Class: DocuSign_eSign::LinkedExternalPrimaryAccount

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LinkedExternalPrimaryAccount

Initializes the object



90
91
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
 
# File 'lib/docusign_esign/models/linked_external_primary_account.rb', line 90

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_name ⇒ Object

Returns the value of attribute account_name.



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

def 
  @account_name
end

#configuration_id ⇒ Object

Returns the value of attribute configuration_id.



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

def configuration_id
  @configuration_id
end

#email ⇒ Object

Returns the value of attribute email.



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

def email
  @email
end

#exempt_members_of_same_account_from_auth ⇒ Object

Returns the value of attribute exempt_members_of_same_account_from_auth.



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

def 
  @exempt_members_of_same_account_from_auth
end

#link_id ⇒ Object

Returns the value of attribute link_id.



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

def link_id
  @link_id
end

#pdf_field_handling_option ⇒ Object

Returns the value of attribute pdf_field_handling_option.



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

def pdf_field_handling_option
  @pdf_field_handling_option
end

#pdf_field_handling_prefill_tab_permission ⇒ Object

Returns the value of attribute pdf_field_handling_prefill_tab_permission.



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

def pdf_field_handling_prefill_tab_permission
  @pdf_field_handling_prefill_tab_permission
end

#pdf_field_handling_standard_input_tab_permission ⇒ Object

Returns the value of attribute pdf_field_handling_standard_input_tab_permission.



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

def pdf_field_handling_standard_input_tab_permission
  @pdf_field_handling_standard_input_tab_permission
end

#pdf_field_handling_standard_tab_permission ⇒ Object

Returns the value of attribute pdf_field_handling_standard_tab_permission.



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

def pdf_field_handling_standard_tab_permission
  @pdf_field_handling_standard_tab_permission
end

#recipient_auth_requirements ⇒ Object

Returns the value of attribute recipient_auth_requirements.



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

def recipient_auth_requirements
  @recipient_auth_requirements
end

#status ⇒ Object

Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.



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

def status
  @status
end

#user_id ⇒ Object

Returns the value of attribute user_id.



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

def user_id
  @user_id
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'account_name' => :'accountName',
    :'configuration_id' => :'configurationId',
    :'email' => :'email',
    :'exempt_members_of_same_account_from_auth' => :'exemptMembersOfSameAccountFromAuth',
    :'link_id' => :'linkId',
    :'pdf_field_handling_option' => :'pdfFieldHandlingOption',
    :'pdf_field_handling_prefill_tab_permission' => :'pdfFieldHandlingPrefillTabPermission',
    :'pdf_field_handling_standard_input_tab_permission' => :'pdfFieldHandlingStandardInputTabPermission',
    :'pdf_field_handling_standard_tab_permission' => :'pdfFieldHandlingStandardTabPermission',
    :'recipient_auth_requirements' => :'recipientAuthRequirements',
    :'status' => :'status',
    :'user_id' => :'userId'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'account_name' => :'String',
    :'configuration_id' => :'String',
    :'email' => :'String',
    :'exempt_members_of_same_account_from_auth' => :'String',
    :'link_id' => :'String',
    :'pdf_field_handling_option' => :'String',
    :'pdf_field_handling_prefill_tab_permission' => :'String',
    :'pdf_field_handling_standard_input_tab_permission' => :'String',
    :'pdf_field_handling_standard_tab_permission' => :'String',
    :'recipient_auth_requirements' => :'ExternalPrimaryAccountRecipientAuthRequirements',
    :'status' => :'String',
    :'user_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/docusign_esign/models/linked_external_primary_account.rb', line 160

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      configuration_id == o.configuration_id &&
      email == o.email &&
       == o. &&
      link_id == o.link_id &&
      pdf_field_handling_option == o.pdf_field_handling_option &&
      pdf_field_handling_prefill_tab_permission == o.pdf_field_handling_prefill_tab_permission &&
      pdf_field_handling_standard_input_tab_permission == o.pdf_field_handling_standard_input_tab_permission &&
      pdf_field_handling_standard_tab_permission == o.pdf_field_handling_standard_tab_permission &&
      recipient_auth_requirements == o.recipient_auth_requirements &&
      status == o.status &&
      user_id == o.user_id
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
247
248
249
 
# File 'lib/docusign_esign/models/linked_external_primary_account.rb', line 213

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



279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/docusign_esign/models/linked_external_primary_account.rb', line 279

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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/docusign_esign/models/linked_external_primary_account.rb', line 192

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

See Also:

  • `==` method


179
180
181
 
# File 'lib/docusign_esign/models/linked_external_primary_account.rb', line 179

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



185
186
187
 
# File 'lib/docusign_esign/models/linked_external_primary_account.rb', line 185

def hash
  [, configuration_id, email, , link_id, pdf_field_handling_option, pdf_field_handling_prefill_tab_permission, pdf_field_handling_standard_input_tab_permission, pdf_field_handling_standard_tab_permission, recipient_auth_requirements, status, user_id].hash
end

#list_invalid_properties ⇒ Object

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



147
148
149
150
 
# File 'lib/docusign_esign/models/linked_external_primary_account.rb', line 147

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



259
260
261
 
# File 'lib/docusign_esign/models/linked_external_primary_account.rb', line 259

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



265
266
267
268
269
270
271
272
273
 
# File 'lib/docusign_esign/models/linked_external_primary_account.rb', line 265

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



253
254
255
 
# File 'lib/docusign_esign/models/linked_external_primary_account.rb', line 253

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



154
155
156
 
# File 'lib/docusign_esign/models/linked_external_primary_account.rb', line 154

def valid?
  true
end