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


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

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

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

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

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

Instance Attribute Details

#account_nameObject

The account name for the new account.


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

def 
  @account_name
end

#account_settingsObject

Returns the value of attribute account_settings


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

def 
  @account_settings
end

#address_informationObject

Returns the value of attribute address_information


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

def address_information
  @address_information
end

#credit_card_informationObject

Returns the value of attribute credit_card_information


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

def credit_card_information
  @credit_card_information
end

#direct_debit_processor_informationObject

Returns the value of attribute direct_debit_processor_information


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

def direct_debit_processor_information
  @direct_debit_processor_information
end

#distributor_codeObject

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


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

def distributor_code
  @distributor_code
end

#distributor_passwordObject

The password for the distributorCode.


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

def distributor_password
  @distributor_password
end

#envelope_partition_idObject

Returns the value of attribute envelope_partition_id


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

def envelope_partition_id
  @envelope_partition_id
end

#initial_userObject

Returns the value of attribute initial_user


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

def initial_user
  @initial_user
end

#payment_methodObject

Returns the value of attribute payment_method


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

def payment_method
  @payment_method
end

#payment_processor_informationObject

Returns the value of attribute payment_processor_information


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

def payment_processor_information
  @payment_processor_information
end

#plan_informationObject

Returns the value of attribute plan_information


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

def plan_information
  @plan_information
end

#referral_informationObject

Returns the value of attribute referral_information


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

def referral_information
  @referral_information
end

#social_account_informationObject

Returns the value of attribute social_account_information


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

def 
  @social_account_information
end

Class Method Details

.attribute_mapObject

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


51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# File 'lib/docusign_esign/models/new_account_definition.rb', line 51

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',
    :'envelope_partition_id' => :'envelopePartitionId',
    :'initial_user' => :'initialUser',
    :'payment_method' => :'paymentMethod',
    :'payment_processor_information' => :'paymentProcessorInformation',
    :'plan_information' => :'planInformation',
    :'referral_information' => :'referralInformation',
    :'social_account_information' => :'socialAccountInformation'
  }
end

.swagger_typesObject

Attribute type mapping.


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

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',
    :'envelope_partition_id' => :'String',
    :'initial_user' => :'UserInformation',
    :'payment_method' => :'String',
    :'payment_processor_information' => :'PaymentProcessorInformation',
    :'plan_information' => :'PlanInformation',
    :'referral_information' => :'ReferralInformation',
    :'social_account_information' => :'SocialAccountInformation'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
# File 'lib/docusign_esign/models/new_account_definition.rb', line 170

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 &&
      envelope_partition_id == o.envelope_partition_id &&
      initial_user == o.initial_user &&
      payment_method == o.payment_method &&
      payment_processor_information == o.payment_processor_information &&
      plan_information == o.plan_information &&
      referral_information == o.referral_information &&
       == o.
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


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

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


291
292
293
294
295
296
297
298
299
300
301
302
303
# File 'lib/docusign_esign/models/new_account_definition.rb', line 291

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


204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
# File 'lib/docusign_esign/models/new_account_definition.rb', line 204

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

191
192
193
# File 'lib/docusign_esign/models/new_account_definition.rb', line 191

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


197
198
199
# File 'lib/docusign_esign/models/new_account_definition.rb', line 197

def hash
  [, , address_information, credit_card_information, direct_debit_processor_information, distributor_code, distributor_password, envelope_partition_id, initial_user, payment_method, payment_processor_information, plan_information, referral_information, ].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


157
158
159
160
# File 'lib/docusign_esign/models/new_account_definition.rb', line 157

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


271
272
273
# File 'lib/docusign_esign/models/new_account_definition.rb', line 271

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


277
278
279
280
281
282
283
284
285
# File 'lib/docusign_esign/models/new_account_definition.rb', line 277

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


265
266
267
# File 'lib/docusign_esign/models/new_account_definition.rb', line 265

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


164
165
166
# File 'lib/docusign_esign/models/new_account_definition.rb', line 164

def valid?
  true
end