Class: Dropbox::Sign::FaxSendRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FaxSendRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#cover_page_from ⇒ String

Fax cover page sender information

Returns:

  • (String) 


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

def cover_page_from
  @cover_page_from
end

#cover_page_message ⇒ String

Fax Cover Page Message

Returns:

  • (String) 


51
52
53
 
# File 'lib/dropbox-sign/models/fax_send_request.rb', line 51

def cover_page_message
  @cover_page_message
end

#cover_page_to ⇒ String

Fax cover page recipient information

Returns:

  • (String) 


43
44
45
 
# File 'lib/dropbox-sign/models/fax_send_request.rb', line 43

def cover_page_to
  @cover_page_to
end

#file_urls ⇒ Array<String>

Use ‘file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint requires either files or file_urls[], but not both.

Returns:

  • (Array<String>) 


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

def file_urls
  @file_urls
end

#files ⇒ Array<File>

Use ‘files[]` to indicate the uploaded file(s) to fax This endpoint requires either files or file_urls[], but not both.

Returns:

  • (Array<File>) 


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

def files
  @files
end

#recipient ⇒ String

Recipient of the fax Can be a phone number in E.164 format or email address

Returns:

  • (String) 


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

def recipient
  @recipient
end

#sender ⇒ String

Fax Send From Sender (used only with fax number)

Returns:

  • (String) 


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

def sender
  @sender
end

#test_mode ⇒ Boolean

API Test Mode Setting

Returns:

  • (Boolean) 


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

def test_mode
  @test_mode
end

#title ⇒ String

Fax Title

Returns:

  • (String) 


55
56
57
 
# File 'lib/dropbox-sign/models/fax_send_request.rb', line 55

def title
  @title
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



73
74
75
 
# File 'lib/dropbox-sign/models/fax_send_request.rb', line 73

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'recipient' => :'recipient',
    :'sender' => :'sender',
    :'files' => :'files',
    :'file_urls' => :'file_urls',
    :'test_mode' => :'test_mode',
    :'cover_page_to' => :'cover_page_to',
    :'cover_page_from' => :'cover_page_from',
    :'cover_page_message' => :'cover_page_message',
    :'title' => :'title'
  }
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



246
247
248
 
# File 'lib/dropbox-sign/models/fax_send_request.rb', line 246

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

.init(data) ⇒ FaxSendRequest

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



121
122
123
124
125
126
 
# File 'lib/dropbox-sign/models/fax_send_request.rb', line 121

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



104
105
106
 
# File 'lib/dropbox-sign/models/fax_send_request.rb', line 104

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



114
115
116
 
# File 'lib/dropbox-sign/models/fax_send_request.rb', line 114

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



109
110
111
 
# File 'lib/dropbox-sign/models/fax_send_request.rb', line 109

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



98
99
100
101
 
# File 'lib/dropbox-sign/models/fax_send_request.rb', line 98

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

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/dropbox-sign/models/fax_send_request.rb', line 83

def self.openapi_types
  {
    :'recipient' => :'String',
    :'sender' => :'String',
    :'files' => :'Array<File>',
    :'file_urls' => :'Array<String>',
    :'test_mode' => :'Boolean',
    :'cover_page_to' => :'String',
    :'cover_page_from' => :'String',
    :'cover_page_message' => :'String',
    :'title' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/dropbox-sign/models/fax_send_request.rb', line 217

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      recipient == o.recipient &&
      sender == o.sender &&
      files == o.files &&
      file_urls == o.file_urls &&
      test_mode == o.test_mode &&
      cover_page_to == o.cover_page_to &&
      cover_page_from == o.cover_page_from &&
      cover_page_message == o.cover_page_message &&
      title == o.title
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



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/dropbox-sign/models/fax_send_request.rb', line 276

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



347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/dropbox-sign/models/fax_send_request.rb', line 347

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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/dropbox-sign/models/fax_send_request.rb', line 253

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



239
240
241
 
# File 'lib/dropbox-sign/models/fax_send_request.rb', line 239

def hash
  [recipient, sender, files, file_urls, test_mode, cover_page_to, cover_page_from, cover_page_message, title].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



189
190
191
192
193
194
195
196
 
# File 'lib/dropbox-sign/models/fax_send_request.rb', line 189

def list_invalid_properties
  invalid_properties = Array.new
  if @recipient.nil?
    invalid_properties.push('invalid value for "recipient", recipient 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



322
323
324
 
# File 'lib/dropbox-sign/models/fax_send_request.rb', line 322

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



328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/dropbox-sign/models/fax_send_request.rb', line 328

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



316
317
318
 
# File 'lib/dropbox-sign/models/fax_send_request.rb', line 316

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



200
201
202
203
 
# File 'lib/dropbox-sign/models/fax_send_request.rb', line 200

def valid?
  return false if @recipient.nil?
  true
end