Class: Twilio::REST::Trusthub::V1::ComplianceRegistrationInquiriesList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/trusthub/v1/compliance_registration_inquiries.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ ComplianceRegistrationInquiriesList

Initialize the ComplianceRegistrationInquiriesList

Parameters:

  • version (Version)

    Version that contains the resource



26
27
28
29
30
31
32
33
# File 'lib/twilio-ruby/rest/trusthub/v1/compliance_registration_inquiries.rb', line 26

def initialize(version)
    super(version)
    
    # Path Solution
    @solution = {  }
    @uri = "/ComplianceInquiries/Registration/RegulatoryCompliance/GB/Initialize"
    
end

Instance Method Details

#create(end_user_type: nil, phone_number_type: nil, business_identity_type: :unset, business_registration_authority: :unset, business_legal_name: :unset, notification_email: :unset, accepted_notification_receipt: :unset, business_registration_number: :unset, business_website_url: :unset, friendly_name: :unset, authorized_representative1_first_name: :unset, authorized_representative1_last_name: :unset, authorized_representative1_phone: :unset, authorized_representative1_email: :unset, authorized_representative1_date_of_birth: :unset, address_street: :unset, address_street_secondary: :unset, address_city: :unset, address_subdivision: :unset, address_postal_code: :unset, address_country_code: :unset, emergency_address_street: :unset, emergency_address_street_secondary: :unset, emergency_address_city: :unset, emergency_address_subdivision: :unset, emergency_address_postal_code: :unset, emergency_address_country_code: :unset, use_address_as_emergency_address: :unset, file_name: :unset, file: :unset, first_name: :unset, last_name: :unset, date_of_birth: :unset, individual_email: :unset, individual_phone: :unset, is_isv_embed: :unset, isv_registering_for_self_or_tenant: :unset, status_callback_url: :unset, theme_set_id: :unset) ⇒ ComplianceRegistrationInquiriesInstance

Create the ComplianceRegistrationInquiriesInstance

Parameters:

  • end_user_type (EndUserType) (defaults to: nil)
  • phone_number_type (PhoneNumberType) (defaults to: nil)
  • business_identity_type (BusinessIdentityType) (defaults to: :unset)
  • business_registration_authority (BusinessRegistrationAuthority) (defaults to: :unset)
  • business_legal_name (String) (defaults to: :unset)

    he name of the business or organization using the Tollfree number.

  • notification_email (String) (defaults to: :unset)

    he email address to receive the notification about the verification result.

  • accepted_notification_receipt (Boolean) (defaults to: :unset)

    The email address to receive the notification about the verification result.

  • business_registration_number (String) (defaults to: :unset)

    Business registration number of the business

  • business_website_url (String) (defaults to: :unset)

    The URL of the business website

  • friendly_name (String) (defaults to: :unset)

    Friendly name for your business information

  • authorized_representative1_first_name (String) (defaults to: :unset)

    First name of the authorized representative

  • authorized_representative1_last_name (String) (defaults to: :unset)

    Last name of the authorized representative

  • authorized_representative1_phone (String) (defaults to: :unset)

    Phone number of the authorized representative

  • authorized_representative1_email (String) (defaults to: :unset)

    Email address of the authorized representative

  • authorized_representative1_date_of_birth (String) (defaults to: :unset)

    Birthdate of the authorized representative

  • address_street (String) (defaults to: :unset)

    Street address of the business

  • address_street_secondary (String) (defaults to: :unset)

    Street address of the business

  • address_city (String) (defaults to: :unset)

    City of the business

  • address_subdivision (String) (defaults to: :unset)

    State or province of the business

  • address_postal_code (String) (defaults to: :unset)

    Postal code of the business

  • address_country_code (String) (defaults to: :unset)

    Country code of the business

  • emergency_address_street (String) (defaults to: :unset)

    Street address of the business

  • emergency_address_street_secondary (String) (defaults to: :unset)

    Street address of the business

  • emergency_address_city (String) (defaults to: :unset)

    City of the business

  • emergency_address_subdivision (String) (defaults to: :unset)

    State or province of the business

  • emergency_address_postal_code (String) (defaults to: :unset)

    Postal code of the business

  • emergency_address_country_code (String) (defaults to: :unset)

    Country code of the business

  • use_address_as_emergency_address (Boolean) (defaults to: :unset)

    Use the business address as the emergency address

  • file_name (String) (defaults to: :unset)

    The name of the verification document to upload

  • file (String) (defaults to: :unset)

    The verification document to upload

  • first_name (String) (defaults to: :unset)

    The first name of the Individual User.

  • last_name (String) (defaults to: :unset)

    The last name of the Individual User.

  • date_of_birth (String) (defaults to: :unset)

    The date of birth of the Individual User.

  • individual_email (String) (defaults to: :unset)

    The email address of the Individual User.

  • individual_phone (String) (defaults to: :unset)

    The phone number of the Individual User.

  • is_isv_embed (Boolean) (defaults to: :unset)

    Indicates if the inquiry is being started from an ISV embedded component.

  • isv_registering_for_self_or_tenant (String) (defaults to: :unset)

    Indicates if the isv registering for self or tenant.

  • status_callback_url (String) (defaults to: :unset)

    The url we call to inform you of bundle changes.

  • theme_set_id (String) (defaults to: :unset)

    Theme id for styling the inquiry form.

Returns:



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
# File 'lib/twilio-ruby/rest/trusthub/v1/compliance_registration_inquiries.rb', line 76

def create(
    end_user_type: nil, 
    phone_number_type: nil, 
    business_identity_type: :unset, 
    business_registration_authority: :unset, 
    business_legal_name: :unset, 
    notification_email: :unset, 
    accepted_notification_receipt: :unset, 
    business_registration_number: :unset, 
    business_website_url: :unset, 
    friendly_name: :unset, 
    authorized_representative1_first_name: :unset, 
    authorized_representative1_last_name: :unset, 
    authorized_representative1_phone: :unset, 
    authorized_representative1_email: :unset, 
    authorized_representative1_date_of_birth: :unset, 
    address_street: :unset, 
    address_street_secondary: :unset, 
    address_city: :unset, 
    address_subdivision: :unset, 
    address_postal_code: :unset, 
    address_country_code: :unset, 
    emergency_address_street: :unset, 
    emergency_address_street_secondary: :unset, 
    emergency_address_city: :unset, 
    emergency_address_subdivision: :unset, 
    emergency_address_postal_code: :unset, 
    emergency_address_country_code: :unset, 
    use_address_as_emergency_address: :unset, 
    file_name: :unset, 
    file: :unset, 
    first_name: :unset, 
    last_name: :unset, 
    date_of_birth: :unset, 
    individual_email: :unset, 
    individual_phone: :unset, 
    is_isv_embed: :unset, 
    isv_registering_for_self_or_tenant: :unset, 
    status_callback_url: :unset, 
    theme_set_id: :unset
)

    data = Twilio::Values.of({
        'EndUserType' => end_user_type,
        'PhoneNumberType' => phone_number_type,
        'BusinessIdentityType' => business_identity_type,
        'BusinessRegistrationAuthority' => business_registration_authority,
        'BusinessLegalName' => business_legal_name,
        'NotificationEmail' => notification_email,
        'AcceptedNotificationReceipt' => accepted_notification_receipt,
        'BusinessRegistrationNumber' => business_registration_number,
        'BusinessWebsiteUrl' => business_website_url,
        'FriendlyName' => friendly_name,
        'AuthorizedRepresentative1FirstName' => authorized_representative1_first_name,
        'AuthorizedRepresentative1LastName' => authorized_representative1_last_name,
        'AuthorizedRepresentative1Phone' => authorized_representative1_phone,
        'AuthorizedRepresentative1Email' => authorized_representative1_email,
        'AuthorizedRepresentative1DateOfBirth' => authorized_representative1_date_of_birth,
        'AddressStreet' => address_street,
        'AddressStreetSecondary' => address_street_secondary,
        'AddressCity' => address_city,
        'AddressSubdivision' => address_subdivision,
        'AddressPostalCode' => address_postal_code,
        'AddressCountryCode' => address_country_code,
        'EmergencyAddressStreet' => emergency_address_street,
        'EmergencyAddressStreetSecondary' => emergency_address_street_secondary,
        'EmergencyAddressCity' => emergency_address_city,
        'EmergencyAddressSubdivision' => emergency_address_subdivision,
        'EmergencyAddressPostalCode' => emergency_address_postal_code,
        'EmergencyAddressCountryCode' => emergency_address_country_code,
        'UseAddressAsEmergencyAddress' => use_address_as_emergency_address,
        'FileName' => file_name,
        'File' => file,
        'FirstName' => first_name,
        'LastName' => last_name,
        'DateOfBirth' => date_of_birth,
        'IndividualEmail' => individual_email,
        'IndividualPhone' => individual_phone,
        'IsIsvEmbed' => is_isv_embed,
        'IsvRegisteringForSelfOrTenant' => isv_registering_for_self_or_tenant,
        'StatusCallbackUrl' => status_callback_url,
        'ThemeSetId' => theme_set_id,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    ComplianceRegistrationInquiriesInstance.new(
        @version,
        payload,
    )
end

#create_with_metadata(end_user_type: nil, phone_number_type: nil, business_identity_type: :unset, business_registration_authority: :unset, business_legal_name: :unset, notification_email: :unset, accepted_notification_receipt: :unset, business_registration_number: :unset, business_website_url: :unset, friendly_name: :unset, authorized_representative1_first_name: :unset, authorized_representative1_last_name: :unset, authorized_representative1_phone: :unset, authorized_representative1_email: :unset, authorized_representative1_date_of_birth: :unset, address_street: :unset, address_street_secondary: :unset, address_city: :unset, address_subdivision: :unset, address_postal_code: :unset, address_country_code: :unset, emergency_address_street: :unset, emergency_address_street_secondary: :unset, emergency_address_city: :unset, emergency_address_subdivision: :unset, emergency_address_postal_code: :unset, emergency_address_country_code: :unset, use_address_as_emergency_address: :unset, file_name: :unset, file: :unset, first_name: :unset, last_name: :unset, date_of_birth: :unset, individual_email: :unset, individual_phone: :unset, is_isv_embed: :unset, isv_registering_for_self_or_tenant: :unset, status_callback_url: :unset, theme_set_id: :unset) ⇒ ComplianceRegistrationInquiriesInstance

Create the ComplianceRegistrationInquiriesInstanceMetadata

Parameters:

  • end_user_type (EndUserType) (defaults to: nil)
  • phone_number_type (PhoneNumberType) (defaults to: nil)
  • business_identity_type (BusinessIdentityType) (defaults to: :unset)
  • business_registration_authority (BusinessRegistrationAuthority) (defaults to: :unset)
  • business_legal_name (String) (defaults to: :unset)

    he name of the business or organization using the Tollfree number.

  • notification_email (String) (defaults to: :unset)

    he email address to receive the notification about the verification result.

  • accepted_notification_receipt (Boolean) (defaults to: :unset)

    The email address to receive the notification about the verification result.

  • business_registration_number (String) (defaults to: :unset)

    Business registration number of the business

  • business_website_url (String) (defaults to: :unset)

    The URL of the business website

  • friendly_name (String) (defaults to: :unset)

    Friendly name for your business information

  • authorized_representative1_first_name (String) (defaults to: :unset)

    First name of the authorized representative

  • authorized_representative1_last_name (String) (defaults to: :unset)

    Last name of the authorized representative

  • authorized_representative1_phone (String) (defaults to: :unset)

    Phone number of the authorized representative

  • authorized_representative1_email (String) (defaults to: :unset)

    Email address of the authorized representative

  • authorized_representative1_date_of_birth (String) (defaults to: :unset)

    Birthdate of the authorized representative

  • address_street (String) (defaults to: :unset)

    Street address of the business

  • address_street_secondary (String) (defaults to: :unset)

    Street address of the business

  • address_city (String) (defaults to: :unset)

    City of the business

  • address_subdivision (String) (defaults to: :unset)

    State or province of the business

  • address_postal_code (String) (defaults to: :unset)

    Postal code of the business

  • address_country_code (String) (defaults to: :unset)

    Country code of the business

  • emergency_address_street (String) (defaults to: :unset)

    Street address of the business

  • emergency_address_street_secondary (String) (defaults to: :unset)

    Street address of the business

  • emergency_address_city (String) (defaults to: :unset)

    City of the business

  • emergency_address_subdivision (String) (defaults to: :unset)

    State or province of the business

  • emergency_address_postal_code (String) (defaults to: :unset)

    Postal code of the business

  • emergency_address_country_code (String) (defaults to: :unset)

    Country code of the business

  • use_address_as_emergency_address (Boolean) (defaults to: :unset)

    Use the business address as the emergency address

  • file_name (String) (defaults to: :unset)

    The name of the verification document to upload

  • file (String) (defaults to: :unset)

    The verification document to upload

  • first_name (String) (defaults to: :unset)

    The first name of the Individual User.

  • last_name (String) (defaults to: :unset)

    The last name of the Individual User.

  • date_of_birth (String) (defaults to: :unset)

    The date of birth of the Individual User.

  • individual_email (String) (defaults to: :unset)

    The email address of the Individual User.

  • individual_phone (String) (defaults to: :unset)

    The phone number of the Individual User.

  • is_isv_embed (Boolean) (defaults to: :unset)

    Indicates if the inquiry is being started from an ISV embedded component.

  • isv_registering_for_self_or_tenant (String) (defaults to: :unset)

    Indicates if the isv registering for self or tenant.

  • status_callback_url (String) (defaults to: :unset)

    The url we call to inform you of bundle changes.

  • theme_set_id (String) (defaults to: :unset)

    Theme id for styling the inquiry form.

Returns:



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
# File 'lib/twilio-ruby/rest/trusthub/v1/compliance_registration_inquiries.rb', line 215

def (
  end_user_type: nil, 
  phone_number_type: nil, 
  business_identity_type: :unset, 
  business_registration_authority: :unset, 
  business_legal_name: :unset, 
  notification_email: :unset, 
  accepted_notification_receipt: :unset, 
  business_registration_number: :unset, 
  business_website_url: :unset, 
  friendly_name: :unset, 
  authorized_representative1_first_name: :unset, 
  authorized_representative1_last_name: :unset, 
  authorized_representative1_phone: :unset, 
  authorized_representative1_email: :unset, 
  authorized_representative1_date_of_birth: :unset, 
  address_street: :unset, 
  address_street_secondary: :unset, 
  address_city: :unset, 
  address_subdivision: :unset, 
  address_postal_code: :unset, 
  address_country_code: :unset, 
  emergency_address_street: :unset, 
  emergency_address_street_secondary: :unset, 
  emergency_address_city: :unset, 
  emergency_address_subdivision: :unset, 
  emergency_address_postal_code: :unset, 
  emergency_address_country_code: :unset, 
  use_address_as_emergency_address: :unset, 
  file_name: :unset, 
  file: :unset, 
  first_name: :unset, 
  last_name: :unset, 
  date_of_birth: :unset, 
  individual_email: :unset, 
  individual_phone: :unset, 
  is_isv_embed: :unset, 
  isv_registering_for_self_or_tenant: :unset, 
  status_callback_url: :unset, 
  theme_set_id: :unset
)

    data = Twilio::Values.of({
        'EndUserType' => end_user_type,
        'PhoneNumberType' => phone_number_type,
        'BusinessIdentityType' => business_identity_type,
        'BusinessRegistrationAuthority' => business_registration_authority,
        'BusinessLegalName' => business_legal_name,
        'NotificationEmail' => notification_email,
        'AcceptedNotificationReceipt' => accepted_notification_receipt,
        'BusinessRegistrationNumber' => business_registration_number,
        'BusinessWebsiteUrl' => business_website_url,
        'FriendlyName' => friendly_name,
        'AuthorizedRepresentative1FirstName' => authorized_representative1_first_name,
        'AuthorizedRepresentative1LastName' => authorized_representative1_last_name,
        'AuthorizedRepresentative1Phone' => authorized_representative1_phone,
        'AuthorizedRepresentative1Email' => authorized_representative1_email,
        'AuthorizedRepresentative1DateOfBirth' => authorized_representative1_date_of_birth,
        'AddressStreet' => address_street,
        'AddressStreetSecondary' => address_street_secondary,
        'AddressCity' => address_city,
        'AddressSubdivision' => address_subdivision,
        'AddressPostalCode' => address_postal_code,
        'AddressCountryCode' => address_country_code,
        'EmergencyAddressStreet' => emergency_address_street,
        'EmergencyAddressStreetSecondary' => emergency_address_street_secondary,
        'EmergencyAddressCity' => emergency_address_city,
        'EmergencyAddressSubdivision' => emergency_address_subdivision,
        'EmergencyAddressPostalCode' => emergency_address_postal_code,
        'EmergencyAddressCountryCode' => emergency_address_country_code,
        'UseAddressAsEmergencyAddress' => use_address_as_emergency_address,
        'FileName' => file_name,
        'File' => file,
        'FirstName' => first_name,
        'LastName' => last_name,
        'DateOfBirth' => date_of_birth,
        'IndividualEmail' => individual_email,
        'IndividualPhone' => individual_phone,
        'IsIsvEmbed' => is_isv_embed,
        'IsvRegisteringForSelfOrTenant' => isv_registering_for_self_or_tenant,
        'StatusCallbackUrl' => status_callback_url,
        'ThemeSetId' => theme_set_id,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.('POST', @uri, data: data, headers: headers)
    compliance_registration_inquiries_instance = ComplianceRegistrationInquiriesInstance.new(
        @version,
        response.body,
    )
    .new(
        @version,
        compliance_registration_inquiries_instance,
        response.headers,
        response.status_code
    )
end

#to_sObject

Provide a user friendly representation



322
323
324
# File 'lib/twilio-ruby/rest/trusthub/v1/compliance_registration_inquiries.rb', line 322

def to_s
    '#<Twilio.Trusthub.V1.ComplianceRegistrationInquiriesList>'
end