@@ -59,9 +59,9 @@ class Account
5959 # @return [String]
6060 attr_accessor :provider
6161
62- # The reseller parent billing account of the account's corresponding billing
63- # account, applicable only when the corresponding billing account is a
64- # subaccount of a reseller. Included in responses only for view
62+ # Output only. The reseller parent billing account of the account's
63+ # corresponding billing account, applicable only when the corresponding billing
64+ # account is a subaccount of a reseller. Included in responses only for view:
6565 # ACCOUNT_VIEW_FULL. Format: billingAccounts/`billing_account_id`
6666 # Corresponds to the JSON property `resellerParentBillingAccount`
6767 # @return [String]
@@ -308,69 +308,69 @@ class Entitlement
308308 # @return [String]
309309 attr_accessor :name
310310
311- # Output only. The end time of the new offer. If the offer was has a term
312- # duration instead of a specified end date, this field is empty. This field is
313- # populated even if the entitlement isn't active yet. If there's no upcoming
314- # offer, the field is empty. * If the entitlement is in
315- # ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE, or
316- # ENTITLEMENT_PENDING_CANCELLATION state , then this field will be empty. * If
317- # the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or
318- # ENTITLEMENT_PENDING_PLAN_CHANGE state, then this field will be populated with
319- # the expected end time of the upcoming offer (in the future) if the upcoming
320- # offer has a specified end date . Otherwise, this field will be empty. * If the
321- # entitlement is in ENTITLEMENT_CANCELLED state, then this field will be empty.
311+ # Output only. The end time of the new offer, determined from the offer's
312+ # specified end date. If the offer des not have a specified end date then this
313+ # field is not set. This field is populated even if the entitlement isn't active
314+ # yet. If there's no upcoming offer, the field is empty. * If the entitlement is
315+ # in the state ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE, or
316+ # ENTITLEMENT_PENDING_CANCELLATION, then this field is empty. * If the
317+ # entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or
318+ # ENTITLEMENT_PENDING_PLAN_CHANGE, and the upcoming offer has a specified end
319+ # date, then this field is populated with the expected end time of the upcoming
320+ # offer, in the future . Otherwise, this field is empty. * If the entitlement is
321+ # in the state ENTITLEMENT_CANCELLED , then this field is empty.
322322 # Corresponds to the JSON property `newOfferEndTime`
323323 # @return [String]
324324 attr_accessor :new_offer_end_time
325325
326326 # Output only. The timestamp when the new offer becomes effective. This field is
327327 # populated even if the entitlement isn't active yet. If there's no upcoming
328- # offer, the field is empty. * If the entitlement is in
329- # ENTITLEMENT_ACTIVATION_REQUESTED state , this field will not be populated when
330- # the entitlement is not yet approved. But after the entitlement is approved,
331- # then this field will be populated with effective time of the upcoming offer. *
332- # If the entitlement is in ENTITLEMENT_ACTIVE or
333- # ENTITLEMENT_PENDING_CANCELLATION state , this field will not be populated. * If
334- # the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state, this
335- # field will not be populated since the entitlement change is waiting on
336- # approval. * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE state,
337- # this field will be populated with the expected effective time of the upcoming
338- # offer ( in the future) . * If the entitlement is in ENTITLEMENT_CANCELLED state,
339- # then this field will be empty.
328+ # offer, the field is empty. * If the entitlement is in the state
329+ # ENTITLEMENT_ACTIVATION_REQUESTED, this field isn't populated when the
330+ # entitlement isn't yet approved. After the entitlement is approved, this field
331+ # is populated with the effective time of the upcoming offer. * If the
332+ # entitlement is in the state ENTITLEMENT_ACTIVE or
333+ # ENTITLEMENT_PENDING_CANCELLATION, this field isn't populated. * If the
334+ # entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL , this
335+ # field isn't populated, because the entitlement change is waiting on approval. *
336+ # If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE, this
337+ # field is populated with the expected effective time of the upcoming offer,
338+ # which is in the future. * If the entitlement is in the state
339+ # ENTITLEMENT_CANCELLED, then this field is empty.
340340 # Corresponds to the JSON property `newOfferStartTime`
341341 # @return [String]
342342 attr_accessor :new_offer_start_time
343343
344- # Output only. The name of the offer the entitlement is switching to upon a
345- # pending plan change . Only exists if the pending plan change is moving to an
346- # offer. This field isn't populated for entitlements which aren't active yet.
347- # Format: 'projects/`project`/services/`service`/privateOffers/`offer`' OR '
344+ # Output only. Upon a pending plan change, the name of the offer that the
345+ # entitlement is switching to . Only exists if the pending plan change is moving
346+ # to an offer. This field isn't populated for entitlements which aren't active
347+ # yet. Format: 'projects/`project`/services/`service`/privateOffers/`offer`' OR '
348348 # projects/`project`/services/`service`/standardOffers/`offer`', depending on
349349 # whether the offer is private or public. The `service` in the name is the
350350 # listing service of the offer. It could be either the product service that the
351351 # offer is referencing, or a generic private offer parent service. We recommend
352352 # that you don't build your integration to rely on the meaning of this `service`
353- # part. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED,
354- # ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION state , then this field
355- # will be empty. * If the entitlement is in
356- # ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE
357- # state, then this field will be populated with the upcoming offer. * If the
358- # entitlement is in ENTITLEMENT_CANCELLED state, then this will be empty.
353+ # part. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED,
354+ # ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION, then this field is
355+ # empty. * If the entitlement is in the state
356+ # ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE,
357+ # then this field is populated with the upcoming offer. * If the entitlement is
358+ # in the state ENTITLEMENT_CANCELLED , then this is empty.
359359 # Corresponds to the JSON property `newPendingOffer`
360360 # @return [String]
361361 attr_accessor :new_pending_offer
362362
363363 # Output only. The duration of the new offer, in ISO 8601 duration format. This
364- # field isn't populated for entitlements which aren 't active yet, only for
365- # pending offer changes . If the offer was has a specified end date instead of a
366- # duration, this field is empty. * If the entitlement is in
367- # ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEENTITLEMENT_ACTIVE , or
368- # ENTITLEMENT_PENDING_CANCELLATION state, then this field is empty. * If the
369- # entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or
370- # ENTITLEMENT_PENDING_PLAN_CHANGE state, then this field will be populated with
371- # the duration of the upcoming offer, if the upcoming offer is does not have a
372- # specified end date . Otherwise, this field will be empty. * If the entitlement
373- # is in ENTITLEMENT_CANCELLED state , then this field will be empty.
364+ # field is populated for pending offer changes. It isn 't populated for
365+ # entitlements which aren't active yet . If the offer has a specified end date
366+ # instead of a duration, this field is empty. * If the entitlement is in the
367+ # state ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE , or
368+ # ENTITLEMENT_PENDING_CANCELLATION, this field is empty. * If the entitlement is
369+ # in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or
370+ # ENTITLEMENT_PENDING_PLAN_CHANGE, and the upcoming offer doesn't have a
371+ # specified end date, then this field is populated with the duration of the
372+ # upcoming offer . Otherwise, this field is empty. * If the entitlement is in the
373+ # state ENTITLEMENT_CANCELLED, then this field is empty.
374374 # Corresponds to the JSON property `newPendingOfferDuration`
375375 # @return [String]
376376 attr_accessor :new_pending_offer_duration
@@ -382,66 +382,67 @@ class Entitlement
382382 attr_accessor :new_pending_plan
383383
384384 # Output only. The name of the offer that was procured. Field is empty if order
385- # was not made using an offer. Format: 'projects/`project`/services/`service`/
385+ # wasn't made using an offer. Format: 'projects/`project`/services/`service`/
386386 # privateOffers/`offer`' OR 'projects/`project`/services/`service`/
387387 # standardOffers/`offer`', depending on whether the offer is private or public.
388388 # The `service` in the name is the listing service of the offer. It could be
389389 # either the product service that the offer is referencing, or a generic private
390390 # offer parent service. We recommend that you don't build your integration to
391- # rely on the meaning of this `service` part. * If the entitlement is in
392- # ENTITLEMENT_ACTIVATION_REQUESTED state, this field will be populated with the
393- # upcoming offer. * If the entitlement is in ENTITLEMENT_ACTIVE,
391+ # rely on the meaning of this `service` part. * If the entitlement is in the
392+ # state ENTITLEMENT_ACTIVATION_REQUESTED , this field is populated with the
393+ # upcoming offer. * If the entitlement is in the state ENTITLEMENT_ACTIVE,
394394 # ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_PENDING_PLAN_CHANGE, or
395- # ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state , this field will be populated
396- # with the current offer. * If the entitlement is in ENTITLEMENT_CANCELLED state,
397- # then this field will be populated with the latest offer the order was
395+ # ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL, this field is populated with the
396+ # current offer. * If the entitlement is in the state ENTITLEMENT_CANCELLED ,
397+ # then this field is populated with the latest offer that the order was
398398 # associated with.
399399 # Corresponds to the JSON property `offer`
400400 # @return [String]
401401 attr_accessor :offer
402402
403- # Output only. The offer duration of the current offer in ISO 8601 duration
404- # format. Field is empty if entitlement was not made using an offer. If the
405- # offer has a specified end date instead of a duration, this field is empty. *
406- # If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED state, then this
407- # field will be populated with the duration of the upcoming offer, if the
408- # upcoming offer does not have a specified end date. Otherwise, this field will
409- # be empty. * If the entitlement is in ENTITLEMENT_ACTIVE,
410- # ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_PENDING_PLAN_CHANGE, or
411- # ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state, then this field will be
412- # populated with the duration of the current offer if the current offer is does
413- # not have a specific end date. Otherwise, this field will be empty. * If the
414- # entitlement is in ENTITLEMENT_CANCELLED state, then this field will be
415- # populated with the duration of the latest offer the order was associated with
416- # if that offer does not have a specific end date. Otherwise, this field will be
403+ # Output only. The offer duration of the current offer, in ISO 8601 duration
404+ # format. This is empty if the entitlement wasn't made using an offer, or if the
405+ # offer has a specified end date instead of a duration. * If the entitlement is
406+ # in the state ENTITLEMENT_ACTIVATION_REQUESTED, and the upcoming offer doesn't
407+ # have a specified end date, then this field is populated with the duration of
408+ # the upcoming offer. Otherwise, this field is empty. * If the entitlement is in
409+ # the state ENTITLEMENT_ACTIVE, ENTITLEMENT_PENDING_CANCELLATION,
410+ # ENTITLEMENT_PENDING_PLAN_CHANGE, or ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL,
411+ # and the current offer doesn't have a specified end date, then this field
412+ # contains the duration of the current offer. Otherwise, this field is empty. *
413+ # If the entitlement is in the state ENTITLEMENT_CANCELLED, and the offer doesn'
414+ # t have a specified end date, then this field is populated with the duration of
415+ # the latest offer that the order was associated with. Otherwise, this field is
417416 # empty.
418417 # Corresponds to the JSON property `offerDuration`
419418 # @return [String]
420419 attr_accessor :offer_duration
421420
422- # Output only. End time for the Offer associated with this entitlement. Note
423- # that this field value can change over time. This occurs naturally even if the
424- # offer is not changed, due to auto renewal. * If the entitlement is in
425- # ENTITLEMENT_ACTIVATION_REQUESTED state, then: * If the entitlement is not yet
426- # approved, then this field will be populated with the expected end time of the
427- # upcoming offer (in the future) if the upcoming offer has a specified end date.
428- # Otherwise this field will be empty. * If the entitlement is approved, then
429- # this field will always be populated with the expected end time of the upcoming
430- # offer (in the future). This means both this field, and the offer_duration
431- # field, can co-exist. * If the entitlement is in ENTITLEMENT_ACTIVE or
432- # ENTITLEMENT_PENDING_CANCELLATION state, then this field will be populated with
433- # the actual expected end time of the current offer (in the futre). Meaning,
434- # this field will be set, regardless of whether the offer has a specific end
435- # date or a duration. This means both this field, and the offer_duration field,
436- # can co-exist. * If the entitlement is in
437- # ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE
438- # state: * If the current offer has already ended and became pure PAYG, then
439- # this field reflects the ACTUAL end time of the current offer (in the past). *
440- # Otherwise, then this is the EXPECTED end date of the current offer (in the
441- # future). * If the entitlement is in ENTITLEMENT_CANCELLED state, then this
442- # field will be populated with the ACTUAL end time of the latest offer the order
443- # was associated with (in the past). If the entitlement was cancelled before any
444- # offer started, then this field will be empty.
421+ # Output only. End time for the current term of the Offer associated with this
422+ # entitlement. The value of this field can change naturally over time due to
423+ # auto-renewal, even if the offer isn't changed. * If the entitlement is in the
424+ # state ENTITLEMENT_ACTIVATION_REQUESTED, then: * If the entitlement isn't
425+ # approved yet approved, and the offer has a specified end date, then this field
426+ # is populated with the expected end time of the upcoming offer, in the future.
427+ # Otherwise, this field is empty. * If the entitlement is approved, then this
428+ # field is populated with the expected end time of the upcoming offer, in the
429+ # future. This means that this field and the field offer_duration can both exist.
430+ # * If the entitlement is in the state ENTITLEMENT_ACTIVE or
431+ # ENTITLEMENT_PENDING_CANCELLATION, then this field is populated with the
432+ # expected end time of the current offer, in the future. This field's value is
433+ # set regardless of whether the offer has a specific end date or a duration.
434+ # This means that this field and the field offer_duration can both exist. * If
435+ # the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or
436+ # ENTITLEMENT_PENDING_PLAN_CHANGE: * If the entitlement's pricing model is usage
437+ # based and the associated offer is a private offer whose term has ended, then
438+ # this field reflects the ACTUAL end time of the entitlement's associated offer (
439+ # in the past), even though the entitlement associated with this private offer
440+ # does not terminate at the end of that private offer's term. * Otherwise, this
441+ # is the expected end date of the current offer, in the future. * If the
442+ # entitlement is in the state ENTITLEMENT_CANCELLED, then this field is
443+ # populated with the end time, in the past, of the latest offer that the order
444+ # was associated with. If the entitlement was cancelled before any offer started,
445+ # then this field is empty.
445446 # Corresponds to the JSON property `offerEndTime`
446447 # @return [String]
447448 attr_accessor :offer_end_time
0 commit comments