{ "uuid": "fdea76e8-911d-47ac-be3a-d884b95643bf", "lastMigration": 29, "name": "Cloud Channel API", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "a345c06b-a1ad-48df-9f23-b6630cc35c6c", "documentation": "Lists the Products the reseller is authorized to sell. Possible error codes: * INVALID_ARGUMENT: Required request parameters are missing or invalid.", "method": "get", "endpoint": "v1/products", "responses": [ { "uuid": "18b29022-9016-49dc-84b3-e329041282ab", "body": "{\n \"nextPageToken\": \"\",\n \"products\": [\n {\n \"marketingInfo\": {\n \"defaultLogo\": {\n \"content\": \"\",\n \"title\": \"\",\n \"type\": \"{{oneOf (array 'MEDIA_TYPE_UNSPECIFIED' 'MEDIA_TYPE_IMAGE')}}\"\n },\n \"description\": \"\",\n \"displayName\": \"\"\n },\n \"name\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "87dedef2-4dee-4cc3-a543-815e861eeb0a", "documentation": "Lists service accounts with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: A list of service email addresses.", "method": "get", "endpoint": "v1/:account:listSubscribers", "responses": [ { "uuid": "872db83b-f4a7-47e7-a4a2-73611741d500", "body": "{\n \"nextPageToken\": \"\",\n \"serviceAccounts\": [\n \"\"\n ],\n \"topic\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fb53caaa-b483-4475-a0e4-da5ab2744d72", "documentation": "Registers a service account with subscriber privileges on the Cloud Pub/Sub topic for this Channel Services account. After you create a subscriber, you get the events through SubscriberEvent Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name with the registered service email address.", "method": "post", "endpoint": "v1/:account:register", "responses": [ { "uuid": "e3ace957-a680-41a8-8bdf-545fc3a55571", "body": "{\n \"topic\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6369cf1f-d565-44c6-b92c-507b306bf5c1", "documentation": "Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name that unregistered the service email address. Returns a success response if the service email address wasn't registered with the topic.", "method": "post", "endpoint": "v1/:account:unregister", "responses": [ { "uuid": "32e32549-5ad0-44ac-96c1-8e2dec732def", "body": "{\n \"topic\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a8ab3ba7-f36a-436e-beb5-e97bf832064e", "documentation": "Lists the following: * Offers that you can purchase for a customer. * Offers that you can change for an entitlement. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller * INVALID_ARGUMENT: Required request parameters are missing or invalid.", "method": "get", "endpoint": "v1/:customer:listPurchasableOffers", "responses": [ { "uuid": "d83564ed-f9ba-41a6-903d-e88f2b4312b8", "body": "{\n \"nextPageToken\": \"\",\n \"purchasableOffers\": [\n {\n \"offer\": {\n \"constraints\": {\n \"customerConstraints\": {\n \"allowedCustomerTypes\": [\n \"{{oneOf (array 'CUSTOMER_TYPE_UNSPECIFIED' 'DOMAIN' 'TEAM')}}\"\n ],\n \"allowedRegions\": [\n \"\"\n ],\n \"promotionalOrderTypes\": [\n \"{{oneOf (array 'PROMOTIONAL_TYPE_UNSPECIFIED' 'NEW_UPGRADE' 'TRANSFER' 'PROMOTION_SWITCH')}}\"\n ]\n }\n },\n \"endTime\": \"\",\n \"marketingInfo\": {\n \"defaultLogo\": {\n \"content\": \"\",\n \"title\": \"\",\n \"type\": \"{{oneOf (array 'MEDIA_TYPE_UNSPECIFIED' 'MEDIA_TYPE_IMAGE')}}\"\n },\n \"description\": \"\",\n \"displayName\": \"\"\n },\n \"name\": \"\",\n \"parameterDefinitions\": [\n {\n \"allowedValues\": [\n {\n \"boolValue\": {{faker 'datatype.boolean'}},\n \"doubleValue\": {{faker 'number.float'}},\n \"int64Value\": \"\",\n \"protoValue\": {},\n \"stringValue\": \"\"\n }\n ],\n \"maxValue\": {\n \"boolValue\": {{faker 'datatype.boolean'}},\n \"doubleValue\": {{faker 'number.float'}},\n \"int64Value\": \"\",\n \"protoValue\": {},\n \"stringValue\": \"\"\n },\n \"minValue\": {\n \"boolValue\": {{faker 'datatype.boolean'}},\n \"doubleValue\": {{faker 'number.float'}},\n \"int64Value\": \"\",\n \"protoValue\": {},\n \"stringValue\": \"\"\n },\n \"name\": \"\",\n \"optional\": {{faker 'datatype.boolean'}},\n \"parameterType\": \"{{oneOf (array 'PARAMETER_TYPE_UNSPECIFIED' 'INT64' 'STRING' 'DOUBLE')}}\"\n }\n ],\n \"plan\": {\n \"billingAccount\": \"\",\n \"paymentCycle\": {\n \"duration\": {{faker 'number.int' max=99999}},\n \"periodType\": \"{{oneOf (array 'PERIOD_TYPE_UNSPECIFIED' 'DAY' 'MONTH' 'YEAR')}}\"\n },\n \"paymentPlan\": \"{{oneOf (array 'PAYMENT_PLAN_UNSPECIFIED' 'COMMITMENT' 'FLEXIBLE' 'FREE' 'TRIAL' 'OFFLINE')}}\",\n \"paymentType\": \"{{oneOf (array 'PAYMENT_TYPE_UNSPECIFIED' 'PREPAY' 'POSTPAY')}}\",\n \"trialPeriod\": {\n \"duration\": {{faker 'number.int' max=99999}},\n \"periodType\": \"{{oneOf (array 'PERIOD_TYPE_UNSPECIFIED' 'DAY' 'MONTH' 'YEAR')}}\"\n }\n },\n \"priceByResources\": [\n {\n \"price\": {\n \"basePrice\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"discount\": {{faker 'number.float'}},\n \"effectivePrice\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"externalPriceUri\": \"\"\n },\n \"pricePhases\": [\n {\n \"firstPeriod\": {{faker 'number.int' max=99999}},\n \"lastPeriod\": {{faker 'number.int' max=99999}},\n \"periodType\": \"{{oneOf (array 'PERIOD_TYPE_UNSPECIFIED' 'DAY' 'MONTH' 'YEAR')}}\",\n \"price\": {\n \"basePrice\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"discount\": {{faker 'number.float'}},\n \"effectivePrice\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"externalPriceUri\": \"\"\n },\n \"priceTiers\": [\n {\n \"firstResource\": {{faker 'number.int' max=99999}},\n \"lastResource\": {{faker 'number.int' max=99999}},\n \"price\": {\n \"basePrice\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"discount\": {{faker 'number.float'}},\n \"effectivePrice\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"externalPriceUri\": \"\"\n }\n }\n ]\n }\n ],\n \"resourceType\": \"{{oneOf (array 'RESOURCE_TYPE_UNSPECIFIED' 'SEAT' 'MAU' 'GB' 'LICENSED_USER' 'MINUTES' 'IAAS_USAGE' 'SUBSCRIPTION')}}\"\n }\n ],\n \"sku\": {\n \"marketingInfo\": {\n \"defaultLogo\": {\n \"content\": \"\",\n \"title\": \"\",\n \"type\": \"{{oneOf (array 'MEDIA_TYPE_UNSPECIFIED' 'MEDIA_TYPE_IMAGE')}}\"\n },\n \"description\": \"\",\n \"displayName\": \"\"\n },\n \"name\": \"\",\n \"product\": {\n \"marketingInfo\": {\n \"defaultLogo\": {\n \"content\": \"\",\n \"title\": \"\",\n \"type\": \"{{oneOf (array 'MEDIA_TYPE_UNSPECIFIED' 'MEDIA_TYPE_IMAGE')}}\"\n },\n \"description\": \"\",\n \"displayName\": \"\"\n },\n \"name\": \"\"\n }\n },\n \"startTime\": \"\"\n }\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1e4eba58-d7ce-4c09-8037-33fc849144dc", "documentation": "Lists the following: * SKUs that you can purchase for a customer * SKUs that you can upgrade or downgrade for an entitlement. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid.", "method": "get", "endpoint": "v1/:customer:listPurchasableSkus", "responses": [ { "uuid": "1cb4132b-c331-4df4-8f00-9bc599629214", "body": "{\n \"nextPageToken\": \"\",\n \"purchasableSkus\": [\n {\n \"sku\": {\n \"marketingInfo\": {\n \"defaultLogo\": {\n \"content\": \"\",\n \"title\": \"\",\n \"type\": \"{{oneOf (array 'MEDIA_TYPE_UNSPECIFIED' 'MEDIA_TYPE_IMAGE')}}\"\n },\n \"description\": \"\",\n \"displayName\": \"\"\n },\n \"name\": \"\",\n \"product\": {\n \"marketingInfo\": {\n \"defaultLogo\": {\n \"content\": \"\",\n \"title\": \"\",\n \"type\": \"{{oneOf (array 'MEDIA_TYPE_UNSPECIFIED' 'MEDIA_TYPE_IMAGE')}}\"\n },\n \"description\": \"\",\n \"displayName\": \"\"\n },\n \"name\": \"\"\n }\n }\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a1b6f61b-6d3d-4f1b-9d9a-e2fee33fc184", "documentation": "Creates a Cloud Identity for the given customer using the customer's information, or the information provided here. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer was not found. * ALREADY_EXISTS: The customer's primary email already exists. Retry after changing the customer's primary contact email. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata contains an instance of OperationMetadata.", "method": "post", "endpoint": "v1/:customer:provisionCloudIdentity", "responses": [ { "uuid": "a227784d-66b5-40fe-b94c-f0b6a0cfd630", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e2d56c81-6e7e-421a-90e2-cd135c8c98b8", "documentation": "Returns the requested Offer resource. Possible error codes: * PERMISSION_DENIED: The entitlement doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement or offer was not found. Return value: The Offer resource.", "method": "get", "endpoint": "v1/:entitlement:lookupOffer", "responses": [ { "uuid": "232e2349-6440-4fdc-a29d-d2b8e085ad42", "body": "{\n \"constraints\": {\n \"customerConstraints\": {\n \"allowedCustomerTypes\": [\n \"{{oneOf (array 'CUSTOMER_TYPE_UNSPECIFIED' 'DOMAIN' 'TEAM')}}\"\n ],\n \"allowedRegions\": [\n \"\"\n ],\n \"promotionalOrderTypes\": [\n \"{{oneOf (array 'PROMOTIONAL_TYPE_UNSPECIFIED' 'NEW_UPGRADE' 'TRANSFER' 'PROMOTION_SWITCH')}}\"\n ]\n }\n },\n \"endTime\": \"\",\n \"marketingInfo\": {\n \"defaultLogo\": {\n \"content\": \"\",\n \"title\": \"\",\n \"type\": \"{{oneOf (array 'MEDIA_TYPE_UNSPECIFIED' 'MEDIA_TYPE_IMAGE')}}\"\n },\n \"description\": \"\",\n \"displayName\": \"\"\n },\n \"name\": \"\",\n \"parameterDefinitions\": [\n {\n \"allowedValues\": [\n {\n \"boolValue\": {{faker 'datatype.boolean'}},\n \"doubleValue\": {{faker 'number.float'}},\n \"int64Value\": \"\",\n \"protoValue\": {},\n \"stringValue\": \"\"\n }\n ],\n \"maxValue\": {\n \"boolValue\": {{faker 'datatype.boolean'}},\n \"doubleValue\": {{faker 'number.float'}},\n \"int64Value\": \"\",\n \"protoValue\": {},\n \"stringValue\": \"\"\n },\n \"minValue\": {\n \"boolValue\": {{faker 'datatype.boolean'}},\n \"doubleValue\": {{faker 'number.float'}},\n \"int64Value\": \"\",\n \"protoValue\": {},\n \"stringValue\": \"\"\n },\n \"name\": \"\",\n \"optional\": {{faker 'datatype.boolean'}},\n \"parameterType\": \"{{oneOf (array 'PARAMETER_TYPE_UNSPECIFIED' 'INT64' 'STRING' 'DOUBLE')}}\"\n }\n ],\n \"plan\": {\n \"billingAccount\": \"\",\n \"paymentCycle\": {\n \"duration\": {{faker 'number.int' max=99999}},\n \"periodType\": \"{{oneOf (array 'PERIOD_TYPE_UNSPECIFIED' 'DAY' 'MONTH' 'YEAR')}}\"\n },\n \"paymentPlan\": \"{{oneOf (array 'PAYMENT_PLAN_UNSPECIFIED' 'COMMITMENT' 'FLEXIBLE' 'FREE' 'TRIAL' 'OFFLINE')}}\",\n \"paymentType\": \"{{oneOf (array 'PAYMENT_TYPE_UNSPECIFIED' 'PREPAY' 'POSTPAY')}}\",\n \"trialPeriod\": {\n \"duration\": {{faker 'number.int' max=99999}},\n \"periodType\": \"{{oneOf (array 'PERIOD_TYPE_UNSPECIFIED' 'DAY' 'MONTH' 'YEAR')}}\"\n }\n },\n \"priceByResources\": [\n {\n \"price\": {\n \"basePrice\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"discount\": {{faker 'number.float'}},\n \"effectivePrice\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"externalPriceUri\": \"\"\n },\n \"pricePhases\": [\n {\n \"firstPeriod\": {{faker 'number.int' max=99999}},\n \"lastPeriod\": {{faker 'number.int' max=99999}},\n \"periodType\": \"{{oneOf (array 'PERIOD_TYPE_UNSPECIFIED' 'DAY' 'MONTH' 'YEAR')}}\",\n \"price\": {\n \"basePrice\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"discount\": {{faker 'number.float'}},\n \"effectivePrice\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"externalPriceUri\": \"\"\n },\n \"priceTiers\": [\n {\n \"firstResource\": {{faker 'number.int' max=99999}},\n \"lastResource\": {{faker 'number.int' max=99999}},\n \"price\": {\n \"basePrice\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"discount\": {{faker 'number.float'}},\n \"effectivePrice\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"externalPriceUri\": \"\"\n }\n }\n ]\n }\n ],\n \"resourceType\": \"{{oneOf (array 'RESOURCE_TYPE_UNSPECIFIED' 'SEAT' 'MAU' 'GB' 'LICENSED_USER' 'MINUTES' 'IAAS_USAGE' 'SUBSCRIPTION')}}\"\n }\n ],\n \"sku\": {\n \"marketingInfo\": {\n \"defaultLogo\": {\n \"content\": \"\",\n \"title\": \"\",\n \"type\": \"{{oneOf (array 'MEDIA_TYPE_UNSPECIFIED' 'MEDIA_TYPE_IMAGE')}}\"\n },\n \"description\": \"\",\n \"displayName\": \"\"\n },\n \"name\": \"\",\n \"product\": {\n \"marketingInfo\": {\n \"defaultLogo\": {\n \"content\": \"\",\n \"title\": \"\",\n \"type\": \"{{oneOf (array 'MEDIA_TYPE_UNSPECIFIED' 'MEDIA_TYPE_IMAGE')}}\"\n },\n \"description\": \"\",\n \"displayName\": \"\"\n },\n \"name\": \"\"\n }\n },\n \"startTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "be9d6e37-d941-4f3a-9abd-befd25f8aec3", "documentation": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "method": "delete", "endpoint": "v1/:name", "responses": [ { "uuid": "b3335b98-8e6a-4712-ad03-3f4a50542a5b", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8ca9f024-9652-42ae-a06b-5c3d5f12f0b4", "documentation": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", "method": "get", "endpoint": "v1/:name", "responses": [ { "uuid": "58b19336-8fee-4e30-bcad-9b3dcfd61b55", "body": "{\n \"nextPageToken\": \"\",\n \"operations\": [\n {\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "36b5d79f-de4a-43d8-97ee-04b57cf0d379", "documentation": "Updates a CustomerRepricingConfig. Call this method to set modifications for a specific customer's bill. This method overwrites the existing CustomerRepricingConfig. You can only update configs if the RepricingConfig.effective_invoice_month is a future month. To make changes to configs for the current month, use CreateCustomerRepricingConfig, taking note of its restrictions. You cannot update the RepricingConfig.effective_invoice_month. When updating a config in the future: * This config must already exist. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months. * NOT_FOUND: The CustomerRepricingConfig specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the updated CustomerRepricingConfig resource, otherwise returns an error.", "method": "patch", "endpoint": "v1/:name", "responses": [ { "uuid": "775ad030-13da-438c-9e1e-e1d749139127", "body": "{\n \"name\": \"\",\n \"repricingConfig\": {\n \"adjustment\": {\n \"percentageAdjustment\": {\n \"percentage\": {\n \"value\": \"\"\n }\n }\n },\n \"channelPartnerGranularity\": {},\n \"effectiveInvoiceMonth\": {\n \"day\": {{faker 'number.int' max=99999}},\n \"month\": {{faker 'number.int' max=99999}},\n \"year\": {{faker 'number.int' max=99999}}\n },\n \"entitlementGranularity\": {\n \"entitlement\": \"\"\n },\n \"rebillingBasis\": \"{{oneOf (array 'REBILLING_BASIS_UNSPECIFIED' 'COST_AT_LIST' 'DIRECT_CUSTOMER_COST')}}\"\n },\n \"updateTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8b5be820-12b8-44c8-ab1b-284d3e36e430", "documentation": "Activates a previously suspended entitlement. Entitlements suspended for pending ToS acceptance can't be activated using this method. An entitlement activation is a long-running operation and it updates the state of the customer entitlement. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement resource not found. * SUSPENSION_NOT_RESELLER_INITIATED: Can only activate reseller-initiated suspensions and entitlements that have accepted the TOS. * NOT_SUSPENDED: Can only activate suspended entitlements not in an ACTIVE state. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.", "method": "post", "endpoint": "v1/:name:activate", "responses": [ { "uuid": "df81258d-8394-444f-997d-23454a36ad4b", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d3a5413d-e1b8-42a1-96be-84a7427cdf34", "documentation": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "method": "post", "endpoint": "v1/:name:cancel", "responses": [ { "uuid": "0e90f496-e8c7-461b-921b-b387d75411c1", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "91c87dc1-8975-40ae-bc19-6b890cfe8668", "documentation": "Updates the Offer for an existing customer entitlement. An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Offer or Entitlement resource not found. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.", "method": "post", "endpoint": "v1/:name:changeOffer", "responses": [ { "uuid": "5abcc2e6-5034-4018-80bc-adef102e9e76", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2ae0b261-4e6d-4165-b53c-0f2f442028eb", "documentation": "Change parameters of the entitlement. An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. For example, the number of seats being changed is greater than the allowed number of max seats, or decreasing seats for a commitment based plan. * NOT_FOUND: Entitlement resource not found. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.", "method": "post", "endpoint": "v1/:name:changeParameters", "responses": [ { "uuid": "fd112f0e-202b-4152-9b62-5317c6d8166e", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "34a8f970-d00a-4515-ab97-7dcbe4e3b242", "documentation": "Updates the renewal settings for an existing customer entitlement. An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement resource not found. * NOT_COMMITMENT_PLAN: Renewal Settings are only applicable for a commitment plan. Can't enable or disable renewals for non-commitment plans. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.", "method": "post", "endpoint": "v1/:name:changeRenewalSettings", "responses": [ { "uuid": "73367ce9-2a7d-435a-ba34-5f174a4b715b", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "17358863-008e-4b52-960f-47b456f80c3e", "documentation": "Starts paid service for a trial entitlement. Starts paid service for a trial entitlement immediately. This method is only applicable if a plan is set up for a trial entitlement but has some trial days remaining. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement resource not found. * FAILED_PRECONDITION/NOT_IN_TRIAL: This method only works for entitlement on trial plans. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.", "method": "post", "endpoint": "v1/:name:startPaidService", "responses": [ { "uuid": "8b1f9bff-b66a-41c8-af03-26574760284d", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b4e12267-e19b-4ca5-bf1e-b276a25ab168", "documentation": "Suspends a previously fulfilled entitlement. An entitlement suspension is a long-running operation. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement resource not found. * NOT_ACTIVE: Entitlement is not active. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.", "method": "post", "endpoint": "v1/:name:suspend", "responses": [ { "uuid": "61f0aff1-3b2a-4ebf-a01a-6bf4794dcdff", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "38363547-346f-4323-95dc-4f20951c9705", "documentation": "List ChannelPartnerLinks belonging to a distributor. You must be a distributor to call this method. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: The list of the distributor account's ChannelPartnerLink resources.", "method": "get", "endpoint": "v1/:parent/channelPartnerLinks", "responses": [ { "uuid": "156464d9-8c28-4d74-8d32-fd43497c0c47", "body": "{\n \"channelPartnerLinks\": [\n {\n \"channelPartnerCloudIdentityInfo\": {\n \"adminConsoleUri\": \"\",\n \"alternateEmail\": \"\",\n \"customerType\": \"{{oneOf (array 'CUSTOMER_TYPE_UNSPECIFIED' 'DOMAIN' 'TEAM')}}\",\n \"eduData\": {\n \"instituteSize\": \"{{oneOf (array 'INSTITUTE_SIZE_UNSPECIFIED' 'SIZE_1_100' 'SIZE_101_500' 'SIZE_501_1000' 'SIZE_1001_2000' 'SIZE_2001_5000' 'SIZE_5001_10000' 'SIZE_10001_OR_MORE')}}\",\n \"instituteType\": \"{{oneOf (array 'INSTITUTE_TYPE_UNSPECIFIED' 'K12' 'UNIVERSITY')}}\",\n \"website\": \"\"\n },\n \"isDomainVerified\": {{faker 'datatype.boolean'}},\n \"languageCode\": \"\",\n \"phoneNumber\": \"\",\n \"primaryDomain\": \"\"\n },\n \"createTime\": \"\",\n \"inviteLinkUri\": \"\",\n \"linkState\": \"{{oneOf (array 'CHANNEL_PARTNER_LINK_STATE_UNSPECIFIED' 'INVITED' 'ACTIVE' 'REVOKED' 'SUSPENDED')}}\",\n \"name\": \"\",\n \"publicId\": \"\",\n \"resellerCloudIdentityId\": \"\",\n \"updateTime\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "decc3b70-82c0-4f1b-be39-71f9e360e5e1", "documentation": "Initiates a channel partner link between a distributor and a reseller, or between resellers in an n-tier reseller channel. Invited partners need to follow the invite_link_uri provided in the response to accept. After accepting the invitation, a link is set up between the two parties. You must be a distributor to call this method. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * ALREADY_EXISTS: The ChannelPartnerLink sent in the request already exists. * NOT_FOUND: No Cloud Identity customer exists for provided domain. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The new ChannelPartnerLink resource.", "method": "post", "endpoint": "v1/:parent/channelPartnerLinks", "responses": [ { "uuid": "efbeba00-6ca1-45f9-b988-32df682acd74", "body": "{\n \"channelPartnerCloudIdentityInfo\": {\n \"adminConsoleUri\": \"\",\n \"alternateEmail\": \"\",\n \"customerType\": \"{{oneOf (array 'CUSTOMER_TYPE_UNSPECIFIED' 'DOMAIN' 'TEAM')}}\",\n \"eduData\": {\n \"instituteSize\": \"{{oneOf (array 'INSTITUTE_SIZE_UNSPECIFIED' 'SIZE_1_100' 'SIZE_101_500' 'SIZE_501_1000' 'SIZE_1001_2000' 'SIZE_2001_5000' 'SIZE_5001_10000' 'SIZE_10001_OR_MORE')}}\",\n \"instituteType\": \"{{oneOf (array 'INSTITUTE_TYPE_UNSPECIFIED' 'K12' 'UNIVERSITY')}}\",\n \"website\": \"\"\n },\n \"isDomainVerified\": {{faker 'datatype.boolean'}},\n \"languageCode\": \"\",\n \"phoneNumber\": \"\",\n \"primaryDomain\": \"\"\n },\n \"createTime\": \"\",\n \"inviteLinkUri\": \"\",\n \"linkState\": \"{{oneOf (array 'CHANNEL_PARTNER_LINK_STATE_UNSPECIFIED' 'INVITED' 'ACTIVE' 'REVOKED' 'SUSPENDED')}}\",\n \"name\": \"\",\n \"publicId\": \"\",\n \"resellerCloudIdentityId\": \"\",\n \"updateTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2e1e8d61-3201-4f5d-b37b-ed367cfad48e", "documentation": "Lists information about how a Reseller modifies their bill before sending it to a ChannelPartner. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * NOT_FOUND: The ChannelPartnerRepricingConfig specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the ChannelPartnerRepricingConfig resources. The data for each resource is displayed in the ascending order of: * channel partner ID * RepricingConfig.effective_invoice_month * ChannelPartnerRepricingConfig.update_time If unsuccessful, returns an error.", "method": "get", "endpoint": "v1/:parent/channelPartnerRepricingConfigs", "responses": [ { "uuid": "a97d73ff-7340-44fa-b223-dba0f87c7bd4", "body": "{\n \"channelPartnerRepricingConfigs\": [\n {\n \"name\": \"\",\n \"repricingConfig\": {\n \"adjustment\": {\n \"percentageAdjustment\": {\n \"percentage\": {\n \"value\": \"\"\n }\n }\n },\n \"channelPartnerGranularity\": {},\n \"effectiveInvoiceMonth\": {\n \"day\": {{faker 'number.int' max=99999}},\n \"month\": {{faker 'number.int' max=99999}},\n \"year\": {{faker 'number.int' max=99999}}\n },\n \"entitlementGranularity\": {\n \"entitlement\": \"\"\n },\n \"rebillingBasis\": \"{{oneOf (array 'REBILLING_BASIS_UNSPECIFIED' 'COST_AT_LIST' 'DIRECT_CUSTOMER_COST')}}\"\n },\n \"updateTime\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5748cc9a-3588-4a41-a225-b0f8acb9acef", "documentation": "Creates a ChannelPartnerRepricingConfig. Call this method to set modifications for a specific ChannelPartner's bill. You can only create configs if the RepricingConfig.effective_invoice_month is a future month. If needed, you can create a config for the current month, with some restrictions. When creating a config for a future month, make sure there are no existing configs for that RepricingConfig.effective_invoice_month. The following restrictions are for creating configs in the current month. * This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases. * The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours. * There is a limit of ten configs for any ChannelPartner or RepricingConfig.effective_invoice_month. * The contained ChannelPartnerRepricingConfig.repricing_config vaule must be different from the value used in the current config for a ChannelPartner. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months. * NOT_FOUND: The ChannelPartnerRepricingConfig specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the updated ChannelPartnerRepricingConfig resource, otherwise returns an error.", "method": "post", "endpoint": "v1/:parent/channelPartnerRepricingConfigs", "responses": [ { "uuid": "8f47476f-1d59-490a-b852-8a67bb574936", "body": "{\n \"name\": \"\",\n \"repricingConfig\": {\n \"adjustment\": {\n \"percentageAdjustment\": {\n \"percentage\": {\n \"value\": \"\"\n }\n }\n },\n \"channelPartnerGranularity\": {},\n \"effectiveInvoiceMonth\": {\n \"day\": {{faker 'number.int' max=99999}},\n \"month\": {{faker 'number.int' max=99999}},\n \"year\": {{faker 'number.int' max=99999}}\n },\n \"entitlementGranularity\": {\n \"entitlement\": \"\"\n },\n \"rebillingBasis\": \"{{oneOf (array 'REBILLING_BASIS_UNSPECIFIED' 'COST_AT_LIST' 'DIRECT_CUSTOMER_COST')}}\"\n },\n \"updateTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c0c76c01-d100-475c-bdce-1cf523f387e8", "documentation": "Lists information about how a Reseller modifies their bill before sending it to a Customer. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * NOT_FOUND: The CustomerRepricingConfig specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the CustomerRepricingConfig resources. The data for each resource is displayed in the ascending order of: * customer ID * RepricingConfig.EntitlementGranularity.entitlement * RepricingConfig.effective_invoice_month * CustomerRepricingConfig.update_time If unsuccessful, returns an error.", "method": "get", "endpoint": "v1/:parent/customerRepricingConfigs", "responses": [ { "uuid": "d5c95769-ae1d-4bb4-b346-e234d2d63316", "body": "{\n \"customerRepricingConfigs\": [\n {\n \"name\": \"\",\n \"repricingConfig\": {\n \"adjustment\": {\n \"percentageAdjustment\": {\n \"percentage\": {\n \"value\": \"\"\n }\n }\n },\n \"channelPartnerGranularity\": {},\n \"effectiveInvoiceMonth\": {\n \"day\": {{faker 'number.int' max=99999}},\n \"month\": {{faker 'number.int' max=99999}},\n \"year\": {{faker 'number.int' max=99999}}\n },\n \"entitlementGranularity\": {\n \"entitlement\": \"\"\n },\n \"rebillingBasis\": \"{{oneOf (array 'REBILLING_BASIS_UNSPECIFIED' 'COST_AT_LIST' 'DIRECT_CUSTOMER_COST')}}\"\n },\n \"updateTime\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c13e9d92-8aad-4993-9875-db48542d5625", "documentation": "Creates a CustomerRepricingConfig. Call this method to set modifications for a specific customer's bill. You can only create configs if the RepricingConfig.effective_invoice_month is a future month. If needed, you can create a config for the current month, with some restrictions. When creating a config for a future month, make sure there are no existing configs for that RepricingConfig.effective_invoice_month. The following restrictions are for creating configs in the current month. * This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases. * The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours. * There is a limit of ten configs for any RepricingConfig.EntitlementGranularity.entitlement or RepricingConfig.effective_invoice_month. * The contained CustomerRepricingConfig.repricing_config vaule must be different from the value used in the current config for a RepricingConfig.EntitlementGranularity.entitlement. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months. * NOT_FOUND: The CustomerRepricingConfig specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the updated CustomerRepricingConfig resource, otherwise returns an error.", "method": "post", "endpoint": "v1/:parent/customerRepricingConfigs", "responses": [ { "uuid": "81ed3f29-aed8-4b75-b34c-2d718e97bd4a", "body": "{\n \"name\": \"\",\n \"repricingConfig\": {\n \"adjustment\": {\n \"percentageAdjustment\": {\n \"percentage\": {\n \"value\": \"\"\n }\n }\n },\n \"channelPartnerGranularity\": {},\n \"effectiveInvoiceMonth\": {\n \"day\": {{faker 'number.int' max=99999}},\n \"month\": {{faker 'number.int' max=99999}},\n \"year\": {{faker 'number.int' max=99999}}\n },\n \"entitlementGranularity\": {\n \"entitlement\": \"\"\n },\n \"rebillingBasis\": \"{{oneOf (array 'REBILLING_BASIS_UNSPECIFIED' 'COST_AT_LIST' 'DIRECT_CUSTOMER_COST')}}\"\n },\n \"updateTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a0337ccc-3ee2-43ae-a1e7-14f48c7c5877", "documentation": "List Customers. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: List of Customers, or an empty list if there are no customers.", "method": "get", "endpoint": "v1/:parent/customers", "responses": [ { "uuid": "60420991-ce7c-4d32-ba9b-7953ff7604a9", "body": "{\n \"customers\": [\n {\n \"alternateEmail\": \"\",\n \"channelPartnerId\": \"\",\n \"cloudIdentityId\": \"\",\n \"cloudIdentityInfo\": {\n \"adminConsoleUri\": \"\",\n \"alternateEmail\": \"\",\n \"customerType\": \"{{oneOf (array 'CUSTOMER_TYPE_UNSPECIFIED' 'DOMAIN' 'TEAM')}}\",\n \"eduData\": {\n \"instituteSize\": \"{{oneOf (array 'INSTITUTE_SIZE_UNSPECIFIED' 'SIZE_1_100' 'SIZE_101_500' 'SIZE_501_1000' 'SIZE_1001_2000' 'SIZE_2001_5000' 'SIZE_5001_10000' 'SIZE_10001_OR_MORE')}}\",\n \"instituteType\": \"{{oneOf (array 'INSTITUTE_TYPE_UNSPECIFIED' 'K12' 'UNIVERSITY')}}\",\n \"website\": \"\"\n },\n \"isDomainVerified\": {{faker 'datatype.boolean'}},\n \"languageCode\": \"\",\n \"phoneNumber\": \"\",\n \"primaryDomain\": \"\"\n },\n \"createTime\": \"\",\n \"domain\": \"\",\n \"languageCode\": \"\",\n \"name\": \"\",\n \"orgDisplayName\": \"\",\n \"orgPostalAddress\": {\n \"addressLines\": [\n \"\"\n ],\n \"administrativeArea\": \"\",\n \"languageCode\": \"\",\n \"locality\": \"\",\n \"organization\": \"\",\n \"postalCode\": \"\",\n \"recipients\": [\n \"\"\n ],\n \"regionCode\": \"\",\n \"revision\": {{faker 'number.int' max=99999}},\n \"sortingCode\": \"\",\n \"sublocality\": \"\"\n },\n \"primaryContactInfo\": {\n \"displayName\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": \"\",\n \"title\": \"\"\n },\n \"updateTime\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3c66293a-08ce-4fd8-b393-0e5a534bfbce", "documentation": "Creates a new Customer resource under the reseller or distributor account. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: * Required request parameters are missing or invalid. * Domain field value doesn't match the primary email domain. Return value: The newly created Customer resource.", "method": "post", "endpoint": "v1/:parent/customers", "responses": [ { "uuid": "a23d8d7a-991b-4100-aafc-fcb2be7df3c9", "body": "{\n \"alternateEmail\": \"\",\n \"channelPartnerId\": \"\",\n \"cloudIdentityId\": \"\",\n \"cloudIdentityInfo\": {\n \"adminConsoleUri\": \"\",\n \"alternateEmail\": \"\",\n \"customerType\": \"{{oneOf (array 'CUSTOMER_TYPE_UNSPECIFIED' 'DOMAIN' 'TEAM')}}\",\n \"eduData\": {\n \"instituteSize\": \"{{oneOf (array 'INSTITUTE_SIZE_UNSPECIFIED' 'SIZE_1_100' 'SIZE_101_500' 'SIZE_501_1000' 'SIZE_1001_2000' 'SIZE_2001_5000' 'SIZE_5001_10000' 'SIZE_10001_OR_MORE')}}\",\n \"instituteType\": \"{{oneOf (array 'INSTITUTE_TYPE_UNSPECIFIED' 'K12' 'UNIVERSITY')}}\",\n \"website\": \"\"\n },\n \"isDomainVerified\": {{faker 'datatype.boolean'}},\n \"languageCode\": \"\",\n \"phoneNumber\": \"\",\n \"primaryDomain\": \"\"\n },\n \"createTime\": \"\",\n \"domain\": \"\",\n \"languageCode\": \"\",\n \"name\": \"\",\n \"orgDisplayName\": \"\",\n \"orgPostalAddress\": {\n \"addressLines\": [\n \"\"\n ],\n \"administrativeArea\": \"\",\n \"languageCode\": \"\",\n \"locality\": \"\",\n \"organization\": \"\",\n \"postalCode\": \"\",\n \"recipients\": [\n \"\"\n ],\n \"regionCode\": \"\",\n \"revision\": {{faker 'number.int' max=99999}},\n \"sortingCode\": \"\",\n \"sublocality\": \"\"\n },\n \"primaryContactInfo\": {\n \"displayName\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": \"\",\n \"title\": \"\"\n },\n \"updateTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9a0f3ed8-cd90-4f74-b4dd-a59306ab26de", "documentation": "Imports a Customer from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call. If a linked Customer already exists and overwrite_if_exists is true, it will update that Customer's data. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * NOT_FOUND: Cloud Identity doesn't exist or was deleted. * INVALID_ARGUMENT: Required parameters are missing, or the auth_token is expired or invalid. * ALREADY_EXISTS: A customer already exists and has conflicting critical fields. Requires an overwrite. Return value: The Customer.", "method": "post", "endpoint": "v1/:parent/customers:import", "responses": [ { "uuid": "479a8cb4-3898-42ca-957a-e095849e0a06", "body": "{\n \"alternateEmail\": \"\",\n \"channelPartnerId\": \"\",\n \"cloudIdentityId\": \"\",\n \"cloudIdentityInfo\": {\n \"adminConsoleUri\": \"\",\n \"alternateEmail\": \"\",\n \"customerType\": \"{{oneOf (array 'CUSTOMER_TYPE_UNSPECIFIED' 'DOMAIN' 'TEAM')}}\",\n \"eduData\": {\n \"instituteSize\": \"{{oneOf (array 'INSTITUTE_SIZE_UNSPECIFIED' 'SIZE_1_100' 'SIZE_101_500' 'SIZE_501_1000' 'SIZE_1001_2000' 'SIZE_2001_5000' 'SIZE_5001_10000' 'SIZE_10001_OR_MORE')}}\",\n \"instituteType\": \"{{oneOf (array 'INSTITUTE_TYPE_UNSPECIFIED' 'K12' 'UNIVERSITY')}}\",\n \"website\": \"\"\n },\n \"isDomainVerified\": {{faker 'datatype.boolean'}},\n \"languageCode\": \"\",\n \"phoneNumber\": \"\",\n \"primaryDomain\": \"\"\n },\n \"createTime\": \"\",\n \"domain\": \"\",\n \"languageCode\": \"\",\n \"name\": \"\",\n \"orgDisplayName\": \"\",\n \"orgPostalAddress\": {\n \"addressLines\": [\n \"\"\n ],\n \"administrativeArea\": \"\",\n \"languageCode\": \"\",\n \"locality\": \"\",\n \"organization\": \"\",\n \"postalCode\": \"\",\n \"recipients\": [\n \"\"\n ],\n \"regionCode\": \"\",\n \"revision\": {{faker 'number.int' max=99999}},\n \"sortingCode\": \"\",\n \"sublocality\": \"\"\n },\n \"primaryContactInfo\": {\n \"displayName\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": \"\",\n \"title\": \"\"\n },\n \"updateTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5df31327-a817-4fd6-a72b-3b8e4db89e9a", "documentation": "Lists Entitlements belonging to a customer. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: A list of the customer's Entitlements.", "method": "get", "endpoint": "v1/:parent/entitlements", "responses": [ { "uuid": "3dc09761-4795-4e3d-bf60-cbf260507276", "body": "{\n \"entitlements\": [\n {\n \"associationInfo\": {\n \"baseEntitlement\": \"\"\n },\n \"commitmentSettings\": {\n \"endTime\": \"\",\n \"renewalSettings\": {\n \"enableRenewal\": {{faker 'datatype.boolean'}},\n \"paymentCycle\": {\n \"duration\": {{faker 'number.int' max=99999}},\n \"periodType\": \"{{oneOf (array 'PERIOD_TYPE_UNSPECIFIED' 'DAY' 'MONTH' 'YEAR')}}\"\n },\n \"paymentPlan\": \"{{oneOf (array 'PAYMENT_PLAN_UNSPECIFIED' 'COMMITMENT' 'FLEXIBLE' 'FREE' 'TRIAL' 'OFFLINE')}}\",\n \"resizeUnitCount\": {{faker 'datatype.boolean'}}\n },\n \"startTime\": \"\"\n },\n \"createTime\": \"\",\n \"name\": \"\",\n \"offer\": \"\",\n \"parameters\": [\n {\n \"editable\": {{faker 'datatype.boolean'}},\n \"name\": \"\",\n \"value\": {\n \"boolValue\": {{faker 'datatype.boolean'}},\n \"doubleValue\": {{faker 'number.float'}},\n \"int64Value\": \"\",\n \"protoValue\": {},\n \"stringValue\": \"\"\n }\n }\n ],\n \"provisionedService\": {\n \"productId\": \"\",\n \"provisioningId\": \"\",\n \"skuId\": \"\"\n },\n \"provisioningState\": \"{{oneOf (array 'PROVISIONING_STATE_UNSPECIFIED' 'ACTIVE' 'SUSPENDED')}}\",\n \"purchaseOrderId\": \"\",\n \"suspensionReasons\": [\n \"{{oneOf (array 'SUSPENSION_REASON_UNSPECIFIED' 'RESELLER_INITIATED' 'TRIAL_ENDED' 'RENEWAL_WITH_TYPE_CANCEL' 'PENDING_TOS_ACCEPTANCE' 'OTHER')}}\"\n ],\n \"trialSettings\": {\n \"endTime\": \"\",\n \"trial\": {{faker 'datatype.boolean'}}\n },\n \"updateTime\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c18d8289-84fb-417c-b5da-1c8167e1e6fc", "documentation": "Creates an entitlement for a customer. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: * Required request parameters are missing or invalid. * There is already a customer entitlement for a SKU from the same product family. * INVALID_VALUE: Make sure the OfferId is valid. If it is, contact Google Channel support for further troubleshooting. * NOT_FOUND: The customer or offer resource was not found. * ALREADY_EXISTS: * The SKU was already purchased for the customer. * The customer's primary email already exists. Retry after changing the customer's primary contact email. * CONDITION_NOT_MET or FAILED_PRECONDITION: * The domain required for purchasing a SKU has not been verified. * A pre-requisite SKU required to purchase an Add-On SKU is missing. For example, Google Workspace Business Starter is required to purchase Vault or Drive. * (Developer accounts only) Reseller and resold domain must meet the following naming requirements: * Domain names must start with goog-test. * Domain names must include the reseller domain. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.", "method": "post", "endpoint": "v1/:parent/entitlements", "responses": [ { "uuid": "b6e4ecdc-3ef6-4677-8d2c-f2883e502398", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f5aad2de-6d74-402d-9fe9-68b909b6ee72", "documentation": "Lists the Offers the reseller can sell. Possible error codes: * INVALID_ARGUMENT: Required request parameters are missing or invalid.", "method": "get", "endpoint": "v1/:parent/offers", "responses": [ { "uuid": "889f48eb-992b-40e1-b948-74bc4c91f9b3", "body": "{\n \"nextPageToken\": \"\",\n \"offers\": [\n {\n \"constraints\": {\n \"customerConstraints\": {\n \"allowedCustomerTypes\": [\n \"{{oneOf (array 'CUSTOMER_TYPE_UNSPECIFIED' 'DOMAIN' 'TEAM')}}\"\n ],\n \"allowedRegions\": [\n \"\"\n ],\n \"promotionalOrderTypes\": [\n \"{{oneOf (array 'PROMOTIONAL_TYPE_UNSPECIFIED' 'NEW_UPGRADE' 'TRANSFER' 'PROMOTION_SWITCH')}}\"\n ]\n }\n },\n \"endTime\": \"\",\n \"marketingInfo\": {\n \"defaultLogo\": {\n \"content\": \"\",\n \"title\": \"\",\n \"type\": \"{{oneOf (array 'MEDIA_TYPE_UNSPECIFIED' 'MEDIA_TYPE_IMAGE')}}\"\n },\n \"description\": \"\",\n \"displayName\": \"\"\n },\n \"name\": \"\",\n \"parameterDefinitions\": [\n {\n \"allowedValues\": [\n {\n \"boolValue\": {{faker 'datatype.boolean'}},\n \"doubleValue\": {{faker 'number.float'}},\n \"int64Value\": \"\",\n \"protoValue\": {},\n \"stringValue\": \"\"\n }\n ],\n \"maxValue\": {\n \"boolValue\": {{faker 'datatype.boolean'}},\n \"doubleValue\": {{faker 'number.float'}},\n \"int64Value\": \"\",\n \"protoValue\": {},\n \"stringValue\": \"\"\n },\n \"minValue\": {\n \"boolValue\": {{faker 'datatype.boolean'}},\n \"doubleValue\": {{faker 'number.float'}},\n \"int64Value\": \"\",\n \"protoValue\": {},\n \"stringValue\": \"\"\n },\n \"name\": \"\",\n \"optional\": {{faker 'datatype.boolean'}},\n \"parameterType\": \"{{oneOf (array 'PARAMETER_TYPE_UNSPECIFIED' 'INT64' 'STRING' 'DOUBLE')}}\"\n }\n ],\n \"plan\": {\n \"billingAccount\": \"\",\n \"paymentCycle\": {\n \"duration\": {{faker 'number.int' max=99999}},\n \"periodType\": \"{{oneOf (array 'PERIOD_TYPE_UNSPECIFIED' 'DAY' 'MONTH' 'YEAR')}}\"\n },\n \"paymentPlan\": \"{{oneOf (array 'PAYMENT_PLAN_UNSPECIFIED' 'COMMITMENT' 'FLEXIBLE' 'FREE' 'TRIAL' 'OFFLINE')}}\",\n \"paymentType\": \"{{oneOf (array 'PAYMENT_TYPE_UNSPECIFIED' 'PREPAY' 'POSTPAY')}}\",\n \"trialPeriod\": {\n \"duration\": {{faker 'number.int' max=99999}},\n \"periodType\": \"{{oneOf (array 'PERIOD_TYPE_UNSPECIFIED' 'DAY' 'MONTH' 'YEAR')}}\"\n }\n },\n \"priceByResources\": [\n {\n \"price\": {\n \"basePrice\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"discount\": {{faker 'number.float'}},\n \"effectivePrice\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"externalPriceUri\": \"\"\n },\n \"pricePhases\": [\n {\n \"firstPeriod\": {{faker 'number.int' max=99999}},\n \"lastPeriod\": {{faker 'number.int' max=99999}},\n \"periodType\": \"{{oneOf (array 'PERIOD_TYPE_UNSPECIFIED' 'DAY' 'MONTH' 'YEAR')}}\",\n \"price\": {\n \"basePrice\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"discount\": {{faker 'number.float'}},\n \"effectivePrice\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"externalPriceUri\": \"\"\n },\n \"priceTiers\": [\n {\n \"firstResource\": {{faker 'number.int' max=99999}},\n \"lastResource\": {{faker 'number.int' max=99999}},\n \"price\": {\n \"basePrice\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"discount\": {{faker 'number.float'}},\n \"effectivePrice\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"externalPriceUri\": \"\"\n }\n }\n ]\n }\n ],\n \"resourceType\": \"{{oneOf (array 'RESOURCE_TYPE_UNSPECIFIED' 'SEAT' 'MAU' 'GB' 'LICENSED_USER' 'MINUTES' 'IAAS_USAGE' 'SUBSCRIPTION')}}\"\n }\n ],\n \"sku\": {\n \"marketingInfo\": {\n \"defaultLogo\": {\n \"content\": \"\",\n \"title\": \"\",\n \"type\": \"{{oneOf (array 'MEDIA_TYPE_UNSPECIFIED' 'MEDIA_TYPE_IMAGE')}}\"\n },\n \"description\": \"\",\n \"displayName\": \"\"\n },\n \"name\": \"\",\n \"product\": {\n \"marketingInfo\": {\n \"defaultLogo\": {\n \"content\": \"\",\n \"title\": \"\",\n \"type\": \"{{oneOf (array 'MEDIA_TYPE_UNSPECIFIED' 'MEDIA_TYPE_IMAGE')}}\"\n },\n \"description\": \"\",\n \"displayName\": \"\"\n },\n \"name\": \"\"\n }\n },\n \"startTime\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d7c9d32b-81eb-430a-900d-717ef2990b05", "documentation": "Lists the SKUs for a product the reseller is authorized to sell. Possible error codes: * INVALID_ARGUMENT: Required request parameters are missing or invalid.", "method": "get", "endpoint": "v1/:parent/skus", "responses": [ { "uuid": "833539be-cb4c-4e5a-95a5-1265493c454b", "body": "{\n \"nextPageToken\": \"\",\n \"skus\": [\n {\n \"marketingInfo\": {\n \"defaultLogo\": {\n \"content\": \"\",\n \"title\": \"\",\n \"type\": \"{{oneOf (array 'MEDIA_TYPE_UNSPECIFIED' 'MEDIA_TYPE_IMAGE')}}\"\n },\n \"description\": \"\",\n \"displayName\": \"\"\n },\n \"name\": \"\",\n \"product\": {\n \"marketingInfo\": {\n \"defaultLogo\": {\n \"content\": \"\",\n \"title\": \"\",\n \"type\": \"{{oneOf (array 'MEDIA_TYPE_UNSPECIFIED' 'MEDIA_TYPE_IMAGE')}}\"\n },\n \"description\": \"\",\n \"displayName\": \"\"\n },\n \"name\": \"\"\n }\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9a5abedb-5911-41fe-bc49-7bb3befdf796", "documentation": "Confirms the existence of Cloud Identity accounts based on the domain and if the Cloud Identity accounts are owned by the reseller. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * INVALID_VALUE: Invalid domain value in the request. Return value: A list of CloudIdentityCustomerAccount resources for the domain (may be empty) Note: in the v1alpha1 version of the API, a NOT_FOUND error returns if no CloudIdentityCustomerAccount resources match the domain.", "method": "post", "endpoint": "v1/:parent:checkCloudIdentityAccountsExist", "responses": [ { "uuid": "fcd5d5c3-ee45-4e81-a533-edec6eae0bb8", "body": "{\n \"cloudIdentityAccounts\": [\n {\n \"customerCloudIdentityId\": \"\",\n \"customerName\": \"\",\n \"existing\": {{faker 'datatype.boolean'}},\n \"owned\": {{faker 'datatype.boolean'}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0b67c77a-b3cd-487b-93b7-015347675666", "documentation": "List TransferableOffers of a customer based on Cloud Identity ID or Customer Name in the request. Use this method when a reseller gets the entitlement information of an unowned customer. The reseller should provide the customer's Cloud Identity ID or Customer Name. Possible error codes: * PERMISSION_DENIED: * The customer doesn't belong to the reseller and has no auth token. * The customer provided incorrect reseller information when generating auth token. * The reseller account making the request is different from the reseller account in the query. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: List of TransferableOffer for the given customer and SKU.", "method": "post", "endpoint": "v1/:parent:listTransferableOffers", "responses": [ { "uuid": "bcfd9022-ea15-4c9a-8fd9-63f5a03e7b40", "body": "{\n \"nextPageToken\": \"\",\n \"transferableOffers\": [\n {\n \"offer\": {\n \"constraints\": {\n \"customerConstraints\": {\n \"allowedCustomerTypes\": [\n \"{{oneOf (array 'CUSTOMER_TYPE_UNSPECIFIED' 'DOMAIN' 'TEAM')}}\"\n ],\n \"allowedRegions\": [\n \"\"\n ],\n \"promotionalOrderTypes\": [\n \"{{oneOf (array 'PROMOTIONAL_TYPE_UNSPECIFIED' 'NEW_UPGRADE' 'TRANSFER' 'PROMOTION_SWITCH')}}\"\n ]\n }\n },\n \"endTime\": \"\",\n \"marketingInfo\": {\n \"defaultLogo\": {\n \"content\": \"\",\n \"title\": \"\",\n \"type\": \"{{oneOf (array 'MEDIA_TYPE_UNSPECIFIED' 'MEDIA_TYPE_IMAGE')}}\"\n },\n \"description\": \"\",\n \"displayName\": \"\"\n },\n \"name\": \"\",\n \"parameterDefinitions\": [\n {\n \"allowedValues\": [\n {\n \"boolValue\": {{faker 'datatype.boolean'}},\n \"doubleValue\": {{faker 'number.float'}},\n \"int64Value\": \"\",\n \"protoValue\": {},\n \"stringValue\": \"\"\n }\n ],\n \"maxValue\": {\n \"boolValue\": {{faker 'datatype.boolean'}},\n \"doubleValue\": {{faker 'number.float'}},\n \"int64Value\": \"\",\n \"protoValue\": {},\n \"stringValue\": \"\"\n },\n \"minValue\": {\n \"boolValue\": {{faker 'datatype.boolean'}},\n \"doubleValue\": {{faker 'number.float'}},\n \"int64Value\": \"\",\n \"protoValue\": {},\n \"stringValue\": \"\"\n },\n \"name\": \"\",\n \"optional\": {{faker 'datatype.boolean'}},\n \"parameterType\": \"{{oneOf (array 'PARAMETER_TYPE_UNSPECIFIED' 'INT64' 'STRING' 'DOUBLE')}}\"\n }\n ],\n \"plan\": {\n \"billingAccount\": \"\",\n \"paymentCycle\": {\n \"duration\": {{faker 'number.int' max=99999}},\n \"periodType\": \"{{oneOf (array 'PERIOD_TYPE_UNSPECIFIED' 'DAY' 'MONTH' 'YEAR')}}\"\n },\n \"paymentPlan\": \"{{oneOf (array 'PAYMENT_PLAN_UNSPECIFIED' 'COMMITMENT' 'FLEXIBLE' 'FREE' 'TRIAL' 'OFFLINE')}}\",\n \"paymentType\": \"{{oneOf (array 'PAYMENT_TYPE_UNSPECIFIED' 'PREPAY' 'POSTPAY')}}\",\n \"trialPeriod\": {\n \"duration\": {{faker 'number.int' max=99999}},\n \"periodType\": \"{{oneOf (array 'PERIOD_TYPE_UNSPECIFIED' 'DAY' 'MONTH' 'YEAR')}}\"\n }\n },\n \"priceByResources\": [\n {\n \"price\": {\n \"basePrice\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"discount\": {{faker 'number.float'}},\n \"effectivePrice\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"externalPriceUri\": \"\"\n },\n \"pricePhases\": [\n {\n \"firstPeriod\": {{faker 'number.int' max=99999}},\n \"lastPeriod\": {{faker 'number.int' max=99999}},\n \"periodType\": \"{{oneOf (array 'PERIOD_TYPE_UNSPECIFIED' 'DAY' 'MONTH' 'YEAR')}}\",\n \"price\": {\n \"basePrice\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"discount\": {{faker 'number.float'}},\n \"effectivePrice\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"externalPriceUri\": \"\"\n },\n \"priceTiers\": [\n {\n \"firstResource\": {{faker 'number.int' max=99999}},\n \"lastResource\": {{faker 'number.int' max=99999}},\n \"price\": {\n \"basePrice\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"discount\": {{faker 'number.float'}},\n \"effectivePrice\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"externalPriceUri\": \"\"\n }\n }\n ]\n }\n ],\n \"resourceType\": \"{{oneOf (array 'RESOURCE_TYPE_UNSPECIFIED' 'SEAT' 'MAU' 'GB' 'LICENSED_USER' 'MINUTES' 'IAAS_USAGE' 'SUBSCRIPTION')}}\"\n }\n ],\n \"sku\": {\n \"marketingInfo\": {\n \"defaultLogo\": {\n \"content\": \"\",\n \"title\": \"\",\n \"type\": \"{{oneOf (array 'MEDIA_TYPE_UNSPECIFIED' 'MEDIA_TYPE_IMAGE')}}\"\n },\n \"description\": \"\",\n \"displayName\": \"\"\n },\n \"name\": \"\",\n \"product\": {\n \"marketingInfo\": {\n \"defaultLogo\": {\n \"content\": \"\",\n \"title\": \"\",\n \"type\": \"{{oneOf (array 'MEDIA_TYPE_UNSPECIFIED' 'MEDIA_TYPE_IMAGE')}}\"\n },\n \"description\": \"\",\n \"displayName\": \"\"\n },\n \"name\": \"\"\n }\n },\n \"startTime\": \"\"\n }\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1bf770ba-45d8-4746-9085-0fbe3aba67b7", "documentation": "List TransferableSkus of a customer based on the Cloud Identity ID or Customer Name in the request. Use this method to list the entitlements information of an unowned customer. You should provide the customer's Cloud Identity ID or Customer Name. Possible error codes: * PERMISSION_DENIED: * The customer doesn't belong to the reseller and has no auth token. * The supplied auth token is invalid. * The reseller account making the request is different from the reseller account in the query. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: A list of the customer's TransferableSku.", "method": "post", "endpoint": "v1/:parent:listTransferableSkus", "responses": [ { "uuid": "4c13418d-5522-4080-b622-04c786235f44", "body": "{\n \"nextPageToken\": \"\",\n \"transferableSkus\": [\n {\n \"legacySku\": {\n \"marketingInfo\": {\n \"defaultLogo\": {\n \"content\": \"\",\n \"title\": \"\",\n \"type\": \"{{oneOf (array 'MEDIA_TYPE_UNSPECIFIED' 'MEDIA_TYPE_IMAGE')}}\"\n },\n \"description\": \"\",\n \"displayName\": \"\"\n },\n \"name\": \"\",\n \"product\": {\n \"marketingInfo\": {\n \"defaultLogo\": {\n \"content\": \"\",\n \"title\": \"\",\n \"type\": \"{{oneOf (array 'MEDIA_TYPE_UNSPECIFIED' 'MEDIA_TYPE_IMAGE')}}\"\n },\n \"description\": \"\",\n \"displayName\": \"\"\n },\n \"name\": \"\"\n }\n },\n \"sku\": {\n \"marketingInfo\": {\n \"defaultLogo\": {\n \"content\": \"\",\n \"title\": \"\",\n \"type\": \"{{oneOf (array 'MEDIA_TYPE_UNSPECIFIED' 'MEDIA_TYPE_IMAGE')}}\"\n },\n \"description\": \"\",\n \"displayName\": \"\"\n },\n \"name\": \"\",\n \"product\": {\n \"marketingInfo\": {\n \"defaultLogo\": {\n \"content\": \"\",\n \"title\": \"\",\n \"type\": \"{{oneOf (array 'MEDIA_TYPE_UNSPECIFIED' 'MEDIA_TYPE_IMAGE')}}\"\n },\n \"description\": \"\",\n \"displayName\": \"\"\n },\n \"name\": \"\"\n }\n },\n \"transferEligibility\": {\n \"description\": \"\",\n \"ineligibilityReason\": \"{{oneOf (array 'REASON_UNSPECIFIED' 'PENDING_TOS_ACCEPTANCE' 'SKU_NOT_ELIGIBLE' 'SKU_SUSPENDED')}}\",\n \"isEligible\": {{faker 'datatype.boolean'}}\n }\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "18f4d9c6-5b01-4488-b845-f6742cb039e4", "documentation": "Transfers customer entitlements to new reseller. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer or offer resource was not found. * ALREADY_EXISTS: The SKU was already transferred for the customer. * CONDITION_NOT_MET or FAILED_PRECONDITION: * The SKU requires domain verification to transfer, but the domain is not verified. * An Add-On SKU (example, Vault or Drive) is missing the pre-requisite SKU (example, G Suite Basic). * (Developer accounts only) Reseller and resold domain must meet the following naming requirements: * Domain names must start with goog-test. * Domain names must include the reseller domain. * Specify all transferring entitlements. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.", "method": "post", "endpoint": "v1/:parent:transferEntitlements", "responses": [ { "uuid": "2008f369-894f-4d6e-b55f-0c0fd2233fb8", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "809076df-b436-4ef2-87eb-c682fd403b22", "documentation": "Transfers customer entitlements from their current reseller to Google. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer or offer resource was not found. * ALREADY_EXISTS: The SKU was already transferred for the customer. * CONDITION_NOT_MET or FAILED_PRECONDITION: * The SKU requires domain verification to transfer, but the domain is not verified. * An Add-On SKU (example, Vault or Drive) is missing the pre-requisite SKU (example, G Suite Basic). * (Developer accounts only) Reseller and resold domain must meet the following naming requirements: * Domain names must start with goog-test. * Domain names must include the reseller domain. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The response will contain google.protobuf.Empty on success. The Operation metadata will contain an instance of OperationMetadata.", "method": "post", "endpoint": "v1/:parent:transferEntitlementsToGoogle", "responses": [ { "uuid": "9e9c3c41-69e0-4a79-86e8-3961d82c68c3", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "a345c06b-a1ad-48df-9f23-b6630cc35c6c" }, { "type": "route", "uuid": "87dedef2-4dee-4cc3-a543-815e861eeb0a" }, { "type": "route", "uuid": "fb53caaa-b483-4475-a0e4-da5ab2744d72" }, { "type": "route", "uuid": "6369cf1f-d565-44c6-b92c-507b306bf5c1" }, { "type": "route", "uuid": "a8ab3ba7-f36a-436e-beb5-e97bf832064e" }, { "type": "route", "uuid": "1e4eba58-d7ce-4c09-8037-33fc849144dc" }, { "type": "route", "uuid": "a1b6f61b-6d3d-4f1b-9d9a-e2fee33fc184" }, { "type": "route", "uuid": "e2d56c81-6e7e-421a-90e2-cd135c8c98b8" }, { "type": "route", "uuid": "be9d6e37-d941-4f3a-9abd-befd25f8aec3" }, { "type": "route", "uuid": "8ca9f024-9652-42ae-a06b-5c3d5f12f0b4" }, { "type": "route", "uuid": "36b5d79f-de4a-43d8-97ee-04b57cf0d379" }, { "type": "route", "uuid": "8b5be820-12b8-44c8-ab1b-284d3e36e430" }, { "type": "route", "uuid": "d3a5413d-e1b8-42a1-96be-84a7427cdf34" }, { "type": "route", "uuid": "91c87dc1-8975-40ae-bc19-6b890cfe8668" }, { "type": "route", "uuid": "2ae0b261-4e6d-4165-b53c-0f2f442028eb" }, { "type": "route", "uuid": "34a8f970-d00a-4515-ab97-7dcbe4e3b242" }, { "type": "route", "uuid": "17358863-008e-4b52-960f-47b456f80c3e" }, { "type": "route", "uuid": "b4e12267-e19b-4ca5-bf1e-b276a25ab168" }, { "type": "route", "uuid": "38363547-346f-4323-95dc-4f20951c9705" }, { "type": "route", "uuid": "decc3b70-82c0-4f1b-be39-71f9e360e5e1" }, { "type": "route", "uuid": "2e1e8d61-3201-4f5d-b37b-ed367cfad48e" }, { "type": "route", "uuid": "5748cc9a-3588-4a41-a225-b0f8acb9acef" }, { "type": "route", "uuid": "c0c76c01-d100-475c-bdce-1cf523f387e8" }, { "type": "route", "uuid": "c13e9d92-8aad-4993-9875-db48542d5625" }, { "type": "route", "uuid": "a0337ccc-3ee2-43ae-a1e7-14f48c7c5877" }, { "type": "route", "uuid": "3c66293a-08ce-4fd8-b393-0e5a534bfbce" }, { "type": "route", "uuid": "9a0f3ed8-cd90-4f74-b4dd-a59306ab26de" }, { "type": "route", "uuid": "5df31327-a817-4fd6-a72b-3b8e4db89e9a" }, { "type": "route", "uuid": "c18d8289-84fb-417c-b5da-1c8167e1e6fc" }, { "type": "route", "uuid": "f5aad2de-6d74-402d-9fe9-68b909b6ee72" }, { "type": "route", "uuid": "d7c9d32b-81eb-430a-900d-717ef2990b05" }, { "type": "route", "uuid": "9a5abedb-5911-41fe-bc49-7bb3befdf796" }, { "type": "route", "uuid": "0b67c77a-b3cd-487b-93b7-015347675666" }, { "type": "route", "uuid": "1bf770ba-45d8-4746-9085-0fbe3aba67b7" }, { "type": "route", "uuid": "18f4d9c6-5b01-4488-b845-f6742cb039e4" }, { "type": "route", "uuid": "809076df-b436-4ef2-87eb-c682fd403b22" } ] }