Class: DocuSign_eSign::RecipientViewRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RecipientViewRequest

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
182
183
184
# File 'lib/docusign_esign/models/recipient_view_request.rb', line 111

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

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

  if attributes.has_key?(:'frameAncestors')
    if (value = attributes[:'frameAncestors']).is_a?(Array)
      self.frame_ancestors = value
    end
  end

  if attributes.has_key?(:'messageOrigins')
    if (value = attributes[:'messageOrigins']).is_a?(Array)
      self.message_origins = value
    end
  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?(:'userId')
    self.user_id = attributes[:'userId']
  end

  if attributes.has_key?(:'userName')
    self.user_name = attributes[:'userName']
  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

A unique identifier of the authentication event executed by the client application.


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

def assertion_id
  @assertion_id
end

#authentication_instantObject

A sender generated value that indicates the date/time that the signer was authenticated.


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

def authentication_instant
  @authentication_instant
end

#authentication_methodObject

A sender created value that indicates the convention used to authenticate the signer. This information is included in the Certificate of Completion.


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

def authentication_method
  @authentication_method
end

#client_user_idObject

A sender created value that shows the recipient is embedded (captive). Maximum length: 100 characters.


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

def client_user_id
  @client_user_id
end

#emailObject

Specifies the email of the recipient. You can use either email and userName or userId to identify the recipient.


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

def email
  @email
end

#frame_ancestorsObject

Returns the value of attribute frame_ancestors


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

def frame_ancestors
  @frame_ancestors
end

#message_originsObject

Returns the value of attribute message_origins


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

def message_origins
  @message_origins
end

#ping_frequencyObject

Only used if pingUrl is specified. This is the interval, in seconds, between pings on the pingUrl. The default is 300 seconds. Valid values are 60-1200 seconds.


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

def ping_frequency
  @ping_frequency
end

#ping_urlObject

A client Url to be pinged by the DocuSign Signing experience to indicate to the client that Signing is active. An HTTP Get is executed against the client. The response from the client is ignored. The intent is for the client to reset it's session timer when the request is received.


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

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.


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

def recipient_id
  @recipient_id
end

#return_urlObject

The url the recipient is redirected to after the signing session has ended. DocuSign redirects to the url and includes an event parameter that can be used by your application. Possible event parameter values: * cancel (recipient canceled the signing operation) * decline (recipient declined to sign) * exception (an exception occurred) * fax_pending (recipient has a fax pending) * session_timeout (session timed out) * signing_complete (signer completed the signing ceremony) * ttl_expired (the TTL, time to live, timer expired) * viewing_complete (recipient completed viewing the envelope) ###### Note: Include https:// in the URL or the redirect might not succeed on some browsers.


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

def return_url
  @return_url
end

#security_domainObject

The domain in which the user authenticated.


51
52
53
# File 'lib/docusign_esign/models/recipient_view_request.rb', line 51

def security_domain
  @security_domain
end

#user_idObject

Specifies the user ID of the recipient. You can use with user ID or email and user name to identify the recipient. If user ID is used and a client user ID is provided, the value in the `userId` property must match a recipient ID (which can be retrieved with a GET recipients call) for the envelope. If a user ID is used and a clientUser ID is not provided, the user ID match the user ID of the authenticating user.


54
55
56
# File 'lib/docusign_esign/models/recipient_view_request.rb', line 54

def user_id
  @user_id
end

#user_nameObject

Specifies the username of the recipient. You can use either email and userName or userId to identify the recipient.


57
58
59
# File 'lib/docusign_esign/models/recipient_view_request.rb', line 57

def user_name
  @user_name
end

#x_frame_optionsObject

Returns the value of attribute x_frame_options


60
61
62
# File 'lib/docusign_esign/models/recipient_view_request.rb', line 60

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


63
64
65
# File 'lib/docusign_esign/models/recipient_view_request.rb', line 63

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.


66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# File 'lib/docusign_esign/models/recipient_view_request.rb', line 66

def self.attribute_map
  {
    :'assertion_id' => :'assertionId',
    :'authentication_instant' => :'authenticationInstant',
    :'authentication_method' => :'authenticationMethod',
    :'client_user_id' => :'clientUserId',
    :'email' => :'email',
    :'frame_ancestors' => :'frameAncestors',
    :'message_origins' => :'messageOrigins',
    :'ping_frequency' => :'pingFrequency',
    :'ping_url' => :'pingUrl',
    :'recipient_id' => :'recipientId',
    :'return_url' => :'returnUrl',
    :'security_domain' => :'securityDomain',
    :'user_id' => :'userId',
    :'user_name' => :'userName',
    :'x_frame_options' => :'xFrameOptions',
    :'x_frame_options_allow_from_url' => :'xFrameOptionsAllowFromUrl'
  }
end

.swagger_typesObject

Attribute type mapping.


88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
# File 'lib/docusign_esign/models/recipient_view_request.rb', line 88

def self.swagger_types
  {
    :'assertion_id' => :'String',
    :'authentication_instant' => :'String',
    :'authentication_method' => :'String',
    :'client_user_id' => :'String',
    :'email' => :'String',
    :'frame_ancestors' => :'Array<String>',
    :'message_origins' => :'Array<String>',
    :'ping_frequency' => :'String',
    :'ping_url' => :'String',
    :'recipient_id' => :'String',
    :'return_url' => :'String',
    :'security_domain' => :'String',
    :'user_id' => :'String',
    :'user_name' => :'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


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

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 &&
      client_user_id == o.client_user_id &&
      email == o.email &&
      frame_ancestors == o.frame_ancestors &&
      message_origins == o.message_origins &&
      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 &&
      user_id == o.user_id &&
      user_name == o.user_name &&
      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


258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
# File 'lib/docusign_esign/models/recipient_view_request.rb', line 258

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


324
325
326
327
328
329
330
331
332
333
334
335
336
# File 'lib/docusign_esign/models/recipient_view_request.rb', line 324

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


237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
# File 'lib/docusign_esign/models/recipient_view_request.rb', line 237

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

224
225
226
# File 'lib/docusign_esign/models/recipient_view_request.rb', line 224

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


230
231
232
# File 'lib/docusign_esign/models/recipient_view_request.rb', line 230

def hash
  [assertion_id, authentication_instant, authentication_method, client_user_id, email, frame_ancestors, message_origins, ping_frequency, ping_url, recipient_id, return_url, security_domain, user_id, user_name, 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


188
189
190
191
# File 'lib/docusign_esign/models/recipient_view_request.rb', line 188

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


304
305
306
# File 'lib/docusign_esign/models/recipient_view_request.rb', line 304

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


310
311
312
313
314
315
316
317
318
# File 'lib/docusign_esign/models/recipient_view_request.rb', line 310

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


298
299
300
# File 'lib/docusign_esign/models/recipient_view_request.rb', line 298

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


195
196
197
# File 'lib/docusign_esign/models/recipient_view_request.rb', line 195

def valid?
  true
end