Class: AftershipAPI::Model::NextCouriersCreateTrackingResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NextCouriersCreateTrackingResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/aftership-tracking-sdk/models/next_couriers_create_tracking_response.rb', line 28

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

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

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

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

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

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

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

Instance Attribute Details

The field provides the link for modifying delivery instructions (such as delivery date and shipping address) if supported by the next carrier. The language parameter of this link is determined by the destination country/region and the language associated with the shipment. If the data related to the destination country/region and the shipment’s language is unavailable, AfterShip will default the language parameter of the link to “US”. courier_redirect_link?: String;



24
25
26
 
# File 'lib/aftership-tracking-sdk/models/next_couriers_create_tracking_response.rb', line 24

def courier_redirect_link
  @courier_redirect_link
end

#courier_tracking_link ⇒ Object

The field contains the official tracking URL of the next courier, if available. The language parameter of this link is determined by the destination country/region and the language associated with the shipment. If the data related to the destination country/region and the shipment’s language is unavailable, AfterShip will default the language parameter of the link to “US”. courier_tracking_link?: String;



20
21
22
 
# File 'lib/aftership-tracking-sdk/models/next_couriers_create_tracking_response.rb', line 20

def courier_tracking_link
  @courier_tracking_link
end

#slug ⇒ Object

Unique code of courier. Get courier slug: String;



8
9
10
 
# File 'lib/aftership-tracking-sdk/models/next_couriers_create_tracking_response.rb', line 8

def slug
  @slug
end

#source ⇒ Object

Source of next couriers. source?: String;



16
17
18
 
# File 'lib/aftership-tracking-sdk/models/next_couriers_create_tracking_response.rb', line 16

def source
  @source
end

#tracking_number ⇒ Object

Tracking number. tracking_number: String;



12
13
14
 
# File 'lib/aftership-tracking-sdk/models/next_couriers_create_tracking_response.rb', line 12

def tracking_number
  @tracking_number
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



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/aftership-tracking-sdk/models/next_couriers_create_tracking_response.rb', line 107

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

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
 
# File 'lib/aftership-tracking-sdk/models/next_couriers_create_tracking_response.rb', line 70

def self.attribute_map
  {
    :'slug' => :'slug',
    :'tracking_number' => :'tracking_number',
    :'source' => :'source',
    :'courier_tracking_link' => :'courier_tracking_link',
    :'courier_redirect_link' => :'courier_redirect_link',
  }
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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/aftership-tracking-sdk/models/next_couriers_create_tracking_response.rb', line 83

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.



59
60
61
62
63
64
65
66
67
 
# File 'lib/aftership-tracking-sdk/models/next_couriers_create_tracking_response.rb', line 59

def self.openapi_types
  {
    :'slug' => :'String',
    :'tracking_number' => :'String',
    :'source' => :'String',
    :'courier_tracking_link' => :'String',
    :'courier_redirect_link' => :'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



174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/aftership-tracking-sdk/models/next_couriers_create_tracking_response.rb', line 174

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



153
154
155
 
# File 'lib/aftership-tracking-sdk/models/next_couriers_create_tracking_response.rb', line 153

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



159
160
161
162
163
164
165
166
167
168
 
# File 'lib/aftership-tracking-sdk/models/next_couriers_create_tracking_response.rb', line 159

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

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

#to_json(*a) ⇒ Object 



188
189
190
 
# File 'lib/aftership-tracking-sdk/models/next_couriers_create_tracking_response.rb', line 188

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



147
148
149
 
# File 'lib/aftership-tracking-sdk/models/next_couriers_create_tracking_response.rb', line 147

def to_s
  to_hash.to_s
end