Class: NewStoreApi::TransferDocumentResponse

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/new_store_api/models/transfer_document_response.rb

Overview

TransferDocumentResponse Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(error = nil, permalink = nil) ⇒ TransferDocumentResponse

Returns a new instance of TransferDocumentResponse.



41
42
43
44
 
# File 'lib/new_store_api/models/transfer_document_response.rb', line 41

def initialize(error = nil, permalink = nil)
  @error = error
  @permalink = permalink
end

Instance Attribute Details

#error ⇒ Object

TODO: Write general description for this method

Returns:

  • (Object) 


14
15
16
 
# File 'lib/new_store_api/models/transfer_document_response.rb', line 14

def error
  @error
end

#permalink ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


18
19
20
 
# File 'lib/new_store_api/models/transfer_document_response.rb', line 18

def permalink
  @permalink
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/new_store_api/models/transfer_document_response.rb', line 47

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  error = hash.key?('error') ? hash['error'] : nil
  permalink = hash.key?('permalink') ? hash['permalink'] : nil

  # Create object from extracted values.
  TransferDocumentResponse.new(error,
                               permalink)
end

.names ⇒ Object

A mapping from model property names to API property names.



21
22
23
24
25
26
 
# File 'lib/new_store_api/models/transfer_document_response.rb', line 21

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['error'] = 'error'
  @_hash['permalink'] = 'permalink'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



34
35
36
37
38
39
 
# File 'lib/new_store_api/models/transfer_document_response.rb', line 34

def self.nullables
  %w[
    error
    permalink
  ]
end

.optionals ⇒ Object

An array for optional fields



29
30
31
 
# File 'lib/new_store_api/models/transfer_document_response.rb', line 29

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



66
67
68
69
 
# File 'lib/new_store_api/models/transfer_document_response.rb', line 66

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} error: #{@error.inspect}, permalink: #{@permalink.inspect}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



60
61
62
63
 
# File 'lib/new_store_api/models/transfer_document_response.rb', line 60

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} error: #{@error}, permalink: #{@permalink}>"
end