From f3ffc4238b05eeccd020a4ea46bb80904afa22c8 Mon Sep 17 00:00:00 2001 From: yoshi-automation Date: Tue, 9 Mar 2021 05:18:19 -0800 Subject: [PATCH] fix(reseller): update the API #### reseller:v1 The following keys were changed: - resources.customers.methods.get.description - resources.customers.methods.get.parameters.customerId.description - resources.customers.methods.insert.description - resources.customers.methods.insert.parameters.customerAuthToken.description - resources.customers.methods.patch.description - resources.customers.methods.patch.parameters.customerId.description - resources.customers.methods.update.description - resources.customers.methods.update.parameters.customerId.description - resources.subscriptions.methods.activate.description - resources.subscriptions.methods.activate.parameters.customerId.description - resources.subscriptions.methods.activate.parameters.subscriptionId.description - resources.subscriptions.methods.changePlan.description - resources.subscriptions.methods.changePlan.parameters.customerId.description - resources.subscriptions.methods.changePlan.parameters.subscriptionId.description - resources.subscriptions.methods.changeRenewalSettings.description - resources.subscriptions.methods.changeRenewalSettings.parameters.customerId.description - resources.subscriptions.methods.changeRenewalSettings.parameters.subscriptionId.description - resources.subscriptions.methods.changeSeats.description - resources.subscriptions.methods.changeSeats.parameters.customerId.description - resources.subscriptions.methods.changeSeats.parameters.subscriptionId.description - resources.subscriptions.methods.delete.parameters.customerId.description - resources.subscriptions.methods.delete.parameters.deletionType.description - resources.subscriptions.methods.delete.parameters.subscriptionId.description - resources.subscriptions.methods.get.description - resources.subscriptions.methods.get.parameters.customerId.description - resources.subscriptions.methods.get.parameters.subscriptionId.description - resources.subscriptions.methods.insert.description - resources.subscriptions.methods.insert.parameters.customerAuthToken.description - resources.subscriptions.methods.insert.parameters.customerId.description - resources.subscriptions.methods.list.description - resources.subscriptions.methods.list.parameters.customerAuthToken.description - resources.subscriptions.methods.list.parameters.customerId.description - resources.subscriptions.methods.list.parameters.customerNamePrefix.description - resources.subscriptions.methods.list.parameters.maxResults.description - resources.subscriptions.methods.startPaidService.description - resources.subscriptions.methods.startPaidService.parameters.customerId.description - resources.subscriptions.methods.startPaidService.parameters.subscriptionId.description - resources.subscriptions.methods.suspend.description - resources.subscriptions.methods.suspend.parameters.customerId.description - resources.subscriptions.methods.suspend.parameters.subscriptionId.description - schemas.Address.properties.addressLine1.description - schemas.Address.properties.countryCode.description - schemas.Address.properties.kind.description - schemas.Address.properties.locality.description - schemas.Address.properties.postalCode.description - schemas.Address.properties.region.description - schemas.ChangePlanRequest.properties.dealCode.description - schemas.ChangePlanRequest.properties.kind.description - schemas.ChangePlanRequest.properties.planName.description - schemas.ChangePlanRequest.properties.purchaseOrderId.description - schemas.Customer.description - schemas.Customer.properties.alternateEmail.description - schemas.Customer.properties.customerDomain.description - schemas.Customer.properties.kind.description - schemas.RenewalSettings.properties.kind.description - schemas.RenewalSettings.properties.renewalType.description - schemas.Seats.properties.kind.description - schemas.Seats.properties.licensedNumberOfSeats.description - schemas.Seats.properties.maximumNumberOfSeats.description - schemas.Seats.properties.numberOfSeats.description - schemas.Subscription.properties.creationTime.description - schemas.Subscription.properties.dealCode.description - schemas.Subscription.properties.kind.description - schemas.Subscription.properties.plan.description - schemas.Subscription.properties.plan.properties.commitmentInterval.description - schemas.Subscription.properties.plan.properties.commitmentInterval.properties.endTime.description - schemas.Subscription.properties.plan.properties.commitmentInterval.properties.startTime.description - schemas.Subscription.properties.plan.properties.isCommitmentPlan.description - schemas.Subscription.properties.plan.properties.planName.description - schemas.Subscription.properties.purchaseOrderId.description - schemas.Subscription.properties.skuId.description - schemas.Subscription.properties.subscriptionId.description - schemas.Subscription.properties.suspensionReasons.description - schemas.Subscription.properties.trialSettings.properties.isInTrial.description - schemas.Subscriptions.description --- discovery/reseller-v1.json | 152 ++++++++++++++-------------- src/apis/reseller/README.md | 2 +- src/apis/reseller/v1.ts | 192 ++++++++++++++++++------------------ 3 files changed, 173 insertions(+), 173 deletions(-) diff --git a/discovery/reseller-v1.json b/discovery/reseller-v1.json index b1ebdaecb9..031b3dcf3e 100644 --- a/discovery/reseller-v1.json +++ b/discovery/reseller-v1.json @@ -111,7 +111,7 @@ "customers": { "methods": { "get": { - "description": "Get a customer account.", + "description": "Get a customer account. Use this operation to see a customer account already in your reseller management, or to see the minimal account information for an existing customer that you do not manage. For more information about the API response for existing customers, see [retrieving a customer account](/admin-sdk/reseller/v1/how-tos/manage_customers#get_customer).", "flatPath": "apps/reseller/v1/customers/{customerId}", "httpMethod": "GET", "id": "reseller.customers.get", @@ -120,7 +120,7 @@ ], "parameters": { "customerId": { - "description": "Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.", + "description": "Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates.", "location": "path", "required": true, "type": "string" @@ -136,14 +136,14 @@ ] }, "insert": { - "description": "Order a new customer's account.", + "description": "Order a new customer's account. Before ordering a new customer account, establish whether the customer account already exists using the [`customers.get`](/admin-sdk/reseller/v1/reference/customers/get) If the customer account exists as a direct Google account or as a resold customer account from another reseller, use the `customerAuthToken\\` as described in [order a resold account for an existing customer](/admin-sdk/reseller/v1/how-tos/manage_customers#create_existing_customer). For more information about ordering a new customer account, see [order a new customer account](/admin-sdk/reseller/v1/how-tos/manage_customers#create_customer). After creating a new customer account, you must provision a user as an administrator. The customer's administrator is required to sign in to the Admin console and sign the G Suite via Reseller agreement to activate the account. Resellers are prohibited from signing the G Suite via Reseller agreement on the customer's behalf. For more information, see [order a new customer account](/admin-sdk/reseller/v1/how-tos/manage_customers#tos).", "flatPath": "apps/reseller/v1/customers", "httpMethod": "POST", "id": "reseller.customers.insert", "parameterOrder": [], "parameters": { "customerAuthToken": { - "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.", + "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.", "location": "query", "type": "string" } @@ -160,7 +160,7 @@ ] }, "patch": { - "description": "Patch a customer account's settings via Apiary Patch Orchestration", + "description": "Update a customer account's settings. This method supports patch semantics.", "flatPath": "apps/reseller/v1/customers/{customerId}", "httpMethod": "PATCH", "id": "reseller.customers.patch", @@ -169,7 +169,7 @@ ], "parameters": { "customerId": { - "description": "Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.", + "description": "Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates.", "location": "path", "required": true, "type": "string" @@ -187,7 +187,7 @@ ] }, "update": { - "description": "Update a customer account's settings.", + "description": "Update a customer account's settings. For more information, see [update a customer's settings](/admin-sdk/reseller/v1/how-tos/manage_customers#update_customer).", "flatPath": "apps/reseller/v1/customers/{customerId}", "httpMethod": "PUT", "id": "reseller.customers.update", @@ -196,7 +196,7 @@ ], "parameters": { "customerId": { - "description": "Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.", + "description": "Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates.", "location": "path", "required": true, "type": "string" @@ -280,7 +280,7 @@ "subscriptions": { "methods": { "activate": { - "description": "Activates a subscription previously suspended by the reseller", + "description": "Activates a subscription previously suspended by the reseller. If you did not suspend the customer subscription and it is suspended for any other reason, such as for abuse or a pending ToS acceptance, this call will not reactivate the customer subscription.", "flatPath": "apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/activate", "httpMethod": "POST", "id": "reseller.subscriptions.activate", @@ -290,13 +290,13 @@ ], "parameters": { "customerId": { - "description": "Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.", + "description": "Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates.", "location": "path", "required": true, "type": "string" }, "subscriptionId": { - "description": "This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.", + "description": "This is a required property. The `subscriptionId` is the subscription identifier and is unique for each customer. Since a `subscriptionId` changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the `subscriptionId` can be found using the retrieve all reseller subscriptions method.", "location": "path", "required": true, "type": "string" @@ -311,7 +311,7 @@ ] }, "changePlan": { - "description": "Update a subscription plan. Use this method to update a plan for a 30-day trial or a flexible plan subscription to an annual commitment plan with monthly or yearly payments.", + "description": "Update a subscription plan. Use this method to update a plan for a 30-day trial or a flexible plan subscription to an annual commitment plan with monthly or yearly payments. How a plan is updated differs depending on the plan and the products. For more information, see the description in [manage subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#update_subscription_plan).", "flatPath": "apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/changePlan", "httpMethod": "POST", "id": "reseller.subscriptions.changePlan", @@ -321,13 +321,13 @@ ], "parameters": { "customerId": { - "description": "Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.", + "description": "Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates.", "location": "path", "required": true, "type": "string" }, "subscriptionId": { - "description": "This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.", + "description": "This is a required property. The `subscriptionId` is the subscription identifier and is unique for each customer. Since a `subscriptionId` changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the `subscriptionId` can be found using the retrieve all reseller subscriptions method.", "location": "path", "required": true, "type": "string" @@ -345,7 +345,7 @@ ] }, "changeRenewalSettings": { - "description": "Update a user license's renewal settings. This is applicable for accounts with annual commitment plans only.", + "description": "Update a user license's renewal settings. This is applicable for accounts with annual commitment plans only. For more information, see the description in [manage subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#update_renewal).", "flatPath": "apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/changeRenewalSettings", "httpMethod": "POST", "id": "reseller.subscriptions.changeRenewalSettings", @@ -355,13 +355,13 @@ ], "parameters": { "customerId": { - "description": "Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.", + "description": "Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates.", "location": "path", "required": true, "type": "string" }, "subscriptionId": { - "description": "This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.", + "description": "This is a required property. The `subscriptionId` is the subscription identifier and is unique for each customer. Since a `subscriptionId` changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the `subscriptionId` can be found using the retrieve all reseller subscriptions method.", "location": "path", "required": true, "type": "string" @@ -379,7 +379,7 @@ ] }, "changeSeats": { - "description": "Update a subscription's user license settings.", + "description": "Update a subscription's user license settings. For more information about updating an annual commitment plan or a flexible plan subscription’s licenses, see [Manage Subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#update_subscription_seat).", "flatPath": "apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/changeSeats", "httpMethod": "POST", "id": "reseller.subscriptions.changeSeats", @@ -389,13 +389,13 @@ ], "parameters": { "customerId": { - "description": "Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.", + "description": "Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates.", "location": "path", "required": true, "type": "string" }, "subscriptionId": { - "description": "This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.", + "description": "This is a required property. The `subscriptionId` is the subscription identifier and is unique for each customer. Since a `subscriptionId` changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the `subscriptionId` can be found using the retrieve all reseller subscriptions method.", "location": "path", "required": true, "type": "string" @@ -424,13 +424,13 @@ ], "parameters": { "customerId": { - "description": "Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.", + "description": "Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates.", "location": "path", "required": true, "type": "string" }, "deletionType": { - "description": "The deletionType query string enables the cancellation, downgrade, or suspension of a subscription.", + "description": "The `deletionType` query string enables the cancellation, downgrade, or suspension of a subscription.", "enum": [ "deletion_type_undefined", "cancel", @@ -446,7 +446,7 @@ "type": "string" }, "subscriptionId": { - "description": "This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.", + "description": "This is a required property. The `subscriptionId` is the subscription identifier and is unique for each customer. Since a `subscriptionId` changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the `subscriptionId` can be found using the retrieve all reseller subscriptions method.", "location": "path", "required": true, "type": "string" @@ -458,7 +458,7 @@ ] }, "get": { - "description": "Get a specific subscription.", + "description": "Get 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).", "flatPath": "apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}", "httpMethod": "GET", "id": "reseller.subscriptions.get", @@ -468,13 +468,13 @@ ], "parameters": { "customerId": { - "description": "Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.", + "description": "Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates.", "location": "path", "required": true, "type": "string" }, "subscriptionId": { - "description": "This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.", + "description": "This is a required property. The `subscriptionId` is the subscription identifier and is unique for each customer. Since a `subscriptionId` changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the `subscriptionId` can be found using the retrieve all reseller subscriptions method.", "location": "path", "required": true, "type": "string" @@ -490,7 +490,7 @@ ] }, "insert": { - "description": "Create or transfer a subscription.", + "description": "Create 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).", "flatPath": "apps/reseller/v1/customers/{customerId}/subscriptions", "httpMethod": "POST", "id": "reseller.subscriptions.insert", @@ -499,12 +499,12 @@ ], "parameters": { "customerAuthToken": { - "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.", + "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.", "location": "query", "type": "string" }, "customerId": { - "description": "Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.", + "description": "Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates.", "location": "path", "required": true, "type": "string" @@ -522,29 +522,29 @@ ] }, "list": { - "description": "List of subscriptions managed by the reseller. The list can be all subscriptions, all of a customer's subscriptions, or all of a customer's transferable subscriptions.", + "description": "List of subscriptions managed by the reseller. The list can be all subscriptions, all of a customer's subscriptions, or all of a customer's transferable subscriptions. Optionally, this method can filter the response by a `customerNamePrefix`. For more information, see [manage subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions).", "flatPath": "apps/reseller/v1/subscriptions", "httpMethod": "GET", "id": "reseller.subscriptions.list", "parameterOrder": [], "parameters": { "customerAuthToken": { - "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.", + "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.", "location": "query", "type": "string" }, "customerId": { - "description": "Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.", + "description": "Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates.", "location": "query", "type": "string" }, "customerNamePrefix": { - "description": "When retrieving all of your subscriptions and filtering for specific customers, you can enter a prefix for a customer name. Using an example customer group that includes exam.com, example20.com and example.com: - exa -- Returns all customer names that start with 'exa' which could include exam.com, example20.com, and example.com. A name prefix is similar to using a regular expression's asterisk, exa*. - example -- Returns example20.com and example.com. ", + "description": "When retrieving all of your subscriptions and filtering for specific customers, you can enter a prefix for a customer name. Using an example customer group that includes `exam.com`, `example20.com` and `example.com`: - `exa` -- Returns all customer names that start with 'exa' which could include `exam.com`, `example20.com`, and `example.com`. A name prefix is similar to using a regular expression's asterisk, exa*. - `example` -- Returns `example20.com` and `example.com`. ", "location": "query", "type": "string" }, "maxResults": { - "description": "When retrieving a large list, the maxResults is the maximum number of results per page. The nextPageToken value takes you to the next page. The default is 20.", + "description": "When retrieving a large list, the `maxResults` is the maximum number of results per page. The `nextPageToken` value takes you to the next page. The default is 20.", "format": "uint32", "location": "query", "maximum": "100", @@ -567,7 +567,7 @@ ] }, "startPaidService": { - "description": "Immediately move a 30-day free trial subscription to a paid service subscription.", + "description": "Immediately move a 30-day free trial subscription to a paid service subscription. This method is only applicable if a payment plan has already been set up for the 30-day trial subscription. For more information, see [manage subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#paid_service).", "flatPath": "apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/startPaidService", "httpMethod": "POST", "id": "reseller.subscriptions.startPaidService", @@ -577,13 +577,13 @@ ], "parameters": { "customerId": { - "description": "Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.", + "description": "Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates.", "location": "path", "required": true, "type": "string" }, "subscriptionId": { - "description": "This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.", + "description": "This is a required property. The `subscriptionId` is the subscription identifier and is unique for each customer. Since a `subscriptionId` changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the `subscriptionId` can be found using the retrieve all reseller subscriptions method.", "location": "path", "required": true, "type": "string" @@ -598,7 +598,7 @@ ] }, "suspend": { - "description": "Suspends an active subscription.", + "description": "Suspends an active subscription. You can use this method to suspend a paid subscription that is currently in the `ACTIVE` state. * For `FLEXIBLE` subscriptions, billing is paused. * For `ANNUAL_MONTHLY_PAY` or `ANNUAL_YEARLY_PAY` subscriptions: * Suspending the subscription does not change the renewal date that was originally committed to. * A suspended subscription does not renew. If you activate the subscription after the original renewal date, a new annual subscription will be created, starting on the day of activation. We strongly encourage you to suspend subscriptions only for short periods of time as suspensions over 60 days may result in the subscription being cancelled.", "flatPath": "apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/suspend", "httpMethod": "POST", "id": "reseller.subscriptions.suspend", @@ -608,13 +608,13 @@ ], "parameters": { "customerId": { - "description": "Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.", + "description": "Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates.", "location": "path", "required": true, "type": "string" }, "subscriptionId": { - "description": "This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.", + "description": "This is a required property. The `subscriptionId` is the subscription identifier and is unique for each customer. Since a `subscriptionId` changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the `subscriptionId` can be found using the retrieve all reseller subscriptions method.", "location": "path", "required": true, "type": "string" @@ -631,7 +631,7 @@ } } }, - "revision": "20201201", + "revision": "20210308", "rootUrl": "https://reseller.googleapis.com/", "schemas": { "Address": { @@ -639,7 +639,7 @@ "id": "Address", "properties": { "addressLine1": { - "description": "A customer's physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional.", + "description": "A customer's physical address. An address can be composed of one to three lines. The `addressline2` and `addressLine3` are optional.", "type": "string" }, "addressLine2": { @@ -655,16 +655,16 @@ "type": "string" }, "countryCode": { - "description": "For countryCode information, see the ISO 3166 country code elements. Verify that country is approved for resale of Google products. This property is required when creating a new customer.", + "description": "For `countryCode` information, see the ISO 3166 country code elements. Verify that country is approved for resale of Google products. This property is required when creating a new customer.", "type": "string" }, "kind": { "default": "customers#address", - "description": "Identifies the resource as a customer address. Value: customers#address", + "description": "Identifies the resource as a customer address. Value: `customers#address`", "type": "string" }, "locality": { - "description": "An example of a locality value is the city of San Francisco.", + "description": "An example of a `locality` value is the city of `San Francisco`.", "type": "string" }, "organizationName": { @@ -672,11 +672,11 @@ "type": "string" }, "postalCode": { - "description": "A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer.", + "description": "A `postalCode` example is a postal zip code such as `94043`. This property is required when creating a new customer.", "type": "string" }, "region": { - "description": "An example of a region value is CA for the state of California.", + "description": "An example of a `region` value is `CA` for the state of California.", "type": "string" } }, @@ -687,20 +687,20 @@ "id": "ChangePlanRequest", "properties": { "dealCode": { - "description": "Google-issued code (100 char max) for discounted pricing on subscription plans. Deal code must be included in changePlan request in order to receive discounted rate. This property is optional. If a deal code has already been added to a subscription, this property may be left empty and the existing discounted rate will still apply (if not empty, only provide the deal code that is already present on the subscription). If a deal code has never been added to a subscription and this property is left blank, regular pricing will apply.", + "description": "Google-issued code (100 char max) for discounted pricing on subscription plans. Deal code must be included in `changePlan` request in order to receive discounted rate. This property is optional. If a deal code has already been added to a subscription, this property may be left empty and the existing discounted rate will still apply (if not empty, only provide the deal code that is already present on the subscription). If a deal code has never been added to a subscription and this property is left blank, regular pricing will apply.", "type": "string" }, "kind": { "default": "subscriptions#changePlanRequest", - "description": "Identifies the resource as a subscription change plan request. Value: subscriptions#changePlanRequest", + "description": "Identifies the resource as a subscription change plan request. Value: `subscriptions#changePlanRequest`", "type": "string" }, "planName": { - "description": "The planName property is required. This is the name of the subscription's payment plan. For more information about the Google payment plans, see API concepts. Possible values are: - ANNUAL_MONTHLY_PAY - The annual commitment plan with monthly payments *Caution: *ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses. - ANNUAL_YEARLY_PAY - The annual commitment plan with yearly payments - FLEXIBLE - The flexible plan - TRIAL - The 30-day free trial plan ", + "description": "The `planName` property is required. This is the name of the subscription's payment plan. For more information about the Google payment plans, see API concepts. Possible values are: - `ANNUAL_MONTHLY_PAY` - The annual commitment plan with monthly payments *Caution: *`ANNUAL_MONTHLY_PAY` is returned as `ANNUAL` in all API responses. - `ANNUAL_YEARLY_PAY` - The annual commitment plan with yearly payments - `FLEXIBLE` - The flexible plan - `TRIAL` - The 30-day free trial plan ", "type": "string" }, "purchaseOrderId": { - "description": "This is an optional property. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters.", + "description": "This is an optional property. This purchase order (PO) information is for resellers to use for their company tracking usage. If a `purchaseOrderId` value is given it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters.", "type": "string" }, "seats": { @@ -711,15 +711,15 @@ "type": "object" }, "Customer": { - "description": "JSON template for a customer.", + "description": "When a Google customer's account is registered with a reseller, the customer's subscriptions for Google services are managed by this reseller. A customer is described by a primary domain name and a physical address.", "id": "Customer", "properties": { "alternateEmail": { - "description": "Like the \"Customer email\" in the reseller tools, this email is the secondary contact used if something happens to the customer's service such as service outage or a security issue. This property is required when creating a new customer and should not use the same domain as customerDomain .", + "description": "Like the \"Customer email\" in the reseller tools, this email is the secondary contact used if something happens to the customer's service such as service outage or a security issue. This property is required when creating a new customer and should not use the same domain as `customerDomain`.", "type": "string" }, "customerDomain": { - "description": "The customer's primary domain name string. customerDomain is required when creating a new customer. Do not include the www prefix in the domain when adding a customer.", + "description": "The customer's primary domain name string. `customerDomain` is required when creating a new customer. Do not include the `www` prefix in the domain when adding a customer.", "type": "string" }, "customerDomainVerified": { @@ -732,7 +732,7 @@ }, "kind": { "default": "reseller#customer", - "description": "Identifies the resource as a customer. Value: reseller#customer", + "description": "Identifies the resource as a customer. Value: `reseller#customer`", "type": "string" }, "phoneNumber": { @@ -756,11 +756,11 @@ "properties": { "kind": { "default": "subscriptions#renewalSettings", - "description": "Identifies the resource as a subscription renewal setting. Value: subscriptions#renewalSettings", + "description": "Identifies the resource as a subscription renewal setting. Value: `subscriptions#renewalSettings`", "type": "string" }, "renewalType": { - "description": "Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center. When renewing a subscription, the renewalType is a required property.", + "description": "Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center. When renewing a subscription, the `renewalType` is a required property.", "type": "string" } }, @@ -801,21 +801,21 @@ "properties": { "kind": { "default": "subscriptions#seats", - "description": "Identifies the resource as a subscription seat setting. Value: subscriptions#seats", + "description": "Identifies the resource as a subscription seat setting. Value: `subscriptions#seats`", "type": "string" }, "licensedNumberOfSeats": { - "description": "Read-only field containing the current number of users that are assigned a license for the product defined in skuId. This field's value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: listForProductAndSku", + "description": "Read-only field containing the current number of users that are assigned a license for the product defined in `skuId`. This field's value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: [`listForProductAndSku`](/admin-sdk/licensing/v1/reference/licenseAssignments/listForProductAndSku).", "format": "int32", "type": "integer" }, "maximumNumberOfSeats": { - "description": "This is a required property and is exclusive to subscriptions with FLEXIBLE or TRIAL plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller's contract. The minimum quantity is the current number of users in the customer account. *Note: *G Suite subscriptions automatically assign a license to every user.", + "description": "This is a required property and is exclusive to subscriptions with `FLEXIBLE` or `TRIAL` plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller's contract. The minimum quantity is the current number of users in the customer account. *Note: *G Suite subscriptions automatically assign a license to every user.", "format": "int32", "type": "integer" }, "numberOfSeats": { - "description": "This is a required property and is exclusive to subscriptions with ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the numberOfSeats cannot be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are assigned. *Note: *G Suite subscriptions automatically assign a license to every user.", + "description": "This is a required property and is exclusive to subscriptions with `ANNUAL_MONTHLY_PAY` and `ANNUAL_YEARLY_PAY` plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the `numberOfSeats` cannot be reduced until renewal. The reseller is invoiced based on the `numberOfSeats` value regardless of how many of these user licenses are assigned. *Note: *G Suite subscriptions automatically assign a license to every user.", "format": "int32", "type": "integer" } @@ -831,7 +831,7 @@ "type": "string" }, "creationTime": { - "description": "The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.", + "description": "The `creationTime` property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.", "format": "int64", "type": "string" }, @@ -844,27 +844,27 @@ "type": "string" }, "dealCode": { - "description": "Google-issued code (100 char max) for discounted pricing on subscription plans. Deal code must be included in insert requests in order to receive discounted rate. This property is optional, regular pricing applies if left empty.", + "description": "Google-issued code (100 char max) for discounted pricing on subscription plans. Deal code must be included in `insert` requests in order to receive discounted rate. This property is optional, regular pricing applies if left empty.", "type": "string" }, "kind": { "default": "reseller#subscription", - "description": "Identifies the resource as a Subscription. Value: reseller#subscription", + "description": "Identifies the resource as a Subscription. Value: `reseller#subscription`", "type": "string" }, "plan": { - "description": "The plan property is required. In this version of the API, the G Suite plans are the flexible plan, annual commitment plan, and the 30-day free trial plan. For more information about the API\"s payment plans, see the API concepts.", + "description": "The `plan` property is required. In this version of the API, the G Suite plans are the flexible plan, annual commitment plan, and the 30-day free trial plan. For more information about the API\"s payment plans, see the API concepts.", "properties": { "commitmentInterval": { - "description": "In this version of the API, annual commitment plan's interval is one year. *Note: *When billingMethod value is OFFLINE, the subscription property object plan.commitmentInterval is omitted in all API responses. ", + "description": "In this version of the API, annual commitment plan's interval is one year. *Note: *When `billingMethod` value is `OFFLINE`, the subscription property object `plan.commitmentInterval` is omitted in all API responses. ", "properties": { "endTime": { - "description": "An annual commitment plan's interval's endTime in milliseconds using the UNIX Epoch format. See an example Epoch converter.", + "description": "An annual commitment plan's interval's `endTime` in milliseconds using the UNIX Epoch format. See an example Epoch converter.", "format": "int64", "type": "string" }, "startTime": { - "description": "An annual commitment plan's interval's startTime in milliseconds using UNIX Epoch format. See an example Epoch converter.", + "description": "An annual commitment plan's interval's `startTime` in milliseconds using UNIX Epoch format. See an example Epoch converter.", "format": "int64", "type": "string" } @@ -872,18 +872,18 @@ "type": "object" }, "isCommitmentPlan": { - "description": "The isCommitmentPlan property's boolean value identifies the plan as an annual commitment plan: - true — The subscription's plan is an annual commitment plan. - false — The plan is not an annual commitment plan. ", + "description": "The `isCommitmentPlan` property's boolean value identifies the plan as an annual commitment plan: - `true` — The subscription's plan is an annual commitment plan. - `false` — The plan is not an annual commitment plan. ", "type": "boolean" }, "planName": { - "description": "The planName property is required. This is the name of the subscription's plan. For more information about the Google payment plans, see the API concepts. Possible values are: - ANNUAL_MONTHLY_PAY — The annual commitment plan with monthly payments. *Caution: *ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses. - ANNUAL_YEARLY_PAY — The annual commitment plan with yearly payments - FLEXIBLE — The flexible plan - TRIAL — The 30-day free trial plan. A subscription in trial will be suspended after the 30th free day if no payment plan is assigned. Calling changePlan will assign a payment plan to a trial but will not activate the plan. A trial will automatically begin its assigned payment plan after its 30th free day or immediately after calling startPaidService. - FREE — The free plan is exclusive to the Cloud Identity SKU and does not incur any billing. ", + "description": "The `planName` property is required. This is the name of the subscription's plan. For more information about the Google payment plans, see the API concepts. Possible values are: - `ANNUAL_MONTHLY_PAY` — The annual commitment plan with monthly payments. *Caution: *`ANNUAL_MONTHLY_PAY` is returned as `ANNUAL` in all API responses. - `ANNUAL_YEARLY_PAY` — The annual commitment plan with yearly payments - `FLEXIBLE` — The flexible plan - `TRIAL` — The 30-day free trial plan. A subscription in trial will be suspended after the 30th free day if no payment plan is assigned. Calling `changePlan` will assign a payment plan to a trial but will not activate the plan. A trial will automatically begin its assigned payment plan after its 30th free day or immediately after calling `startPaidService`. - `FREE` — The free plan is exclusive to the Cloud Identity SKU and does not incur any billing. ", "type": "string" } }, "type": "object" }, "purchaseOrderId": { - "description": "This is an optional property. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters.", + "description": "This is an optional property. This purchase order (PO) information is for resellers to use for their company tracking usage. If a `purchaseOrderId` value is given it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters.", "type": "string" }, "renewalSettings": { @@ -899,7 +899,7 @@ "description": "This is a required property. The number and limit of user seat licenses in the plan." }, "skuId": { - "description": "A required property. The skuId is a unique system identifier for a product's SKU assigned to a customer in the subscription. For products and SKUs available in this version of the API, see Product and SKU IDs.", + "description": "A required property. The `skuId` is a unique system identifier for a product's SKU assigned to a customer in the subscription. For products and SKUs available in this version of the API, see Product and SKU IDs.", "type": "string" }, "skuName": { @@ -911,11 +911,11 @@ "type": "string" }, "subscriptionId": { - "description": "The subscriptionId is the subscription identifier and is unique for each customer. This is a required property. Since a subscriptionId changes when a subscription is updated, we recommend not using this ID as a key for persistent data. Use the subscriptionId as described in retrieve all reseller subscriptions.", + "description": "The `subscriptionId` is the subscription identifier and is unique for each customer. This is a required property. Since a `subscriptionId` changes when a subscription is updated, we recommend not using this ID as a key for persistent data. Use the `subscriptionId` as described in retrieve all reseller subscriptions.", "type": "string" }, "suspensionReasons": { - "description": "Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed. Possible options include: - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the G Suite Resold Terms of Services. - RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term. - RESELLER_INITIATED - A manual suspension invoked by a Reseller. - TRIAL_ENDED - The customer's trial expired without a plan selected. - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise). ", + "description": "Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's `STATUS` is `SUSPENDED` until all pending suspensions are removed. Possible options include: - `PENDING_TOS_ACCEPTANCE` - The customer has not logged in and accepted the G Suite Resold Terms of Services. - `RENEWAL_WITH_TYPE_CANCEL` - The customer's commitment ended and their service was cancelled at the end of their term. - `RESELLER_INITIATED` - A manual suspension invoked by a Reseller. - `TRIAL_ENDED` - The customer's trial expired without a plan selected. - `OTHER` - The customer is suspended for an internal Google reason (e.g. abuse or otherwise). ", "items": { "type": "string" }, @@ -941,7 +941,7 @@ "description": "The G Suite annual commitment and flexible payment plans can be in a 30-day free trial. For more information, see the API concepts.", "properties": { "isInTrial": { - "description": "Determines if a subscription's plan is in a 30-day free trial or not: - true — The plan is in trial. - false — The plan is not in trial. ", + "description": "Determines if a subscription's plan is in a 30-day free trial or not: - `true` — The plan is in trial. - `false` — The plan is not in trial. ", "type": "boolean" }, "trialEndTime": { @@ -956,7 +956,7 @@ "type": "object" }, "Subscriptions": { - "description": "JSON template for a subscription list.", + "description": "A subscription manages the relationship of a Google customer's payment plan with a product's SKU, user licenses, 30-day free trial status, and renewal options. A primary role of a reseller is to manage the Google customer's subscriptions.", "id": "Subscriptions", "properties": { "kind": { diff --git a/src/apis/reseller/README.md b/src/apis/reseller/README.md index 4f78d957a2..51c5e1f7d8 100644 --- a/src/apis/reseller/README.md +++ b/src/apis/reseller/README.md @@ -2,7 +2,7 @@ # reseller -> Perform common functions that are available on the Google Apps Reseller Console at scale like placing orders and viewing customer information +> Perform common functions that are available on the Channel Services console at scale, like placing orders and viewing customer information ## Installation diff --git a/src/apis/reseller/v1.ts b/src/apis/reseller/v1.ts index ed111dc1d6..177f53f2ad 100644 --- a/src/apis/reseller/v1.ts +++ b/src/apis/reseller/v1.ts @@ -134,7 +134,7 @@ export namespace reseller_v1 { */ export interface Schema$Address { /** - * A customer's physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional. + * A customer's physical address. An address can be composed of one to three lines. The `addressline2` and `addressLine3` are optional. */ addressLine1?: string | null; /** @@ -150,15 +150,15 @@ export namespace reseller_v1 { */ contactName?: string | null; /** - * For countryCode information, see the ISO 3166 country code elements. Verify that country is approved for resale of Google products. This property is required when creating a new customer. + * For `countryCode` information, see the ISO 3166 country code elements. Verify that country is approved for resale of Google products. This property is required when creating a new customer. */ countryCode?: string | null; /** - * Identifies the resource as a customer address. Value: customers#address + * Identifies the resource as a customer address. Value: `customers#address` */ kind?: string | null; /** - * An example of a locality value is the city of San Francisco. + * An example of a `locality` value is the city of `San Francisco`. */ locality?: string | null; /** @@ -166,11 +166,11 @@ export namespace reseller_v1 { */ organizationName?: string | null; /** - * A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer. + * A `postalCode` example is a postal zip code such as `94043`. This property is required when creating a new customer. */ postalCode?: string | null; /** - * An example of a region value is CA for the state of California. + * An example of a `region` value is `CA` for the state of California. */ region?: string | null; } @@ -179,19 +179,19 @@ export namespace reseller_v1 { */ export interface Schema$ChangePlanRequest { /** - * Google-issued code (100 char max) for discounted pricing on subscription plans. Deal code must be included in changePlan request in order to receive discounted rate. This property is optional. If a deal code has already been added to a subscription, this property may be left empty and the existing discounted rate will still apply (if not empty, only provide the deal code that is already present on the subscription). If a deal code has never been added to a subscription and this property is left blank, regular pricing will apply. + * Google-issued code (100 char max) for discounted pricing on subscription plans. Deal code must be included in `changePlan` request in order to receive discounted rate. This property is optional. If a deal code has already been added to a subscription, this property may be left empty and the existing discounted rate will still apply (if not empty, only provide the deal code that is already present on the subscription). If a deal code has never been added to a subscription and this property is left blank, regular pricing will apply. */ dealCode?: string | null; /** - * Identifies the resource as a subscription change plan request. Value: subscriptions#changePlanRequest + * Identifies the resource as a subscription change plan request. Value: `subscriptions#changePlanRequest` */ kind?: string | null; /** - * The planName property is required. This is the name of the subscription's payment plan. For more information about the Google payment plans, see API concepts. Possible values are: - ANNUAL_MONTHLY_PAY - The annual commitment plan with monthly payments *Caution: *ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses. - ANNUAL_YEARLY_PAY - The annual commitment plan with yearly payments - FLEXIBLE - The flexible plan - TRIAL - The 30-day free trial plan + * The `planName` property is required. This is the name of the subscription's payment plan. For more information about the Google payment plans, see API concepts. Possible values are: - `ANNUAL_MONTHLY_PAY` - The annual commitment plan with monthly payments *Caution: *`ANNUAL_MONTHLY_PAY` is returned as `ANNUAL` in all API responses. - `ANNUAL_YEARLY_PAY` - The annual commitment plan with yearly payments - `FLEXIBLE` - The flexible plan - `TRIAL` - The 30-day free trial plan */ planName?: string | null; /** - * This is an optional property. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters. + * This is an optional property. This purchase order (PO) information is for resellers to use for their company tracking usage. If a `purchaseOrderId` value is given it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters. */ purchaseOrderId?: string | null; /** @@ -200,15 +200,15 @@ export namespace reseller_v1 { seats?: Schema$Seats; } /** - * JSON template for a customer. + * When a Google customer's account is registered with a reseller, the customer's subscriptions for Google services are managed by this reseller. A customer is described by a primary domain name and a physical address. */ export interface Schema$Customer { /** - * Like the "Customer email" in the reseller tools, this email is the secondary contact used if something happens to the customer's service such as service outage or a security issue. This property is required when creating a new customer and should not use the same domain as customerDomain . + * Like the "Customer email" in the reseller tools, this email is the secondary contact used if something happens to the customer's service such as service outage or a security issue. This property is required when creating a new customer and should not use the same domain as `customerDomain`. */ alternateEmail?: string | null; /** - * The customer's primary domain name string. customerDomain is required when creating a new customer. Do not include the www prefix in the domain when adding a customer. + * The customer's primary domain name string. `customerDomain` is required when creating a new customer. Do not include the `www` prefix in the domain when adding a customer. */ customerDomain?: string | null; /** @@ -220,7 +220,7 @@ export namespace reseller_v1 { */ customerId?: string | null; /** - * Identifies the resource as a customer. Value: reseller#customer + * Identifies the resource as a customer. Value: `reseller#customer` */ kind?: string | null; /** @@ -241,11 +241,11 @@ export namespace reseller_v1 { */ export interface Schema$RenewalSettings { /** - * Identifies the resource as a subscription renewal setting. Value: subscriptions#renewalSettings + * Identifies the resource as a subscription renewal setting. Value: `subscriptions#renewalSettings` */ kind?: string | null; /** - * Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center. When renewing a subscription, the renewalType is a required property. + * Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center. When renewing a subscription, the `renewalType` is a required property. */ renewalType?: string | null; } @@ -276,19 +276,19 @@ export namespace reseller_v1 { */ export interface Schema$Seats { /** - * Identifies the resource as a subscription seat setting. Value: subscriptions#seats + * Identifies the resource as a subscription seat setting. Value: `subscriptions#seats` */ kind?: string | null; /** - * Read-only field containing the current number of users that are assigned a license for the product defined in skuId. This field's value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: listForProductAndSku + * Read-only field containing the current number of users that are assigned a license for the product defined in `skuId`. This field's value is equivalent to the numerical count of users returned by the Enterprise License Manager API method: [`listForProductAndSku`](/admin-sdk/licensing/v1/reference/licenseAssignments/listForProductAndSku). */ licensedNumberOfSeats?: number | null; /** - * This is a required property and is exclusive to subscriptions with FLEXIBLE or TRIAL plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller's contract. The minimum quantity is the current number of users in the customer account. *Note: *G Suite subscriptions automatically assign a license to every user. + * This is a required property and is exclusive to subscriptions with `FLEXIBLE` or `TRIAL` plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller's contract. The minimum quantity is the current number of users in the customer account. *Note: *G Suite subscriptions automatically assign a license to every user. */ maximumNumberOfSeats?: number | null; /** - * This is a required property and is exclusive to subscriptions with ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the numberOfSeats cannot be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are assigned. *Note: *G Suite subscriptions automatically assign a license to every user. + * This is a required property and is exclusive to subscriptions with `ANNUAL_MONTHLY_PAY` and `ANNUAL_YEARLY_PAY` plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the `numberOfSeats` cannot be reduced until renewal. The reseller is invoiced based on the `numberOfSeats` value regardless of how many of these user licenses are assigned. *Note: *G Suite subscriptions automatically assign a license to every user. */ numberOfSeats?: number | null; } @@ -301,7 +301,7 @@ export namespace reseller_v1 { */ billingMethod?: string | null; /** - * The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter. + * The `creationTime` property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter. */ creationTime?: string | null; /** @@ -313,15 +313,15 @@ export namespace reseller_v1 { */ customerId?: string | null; /** - * Google-issued code (100 char max) for discounted pricing on subscription plans. Deal code must be included in insert requests in order to receive discounted rate. This property is optional, regular pricing applies if left empty. + * Google-issued code (100 char max) for discounted pricing on subscription plans. Deal code must be included in `insert` requests in order to receive discounted rate. This property is optional, regular pricing applies if left empty. */ dealCode?: string | null; /** - * Identifies the resource as a Subscription. Value: reseller#subscription + * Identifies the resource as a Subscription. Value: `reseller#subscription` */ kind?: string | null; /** - * The plan property is required. In this version of the API, the G Suite plans are the flexible plan, annual commitment plan, and the 30-day free trial plan. For more information about the API"s payment plans, see the API concepts. + * The `plan` property is required. In this version of the API, the G Suite plans are the flexible plan, annual commitment plan, and the 30-day free trial plan. For more information about the API"s payment plans, see the API concepts. */ plan?: { commitmentInterval?: {endTime?: string; startTime?: string}; @@ -329,7 +329,7 @@ export namespace reseller_v1 { planName?: string; } | null; /** - * This is an optional property. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters. + * This is an optional property. This purchase order (PO) information is for resellers to use for their company tracking usage. If a `purchaseOrderId` value is given it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters. */ purchaseOrderId?: string | null; /** @@ -345,7 +345,7 @@ export namespace reseller_v1 { */ seats?: Schema$Seats; /** - * A required property. The skuId is a unique system identifier for a product's SKU assigned to a customer in the subscription. For products and SKUs available in this version of the API, see Product and SKU IDs. + * A required property. The `skuId` is a unique system identifier for a product's SKU assigned to a customer in the subscription. For products and SKUs available in this version of the API, see Product and SKU IDs. */ skuId?: string | null; /** @@ -357,11 +357,11 @@ export namespace reseller_v1 { */ status?: string | null; /** - * The subscriptionId is the subscription identifier and is unique for each customer. This is a required property. Since a subscriptionId changes when a subscription is updated, we recommend not using this ID as a key for persistent data. Use the subscriptionId as described in retrieve all reseller subscriptions. + * The `subscriptionId` is the subscription identifier and is unique for each customer. This is a required property. Since a `subscriptionId` changes when a subscription is updated, we recommend not using this ID as a key for persistent data. Use the `subscriptionId` as described in retrieve all reseller subscriptions. */ subscriptionId?: string | null; /** - * Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed. Possible options include: - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the G Suite Resold Terms of Services. - RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term. - RESELLER_INITIATED - A manual suspension invoked by a Reseller. - TRIAL_ENDED - The customer's trial expired without a plan selected. - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise). + * Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's `STATUS` is `SUSPENDED` until all pending suspensions are removed. Possible options include: - `PENDING_TOS_ACCEPTANCE` - The customer has not logged in and accepted the G Suite Resold Terms of Services. - `RENEWAL_WITH_TYPE_CANCEL` - The customer's commitment ended and their service was cancelled at the end of their term. - `RESELLER_INITIATED` - A manual suspension invoked by a Reseller. - `TRIAL_ENDED` - The customer's trial expired without a plan selected. - `OTHER` - The customer is suspended for an internal Google reason (e.g. abuse or otherwise). */ suspensionReasons?: string[] | null; /** @@ -377,7 +377,7 @@ export namespace reseller_v1 { trialSettings?: {isInTrial?: boolean; trialEndTime?: string} | null; } /** - * JSON template for a subscription list. + * A subscription manages the relationship of a Google customer's payment plan with a product's SKU, user licenses, 30-day free trial status, and renewal options. A primary role of a reseller is to manage the Google customer's subscriptions. */ export interface Schema$Subscriptions { /** @@ -401,7 +401,7 @@ export namespace reseller_v1 { } /** - * Get a customer account. + * Get a customer account. Use this operation to see a customer account already in your reseller management, or to see the minimal account information for an existing customer that you do not manage. For more information about the API response for existing customers, see [retrieving a customer account](/admin-sdk/reseller/v1/how-tos/manage_customers#get_customer). * @example * ```js * // Before running the sample: @@ -430,7 +430,7 @@ export namespace reseller_v1 { * * // Do the magic * const res = await reseller.customers.get({ - * // Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. + * // Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates. * customerId: 'placeholder-value', * }); * console.log(res.data); @@ -539,7 +539,7 @@ export namespace reseller_v1 { } /** - * Order a new customer's account. + * Order a new customer's account. Before ordering a new customer account, establish whether the customer account already exists using the [`customers.get`](/admin-sdk/reseller/v1/reference/customers/get) If the customer account exists as a direct Google account or as a resold customer account from another reseller, use the `customerAuthToken\` as described in [order a resold account for an existing customer](/admin-sdk/reseller/v1/how-tos/manage_customers#create_existing_customer). For more information about ordering a new customer account, see [order a new customer account](/admin-sdk/reseller/v1/how-tos/manage_customers#create_customer). After creating a new customer account, you must provision a user as an administrator. The customer's administrator is required to sign in to the Admin console and sign the G Suite via Reseller agreement to activate the account. Resellers are prohibited from signing the G Suite via Reseller agreement on the customer's behalf. For more information, see [order a new customer account](/admin-sdk/reseller/v1/how-tos/manage_customers#tos). * @example * ```js * // Before running the sample: @@ -565,7 +565,7 @@ export namespace reseller_v1 { * * // Do the magic * const res = await reseller.customers.insert({ - * // 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. + * // 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. * customerAuthToken: 'placeholder-value', * * // Request body metadata @@ -689,7 +689,7 @@ export namespace reseller_v1 { } /** - * Patch a customer account's settings via Apiary Patch Orchestration + * Update a customer account's settings. This method supports patch semantics. * @example * ```js * // Before running the sample: @@ -715,7 +715,7 @@ export namespace reseller_v1 { * * // Do the magic * const res = await reseller.customers.patch({ - * // Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. + * // Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates. * customerId: 'placeholder-value', * * // Request body metadata @@ -839,7 +839,7 @@ export namespace reseller_v1 { } /** - * Update a customer account's settings. + * Update a customer account's settings. For more information, see [update a customer's settings](/admin-sdk/reseller/v1/how-tos/manage_customers#update_customer). * @example * ```js * // Before running the sample: @@ -865,7 +865,7 @@ export namespace reseller_v1 { * * // Do the magic * const res = await reseller.customers.update({ - * // Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. + * // Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates. * customerId: 'placeholder-value', * * // Request body metadata @@ -991,13 +991,13 @@ export namespace reseller_v1 { export interface Params$Resource$Customers$Get extends StandardParameters { /** - * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. + * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates. */ customerId?: string; } export interface Params$Resource$Customers$Insert extends StandardParameters { /** - * 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. + * 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. */ customerAuthToken?: string; @@ -1008,7 +1008,7 @@ export namespace reseller_v1 { } export interface Params$Resource$Customers$Patch extends StandardParameters { /** - * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. + * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates. */ customerId?: string; @@ -1019,7 +1019,7 @@ export namespace reseller_v1 { } export interface Params$Resource$Customers$Update extends StandardParameters { /** - * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. + * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates. */ customerId?: string; @@ -1468,7 +1468,7 @@ export namespace reseller_v1 { } /** - * Activates a subscription previously suspended by the reseller + * Activates a subscription previously suspended by the reseller. If you did not suspend the customer subscription and it is suspended for any other reason, such as for abuse or a pending ToS acceptance, this call will not reactivate the customer subscription. * @example * ```js * // Before running the sample: @@ -1494,9 +1494,9 @@ export namespace reseller_v1 { * * // Do the magic * const res = await reseller.subscriptions.activate({ - * // Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. + * // Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates. * customerId: 'placeholder-value', - * // This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. + * // This is a required property. The `subscriptionId` is the subscription identifier and is unique for each customer. Since a `subscriptionId` changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the `subscriptionId` can be found using the retrieve all reseller subscriptions method. * subscriptionId: 'placeholder-value', * }); * console.log(res.data); @@ -1616,7 +1616,7 @@ export namespace reseller_v1 { } /** - * Update a subscription plan. Use this method to update a plan for a 30-day trial or a flexible plan subscription to an annual commitment plan with monthly or yearly payments. + * Update a subscription plan. Use this method to update a plan for a 30-day trial or a flexible plan subscription to an annual commitment plan with monthly or yearly payments. How a plan is updated differs depending on the plan and the products. For more information, see the description in [manage subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#update_subscription_plan). * @example * ```js * // Before running the sample: @@ -1642,9 +1642,9 @@ export namespace reseller_v1 { * * // Do the magic * const res = await reseller.subscriptions.changePlan({ - * // Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. + * // Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates. * customerId: 'placeholder-value', - * // This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. + * // This is a required property. The `subscriptionId` is the subscription identifier and is unique for each customer. Since a `subscriptionId` changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the `subscriptionId` can be found using the retrieve all reseller subscriptions method. * subscriptionId: 'placeholder-value', * * // Request body metadata @@ -1776,7 +1776,7 @@ export namespace reseller_v1 { } /** - * Update a user license's renewal settings. This is applicable for accounts with annual commitment plans only. + * Update a user license's renewal settings. This is applicable for accounts with annual commitment plans only. For more information, see the description in [manage subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#update_renewal). * @example * ```js * // Before running the sample: @@ -1802,9 +1802,9 @@ export namespace reseller_v1 { * * // Do the magic * const res = await reseller.subscriptions.changeRenewalSettings({ - * // Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. + * // Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates. * customerId: 'placeholder-value', - * // This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. + * // This is a required property. The `subscriptionId` is the subscription identifier and is unique for each customer. Since a `subscriptionId` changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the `subscriptionId` can be found using the retrieve all reseller subscriptions method. * subscriptionId: 'placeholder-value', * * // Request body metadata @@ -1935,7 +1935,7 @@ export namespace reseller_v1 { } /** - * Update a subscription's user license settings. + * Update a subscription's user license settings. For more information about updating an annual commitment plan or a flexible plan subscription’s licenses, see [Manage Subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#update_subscription_seat). * @example * ```js * // Before running the sample: @@ -1961,9 +1961,9 @@ export namespace reseller_v1 { * * // Do the magic * const res = await reseller.subscriptions.changeSeats({ - * // Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. + * // Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates. * customerId: 'placeholder-value', - * // This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. + * // This is a required property. The `subscriptionId` is the subscription identifier and is unique for each customer. Since a `subscriptionId` changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the `subscriptionId` can be found using the retrieve all reseller subscriptions method. * subscriptionId: 'placeholder-value', * * // Request body metadata @@ -2120,11 +2120,11 @@ export namespace reseller_v1 { * * // Do the magic * const res = await reseller.subscriptions.delete({ - * // Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. + * // Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates. * customerId: 'placeholder-value', - * // The deletionType query string enables the cancellation, downgrade, or suspension of a subscription. + * // The `deletionType` query string enables the cancellation, downgrade, or suspension of a subscription. * deletionType: 'placeholder-value', - * // This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. + * // This is a required property. The `subscriptionId` is the subscription identifier and is unique for each customer. Since a `subscriptionId` changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the `subscriptionId` can be found using the retrieve all reseller subscriptions method. * subscriptionId: 'placeholder-value', * }); * console.log(res.data); @@ -2220,7 +2220,7 @@ export namespace reseller_v1 { } /** - * Get a specific subscription. + * Get 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). * @example * ```js * // Before running the sample: @@ -2249,9 +2249,9 @@ export namespace reseller_v1 { * * // Do the magic * const res = await reseller.subscriptions.get({ - * // Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. + * // Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates. * customerId: 'placeholder-value', - * // This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. + * // This is a required property. The `subscriptionId` is the subscription identifier and is unique for each customer. Since a `subscriptionId` changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the `subscriptionId` can be found using the retrieve all reseller subscriptions method. * subscriptionId: 'placeholder-value', * }); * console.log(res.data); @@ -2371,7 +2371,7 @@ export namespace reseller_v1 { } /** - * Create or transfer a subscription. + * Create 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). * @example * ```js * // Before running the sample: @@ -2397,9 +2397,9 @@ export namespace reseller_v1 { * * // Do the magic * const res = await reseller.subscriptions.insert({ - * // 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. + * // 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. * customerAuthToken: 'placeholder-value', - * // Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. + * // Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates. * customerId: 'placeholder-value', * * // Request body metadata @@ -2543,7 +2543,7 @@ export namespace reseller_v1 { } /** - * List of subscriptions managed by the reseller. The list can be all subscriptions, all of a customer's subscriptions, or all of a customer's transferable subscriptions. + * List of subscriptions managed by the reseller. The list can be all subscriptions, all of a customer's subscriptions, or all of a customer's transferable subscriptions. Optionally, this method can filter the response by a `customerNamePrefix`. For more information, see [manage subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions). * @example * ```js * // Before running the sample: @@ -2572,13 +2572,13 @@ export namespace reseller_v1 { * * // Do the magic * const res = await reseller.subscriptions.list({ - * // 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. + * // 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. * customerAuthToken: 'placeholder-value', - * // Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. + * // Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates. * customerId: 'placeholder-value', - * // When retrieving all of your subscriptions and filtering for specific customers, you can enter a prefix for a customer name. Using an example customer group that includes exam.com, example20.com and example.com: - exa -- Returns all customer names that start with 'exa' which could include exam.com, example20.com, and example.com. A name prefix is similar to using a regular expression's asterisk, exa*. - example -- Returns example20.com and example.com. + * // When retrieving all of your subscriptions and filtering for specific customers, you can enter a prefix for a customer name. Using an example customer group that includes `exam.com`, `example20.com` and `example.com`: - `exa` -- Returns all customer names that start with 'exa' which could include `exam.com`, `example20.com`, and `example.com`. A name prefix is similar to using a regular expression's asterisk, exa*. - `example` -- Returns `example20.com` and `example.com`. * customerNamePrefix: 'placeholder-value', - * // When retrieving a large list, the maxResults is the maximum number of results per page. The nextPageToken value takes you to the next page. The default is 20. + * // When retrieving a large list, the `maxResults` is the maximum number of results per page. The `nextPageToken` value takes you to the next page. The default is 20. * maxResults: 'placeholder-value', * // Token to specify next page in the list * pageToken: 'placeholder-value', @@ -2685,7 +2685,7 @@ export namespace reseller_v1 { } /** - * Immediately move a 30-day free trial subscription to a paid service subscription. + * Immediately move a 30-day free trial subscription to a paid service subscription. This method is only applicable if a payment plan has already been set up for the 30-day trial subscription. For more information, see [manage subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#paid_service). * @example * ```js * // Before running the sample: @@ -2711,9 +2711,9 @@ export namespace reseller_v1 { * * // Do the magic * const res = await reseller.subscriptions.startPaidService({ - * // Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. + * // Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates. * customerId: 'placeholder-value', - * // This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. + * // This is a required property. The `subscriptionId` is the subscription identifier and is unique for each customer. Since a `subscriptionId` changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the `subscriptionId` can be found using the retrieve all reseller subscriptions method. * subscriptionId: 'placeholder-value', * }); * console.log(res.data); @@ -2833,7 +2833,7 @@ export namespace reseller_v1 { } /** - * Suspends an active subscription. + * Suspends an active subscription. You can use this method to suspend a paid subscription that is currently in the `ACTIVE` state. * For `FLEXIBLE` subscriptions, billing is paused. * For `ANNUAL_MONTHLY_PAY` or `ANNUAL_YEARLY_PAY` subscriptions: * Suspending the subscription does not change the renewal date that was originally committed to. * A suspended subscription does not renew. If you activate the subscription after the original renewal date, a new annual subscription will be created, starting on the day of activation. We strongly encourage you to suspend subscriptions only for short periods of time as suspensions over 60 days may result in the subscription being cancelled. * @example * ```js * // Before running the sample: @@ -2859,9 +2859,9 @@ export namespace reseller_v1 { * * // Do the magic * const res = await reseller.subscriptions.suspend({ - * // Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. + * // Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates. * customerId: 'placeholder-value', - * // This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. + * // This is a required property. The `subscriptionId` is the subscription identifier and is unique for each customer. Since a `subscriptionId` changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the `subscriptionId` can be found using the retrieve all reseller subscriptions method. * subscriptionId: 'placeholder-value', * }); * console.log(res.data); @@ -2984,22 +2984,22 @@ export namespace reseller_v1 { export interface Params$Resource$Subscriptions$Activate extends StandardParameters { /** - * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. + * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates. */ customerId?: string; /** - * This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. + * This is a required property. The `subscriptionId` is the subscription identifier and is unique for each customer. Since a `subscriptionId` changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the `subscriptionId` can be found using the retrieve all reseller subscriptions method. */ subscriptionId?: string; } export interface Params$Resource$Subscriptions$Changeplan extends StandardParameters { /** - * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. + * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates. */ customerId?: string; /** - * This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. + * This is a required property. The `subscriptionId` is the subscription identifier and is unique for each customer. Since a `subscriptionId` changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the `subscriptionId` can be found using the retrieve all reseller subscriptions method. */ subscriptionId?: string; @@ -3011,11 +3011,11 @@ export namespace reseller_v1 { export interface Params$Resource$Subscriptions$Changerenewalsettings extends StandardParameters { /** - * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. + * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates. */ customerId?: string; /** - * This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. + * This is a required property. The `subscriptionId` is the subscription identifier and is unique for each customer. Since a `subscriptionId` changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the `subscriptionId` can be found using the retrieve all reseller subscriptions method. */ subscriptionId?: string; @@ -3027,11 +3027,11 @@ export namespace reseller_v1 { export interface Params$Resource$Subscriptions$Changeseats extends StandardParameters { /** - * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. + * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates. */ customerId?: string; /** - * This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. + * This is a required property. The `subscriptionId` is the subscription identifier and is unique for each customer. Since a `subscriptionId` changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the `subscriptionId` can be found using the retrieve all reseller subscriptions method. */ subscriptionId?: string; @@ -3043,37 +3043,37 @@ export namespace reseller_v1 { export interface Params$Resource$Subscriptions$Delete extends StandardParameters { /** - * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. + * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates. */ customerId?: string; /** - * The deletionType query string enables the cancellation, downgrade, or suspension of a subscription. + * The `deletionType` query string enables the cancellation, downgrade, or suspension of a subscription. */ deletionType?: string; /** - * This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. + * This is a required property. The `subscriptionId` is the subscription identifier and is unique for each customer. Since a `subscriptionId` changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the `subscriptionId` can be found using the retrieve all reseller subscriptions method. */ subscriptionId?: string; } export interface Params$Resource$Subscriptions$Get extends StandardParameters { /** - * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. + * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates. */ customerId?: string; /** - * This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. + * This is a required property. The `subscriptionId` is the subscription identifier and is unique for each customer. Since a `subscriptionId` changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the `subscriptionId` can be found using the retrieve all reseller subscriptions method. */ subscriptionId?: string; } export interface Params$Resource$Subscriptions$Insert extends StandardParameters { /** - * 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. + * 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. */ customerAuthToken?: string; /** - * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. + * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates. */ customerId?: string; @@ -3085,19 +3085,19 @@ export namespace reseller_v1 { export interface Params$Resource$Subscriptions$List extends StandardParameters { /** - * 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. + * 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. */ customerAuthToken?: string; /** - * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. + * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates. */ customerId?: string; /** - * When retrieving all of your subscriptions and filtering for specific customers, you can enter a prefix for a customer name. Using an example customer group that includes exam.com, example20.com and example.com: - exa -- Returns all customer names that start with 'exa' which could include exam.com, example20.com, and example.com. A name prefix is similar to using a regular expression's asterisk, exa*. - example -- Returns example20.com and example.com. + * When retrieving all of your subscriptions and filtering for specific customers, you can enter a prefix for a customer name. Using an example customer group that includes `exam.com`, `example20.com` and `example.com`: - `exa` -- Returns all customer names that start with 'exa' which could include `exam.com`, `example20.com`, and `example.com`. A name prefix is similar to using a regular expression's asterisk, exa*. - `example` -- Returns `example20.com` and `example.com`. */ customerNamePrefix?: string; /** - * When retrieving a large list, the maxResults is the maximum number of results per page. The nextPageToken value takes you to the next page. The default is 20. + * When retrieving a large list, the `maxResults` is the maximum number of results per page. The `nextPageToken` value takes you to the next page. The default is 20. */ maxResults?: number; /** @@ -3108,22 +3108,22 @@ export namespace reseller_v1 { export interface Params$Resource$Subscriptions$Startpaidservice extends StandardParameters { /** - * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. + * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates. */ customerId?: string; /** - * This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. + * This is a required property. The `subscriptionId` is the subscription identifier and is unique for each customer. Since a `subscriptionId` changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the `subscriptionId` can be found using the retrieve all reseller subscriptions method. */ subscriptionId?: string; } export interface Params$Resource$Subscriptions$Suspend extends StandardParameters { /** - * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. + * Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a `customerId` as a key for persistent data. If the domain name for a `customerId` is changed, the Google system automatically updates. */ customerId?: string; /** - * This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. + * This is a required property. The `subscriptionId` is the subscription identifier and is unique for each customer. Since a `subscriptionId` changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the `subscriptionId` can be found using the retrieve all reseller subscriptions method. */ subscriptionId?: string; }