Class: Dropbox::Sign::UnclaimedDraftEditAndResendRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UnclaimedDraftEditAndResendRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb', line 118

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::UnclaimedDraftEditAndResendRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.merged_attributes.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::UnclaimedDraftEditAndResendRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'client_id')
    self.client_id = attributes[:'client_id']
  end

  if attributes.key?(:'editor_options')
    self.editor_options = attributes[:'editor_options']
  end

  if attributes.key?(:'is_for_embedded_signing')
    self.is_for_embedded_signing = attributes[:'is_for_embedded_signing']
  end

  if attributes.key?(:'requester_email_address')
    self.requester_email_address = attributes[:'requester_email_address']
  end

  if attributes.key?(:'requesting_redirect_url')
    self.requesting_redirect_url = attributes[:'requesting_redirect_url']
  end

  if attributes.key?(:'show_progress_stepper')
    self.show_progress_stepper = attributes[:'show_progress_stepper']
  else
    self.show_progress_stepper = true
  end

  if attributes.key?(:'signing_redirect_url')
    self.signing_redirect_url = attributes[:'signing_redirect_url']
  end

  if attributes.key?(:'test_mode')
    self.test_mode = attributes[:'test_mode']
  else
    self.test_mode = false
  end
end

Instance Attribute Details

#client_id ⇒ String

Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.

Returns:

  • (String) 


23
24
25
 
# File 'lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb', line 23

def client_id
  @client_id
end

#editor_options ⇒ SubEditorOptions

Returns:



26
27
28
 
# File 'lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb', line 26

def editor_options
  @editor_options
end

#is_for_embedded_signing ⇒ Boolean

The request created from this draft will also be signable in embedded mode if set to ‘true`.

Returns:

  • (Boolean) 


30
31
32
 
# File 'lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb', line 30

def is_for_embedded_signing
  @is_for_embedded_signing
end

#requester_email_address ⇒ String

The email address of the user that should be designated as the requester of this draft. If not set, original requester’s email address will be used.

Returns:

  • (String) 


34
35
36
 
# File 'lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb', line 34

def requester_email_address
  @requester_email_address
end

#requesting_redirect_url ⇒ String

The URL you want signers redirected to after they successfully request a signature.

Returns:

  • (String) 


38
39
40
 
# File 'lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb', line 38

def requesting_redirect_url
  @requesting_redirect_url
end

#show_progress_stepper ⇒ Boolean

When only one step remains in the signature request process and this parameter is set to ‘false` then the progress stepper will be hidden.

Returns:

  • (Boolean) 


42
43
44
 
# File 'lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb', line 42

def show_progress_stepper
  @show_progress_stepper
end

#signing_redirect_url ⇒ String

The URL you want signers redirected to after they successfully sign.

Returns:

  • (String) 


46
47
48
 
# File 'lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb', line 46

def signing_redirect_url
  @signing_redirect_url
end

#test_mode ⇒ Boolean

Whether this is a test, the signature request created from this draft will not be legally binding if set to ‘true`. Defaults to `false`.

Returns:

  • (Boolean) 


50
51
52
 
# File 'lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb', line 50

def test_mode
  @test_mode
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



67
68
69
 
# File 'lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb', line 67

def self.acceptable_attributes
  attribute_map.values
end

.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
 
# File 'lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb', line 53

def self.attribute_map
  {
    :'client_id' => :'client_id',
    :'editor_options' => :'editor_options',
    :'is_for_embedded_signing' => :'is_for_embedded_signing',
    :'requester_email_address' => :'requester_email_address',
    :'requesting_redirect_url' => :'requesting_redirect_url',
    :'show_progress_stepper' => :'show_progress_stepper',
    :'signing_redirect_url' => :'signing_redirect_url',
    :'test_mode' => :'test_mode'
  }
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



216
217
218
 
# File 'lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb', line 216

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.init(data) ⇒ UnclaimedDraftEditAndResendRequest

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



109
110
111
112
113
114
 
# File 'lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb', line 109

def self.init(data)
  return ApiClient.default.convert_to_type(
    data,
    "UnclaimedDraftEditAndResendRequest"
  ) || UnclaimedDraftEditAndResendRequest.new
end

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



92
93
94
 
# File 'lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb', line 92

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

Returns list of attributes with nullable: true of this model + parent



102
103
104
 
# File 'lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb', line 102

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



97
98
99
 
# File 'lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb', line 97

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



86
87
88
89
 
# File 'lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb', line 86

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb', line 72

def self.openapi_types
  {
    :'client_id' => :'String',
    :'editor_options' => :'SubEditorOptions',
    :'is_for_embedded_signing' => :'Boolean',
    :'requester_email_address' => :'String',
    :'requesting_redirect_url' => :'String',
    :'show_progress_stepper' => :'Boolean',
    :'signing_redirect_url' => :'String',
    :'test_mode' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb', line 188

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_id == o.client_id &&
      editor_options == o.editor_options &&
      is_for_embedded_signing == o.is_for_embedded_signing &&
      requester_email_address == o.requester_email_address &&
      requesting_redirect_url == o.requesting_redirect_url &&
      show_progress_stepper == o.show_progress_stepper &&
      signing_redirect_url == o.signing_redirect_url &&
      test_mode == o.test_mode
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



246
247
248
249
250
251
252
253
254
255
256
257
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
 
# File 'lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb', line 246

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    klass = Dropbox::Sign.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value, include_nil = true) ⇒ 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



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb', line 317

def _to_hash(value, include_nil = true)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v, include_nil) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v, include_nil) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash(include_nil)
  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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb', line 223

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attribute_map = self.class.merged_attributes

  self.class.merged_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[attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


203
204
205
 
# File 'lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb', line 203

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



209
210
211
 
# File 'lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb', line 209

def hash
  [client_id, editor_options, is_for_embedded_signing, requester_email_address, requesting_redirect_url, show_progress_stepper, signing_redirect_url, test_mode].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



170
171
172
173
174
175
176
177
 
# File 'lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb', line 170

def list_invalid_properties
  invalid_properties = Array.new
  if @client_id.nil?
    invalid_properties.push('invalid value for "client_id", client_id cannot be nil.')
  end

  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



292
293
294
 
# File 'lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb', line 292

def to_body
  to_hash
end

#to_hash(include_nil = true) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb', line 298

def to_hash(include_nil = true)
  hash = {}
  self.class.merged_attributes.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      next unless include_nil
      is_nullable = self.class.merged_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value, include_nil)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



286
287
288
 
# File 'lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb', line 286

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



181
182
183
184
 
# File 'lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb', line 181

def valid?
  return false if @client_id.nil?
  true
end