Class: Dropbox::Sign::TemplateCreateEmbeddedDraftResponseTemplate

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

Overview

Template object with parameters: ‘template_id`, `edit_url`, `expires_at`.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TemplateCreateEmbeddedDraftResponseTemplate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb', line 101

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

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  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::TemplateCreateEmbeddedDraftResponseTemplate`. Please check the name to make sure it's valid. List of attributes: " + acceptable_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?(:'edit_url')
    self.edit_url = attributes[:'edit_url']
  end

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

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

Instance Attribute Details

#edit_url ⇒ String

Link to edit the template.

Returns:

  • (String) 


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

def edit_url
  @edit_url
end

#expires_at ⇒ Integer

When the link expires.

Returns:

  • (Integer) 


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

def expires_at
  @expires_at
end

#template_id ⇒ String

The id of the Template.

Returns:

  • (String) 


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

def template_id
  @template_id
end

#warnings ⇒ Array<WarningResponse>

A list of warnings.

Returns:



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

def warnings
  @warnings
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



49
50
51
 
# File 'lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb', line 49

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



54
55
56
 
# File 'lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb', line 54

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
 
# File 'lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb', line 39

def self.attribute_map
  {
    :'template_id' => :'template_id',
    :'edit_url' => :'edit_url',
    :'expires_at' => :'expires_at',
    :'warnings' => :'warnings'
  }
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



173
174
175
 
# File 'lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb', line 173

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

.init(data) ⇒ TemplateCreateEmbeddedDraftResponseTemplate

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



92
93
94
95
96
97
 
# File 'lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb', line 92

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



75
76
77
 
# File 'lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb', line 75

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



85
86
87
 
# File 'lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb', line 85

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



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

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



69
70
71
72
 
# File 'lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb', line 69

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

.openapi_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
 
# File 'lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb', line 59

def self.openapi_types
  {
    :'template_id' => :'String',
    :'edit_url' => :'String',
    :'expires_at' => :'Integer',
    :'warnings' => :'Array<WarningResponse>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



149
150
151
152
153
154
155
156
 
# File 'lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb', line 149

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      template_id == o.template_id &&
      edit_url == o.edit_url &&
      expires_at == o.expires_at &&
      warnings == o.warnings
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



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

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



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

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



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb', line 180

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


160
161
162
 
# File 'lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb', line 160

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



166
167
168
 
# File 'lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb', line 166

def hash
  [template_id, edit_url, expires_at, warnings].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



136
137
138
139
 
# File 'lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb', line 136

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



249
250
251
 
# File 'lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb', line 249

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



255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb', line 255

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



243
244
245
 
# File 'lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb', line 243

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



143
144
145
 
# File 'lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb', line 143

def valid?
  true
end