Class: Dropbox::Sign::ReportResponse

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

Overview

Contains information about the report request.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReportResponse

Initializes the object



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
153
154
 
# File 'lib/dropbox-sign/models/report_response.rb', line 123

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

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

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

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

Instance Attribute Details

#end_date ⇒ String

The (inclusive) end date for the report data in MM/DD/YYYY format.



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

def end_date
  @end_date
end

#report_type ⇒ Array<String>

The type(s) of the report you are requesting. Allowed values are "user_activity" and "document_status". User activity reports contain list of all users and their activity during the specified date range. Document status report contain a list of signature requests created in the specified time range (and their status).



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

def report_type
  @report_type
end

#start_date ⇒ String

The (inclusive) start date for the report data in MM/DD/YYYY format.



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

def start_date
  @start_date
end

#success ⇒ String

A message indicating the requested operation’s success



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

def success
  @success
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



71
72
73
 
# File 'lib/dropbox-sign/models/report_response.rb', line 71

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



76
77
78
 
# File 'lib/dropbox-sign/models/report_response.rb', line 76

def self.acceptable_attributes
  acceptable_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
 
# File 'lib/dropbox-sign/models/report_response.rb', line 61

def self.attribute_map
  {
    :'success' => :'success',
    :'start_date' => :'start_date',
    :'end_date' => :'end_date',
    :'report_type' => :'report_type'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



195
196
197
 
# File 'lib/dropbox-sign/models/report_response.rb', line 195

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

.init(data) ⇒ ReportResponse

Attempt to instantiate and hydrate a new instance of this class



114
115
116
117
118
119
 
# File 'lib/dropbox-sign/models/report_response.rb', line 114

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



97
98
99
 
# File 'lib/dropbox-sign/models/report_response.rb', line 97

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



107
108
109
 
# File 'lib/dropbox-sign/models/report_response.rb', line 107

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



102
103
104
 
# File 'lib/dropbox-sign/models/report_response.rb', line 102

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



91
92
93
94
 
# File 'lib/dropbox-sign/models/report_response.rb', line 91

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

.openapi_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
 
# File 'lib/dropbox-sign/models/report_response.rb', line 81

def self.openapi_types
  {
    :'success' => :'String',
    :'start_date' => :'String',
    :'end_date' => :'String',
    :'report_type' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



171
172
173
174
175
176
177
178
 
# File 'lib/dropbox-sign/models/report_response.rb', line 171

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      success == o.success &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      report_type == o.report_type
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/dropbox-sign/models/report_response.rb', line 225

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



296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/dropbox-sign/models/report_response.rb', line 296

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



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

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

See Also:

  • `==` method


182
183
184
 
# File 'lib/dropbox-sign/models/report_response.rb', line 182

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



188
189
190
 
# File 'lib/dropbox-sign/models/report_response.rb', line 188

def hash
  [success, start_date, end_date, report_type].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



158
159
160
161
 
# File 'lib/dropbox-sign/models/report_response.rb', line 158

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



271
272
273
 
# File 'lib/dropbox-sign/models/report_response.rb', line 271

def to_body
  to_hash
end

#to_hash(include_nil = true) ⇒ Hash

Returns the object in the form of hash



277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/dropbox-sign/models/report_response.rb', line 277

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



265
266
267
 
# File 'lib/dropbox-sign/models/report_response.rb', line 265

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



165
166
167
 
# File 'lib/dropbox-sign/models/report_response.rb', line 165

def valid?
  true
end