Class: AftershipAPI::Model::Pagination

Inherits:
Object
  • Object
show all
Defined in:
lib/aftership-tracking-sdk/models/pagination.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Pagination

Initializes the object

Parameters:

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

    Model attributes in the form of hash



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/aftership-tracking-sdk/models/pagination.rb', line 9

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `AftershipAPI::Pagination` initialize method"
  end

  attributes = attributes.each_with_object({}) { |(k, v), h|
    h[k.to_sym] = v
  }

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

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

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

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

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

end

Instance Attribute Details

#has_next_page ⇒ Object

Returns the value of attribute has_next_page.



6
7
8
 
# File 'lib/aftership-tracking-sdk/models/pagination.rb', line 6

def has_next_page
  @has_next_page
end

#limit ⇒ Object

Returns the value of attribute limit.



6
7
8
 
# File 'lib/aftership-tracking-sdk/models/pagination.rb', line 6

def limit
  @limit
end

#next_cursor ⇒ Object

Returns the value of attribute next_cursor.



6
7
8
 
# File 'lib/aftership-tracking-sdk/models/pagination.rb', line 6

def next_cursor
  @next_cursor
end

#page ⇒ Object

Returns the value of attribute page.



6
7
8
 
# File 'lib/aftership-tracking-sdk/models/pagination.rb', line 6

def page
  @page
end

#total ⇒ Object

Returns the value of attribute total.



6
7
8
 
# File 'lib/aftership-tracking-sdk/models/pagination.rb', line 6

def total
  @total
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type (String) —

    Data type

  • value (String) —

    Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
107
108
109
110
111
112
113
114
 
# File 'lib/aftership-tracking-sdk/models/pagination.rb', line 78

def self._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 = AftershipAPI::Model.const_get(type)
    klass.build_from_hash(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



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/aftership-tracking-sdk/models/pagination.rb', line 54

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?(key) && attributes[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[key].is_a?(Array)
        transformed_hash["#{key}"] = attributes[key].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[key].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[key])
    end
  end
  new(transformed_hash)
end

.openapi_types ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
48
49
 
# File 'lib/aftership-tracking-sdk/models/pagination.rb', line 41

def self.openapi_types
  {
    :'total' => :'Integer',
		:'page' => :'Integer',
		:'limit' => :'Integer',
		:'has_next_page' => :'Boolean',
    :'next_cursor' => :'String'
  }
end

Instance Method Details

#_to_hash(value) ⇒ 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



145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/aftership-tracking-sdk/models/pagination.rb', line 145

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



124
125
126
 
# File 'lib/aftership-tracking-sdk/models/pagination.rb', line 124

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



130
131
132
133
134
135
136
137
138
139
 
# File 'lib/aftership-tracking-sdk/models/pagination.rb', line 130

def to_hash
  hash = {}
  self.class.openapi_types.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?

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

#to_json(*a) ⇒ Object 



159
160
161
 
# File 'lib/aftership-tracking-sdk/models/pagination.rb', line 159

def to_json(*a)
  to_hash.to_json(*a)
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



118
119
120
 
# File 'lib/aftership-tracking-sdk/models/pagination.rb', line 118

def to_s
  to_hash.to_s
end