Class: AftershipAPI::Model::PostCourierConnectionsRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostCourierConnectionsRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/aftership-tracking-sdk/models/post_courier_connections_request.rb', line 15

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

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

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

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

Instance Attribute Details

#courier_slug ⇒ Object

Unique code of courier. Get the slugs from . courier_slug: String;



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

def courier_slug
  @courier_slug
end

#credentials ⇒ Object

It refers to the authentication details required for each specific carrier details required for each specific carrier (such as API keys, username, password, etc.) that the user must provide to establish a carrier connection. The content varies by carrier. credentials: Object;



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

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



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

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.



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

def self.attribute_map
  {
    :'courier_slug' => :'courier_slug',
    :'credentials' => :'credentials',
  }
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



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

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.



34
35
36
37
38
39
 
# File 'lib/aftership-tracking-sdk/models/post_courier_connections_request.rb', line 34

def self.openapi_types
  {
    :'courier_slug' => :'String',
    :'credentials' => :'Object',
  }
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



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

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



122
123
124
 
# File 'lib/aftership-tracking-sdk/models/post_courier_connections_request.rb', line 122

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



128
129
130
131
132
133
134
135
136
137
 
# File 'lib/aftership-tracking-sdk/models/post_courier_connections_request.rb', line 128

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 



157
158
159
 
# File 'lib/aftership-tracking-sdk/models/post_courier_connections_request.rb', line 157

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



116
117
118
 
# File 'lib/aftership-tracking-sdk/models/post_courier_connections_request.rb', line 116

def to_s
  to_hash.to_s
end