Class: Pingram::TenDlcBrandAdminUpdateRequest

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/pingram/models/ten_dlc_brand_admin_update_request.rb

Overview

Request body for the superadmin-only PATCH /registrations/us/10dlc/brand/admin

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ TenDlcBrandAdminUpdateRequest

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
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
 
# File 'lib/pingram/models/ten_dlc_brand_admin_update_request.rb', line 161

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Pingram::TenDlcBrandAdminUpdateRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Pingram::TenDlcBrandAdminUpdateRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'scenario_id')
    self.scenario_id = attributes[:'scenario_id']
  end

  if attributes.key?(:'business_type')
    self.business_type = attributes[:'business_type']
  end

  if attributes.key?(:'legal_name')
    self.legal_name = attributes[:'legal_name']
  end

  if attributes.key?(:'display_name')
    self.display_name = attributes[:'display_name']
  end

  if attributes.key?(:'first_name')
    self.first_name = attributes[:'first_name']
  end

  if attributes.key?(:'last_name')
    self.last_name = attributes[:'last_name']
  end

  if attributes.key?(:'tax_id')
    self.tax_id = attributes[:'tax_id']
  end

  if attributes.key?(:'website')
    self.website = attributes[:'website']
  end

  if attributes.key?(:'country')
    self.country = attributes[:'country']
  end

  if attributes.key?(:'street')
    self.street = attributes[:'street']
  end

  if attributes.key?(:'city')
    self.city = attributes[:'city']
  end

  if attributes.key?(:'state')
    self.state = attributes[:'state']
  end

  if attributes.key?(:'postal_code')
    self.postal_code = attributes[:'postal_code']
  end

  if attributes.key?(:'compliance_contact_email')
    self.compliance_contact_email = attributes[:'compliance_contact_email']
  end

  if attributes.key?(:'compliance_contact_phone')
    self.compliance_contact_phone = attributes[:'compliance_contact_phone']
  end

  if attributes.key?(:'vertical')
    self.vertical = attributes[:'vertical']
  end

  if attributes.key?(:'entity_type')
    self.entity_type = attributes[:'entity_type']
  end

  if attributes.key?(:'brand_status')
    self.brand_status = attributes[:'brand_status']
  end
end

Instance Attribute Details

#brand_status ⇒ Object

Pingram-side 10DLC registration workflow status (brand or campaign). - not_started: no customer submission yet - pending_review: customer submitted; Pingram has not submitted to carriers - in_progress: submitted for carrier review - approved | rejected | info_needed: review outcome



71
72
73
 
# File 'lib/pingram/models/ten_dlc_brand_admin_update_request.rb', line 71

def brand_status
  @brand_status
end

#business_type ⇒ Object

Legal entity type for a 10DLC brand. - PRIVATE_PROFIT: private for-profit (LLC, corp, etc.) - SOLE_PROPRIETOR: sole proprietorship - PUBLIC_PROFIT: publicly traded for-profit - NON_PROFIT: non-profit - GOVERNMENT: government



23
24
25
 
# File 'lib/pingram/models/ten_dlc_brand_admin_update_request.rb', line 23

def business_type
  @business_type
end

#city ⇒ Object

City that matches official tax registration.



50
51
52
 
# File 'lib/pingram/models/ten_dlc_brand_admin_update_request.rb', line 50

def city
  @city
end

#compliance_contact_email ⇒ Object

Email for the 10DLC compliance contact. Used for carrier and registration follow-up.



59
60
61
 
# File 'lib/pingram/models/ten_dlc_brand_admin_update_request.rb', line 59

def compliance_contact_email
  @compliance_contact_email
end

#compliance_contact_phone ⇒ Object

Phone number for the 10DLC compliance contact. E.164 preferred; national numbers are normalized using country.



62
63
64
 
# File 'lib/pingram/models/ten_dlc_brand_admin_update_request.rb', line 62

def compliance_contact_phone
  @compliance_contact_phone
end

#country ⇒ Object

ISO 3166-1 alpha-2 country of incorporation (for example US or CA).



44
45
46
 
# File 'lib/pingram/models/ten_dlc_brand_admin_update_request.rb', line 44

def country
  @country
end

#display_name ⇒ Object

Public brand name shown to recipients and carriers. Use the name customers recognize (your DBA or trade name). For SOLE_PROPRIETOR, this is the brand you send as — not the individual's legal name. Omit to keep the existing value. If you change legalName and omit displayName, displayName is reset to the new legalName.



29
30
31
 
# File 'lib/pingram/models/ten_dlc_brand_admin_update_request.rb', line 29

def display_name
  @display_name
end

#entity_type ⇒ Object

Legacy only when businessType is Other.



68
69
70
 
# File 'lib/pingram/models/ten_dlc_brand_admin_update_request.rb', line 68

def entity_type
  @entity_type
end

#first_name ⇒ Object

Legal first name of the sole proprietor. Required when businessType is SOLE_PROPRIETOR.



32
33
34
 
# File 'lib/pingram/models/ten_dlc_brand_admin_update_request.rb', line 32

def first_name
  @first_name
end

#last_name ⇒ Object

Legal last name of the sole proprietor. Required when businessType is SOLE_PROPRIETOR.



35
36
37
 
# File 'lib/pingram/models/ten_dlc_brand_admin_update_request.rb', line 35

def last_name
  @last_name
end

#legal_name ⇒ Object

Official registered legal business name. For SOLE_PROPRIETOR, optional DBA or trade name (defaults to firstName and lastName).



26
27
28
 
# File 'lib/pingram/models/ten_dlc_brand_admin_update_request.rb', line 26

def legal_name
  @legal_name
end

#postal_code ⇒ Object

ZIP code (US) or postal code (CA) that matches official tax registration.



56
57
58
 
# File 'lib/pingram/models/ten_dlc_brand_admin_update_request.rb', line 56

def postal_code
  @postal_code
end

#scenario_id ⇒ Object

Who the 10DLC brand is registered for. - own_brand: personal or company project - client_brand: agency or contractor



20
21
22
 
# File 'lib/pingram/models/ten_dlc_brand_admin_update_request.rb', line 20

def scenario_id
  @scenario_id
end

#state ⇒ Object

State (US) or province (CA) that matches official tax registration.



53
54
55
 
# File 'lib/pingram/models/ten_dlc_brand_admin_update_request.rb', line 53

def state
  @state
end

#street ⇒ Object

Street address that matches official tax registration.



47
48
49
 
# File 'lib/pingram/models/ten_dlc_brand_admin_update_request.rb', line 47

def street
  @street
end

#tax_id ⇒ Object

For US companies (country US): 9-digit EIN (Employer Identification Number). For Canada (country CA): 9-digit BN (Business Number). For other countries: national business tax identifier. Required except when businessType is SOLE_PROPRIETOR.



38
39
40
 
# File 'lib/pingram/models/ten_dlc_brand_admin_update_request.rb', line 38

def tax_id
  @tax_id
end

#vertical ⇒ Object

Industry vertical required before Pingram submits the brand to carriers.



65
66
67
 
# File 'lib/pingram/models/ten_dlc_brand_admin_update_request.rb', line 65

def vertical
  @vertical
end

#website ⇒ Object

Public website for the brand. Include a scheme (https://) or a domain; https:// is prepended when omitted. Carriers expect a working site with privacy policy and terms.



41
42
43
 
# File 'lib/pingram/models/ten_dlc_brand_admin_update_request.rb', line 41

def website
  @website
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



120
121
122
 
# File 'lib/pingram/models/ten_dlc_brand_admin_update_request.rb', line 120

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



125
126
127
 
# File 'lib/pingram/models/ten_dlc_brand_admin_update_request.rb', line 125

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/pingram/models/ten_dlc_brand_admin_update_request.rb', line 96

def self.attribute_map
  {
    :'scenario_id' => :'scenarioId',
    :'business_type' => :'businessType',
    :'legal_name' => :'legalName',
    :'display_name' => :'displayName',
    :'first_name' => :'firstName',
    :'last_name' => :'lastName',
    :'tax_id' => :'taxId',
    :'website' => :'website',
    :'country' => :'country',
    :'street' => :'street',
    :'city' => :'city',
    :'state' => :'state',
    :'postal_code' => :'postalCode',
    :'compliance_contact_email' => :'complianceContactEmail',
    :'compliance_contact_phone' => :'complianceContactPhone',
    :'vertical' => :'vertical',
    :'entity_type' => :'entityType',
    :'brand_status' => :'brandStatus'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/pingram/models/ten_dlc_brand_admin_update_request.rb', line 351

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



154
155
156
157
 
# File 'lib/pingram/models/ten_dlc_brand_admin_update_request.rb', line 154

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/pingram/models/ten_dlc_brand_admin_update_request.rb', line 130

def self.openapi_types
  {
    :'scenario_id' => :'String',
    :'business_type' => :'String',
    :'legal_name' => :'String',
    :'display_name' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'tax_id' => :'String',
    :'website' => :'String',
    :'country' => :'String',
    :'street' => :'String',
    :'city' => :'String',
    :'state' => :'String',
    :'postal_code' => :'String',
    :'compliance_contact_email' => :'String',
    :'compliance_contact_phone' => :'String',
    :'vertical' => :'String',
    :'entity_type' => :'String',
    :'brand_status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/pingram/models/ten_dlc_brand_admin_update_request.rb', line 313

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      scenario_id == o.scenario_id &&
      business_type == o.business_type &&
      legal_name == o.legal_name &&
      display_name == o.display_name &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      tax_id == o.tax_id &&
      website == o.website &&
      country == o.country &&
      street == o.street &&
      city == o.city &&
      state == o.state &&
      postal_code == o.postal_code &&
      compliance_contact_email == o.compliance_contact_email &&
      compliance_contact_phone == o.compliance_contact_phone &&
      vertical == o.vertical &&
      entity_type == o.entity_type &&
      brand_status == o.brand_status
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


338
339
340
 
# File 'lib/pingram/models/ten_dlc_brand_admin_update_request.rb', line 338

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



344
345
346
 
# File 'lib/pingram/models/ten_dlc_brand_admin_update_request.rb', line 344

def hash
  [scenario_id, business_type, legal_name, display_name, first_name, last_name, tax_id, website, country, street, city, state, postal_code, compliance_contact_email, compliance_contact_phone, vertical, entity_type, brand_status].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



250
251
252
253
254
 
# File 'lib/pingram/models/ten_dlc_brand_admin_update_request.rb', line 250

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/pingram/models/ten_dlc_brand_admin_update_request.rb', line 373

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/pingram/models/ten_dlc_brand_admin_update_request.rb', line 258

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  scenario_id_validator = EnumAttributeValidator.new('String', ["own_brand", "client_brand"])
  return false unless scenario_id_validator.valid?(@scenario_id)
  business_type_validator = EnumAttributeValidator.new('String', ["PRIVATE_PROFIT", "SOLE_PROPRIETOR", "PUBLIC_PROFIT", "NON_PROFIT", "GOVERNMENT"])
  return false unless business_type_validator.valid?(@business_type)
  vertical_validator = EnumAttributeValidator.new('String', ["AGRICULTURE", "COMMUNICATION", "CONSTRUCTION", "EDUCATION", "ENERGY", "ENTERTAINMENT", "FINANCIAL", "GAMBLING", "GOVERNMENT", "HEALTHCARE", "HOSPITALITY", "HUMAN_RESOURCES", "INSURANCE", "LEGAL", "MANUFACTURING", "NGO", "POLITICAL", "POSTAL", "PROFESSIONAL", "REAL_ESTATE", "RETAIL", "TECHNOLOGY", "TRANSPORTATION"])
  return false unless vertical_validator.valid?(@vertical)
  brand_status_validator = EnumAttributeValidator.new('String', ["not_started", "in_progress", "pending_review", "approved", "rejected", "info_needed"])
  return false unless brand_status_validator.valid?(@brand_status)
  true
end