feat: Automated regeneration of cloudcommerceprocurement v1 client (#24253)

Auto-created at 2025-09-14 09:34:58 +0000 using the toys pull request generator.

Author: yoshi-code-bot

generated/google-apis-cloudcommerceprocurement_v1/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-cloudcommerceprocurement_v1
 
+### v0.3.0 (2025-09-14)
+
+* Regenerated from discovery document revision 20250907
+
 ### v0.2.0 (2025-09-07)
 
 * Regenerated from discovery document revision 20250831

generated/google-apis-cloudcommerceprocurement_v1/lib/google/apis/cloudcommerceprocurement_v1/classes.rb

@@ -299,39 +299,69 @@ class Entitlement
         # @return [String]
         attr_accessor :name
 
-        # Output only. The end time of the new offer. If the offer was created with a
-        # term instead of a specified end date, this field is empty. This field is
+        # Output only. The end time of the new offer. If the offer was has a term
+        # duration instead of a specified end date, this field is empty. This field is
         # populated even if the entitlement isn't active yet. If there's no upcoming
-        # offer, the field is be empty.
+        # offer, the field is empty. * If the entitlement is in
+        # ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE, or
+        # ENTITLEMENT_PENDING_CANCELLATION state, then this field will be empty. * If
+        # the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or
+        # ENTITLEMENT_PENDING_PLAN_CHANGE state, then this field will be populated with
+        # the expected end time of the upcoming offer (in the future) if the upcoming
+        # offer has a specified end date. Otherwise, this field will be empty. * If the
+        # entitlement is in ENTITLEMENT_CANCELLED state, then this field will be empty.
         # Corresponds to the JSON property `newOfferEndTime`
         # @return [String]
         attr_accessor :new_offer_end_time
 
         # Output only. The timestamp when the new offer becomes effective. This field is
         # populated even if the entitlement isn't active yet. If there's no upcoming
-        # offer, the field is empty.
+        # offer, the field is empty. * If the entitlement is in
+        # ENTITLEMENT_ACTIVATION_REQUESTED state, this field will not be populated when
+        # the entitlement is not yet approved. But after the entitlement is approved,
+        # then this field will be populated with effective time of the upcoming offer. *
+        # If the entitlement is in ENTITLEMENT_ACTIVE or
+        # ENTITLEMENT_PENDING_CANCELLATION state, this field will not be populated. * If
+        # the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state, this
+        # field will not be populated since the entitlement change is waiting on
+        # approval. * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE state,
+        # this field will be populated with the expected effective time of the upcoming
+        # offer (in the future). * If the entitlement is in ENTITLEMENT_CANCELLED state,
+        # then this field will be empty.
         # Corresponds to the JSON property `newOfferStartTime`
         # @return [String]
         attr_accessor :new_offer_start_time
 
         # Output only. The name of the offer the entitlement is switching to upon a
         # pending plan change. Only exists if the pending plan change is moving to an
         # offer. This field isn't populated for entitlements which aren't active yet.
-        # Format: 'projects/`project`/services/`service`/privateOffers/`offer-id`' OR '
-        # projects/`project`/services/`service`/standardOffers/`offer-id`', depending on
+        # Format: 'projects/`project`/services/`service`/privateOffers/`offer`' OR '
+        # projects/`project`/services/`service`/standardOffers/`offer`', depending on
         # whether the offer is private or public. The `service` in the name is the
         # listing service of the offer. It could be either the product service that the
         # offer is referencing, or a generic private offer parent service. We recommend
         # that you don't build your integration to rely on the meaning of this `service`
-        # part.
+        # part. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED,
+        # ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION state, then this field
+        # will be empty. * If the entitlement is in
+        # ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE
+        # state, then this field will be populated with the upcoming offer. * If the
+        # entitlement is in ENTITLEMENT_CANCELLED state, then this will be empty.
         # Corresponds to the JSON property `newPendingOffer`
         # @return [String]
         attr_accessor :new_pending_offer
 
         # Output only. The duration of the new offer, in ISO 8601 duration format. This
         # field isn't populated for entitlements which aren't active yet, only for
-        # pending offer changes. If the offer was created with a specified end date
-        # instead of a duration, this field is empty.
+        # pending offer changes. If the offer was has a specified end date instead of a
+        # duration, this field is empty. * If the entitlement is in
+        # ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEENTITLEMENT_ACTIVE, or
+        # ENTITLEMENT_PENDING_CANCELLATION state, then this field is empty. * If the
+        # entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or
+        # ENTITLEMENT_PENDING_PLAN_CHANGE state, then this field will be populated with
+        # the duration of the upcoming offer, if the upcoming offer is does not have a
+        # specified end date. Otherwise, this field will be empty. * If the entitlement
+        # is in ENTITLEMENT_CANCELLED state, then this field will be empty.
         # Corresponds to the JSON property `newPendingOfferDuration`
         # @return [String]
         attr_accessor :new_pending_offer_duration
@@ -344,27 +374,65 @@ class Entitlement
 
         # Output only. The name of the offer that was procured. Field is empty if order
         # was not made using an offer. Format: 'projects/`project`/services/`service`/
-        # privateOffers/`offer-id`' OR 'projects/`project`/services/`service`/
-        # standardOffers/`offer-id`', depending on whether the offer is private or
-        # public. The `service` in the name is the listing service of the offer. It
-        # could be either the product service that the offer is referencing, or a
-        # generic private offer parent service. We recommend that you don't build your
-        # integration to rely on the meaning of this `service` part.
+        # privateOffers/`offer`' OR 'projects/`project`/services/`service`/
+        # standardOffers/`offer`', depending on whether the offer is private or public.
+        # The `service` in the name is the listing service of the offer. It could be
+        # either the product service that the offer is referencing, or a generic private
+        # offer parent service. We recommend that you don't build your integration to
+        # rely on the meaning of this `service` part. * If the entitlement is in
+        # ENTITLEMENT_ACTIVATION_REQUESTED state, this field will be populated with the
+        # upcoming offer. * If the entitlement is in ENTITLEMENT_ACTIVE,
+        # ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_PENDING_PLAN_CHANGE, or
+        # ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state, this field will be populated
+        # with the current offer. * If the entitlement is in ENTITLEMENT_CANCELLED state,
+        # then this field will be populated with the latest offer the order was
+        # associated with.
         # Corresponds to the JSON property `offer`
         # @return [String]
         attr_accessor :offer
 
         # Output only. The offer duration of the current offer in ISO 8601 duration
         # format. Field is empty if entitlement was not made using an offer. If the
-        # offer was created with a specified end date instead of a duration, this field
-        # is empty.
+        # offer has a specified end date instead of a duration, this field is empty. *
+        # If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED state, then this
+        # field will be populated with the duration of the upcoming offer, if the
+        # upcoming offer does not have a specified end date. Otherwise, this field will
+        # be empty. * If the entitlement is in ENTITLEMENT_ACTIVE,
+        # ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_PENDING_PLAN_CHANGE, or
+        # ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state, then this field will be
+        # populated with the duration of the current offer if the current offer is does
+        # not have a specific end date. Otherwise, this field will be empty. * If the
+        # entitlement is in ENTITLEMENT_CANCELLED state, then this field will be
+        # populated with the duration of the latest offer the order was associated with
+        # if that offer does not have a specific end date. Otherwise, this field will be
+        # empty.
         # Corresponds to the JSON property `offerDuration`
         # @return [String]
         attr_accessor :offer_duration
 
-        # Output only. End time for the Offer association corresponding to this
-        # entitlement. The field is only populated if the entitlement is currently
-        # associated with an Offer.
+        # Output only. End time for the Offer associated with this entitlement. Note
+        # that this field value can change over time. This occurs naturally even if the
+        # offer is not changed, due to auto renewal. * If the entitlement is in
+        # ENTITLEMENT_ACTIVATION_REQUESTED state, then: * If the entitlement is not yet
+        # approved, then this field will be populated with the expected end time of the
+        # upcoming offer (in the future) if the upcoming offer has a specified end date.
+        # Otherwise this field will be empty. * If the entitlement is approved, then
+        # this field will always be populated with the expected end time of the upcoming
+        # offer (in the future). This means both this field, and the offer_duration
+        # field, can co-exist. * If the entitlement is in ENTITLEMENT_ACTIVE or
+        # ENTITLEMENT_PENDING_CANCELLATION state, then this field will be populated with
+        # the actual expected end time of the current offer (in the futre). Meaning,
+        # this field will be set, regardless of whether the offer has a specific end
+        # date or a duration. This means both this field, and the offer_duration field,
+        # can co-exist. * If the entitlement is in
+        # ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE
+        # state: * If the current offer has already ended and became pure PAYG, then
+        # this field reflects the ACTUAL end time of the current offer (in the past). *
+        # Otherwise, then this is the EXPECTED end date of the current offer (in the
+        # future). * If the entitlement is in ENTITLEMENT_CANCELLED state, then this
+        # field will be populated with the ACTUAL end time of the latest offer the order
+        # was associated with (in the past). If the entitlement was cancelled before any
+        # offer started, then this field will be empty.
         # Corresponds to the JSON property `offerEndTime`
         # @return [String]
         attr_accessor :offer_end_time

generated/google-apis-cloudcommerceprocurement_v1/lib/google/apis/cloudcommerceprocurement_v1/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module CloudcommerceprocurementV1
       # Version of the google-apis-cloudcommerceprocurement_v1 gem
-      GEM_VERSION = "0.2.0"
+      GEM_VERSION = "0.3.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.18.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20250831"
+      REVISION = "20250907"
     end
   end
 end