Class: Dropbox::Sign::SubEditorOptions

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

Overview

This allows the requester to specify editor options when a preparing a document

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubEditorOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

Instance Attribute Details

#allow_edit_documents ⇒ Boolean

Allows requesters to edit documents, including delete and add

Returns:

  • (Boolean) 


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

def allow_edit_documents
  @allow_edit_documents
end

#allow_edit_signers ⇒ Boolean

Allows requesters to edit the list of signers

Returns:

  • (Boolean) 


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

def allow_edit_signers
  @allow_edit_signers
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



39
40
41
 
# File 'lib/dropbox-sign/models/sub_editor_options.rb', line 39

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



31
32
33
34
35
36
 
# File 'lib/dropbox-sign/models/sub_editor_options.rb', line 31

def self.attribute_map
  {
    :'allow_edit_signers' => :'allow_edit_signers',
    :'allow_edit_documents' => :'allow_edit_documents'
  }
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



147
148
149
 
# File 'lib/dropbox-sign/models/sub_editor_options.rb', line 147

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

.init(data) ⇒ SubEditorOptions

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



75
76
77
78
79
80
 
# File 'lib/dropbox-sign/models/sub_editor_options.rb', line 75

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



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

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



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

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



63
64
65
 
# File 'lib/dropbox-sign/models/sub_editor_options.rb', line 63

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
 
# File 'lib/dropbox-sign/models/sub_editor_options.rb', line 44

def self.openapi_types
  {
    :'allow_edit_signers' => :'Boolean',
    :'allow_edit_documents' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



125
126
127
128
129
130
 
# File 'lib/dropbox-sign/models/sub_editor_options.rb', line 125

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      allow_edit_signers == o.allow_edit_signers &&
      allow_edit_documents == o.allow_edit_documents
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



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

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



248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/dropbox-sign/models/sub_editor_options.rb', line 248

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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/dropbox-sign/models/sub_editor_options.rb', line 154

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


134
135
136
 
# File 'lib/dropbox-sign/models/sub_editor_options.rb', line 134

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



140
141
142
 
# File 'lib/dropbox-sign/models/sub_editor_options.rb', line 140

def hash
  [allow_edit_signers, allow_edit_documents].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



112
113
114
115
 
# File 'lib/dropbox-sign/models/sub_editor_options.rb', line 112

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



223
224
225
 
# File 'lib/dropbox-sign/models/sub_editor_options.rb', line 223

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



229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/dropbox-sign/models/sub_editor_options.rb', line 229

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



217
218
219
 
# File 'lib/dropbox-sign/models/sub_editor_options.rb', line 217

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



119
120
121
 
# File 'lib/dropbox-sign/models/sub_editor_options.rb', line 119

def valid?
  true
end