Class: Dropbox::Sign::ApiAppResponse

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

Overview

Contains information about an API App.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ApiAppResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

  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?(:'is_approved')
    self.is_approved = attributes[:'is_approved']
  end

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

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

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

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

Instance Attribute Details

#callback_url ⇒ String?

The app’s callback URL (for events)

Returns:

  • (String, nil) 


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

def callback_url
  @callback_url
end

#client_id ⇒ String

The app’s client id

Returns:

  • (String) 


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

def client_id
  @client_id
end

#created_at ⇒ Integer

The time that the app was created

Returns:

  • (Integer) 


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

def created_at
  @created_at
end

#domains ⇒ Array<String>

The domain name(s) associated with the app

Returns:

  • (Array<String>) 


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

def domains
  @domains
end

#is_approved ⇒ Boolean

Boolean to indicate if the app has been approved

Returns:

  • (Boolean) 


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

def is_approved
  @is_approved
end

#name ⇒ String

The name of the app

Returns:

  • (String) 


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

def name
  @name
end

#oauth ⇒ ApiAppResponseOAuth?

Returns:



47
48
49
 
# File 'lib/dropbox-sign/models/api_app_response.rb', line 47

def oauth
  @oauth
end

#options ⇒ ApiAppResponseOptions?

Returns:



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

def options
  @options
end

#owner_account ⇒ ApiAppResponseOwnerAccount

Returns:



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

def 
  @owner_account
end

#white_labeling_options ⇒ ApiAppResponseWhiteLabelingOptions?

Returns:



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

def white_labeling_options
  @white_labeling_options
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'callback_url' => :'callback_url',
    :'client_id' => :'client_id',
    :'created_at' => :'created_at',
    :'domains' => :'domains',
    :'name' => :'name',
    :'is_approved' => :'is_approved',
    :'oauth' => :'oauth',
    :'options' => :'options',
    :'owner_account' => :'owner_account',
    :'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_response.rb', line 233

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

.init(data) ⇒ ApiAppResponse

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



123
124
125
126
127
128
 
# File 'lib/dropbox-sign/models/api_app_response.rb', line 123

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



106
107
108
 
# File 'lib/dropbox-sign/models/api_app_response.rb', line 106

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



116
117
118
 
# File 'lib/dropbox-sign/models/api_app_response.rb', line 116

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



111
112
113
 
# File 'lib/dropbox-sign/models/api_app_response.rb', line 111

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



96
97
98
99
100
101
102
103
 
# File 'lib/dropbox-sign/models/api_app_response.rb', line 96

def self.openapi_nullable
  Set.new([
    :'callback_url',
    :'oauth',
    :'options',
    :'white_labeling_options'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'callback_url' => :'String',
    :'client_id' => :'String',
    :'created_at' => :'Integer',
    :'domains' => :'Array<String>',
    :'name' => :'String',
    :'is_approved' => :'Boolean',
    :'oauth' => :'ApiAppResponseOAuth',
    :'options' => :'ApiAppResponseOptions',
    :'owner_account' => :'ApiAppResponseOwnerAccount',
    :'white_labeling_options' => :'ApiAppResponseWhiteLabelingOptions'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      callback_url == o.callback_url &&
      client_id == o.client_id &&
      created_at == o.created_at &&
      domains == o.domains &&
      name == o.name &&
      is_approved == o.is_approved &&
      oauth == o.oauth &&
      options == o.options &&
       == o. &&
      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_response.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_response.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_response.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_response.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_response.rb', line 226

def hash
  [callback_url, client_id, created_at, domains, name, is_approved, 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



190
191
192
193
 
# File 'lib/dropbox-sign/models/api_app_response.rb', line 190

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



309
310
311
 
# File 'lib/dropbox-sign/models/api_app_response.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_response.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_response.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



197
198
199
 
# File 'lib/dropbox-sign/models/api_app_response.rb', line 197

def valid?
  true
end