Class: Dropbox::Sign::ApiAppCreateRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ApiAppCreateRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



110
111
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
149
150
151
152
 
# File 'lib/dropbox-sign/models/api_app_create_request.rb', line 110

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

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

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

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

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

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

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

Instance Attribute Details

#callback_url ⇒ String

The URL at which the ApiApp should receive event callbacks.

Returns:

  • (String) 


31
32
33
 
# File 'lib/dropbox-sign/models/api_app_create_request.rb', line 31

def callback_url
  @callback_url
end

#custom_logo_file ⇒ File

An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)

Returns:

  • (File) 


35
36
37
 
# File 'lib/dropbox-sign/models/api_app_create_request.rb', line 35

def custom_logo_file
  @custom_logo_file
end

#domains ⇒ Array<String>

The domain names the ApiApp will be associated with.

Returns:

  • (Array<String>) 


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

def domains
  @domains
end

#name ⇒ String

The name you want to assign to the ApiApp.

Returns:

  • (String) 


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

def name
  @name
end

#oauth ⇒ SubOAuth

Returns:



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

def oauth
  @oauth
end

#options ⇒ SubOptions

Returns:



41
42
43
 
# File 'lib/dropbox-sign/models/api_app_create_request.rb', line 41

def options
  @options
end

#white_labeling_options ⇒ SubWhiteLabelingOptions

Returns:



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

def white_labeling_options
  @white_labeling_options
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

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

def self.attribute_map
  {
    :'domains' => :'domains',
    :'name' => :'name',
    :'callback_url' => :'callback_url',
    :'custom_logo_file' => :'custom_logo_file',
    :'oauth' => :'oauth',
    :'options' => :'options',
    :'white_labeling_options' => :'white_labeling_options'
  }
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



233
234
235
 
# File 'lib/dropbox-sign/models/api_app_create_request.rb', line 233

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

.init(data) ⇒ ApiAppCreateRequest

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



101
102
103
104
105
106
 
# File 'lib/dropbox-sign/models/api_app_create_request.rb', line 101

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



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

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



94
95
96
 
# File 'lib/dropbox-sign/models/api_app_create_request.rb', line 94

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



89
90
91
 
# File 'lib/dropbox-sign/models/api_app_create_request.rb', line 89

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



78
79
80
81
 
# File 'lib/dropbox-sign/models/api_app_create_request.rb', line 78

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'domains' => :'Array<String>',
    :'name' => :'String',
    :'callback_url' => :'String',
    :'custom_logo_file' => :'File',
    :'oauth' => :'SubOAuth',
    :'options' => :'SubOptions',
    :'white_labeling_options' => :'SubWhiteLabelingOptions'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/dropbox-sign/models/api_app_create_request.rb', line 206

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      domains == o.domains &&
      name == o.name &&
      callback_url == o.callback_url &&
      custom_logo_file == o.custom_logo_file &&
      oauth == o.oauth &&
      options == o.options &&
      white_labeling_options == o.white_labeling_options
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



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
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/api_app_create_request.rb', line 263

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



334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/dropbox-sign/models/api_app_create_request.rb', line 334

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



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/dropbox-sign/models/api_app_create_request.rb', line 240

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


220
221
222
 
# File 'lib/dropbox-sign/models/api_app_create_request.rb', line 220

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



226
227
228
 
# File 'lib/dropbox-sign/models/api_app_create_request.rb', line 226

def hash
  [domains, name, callback_url, custom_logo_file, oauth, options, white_labeling_options].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



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/dropbox-sign/models/api_app_create_request.rb', line 156

def list_invalid_properties
  invalid_properties = Array.new
  if @domains.nil?
    invalid_properties.push('invalid value for "domains", domains cannot be nil.')
  end

  if @domains.length > 2
    invalid_properties.push('invalid value for "domains", number of items must be less than or equal to 2.')
  end

  if @domains.length < 1
    invalid_properties.push('invalid value for "domains", number of items must be greater than or equal to 1.')
  end

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  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



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

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



315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/dropbox-sign/models/api_app_create_request.rb', line 315

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



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

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



179
180
181
182
183
184
185
 
# File 'lib/dropbox-sign/models/api_app_create_request.rb', line 179

def valid?
  return false if @domains.nil?
  return false if @domains.length > 2
  return false if @domains.length < 1
  return false if @name.nil?
  true
end