Class: Zernio::RespondToPhoneNumberReviewerRequestDocumentsInner

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/zernio-sdk/models/respond_to_phone_number_reviewer_request_documents_inner.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ RespondToPhoneNumberReviewerRequestDocumentsInner

Initializes the object

Parameters:

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

    Model attributes in the form of hash



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/zernio-sdk/models/respond_to_phone_number_reviewer_request_documents_inner.rb', line 71

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::RespondToPhoneNumberReviewerRequestDocumentsInner` 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 (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::RespondToPhoneNumberReviewerRequestDocumentsInner`. 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?(:'requirement_id')
    self.requirement_id = attributes[:'requirement_id']
  else
    self.requirement_id = nil
  end

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

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

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

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

Instance Attribute Details

#base64 ⇒ Object

Base64-encoded file bytes (or supply documentId instead).



23
24
25
 
# File 'lib/zernio-sdk/models/respond_to_phone_number_reviewer_request_documents_inner.rb', line 23

def base64
  @base64
end

#document_id ⇒ Object

Id of a document already uploaded out-of-band.



26
27
28
 
# File 'lib/zernio-sdk/models/respond_to_phone_number_reviewer_request_documents_inner.rb', line 26

def document_id
  @document_id
end

#filename ⇒ Object

Returns the value of attribute filename.



20
21
22
 
# File 'lib/zernio-sdk/models/respond_to_phone_number_reviewer_request_documents_inner.rb', line 20

def filename
  @filename
end

#issued_at ⇒ Object

Date printed on the document (YYYY-MM-DD), for slots the regulator windows such as proof of address. The pre-submit review trusts it over its own read of the PDF.



29
30
31
 
# File 'lib/zernio-sdk/models/respond_to_phone_number_reviewer_request_documents_inner.rb', line 29

def issued_at
  @issued_at
end

#requirement_id ⇒ Object

Returns the value of attribute requirement_id.



18
19
20
 
# File 'lib/zernio-sdk/models/respond_to_phone_number_reviewer_request_documents_inner.rb', line 18

def requirement_id
  @requirement_id
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



43
44
45
 
# File 'lib/zernio-sdk/models/respond_to_phone_number_reviewer_request_documents_inner.rb', line 43

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



48
49
50
 
# File 'lib/zernio-sdk/models/respond_to_phone_number_reviewer_request_documents_inner.rb', line 48

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
40
 
# File 'lib/zernio-sdk/models/respond_to_phone_number_reviewer_request_documents_inner.rb', line 32

def self.attribute_map
  {
    :'requirement_id' => :'requirementId',
    :'filename' => :'filename',
    :'base64' => :'base64',
    :'document_id' => :'documentId',
    :'issued_at' => :'issuedAt'
  }
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



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/zernio-sdk/models/respond_to_phone_number_reviewer_request_documents_inner.rb', line 165

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



64
65
66
67
 
# File 'lib/zernio-sdk/models/respond_to_phone_number_reviewer_request_documents_inner.rb', line 64

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

.openapi_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
 
# File 'lib/zernio-sdk/models/respond_to_phone_number_reviewer_request_documents_inner.rb', line 53

def self.openapi_types
  {
    :'requirement_id' => :'String',
    :'filename' => :'String',
    :'base64' => :'String',
    :'document_id' => :'String',
    :'issued_at' => :'Date'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



140
141
142
143
144
145
146
147
148
 
# File 'lib/zernio-sdk/models/respond_to_phone_number_reviewer_request_documents_inner.rb', line 140

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      requirement_id == o.requirement_id &&
      filename == o.filename &&
      base64 == o.base64 &&
      document_id == o.document_id &&
      issued_at == o.issued_at
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


152
153
154
 
# File 'lib/zernio-sdk/models/respond_to_phone_number_reviewer_request_documents_inner.rb', line 152

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



158
159
160
 
# File 'lib/zernio-sdk/models/respond_to_phone_number_reviewer_request_documents_inner.rb', line 158

def hash
  [requirement_id, filename, base64, document_id, issued_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



110
111
112
113
114
115
116
117
118
 
# File 'lib/zernio-sdk/models/respond_to_phone_number_reviewer_request_documents_inner.rb', line 110

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @requirement_id.nil?
    invalid_properties.push('invalid value for "requirement_id", requirement_id cannot be nil.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/zernio-sdk/models/respond_to_phone_number_reviewer_request_documents_inner.rb', line 187

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



122
123
124
125
126
 
# File 'lib/zernio-sdk/models/respond_to_phone_number_reviewer_request_documents_inner.rb', line 122

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @requirement_id.nil?
  true
end