Class: DocuSign_eSign::NewAccountDefinition

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/models/new_account_definition.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NewAccountDefinition

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/docusign_esign/models/new_account_definition.rb', line 120

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'accountName')
    self. = attributes[:'accountName']
  end

  if attributes.has_key?(:'accountSettings')
    self. = attributes[:'accountSettings']
  end

  if attributes.has_key?(:'addressInformation')
    self.address_information = attributes[:'addressInformation']
  end

  if attributes.has_key?(:'creditCardInformation')
    self.credit_card_information = attributes[:'creditCardInformation']
  end

  if attributes.has_key?(:'directDebitProcessorInformation')
    self.direct_debit_processor_information = attributes[:'directDebitProcessorInformation']
  end

  if attributes.has_key?(:'distributorCode')
    self.distributor_code = attributes[:'distributorCode']
  end

  if attributes.has_key?(:'distributorPassword')
    self.distributor_password = attributes[:'distributorPassword']
  end

  if attributes.has_key?(:'enablePreAuth')
    self.enable_pre_auth = attributes[:'enablePreAuth']
  end

  if attributes.has_key?(:'envelopePartitionId')
    self.envelope_partition_id = attributes[:'envelopePartitionId']
  end

  if attributes.has_key?(:'initialUser')
    self.initial_user = attributes[:'initialUser']
  end

  if attributes.has_key?(:'paymentMethod')
    self.payment_method = attributes[:'paymentMethod']
  end

  if attributes.has_key?(:'paymentProcessor')
    self.payment_processor = attributes[:'paymentProcessor']
  end

  if attributes.has_key?(:'paymentProcessorInformation')
    self.payment_processor_information = attributes[:'paymentProcessorInformation']
  end

  if attributes.has_key?(:'planInformation')
    self.plan_information = attributes[:'planInformation']
  end

  if attributes.has_key?(:'processPayment')
    self.process_payment = attributes[:'processPayment']
  end

  if attributes.has_key?(:'referralInformation')
    self.referral_information = attributes[:'referralInformation']
  end

  if attributes.has_key?(:'socialAccountInformation')
    self. = attributes[:'socialAccountInformation']
  end

  if attributes.has_key?(:'taxExemptId')
    self.tax_exempt_id = attributes[:'taxExemptId']
  end
end

Instance Attribute Details

#account_name ⇒ Object

The account name for the new account.



17
18
19
 
# File 'lib/docusign_esign/models/new_account_definition.rb', line 17

def 
  @account_name
end

#account_settings ⇒ Object

The list of account settings. These determine the features available for the account. Note that some features are determined by the plan used to create the account, and cannot be overridden.



20
21
22
 
# File 'lib/docusign_esign/models/new_account_definition.rb', line 20

def 
  @account_settings
end

#address_information ⇒ Object

A complex type that contains the following information for the new account: ‘Street1`, `Street2`, `City`, `State`, `Zip`, `Phone`, and `Fax`.



23
24
25
 
# File 'lib/docusign_esign/models/new_account_definition.rb', line 23

def address_information
  @address_information
end

#credit_card_information ⇒ Object

A complex type that has information about the credit card used to pay for this account.



26
27
28
 
# File 'lib/docusign_esign/models/new_account_definition.rb', line 26

def credit_card_information
  @credit_card_information
end

#direct_debit_processor_information ⇒ Object

Information about the bank that processes direct debits for the payment plan.



29
30
31
 
# File 'lib/docusign_esign/models/new_account_definition.rb', line 29

def direct_debit_processor_information
  @direct_debit_processor_information
end

#distributor_code ⇒ Object

The code that identifies the billing plan groups and plans for the new account.



32
33
34
 
# File 'lib/docusign_esign/models/new_account_definition.rb', line 32

def distributor_code
  @distributor_code
end

#distributor_password ⇒ Object

The password for the distributorCode.



35
36
37
 
# File 'lib/docusign_esign/models/new_account_definition.rb', line 35

def distributor_password
  @distributor_password
end

#enable_pre_auth ⇒ Object

Returns the value of attribute enable_pre_auth.



38
39
40
 
# File 'lib/docusign_esign/models/new_account_definition.rb', line 38

def enable_pre_auth
  @enable_pre_auth
end

#envelope_partition_id ⇒ Object

Returns the value of attribute envelope_partition_id.



41
42
43
 
# File 'lib/docusign_esign/models/new_account_definition.rb', line 41

def envelope_partition_id
  @envelope_partition_id
end

#initial_user ⇒ Object

A complex type with the initial user information for the new account. Note that some user information is set internally based on the plan and cannot be overridden.



44
45
46
 
# File 'lib/docusign_esign/models/new_account_definition.rb', line 44

def initial_user
  @initial_user
end

#payment_method ⇒ Object

Returns the value of attribute payment_method.



47
48
49
 
# File 'lib/docusign_esign/models/new_account_definition.rb', line 47

def payment_method
  @payment_method
end

#payment_processor ⇒ Object

Returns the value of attribute payment_processor.



50
51
52
 
# File 'lib/docusign_esign/models/new_account_definition.rb', line 50

def payment_processor
  @payment_processor
end

#payment_processor_information ⇒ Object

Information about the entity that processes payments for the billing plan.



53
54
55
 
# File 'lib/docusign_esign/models/new_account_definition.rb', line 53

def payment_processor_information
  @payment_processor_information
end

#plan_information ⇒ Object

An object used to identify the features and attributes of the account being created.



56
57
58
 
# File 'lib/docusign_esign/models/new_account_definition.rb', line 56

def plan_information
  @plan_information
end

#process_payment ⇒ Object

Returns the value of attribute process_payment.



59
60
61
 
# File 'lib/docusign_esign/models/new_account_definition.rb', line 59

def process_payment
  @process_payment
end

#referral_information ⇒ Object

A complex type that contains properties for entering referral and discount information.



62
63
64
 
# File 'lib/docusign_esign/models/new_account_definition.rb', line 62

def referral_information
  @referral_information
end

#social_account_information ⇒ Object

Contains properties that map a DocuSign user to a social account (Facebook, Yahoo, etc.)



65
66
67
 
# File 'lib/docusign_esign/models/new_account_definition.rb', line 65

def 
  @social_account_information
end

#tax_exempt_id ⇒ Object

Returns the value of attribute tax_exempt_id.



68
69
70
 
# File 'lib/docusign_esign/models/new_account_definition.rb', line 68

def tax_exempt_id
  @tax_exempt_id
end

Class Method Details

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/docusign_esign/models/new_account_definition.rb', line 71

def self.attribute_map
  {
    :'account_name' => :'accountName',
    :'account_settings' => :'accountSettings',
    :'address_information' => :'addressInformation',
    :'credit_card_information' => :'creditCardInformation',
    :'direct_debit_processor_information' => :'directDebitProcessorInformation',
    :'distributor_code' => :'distributorCode',
    :'distributor_password' => :'distributorPassword',
    :'enable_pre_auth' => :'enablePreAuth',
    :'envelope_partition_id' => :'envelopePartitionId',
    :'initial_user' => :'initialUser',
    :'payment_method' => :'paymentMethod',
    :'payment_processor' => :'paymentProcessor',
    :'payment_processor_information' => :'paymentProcessorInformation',
    :'plan_information' => :'planInformation',
    :'process_payment' => :'processPayment',
    :'referral_information' => :'referralInformation',
    :'social_account_information' => :'socialAccountInformation',
    :'tax_exempt_id' => :'taxExemptId'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'account_name' => :'String',
    :'account_settings' => :'AccountSettingsInformation',
    :'address_information' => :'AccountAddress',
    :'credit_card_information' => :'CreditCardInformation',
    :'direct_debit_processor_information' => :'DirectDebitProcessorInformation',
    :'distributor_code' => :'String',
    :'distributor_password' => :'String',
    :'enable_pre_auth' => :'String',
    :'envelope_partition_id' => :'String',
    :'initial_user' => :'UserInformation',
    :'payment_method' => :'String',
    :'payment_processor' => :'String',
    :'payment_processor_information' => :'PaymentProcessorInformation',
    :'plan_information' => :'PlanInformation',
    :'process_payment' => :'String',
    :'referral_information' => :'ReferralInformation',
    :'social_account_information' => :'SocialAccountInformation',
    :'tax_exempt_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/docusign_esign/models/new_account_definition.rb', line 214

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
       == o. &&
      address_information == o.address_information &&
      credit_card_information == o.credit_card_information &&
      direct_debit_processor_information == o.direct_debit_processor_information &&
      distributor_code == o.distributor_code &&
      distributor_password == o.distributor_password &&
      enable_pre_auth == o.enable_pre_auth &&
      envelope_partition_id == o.envelope_partition_id &&
      initial_user == o.initial_user &&
      payment_method == o.payment_method &&
      payment_processor == o.payment_processor &&
      payment_processor_information == o.payment_processor_information &&
      plan_information == o.plan_information &&
      process_payment == o.process_payment &&
      referral_information == o.referral_information &&
       == o. &&
      tax_exempt_id == o.tax_exempt_id
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



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
 
# File 'lib/docusign_esign/models/new_account_definition.rb', line 273

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = DocuSign_eSign.const_get(type).new
    temp_model.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



339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/docusign_esign/models/new_account_definition.rb', line 339

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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/docusign_esign/models/new_account_definition.rb', line 252

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


239
240
241
 
# File 'lib/docusign_esign/models/new_account_definition.rb', line 239

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



245
246
247
 
# File 'lib/docusign_esign/models/new_account_definition.rb', line 245

def hash
  [, , address_information, credit_card_information, direct_debit_processor_information, distributor_code, distributor_password, enable_pre_auth, envelope_partition_id, initial_user, payment_method, payment_processor, payment_processor_information, plan_information, process_payment, referral_information, , tax_exempt_id].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



201
202
203
204
 
# File 'lib/docusign_esign/models/new_account_definition.rb', line 201

def list_invalid_properties
  invalid_properties = Array.new
  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



319
320
321
 
# File 'lib/docusign_esign/models/new_account_definition.rb', line 319

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



325
326
327
328
329
330
331
332
333
 
# File 'lib/docusign_esign/models/new_account_definition.rb', line 325

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



313
314
315
 
# File 'lib/docusign_esign/models/new_account_definition.rb', line 313

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



208
209
210
 
# File 'lib/docusign_esign/models/new_account_definition.rb', line 208

def valid?
  true
end