Skip to content

Commit

Permalink
fix(reseller): update the API
Browse files Browse the repository at this point in the history 
#### reseller:v1

The following keys were changed:
- resources.customers.methods.get.description
- resources.customers.methods.insert.description
- resources.customers.methods.patch.description
- resources.customers.methods.update.description
- resources.subscriptions.methods.changePlan.description
- resources.subscriptions.methods.changeRenewalSettings.description
- resources.subscriptions.methods.changeSeats.description
- resources.subscriptions.methods.delete.description
- resources.subscriptions.methods.get.description
- resources.subscriptions.methods.insert.description
- resources.subscriptions.methods.list.description
- schemas.Customer.properties.alternateEmail.description
- schemas.Customer.properties.customerType.description
- schemas.Customer.properties.customerType.enumDescriptions
- schemas.PrimaryAdmin.properties.primaryEmail.description
- schemas.Subscription.properties.transferInfo.properties.currentLegacySkuId.description
  • Loading branch information
@yoshi-automation @bcoe
yoshi-automation authored and bcoe committed Jul 23, 2021
1 parent c4b864a commit 31d1483
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 32 deletions.
36 changes: 18 additions & 18 deletions discovery/reseller-v1.json
View file
Expand Up @@ -111,7 +111,7 @@
"customers": {
"methods": {
"get": {
"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).",
"description": "Gets 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",
Expand All @@ -136,7 +136,7 @@
]
},
"insert": {
"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).",
"description": "Orders 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",
Expand All @@ -160,7 +160,7 @@
]
},
"patch": {
"description": "Update a customer account's settings. This method supports patch semantics.",
"description": "Updates a customer account's settings. This method supports patch semantics. You cannot update `customerType` via the Reseller API, but a `\"team\"` customer can verify their domain and become `customerType = \"domain\"`. For more information, see [Verify your domain to unlock Essentials features](https://support.google.com/a/answer/9122284).",
"flatPath": "apps/reseller/v1/customers/{customerId}",
"httpMethod": "PATCH",
"id": "reseller.customers.patch",
Expand All @@ -187,7 +187,7 @@
]
},
"update": {
"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).",
"description": "Updates a customer account's settings. You cannot update `customerType` via the Reseller API, but a `\"team\"` customer can verify their domain and become `customerType = \"domain\"`. 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",
Expand Down Expand Up @@ -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. 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).",
"description": "Updates 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",
Expand Down Expand Up @@ -345,7 +345,7 @@
]
},
"changeRenewalSettings": {
"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).",
"description": "Updates 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",
Expand Down Expand Up @@ -379,7 +379,7 @@
]
},
"changeSeats": {
"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).",
"description": "Updates 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",
Expand Down Expand Up @@ -413,7 +413,7 @@
]
},
"delete": {
"description": "Cancel, suspend, or transfer a subscription to direct.",
"description": "Cancels, suspends, or transfers a subscription to direct.",
"flatPath": "apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}",
"httpMethod": "DELETE",
"id": "reseller.subscriptions.delete",
Expand Down Expand Up @@ -458,7 +458,7 @@
]
},
"get": {
"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).",
"description": "Gets a specific subscription. The `subscriptionId` can be found using the [Retrieve all reseller subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#get_all_subscriptions) method. For more information about retrieving a specific subscription, see the information descrived in [manage subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#get_subscription).",
"flatPath": "apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}",
"httpMethod": "GET",
"id": "reseller.subscriptions.get",
Expand Down Expand Up @@ -490,7 +490,7 @@
]
},
"insert": {
"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).",
"description": "Creates or transfer a subscription. Create a subscription for a customer's account that you ordered using the [Order a new customer account](/admin-sdk/reseller/v1/reference/customers/insert.html) method. For more information about creating a subscription for different payment plans, see [manage subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#create_subscription).\\ If you did not order the customer's account using the customer insert method, use the customer's `customerAuthToken` when creating a subscription for that customer. If transferring a G Suite subscription with an associated Google Drive or Google Vault subscription, use the [batch operation](/admin-sdk/reseller/v1/how-tos/batch.html) to transfer all of these subscriptions. For more information, see how to [transfer subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions#transfer_a_subscription).",
"flatPath": "apps/reseller/v1/customers/{customerId}/subscriptions",
"httpMethod": "POST",
"id": "reseller.subscriptions.insert",
Expand Down Expand Up @@ -522,7 +522,7 @@
]
},
"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. Optionally, this method can filter the response by a `customerNamePrefix`. For more information, see [manage subscriptions](/admin-sdk/reseller/v1/how-tos/manage_subscriptions).",
"description": "Lists 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",
Expand Down Expand Up @@ -631,7 +631,7 @@
}
}
},
"revision": "20210623",
"revision": "20210720",
"rootUrl": "https://reseller.googleapis.com/",
"schemas": {
"Address": {
Expand Down Expand Up @@ -715,7 +715,7 @@
"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 \"domain\" customer and should not use the same domain as `customerDomain`. The `alternateEmail` field is not necessary to create a \"team\" customer.",
"type": "string"
},
"customerDomain": {
Expand All @@ -731,16 +731,16 @@
"type": "string"
},
"customerType": {
"description": "The type of the customer (DOMAIN or TEAM), default is DOMAIN.",
"description": "Identifies the type of the customer. Acceptable values include: * `domain`: Implies a domain-verified customer (default). * `team`: Implies an email-verified customer. For more information, see [managed teams](https://support.google.com/a/users/answer/9939479).",
"enum": [
"CUSTOMER_TYPE_UNSPECIFIED",
"DOMAIN",
"TEAM"
],
"enumDescriptions": [
"Customer type not known",
"Domained or domain owning customers",
"Domainless customers"
"Domained or domain-owning customers",
"Domainless or email-verified customers"
],
"type": "string"
},
Expand Down Expand Up @@ -773,7 +773,7 @@
"id": "PrimaryAdmin",
"properties": {
"primaryEmail": {
"description": "Primary admin's domained email This email's domain will be used to create TEAM customer",
"description": "The business email of the primary administrator of the customer. The email verification link is sent to this email address at the time of customer creation. Primary administrators have access to the customer's Admin Console, including the ability to invite and evict users and manage the administrative needs of the customer.",
"type": "string"
}
},
Expand Down Expand Up @@ -954,7 +954,7 @@
"description": "Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.",
"properties": {
"currentLegacySkuId": {
"description": "Sku id of the current resold subscription. This is populated only when customer has subscription with legacy sku and the subscription resource is populated with recommeded sku for transfer in.",
"description": "The `skuId` of the current resold subscription. This is populated only when the customer has a subscription with a legacy SKU and the subscription resource is populated with the `skuId` of the SKU recommended for the transfer.",
"type": "string"
},
"minimumTransferableSeats": {
Expand Down

0 comments on commit 31d1483

Please sign in to comment.