Class: Google::Apis::AndroiddeviceprovisioningV1::Company

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

Overview

A reseller, vendor, or customer in the zero-touch reseller and customer APIs.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Company

Returns a new instance of Company.



209
210
211
# File 'lib/google/apis/androiddeviceprovisioning_v1/classes.rb', line 209

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

Instance Attribute Details

#admin_emailsArray<String>

Optional. Email address of customer's users in the admin role. Each email address must be associated with a Google Account. Corresponds to the JSON property adminEmails

Returns:

  • (Array<String>)


145
146
147
# File 'lib/google/apis/androiddeviceprovisioning_v1/classes.rb', line 145

def admin_emails
  @admin_emails
end

#company_idFixnum

Output only. The ID of the company. Assigned by the server. Corresponds to the JSON property companyId

Returns:

  • (Fixnum)


150
151
152
# File 'lib/google/apis/androiddeviceprovisioning_v1/classes.rb', line 150

def company_id
  @company_id
end

#company_nameString

Required. The name of the company. For example XYZ Corp. Displayed to the company's employees in the zero-touch enrollment portal. Corresponds to the JSON property companyName

Returns:

  • (String)


156
157
158
# File 'lib/google/apis/androiddeviceprovisioning_v1/classes.rb', line 156

def company_name
  @company_name
end

#google_workspace_accountGoogle::Apis::AndroiddeviceprovisioningV1::GoogleWorkspaceAccount

A Google Workspace customer. Corresponds to the JSON property googleWorkspaceAccount



161
162
163
# File 'lib/google/apis/androiddeviceprovisioning_v1/classes.rb', line 161

def 
  @google_workspace_account
end

#language_codeString

Input only. The preferred locale of the customer represented as a BCP47 language code. This field is validated on input and requests containing unsupported language codes will be rejected. Supported language codes: Arabic ( ar) Chinese (Hong Kong) (zh-HK) Chinese (Simplified) (zh-CN) Chinese ( Traditional) (zh-TW) Czech (cs) Danish (da) Dutch (nl) English (UK) (en-GB) English (US) (en-US) Filipino (fil) Finnish (fi) French (fr) German (de) Hebrew (iw) Hindi (hi) Hungarian (hu) Indonesian (id) Italian (it) Japanese ( ja) Korean (ko) Norwegian (Bokmal) (no) Polish (pl) Portuguese (Brazil) (pt-BR) Portuguese (Portugal) (pt-PT) Russian (ru) Spanish (es) Spanish (Latin America) (es-419) Swedish (sv) Thai (th) Turkish (tr) Ukrainian (uk) Vietnamese (vi) Corresponds to the JSON property languageCode

Returns:

  • (String)


176
177
178
# File 'lib/google/apis/androiddeviceprovisioning_v1/classes.rb', line 176

def language_code
  @language_code
end

#nameString

Output only. The API resource name of the company. The resource name is one of the following formats: * partners/[PARTNER_ID]/customers/[CUSTOMER_ID] * partners/[PARTNER_ID]/vendors/[VENDOR_ID] * partners/[PARTNER_ID]/vendors/[ VENDOR_ID]/customers/[CUSTOMER_ID] Assigned by the server. Corresponds to the JSON property name

Returns:

  • (String)


184
185
186
# File 'lib/google/apis/androiddeviceprovisioning_v1/classes.rb', line 184

def name
  @name
end

#owner_emailsArray<String>

Required. Input only. Email address of customer's users in the owner role. At least one owner_email is required. Owners share the same access as admins but can also add, delete, and edit your organization's portal users. Corresponds to the JSON property ownerEmails

Returns:

  • (Array<String>)


191
192
193
# File 'lib/google/apis/androiddeviceprovisioning_v1/classes.rb', line 191

def owner_emails
  @owner_emails
end

#skip_welcome_emailBoolean Also known as: skip_welcome_email?

Input only. If set to true, welcome email will not be sent to the customer. It is recommended to skip the welcome email if devices will be claimed with additional DEVICE_PROTECTION service, as the customer will receive separate emails at device claim time. This field is ignored if this is not a Zero-touch customer. Corresponds to the JSON property skipWelcomeEmail

Returns:

  • (Boolean)


200
201
202
# File 'lib/google/apis/androiddeviceprovisioning_v1/classes.rb', line 200

def skip_welcome_email
  @skip_welcome_email
end

#terms_statusString

Output only. Whether any user from the company has accepted the latest Terms of Service (ToS). See TermsStatus. Corresponds to the JSON property termsStatus

Returns:

  • (String)


207
208
209
# File 'lib/google/apis/androiddeviceprovisioning_v1/classes.rb', line 207

def terms_status
  @terms_status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



214
215
216
217
218
219
220
221
222
223
224
# File 'lib/google/apis/androiddeviceprovisioning_v1/classes.rb', line 214

def update!(**args)
  @admin_emails = args[:admin_emails] if args.key?(:admin_emails)
  @company_id = args[:company_id] if args.key?(:company_id)
  @company_name = args[:company_name] if args.key?(:company_name)
  @google_workspace_account = args[:google_workspace_account] if args.key?(:google_workspace_account)
  @language_code = args[:language_code] if args.key?(:language_code)
  @name = args[:name] if args.key?(:name)
  @owner_emails = args[:owner_emails] if args.key?(:owner_emails)
  @skip_welcome_email = args[:skip_welcome_email] if args.key?(:skip_welcome_email)
  @terms_status = args[:terms_status] if args.key?(:terms_status)
end