Class: DocuSign_eSign::RecipientViewRequest

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

Overview

The request body for the [EnvelopeViews: createRecipient](/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/) and [EnvelopeViews: createSharedRecipient](/docs/esign-rest-api/reference/envelopes/envelopeviews/createsharedrecipient/) methods.

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



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
198
199
200
201
202
 
# File 'lib/docusign_esign/models/recipient_view_request.rb', line 121

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

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

  if attributes.has_key?(:'displayFormat')
    self.display_format = attributes[:'displayFormat']
  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_id ⇒ Object

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_instant ⇒ Object

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_method ⇒ Object

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_ur_ls ⇒ Object

Returns the value of attribute client_ur_ls.



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

def client_ur_ls
  @client_ur_ls
end

#client_user_id ⇒ Object

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



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

def client_user_id
  @client_user_id
end

#display_format ⇒ Object

Returns the value of attribute display_format.



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

def display_format
  @display_format
end

#email ⇒ Object

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



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

def email
  @email
end

#frame_ancestors ⇒ Object

Returns the value of attribute frame_ancestors.



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

def frame_ancestors
  @frame_ancestors
end

#message_origins ⇒ Object

Returns the value of attribute message_origins.



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

def message_origins
  @message_origins
end

#ping_frequency ⇒ Object

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.



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

def ping_frequency
  @ping_frequency
end

#ping_url ⇒ Object

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.



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

def ping_url
  @ping_url
end

#recipient_id ⇒ Object

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



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

def recipient_id
  @recipient_id
end

#return_url ⇒ Object

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.



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

def return_url
  @return_url
end

#security_domain ⇒ Object

The domain in which the user authenticated.



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

def security_domain
  @security_domain
end

#user_id ⇒ Object

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.



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

def user_id
  @user_id
end

#user_name ⇒ Object

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



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

def user_name
  @user_name
end

#x_frame_options ⇒ Object

Returns the value of attribute x_frame_options.



66
67
68
 
# File 'lib/docusign_esign/models/recipient_view_request.rb', line 66

def x_frame_options
  @x_frame_options
end

#x_frame_options_allow_from_url ⇒ Object

Returns the value of attribute x_frame_options_allow_from_url.



69
70
71
 
# File 'lib/docusign_esign/models/recipient_view_request.rb', line 69

def x_frame_options_allow_from_url
  @x_frame_options_allow_from_url
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'assertion_id' => :'assertionId',
    :'authentication_instant' => :'authenticationInstant',
    :'authentication_method' => :'authenticationMethod',
    :'client_ur_ls' => :'clientURLs',
    :'client_user_id' => :'clientUserId',
    :'display_format' => :'displayFormat',
    :'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_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'assertion_id' => :'String',
    :'authentication_instant' => :'String',
    :'authentication_method' => :'String',
    :'client_ur_ls' => :'RecipientTokenClientURLs',
    :'client_user_id' => :'String',
    :'display_format' => :'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



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/docusign_esign/models/recipient_view_request.rb', line 219

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_ur_ls == o.client_ur_ls &&
      client_user_id == o.client_user_id &&
      display_format == o.display_format &&
      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



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
310
311
312
313
314
 
# File 'lib/docusign_esign/models/recipient_view_request.rb', line 278

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



344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/docusign_esign/models/recipient_view_request.rb', line 344

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



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

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


244
245
246
 
# File 'lib/docusign_esign/models/recipient_view_request.rb', line 244

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



250
251
252
 
# File 'lib/docusign_esign/models/recipient_view_request.rb', line 250

def hash
  [assertion_id, authentication_instant, authentication_method, client_ur_ls, client_user_id, display_format, 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_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



206
207
208
209
 
# File 'lib/docusign_esign/models/recipient_view_request.rb', line 206

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



324
325
326
 
# File 'lib/docusign_esign/models/recipient_view_request.rb', line 324

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



330
331
332
333
334
335
336
337
338
 
# File 'lib/docusign_esign/models/recipient_view_request.rb', line 330

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



318
319
320
 
# File 'lib/docusign_esign/models/recipient_view_request.rb', line 318

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



213
214
215
 
# File 'lib/docusign_esign/models/recipient_view_request.rb', line 213

def valid?
  true
end