Skip to content

Commit c73b70e

Browse files
yoshi-automationsofisl
authored andcommitted
feat(cloudchannel): update the API
#### cloudchannel:v1 The following keys were added: - resources.accounts.resources.customers.resources.entitlements.methods.listEntitlementChanges.description - resources.accounts.resources.customers.resources.entitlements.methods.listEntitlementChanges.flatPath - resources.accounts.resources.customers.resources.entitlements.methods.listEntitlementChanges.httpMethod - resources.accounts.resources.customers.resources.entitlements.methods.listEntitlementChanges.id - resources.accounts.resources.customers.resources.entitlements.methods.listEntitlementChanges.parameterOrder - resources.accounts.resources.customers.resources.entitlements.methods.listEntitlementChanges.parameters.filter.description - resources.accounts.resources.customers.resources.entitlements.methods.listEntitlementChanges.parameters.filter.location - resources.accounts.resources.customers.resources.entitlements.methods.listEntitlementChanges.parameters.filter.type - resources.accounts.resources.customers.resources.entitlements.methods.listEntitlementChanges.parameters.pageSize.description - resources.accounts.resources.customers.resources.entitlements.methods.listEntitlementChanges.parameters.pageSize.format - resources.accounts.resources.customers.resources.entitlements.methods.listEntitlementChanges.parameters.pageSize.location - resources.accounts.resources.customers.resources.entitlements.methods.listEntitlementChanges.parameters.pageSize.type - resources.accounts.resources.customers.resources.entitlements.methods.listEntitlementChanges.parameters.pageToken.description - resources.accounts.resources.customers.resources.entitlements.methods.listEntitlementChanges.parameters.pageToken.location - resources.accounts.resources.customers.resources.entitlements.methods.listEntitlementChanges.parameters.pageToken.type - resources.accounts.resources.customers.resources.entitlements.methods.listEntitlementChanges.parameters.parent.description - resources.accounts.resources.customers.resources.entitlements.methods.listEntitlementChanges.parameters.parent.location - resources.accounts.resources.customers.resources.entitlements.methods.listEntitlementChanges.parameters.parent.pattern - resources.accounts.resources.customers.resources.entitlements.methods.listEntitlementChanges.parameters.parent.required - resources.accounts.resources.customers.resources.entitlements.methods.listEntitlementChanges.parameters.parent.type - resources.accounts.resources.customers.resources.entitlements.methods.listEntitlementChanges.path - resources.accounts.resources.customers.resources.entitlements.methods.listEntitlementChanges.response.$ref - resources.accounts.resources.customers.resources.entitlements.methods.listEntitlementChanges.scopes - resources.accounts.resources.offers.methods.list.parameters.showFutureOffers.description - resources.accounts.resources.offers.methods.list.parameters.showFutureOffers.location - resources.accounts.resources.offers.methods.list.parameters.showFutureOffers.type - schemas.GoogleCloudChannelV1EntitlementChange.description - schemas.GoogleCloudChannelV1EntitlementChange.id - schemas.GoogleCloudChannelV1EntitlementChange.properties.activationReason.description - schemas.GoogleCloudChannelV1EntitlementChange.properties.activationReason.enum - schemas.GoogleCloudChannelV1EntitlementChange.properties.activationReason.enumDescriptions - schemas.GoogleCloudChannelV1EntitlementChange.properties.activationReason.type - schemas.GoogleCloudChannelV1EntitlementChange.properties.cancellationReason.description - schemas.GoogleCloudChannelV1EntitlementChange.properties.cancellationReason.enum - schemas.GoogleCloudChannelV1EntitlementChange.properties.cancellationReason.enumDescriptions - schemas.GoogleCloudChannelV1EntitlementChange.properties.cancellationReason.type - schemas.GoogleCloudChannelV1EntitlementChange.properties.changeType.description - schemas.GoogleCloudChannelV1EntitlementChange.properties.changeType.enum - schemas.GoogleCloudChannelV1EntitlementChange.properties.changeType.enumDescriptions - schemas.GoogleCloudChannelV1EntitlementChange.properties.changeType.type - schemas.GoogleCloudChannelV1EntitlementChange.properties.createTime.description - schemas.GoogleCloudChannelV1EntitlementChange.properties.createTime.format - schemas.GoogleCloudChannelV1EntitlementChange.properties.createTime.type - schemas.GoogleCloudChannelV1EntitlementChange.properties.entitlement.description - schemas.GoogleCloudChannelV1EntitlementChange.properties.entitlement.type - schemas.GoogleCloudChannelV1EntitlementChange.properties.offer.description - schemas.GoogleCloudChannelV1EntitlementChange.properties.offer.type - schemas.GoogleCloudChannelV1EntitlementChange.properties.operator.description - schemas.GoogleCloudChannelV1EntitlementChange.properties.operator.type - schemas.GoogleCloudChannelV1EntitlementChange.properties.operatorType.description - schemas.GoogleCloudChannelV1EntitlementChange.properties.operatorType.enum - schemas.GoogleCloudChannelV1EntitlementChange.properties.operatorType.enumDescriptions - schemas.GoogleCloudChannelV1EntitlementChange.properties.operatorType.type - schemas.GoogleCloudChannelV1EntitlementChange.properties.otherChangeReason.description - schemas.GoogleCloudChannelV1EntitlementChange.properties.otherChangeReason.type - schemas.GoogleCloudChannelV1EntitlementChange.properties.parameters.description - schemas.GoogleCloudChannelV1EntitlementChange.properties.parameters.items.$ref - schemas.GoogleCloudChannelV1EntitlementChange.properties.parameters.type - schemas.GoogleCloudChannelV1EntitlementChange.properties.provisionedService.$ref - schemas.GoogleCloudChannelV1EntitlementChange.properties.provisionedService.description - schemas.GoogleCloudChannelV1EntitlementChange.properties.suspensionReason.description - schemas.GoogleCloudChannelV1EntitlementChange.properties.suspensionReason.enum - schemas.GoogleCloudChannelV1EntitlementChange.properties.suspensionReason.enumDescriptions - schemas.GoogleCloudChannelV1EntitlementChange.properties.suspensionReason.type - schemas.GoogleCloudChannelV1EntitlementChange.type - schemas.GoogleCloudChannelV1ListEntitlementChangesResponse.description - schemas.GoogleCloudChannelV1ListEntitlementChangesResponse.id - schemas.GoogleCloudChannelV1ListEntitlementChangesResponse.properties.entitlementChanges.description - schemas.GoogleCloudChannelV1ListEntitlementChangesResponse.properties.entitlementChanges.items.$ref - schemas.GoogleCloudChannelV1ListEntitlementChangesResponse.properties.entitlementChanges.type - schemas.GoogleCloudChannelV1ListEntitlementChangesResponse.properties.nextPageToken.description - schemas.GoogleCloudChannelV1ListEntitlementChangesResponse.properties.nextPageToken.type - schemas.GoogleCloudChannelV1ListEntitlementChangesResponse.type The following keys were changed: - resources.accounts.resources.channelPartnerLinks.resources.channelPartnerRepricingConfigs.methods.list.description - resources.accounts.resources.customers.resources.customerRepricingConfigs.methods.list.description - resources.operations.methods.list.description
1 parent d583809 commit c73b70e

File tree

2 files changed

+459
-7
lines changed

2 files changed

+459
-7
lines changed

discovery/cloudchannel-v1.json

Lines changed: 217 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -520,7 +520,7 @@
520520
]
521521
},
522522
"list": {
523-
"description": "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.",
523+
"description": "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.",
524524
"flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}/channelPartnerRepricingConfigs",
525525
"httpMethod": "GET",
526526
"id": "cloudchannel.accounts.channelPartnerLinks.channelPartnerRepricingConfigs.list",
@@ -1249,7 +1249,7 @@
12491249
]
12501250
},
12511251
"list": {
1252-
"description": "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.",
1252+
"description": "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.",
12531253
"flatPath": "v1/accounts/{accountsId}/customers/{customersId}/customerRepricingConfigs",
12541254
"httpMethod": "GET",
12551255
"id": "cloudchannel.accounts.customers.customerRepricingConfigs.list",
@@ -1550,6 +1550,47 @@
15501550
"https://www.googleapis.com/auth/apps.order"
15511551
]
15521552
},
1553+
"listEntitlementChanges": {
1554+
"description": "List entitlement history. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different. * INVALID_ARGUMENT: Missing or invalid required fields in the request. * NOT_FOUND: The parent resource doesn't exist. Usually the result of an invalid name parameter. * INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact CloudChannel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support. Return value: List of EntitlementChanges.",
1555+
"flatPath": "v1/accounts/{accountsId}/customers/{customersId}/entitlements/{entitlementsId}:listEntitlementChanges",
1556+
"httpMethod": "GET",
1557+
"id": "cloudchannel.accounts.customers.entitlements.listEntitlementChanges",
1558+
"parameterOrder": [
1559+
"parent"
1560+
],
1561+
"parameters": {
1562+
"filter": {
1563+
"description": "Optional. Filters applied to the list results.",
1564+
"location": "query",
1565+
"type": "string"
1566+
},
1567+
"pageSize": {
1568+
"description": "Optional. The maximum number of entitlement changes to return. The service may return fewer than this value. If unspecified, returns at most 10 entitlement changes. The maximum value is 50; the server will coerce values above 50.",
1569+
"format": "int32",
1570+
"location": "query",
1571+
"type": "integer"
1572+
},
1573+
"pageToken": {
1574+
"description": "Optional. A page token, received from a previous CloudChannelService.ListEntitlementChanges call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to CloudChannelService.ListEntitlementChanges must match the call that provided the page token.",
1575+
"location": "query",
1576+
"type": "string"
1577+
},
1578+
"parent": {
1579+
"description": "Required. The resource name of the entitlement for which to list entitlement changes. The `-` wildcard may be used to match entitlements across a customer. Formats: * accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} * accounts/{account_id}/customers/{customer_id}/entitlements/-",
1580+
"location": "path",
1581+
"pattern": "^accounts/[^/]+/customers/[^/]+/entitlements/[^/]+$",
1582+
"required": true,
1583+
"type": "string"
1584+
}
1585+
},
1586+
"path": "v1/{+parent}:listEntitlementChanges",
1587+
"response": {
1588+
"$ref": "GoogleCloudChannelV1ListEntitlementChangesResponse"
1589+
},
1590+
"scopes": [
1591+
"https://www.googleapis.com/auth/apps.order"
1592+
]
1593+
},
15531594
"lookupOffer": {
15541595
"description": "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.",
15551596
"flatPath": "v1/accounts/{accountsId}/customers/{customersId}/entitlements/{entitlementsId}:lookupOffer",
@@ -1673,6 +1714,11 @@
16731714
"pattern": "^accounts/[^/]+$",
16741715
"required": true,
16751716
"type": "string"
1717+
},
1718+
"showFutureOffers": {
1719+
"description": "Optional. A boolean flag that determines if a response returns future offers 30 days from now. If the show_future_offers is true, the response will only contain offers that are scheduled to be available 30 days from now.",
1720+
"location": "query",
1721+
"type": "boolean"
16761722
}
16771723
},
16781724
"path": "v1/{+parent}/offers",
@@ -1873,7 +1919,7 @@
18731919
]
18741920
},
18751921
"list": {
1876-
"description": "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.",
1922+
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
18771923
"flatPath": "v1/operations",
18781924
"httpMethod": "GET",
18791925
"id": "cloudchannel.operations.list",
@@ -2009,7 +2055,7 @@
20092055
}
20102056
}
20112057
},
2012-
"revision": "20230301",
2058+
"revision": "20230320",
20132059
"rootUrl": "https://cloudchannel.googleapis.com/",
20142060
"schemas": {
20152061
"GoogleCloudChannelV1ActivateEntitlementRequest": {
@@ -2788,6 +2834,155 @@
27882834
},
27892835
"type": "object"
27902836
},
2837+
"GoogleCloudChannelV1EntitlementChange": {
2838+
"description": "Change event entry for Entitlement order history",
2839+
"id": "GoogleCloudChannelV1EntitlementChange",
2840+
"properties": {
2841+
"activationReason": {
2842+
"description": "The Entitlement's activation reason",
2843+
"enum": [
2844+
"ACTIVATION_REASON_UNSPECIFIED",
2845+
"RESELLER_REVOKED_SUSPENSION",
2846+
"CUSTOMER_ACCEPTED_PENDING_TOS",
2847+
"RENEWAL_SETTINGS_CHANGED",
2848+
"OTHER_ACTIVATION_REASON"
2849+
],
2850+
"enumDescriptions": [
2851+
"Not used.",
2852+
"Reseller reactivated a suspended Entitlement.",
2853+
"Customer accepted pending terms of service.",
2854+
"Reseller updated the renewal settings on an entitlement that was suspended due to cancellation, and this update reactivated the entitlement.",
2855+
"Other reasons (Activated temporarily for cancellation, added a payment plan to a trial entitlement, etc.)"
2856+
],
2857+
"type": "string"
2858+
},
2859+
"cancellationReason": {
2860+
"description": "Cancellation reason for the Entitlement.",
2861+
"enum": [
2862+
"CANCELLATION_REASON_UNSPECIFIED",
2863+
"SERVICE_TERMINATED",
2864+
"RELATIONSHIP_ENDED",
2865+
"PARTIAL_TRANSFER"
2866+
],
2867+
"enumDescriptions": [
2868+
"Not used.",
2869+
"Reseller triggered a cancellation of the service.",
2870+
"Relationship between the reseller and customer has ended due to a transfer.",
2871+
"Entitlement transferred away from reseller while still keeping other entitlement(s) with the reseller."
2872+
],
2873+
"type": "string"
2874+
},
2875+
"changeType": {
2876+
"description": "The change action type.",
2877+
"enum": [
2878+
"CHANGE_TYPE_UNSPECIFIED",
2879+
"CREATED",
2880+
"PRICE_PLAN_SWITCHED",
2881+
"COMMITMENT_CHANGED",
2882+
"RENEWED",
2883+
"SUSPENDED",
2884+
"ACTIVATED",
2885+
"CANCELLED",
2886+
"SKU_CHANGED",
2887+
"RENEWAL_SETTING_CHANGED",
2888+
"PAID_SUBSCRIPTION_STARTED",
2889+
"LICENSE_CAP_CHANGED",
2890+
"SUSPENSION_DETAILS_CHANGED",
2891+
"TRIAL_END_DATE_EXTENDED",
2892+
"TRIAL_STARTED"
2893+
],
2894+
"enumDescriptions": [
2895+
"Not used.",
2896+
"New Entitlement was created.",
2897+
"Price plan associated with an Entitlement was changed.",
2898+
"Number of seats committed for a commitment Entitlement was changed.",
2899+
"An annual Entitlement was renewed.",
2900+
"Entitlement was suspended.",
2901+
"Entitlement was activated.",
2902+
"Entitlement was cancelled.",
2903+
"Entitlement was upgraded or downgraded for ex. from Google Workspace Business Standard to Google Workspace Business Plus.",
2904+
"The settings for renewal of an Entitlement have changed.",
2905+
"Use for Google Workspace subscription. Either a trial was converted to a paid subscription or a new subscription with no trial is created.",
2906+
"License cap was changed for the entitlement.",
2907+
"The suspension details have changed (but it is still suspended).",
2908+
"The trial end date was extended.",
2909+
"Entitlement started trial."
2910+
],
2911+
"type": "string"
2912+
},
2913+
"createTime": {
2914+
"description": "The submitted time of the change.",
2915+
"format": "google-datetime",
2916+
"type": "string"
2917+
},
2918+
"entitlement": {
2919+
"description": "Required. Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}",
2920+
"type": "string"
2921+
},
2922+
"offer": {
2923+
"description": "Required. Resource name of the Offer at the time of change. Takes the form: accounts/{account_id}/offers/{offer_id}.",
2924+
"type": "string"
2925+
},
2926+
"operator": {
2927+
"description": "Human-readable identifier that shows what operator made a change. When the operator_type is RESELLER, this is the user's email address. For all other operator types, this is empty.",
2928+
"type": "string"
2929+
},
2930+
"operatorType": {
2931+
"description": "Operator type responsible for the change.",
2932+
"enum": [
2933+
"OPERATOR_TYPE_UNSPECIFIED",
2934+
"CUSTOMER_SERVICE_REPRESENTATIVE",
2935+
"SYSTEM",
2936+
"CUSTOMER",
2937+
"RESELLER"
2938+
],
2939+
"enumDescriptions": [
2940+
"Not used.",
2941+
"Customer service representative.",
2942+
"System auto job.",
2943+
"Customer user.",
2944+
"Reseller user."
2945+
],
2946+
"type": "string"
2947+
},
2948+
"otherChangeReason": {
2949+
"description": "e.g. purchase_number change reason, entered by CRS.",
2950+
"type": "string"
2951+
},
2952+
"parameters": {
2953+
"description": "Extended parameters, such as: purchase_order_number, gcp_details; internal_correlation_id, long_running_operation_id, order_id; etc.",
2954+
"items": {
2955+
"$ref": "GoogleCloudChannelV1Parameter"
2956+
},
2957+
"type": "array"
2958+
},
2959+
"provisionedService": {
2960+
"$ref": "GoogleCloudChannelV1ProvisionedService",
2961+
"description": "Service provisioned for an Entitlement."
2962+
},
2963+
"suspensionReason": {
2964+
"description": "Suspension reason for the Entitlement.",
2965+
"enum": [
2966+
"SUSPENSION_REASON_UNSPECIFIED",
2967+
"RESELLER_INITIATED",
2968+
"TRIAL_ENDED",
2969+
"RENEWAL_WITH_TYPE_CANCEL",
2970+
"PENDING_TOS_ACCEPTANCE",
2971+
"OTHER"
2972+
],
2973+
"enumDescriptions": [
2974+
"Not used.",
2975+
"Entitlement was manually suspended by the Reseller.",
2976+
"Trial ended.",
2977+
"Entitlement renewal was canceled.",
2978+
"Entitlement was automatically suspended on creation for pending ToS acceptance on customer.",
2979+
"Other reasons (internal reasons, abuse, etc.)."
2980+
],
2981+
"type": "string"
2982+
}
2983+
},
2984+
"type": "object"
2985+
},
27912986
"GoogleCloudChannelV1EntitlementEvent": {
27922987
"description": "Represents Pub/Sub message content describing entitlement update.",
27932988
"id": "GoogleCloudChannelV1EntitlementEvent",
@@ -2974,6 +3169,24 @@
29743169
},
29753170
"type": "object"
29763171
},
3172+
"GoogleCloudChannelV1ListEntitlementChangesResponse": {
3173+
"description": "Response message for CloudChannelService.ListEntitlementChanges",
3174+
"id": "GoogleCloudChannelV1ListEntitlementChangesResponse",
3175+
"properties": {
3176+
"entitlementChanges": {
3177+
"description": "The list of entitlement changes.",
3178+
"items": {
3179+
"$ref": "GoogleCloudChannelV1EntitlementChange"
3180+
},
3181+
"type": "array"
3182+
},
3183+
"nextPageToken": {
3184+
"description": "A token to list the next page of results.",
3185+
"type": "string"
3186+
}
3187+
},
3188+
"type": "object"
3189+
},
29773190
"GoogleCloudChannelV1ListEntitlementsResponse": {
29783191
"description": "Response message for CloudChannelService.ListEntitlements.",
29793192
"id": "GoogleCloudChannelV1ListEntitlementsResponse",

0 commit comments

Comments
 (0)