aftership-tracking-sdk 7.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (76) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +11 -0
  3. data/LICENSE +21 -0
  4. data/README.md +285 -0
  5. data/aftership-tracking-sdk.gemspec +27 -0
  6. data/lib/aftership-tracking-sdk/api/courier.rb +163 -0
  7. data/lib/aftership-tracking-sdk/api/estimated_delivery_date.rb +67 -0
  8. data/lib/aftership-tracking-sdk/api/last_checkpoint.rb +143 -0
  9. data/lib/aftership-tracking-sdk/api/notification.rb +403 -0
  10. data/lib/aftership-tracking-sdk/api/tracking.rb +793 -0
  11. data/lib/aftership-tracking-sdk/api_client.rb +426 -0
  12. data/lib/aftership-tracking-sdk/configuration.rb +122 -0
  13. data/lib/aftership-tracking-sdk/error.rb +125 -0
  14. data/lib/aftership-tracking-sdk/models/additional_fields_v1.rb +32 -0
  15. data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_tracking.rb +181 -0
  16. data/lib/aftership-tracking-sdk/models/carbon_emissions_tracking.rb +161 -0
  17. data/lib/aftership-tracking-sdk/models/checkpoint.rb +301 -0
  18. data/lib/aftership-tracking-sdk/models/coordinate_checkpoint.rb +161 -0
  19. data/lib/aftership-tracking-sdk/models/courier.rb +241 -0
  20. data/lib/aftership-tracking-sdk/models/courier_response_v1.rb +161 -0
  21. data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_tracking.rb +181 -0
  22. data/lib/aftership-tracking-sdk/models/custom_fields_tracking_update_tracking_by_slug_tracking_number_request.rb +139 -0
  23. data/lib/aftership-tracking-sdk/models/data_courier_response_v1.rb +161 -0
  24. data/lib/aftership-tracking-sdk/models/data_notification_response_v1.rb +151 -0
  25. data/lib/aftership-tracking-sdk/models/data_tracking_delete_response_v1.rb +151 -0
  26. data/lib/aftership-tracking-sdk/models/data_tracking_response_get_multiple_v1.rb +281 -0
  27. data/lib/aftership-tracking-sdk/models/data_tracking_response_v1.rb +151 -0
  28. data/lib/aftership-tracking-sdk/models/destination_address_estimated_delivery_date_request.rb +191 -0
  29. data/lib/aftership-tracking-sdk/models/destination_address_estimated_delivery_date_response.rb +191 -0
  30. data/lib/aftership-tracking-sdk/models/detect_courier_response.rb +161 -0
  31. data/lib/aftership-tracking-sdk/models/estimated_delivery_date_request.rb +221 -0
  32. data/lib/aftership-tracking-sdk/models/estimated_delivery_date_response.rb +261 -0
  33. data/lib/aftership-tracking-sdk/models/estimated_pickup_estimated_delivery_date_request.rb +181 -0
  34. data/lib/aftership-tracking-sdk/models/estimated_pickup_estimated_delivery_date_response.rb +191 -0
  35. data/lib/aftership-tracking-sdk/models/events_checkpoint.rb +161 -0
  36. data/lib/aftership-tracking-sdk/models/first_estimated_delivery_tracking.rb +191 -0
  37. data/lib/aftership-tracking-sdk/models/get_all_couriers_response.rb +161 -0
  38. data/lib/aftership-tracking-sdk/models/get_checkpoint_by_slug_tracking_number_response.rb +211 -0
  39. data/lib/aftership-tracking-sdk/models/get_checkpoint_by_tracking_id_response.rb +211 -0
  40. data/lib/aftership-tracking-sdk/models/get_trackings_response.rb +161 -0
  41. data/lib/aftership-tracking-sdk/models/get_user_couriers_response.rb +161 -0
  42. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_tracking.rb +191 -0
  43. data/lib/aftership-tracking-sdk/models/mark_tracking_completed_by_id_request.rb +151 -0
  44. data/lib/aftership-tracking-sdk/models/mark_tracking_completed_by_slug_tracking_number_request.rb +151 -0
  45. data/lib/aftership-tracking-sdk/models/meta_v1.rb +171 -0
  46. data/lib/aftership-tracking-sdk/models/next_couriers_tracking.rb +171 -0
  47. data/lib/aftership-tracking-sdk/models/next_couriers_tracking_create_tracking_request.rb +161 -0
  48. data/lib/aftership-tracking-sdk/models/notification.rb +161 -0
  49. data/lib/aftership-tracking-sdk/models/notification_request_v1.rb +161 -0
  50. data/lib/aftership-tracking-sdk/models/notification_response_v1.rb +161 -0
  51. data/lib/aftership-tracking-sdk/models/order_processing_time_estimated_pickup_estimated_delivery_date_request.rb +161 -0
  52. data/lib/aftership-tracking-sdk/models/order_processing_time_estimated_pickup_estimated_delivery_date_response.rb +161 -0
  53. data/lib/aftership-tracking-sdk/models/origin_address_estimated_delivery_date_request.rb +191 -0
  54. data/lib/aftership-tracking-sdk/models/origin_address_estimated_delivery_date_response.rb +191 -0
  55. data/lib/aftership-tracking-sdk/models/pagination.rb +156 -0
  56. data/lib/aftership-tracking-sdk/models/partial_delete_tracking.rb +241 -0
  57. data/lib/aftership-tracking-sdk/models/partial_update_tracking.rb +251 -0
  58. data/lib/aftership-tracking-sdk/models/predict_batch_request.rb +151 -0
  59. data/lib/aftership-tracking-sdk/models/predict_batch_response.rb +151 -0
  60. data/lib/aftership-tracking-sdk/models/reason_events_checkpoint.rb +151 -0
  61. data/lib/aftership-tracking-sdk/models/slug_group_v1.rb +37 -0
  62. data/lib/aftership-tracking-sdk/models/tag_v1.rb +34 -0
  63. data/lib/aftership-tracking-sdk/models/tracking.rb +921 -0
  64. data/lib/aftership-tracking-sdk/models/tracking_create_tracking_request.rb +551 -0
  65. data/lib/aftership-tracking-sdk/models/tracking_delete_response_v1.rb +161 -0
  66. data/lib/aftership-tracking-sdk/models/tracking_detect_courier_request.rb +261 -0
  67. data/lib/aftership-tracking-sdk/models/tracking_response_get_multiple_v1.rb +161 -0
  68. data/lib/aftership-tracking-sdk/models/tracking_response_v1.rb +161 -0
  69. data/lib/aftership-tracking-sdk/models/tracking_update_tracking_by_id_request.rb +501 -0
  70. data/lib/aftership-tracking-sdk/models/tracking_update_tracking_by_slug_tracking_number_request.rb +391 -0
  71. data/lib/aftership-tracking-sdk/models/weight_estimated_delivery_date_request.rb +161 -0
  72. data/lib/aftership-tracking-sdk/models/weight_estimated_delivery_date_response.rb +161 -0
  73. data/lib/aftership-tracking-sdk/sign_string.rb +77 -0
  74. data/lib/aftership-tracking-sdk/version.rb +5 -0
  75. data/lib/aftership-tracking-sdk.rb +47 -0
  76. metadata +157 -0
@@ -0,0 +1,151 @@
1
+ # This code was auto generated by AfterShip SDK Generator.
2
+ # Do not edit the class manually.
3
+ module AftershipAPI::Model
4
+ class PredictBatchResponse
5
+ #
6
+ # estimated_delivery_dates: EstimatedDeliveryDateResponse[];
7
+ attr_accessor :estimated_delivery_dates
8
+
9
+ # Initializes the object
10
+ # @param [Hash] attributes Model attributes in the form of hash
11
+ def initialize(attributes = {})
12
+ if (!attributes.is_a?(Hash))
13
+ fail ArgumentError, "The input argument (attributes) must be a hash in `AftershipAPI::PredictBatchResponse` initialize method"
14
+ end
15
+
16
+ attributes = attributes.each_with_object({}) { |(k, v), h|
17
+ h[k.to_sym] = v
18
+ }
19
+
20
+ if attributes.key?(:'estimated_delivery_dates')
21
+ self.estimated_delivery_dates = attributes[:'estimated_delivery_dates']
22
+ end
23
+ end
24
+
25
+ # Attribute type mapping.
26
+ def self.openapi_types
27
+ {
28
+ :'estimated_delivery_dates' => :'Array<EstimatedDeliveryDateResponse>',
29
+ }
30
+ end
31
+
32
+ # Attribute mapping from ruby-style variable name to JSON key.
33
+ def self.attribute_map
34
+ {
35
+ :'estimated_delivery_dates' => :'estimated_delivery_dates',
36
+ }
37
+ end
38
+
39
+ # Builds the object from hash
40
+ # @param attributes [Hash] Model attributes in the form of hash
41
+ # @return [Object] Returns the model itself
42
+ def self.build_from_hash(attributes)
43
+ return nil unless attributes.is_a?(Hash)
44
+ attributes = attributes.transform_keys(&:to_sym)
45
+ transformed_hash = {}
46
+ openapi_types.each_pair do |key, type|
47
+ if attributes.key?(key) && attributes[key].nil?
48
+ transformed_hash["#{key}"] = nil
49
+ elsif type =~ /\AArray<(.*)>/i
50
+ # check to ensure the input is an array given that the attribute
51
+ # is documented as an array but the input is not
52
+ if attributes[key].is_a?(Array)
53
+ transformed_hash["#{key}"] = attributes[key].map { |v| _deserialize($1, v) }
54
+ end
55
+ elsif !attributes[key].nil?
56
+ transformed_hash["#{key}"] = _deserialize(type, attributes[key])
57
+ end
58
+ end
59
+ new(transformed_hash)
60
+ end
61
+
62
+ # Deserializes the data based on type
63
+ # @param type [String] Data type
64
+ # @param value [String] Value to be deserialized
65
+ # @return [Object] Deserialized data
66
+ def self._deserialize(type, value)
67
+ case type.to_sym
68
+ when :Time
69
+ Time.parse(value)
70
+ when :Date
71
+ Date.parse(value)
72
+ when :String
73
+ value.to_s
74
+ when :Integer
75
+ value.to_i
76
+ when :Float
77
+ value.to_f
78
+ when :Boolean
79
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
80
+ true
81
+ else
82
+ false
83
+ end
84
+ when :Object
85
+ # generic object (usually a Hash), return directly
86
+ value
87
+ when /\AArray<(?<inner_type>.+)>\z/
88
+ inner_type = Regexp.last_match[:inner_type]
89
+ value.map { |v| _deserialize(inner_type, v) }
90
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
91
+ k_type = Regexp.last_match[:k_type]
92
+ v_type = Regexp.last_match[:v_type]
93
+ {}.tap do |hash|
94
+ value.each do |k, v|
95
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
96
+ end
97
+ end
98
+ else # model
99
+ klass = AftershipAPI::Model.const_get(type)
100
+ klass.build_from_hash(value)
101
+ end
102
+ end
103
+
104
+ # Returns the string representation of the object
105
+ # @return [String] String presentation of the object
106
+ def to_s
107
+ to_hash.to_s
108
+ end
109
+
110
+ # to_body is an alias to to_hash (backward compatibility)
111
+ # @return [Hash] Returns the object in the form of hash
112
+ def to_body
113
+ to_hash
114
+ end
115
+
116
+ # Returns the object in the form of hash
117
+ # @return [Hash] Returns the object in the form of hash
118
+ def to_hash
119
+ hash = {}
120
+ self.class.attribute_map.each_pair do |attr, param|
121
+ value = self.send(attr)
122
+ next if value.nil?
123
+
124
+ hash[param] = _to_hash(value)
125
+ end
126
+ hash
127
+ end
128
+
129
+ # Outputs non-array value in the form of hash
130
+ # For object, use to_hash. Otherwise, just return the value
131
+ # @param value [Object] Any valid value
132
+ # @return [Hash] Returns the value in the form of hash
133
+ def _to_hash(value)
134
+ if value.is_a?(Array)
135
+ value.compact.map { |v| _to_hash(v) }
136
+ elsif value.is_a?(Hash)
137
+ {}.tap do |hash|
138
+ value.each { |k, v| hash[k] = _to_hash(v) }
139
+ end
140
+ elsif value.respond_to? :to_hash
141
+ value.to_hash
142
+ else
143
+ value
144
+ end
145
+ end
146
+
147
+ def to_json(*a)
148
+ to_hash.to_json(*a)
149
+ end
150
+ end
151
+ end
@@ -0,0 +1,151 @@
1
+ # This code was auto generated by AfterShip SDK Generator.
2
+ # Do not edit the class manually.
3
+ module AftershipAPI::Model
4
+ class ReasonEventsCheckpoint
5
+ # The code of the reason.
6
+ # code?: String;
7
+ attr_accessor :code
8
+
9
+ # Initializes the object
10
+ # @param [Hash] attributes Model attributes in the form of hash
11
+ def initialize(attributes = {})
12
+ if (!attributes.is_a?(Hash))
13
+ fail ArgumentError, "The input argument (attributes) must be a hash in `AftershipAPI::ReasonEventsCheckpoint` initialize method"
14
+ end
15
+
16
+ attributes = attributes.each_with_object({}) { |(k, v), h|
17
+ h[k.to_sym] = v
18
+ }
19
+
20
+ if attributes.key?(:'code')
21
+ self.code = attributes[:'code']
22
+ end
23
+ end
24
+
25
+ # Attribute type mapping.
26
+ def self.openapi_types
27
+ {
28
+ :'code' => :'String',
29
+ }
30
+ end
31
+
32
+ # Attribute mapping from ruby-style variable name to JSON key.
33
+ def self.attribute_map
34
+ {
35
+ :'code' => :'code',
36
+ }
37
+ end
38
+
39
+ # Builds the object from hash
40
+ # @param attributes [Hash] Model attributes in the form of hash
41
+ # @return [Object] Returns the model itself
42
+ def self.build_from_hash(attributes)
43
+ return nil unless attributes.is_a?(Hash)
44
+ attributes = attributes.transform_keys(&:to_sym)
45
+ transformed_hash = {}
46
+ openapi_types.each_pair do |key, type|
47
+ if attributes.key?(key) && attributes[key].nil?
48
+ transformed_hash["#{key}"] = nil
49
+ elsif type =~ /\AArray<(.*)>/i
50
+ # check to ensure the input is an array given that the attribute
51
+ # is documented as an array but the input is not
52
+ if attributes[key].is_a?(Array)
53
+ transformed_hash["#{key}"] = attributes[key].map { |v| _deserialize($1, v) }
54
+ end
55
+ elsif !attributes[key].nil?
56
+ transformed_hash["#{key}"] = _deserialize(type, attributes[key])
57
+ end
58
+ end
59
+ new(transformed_hash)
60
+ end
61
+
62
+ # Deserializes the data based on type
63
+ # @param type [String] Data type
64
+ # @param value [String] Value to be deserialized
65
+ # @return [Object] Deserialized data
66
+ def self._deserialize(type, value)
67
+ case type.to_sym
68
+ when :Time
69
+ Time.parse(value)
70
+ when :Date
71
+ Date.parse(value)
72
+ when :String
73
+ value.to_s
74
+ when :Integer
75
+ value.to_i
76
+ when :Float
77
+ value.to_f
78
+ when :Boolean
79
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
80
+ true
81
+ else
82
+ false
83
+ end
84
+ when :Object
85
+ # generic object (usually a Hash), return directly
86
+ value
87
+ when /\AArray<(?<inner_type>.+)>\z/
88
+ inner_type = Regexp.last_match[:inner_type]
89
+ value.map { |v| _deserialize(inner_type, v) }
90
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
91
+ k_type = Regexp.last_match[:k_type]
92
+ v_type = Regexp.last_match[:v_type]
93
+ {}.tap do |hash|
94
+ value.each do |k, v|
95
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
96
+ end
97
+ end
98
+ else # model
99
+ klass = AftershipAPI::Model.const_get(type)
100
+ klass.build_from_hash(value)
101
+ end
102
+ end
103
+
104
+ # Returns the string representation of the object
105
+ # @return [String] String presentation of the object
106
+ def to_s
107
+ to_hash.to_s
108
+ end
109
+
110
+ # to_body is an alias to to_hash (backward compatibility)
111
+ # @return [Hash] Returns the object in the form of hash
112
+ def to_body
113
+ to_hash
114
+ end
115
+
116
+ # Returns the object in the form of hash
117
+ # @return [Hash] Returns the object in the form of hash
118
+ def to_hash
119
+ hash = {}
120
+ self.class.attribute_map.each_pair do |attr, param|
121
+ value = self.send(attr)
122
+ next if value.nil?
123
+
124
+ hash[param] = _to_hash(value)
125
+ end
126
+ hash
127
+ end
128
+
129
+ # Outputs non-array value in the form of hash
130
+ # For object, use to_hash. Otherwise, just return the value
131
+ # @param value [Object] Any valid value
132
+ # @return [Hash] Returns the value in the form of hash
133
+ def _to_hash(value)
134
+ if value.is_a?(Array)
135
+ value.compact.map { |v| _to_hash(v) }
136
+ elsif value.is_a?(Hash)
137
+ {}.tap do |hash|
138
+ value.each { |k, v| hash[k] = _to_hash(v) }
139
+ end
140
+ elsif value.respond_to? :to_hash
141
+ value.to_hash
142
+ else
143
+ value
144
+ end
145
+ end
146
+
147
+ def to_json(*a)
148
+ to_hash.to_json(*a)
149
+ end
150
+ end
151
+ end
@@ -0,0 +1,37 @@
1
+ # This code was auto generated by AfterShip SDK Generator.
2
+ # Do not edit the class manually.
3
+
4
+ module AftershipAPI::Model
5
+ class SlugGroupV1
6
+ AMAZON_GROUP = "amazon-group".freeze
7
+ FEDEX_GROUP = "fedex-group".freeze
8
+ TOLL_GROUP = "toll-group".freeze
9
+ TAQBIN_GROUP = "taqbin-group".freeze
10
+ TNT_GROUP = "tnt-group".freeze
11
+ CJ_GROUP = "cj-group".freeze
12
+ HERMES_GROUP = "hermes-group".freeze
13
+ DPD_GROUP = "dpd-group".freeze
14
+ GLS_GROUP = "gls-group".freeze
15
+ DHL_GROUP = "dhl-group".freeze
16
+ FASTWAY_GROUP = "fastway-group".freeze
17
+ ASENDIA_GROUP = "asendia-group".freeze
18
+ def self.all_vars
19
+ @all_vars ||= [AMAZON_GROUP, FEDEX_GROUP, TOLL_GROUP, TAQBIN_GROUP, TNT_GROUP, CJ_GROUP, HERMES_GROUP, DPD_GROUP, GLS_GROUP, DHL_GROUP, FASTWAY_GROUP, ASENDIA_GROUP,].freeze
20
+ end
21
+
22
+ # Builds the enum from string
23
+ # @param value [String] The enum value in the form of the string
24
+ # @return [String] The enum value
25
+ def self.build_from_hash(value)
26
+ new.build_from_hash(value)
27
+ end
28
+
29
+ # Builds the enum from string
30
+ # @param value [String] The enum value in the form of the string
31
+ # @return [String] The enum value
32
+ def build_from_hash(value)
33
+ return value if SlugGroupV1.all_vars.include?(value)
34
+ raise "Invalid ENUM value #{value} for class #SlugGroupV1"
35
+ end
36
+ end
37
+ end
@@ -0,0 +1,34 @@
1
+ # This code was auto generated by AfterShip SDK Generator.
2
+ # Do not edit the class manually.
3
+
4
+ module AftershipAPI::Model
5
+ class TagV1
6
+ PENDING = "Pending".freeze
7
+ INFORECEIVED = "InfoReceived".freeze
8
+ INTRANSIT = "InTransit".freeze
9
+ OUTFORDELIVERY = "OutForDelivery".freeze
10
+ ATTEMPTFAIL = "AttemptFail".freeze
11
+ DELIVERED = "Delivered".freeze
12
+ AVAILABLEFORPICKUP = "AvailableForPickup".freeze
13
+ EXCEPTION = "Exception".freeze
14
+ EXPIRED = "Expired".freeze
15
+ def self.all_vars
16
+ @all_vars ||= [PENDING, INFORECEIVED, INTRANSIT, OUTFORDELIVERY, ATTEMPTFAIL, DELIVERED, AVAILABLEFORPICKUP, EXCEPTION, EXPIRED,].freeze
17
+ end
18
+
19
+ # Builds the enum from string
20
+ # @param value [String] The enum value in the form of the string
21
+ # @return [String] The enum value
22
+ def self.build_from_hash(value)
23
+ new.build_from_hash(value)
24
+ end
25
+
26
+ # Builds the enum from string
27
+ # @param value [String] The enum value in the form of the string
28
+ # @return [String] The enum value
29
+ def build_from_hash(value)
30
+ return value if TagV1.all_vars.include?(value)
31
+ raise "Invalid ENUM value #{value} for class #TagV1"
32
+ end
33
+ end
34
+ end