boxx_client 1.4.1

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 (82) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +7 -0
  3. data/README.md +109 -0
  4. data/Rakefile +8 -0
  5. data/boxx_client.gemspec +46 -0
  6. data/dist/boxx_client-1.4.0.gem +0 -0
  7. data/dist/examples/upload_customer.rb +76 -0
  8. data/dist/examples/upload_product.rb +54 -0
  9. data/dist/examples/upload_transaction.rb +56 -0
  10. data/docs/DeleteAll.md +10 -0
  11. data/docs/DeleteAllApi.md +56 -0
  12. data/docs/DeleteSpecific.md +11 -0
  13. data/docs/DeleteSpecificApi.md +56 -0
  14. data/docs/InlineResponse200.md +9 -0
  15. data/docs/InlineResponse2001.md +9 -0
  16. data/docs/InlineResponse2001Response.md +9 -0
  17. data/docs/InlineResponse200Response.md +11 -0
  18. data/docs/InlineResponse400.md +9 -0
  19. data/docs/InlineResponse4001.md +9 -0
  20. data/docs/UploadCustomer.md +14 -0
  21. data/docs/UploadCustomerDeviceTokens.md +11 -0
  22. data/docs/UploadCustomerMobileTokens.md +10 -0
  23. data/docs/UploadCustomerRequest.md +11 -0
  24. data/docs/UploadDataApi.md +149 -0
  25. data/docs/UploadOkResponse.md +9 -0
  26. data/docs/UploadOkResponseResult.md +11 -0
  27. data/docs/UploadProduct.md +13 -0
  28. data/docs/UploadProductRequest.md +11 -0
  29. data/docs/UploadTransaction.md +16 -0
  30. data/docs/UploadTransactionRequest.md +11 -0
  31. data/git_push.sh +55 -0
  32. data/lib/boxx_client.rb +60 -0
  33. data/lib/boxx_client/api/delete_all_api.rb +78 -0
  34. data/lib/boxx_client/api/delete_specific_api.rb +78 -0
  35. data/lib/boxx_client/api/upload_data_api.rb +188 -0
  36. data/lib/boxx_client/api_client.rb +388 -0
  37. data/lib/boxx_client/api_error.rb +38 -0
  38. data/lib/boxx_client/configuration.rb +202 -0
  39. data/lib/boxx_client/models/delete_all.rb +224 -0
  40. data/lib/boxx_client/models/delete_specific.rb +241 -0
  41. data/lib/boxx_client/models/inline_response_200.rb +197 -0
  42. data/lib/boxx_client/models/inline_response_200_1.rb +197 -0
  43. data/lib/boxx_client/models/inline_response_200_1_response.rb +199 -0
  44. data/lib/boxx_client/models/inline_response_200_response.rb +217 -0
  45. data/lib/boxx_client/models/inline_response_400.rb +197 -0
  46. data/lib/boxx_client/models/inline_response_400_1.rb +197 -0
  47. data/lib/boxx_client/models/upload_customer.rb +255 -0
  48. data/lib/boxx_client/models/upload_customer_device_tokens.rb +215 -0
  49. data/lib/boxx_client/models/upload_customer_mobile_tokens.rb +206 -0
  50. data/lib/boxx_client/models/upload_customer_request.rb +236 -0
  51. data/lib/boxx_client/models/upload_ok_response.rb +197 -0
  52. data/lib/boxx_client/models/upload_ok_response_result.rb +217 -0
  53. data/lib/boxx_client/models/upload_product.rb +244 -0
  54. data/lib/boxx_client/models/upload_product_request.rb +236 -0
  55. data/lib/boxx_client/models/upload_transaction.rb +279 -0
  56. data/lib/boxx_client/models/upload_transaction_request.rb +236 -0
  57. data/lib/boxx_client/version.rb +15 -0
  58. data/spec/api/delete_all_api_spec.rb +47 -0
  59. data/spec/api/delete_specific_api_spec.rb +47 -0
  60. data/spec/api/upload_data_api_spec.rb +71 -0
  61. data/spec/api_client_spec.rb +226 -0
  62. data/spec/configuration_spec.rb +42 -0
  63. data/spec/models/delete_all_spec.rb +54 -0
  64. data/spec/models/delete_specific_spec.rb +60 -0
  65. data/spec/models/inline_response_200_1_response_spec.rb +48 -0
  66. data/spec/models/inline_response_200_1_spec.rb +48 -0
  67. data/spec/models/inline_response_200_response_spec.rb +60 -0
  68. data/spec/models/inline_response_200_spec.rb +48 -0
  69. data/spec/models/inline_response_400_1_spec.rb +48 -0
  70. data/spec/models/inline_response_400_spec.rb +48 -0
  71. data/spec/models/upload_customer_device_tokens_spec.rb +60 -0
  72. data/spec/models/upload_customer_mobile_tokens_spec.rb +54 -0
  73. data/spec/models/upload_customer_request_spec.rb +60 -0
  74. data/spec/models/upload_customer_spec.rb +78 -0
  75. data/spec/models/upload_ok_response_result_spec.rb +60 -0
  76. data/spec/models/upload_ok_response_spec.rb +48 -0
  77. data/spec/models/upload_product_request_spec.rb +60 -0
  78. data/spec/models/upload_product_spec.rb +72 -0
  79. data/spec/models/upload_transaction_request_spec.rb +60 -0
  80. data/spec/models/upload_transaction_spec.rb +90 -0
  81. data/spec/spec_helper.rb +111 -0
  82. metadata +327 -0
@@ -0,0 +1,236 @@
1
+ =begin
2
+ #Upload and Delete Data API
3
+
4
+ #Boxx.ai's customer, product and interaction data ingestion sdk
5
+
6
+ OpenAPI spec version: 1.4.1
7
+ Contact: aida@boxx.ai
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.3.1
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module BoxxClient
16
+ # upload product request
17
+ class UploadProductRequest
18
+ # client id of the user
19
+ attr_accessor :client_id
20
+
21
+ # access token of the user
22
+ attr_accessor :access_token
23
+
24
+ attr_accessor :data
25
+
26
+ attr_accessor :data_format
27
+
28
+
29
+ # Attribute mapping from ruby-style variable name to JSON key.
30
+ def self.attribute_map
31
+ {
32
+ :'client_id' => :'client_id',
33
+ :'access_token' => :'access_token',
34
+ :'data' => :'data',
35
+ :'data_format' => :'data_format'
36
+ }
37
+ end
38
+
39
+ # Attribute type mapping.
40
+ def self.swagger_types
41
+ {
42
+ :'client_id' => :'String',
43
+ :'access_token' => :'String',
44
+ :'data' => :'Array<UploadProduct>',
45
+ :'data_format' => :'Hash<String, String>'
46
+ }
47
+ end
48
+
49
+ # Initializes the object
50
+ # @param [Hash] attributes Model attributes in the form of hash
51
+ def initialize(attributes = {})
52
+ return unless attributes.is_a?(Hash)
53
+
54
+ # convert string to symbol for hash key
55
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
56
+
57
+ if attributes.has_key?(:'client_id')
58
+ self.client_id = attributes[:'client_id']
59
+ end
60
+
61
+ if attributes.has_key?(:'access_token')
62
+ self.access_token = attributes[:'access_token']
63
+ end
64
+
65
+ if attributes.has_key?(:'data')
66
+ if (value = attributes[:'data']).is_a?(Array)
67
+ self.data = value
68
+ end
69
+ end
70
+
71
+ if attributes.has_key?(:'data_format')
72
+ if (value = attributes[:'data_format']).is_a?(Hash)
73
+ self.data_format = value
74
+ end
75
+ end
76
+
77
+ end
78
+
79
+ # Show invalid properties with the reasons. Usually used together with valid?
80
+ # @return Array for valid properties with the reasons
81
+ def list_invalid_properties
82
+ invalid_properties = Array.new
83
+ if @client_id.nil?
84
+ invalid_properties.push("invalid value for 'client_id', client_id cannot be nil.")
85
+ end
86
+
87
+ if @access_token.nil?
88
+ invalid_properties.push("invalid value for 'access_token', access_token cannot be nil.")
89
+ end
90
+
91
+ if @data.nil?
92
+ invalid_properties.push("invalid value for 'data', data cannot be nil.")
93
+ end
94
+
95
+ return invalid_properties
96
+ end
97
+
98
+ # Check to see if the all the properties in the model are valid
99
+ # @return true if the model is valid
100
+ def valid?
101
+ return false if @client_id.nil?
102
+ return false if @access_token.nil?
103
+ return false if @data.nil?
104
+ return true
105
+ end
106
+
107
+ # Checks equality by comparing each attribute.
108
+ # @param [Object] Object to be compared
109
+ def ==(o)
110
+ return true if self.equal?(o)
111
+ self.class == o.class &&
112
+ client_id == o.client_id &&
113
+ access_token == o.access_token &&
114
+ data == o.data &&
115
+ data_format == o.data_format
116
+ end
117
+
118
+ # @see the `==` method
119
+ # @param [Object] Object to be compared
120
+ def eql?(o)
121
+ self == o
122
+ end
123
+
124
+ # Calculates hash code according to all attributes.
125
+ # @return [Fixnum] Hash code
126
+ def hash
127
+ [client_id, access_token, data, data_format].hash
128
+ end
129
+
130
+ # Builds the object from hash
131
+ # @param [Hash] attributes Model attributes in the form of hash
132
+ # @return [Object] Returns the model itself
133
+ def build_from_hash(attributes)
134
+ return nil unless attributes.is_a?(Hash)
135
+ self.class.swagger_types.each_pair do |key, type|
136
+ if type =~ /\AArray<(.*)>/i
137
+ # check to ensure the input is an array given that the the attribute
138
+ # is documented as an array but the input is not
139
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
140
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
141
+ end
142
+ elsif !attributes[self.class.attribute_map[key]].nil?
143
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
144
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
145
+ end
146
+
147
+ self
148
+ end
149
+
150
+ # Deserializes the data based on type
151
+ # @param string type Data type
152
+ # @param string value Value to be deserialized
153
+ # @return [Object] Deserialized data
154
+ def _deserialize(type, value)
155
+ case type.to_sym
156
+ when :DateTime
157
+ DateTime.parse(value)
158
+ when :Date
159
+ Date.parse(value)
160
+ when :String
161
+ value.to_s
162
+ when :Integer
163
+ value.to_i
164
+ when :Float
165
+ value.to_f
166
+ when :BOOLEAN
167
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
168
+ true
169
+ else
170
+ false
171
+ end
172
+ when :Object
173
+ # generic object (usually a Hash), return directly
174
+ value
175
+ when /\AArray<(?<inner_type>.+)>\z/
176
+ inner_type = Regexp.last_match[:inner_type]
177
+ value.map { |v| _deserialize(inner_type, v) }
178
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
179
+ k_type = Regexp.last_match[:k_type]
180
+ v_type = Regexp.last_match[:v_type]
181
+ {}.tap do |hash|
182
+ value.each do |k, v|
183
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
184
+ end
185
+ end
186
+ else # model
187
+ temp_model = BoxxClient.const_get(type).new
188
+ temp_model.build_from_hash(value)
189
+ end
190
+ end
191
+
192
+ # Returns the string representation of the object
193
+ # @return [String] String presentation of the object
194
+ def to_s
195
+ to_hash.to_s
196
+ end
197
+
198
+ # to_body is an alias to to_hash (backward compatibility)
199
+ # @return [Hash] Returns the object in the form of hash
200
+ def to_body
201
+ to_hash
202
+ end
203
+
204
+ # Returns the object in the form of hash
205
+ # @return [Hash] Returns the object in the form of hash
206
+ def to_hash
207
+ hash = {}
208
+ self.class.attribute_map.each_pair do |attr, param|
209
+ value = self.send(attr)
210
+ next if value.nil?
211
+ hash[param] = _to_hash(value)
212
+ end
213
+ hash
214
+ end
215
+
216
+ # Outputs non-array value in the form of hash
217
+ # For object, use to_hash. Otherwise, just return the value
218
+ # @param [Object] value Any valid value
219
+ # @return [Hash] Returns the value in the form of hash
220
+ def _to_hash(value)
221
+ if value.is_a?(Array)
222
+ value.compact.map{ |v| _to_hash(v) }
223
+ elsif value.is_a?(Hash)
224
+ {}.tap do |hash|
225
+ value.each { |k, v| hash[k] = _to_hash(v) }
226
+ end
227
+ elsif value.respond_to? :to_hash
228
+ value.to_hash
229
+ else
230
+ value
231
+ end
232
+ end
233
+
234
+ end
235
+
236
+ end
@@ -0,0 +1,279 @@
1
+ =begin
2
+ #Upload and Delete Data API
3
+
4
+ #Boxx.ai's customer, product and interaction data ingestion sdk
5
+
6
+ OpenAPI spec version: 1.4.1
7
+ Contact: aida@boxx.ai
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.3.1
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module BoxxClient
16
+ # Upload data transaction schema
17
+ class UploadTransaction
18
+ attr_accessor :customerid
19
+
20
+ attr_accessor :cookieid
21
+
22
+ attr_accessor :boxx_token_id
23
+
24
+ attr_accessor :properties
25
+
26
+ attr_accessor :transactionid
27
+
28
+ attr_accessor :productid
29
+
30
+ attr_accessor :type
31
+
32
+ attr_accessor :transactiondate
33
+
34
+ attr_accessor :location
35
+
36
+
37
+ # Attribute mapping from ruby-style variable name to JSON key.
38
+ def self.attribute_map
39
+ {
40
+ :'customerid' => :'customerid',
41
+ :'cookieid' => :'cookieid',
42
+ :'boxx_token_id' => :'boxx_token_id',
43
+ :'properties' => :'properties',
44
+ :'transactionid' => :'transactionid',
45
+ :'productid' => :'productid',
46
+ :'type' => :'type',
47
+ :'transactiondate' => :'transactiondate',
48
+ :'location' => :'location'
49
+ }
50
+ end
51
+
52
+ # Attribute type mapping.
53
+ def self.swagger_types
54
+ {
55
+ :'customerid' => :'String',
56
+ :'cookieid' => :'String',
57
+ :'boxx_token_id' => :'String',
58
+ :'properties' => :'Hash<String, Object>',
59
+ :'transactionid' => :'String',
60
+ :'productid' => :'String',
61
+ :'type' => :'String',
62
+ :'transactiondate' => :'String',
63
+ :'location' => :'Array<String>'
64
+ }
65
+ end
66
+
67
+ # Initializes the object
68
+ # @param [Hash] attributes Model attributes in the form of hash
69
+ def initialize(attributes = {})
70
+ return unless attributes.is_a?(Hash)
71
+
72
+ # convert string to symbol for hash key
73
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
74
+
75
+ if attributes.has_key?(:'customerid')
76
+ self.customerid = attributes[:'customerid']
77
+ end
78
+
79
+ if attributes.has_key?(:'cookieid')
80
+ self.cookieid = attributes[:'cookieid']
81
+ end
82
+
83
+ if attributes.has_key?(:'boxx_token_id')
84
+ self.boxx_token_id = attributes[:'boxx_token_id']
85
+ end
86
+
87
+ if attributes.has_key?(:'properties')
88
+ if (value = attributes[:'properties']).is_a?(Hash)
89
+ self.properties = value
90
+ end
91
+ end
92
+
93
+ if attributes.has_key?(:'transactionid')
94
+ self.transactionid = attributes[:'transactionid']
95
+ end
96
+
97
+ if attributes.has_key?(:'productid')
98
+ self.productid = attributes[:'productid']
99
+ end
100
+
101
+ if attributes.has_key?(:'type')
102
+ self.type = attributes[:'type']
103
+ end
104
+
105
+ if attributes.has_key?(:'transactiondate')
106
+ self.transactiondate = attributes[:'transactiondate']
107
+ end
108
+
109
+ if attributes.has_key?(:'location')
110
+ if (value = attributes[:'location']).is_a?(Array)
111
+ self.location = value
112
+ end
113
+ end
114
+
115
+ end
116
+
117
+ # Show invalid properties with the reasons. Usually used together with valid?
118
+ # @return Array for valid properties with the reasons
119
+ def list_invalid_properties
120
+ invalid_properties = Array.new
121
+ if @productid.nil?
122
+ invalid_properties.push("invalid value for 'productid', productid cannot be nil.")
123
+ end
124
+
125
+ if @type.nil?
126
+ invalid_properties.push("invalid value for 'type', type cannot be nil.")
127
+ end
128
+
129
+ if @transactiondate.nil?
130
+ invalid_properties.push("invalid value for 'transactiondate', transactiondate cannot be nil.")
131
+ end
132
+
133
+ return invalid_properties
134
+ end
135
+
136
+ # Check to see if the all the properties in the model are valid
137
+ # @return true if the model is valid
138
+ def valid?
139
+ return false if @productid.nil?
140
+ return false if @type.nil?
141
+ return false if @transactiondate.nil?
142
+ return true
143
+ end
144
+
145
+ # Checks equality by comparing each attribute.
146
+ # @param [Object] Object to be compared
147
+ def ==(o)
148
+ return true if self.equal?(o)
149
+ self.class == o.class &&
150
+ customerid == o.customerid &&
151
+ cookieid == o.cookieid &&
152
+ boxx_token_id == o.boxx_token_id &&
153
+ properties == o.properties &&
154
+ transactionid == o.transactionid &&
155
+ productid == o.productid &&
156
+ type == o.type &&
157
+ transactiondate == o.transactiondate &&
158
+ location == o.location
159
+ end
160
+
161
+ # @see the `==` method
162
+ # @param [Object] Object to be compared
163
+ def eql?(o)
164
+ self == o
165
+ end
166
+
167
+ # Calculates hash code according to all attributes.
168
+ # @return [Fixnum] Hash code
169
+ def hash
170
+ [customerid, cookieid, boxx_token_id, properties, transactionid, productid, type, transactiondate, location].hash
171
+ end
172
+
173
+ # Builds the object from hash
174
+ # @param [Hash] attributes Model attributes in the form of hash
175
+ # @return [Object] Returns the model itself
176
+ def build_from_hash(attributes)
177
+ return nil unless attributes.is_a?(Hash)
178
+ self.class.swagger_types.each_pair do |key, type|
179
+ if type =~ /\AArray<(.*)>/i
180
+ # check to ensure the input is an array given that the the attribute
181
+ # is documented as an array but the input is not
182
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
183
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
184
+ end
185
+ elsif !attributes[self.class.attribute_map[key]].nil?
186
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
187
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
188
+ end
189
+
190
+ self
191
+ end
192
+
193
+ # Deserializes the data based on type
194
+ # @param string type Data type
195
+ # @param string value Value to be deserialized
196
+ # @return [Object] Deserialized data
197
+ def _deserialize(type, value)
198
+ case type.to_sym
199
+ when :DateTime
200
+ DateTime.parse(value)
201
+ when :Date
202
+ Date.parse(value)
203
+ when :String
204
+ value.to_s
205
+ when :Integer
206
+ value.to_i
207
+ when :Float
208
+ value.to_f
209
+ when :BOOLEAN
210
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
211
+ true
212
+ else
213
+ false
214
+ end
215
+ when :Object
216
+ # generic object (usually a Hash), return directly
217
+ value
218
+ when /\AArray<(?<inner_type>.+)>\z/
219
+ inner_type = Regexp.last_match[:inner_type]
220
+ value.map { |v| _deserialize(inner_type, v) }
221
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
222
+ k_type = Regexp.last_match[:k_type]
223
+ v_type = Regexp.last_match[:v_type]
224
+ {}.tap do |hash|
225
+ value.each do |k, v|
226
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
227
+ end
228
+ end
229
+ else # model
230
+ temp_model = BoxxClient.const_get(type).new
231
+ temp_model.build_from_hash(value)
232
+ end
233
+ end
234
+
235
+ # Returns the string representation of the object
236
+ # @return [String] String presentation of the object
237
+ def to_s
238
+ to_hash.to_s
239
+ end
240
+
241
+ # to_body is an alias to to_hash (backward compatibility)
242
+ # @return [Hash] Returns the object in the form of hash
243
+ def to_body
244
+ to_hash
245
+ end
246
+
247
+ # Returns the object in the form of hash
248
+ # @return [Hash] Returns the object in the form of hash
249
+ def to_hash
250
+ hash = {}
251
+ self.class.attribute_map.each_pair do |attr, param|
252
+ value = self.send(attr)
253
+ next if value.nil?
254
+ hash[param] = _to_hash(value)
255
+ end
256
+ hash
257
+ end
258
+
259
+ # Outputs non-array value in the form of hash
260
+ # For object, use to_hash. Otherwise, just return the value
261
+ # @param [Object] value Any valid value
262
+ # @return [Hash] Returns the value in the form of hash
263
+ def _to_hash(value)
264
+ if value.is_a?(Array)
265
+ value.compact.map{ |v| _to_hash(v) }
266
+ elsif value.is_a?(Hash)
267
+ {}.tap do |hash|
268
+ value.each { |k, v| hash[k] = _to_hash(v) }
269
+ end
270
+ elsif value.respond_to? :to_hash
271
+ value.to_hash
272
+ else
273
+ value
274
+ end
275
+ end
276
+
277
+ end
278
+
279
+ end