Class: Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1Subscription

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/paymentsresellersubscription_v1/classes.rb,
lib/google/apis/paymentsresellersubscription_v1/representations.rb,
lib/google/apis/paymentsresellersubscription_v1/representations.rb

Overview

A Subscription resource managed by 3P Partners.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudPaymentsResellerSubscriptionV1Subscription

Returns a new instance of GoogleCloudPaymentsResellerSubscriptionV1Subscription.



489
490
491
 
# File 'lib/google/apis/paymentsresellersubscription_v1/classes.rb', line 489

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#cancellation_details ⇒ Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1SubscriptionCancellationDetails

Describes the details of a cancelled or cancelling subscription. Corresponds to the JSON property cancellationDetails

Returns:



398
399
400
 
# File 'lib/google/apis/paymentsresellersubscription_v1/classes.rb', line 398

def cancellation_details
  @cancellation_details
end

#create_time ⇒ String

Output only. System generated timestamp when the subscription is created. UTC timezone. Corresponds to the JSON property createTime

Returns:

  • (String) 


404
405
406
 
# File 'lib/google/apis/paymentsresellersubscription_v1/classes.rb', line 404

def create_time
  @create_time
end

#cycle_end_time ⇒ String

Output only. The time at which the subscription is expected to be extended, in ISO 8061 format. UTC timezone. For example: "2019-08-31T17:28:54.564Z" Corresponds to the JSON property cycleEndTime

Returns:

  • (String) 


410
411
412
 
# File 'lib/google/apis/paymentsresellersubscription_v1/classes.rb', line 410

def cycle_end_time
  @cycle_end_time
end

#end_user_entitled ⇒ Boolean Also known as: end_user_entitled?

Output only. Indicates if the subscription is entitled to the end user. Corresponds to the JSON property endUserEntitled

Returns:

  • (Boolean) 


415
416
417
 
# File 'lib/google/apis/paymentsresellersubscription_v1/classes.rb', line 415

def end_user_entitled
  @end_user_entitled
end

#free_trial_end_time ⇒ String

Output only. End of the free trial period, in ISO 8061 format. For example, " 2019-08-31T17:28:54.564Z". It will be set the same as createTime if no free trial promotion is specified. Corresponds to the JSON property freeTrialEndTime

Returns:

  • (String) 


423
424
425
 
# File 'lib/google/apis/paymentsresellersubscription_v1/classes.rb', line 423

def free_trial_end_time
  @free_trial_end_time
end

#name ⇒ String

Output only. Response only. Resource name of the subscription. It will have the format of "partners/partner_id/subscriptions/subscription_id" Corresponds to the JSON property name

Returns:

  • (String) 


429
430
431
 
# File 'lib/google/apis/paymentsresellersubscription_v1/classes.rb', line 429

def name
  @name
end

#partner_user_token ⇒ String

Required. Identifier of the end-user in partner’s system. The value is restricted to 63 ASCII characters at the maximum. Corresponds to the JSON property partnerUserToken

Returns:

  • (String) 


435
436
437
 
# File 'lib/google/apis/paymentsresellersubscription_v1/classes.rb', line 435

def partner_user_token
  @partner_user_token
end

#processing_state ⇒ String

Output only. Describes the processing state of the subscription. See more details at the lifecycle of a subscription. Corresponds to the JSON property processingState

Returns:

  • (String) 


442
443
444
 
# File 'lib/google/apis/paymentsresellersubscription_v1/classes.rb', line 442

def processing_state
  @processing_state
end

#products ⇒ Array<String>

Required. Resource name that identifies one or more subscription products. The format will be 'partners/partner_id/products/product_id'. Corresponds to the JSON property products

Returns:

  • (Array<String>) 


448
449
450
 
# File 'lib/google/apis/paymentsresellersubscription_v1/classes.rb', line 448

def products
  @products
end

#promotions ⇒ Array<String>

Optional. Resource name that identifies one or more promotions that can be applied on the product. A typical promotion for a subscription is Free trial. The format will be 'partners/partner_id/promotions/promotion_id'. Corresponds to the JSON property promotions

Returns:

  • (Array<String>) 


455
456
457
 
# File 'lib/google/apis/paymentsresellersubscription_v1/classes.rb', line 455

def promotions
  @promotions
end

#redirect_uri ⇒ String

Output only. The place where partners should redirect the end-user to after creation. This field might also be populated when creation failed. However, Partners should always prepare a default URL to redirect the user in case this field is empty. Corresponds to the JSON property redirectUri

Returns:

  • (String) 


463
464
465
 
# File 'lib/google/apis/paymentsresellersubscription_v1/classes.rb', line 463

def redirect_uri
  @redirect_uri
end

#service_location ⇒ Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1Location

Describes a location of an end user. Corresponds to the JSON property serviceLocation

Returns:



468
469
470
 
# File 'lib/google/apis/paymentsresellersubscription_v1/classes.rb', line 468

def service_location
  @service_location
end

#state ⇒ String

Output only. Describes the state of the subscription. See more details at the lifecycle of a subscription. Corresponds to the JSON property state

Returns:

  • (String) 


475
476
477
 
# File 'lib/google/apis/paymentsresellersubscription_v1/classes.rb', line 475

def state
  @state
end

#update_time ⇒ String

Output only. System generated timestamp when the subscription is most recently updated. UTC timezone. Corresponds to the JSON property updateTime

Returns:

  • (String) 


481
482
483
 
# File 'lib/google/apis/paymentsresellersubscription_v1/classes.rb', line 481

def update_time
  @update_time
end

#upgrade_downgrade_details ⇒ Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1SubscriptionUpgradeDowngradeDetails

Details about the previous subscription that this new subscription upgrades/ downgrades from. Corresponds to the JSON property upgradeDowngradeDetails

Returns:



487
488
489
 
# File 'lib/google/apis/paymentsresellersubscription_v1/classes.rb', line 487

def upgrade_downgrade_details
  @upgrade_downgrade_details
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'lib/google/apis/paymentsresellersubscription_v1/classes.rb', line 494

def update!(**args)
  @cancellation_details = args[:cancellation_details] if args.key?(:cancellation_details)
  @create_time = args[:create_time] if args.key?(:create_time)
  @cycle_end_time = args[:cycle_end_time] if args.key?(:cycle_end_time)
  @end_user_entitled = args[:end_user_entitled] if args.key?(:end_user_entitled)
  @free_trial_end_time = args[:free_trial_end_time] if args.key?(:free_trial_end_time)
  @name = args[:name] if args.key?(:name)
  @partner_user_token = args[:partner_user_token] if args.key?(:partner_user_token)
  @processing_state = args[:processing_state] if args.key?(:processing_state)
  @products = args[:products] if args.key?(:products)
  @promotions = args[:promotions] if args.key?(:promotions)
  @redirect_uri = args[:redirect_uri] if args.key?(:redirect_uri)
  @service_location = args[:service_location] if args.key?(:service_location)
  @state = args[:state] if args.key?(:state)
  @update_time = args[:update_time] if args.key?(:update_time)
  @upgrade_downgrade_details = args[:upgrade_downgrade_details] if args.key?(:upgrade_downgrade_details)
end