Class: Dropbox::Sign::UnclaimedDraftResponse

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

Overview

A group of documents that a user can take ownership of via the claim URL.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UnclaimedDraftResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::UnclaimedDraftResponse` 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::UnclaimedDraftResponse`. 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?(:'signature_request_id')
    self.signature_request_id = attributes[:'signature_request_id']
  end

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

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

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

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

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

Instance Attribute Details

#claim_url ⇒ String

The URL to be used to claim this UnclaimedDraft.

Returns:

  • (String) 


28
29
30
 
# File 'lib/dropbox-sign/models/unclaimed_draft_response.rb', line 28

def claim_url
  @claim_url
end

#expires_at ⇒ Integer?

When the link expires.

Returns:

  • (Integer, nil) 


40
41
42
 
# File 'lib/dropbox-sign/models/unclaimed_draft_response.rb', line 40

def expires_at
  @expires_at
end

#requesting_redirect_url ⇒ String?

The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.).

Returns:

  • (String, nil) 


36
37
38
 
# File 'lib/dropbox-sign/models/unclaimed_draft_response.rb', line 36

def requesting_redirect_url
  @requesting_redirect_url
end

#signature_request_id ⇒ String?

The ID of the signature request that is represented by this UnclaimedDraft.

Returns:

  • (String, nil) 


24
25
26
 
# File 'lib/dropbox-sign/models/unclaimed_draft_response.rb', line 24

def signature_request_id
  @signature_request_id
end

#signing_redirect_url ⇒ String?

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

Returns:

  • (String, nil) 


32
33
34
 
# File 'lib/dropbox-sign/models/unclaimed_draft_response.rb', line 32

def signing_redirect_url
  @signing_redirect_url
end

#test_mode ⇒ Boolean

Whether this is a test draft. Signature requests made from test drafts have no legal value.

Returns:

  • (Boolean) 


44
45
46
 
# File 'lib/dropbox-sign/models/unclaimed_draft_response.rb', line 44

def test_mode
  @test_mode
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



59
60
61
 
# File 'lib/dropbox-sign/models/unclaimed_draft_response.rb', line 59

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
 
# File 'lib/dropbox-sign/models/unclaimed_draft_response.rb', line 47

def self.attribute_map
  {
    :'signature_request_id' => :'signature_request_id',
    :'claim_url' => :'claim_url',
    :'signing_redirect_url' => :'signing_redirect_url',
    :'requesting_redirect_url' => :'requesting_redirect_url',
    :'expires_at' => :'expires_at',
    :'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



191
192
193
 
# File 'lib/dropbox-sign/models/unclaimed_draft_response.rb', line 191

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

.init(data) ⇒ UnclaimedDraftResponse

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



103
104
105
106
107
108
 
# File 'lib/dropbox-sign/models/unclaimed_draft_response.rb', line 103

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



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

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



96
97
98
 
# File 'lib/dropbox-sign/models/unclaimed_draft_response.rb', line 96

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



91
92
93
 
# File 'lib/dropbox-sign/models/unclaimed_draft_response.rb', line 91

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



76
77
78
79
80
81
82
83
 
# File 'lib/dropbox-sign/models/unclaimed_draft_response.rb', line 76

def self.openapi_nullable
  Set.new([
    :'signature_request_id',
    :'signing_redirect_url',
    :'requesting_redirect_url',
    :'expires_at',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
 
# File 'lib/dropbox-sign/models/unclaimed_draft_response.rb', line 64

def self.openapi_types
  {
    :'signature_request_id' => :'String',
    :'claim_url' => :'String',
    :'signing_redirect_url' => :'String',
    :'requesting_redirect_url' => :'String',
    :'expires_at' => :'Integer',
    :'test_mode' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



165
166
167
168
169
170
171
172
173
174
 
# File 'lib/dropbox-sign/models/unclaimed_draft_response.rb', line 165

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      signature_request_id == o.signature_request_id &&
      claim_url == o.claim_url &&
      signing_redirect_url == o.signing_redirect_url &&
      requesting_redirect_url == o.requesting_redirect_url &&
      expires_at == o.expires_at &&
      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



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

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



292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/dropbox-sign/models/unclaimed_draft_response.rb', line 292

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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/dropbox-sign/models/unclaimed_draft_response.rb', line 198

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


178
179
180
 
# File 'lib/dropbox-sign/models/unclaimed_draft_response.rb', line 178

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



184
185
186
 
# File 'lib/dropbox-sign/models/unclaimed_draft_response.rb', line 184

def hash
  [signature_request_id, claim_url, signing_redirect_url, requesting_redirect_url, expires_at, 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



152
153
154
155
 
# File 'lib/dropbox-sign/models/unclaimed_draft_response.rb', line 152

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



267
268
269
 
# File 'lib/dropbox-sign/models/unclaimed_draft_response.rb', line 267

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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/dropbox-sign/models/unclaimed_draft_response.rb', line 273

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



261
262
263
 
# File 'lib/dropbox-sign/models/unclaimed_draft_response.rb', line 261

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



159
160
161
 
# File 'lib/dropbox-sign/models/unclaimed_draft_response.rb', line 159

def valid?
  true
end