Class: DocuSign_eSign::RecipientPreviewRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RecipientPreviewRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash


81
82
83
84
85
86
87
88
89
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
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 81

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#assertion_idObject

Returns the value of attribute assertion_id


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

def assertion_id
  @assertion_id
end

#authentication_instantObject

Returns the value of attribute authentication_instant


21
22
23
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 21

def authentication_instant
  @authentication_instant
end

#authentication_methodObject

Returns the value of attribute authentication_method


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

def authentication_method
  @authentication_method
end

#ping_frequencyObject

Returns the value of attribute ping_frequency


27
28
29
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 27

def ping_frequency
  @ping_frequency
end

#ping_urlObject

Returns the value of attribute ping_url


30
31
32
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 30

def ping_url
  @ping_url
end

#recipient_idObject

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.


33
34
35
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 33

def recipient_id
  @recipient_id
end

#return_urlObject

Returns the value of attribute return_url


36
37
38
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 36

def return_url
  @return_url
end

#security_domainObject

Returns the value of attribute security_domain


39
40
41
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 39

def security_domain
  @security_domain
end

#x_frame_optionsObject

Returns the value of attribute x_frame_options


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

def x_frame_options
  @x_frame_options
end

#x_frame_options_allow_from_urlObject

Returns the value of attribute x_frame_options_allow_from_url


45
46
47
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 45

def x_frame_options_allow_from_url
  @x_frame_options_allow_from_url
end

Class Method Details

.attribute_mapObject

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


48
49
50
51
52
53
54
55
56
57
58
59
60
61
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 48

def self.attribute_map
  {
    :'assertion_id' => :'assertionId',
    :'authentication_instant' => :'authenticationInstant',
    :'authentication_method' => :'authenticationMethod',
    :'ping_frequency' => :'pingFrequency',
    :'ping_url' => :'pingUrl',
    :'recipient_id' => :'recipientId',
    :'return_url' => :'returnUrl',
    :'security_domain' => :'securityDomain',
    :'x_frame_options' => :'xFrameOptions',
    :'x_frame_options_allow_from_url' => :'xFrameOptionsAllowFromUrl'
  }
end

.swagger_typesObject

Attribute type mapping.


64
65
66
67
68
69
70
71
72
73
74
75
76
77
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 64

def self.swagger_types
  {
    :'assertion_id' => :'String',
    :'authentication_instant' => :'String',
    :'authentication_method' => :'String',
    :'ping_frequency' => :'String',
    :'ping_url' => :'String',
    :'recipient_id' => :'String',
    :'return_url' => :'String',
    :'security_domain' => :'String',
    :'x_frame_options' => :'String',
    :'x_frame_options_allow_from_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


143
144
145
146
147
148
149
150
151
152
153
154
155
156
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 143

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      assertion_id == o.assertion_id &&
      authentication_instant == o.authentication_instant &&
      authentication_method == o.authentication_method &&
      ping_frequency == o.ping_frequency &&
      ping_url == o.ping_url &&
      recipient_id == o.recipient_id &&
      return_url == o.return_url &&
      security_domain == o.security_domain &&
      x_frame_options == o.x_frame_options &&
      x_frame_options_allow_from_url == o.x_frame_options_allow_from_url
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


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
221
222
223
224
225
226
227
228
229
230
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 194

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


260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 260

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


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

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

160
161
162
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 160

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


166
167
168
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 166

def hash
  [assertion_id, authentication_instant, authentication_method, ping_frequency, ping_url, recipient_id, return_url, security_domain, x_frame_options, x_frame_options_allow_from_url].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


130
131
132
133
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 130

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


240
241
242
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 240

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


246
247
248
249
250
251
252
253
254
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 246

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


234
235
236
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 234

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


137
138
139
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 137

def valid?
  true
end