ultracart_api 4.0.32.rc → 4.0.35.rc

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 (48) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +25 -4
  3. data/docs/Activity.md +4 -0
  4. data/docs/AffiliateApi.md +16 -22
  5. data/docs/AutoOrderApi.md +64 -88
  6. data/docs/ChannelPartnerApi.md +40 -55
  7. data/docs/ChargebackApi.md +40 -55
  8. data/docs/CheckoutApi.md +152 -294
  9. data/docs/Conversation.md +26 -0
  10. data/docs/ConversationAgentAuthResponse.md +22 -0
  11. data/docs/ConversationApi.md +438 -0
  12. data/docs/ConversationMessage.md +26 -0
  13. data/docs/ConversationParticipant.md +30 -0
  14. data/docs/ConversationStartRequest.md +20 -0
  15. data/docs/ConversationStartResponse.md +20 -0
  16. data/docs/ConversationSummary.md +34 -0
  17. data/docs/ConversationsResponse.md +26 -0
  18. data/docs/CouponApi.md +152 -209
  19. data/docs/CustomerActivity.md +9 -1
  20. data/docs/CustomerApi.md +213 -192
  21. data/docs/CustomerMergeRequest.md +20 -0
  22. data/docs/FulfillmentApi.md +48 -66
  23. data/docs/GiftCertificateApi.md +64 -88
  24. data/docs/IntegrationLogApi.md +40 -55
  25. data/docs/ItemApi.md +72 -99
  26. data/docs/OauthApi.md +16 -32
  27. data/docs/OrderApi.md +184 -253
  28. data/docs/SsoApi.md +32 -44
  29. data/docs/StorefrontApi.md +1134 -2345
  30. data/docs/TaxApi.md +224 -308
  31. data/docs/UserApi.md +88 -121
  32. data/docs/WebhookApi.md +64 -88
  33. data/lib/ultracart_api/api/conversation_api.rb +418 -0
  34. data/lib/ultracart_api/api/customer_api.rb +78 -0
  35. data/lib/ultracart_api/models/activity.rb +19 -1
  36. data/lib/ultracart_api/models/conversation.rb +259 -0
  37. data/lib/ultracart_api/models/conversation_agent_auth_response.rb +237 -0
  38. data/lib/ultracart_api/models/conversation_message.rb +258 -0
  39. data/lib/ultracart_api/models/conversation_participant.rb +276 -0
  40. data/lib/ultracart_api/models/conversation_start_request.rb +230 -0
  41. data/lib/ultracart_api/models/conversation_start_response.rb +228 -0
  42. data/lib/ultracart_api/models/conversation_summary.rb +292 -0
  43. data/lib/ultracart_api/models/conversations_response.rb +258 -0
  44. data/lib/ultracart_api/models/customer_activity.rb +40 -4
  45. data/lib/ultracart_api/models/customer_merge_request.rb +230 -0
  46. data/lib/ultracart_api/version.rb +1 -1
  47. data/lib/ultracart_api.rb +10 -0
  48. metadata +22 -2
data/docs/ChargebackApi.md CHANGED
@@ -24,18 +24,15 @@ Delete a chargeback on the UltraCart account.
24
24
  ```ruby
25
25
  require 'time'
26
26
  require 'ultracart_api'
27
- # setup authorization
28
- UltracartClient.configure do |config|
29
- # Configure OAuth2 access token for authorization: ultraCartOauth
30
- config.access_token = 'YOUR ACCESS TOKEN'
31
-
32
- # Configure API key authorization: ultraCartSimpleApiKey
33
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
34
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
35
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
36
- end
27
+ require 'json'
28
+ require 'yaml'
29
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
30
+
31
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
32
+ # As such, this might not be the best way to use this object.
33
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
37
34
 
38
- api_instance = UltracartClient::ChargebackApi.new
35
+ api = UltracartClient::ChargebackApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
39
36
  chargeback_dispute_oid = 56 # Integer | The chargeback_dispute_oid to delete.
40
37
 
41
38
  begin
@@ -98,18 +95,15 @@ Retrieves a single chargeback using the specified chargeback dispute oid.
98
95
  ```ruby
99
96
  require 'time'
100
97
  require 'ultracart_api'
101
- # setup authorization
102
- UltracartClient.configure do |config|
103
- # Configure OAuth2 access token for authorization: ultraCartOauth
104
- config.access_token = 'YOUR ACCESS TOKEN'
105
-
106
- # Configure API key authorization: ultraCartSimpleApiKey
107
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
108
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
109
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
110
- end
98
+ require 'json'
99
+ require 'yaml'
100
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
111
101
 
112
- api_instance = UltracartClient::ChargebackApi.new
102
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
103
+ # As such, this might not be the best way to use this object.
104
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
105
+
106
+ api = UltracartClient::ChargebackApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
113
107
  chargeback_dispute_oid = 56 # Integer | The chargeback dispute oid to retrieve.
114
108
  opts = {
115
109
  _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
@@ -176,18 +170,15 @@ Retrieves chargebacks from the account. If no parameters are specified, all cha
176
170
  ```ruby
177
171
  require 'time'
178
172
  require 'ultracart_api'
179
- # setup authorization
180
- UltracartClient.configure do |config|
181
- # Configure OAuth2 access token for authorization: ultraCartOauth
182
- config.access_token = 'YOUR ACCESS TOKEN'
183
-
184
- # Configure API key authorization: ultraCartSimpleApiKey
185
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
186
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
187
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
188
- end
173
+ require 'json'
174
+ require 'yaml'
175
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
189
176
 
190
- api_instance = UltracartClient::ChargebackApi.new
177
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
178
+ # As such, this might not be the best way to use this object.
179
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
180
+
181
+ api = UltracartClient::ChargebackApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
191
182
  opts = {
192
183
  order_id: 'order_id_example', # String | Order Id
193
184
  case_number: 'case_number_example', # String | Case number
@@ -274,18 +265,15 @@ Insert a chargeback on the UltraCart account.
274
265
  ```ruby
275
266
  require 'time'
276
267
  require 'ultracart_api'
277
- # setup authorization
278
- UltracartClient.configure do |config|
279
- # Configure OAuth2 access token for authorization: ultraCartOauth
280
- config.access_token = 'YOUR ACCESS TOKEN'
281
-
282
- # Configure API key authorization: ultraCartSimpleApiKey
283
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
284
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
285
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
286
- end
268
+ require 'json'
269
+ require 'yaml'
270
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
271
+
272
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
273
+ # As such, this might not be the best way to use this object.
274
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
287
275
 
288
- api_instance = UltracartClient::ChargebackApi.new
276
+ api = UltracartClient::ChargebackApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
289
277
  chargeback = UltracartClient::ChargebackDispute.new # ChargebackDispute | Chargeback to insert
290
278
  opts = {
291
279
  _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
@@ -352,18 +340,15 @@ Update a chargeback on the UltraCart account.
352
340
  ```ruby
353
341
  require 'time'
354
342
  require 'ultracart_api'
355
- # setup authorization
356
- UltracartClient.configure do |config|
357
- # Configure OAuth2 access token for authorization: ultraCartOauth
358
- config.access_token = 'YOUR ACCESS TOKEN'
359
-
360
- # Configure API key authorization: ultraCartSimpleApiKey
361
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
362
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
363
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
364
- end
343
+ require 'json'
344
+ require 'yaml'
345
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
346
+
347
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
348
+ # As such, this might not be the best way to use this object.
349
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
365
350
 
366
- api_instance = UltracartClient::ChargebackApi.new
351
+ api = UltracartClient::ChargebackApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
367
352
  chargeback_dispute_oid = 56 # Integer | The chargeback_dispute_oid to update.
368
353
  chargeback = UltracartClient::ChargebackDispute.new # ChargebackDispute | Chargeback to update
369
354
  opts = {