Class: Google::Apis::ResellerV1::Customer

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

Overview

When a Google customer's account is registered with a reseller, the customer's subscriptions for Google services are managed by this reseller. A customer is described by a primary domain name and a physical address.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Customer

Returns a new instance of Customer.



235
236
237
 
# File 'lib/google/apis/reseller_v1/classes.rb', line 235

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

Instance Attribute Details

#alternate_email ⇒ String

Like the "Customer email" in the reseller tools, this email is the secondary contact used if something happens to the customer's service such as service outage or a security issue. This property is required when creating a new " domain" customer and should not use the same domain as customerDomain. The alternateEmail field is not necessary to create a "team" customer. Corresponds to the JSON property alternateEmail

Returns:

  • (String) 


175
176
177
 
# File 'lib/google/apis/reseller_v1/classes.rb', line 175

def alternate_email
  @alternate_email
end

#customer_domain ⇒ String

The customer's primary domain name string. customerDomain is required when creating a new customer. Do not include the www prefix in the domain when adding a customer. Corresponds to the JSON property customerDomain

Returns:

  • (String) 


182
183
184
 
# File 'lib/google/apis/reseller_v1/classes.rb', line 182

def customer_domain
  @customer_domain
end

#customer_domain_verified ⇒ Boolean Also known as: customer_domain_verified?

Whether the customer's primary domain has been verified. Corresponds to the JSON property customerDomainVerified

Returns:

  • (Boolean) 


187
188
189
 
# File 'lib/google/apis/reseller_v1/classes.rb', line 187

def customer_domain_verified
  @customer_domain_verified
end

#customer_id ⇒ String

This property will always be returned in a response as the unique identifier generated by Google. In a request, this property can be either the primary domain or the unique identifier generated by Google. Corresponds to the JSON property customerId

Returns:

  • (String) 


195
196
197
 
# File 'lib/google/apis/reseller_v1/classes.rb', line 195

def customer_id
  @customer_id
end

#customer_type ⇒ String

Identifies the type of the customer. Acceptable values include: * domain: Implies a domain-verified customer (default). * team: Implies an email- verified customer. For more information, see managed teams. Corresponds to the JSON property customerType

Returns:

  • (String) 


203
204
205
 
# File 'lib/google/apis/reseller_v1/classes.rb', line 203

def customer_type
  @customer_type
end

#kind ⇒ String

Identifies the resource as a customer. Value: reseller#customer Corresponds to the JSON property kind

Returns:

  • (String) 


208
209
210
 
# File 'lib/google/apis/reseller_v1/classes.rb', line 208

def kind
  @kind
end

#phone_number ⇒ String

Customer contact phone number. Must start with "+" followed by the country code. The rest of the number can be contiguous numbers or respect the phone local format conventions, but it must be a real phone number and not, for example, "123". This field is silently ignored if invalid. Corresponds to the JSON property phoneNumber

Returns:

  • (String) 


216
217
218
 
# File 'lib/google/apis/reseller_v1/classes.rb', line 216

def phone_number
  @phone_number
end

#postal_address ⇒ Google::Apis::ResellerV1::Address

JSON template for address of a customer. Corresponds to the JSON property postalAddress

Returns:



221
222
223
 
# File 'lib/google/apis/reseller_v1/classes.rb', line 221

def postal_address
  @postal_address
end

#primary_admin ⇒ Google::Apis::ResellerV1::PrimaryAdmin

JSON template for primary admin in case of TEAM customers Corresponds to the JSON property primaryAdmin

Returns:



226
227
228
 
# File 'lib/google/apis/reseller_v1/classes.rb', line 226

def primary_admin
  @primary_admin
end

#resource_ui_url ⇒ String

URL to customer's Admin console dashboard. The read-only URL is generated by the API service. This is used if your client application requires the customer to complete a task in the Admin console. Corresponds to the JSON property resourceUiUrl

Returns:

  • (String) 


233
234
235
 
# File 'lib/google/apis/reseller_v1/classes.rb', line 233

def resource_ui_url
  @resource_ui_url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/google/apis/reseller_v1/classes.rb', line 240

def update!(**args)
  @alternate_email = args[:alternate_email] if args.key?(:alternate_email)
  @customer_domain = args[:customer_domain] if args.key?(:customer_domain)
  @customer_domain_verified = args[:customer_domain_verified] if args.key?(:customer_domain_verified)
  @customer_id = args[:customer_id] if args.key?(:customer_id)
  @customer_type = args[:customer_type] if args.key?(:customer_type)
  @kind = args[:kind] if args.key?(:kind)
  @phone_number = args[:phone_number] if args.key?(:phone_number)
  @postal_address = args[:postal_address] if args.key?(:postal_address)
  @primary_admin = args[:primary_admin] if args.key?(:primary_admin)
  @resource_ui_url = args[:resource_ui_url] if args.key?(:resource_ui_url)
end