ultracart_api 3.2.11 → 3.2.15

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ab4a9230408e849839ffa05f1388f126d79ea05461e32435e17fc36cc368442d
4
- data.tar.gz: d7860c7728fe67f723b1c5b156f8922ec4d502c0953dc139000fa8eb4be8c062
3
+ metadata.gz: bc9bde08cb99dbff1869db3b6d3ea61df1c1dd099efa422b66c67bd46eb73d0d
4
+ data.tar.gz: 9f741b906df5a4e79f3998c46d82c5f6ae3177e1400c34b0dd097aeea1afae14
5
5
  SHA512:
6
- metadata.gz: ee1653e846c97444c43922ac2580c468987f99fcd0baf2614f02f413fa0b50200db1f982dc51d8caf62390f9592c2eccd9d09d6c2d931fd701cbb9205d555152
7
- data.tar.gz: a251dfca7836f01f542b193ab791a1b00cb4f07f5068aa243190df00e040067251350939e6d23b7f5aa338cd43047d3aabc773bc9f8418c40fe6c8312407391a
6
+ metadata.gz: b6a920d32426b5c3bbad90dfa18794bcbc0a694055e9eafbce2b40be47dc3741a02028015dceefafc71c2ecdad48a2623bd4f4373152019c56ddfb18d9cb9506
7
+ data.tar.gz: 209ce5b9f0ea5267ddce634399390936d410e4058283757a0f74a9aaaf4ddc0b497c105d692450388462ec2fbc00dc9f95dd400647c21a0261030c08ccd8c883
data/README.md CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
7
7
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
8
 
9
9
  - API version: 2.0.0
10
- - Package version: 3.2.11
10
+ - Package version: 3.2.15
11
11
  - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
12
  For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
13
13
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
24
24
  Then either install the gem locally:
25
25
 
26
26
  ```shell
27
- gem install ./ultracart_api-3.2.11.gem
27
+ gem install ./ultracart_api-3.2.15.gem
28
28
  ```
29
- (for development, run `gem install --dev ./ultracart_api-3.2.11.gem` to install the development dependencies)
29
+ (for development, run `gem install --dev ./ultracart_api-3.2.15.gem` to install the development dependencies)
30
30
 
31
31
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
32
32
 
33
33
  Finally add this to the Gemfile:
34
34
 
35
- gem 'ultracart_api', '~> 3.2.11'
35
+ gem 'ultracart_api', '~> 3.2.15'
36
36
 
37
37
  ### Install from Git
38
38
 
@@ -153,6 +153,7 @@ Class | Method | HTTP request | Description
153
153
  *UltracartClient::CustomerApi* | [**update_customer_email_lists**](docs/CustomerApi.md#update_customer_email_lists) | **POST** /customer/customers/{customer_profile_oid}/email_lists | Update email list subscriptions for a customer
154
154
  *UltracartClient::CustomerApi* | [**validate_email_verification_token**](docs/CustomerApi.md#validate_email_verification_token) | **POST** /customer/customers/email_verify/validate_token | Validate a token that can be used to verify a customer email address
155
155
  *UltracartClient::FulfillmentApi* | [**acknowledge_orders**](docs/FulfillmentApi.md#acknowledge_orders) | **PUT** /fulfillment/distribution_centers/{distribution_center_code}/acknowledgements | Acknowledge receipt of orders.
156
+ *UltracartClient::FulfillmentApi* | [**generate_packing_slip**](docs/FulfillmentApi.md#generate_packing_slip) | **GET** /fulfillment/distribution_centers/{distribution_center_code}/orders/{order_id} | Generate a packing slip for this order for the given distribution center.
156
157
  *UltracartClient::FulfillmentApi* | [**get_distribution_center_orders**](docs/FulfillmentApi.md#get_distribution_center_orders) | **GET** /fulfillment/distribution_centers/{distribution_center_code}/orders | Retrieve orders queued up for this distribution center.
157
158
  *UltracartClient::FulfillmentApi* | [**get_distribution_centers**](docs/FulfillmentApi.md#get_distribution_centers) | **GET** /fulfillment/distribution_centers | Retrieve distribution centers
158
159
  *UltracartClient::FulfillmentApi* | [**ship_orders**](docs/FulfillmentApi.md#ship_orders) | **POST** /fulfillment/distribution_centers/{distribution_center_code}/shipments | Mark orders as shipped
@@ -176,6 +177,8 @@ Class | Method | HTTP request | Description
176
177
  *UltracartClient::OrderApi* | [**delete_order**](docs/OrderApi.md#delete_order) | **DELETE** /order/orders/{order_id} | Delete an order
177
178
  *UltracartClient::OrderApi* | [**format**](docs/OrderApi.md#format) | **POST** /order/orders/{order_id}/format | Format order
178
179
  *UltracartClient::OrderApi* | [**generate_order_token**](docs/OrderApi.md#generate_order_token) | **GET** /order/orders/token/{order_id} | Generate an order token for a given order id
180
+ *UltracartClient::OrderApi* | [**generate_packing_slip_all_dc**](docs/OrderApi.md#generate_packing_slip_all_dc) | **GET** /order/orders/{order_id}/packing_slip | Generate a packing slip for this order across all distribution centers.
181
+ *UltracartClient::OrderApi* | [**generate_packing_slip_specific_dc**](docs/OrderApi.md#generate_packing_slip_specific_dc) | **GET** /order/orders/{order_id}/packing_slip/{distribution_center_code} | Generate a packing slip for this order for the given distribution center.
179
182
  *UltracartClient::OrderApi* | [**get_accounts_receivable_retry_config**](docs/OrderApi.md#get_accounts_receivable_retry_config) | **GET** /order/accountsReceivableRetryConfig | Retrieve A/R Retry Configuration
180
183
  *UltracartClient::OrderApi* | [**get_accounts_receivable_retry_stats**](docs/OrderApi.md#get_accounts_receivable_retry_stats) | **GET** /order/accountsReceivableRetryConfig/stats | Retrieve A/R Retry Statistics
181
184
  *UltracartClient::OrderApi* | [**get_order**](docs/OrderApi.md#get_order) | **GET** /order/orders/{order_id} | Retrieve an order
@@ -235,6 +238,7 @@ Class | Method | HTTP request | Description
235
238
  *UltracartClient::StorefrontApi* | [**get_email_customers**](docs/StorefrontApi.md#get_email_customers) | **GET** /storefront/{storefront_oid}/email/customers | Get email customers
236
239
  *UltracartClient::StorefrontApi* | [**get_email_dashboard_activity**](docs/StorefrontApi.md#get_email_dashboard_activity) | **GET** /storefront/{storefront_oid}/email/dashboard_activity | Get email dashboard activity
237
240
  *UltracartClient::StorefrontApi* | [**get_email_dashboard_stats**](docs/StorefrontApi.md#get_email_dashboard_stats) | **GET** /storefront/{storefront_oid}/email/dashboard_stats | Get dashboard stats
241
+ *UltracartClient::StorefrontApi* | [**get_email_dispatch_logs**](docs/StorefrontApi.md#get_email_dispatch_logs) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/logs | Get email dispatch logs
238
242
  *UltracartClient::StorefrontApi* | [**get_email_email**](docs/StorefrontApi.md#get_email_email) | **GET** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid} | Get email email
239
243
  *UltracartClient::StorefrontApi* | [**get_email_email_clicks**](docs/StorefrontApi.md#get_email_email_clicks) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/emails/{commseq_email_uuid}/clicks | Get email email clicks
240
244
  *UltracartClient::StorefrontApi* | [**get_email_email_customer_editor_url**](docs/StorefrontApi.md#get_email_email_customer_editor_url) | **GET** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/orders/{order_id}/editor_url | Get email order customer editor url
@@ -607,6 +611,8 @@ Class | Method | HTTP request | Description
607
611
  - [UltracartClient::EmailCommseqStat](docs/EmailCommseqStat.md)
608
612
  - [UltracartClient::EmailCommseqStatResponse](docs/EmailCommseqStatResponse.md)
609
613
  - [UltracartClient::EmailCommseqStep](docs/EmailCommseqStep.md)
614
+ - [UltracartClient::EmailCommseqStepLog](docs/EmailCommseqStepLog.md)
615
+ - [UltracartClient::EmailCommseqStepLogsResponse](docs/EmailCommseqStepLogsResponse.md)
610
616
  - [UltracartClient::EmailCommseqsResponse](docs/EmailCommseqsResponse.md)
611
617
  - [UltracartClient::EmailCustomer](docs/EmailCustomer.md)
612
618
  - [UltracartClient::EmailCustomerEditorUrlResponse](docs/EmailCustomerEditorUrlResponse.md)
@@ -1032,6 +1038,10 @@ Not every change is committed to every SDK.
1032
1038
 
1033
1039
  | Version | Date | Comments |
1034
1040
  | --: | :-: | --- |
1041
+ | 3.2.15 | 07/13/2021 | storefront communications - added methods to retrieve step dispatch logs |
1042
+ | 3.2.14 | 07/12/2021 | fix documentation bug on packing slip methods for order api |
1043
+ | 3.2.13 | 07/12/2021 | coupon api - added hideFromCustomer flag |
1044
+ | 3.2.12 | 07/09/2021 | new fulfillment and order methods for generation of packing slips |
1035
1045
  | 3.2.11 | 07/08/2021 | screen recording - missing external tracking flag added |
1036
1046
  | 3.2.10 | 07/08/2021 | customer profile - allow drop shipping options |
1037
1047
  | 3.2.9 | 07/07/2021 | screen recording - provide cost per thousand and retention interval |
data/docs/Coupon.md CHANGED
@@ -33,6 +33,7 @@ Name | Type | Description | Notes
33
33
  **free_shipping_specific_items** | [**CouponFreeShippingSpecificItems**](CouponFreeShippingSpecificItems.md) | | [optional]
34
34
  **free_shipping_with_items_purchase** | [**CouponFreeShippingWithItemsPurchase**](CouponFreeShippingWithItemsPurchase.md) | | [optional]
35
35
  **free_shipping_with_subtotal** | [**CouponFreeShippingWithSubtotal**](CouponFreeShippingWithSubtotal.md) | | [optional]
36
+ **hide_from_customer** | **BOOLEAN** | Hide coupon from customer during checkout. Often used when coupons are automatic discounting mechanisms. | [optional]
36
37
  **merchant_code** | **String** | Merchant code of coupon up to 20 characters. | [optional]
37
38
  **merchant_notes** | **String** | Internal notes about this coupon. These are not visible to customer. | [optional]
38
39
  **multiple_amounts_off_items** | [**CouponMultipleAmountsOffItems**](CouponMultipleAmountsOffItems.md) | | [optional]
@@ -0,0 +1,10 @@
1
+ # UltracartClient::EmailCommseqStepLog
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **email** | **String** | Email | [optional]
7
+ **log** | **String** | Log text | [optional]
8
+ **log_dts** | **String** | Log date/time | [optional]
9
+
10
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::EmailCommseqStepLogsResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error** | [**Error**](Error.md) | | [optional]
7
+ **logs** | [**Array<EmailCommseqStepLog>**](EmailCommseqStepLog.md) | | [optional]
8
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
9
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
@@ -5,6 +5,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**acknowledge_orders**](FulfillmentApi.md#acknowledge_orders) | **PUT** /fulfillment/distribution_centers/{distribution_center_code}/acknowledgements | Acknowledge receipt of orders.
8
+ [**generate_packing_slip**](FulfillmentApi.md#generate_packing_slip) | **GET** /fulfillment/distribution_centers/{distribution_center_code}/orders/{order_id} | Generate a packing slip for this order for the given distribution center.
8
9
  [**get_distribution_center_orders**](FulfillmentApi.md#get_distribution_center_orders) | **GET** /fulfillment/distribution_centers/{distribution_center_code}/orders | Retrieve orders queued up for this distribution center.
9
10
  [**get_distribution_centers**](FulfillmentApi.md#get_distribution_centers) | **GET** /fulfillment/distribution_centers | Retrieve distribution centers
10
11
  [**ship_orders**](FulfillmentApi.md#ship_orders) | **POST** /fulfillment/distribution_centers/{distribution_center_code}/shipments | Mark orders as shipped
@@ -63,6 +64,59 @@ nil (empty response body)
63
64
 
64
65
 
65
66
 
67
+ # **generate_packing_slip**
68
+ > OrdersResponse generate_packing_slip(distribution_center_code, order_id)
69
+
70
+ Generate a packing slip for this order for the given distribution center.
71
+
72
+ The packing slip PDF that is returned is base 64 encoded
73
+
74
+ ### Example
75
+ ```ruby
76
+ # load the gem
77
+ require 'ultracart_api'
78
+
79
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
80
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
81
+ api_instance = UltracartClient::FulfillmentApi.new_using_api_key(simple_key, false, false)
82
+
83
+
84
+ distribution_center_code = 'distribution_center_code_example' # String | Distribution center code
85
+
86
+ order_id = 'order_id_example' # String | Order ID
87
+
88
+
89
+ begin
90
+ #Generate a packing slip for this order for the given distribution center.
91
+ result = api_instance.generate_packing_slip(distribution_center_code, order_id)
92
+ p result
93
+ rescue UltracartClient::ApiError => e
94
+ puts "Exception when calling FulfillmentApi->generate_packing_slip: #{e}"
95
+ end
96
+ ```
97
+
98
+ ### Parameters
99
+
100
+ Name | Type | Description | Notes
101
+ ------------- | ------------- | ------------- | -------------
102
+ **distribution_center_code** | **String**| Distribution center code |
103
+ **order_id** | **String**| Order ID |
104
+
105
+ ### Return type
106
+
107
+ [**OrdersResponse**](OrdersResponse.md)
108
+
109
+ ### Authorization
110
+
111
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
112
+
113
+ ### HTTP request headers
114
+
115
+ - **Content-Type**: application/json
116
+ - **Accept**: application/json
117
+
118
+
119
+
66
120
  # **get_distribution_center_orders**
67
121
  > OrdersResponse get_distribution_center_orders(distribution_center_code)
68
122
 
data/docs/OrderApi.md CHANGED
@@ -9,6 +9,8 @@ Method | HTTP request | Description
9
9
  [**delete_order**](OrderApi.md#delete_order) | **DELETE** /order/orders/{order_id} | Delete an order
10
10
  [**format**](OrderApi.md#format) | **POST** /order/orders/{order_id}/format | Format order
11
11
  [**generate_order_token**](OrderApi.md#generate_order_token) | **GET** /order/orders/token/{order_id} | Generate an order token for a given order id
12
+ [**generate_packing_slip_all_dc**](OrderApi.md#generate_packing_slip_all_dc) | **GET** /order/orders/{order_id}/packing_slip | Generate a packing slip for this order across all distribution centers.
13
+ [**generate_packing_slip_specific_dc**](OrderApi.md#generate_packing_slip_specific_dc) | **GET** /order/orders/{order_id}/packing_slip/{distribution_center_code} | Generate a packing slip for this order for the given distribution center.
12
14
  [**get_accounts_receivable_retry_config**](OrderApi.md#get_accounts_receivable_retry_config) | **GET** /order/accountsReceivableRetryConfig | Retrieve A/R Retry Configuration
13
15
  [**get_accounts_receivable_retry_stats**](OrderApi.md#get_accounts_receivable_retry_stats) | **GET** /order/accountsReceivableRetryConfig/stats | Retrieve A/R Retry Statistics
14
16
  [**get_order**](OrderApi.md#get_order) | **GET** /order/orders/{order_id} | Retrieve an order
@@ -281,6 +283,109 @@ Name | Type | Description | Notes
281
283
 
282
284
 
283
285
 
286
+ # **generate_packing_slip_all_dc**
287
+ > OrdersResponse generate_packing_slip_all_dc(order_id)
288
+
289
+ Generate a packing slip for this order across all distribution centers.
290
+
291
+ The packing slip PDF that is returned is base 64 encoded
292
+
293
+ ### Example
294
+ ```ruby
295
+ # load the gem
296
+ require 'ultracart_api'
297
+
298
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
299
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
300
+ api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
301
+
302
+
303
+ order_id = 'order_id_example' # String | Order ID
304
+
305
+
306
+ begin
307
+ #Generate a packing slip for this order across all distribution centers.
308
+ result = api_instance.generate_packing_slip_all_dc(order_id)
309
+ p result
310
+ rescue UltracartClient::ApiError => e
311
+ puts "Exception when calling OrderApi->generate_packing_slip_all_dc: #{e}"
312
+ end
313
+ ```
314
+
315
+ ### Parameters
316
+
317
+ Name | Type | Description | Notes
318
+ ------------- | ------------- | ------------- | -------------
319
+ **order_id** | **String**| Order ID |
320
+
321
+ ### Return type
322
+
323
+ [**OrdersResponse**](OrdersResponse.md)
324
+
325
+ ### Authorization
326
+
327
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
328
+
329
+ ### HTTP request headers
330
+
331
+ - **Content-Type**: application/json
332
+ - **Accept**: application/json
333
+
334
+
335
+
336
+ # **generate_packing_slip_specific_dc**
337
+ > OrdersResponse generate_packing_slip_specific_dc(distribution_center_code, order_id)
338
+
339
+ Generate a packing slip for this order for the given distribution center.
340
+
341
+ The packing slip PDF that is returned is base 64 encoded
342
+
343
+ ### Example
344
+ ```ruby
345
+ # load the gem
346
+ require 'ultracart_api'
347
+
348
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
349
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
350
+ api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
351
+
352
+
353
+ distribution_center_code = 'distribution_center_code_example' # String | Distribution center code
354
+
355
+ order_id = 'order_id_example' # String | Order ID
356
+
357
+
358
+ begin
359
+ #Generate a packing slip for this order for the given distribution center.
360
+ result = api_instance.generate_packing_slip_specific_dc(distribution_center_code, order_id)
361
+ p result
362
+ rescue UltracartClient::ApiError => e
363
+ puts "Exception when calling OrderApi->generate_packing_slip_specific_dc: #{e}"
364
+ end
365
+ ```
366
+
367
+ ### Parameters
368
+
369
+ Name | Type | Description | Notes
370
+ ------------- | ------------- | ------------- | -------------
371
+ **distribution_center_code** | **String**| Distribution center code |
372
+ **order_id** | **String**| Order ID |
373
+
374
+ ### Return type
375
+
376
+ [**OrdersResponse**](OrdersResponse.md)
377
+
378
+ ### Authorization
379
+
380
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
381
+
382
+ ### HTTP request headers
383
+
384
+ - **Content-Type**: application/json
385
+ - **Accept**: application/json
386
+
387
+
388
+
284
389
  # **get_accounts_receivable_retry_config**
285
390
  > AccountsReceivableRetryConfigResponse get_accounts_receivable_retry_config
286
391
 
data/docs/OrderCoupon.md CHANGED
@@ -7,5 +7,6 @@ Name | Type | Description | Notes
7
7
  **automatically_applied** | **BOOLEAN** | Whether or not the coupon was automatically applied to the order | [optional]
8
8
  **base_coupon_code** | **String** | Coupon code configured by the merchant. Will differ if the customer used a one time coupon code generated off this base coupon | [optional]
9
9
  **coupon_code** | **String** | Coupon code entered by the customer | [optional]
10
+ **hdie_from_customer** | **BOOLEAN** | True if this coupon is hidde from the customer | [optional]
10
11
 
11
12
 
@@ -48,6 +48,7 @@ Method | HTTP request | Description
48
48
  [**get_email_customers**](StorefrontApi.md#get_email_customers) | **GET** /storefront/{storefront_oid}/email/customers | Get email customers
49
49
  [**get_email_dashboard_activity**](StorefrontApi.md#get_email_dashboard_activity) | **GET** /storefront/{storefront_oid}/email/dashboard_activity | Get email dashboard activity
50
50
  [**get_email_dashboard_stats**](StorefrontApi.md#get_email_dashboard_stats) | **GET** /storefront/{storefront_oid}/email/dashboard_stats | Get dashboard stats
51
+ [**get_email_dispatch_logs**](StorefrontApi.md#get_email_dispatch_logs) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/logs | Get email dispatch logs
51
52
  [**get_email_email**](StorefrontApi.md#get_email_email) | **GET** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid} | Get email email
52
53
  [**get_email_email_clicks**](StorefrontApi.md#get_email_email_clicks) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/emails/{commseq_email_uuid}/clicks | Get email email clicks
53
54
  [**get_email_email_customer_editor_url**](StorefrontApi.md#get_email_email_customer_editor_url) | **GET** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/orders/{order_id}/editor_url | Get email order customer editor url
@@ -2395,6 +2396,60 @@ Name | Type | Description | Notes
2395
2396
 
2396
2397
 
2397
2398
 
2399
+ # **get_email_dispatch_logs**
2400
+ > EmailCommseqStepLogsResponse get_email_dispatch_logs(storefront_oid, commseq_uuid, commseq_step_uuid)
2401
+
2402
+ Get email dispatch logs
2403
+
2404
+ ### Example
2405
+ ```ruby
2406
+ # load the gem
2407
+ require 'ultracart_api'
2408
+
2409
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
2410
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
2411
+ api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
2412
+
2413
+
2414
+ storefront_oid = 56 # Integer |
2415
+
2416
+ commseq_uuid = 'commseq_uuid_example' # String |
2417
+
2418
+ commseq_step_uuid = 'commseq_step_uuid_example' # String |
2419
+
2420
+
2421
+ begin
2422
+ #Get email dispatch logs
2423
+ result = api_instance.get_email_dispatch_logs(storefront_oid, commseq_uuid, commseq_step_uuid)
2424
+ p result
2425
+ rescue UltracartClient::ApiError => e
2426
+ puts "Exception when calling StorefrontApi->get_email_dispatch_logs: #{e}"
2427
+ end
2428
+ ```
2429
+
2430
+ ### Parameters
2431
+
2432
+ Name | Type | Description | Notes
2433
+ ------------- | ------------- | ------------- | -------------
2434
+ **storefront_oid** | **Integer**| |
2435
+ **commseq_uuid** | **String**| |
2436
+ **commseq_step_uuid** | **String**| |
2437
+
2438
+ ### Return type
2439
+
2440
+ [**EmailCommseqStepLogsResponse**](EmailCommseqStepLogsResponse.md)
2441
+
2442
+ ### Authorization
2443
+
2444
+ [ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2445
+
2446
+ ### HTTP request headers
2447
+
2448
+ - **Content-Type**: application/json
2449
+ - **Accept**: application/json
2450
+
2451
+
2452
+
2398
2453
  # **get_email_email**
2399
2454
  > EmailCommseqEmailResponse get_email_email(storefront_oid, commseq_email_uuid)
2400
2455
 
data/lib/ultracart_api.rb CHANGED
@@ -235,6 +235,8 @@ require 'ultracart_api/models/email_commseq_response'
235
235
  require 'ultracart_api/models/email_commseq_stat'
236
236
  require 'ultracart_api/models/email_commseq_stat_response'
237
237
  require 'ultracart_api/models/email_commseq_step'
238
+ require 'ultracart_api/models/email_commseq_step_log'
239
+ require 'ultracart_api/models/email_commseq_step_logs_response'
238
240
  require 'ultracart_api/models/email_commseqs_response'
239
241
  require 'ultracart_api/models/email_customer'
240
242
  require 'ultracart_api/models/email_customer_editor_url_response'
@@ -92,6 +92,67 @@ module UltracartClient
92
92
  end
93
93
  return data, status_code, headers
94
94
  end
95
+ # Generate a packing slip for this order for the given distribution center.
96
+ # The packing slip PDF that is returned is base 64 encoded
97
+ # @param distribution_center_code Distribution center code
98
+ # @param order_id Order ID
99
+ # @param [Hash] opts the optional parameters
100
+ # @return [OrdersResponse]
101
+ def generate_packing_slip(distribution_center_code, order_id, opts = {})
102
+ data, _status_code, _headers = generate_packing_slip_with_http_info(distribution_center_code, order_id, opts)
103
+ data
104
+ end
105
+
106
+ # Generate a packing slip for this order for the given distribution center.
107
+ # The packing slip PDF that is returned is base 64 encoded
108
+ # @param distribution_center_code Distribution center code
109
+ # @param order_id Order ID
110
+ # @param [Hash] opts the optional parameters
111
+ # @return [Array<(OrdersResponse, Fixnum, Hash)>] OrdersResponse data, response status code and response headers
112
+ def generate_packing_slip_with_http_info(distribution_center_code, order_id, opts = {})
113
+ if @api_client.config.debugging
114
+ @api_client.config.logger.debug 'Calling API: FulfillmentApi.generate_packing_slip ...'
115
+ end
116
+ # verify the required parameter 'distribution_center_code' is set
117
+ if @api_client.config.client_side_validation && distribution_center_code.nil?
118
+ fail ArgumentError, "Missing the required parameter 'distribution_center_code' when calling FulfillmentApi.generate_packing_slip"
119
+ end
120
+ # verify the required parameter 'order_id' is set
121
+ if @api_client.config.client_side_validation && order_id.nil?
122
+ fail ArgumentError, "Missing the required parameter 'order_id' when calling FulfillmentApi.generate_packing_slip"
123
+ end
124
+ # resource path
125
+ local_var_path = '/fulfillment/distribution_centers/{distribution_center_code}/orders/{order_id}'.sub('{' + 'distribution_center_code' + '}', distribution_center_code.to_s).sub('{' + 'order_id' + '}', order_id.to_s)
126
+
127
+ # query parameters
128
+ query_params = {}
129
+
130
+ # header parameters
131
+ header_params = {}
132
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
133
+ # HTTP header 'Accept' (if needed)
134
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
135
+ # HTTP header 'Content-Type'
136
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
137
+
138
+ # form parameters
139
+ form_params = {}
140
+
141
+ # http body (model)
142
+ post_body = nil
143
+ auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
144
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
145
+ :header_params => header_params,
146
+ :query_params => query_params,
147
+ :form_params => form_params,
148
+ :body => post_body,
149
+ :auth_names => auth_names,
150
+ :return_type => 'OrdersResponse')
151
+ if @api_client.config.debugging
152
+ @api_client.config.logger.debug "API called: FulfillmentApi#generate_packing_slip\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
153
+ end
154
+ return data, status_code, headers
155
+ end
95
156
  # Retrieve orders queued up for this distribution center.
96
157
  # Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, buysafe, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
97
158
  # @param distribution_center_code Distribution center code
@@ -318,6 +318,122 @@ module UltracartClient
318
318
  end
319
319
  return data, status_code, headers
320
320
  end
321
+ # Generate a packing slip for this order across all distribution centers.
322
+ # The packing slip PDF that is returned is base 64 encoded
323
+ # @param order_id Order ID
324
+ # @param [Hash] opts the optional parameters
325
+ # @return [OrdersResponse]
326
+ def generate_packing_slip_all_dc(order_id, opts = {})
327
+ data, _status_code, _headers = generate_packing_slip_all_dc_with_http_info(order_id, opts)
328
+ data
329
+ end
330
+
331
+ # Generate a packing slip for this order across all distribution centers.
332
+ # The packing slip PDF that is returned is base 64 encoded
333
+ # @param order_id Order ID
334
+ # @param [Hash] opts the optional parameters
335
+ # @return [Array<(OrdersResponse, Fixnum, Hash)>] OrdersResponse data, response status code and response headers
336
+ def generate_packing_slip_all_dc_with_http_info(order_id, opts = {})
337
+ if @api_client.config.debugging
338
+ @api_client.config.logger.debug 'Calling API: OrderApi.generate_packing_slip_all_dc ...'
339
+ end
340
+ # verify the required parameter 'order_id' is set
341
+ if @api_client.config.client_side_validation && order_id.nil?
342
+ fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.generate_packing_slip_all_dc"
343
+ end
344
+ # resource path
345
+ local_var_path = '/order/orders/{order_id}/packing_slip'.sub('{' + 'order_id' + '}', order_id.to_s)
346
+
347
+ # query parameters
348
+ query_params = {}
349
+
350
+ # header parameters
351
+ header_params = {}
352
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
353
+ # HTTP header 'Accept' (if needed)
354
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
355
+ # HTTP header 'Content-Type'
356
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
357
+
358
+ # form parameters
359
+ form_params = {}
360
+
361
+ # http body (model)
362
+ post_body = nil
363
+ auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
364
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
365
+ :header_params => header_params,
366
+ :query_params => query_params,
367
+ :form_params => form_params,
368
+ :body => post_body,
369
+ :auth_names => auth_names,
370
+ :return_type => 'OrdersResponse')
371
+ if @api_client.config.debugging
372
+ @api_client.config.logger.debug "API called: OrderApi#generate_packing_slip_all_dc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
373
+ end
374
+ return data, status_code, headers
375
+ end
376
+ # Generate a packing slip for this order for the given distribution center.
377
+ # The packing slip PDF that is returned is base 64 encoded
378
+ # @param distribution_center_code Distribution center code
379
+ # @param order_id Order ID
380
+ # @param [Hash] opts the optional parameters
381
+ # @return [OrdersResponse]
382
+ def generate_packing_slip_specific_dc(distribution_center_code, order_id, opts = {})
383
+ data, _status_code, _headers = generate_packing_slip_specific_dc_with_http_info(distribution_center_code, order_id, opts)
384
+ data
385
+ end
386
+
387
+ # Generate a packing slip for this order for the given distribution center.
388
+ # The packing slip PDF that is returned is base 64 encoded
389
+ # @param distribution_center_code Distribution center code
390
+ # @param order_id Order ID
391
+ # @param [Hash] opts the optional parameters
392
+ # @return [Array<(OrdersResponse, Fixnum, Hash)>] OrdersResponse data, response status code and response headers
393
+ def generate_packing_slip_specific_dc_with_http_info(distribution_center_code, order_id, opts = {})
394
+ if @api_client.config.debugging
395
+ @api_client.config.logger.debug 'Calling API: OrderApi.generate_packing_slip_specific_dc ...'
396
+ end
397
+ # verify the required parameter 'distribution_center_code' is set
398
+ if @api_client.config.client_side_validation && distribution_center_code.nil?
399
+ fail ArgumentError, "Missing the required parameter 'distribution_center_code' when calling OrderApi.generate_packing_slip_specific_dc"
400
+ end
401
+ # verify the required parameter 'order_id' is set
402
+ if @api_client.config.client_side_validation && order_id.nil?
403
+ fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.generate_packing_slip_specific_dc"
404
+ end
405
+ # resource path
406
+ local_var_path = '/order/orders/{order_id}/packing_slip/{distribution_center_code}'.sub('{' + 'distribution_center_code' + '}', distribution_center_code.to_s).sub('{' + 'order_id' + '}', order_id.to_s)
407
+
408
+ # query parameters
409
+ query_params = {}
410
+
411
+ # header parameters
412
+ header_params = {}
413
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
414
+ # HTTP header 'Accept' (if needed)
415
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
416
+ # HTTP header 'Content-Type'
417
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
418
+
419
+ # form parameters
420
+ form_params = {}
421
+
422
+ # http body (model)
423
+ post_body = nil
424
+ auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
425
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
426
+ :header_params => header_params,
427
+ :query_params => query_params,
428
+ :form_params => form_params,
429
+ :body => post_body,
430
+ :auth_names => auth_names,
431
+ :return_type => 'OrdersResponse')
432
+ if @api_client.config.debugging
433
+ @api_client.config.logger.debug "API called: OrderApi#generate_packing_slip_specific_dc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
434
+ end
435
+ return data, status_code, headers
436
+ end
321
437
  # Retrieve A/R Retry Configuration
322
438
  # Retrieve A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.
323
439
  # @param [Hash] opts the optional parameters
@@ -2596,6 +2596,71 @@ module UltracartClient
2596
2596
  end
2597
2597
  return data, status_code, headers
2598
2598
  end
2599
+ # Get email dispatch logs
2600
+ # @param storefront_oid
2601
+ # @param commseq_uuid
2602
+ # @param commseq_step_uuid
2603
+ # @param [Hash] opts the optional parameters
2604
+ # @return [EmailCommseqStepLogsResponse]
2605
+ def get_email_dispatch_logs(storefront_oid, commseq_uuid, commseq_step_uuid, opts = {})
2606
+ data, _status_code, _headers = get_email_dispatch_logs_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts)
2607
+ data
2608
+ end
2609
+
2610
+ # Get email dispatch logs
2611
+ # @param storefront_oid
2612
+ # @param commseq_uuid
2613
+ # @param commseq_step_uuid
2614
+ # @param [Hash] opts the optional parameters
2615
+ # @return [Array<(EmailCommseqStepLogsResponse, Fixnum, Hash)>] EmailCommseqStepLogsResponse data, response status code and response headers
2616
+ def get_email_dispatch_logs_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts = {})
2617
+ if @api_client.config.debugging
2618
+ @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_dispatch_logs ...'
2619
+ end
2620
+ # verify the required parameter 'storefront_oid' is set
2621
+ if @api_client.config.client_side_validation && storefront_oid.nil?
2622
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_dispatch_logs"
2623
+ end
2624
+ # verify the required parameter 'commseq_uuid' is set
2625
+ if @api_client.config.client_side_validation && commseq_uuid.nil?
2626
+ fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.get_email_dispatch_logs"
2627
+ end
2628
+ # verify the required parameter 'commseq_step_uuid' is set
2629
+ if @api_client.config.client_side_validation && commseq_step_uuid.nil?
2630
+ fail ArgumentError, "Missing the required parameter 'commseq_step_uuid' when calling StorefrontApi.get_email_dispatch_logs"
2631
+ end
2632
+ # resource path
2633
+ local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/logs'.sub('{' + 'storefront_oid' + '}', storefront_oid.to_s).sub('{' + 'commseq_uuid' + '}', commseq_uuid.to_s).sub('{' + 'commseq_step_uuid' + '}', commseq_step_uuid.to_s)
2634
+
2635
+ # query parameters
2636
+ query_params = {}
2637
+
2638
+ # header parameters
2639
+ header_params = {}
2640
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2641
+ # HTTP header 'Accept' (if needed)
2642
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2643
+ # HTTP header 'Content-Type'
2644
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2645
+
2646
+ # form parameters
2647
+ form_params = {}
2648
+
2649
+ # http body (model)
2650
+ post_body = nil
2651
+ auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
2652
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2653
+ :header_params => header_params,
2654
+ :query_params => query_params,
2655
+ :form_params => form_params,
2656
+ :body => post_body,
2657
+ :auth_names => auth_names,
2658
+ :return_type => 'EmailCommseqStepLogsResponse')
2659
+ if @api_client.config.debugging
2660
+ @api_client.config.logger.debug "API called: StorefrontApi#get_email_dispatch_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2661
+ end
2662
+ return data, status_code, headers
2663
+ end
2599
2664
  # Get email email
2600
2665
  # @param storefront_oid
2601
2666
  # @param commseq_email_uuid
@@ -82,6 +82,9 @@ module UltracartClient
82
82
 
83
83
  attr_accessor :free_shipping_with_subtotal
84
84
 
85
+ # Hide coupon from customer during checkout. Often used when coupons are automatic discounting mechanisms.
86
+ attr_accessor :hide_from_customer
87
+
85
88
  # Merchant code of coupon up to 20 characters.
86
89
  attr_accessor :merchant_code
87
90
 
@@ -180,6 +183,7 @@ module UltracartClient
180
183
  :'free_shipping_specific_items' => :'free_shipping_specific_items',
181
184
  :'free_shipping_with_items_purchase' => :'free_shipping_with_items_purchase',
182
185
  :'free_shipping_with_subtotal' => :'free_shipping_with_subtotal',
186
+ :'hide_from_customer' => :'hide_from_customer',
183
187
  :'merchant_code' => :'merchant_code',
184
188
  :'merchant_notes' => :'merchant_notes',
185
189
  :'multiple_amounts_off_items' => :'multiple_amounts_off_items',
@@ -244,6 +248,7 @@ module UltracartClient
244
248
  :'free_shipping_specific_items' => :'CouponFreeShippingSpecificItems',
245
249
  :'free_shipping_with_items_purchase' => :'CouponFreeShippingWithItemsPurchase',
246
250
  :'free_shipping_with_subtotal' => :'CouponFreeShippingWithSubtotal',
251
+ :'hide_from_customer' => :'BOOLEAN',
247
252
  :'merchant_code' => :'String',
248
253
  :'merchant_notes' => :'String',
249
254
  :'multiple_amounts_off_items' => :'CouponMultipleAmountsOffItems',
@@ -403,6 +408,10 @@ module UltracartClient
403
408
  self.free_shipping_with_subtotal = attributes[:'free_shipping_with_subtotal']
404
409
  end
405
410
 
411
+ if attributes.has_key?(:'hide_from_customer')
412
+ self.hide_from_customer = attributes[:'hide_from_customer']
413
+ end
414
+
406
415
  if attributes.has_key?(:'merchant_code')
407
416
  self.merchant_code = attributes[:'merchant_code']
408
417
  end
@@ -660,6 +669,7 @@ module UltracartClient
660
669
  free_shipping_specific_items == o.free_shipping_specific_items &&
661
670
  free_shipping_with_items_purchase == o.free_shipping_with_items_purchase &&
662
671
  free_shipping_with_subtotal == o.free_shipping_with_subtotal &&
672
+ hide_from_customer == o.hide_from_customer &&
663
673
  merchant_code == o.merchant_code &&
664
674
  merchant_notes == o.merchant_notes &&
665
675
  multiple_amounts_off_items == o.multiple_amounts_off_items &&
@@ -699,7 +709,7 @@ module UltracartClient
699
709
  # Calculates hash code according to all attributes.
700
710
  # @return [Fixnum] Hash code
701
711
  def hash
702
- [affiliate_oid, allow_multiple_one_time_codes, amount_off_items, amount_off_shipping, amount_off_shipping_with_items_purchase, amount_off_subtotal, amount_off_subtotal_and_free_shipping, amount_off_subtotal_and_shipping, amount_off_subtotal_with_block_purchase, amount_off_subtotal_with_items_purchase, amount_off_subtotal_with_purchase, automatically_apply_coupon_codes, buy_one_get_one, calculated_description, can_be_used_with_other_coupons, coupon_oid, coupon_type, description, discount_item_with_item_purchase, discount_items, expiration_dts, free_item_and_shipping_with_subtotal, free_item_with_item_purchase, free_item_with_subtotal, free_items_with_item_purchase, free_items_with_mixmatch_purchase, free_shipping, free_shipping_specific_items, free_shipping_with_items_purchase, free_shipping_with_subtotal, merchant_code, merchant_notes, multiple_amounts_off_items, no_discount, percent_off_item_with_items_quantity_purchase, percent_off_items, percent_off_items_and_free_shipping, percent_off_items_with_items_purchase, percent_off_msrp_items, percent_off_retail_price_items, percent_off_shipping, percent_off_subtotal, percent_off_subtotal_and_free_shipping, percent_off_subtotal_limit, percent_off_subtotal_with_items_purchase, percent_off_subtotal_with_subtotal, quickbooks_code, restrict_by_postal_codes, restrict_by_screen_branding_theme_codes, restrict_by_storefronts, start_dts, super_coupon, tiered_amount_off_item, tiered_amount_off_subtotal, tiered_percent_off_items, tiered_percent_off_shipping, tiered_percent_off_subtotal, usable_by].hash
712
+ [affiliate_oid, allow_multiple_one_time_codes, amount_off_items, amount_off_shipping, amount_off_shipping_with_items_purchase, amount_off_subtotal, amount_off_subtotal_and_free_shipping, amount_off_subtotal_and_shipping, amount_off_subtotal_with_block_purchase, amount_off_subtotal_with_items_purchase, amount_off_subtotal_with_purchase, automatically_apply_coupon_codes, buy_one_get_one, calculated_description, can_be_used_with_other_coupons, coupon_oid, coupon_type, description, discount_item_with_item_purchase, discount_items, expiration_dts, free_item_and_shipping_with_subtotal, free_item_with_item_purchase, free_item_with_subtotal, free_items_with_item_purchase, free_items_with_mixmatch_purchase, free_shipping, free_shipping_specific_items, free_shipping_with_items_purchase, free_shipping_with_subtotal, hide_from_customer, merchant_code, merchant_notes, multiple_amounts_off_items, no_discount, percent_off_item_with_items_quantity_purchase, percent_off_items, percent_off_items_and_free_shipping, percent_off_items_with_items_purchase, percent_off_msrp_items, percent_off_retail_price_items, percent_off_shipping, percent_off_subtotal, percent_off_subtotal_and_free_shipping, percent_off_subtotal_limit, percent_off_subtotal_with_items_purchase, percent_off_subtotal_with_subtotal, quickbooks_code, restrict_by_postal_codes, restrict_by_screen_branding_theme_codes, restrict_by_storefronts, start_dts, super_coupon, tiered_amount_off_item, tiered_amount_off_subtotal, tiered_percent_off_items, tiered_percent_off_shipping, tiered_percent_off_subtotal, usable_by].hash
703
713
  end
704
714
 
705
715
  # Builds the object from hash
@@ -0,0 +1,205 @@
1
+ =begin
2
+ #UltraCart Rest API V2
3
+
4
+ #UltraCart REST API Version 2
5
+
6
+ OpenAPI spec version: 2.0.0
7
+ Contact: support@ultracart.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.15-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module UltracartClient
16
+ class EmailCommseqStepLog
17
+ # Email
18
+ attr_accessor :email
19
+
20
+ # Log text
21
+ attr_accessor :log
22
+
23
+ # Log date/time
24
+ attr_accessor :log_dts
25
+
26
+ # Attribute mapping from ruby-style variable name to JSON key.
27
+ def self.attribute_map
28
+ {
29
+ :'email' => :'email',
30
+ :'log' => :'log',
31
+ :'log_dts' => :'log_dts'
32
+ }
33
+ end
34
+
35
+ # Attribute type mapping.
36
+ def self.swagger_types
37
+ {
38
+ :'email' => :'String',
39
+ :'log' => :'String',
40
+ :'log_dts' => :'String'
41
+ }
42
+ end
43
+
44
+ # Initializes the object
45
+ # @param [Hash] attributes Model attributes in the form of hash
46
+ def initialize(attributes = {})
47
+ return unless attributes.is_a?(Hash)
48
+
49
+ # convert string to symbol for hash key
50
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
51
+
52
+ if attributes.has_key?(:'email')
53
+ self.email = attributes[:'email']
54
+ end
55
+
56
+ if attributes.has_key?(:'log')
57
+ self.log = attributes[:'log']
58
+ end
59
+
60
+ if attributes.has_key?(:'log_dts')
61
+ self.log_dts = attributes[:'log_dts']
62
+ end
63
+ end
64
+
65
+ # Show invalid properties with the reasons. Usually used together with valid?
66
+ # @return Array for valid properties with the reasons
67
+ def list_invalid_properties
68
+ invalid_properties = Array.new
69
+ invalid_properties
70
+ end
71
+
72
+ # Check to see if the all the properties in the model are valid
73
+ # @return true if the model is valid
74
+ def valid?
75
+ true
76
+ end
77
+
78
+ # Checks equality by comparing each attribute.
79
+ # @param [Object] Object to be compared
80
+ def ==(o)
81
+ return true if self.equal?(o)
82
+ self.class == o.class &&
83
+ email == o.email &&
84
+ log == o.log &&
85
+ log_dts == o.log_dts
86
+ end
87
+
88
+ # @see the `==` method
89
+ # @param [Object] Object to be compared
90
+ def eql?(o)
91
+ self == o
92
+ end
93
+
94
+ # Calculates hash code according to all attributes.
95
+ # @return [Fixnum] Hash code
96
+ def hash
97
+ [email, log, log_dts].hash
98
+ end
99
+
100
+ # Builds the object from hash
101
+ # @param [Hash] attributes Model attributes in the form of hash
102
+ # @return [Object] Returns the model itself
103
+ def build_from_hash(attributes)
104
+ return nil unless attributes.is_a?(Hash)
105
+ self.class.swagger_types.each_pair do |key, type|
106
+ if type =~ /\AArray<(.*)>/i
107
+ # check to ensure the input is an array given that the attribute
108
+ # is documented as an array but the input is not
109
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
110
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
111
+ end
112
+ elsif !attributes[self.class.attribute_map[key]].nil?
113
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
114
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
115
+ end
116
+
117
+ self
118
+ end
119
+
120
+ # Deserializes the data based on type
121
+ # @param string type Data type
122
+ # @param string value Value to be deserialized
123
+ # @return [Object] Deserialized data
124
+ def _deserialize(type, value)
125
+ case type.to_sym
126
+ when :DateTime
127
+ DateTime.parse(value)
128
+ when :Date
129
+ Date.parse(value)
130
+ when :String
131
+ value.to_s
132
+ when :Integer
133
+ value.to_i
134
+ when :Float
135
+ value.to_f
136
+ when :BOOLEAN
137
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
138
+ true
139
+ else
140
+ false
141
+ end
142
+ when :Object
143
+ # generic object (usually a Hash), return directly
144
+ value
145
+ when /\AArray<(?<inner_type>.+)>\z/
146
+ inner_type = Regexp.last_match[:inner_type]
147
+ value.map { |v| _deserialize(inner_type, v) }
148
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
149
+ k_type = Regexp.last_match[:k_type]
150
+ v_type = Regexp.last_match[:v_type]
151
+ {}.tap do |hash|
152
+ value.each do |k, v|
153
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
154
+ end
155
+ end
156
+ else # model
157
+ temp_model = UltracartClient.const_get(type).new
158
+ temp_model.build_from_hash(value)
159
+ end
160
+ end
161
+
162
+ # Returns the string representation of the object
163
+ # @return [String] String presentation of the object
164
+ def to_s
165
+ to_hash.to_s
166
+ end
167
+
168
+ # to_body is an alias to to_hash (backward compatibility)
169
+ # @return [Hash] Returns the object in the form of hash
170
+ def to_body
171
+ to_hash
172
+ end
173
+
174
+ # Returns the object in the form of hash
175
+ # @return [Hash] Returns the object in the form of hash
176
+ def to_hash
177
+ hash = {}
178
+ self.class.attribute_map.each_pair do |attr, param|
179
+ value = self.send(attr)
180
+ next if value.nil?
181
+ hash[param] = _to_hash(value)
182
+ end
183
+ hash
184
+ end
185
+
186
+ # Outputs non-array value in the form of hash
187
+ # For object, use to_hash. Otherwise, just return the value
188
+ # @param [Object] value Any valid value
189
+ # @return [Hash] Returns the value in the form of hash
190
+ def _to_hash(value)
191
+ if value.is_a?(Array)
192
+ value.compact.map { |v| _to_hash(v) }
193
+ elsif value.is_a?(Hash)
194
+ {}.tap do |hash|
195
+ value.each { |k, v| hash[k] = _to_hash(v) }
196
+ end
197
+ elsif value.respond_to? :to_hash
198
+ value.to_hash
199
+ else
200
+ value
201
+ end
202
+ end
203
+
204
+ end
205
+ end
@@ -0,0 +1,223 @@
1
+ =begin
2
+ #UltraCart Rest API V2
3
+
4
+ #UltraCart REST API Version 2
5
+
6
+ OpenAPI spec version: 2.0.0
7
+ Contact: support@ultracart.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.15-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module UltracartClient
16
+ class EmailCommseqStepLogsResponse
17
+ attr_accessor :error
18
+
19
+ attr_accessor :logs
20
+
21
+ attr_accessor :metadata
22
+
23
+ # Indicates if API call was successful
24
+ attr_accessor :success
25
+
26
+ attr_accessor :warning
27
+
28
+ # Attribute mapping from ruby-style variable name to JSON key.
29
+ def self.attribute_map
30
+ {
31
+ :'error' => :'error',
32
+ :'logs' => :'logs',
33
+ :'metadata' => :'metadata',
34
+ :'success' => :'success',
35
+ :'warning' => :'warning'
36
+ }
37
+ end
38
+
39
+ # Attribute type mapping.
40
+ def self.swagger_types
41
+ {
42
+ :'error' => :'Error',
43
+ :'logs' => :'Array<EmailCommseqStepLog>',
44
+ :'metadata' => :'ResponseMetadata',
45
+ :'success' => :'BOOLEAN',
46
+ :'warning' => :'Warning'
47
+ }
48
+ end
49
+
50
+ # Initializes the object
51
+ # @param [Hash] attributes Model attributes in the form of hash
52
+ def initialize(attributes = {})
53
+ return unless attributes.is_a?(Hash)
54
+
55
+ # convert string to symbol for hash key
56
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
57
+
58
+ if attributes.has_key?(:'error')
59
+ self.error = attributes[:'error']
60
+ end
61
+
62
+ if attributes.has_key?(:'logs')
63
+ if (value = attributes[:'logs']).is_a?(Array)
64
+ self.logs = value
65
+ end
66
+ end
67
+
68
+ if attributes.has_key?(:'metadata')
69
+ self.metadata = attributes[:'metadata']
70
+ end
71
+
72
+ if attributes.has_key?(:'success')
73
+ self.success = attributes[:'success']
74
+ end
75
+
76
+ if attributes.has_key?(:'warning')
77
+ self.warning = attributes[:'warning']
78
+ end
79
+ end
80
+
81
+ # Show invalid properties with the reasons. Usually used together with valid?
82
+ # @return Array for valid properties with the reasons
83
+ def list_invalid_properties
84
+ invalid_properties = Array.new
85
+ invalid_properties
86
+ end
87
+
88
+ # Check to see if the all the properties in the model are valid
89
+ # @return true if the model is valid
90
+ def valid?
91
+ true
92
+ end
93
+
94
+ # Checks equality by comparing each attribute.
95
+ # @param [Object] Object to be compared
96
+ def ==(o)
97
+ return true if self.equal?(o)
98
+ self.class == o.class &&
99
+ error == o.error &&
100
+ logs == o.logs &&
101
+ metadata == o.metadata &&
102
+ success == o.success &&
103
+ warning == o.warning
104
+ end
105
+
106
+ # @see the `==` method
107
+ # @param [Object] Object to be compared
108
+ def eql?(o)
109
+ self == o
110
+ end
111
+
112
+ # Calculates hash code according to all attributes.
113
+ # @return [Fixnum] Hash code
114
+ def hash
115
+ [error, logs, metadata, success, warning].hash
116
+ end
117
+
118
+ # Builds the object from hash
119
+ # @param [Hash] attributes Model attributes in the form of hash
120
+ # @return [Object] Returns the model itself
121
+ def build_from_hash(attributes)
122
+ return nil unless attributes.is_a?(Hash)
123
+ self.class.swagger_types.each_pair do |key, type|
124
+ if type =~ /\AArray<(.*)>/i
125
+ # check to ensure the input is an array given that the attribute
126
+ # is documented as an array but the input is not
127
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
128
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
129
+ end
130
+ elsif !attributes[self.class.attribute_map[key]].nil?
131
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
132
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
133
+ end
134
+
135
+ self
136
+ end
137
+
138
+ # Deserializes the data based on type
139
+ # @param string type Data type
140
+ # @param string value Value to be deserialized
141
+ # @return [Object] Deserialized data
142
+ def _deserialize(type, value)
143
+ case type.to_sym
144
+ when :DateTime
145
+ DateTime.parse(value)
146
+ when :Date
147
+ Date.parse(value)
148
+ when :String
149
+ value.to_s
150
+ when :Integer
151
+ value.to_i
152
+ when :Float
153
+ value.to_f
154
+ when :BOOLEAN
155
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
156
+ true
157
+ else
158
+ false
159
+ end
160
+ when :Object
161
+ # generic object (usually a Hash), return directly
162
+ value
163
+ when /\AArray<(?<inner_type>.+)>\z/
164
+ inner_type = Regexp.last_match[:inner_type]
165
+ value.map { |v| _deserialize(inner_type, v) }
166
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
167
+ k_type = Regexp.last_match[:k_type]
168
+ v_type = Regexp.last_match[:v_type]
169
+ {}.tap do |hash|
170
+ value.each do |k, v|
171
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
172
+ end
173
+ end
174
+ else # model
175
+ temp_model = UltracartClient.const_get(type).new
176
+ temp_model.build_from_hash(value)
177
+ end
178
+ end
179
+
180
+ # Returns the string representation of the object
181
+ # @return [String] String presentation of the object
182
+ def to_s
183
+ to_hash.to_s
184
+ end
185
+
186
+ # to_body is an alias to to_hash (backward compatibility)
187
+ # @return [Hash] Returns the object in the form of hash
188
+ def to_body
189
+ to_hash
190
+ end
191
+
192
+ # Returns the object in the form of hash
193
+ # @return [Hash] Returns the object in the form of hash
194
+ def to_hash
195
+ hash = {}
196
+ self.class.attribute_map.each_pair do |attr, param|
197
+ value = self.send(attr)
198
+ next if value.nil?
199
+ hash[param] = _to_hash(value)
200
+ end
201
+ hash
202
+ end
203
+
204
+ # Outputs non-array value in the form of hash
205
+ # For object, use to_hash. Otherwise, just return the value
206
+ # @param [Object] value Any valid value
207
+ # @return [Hash] Returns the value in the form of hash
208
+ def _to_hash(value)
209
+ if value.is_a?(Array)
210
+ value.compact.map { |v| _to_hash(v) }
211
+ elsif value.is_a?(Hash)
212
+ {}.tap do |hash|
213
+ value.each { |k, v| hash[k] = _to_hash(v) }
214
+ end
215
+ elsif value.respond_to? :to_hash
216
+ value.to_hash
217
+ else
218
+ value
219
+ end
220
+ end
221
+
222
+ end
223
+ end
@@ -26,13 +26,17 @@ module UltracartClient
26
26
  # Coupon code entered by the customer
27
27
  attr_accessor :coupon_code
28
28
 
29
+ # True if this coupon is hidde from the customer
30
+ attr_accessor :hdie_from_customer
31
+
29
32
  # Attribute mapping from ruby-style variable name to JSON key.
30
33
  def self.attribute_map
31
34
  {
32
35
  :'accounting_code' => :'accounting_code',
33
36
  :'automatically_applied' => :'automatically_applied',
34
37
  :'base_coupon_code' => :'base_coupon_code',
35
- :'coupon_code' => :'coupon_code'
38
+ :'coupon_code' => :'coupon_code',
39
+ :'hdie_from_customer' => :'hdie_from_customer'
36
40
  }
37
41
  end
38
42
 
@@ -42,7 +46,8 @@ module UltracartClient
42
46
  :'accounting_code' => :'String',
43
47
  :'automatically_applied' => :'BOOLEAN',
44
48
  :'base_coupon_code' => :'String',
45
- :'coupon_code' => :'String'
49
+ :'coupon_code' => :'String',
50
+ :'hdie_from_customer' => :'BOOLEAN'
46
51
  }
47
52
  end
48
53
 
@@ -69,6 +74,10 @@ module UltracartClient
69
74
  if attributes.has_key?(:'coupon_code')
70
75
  self.coupon_code = attributes[:'coupon_code']
71
76
  end
77
+
78
+ if attributes.has_key?(:'hdie_from_customer')
79
+ self.hdie_from_customer = attributes[:'hdie_from_customer']
80
+ end
72
81
  end
73
82
 
74
83
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -122,7 +131,8 @@ module UltracartClient
122
131
  accounting_code == o.accounting_code &&
123
132
  automatically_applied == o.automatically_applied &&
124
133
  base_coupon_code == o.base_coupon_code &&
125
- coupon_code == o.coupon_code
134
+ coupon_code == o.coupon_code &&
135
+ hdie_from_customer == o.hdie_from_customer
126
136
  end
127
137
 
128
138
  # @see the `==` method
@@ -134,7 +144,7 @@ module UltracartClient
134
144
  # Calculates hash code according to all attributes.
135
145
  # @return [Fixnum] Hash code
136
146
  def hash
137
- [accounting_code, automatically_applied, base_coupon_code, coupon_code].hash
147
+ [accounting_code, automatically_applied, base_coupon_code, coupon_code, hdie_from_customer].hash
138
148
  end
139
149
 
140
150
  # Builds the object from hash
@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.15-SNAPSHOT
11
11
  =end
12
12
 
13
13
  module UltracartClient
14
- VERSION = '3.2.11'
14
+ VERSION = '3.2.15'
15
15
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ultracart_api
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.2.11
4
+ version: 3.2.15
5
5
  platform: ruby
6
6
  authors:
7
7
  - UltraCart
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-07-08 00:00:00.000000000 Z
11
+ date: 2021-07-13 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -425,6 +425,8 @@ files:
425
425
  - docs/EmailCommseqStat.md
426
426
  - docs/EmailCommseqStatResponse.md
427
427
  - docs/EmailCommseqStep.md
428
+ - docs/EmailCommseqStepLog.md
429
+ - docs/EmailCommseqStepLogsResponse.md
428
430
  - docs/EmailCommseqsResponse.md
429
431
  - docs/EmailCustomer.md
430
432
  - docs/EmailCustomerEditorUrlResponse.md
@@ -1035,6 +1037,8 @@ files:
1035
1037
  - lib/ultracart_api/models/email_commseq_stat.rb
1036
1038
  - lib/ultracart_api/models/email_commseq_stat_response.rb
1037
1039
  - lib/ultracart_api/models/email_commseq_step.rb
1040
+ - lib/ultracart_api/models/email_commseq_step_log.rb
1041
+ - lib/ultracart_api/models/email_commseq_step_logs_response.rb
1038
1042
  - lib/ultracart_api/models/email_commseqs_response.rb
1039
1043
  - lib/ultracart_api/models/email_customer.rb
1040
1044
  - lib/ultracart_api/models/email_customer_editor_url_response.rb