Skip to content

Commit 5af5820

Browse files
feat(reseller): update the api
#### reseller:v1 The following keys were added: - resources.subscriptions.methods.insert.parameters.action (Total Keys: 2) - resources.subscriptions.methods.insert.parameters.sourceSkuId (Total Keys: 2)
1 parent 9638838 commit 5af5820

File tree

2 files changed

+29
-3
lines changed

2 files changed

+29
-3
lines changed

docs/dyn/reseller_v1.subscriptions.html

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ <h2>Instance Methods</h2>
9696
<code><a href="#get">get(customerId, subscriptionId, x__xgafv=None)</a></code></p>
9797
<p class="firstline">Gets a specific subscription. The `subscriptionId` can be found using the [Retrieve all reseller subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#get_all_subscriptions) method. For more information about retrieving a specific subscription, see the information descrived in [manage subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#get_subscription).</p>
9898
<p class="toc_element">
99-
<code><a href="#insert">insert(customerId, body=None, customerAuthToken=None, x__xgafv=None)</a></code></p>
99+
<code><a href="#insert">insert(customerId, action=None, body=None, customerAuthToken=None, sourceSkuId=None, x__xgafv=None)</a></code></p>
100100
<p class="firstline">Creates or transfer a subscription. Create a subscription for a customer's account that you ordered using the [Order a new customer account](/admin-sdk/reseller/v1/reference/customers/insert.html) method. For more information about creating a subscription for different payment plans, see [manage subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#create_subscription).\ If you did not order the customer's account using the customer insert method, use the customer's `customerAuthToken` when creating a subscription for that customer. If transferring a G Suite subscription with an associated Google Drive or Google Vault subscription, use the [batch operation](/admin-sdk/reseller/v1/how-tos/batch.html) to transfer all of these subscriptions. For more information, see how to [transfer subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#transfer_a_subscription).</p>
101101
<p class="toc_element">
102102
<code><a href="#list">list(customerAuthToken=None, customerId=None, customerNamePrefix=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
@@ -475,7 +475,7 @@ <h3>Method Details</h3>
475475
</div>
476476

477477
<div class="method">
478-
<code class="details" id="insert">insert(customerId, body=None, customerAuthToken=None, x__xgafv=None)</code>
478+
<code class="details" id="insert">insert(customerId, action=None, body=None, customerAuthToken=None, sourceSkuId=None, x__xgafv=None)</code>
479479
<pre>Creates or transfer a subscription. Create a subscription for a customer&#x27;s account that you ordered using the [Order a new customer account](/admin-sdk/reseller/v1/reference/customers/insert.html) method. For more information about creating a subscription for different payment plans, see [manage subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#create_subscription).\ If you did not order the customer&#x27;s account using the customer insert method, use the customer&#x27;s `customerAuthToken` when creating a subscription for that customer. If transferring a G Suite subscription with an associated Google Drive or Google Vault subscription, use the [batch operation](/admin-sdk/reseller/v1/how-tos/batch.html) to transfer all of these subscriptions. For more information, see how to [transfer subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#transfer_a_subscription).
480480

481481
Args:
@@ -528,7 +528,13 @@ <h3>Method Details</h3>
528528
},
529529
}
530530

531+
action: string, The intented insert action. The usage of this field is governed by certain policies which are being developed &amp; tested currently. Hence, these might not work as intended. Once this is fully tested &amp; available to consume, we will share more information about its usage, limitations and policy documentation.
532+
Allowed values
533+
actionUnspecified - Auto determines whether to create new subscription, upgrade or downagrade existing subscription or transfer the existing subscription
534+
buy - Create new subscription
535+
switch - Switch existing subscription to another sku (upgrade/downgrade)
531536
customerAuthToken: string, The `customerAuthToken` query string is required when creating a resold account that transfers a direct customer&#x27;s subscription or transfers another reseller customer&#x27;s subscription to your reseller management. This is a hexadecimal authentication token needed to complete the subscription transfer. For more information, see the administrator help center.
537+
sourceSkuId: string, The sku_id of the existing subscription to be upgraded or downgraded. This is required when action is SWITCH. The usage of this field is governed by certain policies which are being developed &amp; tested currently. Hence, these might not work as intended. Once this is fully tested &amp; available to consume, we will share more information about its usage, limitations and policy documentation.
532538
x__xgafv: string, V1 error format.
533539
Allowed values
534540
1 - v1 error format

googleapiclient/discovery_cache/documents/reseller.v1.json

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -498,6 +498,21 @@
498498
"customerId"
499499
],
500500
"parameters": {
501+
"action": {
502+
"description": "The intented insert action. The usage of this field is governed by certain policies which are being developed & tested currently. Hence, these might not work as intended. Once this is fully tested & available to consume, we will share more information about its usage, limitations and policy documentation.",
503+
"enum": [
504+
"actionUnspecified",
505+
"buy",
506+
"switch"
507+
],
508+
"enumDescriptions": [
509+
"Auto determines whether to create new subscription, upgrade or downagrade existing subscription or transfer the existing subscription",
510+
"Create new subscription",
511+
"Switch existing subscription to another sku (upgrade/downgrade)"
512+
],
513+
"location": "query",
514+
"type": "string"
515+
},
501516
"customerAuthToken": {
502517
"description": "The `customerAuthToken` query string is required when creating a resold account that transfers a direct customer's subscription or transfers another reseller customer's subscription to your reseller management. This is a hexadecimal authentication token needed to complete the subscription transfer. For more information, see the administrator help center.",
503518
"location": "query",
@@ -508,6 +523,11 @@
508523
"location": "path",
509524
"required": true,
510525
"type": "string"
526+
},
527+
"sourceSkuId": {
528+
"description": "The sku_id of the existing subscription to be upgraded or downgraded. This is required when action is SWITCH. The usage of this field is governed by certain policies which are being developed & tested currently. Hence, these might not work as intended. Once this is fully tested & available to consume, we will share more information about its usage, limitations and policy documentation.",
529+
"location": "query",
530+
"type": "string"
511531
}
512532
},
513533
"path": "apps/reseller/v1/customers/{customerId}/subscriptions",
@@ -631,7 +651,7 @@
631651
}
632652
}
633653
},
634-
"revision": "20230604",
654+
"revision": "20230618",
635655
"rootUrl": "https://reseller.googleapis.com/",
636656
"schemas": {
637657
"Address": {

0 commit comments

Comments
 (0)