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



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
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 111

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?(:'address')
    self.address = attributes[:'address']
  end

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

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



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

def address
  @address
end

#application_name ⇒ Object

The name of the end customer’s application.



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

def application_name
  @application_name
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.



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.



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

def create_link_customization
  @create_link_customization
end

#is_bank_addendum_completed ⇒ Object

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



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

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.



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. Defaults to the partner’s logo if omitted.



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

def 
  @logo
end

#products ⇒ Object

The products to be enabled for the end customer.



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

def products
  @products
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



79
80
81
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 79

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 59

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',
    :'address' => :'address',
    :'is_bank_addendum_completed' => :'is_bank_addendum_completed'
  }
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



272
273
274
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 272

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



104
105
106
107
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 104

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

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 84

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',
    :'address' => :'PartnerEndCustomerAddress',
    :'is_bank_addendum_completed' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 238

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 &&
      address == o.address &&
      is_bank_addendum_completed == o.is_bank_addendum_completed
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



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 302

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



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

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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 279

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  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


259
260
261
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 259

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



265
266
267
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 265

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



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

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 @products.nil?
    invalid_properties.push('invalid value for "products", products 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



349
350
351
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 349

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



355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 355

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



343
344
345
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 343

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



224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/plaid/models/partner_customer_create_request.rb', line 224

def valid?
  return false if @company_name.nil?
  return false if @is_diligence_attested.nil?
  return false if @products.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