Class: Dropbox::Sign::TemplateResponse

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

Overview

Contains information about the templates you and your team have created.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TemplateResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
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
258
259
260
261
262
263
 
# File 'lib/dropbox-sign/models/template_response.rb', line 171

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

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

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

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

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

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

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

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

  if attributes.key?(:'metadata')
    if (value = attributes[:'metadata']).is_a?(Hash)
      self.metadata = value
    end
  end

  if attributes.key?(:'signer_roles')
    if (value = attributes[:'signer_roles']).is_a?(Array)
      self.signer_roles = value
    end
  end

  if attributes.key?(:'cc_roles')
    if (value = attributes[:'cc_roles']).is_a?(Array)
      self.cc_roles = value
    end
  end

  if attributes.key?(:'documents')
    if (value = attributes[:'documents']).is_a?(Array)
      self.documents = value
    end
  end

  if attributes.key?(:'custom_fields')
    if (value = attributes[:'custom_fields']).is_a?(Array)
      self.custom_fields = value
    end
  end

  if attributes.key?(:'named_form_fields')
    if (value = attributes[:'named_form_fields']).is_a?(Array)
      self.named_form_fields = value
    end
  end

  if attributes.key?(:'accounts')
    if (value = attributes[:'accounts']).is_a?(Array)
      self.accounts = value
    end
  end

  if attributes.key?(:'attachments')
    if (value = attributes[:'attachments']).is_a?(Array)
      self.attachments = value
    end
  end
end

Instance Attribute Details

#accounts ⇒ Array<TemplateResponseAccount>

An array of the Accounts that can use this Template.

Returns:



80
81
82
 
# File 'lib/dropbox-sign/models/template_response.rb', line 80

def accounts
  @accounts
end

#attachments ⇒ Array<SignatureRequestResponseAttachment>

Signer attachments.

Returns:



84
85
86
 
# File 'lib/dropbox-sign/models/template_response.rb', line 84

def attachments
  @attachments
end

#can_edit ⇒ Boolean

Indicates whether edit rights have been granted to you by the owner (always ‘true` if that’s you).

Returns:

  • (Boolean) 


48
49
50
 
# File 'lib/dropbox-sign/models/template_response.rb', line 48

def can_edit
  @can_edit
end

#cc_roles ⇒ Array<TemplateResponseCCRole>

An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.

Returns:



64
65
66
 
# File 'lib/dropbox-sign/models/template_response.rb', line 64

def cc_roles
  @cc_roles
end

#custom_fields ⇒ Array<TemplateResponseDocumentCustomFieldBase>?

Deprecated. Use ‘custom_fields` inside the [documents](developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.

Returns:



72
73
74
 
# File 'lib/dropbox-sign/models/template_response.rb', line 72

def custom_fields
  @custom_fields
end

#documents ⇒ Array<TemplateResponseDocument>

An array describing each document associated with this Template. Includes form field data for each document.

Returns:



68
69
70
 
# File 'lib/dropbox-sign/models/template_response.rb', line 68

def documents
  @documents
end

#is_creator ⇒ Boolean

‘true` if you are the owner of this template, `false` if it’s been shared with you by a team member.

Returns:

  • (Boolean) 


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

def is_creator
  @is_creator
end

#is_embedded ⇒ Boolean?

‘true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template.

Returns:

  • (Boolean, nil) 


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

def is_embedded
  @is_embedded
end

#is_locked ⇒ Boolean

Indicates whether the template is locked. If ‘true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests.

Returns:

  • (Boolean) 


52
53
54
 
# File 'lib/dropbox-sign/models/template_response.rb', line 52

def is_locked
  @is_locked
end

#message ⇒ String

The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest.

Returns:

  • (String) 


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

def message
  @message
end

#metadata ⇒ Hash<String, Object>

The metadata attached to the template.

Returns:

  • (Hash<String, Object>) 


56
57
58
 
# File 'lib/dropbox-sign/models/template_response.rb', line 56

def metadata
  @metadata
end

#named_form_fields ⇒ Array<TemplateResponseDocumentFormFieldBase>?

Deprecated. Use ‘form_fields` inside the [documents](developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.

Returns:



76
77
78
 
# File 'lib/dropbox-sign/models/template_response.rb', line 76

def named_form_fields
  @named_form_fields
end

#signer_roles ⇒ Array<TemplateResponseSignerRole>

An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.

Returns:



60
61
62
 
# File 'lib/dropbox-sign/models/template_response.rb', line 60

def signer_roles
  @signer_roles
end

#template_id ⇒ String

The id of the Template.

Returns:

  • (String) 


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

def template_id
  @template_id
end

#title ⇒ String

The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest.

Returns:

  • (String) 


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

def title
  @title
end

#updated_at ⇒ Integer

Time the template was last updated.

Returns:

  • (Integer) 


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

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



109
110
111
 
# File 'lib/dropbox-sign/models/template_response.rb', line 109

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/dropbox-sign/models/template_response.rb', line 87

def self.attribute_map
  {
    :'template_id' => :'template_id',
    :'title' => :'title',
    :'message' => :'message',
    :'updated_at' => :'updated_at',
    :'is_embedded' => :'is_embedded',
    :'is_creator' => :'is_creator',
    :'can_edit' => :'can_edit',
    :'is_locked' => :'is_locked',
    :'metadata' => :'metadata',
    :'signer_roles' => :'signer_roles',
    :'cc_roles' => :'cc_roles',
    :'documents' => :'documents',
    :'custom_fields' => :'custom_fields',
    :'named_form_fields' => :'named_form_fields',
    :'accounts' => :'accounts',
    :'attachments' => :'attachments'
  }
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



316
317
318
 
# File 'lib/dropbox-sign/models/template_response.rb', line 316

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

.init(data) ⇒ TemplateResponse

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



162
163
164
165
166
167
 
# File 'lib/dropbox-sign/models/template_response.rb', line 162

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



145
146
147
 
# File 'lib/dropbox-sign/models/template_response.rb', line 145

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



155
156
157
 
# File 'lib/dropbox-sign/models/template_response.rb', line 155

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



150
151
152
 
# File 'lib/dropbox-sign/models/template_response.rb', line 150

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



136
137
138
139
140
141
142
 
# File 'lib/dropbox-sign/models/template_response.rb', line 136

def self.openapi_nullable
  Set.new([
    :'is_embedded',
    :'custom_fields',
    :'named_form_fields',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/dropbox-sign/models/template_response.rb', line 114

def self.openapi_types
  {
    :'template_id' => :'String',
    :'title' => :'String',
    :'message' => :'String',
    :'updated_at' => :'Integer',
    :'is_embedded' => :'Boolean',
    :'is_creator' => :'Boolean',
    :'can_edit' => :'Boolean',
    :'is_locked' => :'Boolean',
    :'metadata' => :'Hash<String, Object>',
    :'signer_roles' => :'Array<TemplateResponseSignerRole>',
    :'cc_roles' => :'Array<TemplateResponseCCRole>',
    :'documents' => :'Array<TemplateResponseDocument>',
    :'custom_fields' => :'Array<TemplateResponseDocumentCustomFieldBase>',
    :'named_form_fields' => :'Array<TemplateResponseDocumentFormFieldBase>',
    :'accounts' => :'Array<TemplateResponseAccount>',
    :'attachments' => :'Array<SignatureRequestResponseAttachment>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/dropbox-sign/models/template_response.rb', line 280

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      template_id == o.template_id &&
      title == o.title &&
      message == o.message &&
      updated_at == o.updated_at &&
      is_embedded == o.is_embedded &&
      is_creator == o.is_creator &&
      can_edit == o.can_edit &&
      is_locked == o.is_locked &&
      metadata == o.metadata &&
      signer_roles == o.signer_roles &&
      cc_roles == o.cc_roles &&
      documents == o.documents &&
      custom_fields == o.custom_fields &&
      named_form_fields == o.named_form_fields &&
      accounts == o.accounts &&
      attachments == o.attachments
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



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/dropbox-sign/models/template_response.rb', line 346

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



417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/dropbox-sign/models/template_response.rb', line 417

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



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/dropbox-sign/models/template_response.rb', line 323

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


303
304
305
 
# File 'lib/dropbox-sign/models/template_response.rb', line 303

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



309
310
311
 
# File 'lib/dropbox-sign/models/template_response.rb', line 309

def hash
  [template_id, title, message, updated_at, is_embedded, is_creator, can_edit, is_locked, metadata, signer_roles, cc_roles, documents, custom_fields, named_form_fields, accounts, attachments].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



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

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



392
393
394
 
# File 'lib/dropbox-sign/models/template_response.rb', line 392

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



398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/dropbox-sign/models/template_response.rb', line 398

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



386
387
388
 
# File 'lib/dropbox-sign/models/template_response.rb', line 386

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



274
275
276
 
# File 'lib/dropbox-sign/models/template_response.rb', line 274

def valid?
  true
end