Class: Dropbox::Sign::EmbeddedEditUrlRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmbeddedEditUrlRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

  if attributes.key?(:'show_preview')
    self.show_preview = attributes[:'show_preview']
  else
    self.show_preview = false
  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?(:'test_mode')
    self.test_mode = attributes[:'test_mode']
  else
    self.test_mode = false
  end
end

Instance Attribute Details

#allow_edit_ccs ⇒ Boolean

This allows the requester to enable/disable to add or change CC roles when editing the template.

Returns:

  • (Boolean) 


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

def allow_edit_ccs
  @allow_edit_ccs
end

#cc_roles ⇒ Array<String>

The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request.

Returns:

  • (Array<String>) 


27
28
29
 
# File 'lib/dropbox-sign/models/embedded_edit_url_request.rb', line 27

def cc_roles
  @cc_roles
end

#editor_options ⇒ SubEditorOptions

Returns:



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

def editor_options
  @editor_options
end

#force_signer_roles ⇒ Boolean

Provide users the ability to review/edit the template signer roles.

Returns:

  • (Boolean) 


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

def force_signer_roles
  @force_signer_roles
end

#force_subject_message ⇒ Boolean

Provide users the ability to review/edit the template subject and message.

Returns:

  • (Boolean) 


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

def force_subject_message
  @force_subject_message
end

#merge_fields ⇒ Array<SubMergeField>

Add additional merge fields to the template, which can be used used to pre-fill data by passing values into signature requests made with that template. Remove all merge fields on the template by passing an empty array ‘[]`.

Returns:



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

def merge_fields
  @merge_fields
end

#preview_only ⇒ Boolean

This allows the requester to enable the preview experience (i.e. does not allow the requester’s end user to add any additional fields via the editor). NOTE: This parameter overwrites ‘show_preview=true` (if set).

Returns:

  • (Boolean) 


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

def preview_only
  @preview_only
end

#show_preview ⇒ Boolean

This allows the requester to enable the editor/preview experience.

Returns:

  • (Boolean) 


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

def show_preview
  @show_preview
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) 


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

def show_progress_stepper
  @show_progress_stepper
end

#test_mode ⇒ Boolean

Whether this is a test, locked templates will only be available for editing if this is set to ‘true`. Defaults to `false`.

Returns:

  • (Boolean) 


58
59
60
 
# File 'lib/dropbox-sign/models/embedded_edit_url_request.rb', line 58

def test_mode
  @test_mode
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



77
78
79
 
# File 'lib/dropbox-sign/models/embedded_edit_url_request.rb', line 77

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/dropbox-sign/models/embedded_edit_url_request.rb', line 61

def self.attribute_map
  {
    :'allow_edit_ccs' => :'allow_edit_ccs',
    :'cc_roles' => :'cc_roles',
    :'editor_options' => :'editor_options',
    :'force_signer_roles' => :'force_signer_roles',
    :'force_subject_message' => :'force_subject_message',
    :'merge_fields' => :'merge_fields',
    :'preview_only' => :'preview_only',
    :'show_preview' => :'show_preview',
    :'show_progress_stepper' => :'show_progress_stepper',
    :'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



247
248
249
 
# File 'lib/dropbox-sign/models/embedded_edit_url_request.rb', line 247

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

.init(data) ⇒ EmbeddedEditUrlRequest

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



121
122
123
124
125
126
 
# File 'lib/dropbox-sign/models/embedded_edit_url_request.rb', line 121

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



104
105
106
 
# File 'lib/dropbox-sign/models/embedded_edit_url_request.rb', line 104

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



114
115
116
 
# File 'lib/dropbox-sign/models/embedded_edit_url_request.rb', line 114

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



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

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



98
99
100
101
 
# File 'lib/dropbox-sign/models/embedded_edit_url_request.rb', line 98

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

.openapi_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/dropbox-sign/models/embedded_edit_url_request.rb', line 82

def self.openapi_types
  {
    :'allow_edit_ccs' => :'Boolean',
    :'cc_roles' => :'Array<String>',
    :'editor_options' => :'SubEditorOptions',
    :'force_signer_roles' => :'Boolean',
    :'force_subject_message' => :'Boolean',
    :'merge_fields' => :'Array<SubMergeField>',
    :'preview_only' => :'Boolean',
    :'show_preview' => :'Boolean',
    :'show_progress_stepper' => :'Boolean',
    :'test_mode' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/dropbox-sign/models/embedded_edit_url_request.rb', line 217

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      allow_edit_ccs == o.allow_edit_ccs &&
      cc_roles == o.cc_roles &&
      editor_options == o.editor_options &&
      force_signer_roles == o.force_signer_roles &&
      force_subject_message == o.force_subject_message &&
      merge_fields == o.merge_fields &&
      preview_only == o.preview_only &&
      show_preview == o.show_preview &&
      show_progress_stepper == o.show_progress_stepper &&
      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



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

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



348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/dropbox-sign/models/embedded_edit_url_request.rb', line 348

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



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

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


234
235
236
 
# File 'lib/dropbox-sign/models/embedded_edit_url_request.rb', line 234

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



240
241
242
 
# File 'lib/dropbox-sign/models/embedded_edit_url_request.rb', line 240

def hash
  [allow_edit_ccs, cc_roles, editor_options, force_signer_roles, force_subject_message, merge_fields, preview_only, show_preview, show_progress_stepper, 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



204
205
206
207
 
# File 'lib/dropbox-sign/models/embedded_edit_url_request.rb', line 204

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



323
324
325
 
# File 'lib/dropbox-sign/models/embedded_edit_url_request.rb', line 323

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



329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/dropbox-sign/models/embedded_edit_url_request.rb', line 329

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



317
318
319
 
# File 'lib/dropbox-sign/models/embedded_edit_url_request.rb', line 317

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



211
212
213
 
# File 'lib/dropbox-sign/models/embedded_edit_url_request.rb', line 211

def valid?
  true
end