Class: Google::Apis::ResellerV1::Subscription

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

Overview

JSON template for a subscription.

Defined Under Namespace

Classes: Plan, TransferInfo, TrialSettings

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Subscription

Returns a new instance of Subscription.



373
374
375
 
# File 'generated/google/apis/reseller_v1/classes.rb', line 373

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

Instance Attribute Details

#billing_method ⇒ String

Billing method of this subscription. Corresponds to the JSON property billingMethod

Returns:

  • (String) 


279
280
281
 
# File 'generated/google/apis/reseller_v1/classes.rb', line 279

def billing_method
  @billing_method
end

#creation_time ⇒ String

Creation time of this subscription in milliseconds since Unix epoch. Corresponds to the JSON property creationTime

Returns:

  • (String) 


284
285
286
 
# File 'generated/google/apis/reseller_v1/classes.rb', line 284

def creation_time
  @creation_time
end

#customer_domain ⇒ String

Primary domain name of the customer Corresponds to the JSON property customerDomain

Returns:

  • (String) 


289
290
291
 
# File 'generated/google/apis/reseller_v1/classes.rb', line 289

def customer_domain
  @customer_domain
end

#customer_id ⇒ String

The id of the customer to whom the subscription belongs. Corresponds to the JSON property customerId

Returns:

  • (String) 


294
295
296
 
# File 'generated/google/apis/reseller_v1/classes.rb', line 294

def customer_id
  @customer_id
end

#deal_code ⇒ String

External name of the deal, if this subscription was provisioned under one. Otherwise this field will be empty. Corresponds to the JSON property dealCode

Returns:

  • (String) 


300
301
302
 
# File 'generated/google/apis/reseller_v1/classes.rb', line 300

def deal_code
  @deal_code
end

#kind ⇒ String

Identifies the resource as a Subscription. Corresponds to the JSON property kind

Returns:

  • (String) 


305
306
307
 
# File 'generated/google/apis/reseller_v1/classes.rb', line 305

def kind
  @kind
end

#plan ⇒ Google::Apis::ResellerV1::Subscription::Plan

Plan details of the subscription Corresponds to the JSON property plan

Returns:



310
311
312
 
# File 'generated/google/apis/reseller_v1/classes.rb', line 310

def plan
  @plan
end

#purchase_order_id ⇒ String

Purchase order id for your order tracking purposes. Corresponds to the JSON property purchaseOrderId

Returns:

  • (String) 


315
316
317
 
# File 'generated/google/apis/reseller_v1/classes.rb', line 315

def purchase_order_id
  @purchase_order_id
end

#renewal_settings ⇒ Google::Apis::ResellerV1::RenewalSettings

JSON template for a subscription renewal settings. Corresponds to the JSON property renewalSettings

Returns:



320
321
322
 
# File 'generated/google/apis/reseller_v1/classes.rb', line 320

def renewal_settings
  @renewal_settings
end

#resource_ui_url ⇒ String

Ui url for subscription resource. Corresponds to the JSON property resourceUiUrl

Returns:

  • (String) 


325
326
327
 
# File 'generated/google/apis/reseller_v1/classes.rb', line 325

def resource_ui_url
  @resource_ui_url
end

#seats ⇒ Google::Apis::ResellerV1::Seats

JSON template for subscription seats. Corresponds to the JSON property seats

Returns:



330
331
332
 
# File 'generated/google/apis/reseller_v1/classes.rb', line 330

def seats
  @seats
end

#sku_id ⇒ String

Name of the sku for which this subscription is purchased. Corresponds to the JSON property skuId

Returns:

  • (String) 


335
336
337
 
# File 'generated/google/apis/reseller_v1/classes.rb', line 335

def sku_id
  @sku_id
end

#status ⇒ String

Status of the subscription. Corresponds to the JSON property status

Returns:

  • (String) 


340
341
342
 
# File 'generated/google/apis/reseller_v1/classes.rb', line 340

def status
  @status
end

#subscription_id ⇒ String

The id of the subscription. Corresponds to the JSON property subscriptionId

Returns:

  • (String) 


345
346
347
 
# File 'generated/google/apis/reseller_v1/classes.rb', line 345

def subscription_id
  @subscription_id
end

#suspension_reasons ⇒ Array<String>

Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed. Possible options include:

  • PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the Google Apps Resold Terms of Services.
  • RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term.
  • RESELLER_INITIATED - A manual suspension invoked by a Reseller.
  • TRIAL_ENDED - The customer's trial expired without a plan selected.
  • OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise). Corresponds to the JSON property suspensionReasons

Returns:

  • (Array<String>) 


361
362
363
 
# File 'generated/google/apis/reseller_v1/classes.rb', line 361

def suspension_reasons
  @suspension_reasons
end

#transfer_info ⇒ Google::Apis::ResellerV1::Subscription::TransferInfo

Transfer related information for the subscription. Corresponds to the JSON property transferInfo

Returns:



366
367
368
 
# File 'generated/google/apis/reseller_v1/classes.rb', line 366

def transfer_info
  @transfer_info
end

#trial_settings ⇒ Google::Apis::ResellerV1::Subscription::TrialSettings

Trial Settings of the subscription. Corresponds to the JSON property trialSettings

Returns:



371
372
373
 
# File 'generated/google/apis/reseller_v1/classes.rb', line 371

def trial_settings
  @trial_settings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'generated/google/apis/reseller_v1/classes.rb', line 378

def update!(**args)
  @billing_method = args[:billing_method] if args.key?(:billing_method)
  @creation_time = args[:creation_time] if args.key?(:creation_time)
  @customer_domain = args[:customer_domain] if args.key?(:customer_domain)
  @customer_id = args[:customer_id] if args.key?(:customer_id)
  @deal_code = args[:deal_code] if args.key?(:deal_code)
  @kind = args[:kind] if args.key?(:kind)
  @plan = args[:plan] if args.key?(:plan)
  @purchase_order_id = args[:purchase_order_id] if args.key?(:purchase_order_id)
  @renewal_settings = args[:renewal_settings] if args.key?(:renewal_settings)
  @resource_ui_url = args[:resource_ui_url] if args.key?(:resource_ui_url)
  @seats = args[:seats] if args.key?(:seats)
  @sku_id = args[:sku_id] if args.key?(:sku_id)
  @status = args[:status] if args.key?(:status)
  @subscription_id = args[:subscription_id] if args.key?(:subscription_id)
  @suspension_reasons = args[:suspension_reasons] if args.key?(:suspension_reasons)
  @transfer_info = args[:transfer_info] if args.key?(:transfer_info)
  @trial_settings = args[:trial_settings] if args.key?(:trial_settings)
end