Class: Plaid::PartnerCustomerCreateRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/plaid/models/partner_customer_create_request.rb

Overview

Request schema for ‘/partner/customer/create`.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PartnerCustomerCreateRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 129

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

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

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

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

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

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

  if attributes.key?(:'products')
    if (value = attributes[:'products']).is_a?(Array)
      self.products = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'redirect_uris')
    if (value = attributes[:'redirect_uris']).is_a?(Array)
      self.redirect_uris = value
    end
  end

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

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



55
56
57
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 55

def address
  @address
end

#application_name ⇒ Object

The name of the end customer’s application. This will be shown to end users when they go through the Plaid Link flow. The application name must be unique and cannot match the name of another application already registered with Plaid.



47
48
49
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 47

def application_name
  @application_name
end

#assets_under_management ⇒ Object

Returns the value of attribute assets_under_management.



60
61
62
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 60

def assets_under_management
  @assets_under_management
end

#billing_contact ⇒ Object

Returns the value of attribute billing_contact.



51
52
53
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 51

def billing_contact
  @billing_contact
end

#client_id ⇒ Object

Your Plaid API ‘client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.



20
21
22
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 20

def client_id
  @client_id
end

#company_name ⇒ Object

The company name of the end customer being created. This will be used to display the end customer in the Plaid Dashboard. It will not be shown to end users.



26
27
28
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 26

def company_name
  @company_name
end

#create_link_customization ⇒ Object

If ‘true`, the end customer’s default Link customization will be set to match the partner’s. You can always change the end customer’s Link customization in the Plaid Dashboard. See the [Link Customization docs](plaid.com/docs/link/customization/) for more information. If you require the ability to programmatically create end customers using multiple different Link customization profiles, contact your Plaid Account Manager for assistance. Important: Data Transparency Messaging (DTM) use cases will not be copied to the end customer’s Link customization unless the **Publish changes** button is clicked after the use cases are applied. Link will not work in Production unless the end customer’s DTM use cases are configured. For more details, see [Data Transparency Messaging](plaid.com/docs/link/data-transparency-messaging-migration-guide/).



35
36
37
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 35

def create_link_customization
  @create_link_customization
end

#customer_support_info ⇒ Object

Returns the value of attribute customer_support_info.



53
54
55
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 53

def customer_support_info
  @customer_support_info
end

#is_bank_addendum_completed ⇒ Object

Denotes whether the partner has forwarded the Plaid bank addendum to the end customer.



58
59
60
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 58

def is_bank_addendum_completed
  @is_bank_addendum_completed
end

#is_diligence_attested ⇒ Object

Denotes whether or not the partner has completed attestation of diligence for the end customer to be created.



29
30
31
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 29

def is_diligence_attested
  @is_diligence_attested
end

#legal_entity_name ⇒ Object

The end customer’s legal name. This will be shared with financial institutions as part of the OAuth registration process. It will not be shown to end users.



41
42
43
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 41

def legal_entity_name
  @legal_entity_name
end

#logo ⇒ Object

Base64-encoded representation of the end customer’s logo. Must be a PNG of size 1024x1024 under 4MB. The logo will be shared with financial institutions and shown to the end user during Link flows. A logo is required if ‘create_link_customization` is `true`. If `create_link_customization` is `false` and the logo is omitted, the partner’s logo will be used if one exists, otherwise a stock logo will be used.



38
39
40
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 38

def 
  
end

#products ⇒ Object

The products to be enabled for the end customer. If empty or ‘null`, this field will default to the products enabled for the reseller at the time this endpoint is called.



32
33
34
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 32

def products
  @products
end

#redirect_uris ⇒ Object

A list of URIs indicating the destination(s) where a user can be forwarded after completing the Link flow; used to support OAuth authentication flows when launching Link in the browser or another app. URIs should not contain any query parameters. When used in Production, URIs must use https. To specify any subdomain, use ‘*` as a wildcard character, e.g. `*.example.com/oauth.html`. To modify redirect URIs for an end customer after creating them, go to the end customer’s [API page](dashboard.plaid.com/team/api) in the Dashboard.



63
64
65
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 63

def redirect_uris
  @redirect_uris
end

#registration_number ⇒ Object

The unique identifier assigned to a financial institution by regulatory authorities, if applicable. For banks, this is the FDIC Certificate Number. For credit unions, this is the Credit Union Charter Number.



66
67
68
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 66

def registration_number
  @registration_number
end

#secret ⇒ Object

Your Plaid API ‘secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.



23
24
25
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 23

def secret
  @secret
end

#technical_contact ⇒ Object

Returns the value of attribute technical_contact.



49
50
51
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 49

def technical_contact
  @technical_contact
end

#website ⇒ Object

The end customer’s website.



44
45
46
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 44

def website
  @website
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



93
94
95
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 93

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 69

def self.attribute_map
  {
    :'client_id' => :'client_id',
    :'secret' => :'secret',
    :'company_name' => :'company_name',
    :'is_diligence_attested' => :'is_diligence_attested',
    :'products' => :'products',
    :'create_link_customization' => :'create_link_customization',
    :'logo' => :'logo',
    :'legal_entity_name' => :'legal_entity_name',
    :'website' => :'website',
    :'application_name' => :'application_name',
    :'technical_contact' => :'technical_contact',
    :'billing_contact' => :'billing_contact',
    :'customer_support_info' => :'customer_support_info',
    :'address' => :'address',
    :'is_bank_addendum_completed' => :'is_bank_addendum_completed',
    :'assets_under_management' => :'assets_under_management',
    :'redirect_uris' => :'redirect_uris',
    :'registration_number' => :'registration_number'
  }
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



307
308
309
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 307

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



122
123
124
125
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 122

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

.openapi_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 98

def self.openapi_types
  {
    :'client_id' => :'String',
    :'secret' => :'String',
    :'company_name' => :'String',
    :'is_diligence_attested' => :'Boolean',
    :'products' => :'Array<Products>',
    :'create_link_customization' => :'Boolean',
    :'logo' => :'String',
    :'legal_entity_name' => :'String',
    :'website' => :'String',
    :'application_name' => :'String',
    :'technical_contact' => :'PartnerEndCustomerTechnicalContact',
    :'billing_contact' => :'PartnerEndCustomerBillingContact',
    :'customer_support_info' => :'PartnerEndCustomerCustomerSupportInfo',
    :'address' => :'PartnerEndCustomerAddress',
    :'is_bank_addendum_completed' => :'Boolean',
    :'assets_under_management' => :'PartnerEndCustomerAssetsUnderManagement',
    :'redirect_uris' => :'Array<String>',
    :'registration_number' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 269

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_id == o.client_id &&
      secret == o.secret &&
      company_name == o.company_name &&
      is_diligence_attested == o.is_diligence_attested &&
      products == o.products &&
      create_link_customization == o.create_link_customization &&
       == o. &&
      legal_entity_name == o.legal_entity_name &&
      website == o.website &&
      application_name == o.application_name &&
      technical_contact == o.technical_contact &&
      billing_contact == o.billing_contact &&
      customer_support_info == o.customer_support_info &&
      address == o.address &&
      is_bank_addendum_completed == o.is_bank_addendum_completed &&
      assets_under_management == o.assets_under_management &&
      redirect_uris == o.redirect_uris &&
      registration_number == o.registration_number
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 338

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Plaid.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 409

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
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



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

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


294
295
296
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 294

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



300
301
302
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 300

def hash
  [client_id, secret, company_name, is_diligence_attested, products, create_link_customization, , legal_entity_name, website, application_name, technical_contact, billing_contact, customer_support_info, address, is_bank_addendum_completed, assets_under_management, redirect_uris, registration_number].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



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
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 221

def list_invalid_properties
  invalid_properties = Array.new
  if @company_name.nil?
    invalid_properties.push('invalid value for "company_name", company_name cannot be nil.')
  end

  if @is_diligence_attested.nil?
    invalid_properties.push('invalid value for "is_diligence_attested", is_diligence_attested cannot be nil.')
  end

  if @legal_entity_name.nil?
    invalid_properties.push('invalid value for "legal_entity_name", legal_entity_name cannot be nil.')
  end

  if @website.nil?
    invalid_properties.push('invalid value for "website", website cannot be nil.')
  end

  if @application_name.nil?
    invalid_properties.push('invalid value for "application_name", application_name cannot be nil.')
  end

  if @address.nil?
    invalid_properties.push('invalid value for "address", address cannot be nil.')
  end

  if @is_bank_addendum_completed.nil?
    invalid_properties.push('invalid value for "is_bank_addendum_completed", is_bank_addendum_completed cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



385
386
387
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 385

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 391

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



379
380
381
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 379

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



256
257
258
259
260
261
262
263
264
265
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 256

def valid?
  return false if @company_name.nil?
  return false if @is_diligence_attested.nil?
  return false if @legal_entity_name.nil?
  return false if @website.nil?
  return false if @application_name.nil?
  return false if @address.nil?
  return false if @is_bank_addendum_completed.nil?
  true
end