feat(cloudchannel): update the api

yoshi-automation · yoshi-automation · commit 3fd0d738d8fd · 2024-11-12T07:07:52.000Z
#### cloudchannel:v1

The following keys were added:
- schemas.GoogleCloudChannelV1ChangeOfferRequest.properties.priceReferenceId.type (Total Keys: 1)
- schemas.GoogleCloudChannelV1PurchasableOffer.properties.priceReferenceId.type (Total Keys: 1)
- schemas.GoogleCloudChannelV1TransferableOffer.properties.priceReferenceId.type (Total Keys: 1)
- schemas.GoogleCloudChannelV1alpha1OpportunityEvent (Total Keys: 4)
- schemas.GoogleCloudChannelV1alpha1SubscriberEvent.properties.opportunityEvent.$ref (Total Keys: 1)
diff --git a/docs/dyn/cloudchannel_v1.accounts.channelPartnerLinks.channelPartnerRepricingConfigs.html b/docs/dyn/cloudchannel_v1.accounts.channelPartnerLinks.channelPartnerRepricingConfigs.html
diff --git a/docs/dyn/cloudchannel_v1.accounts.customers.customerRepricingConfigs.html b/docs/dyn/cloudchannel_v1.accounts.customers.customerRepricingConfigs.html
diff --git a/docs/dyn/cloudchannel_v1.accounts.customers.entitlements.html b/docs/dyn/cloudchannel_v1.accounts.customers.entitlements.html
@@ -231,6 +231,7 @@ <h3>Method Details</h3>
       },
     },
   ],
+  &quot;priceReferenceId&quot;: &quot;A String&quot;, # Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. Yet to be implemented: this field is currently not evaluated in the API if populated in a request.
   &quot;purchaseOrderId&quot;: &quot;A String&quot;, # Optional. Purchase order id provided by the reseller.
   &quot;requestId&quot;: &quot;A String&quot;, # Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it&#x27;s complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122) with the exception that zero UUID is not supported (`00000000-0000-0000-0000-000000000000`).
 }
@@ -424,6 +425,7 @@ <h3>Method Details</h3>
         },
       },
     ],
+    &quot;priceReferenceId&quot;: &quot;A String&quot;, # Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. Yet to be implemented: this field is currently not evaluated in the API if populated in a request.
     &quot;provisionedService&quot;: { # Service provisioned for an entitlement. # Output only. Service provisioning details for the entitlement.
       &quot;productId&quot;: &quot;A String&quot;, # Output only. The product pertaining to the provisioning resource as specified in the Offer.
       &quot;provisioningId&quot;: &quot;A String&quot;, # Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount.
@@ -522,6 +524,7 @@ <h3>Method Details</h3>
       },
     },
   ],
+  &quot;priceReferenceId&quot;: &quot;A String&quot;, # Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. Yet to be implemented: this field is currently not evaluated in the API if populated in a request.
   &quot;provisionedService&quot;: { # Service provisioned for an entitlement. # Output only. Service provisioning details for the entitlement.
     &quot;productId&quot;: &quot;A String&quot;, # Output only. The product pertaining to the provisioning resource as specified in the Offer.
     &quot;provisioningId&quot;: &quot;A String&quot;, # Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount.
@@ -594,6 +597,7 @@ <h3>Method Details</h3>
           },
         },
       ],
+      &quot;priceReferenceId&quot;: &quot;A String&quot;, # Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. Yet to be implemented: this field is currently not evaluated in the API if populated in a request.
       &quot;provisionedService&quot;: { # Service provisioned for an entitlement. # Output only. Service provisioning details for the entitlement.
         &quot;productId&quot;: &quot;A String&quot;, # Output only. The product pertaining to the provisioning resource as specified in the Offer.
         &quot;provisioningId&quot;: &quot;A String&quot;, # Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount.
diff --git a/docs/dyn/cloudchannel_v1.accounts.customers.html b/docs/dyn/cloudchannel_v1.accounts.customers.html
@@ -687,6 +687,7 @@ <h3>Method Details</h3>
         },
         &quot;startTime&quot;: &quot;A String&quot;, # Start of the Offer validity time.
       },
+      &quot;priceReferenceId&quot;: &quot;A String&quot;, # Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order.
     },
   ],
 }</pre>
@@ -1060,6 +1061,7 @@ <h3>Method Details</h3>
           },
         },
       ],
+      &quot;priceReferenceId&quot;: &quot;A String&quot;, # Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. Yet to be implemented: this field is currently not evaluated in the API if populated in a request.
       &quot;provisionedService&quot;: { # Service provisioned for an entitlement. # Output only. Service provisioning details for the entitlement.
         &quot;productId&quot;: &quot;A String&quot;, # Output only. The product pertaining to the provisioning resource as specified in the Offer.
         &quot;provisioningId&quot;: &quot;A String&quot;, # Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount.
@@ -1156,6 +1158,7 @@ <h3>Method Details</h3>
           },
         },
       ],
+      &quot;priceReferenceId&quot;: &quot;A String&quot;, # Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. Yet to be implemented: this field is currently not evaluated in the API if populated in a request.
       &quot;provisionedService&quot;: { # Service provisioned for an entitlement. # Output only. Service provisioning details for the entitlement.
         &quot;productId&quot;: &quot;A String&quot;, # Output only. The product pertaining to the provisioning resource as specified in the Offer.
         &quot;provisioningId&quot;: &quot;A String&quot;, # Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount.
diff --git a/docs/dyn/cloudchannel_v1.accounts.html b/docs/dyn/cloudchannel_v1.accounts.html
@@ -408,6 +408,7 @@ <h3>Method Details</h3>
         },
         &quot;startTime&quot;: &quot;A String&quot;, # Start of the Offer validity time.
       },
+      &quot;priceReferenceId&quot;: &quot;A String&quot;, # Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order.
     },
   ],
 }</pre>
diff --git a/docs/dyn/cloudchannel_v1.accounts.reportJobs.html b/docs/dyn/cloudchannel_v1.accounts.reportJobs.html
@@ -235,7 +235,7 @@ <h3>Method Details</h3>
             &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
             &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
           },
-          &quot;decimalValue&quot;: { # A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java&#x27;s BigDecimal or Python&#x27;s decimal.Decimal. [BigDecimal]: https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html [decimal.Decimal]: https://docs.python.org/3/library/decimal.html # A value of type `google.type.Decimal`, representing non-integer numeric values.
+          &quot;decimalValue&quot;: { # A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java&#x27;s [BigDecimal](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html) or Python&#x27;s [decimal.Decimal](https://docs.python.org/3/library/decimal.html). # A value of type `google.type.Decimal`, representing non-integer numeric values.
             &quot;value&quot;: &quot;A String&quot;, # The decimal value, as a string. The string representation consists of an optional sign, `+` (`U+002B`) or `-` (`U+002D`), followed by a sequence of zero or more decimal digits (&quot;the integer&quot;), optionally followed by a fraction, optionally followed by an exponent. An empty string **should** be interpreted as `0`. The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction. The number formed by the sign, the integer and the fraction is referred to as the significand. The exponent consists of the character `e` (`U+0065`) or `E` (`U+0045`) followed by one or more decimal digits. Services **should** normalize decimal values before storing them by: - Removing an explicitly-provided `+` sign (`+2.5` -&gt; `2.5`). - Replacing a zero-length integer value with `0` (`.5` -&gt; `0.5`). - Coercing the exponent character to upper-case, with explicit sign (`2.5e8` -&gt; `2.5E+8`). - Removing an explicitly-provided zero exponent (`2.5E0` -&gt; `2.5`). Services **may** perform additional normalization based on its own needs and the internal decimal implementation selected, such as shifting the decimal point and exponent value together (example: `2.5E-1` &lt;-&gt; `0.25`). Additionally, services **may** preserve trailing zeroes in the fraction to indicate increased precision, but are not required to do so. Note that only the `.` character is supported to divide the integer and the fraction; `,` **should not** be supported regardless of locale. Additionally, thousand separators **should not** be supported. If a service does support them, values **must** be normalized. The ENBF grammar is: DecimalString = &#x27;&#x27; | [Sign] Significand [Exponent]; Sign = &#x27;+&#x27; | &#x27;-&#x27;; Significand = Digits &#x27;.&#x27; | [Digits] &#x27;.&#x27; Digits; Exponent = (&#x27;e&#x27; | &#x27;E&#x27;) [Sign] Digits; Digits = { &#x27;0&#x27; | &#x27;1&#x27; | &#x27;2&#x27; | &#x27;3&#x27; | &#x27;4&#x27; | &#x27;5&#x27; | &#x27;6&#x27; | &#x27;7&#x27; | &#x27;8&#x27; | &#x27;9&#x27; }; Services **should** clearly document the range of supported values, the maximum supported precision (total number of digits), and, if applicable, the scale (number of digits after the decimal point), as well as how it behaves when receiving out-of-bounds values. Services **may** choose to accept values passed as input even when the value has a higher precision or scale than the service supports, and **should** round the value to fit the supported scale. Alternatively, the service **may** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if precision would be lost. Services **should** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if the service receives a value outside of the supported range.
           },
           &quot;intValue&quot;: &quot;A String&quot;, # A value of type `int`.
diff --git a/googleapiclient/discovery_cache/documents/cloudchannel.v1.json b/googleapiclient/discovery_cache/documents/cloudchannel.v1.json
@@ -2289,7 +2289,7 @@
 }
 }
 },
-"revision": "20241024",
+"revision": "20241102",
 "rootUrl": "https://cloudchannel.googleapis.com/",
 "schemas": {
 "GoogleCloudChannelV1ActivateEntitlementRequest": {
@@ -2429,6 +2429,10 @@
 },
 "type": "array"
 },
+"priceReferenceId": {
+"description": "Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. Yet to be implemented: this field is currently not evaluated in the API if populated in a request.",
+"type": "string"
+},
 "purchaseOrderId": {
 "description": "Optional. Purchase order id provided by the reseller.",
 "type": "string"
@@ -2955,7 +2959,7 @@
 "type": "string"
 },
 "eventType": {
-"description": "Type of event which happened on the customer.",
+"description": "Type of event which happened for the customer.",
 "enum": [
 "TYPE_UNSPECIFIED",
 "PRIMARY_DOMAIN_CHANGED",
@@ -3104,6 +3108,10 @@
 },
 "type": "array"
 },
+"priceReferenceId": {
+"description": "Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. Yet to be implemented: this field is currently not evaluated in the API if populated in a request.",
+"type": "string"
+},
 "provisionedService": {
 "$ref": "GoogleCloudChannelV1ProvisionedService",
 "description": "Output only. Service provisioning details for the entitlement.",
@@ -3324,7 +3332,7 @@
 "type": "string"
 },
 "eventType": {
-"description": "Type of event which happened on the entitlement.",
+"description": "Type of event which happened for the entitlement.",
 "enum": [
 "TYPE_UNSPECIFIED",
 "CREATED",
@@ -4316,6 +4324,10 @@
 "offer": {
 "$ref": "GoogleCloudChannelV1Offer",
 "description": "Offer."
+},
+"priceReferenceId": {
+"description": "Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order.",
+"type": "string"
 }
 },
 "type": "object"
@@ -4888,6 +4900,10 @@
 "offer": {
 "$ref": "GoogleCloudChannelV1Offer",
 "description": "Offer with parameter constraints updated to allow the Transfer."
+},
+"priceReferenceId": {
+"description": "Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order.",
+"type": "string"
 }
 },
 "type": "object"
@@ -5026,7 +5042,7 @@
 "type": "string"
 },
 "eventType": {
-"description": "Type of event performed on the Channel Partner.",
+"description": "Type of event which happened for the channel partner.",
 "enum": [
 "TYPE_UNSPECIFIED",
 "LINK_STATE_CHANGED",
@@ -5112,7 +5128,7 @@
 "type": "string"
 },
 "eventType": {
-"description": "Type of event which happened on the customer.",
+"description": "Type of event which happened for the customer.",
 "enum": [
 "TYPE_UNSPECIFIED",
 "PRIMARY_DOMAIN_CHANGED",
@@ -5302,7 +5318,7 @@ false
 "type": "string"
 },
 "eventType": {
-"description": "Type of event which happened on the entitlement.",
+"description": "Type of event which happened for the entitlement.",
 "enum": [
 "TYPE_UNSPECIFIED",
 "CREATED",
@@ -5383,6 +5399,31 @@ false
 },
 "type": "object"
 },
+"GoogleCloudChannelV1alpha1OpportunityEvent": {
+"description": "Represents Pub/Sub message content describing opportunity updates.",
+"id": "GoogleCloudChannelV1alpha1OpportunityEvent",
+"properties": {
+"eventType": {
+"description": "Type of event which happened for the opportunity.",
+"enum": [
+"TYPE_UNSPECIFIED",
+"CREATED",
+"UPDATED"
+],
+"enumDescriptions": [
+"Not used.",
+"New opportunity created.",
+"Existing opportunity updated."
+],
+"type": "string"
+},
+"opportunity": {
+"description": "Resource name of the opportunity. Format: opportunities/{opportunity}",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudChannelV1alpha1Parameter": {
 "description": "Definition for extended entitlement parameters.",
 "id": "GoogleCloudChannelV1alpha1Parameter",
@@ -5652,6 +5693,10 @@ false
 "entitlementEvent": {
 "$ref": "GoogleCloudChannelV1alpha1EntitlementEvent",
 "description": "Entitlement event sent as part of Pub/Sub event to partners."
+},
+"opportunityEvent": {
+"$ref": "GoogleCloudChannelV1alpha1OpportunityEvent",
+"description": "Opportunity event sent as part of Pub/Sub event to partners/integrators."
 }
 },
 "type": "object"
@@ -5885,7 +5930,7 @@ false
 "type": "object"
 },
 "GoogleTypeDecimal": {
-"description": "A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal. [BigDecimal]: https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html [decimal.Decimal]: https://docs.python.org/3/library/decimal.html",
+"description": "A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html) or Python's [decimal.Decimal](https://docs.python.org/3/library/decimal.html).",
 "id": "GoogleTypeDecimal",
 "properties": {
 "value": {
