Class: Dropbox::Sign::BulkSendJobResponse

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

Overview

Contains information about the BulkSendJob such as when it was created and how many signature requests are queued.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BulkSendJobResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/dropbox-sign/models/bulk_send_job_response.rb', line 97

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

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

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

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

Instance Attribute Details

#bulk_send_job_id ⇒ String?

The id of the BulkSendJob.

Returns:

  • (String, nil) 


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

def bulk_send_job_id
  @bulk_send_job_id
end

#created_at ⇒ Integer

Time that the BulkSendJob was created.

Returns:

  • (Integer) 


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

def created_at
  @created_at
end

#is_creator ⇒ Boolean

True if you are the owner of this BulkSendJob, false if it’s been shared with you by a team member.

Returns:

  • (Boolean) 


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

def is_creator
  @is_creator
end

#total ⇒ Integer

The total amount of Signature Requests queued for sending.

Returns:

  • (Integer) 


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

def total
  @total
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



49
50
51
 
# File 'lib/dropbox-sign/models/bulk_send_job_response.rb', line 49

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
 
# File 'lib/dropbox-sign/models/bulk_send_job_response.rb', line 39

def self.attribute_map
  {
    :'bulk_send_job_id' => :'bulk_send_job_id',
    :'total' => :'total',
    :'is_creator' => :'is_creator',
    :'created_at' => :'created_at'
  }
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



166
167
168
 
# File 'lib/dropbox-sign/models/bulk_send_job_response.rb', line 166

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

.init(data) ⇒ BulkSendJobResponse

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



88
89
90
91
92
93
 
# File 'lib/dropbox-sign/models/bulk_send_job_response.rb', line 88

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



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

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



81
82
83
 
# File 'lib/dropbox-sign/models/bulk_send_job_response.rb', line 81

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



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

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



64
65
66
67
68
 
# File 'lib/dropbox-sign/models/bulk_send_job_response.rb', line 64

def self.openapi_nullable
  Set.new([
    :'bulk_send_job_id',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
 
# File 'lib/dropbox-sign/models/bulk_send_job_response.rb', line 54

def self.openapi_types
  {
    :'bulk_send_job_id' => :'String',
    :'total' => :'Integer',
    :'is_creator' => :'Boolean',
    :'created_at' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



142
143
144
145
146
147
148
149
 
# File 'lib/dropbox-sign/models/bulk_send_job_response.rb', line 142

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      bulk_send_job_id == o.bulk_send_job_id &&
      total == o.total &&
      is_creator == o.is_creator &&
      created_at == o.created_at
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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/dropbox-sign/models/bulk_send_job_response.rb', line 196

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



267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/dropbox-sign/models/bulk_send_job_response.rb', line 267

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



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/dropbox-sign/models/bulk_send_job_response.rb', line 173

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


153
154
155
 
# File 'lib/dropbox-sign/models/bulk_send_job_response.rb', line 153

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [bulk_send_job_id, total, is_creator, created_at].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



129
130
131
132
 
# File 'lib/dropbox-sign/models/bulk_send_job_response.rb', line 129

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



242
243
244
 
# File 'lib/dropbox-sign/models/bulk_send_job_response.rb', line 242

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



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

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



236
237
238
 
# File 'lib/dropbox-sign/models/bulk_send_job_response.rb', line 236

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



136
137
138
 
# File 'lib/dropbox-sign/models/bulk_send_job_response.rb', line 136

def valid?
  true
end