ultracart_api 3.9.5 → 3.9.8

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 3d068d27d5807a5494204d0db5a681fb771e5b9fbabb74f59742e7d3ba59fd34
4
- data.tar.gz: fff21105856493ae872eebd2fc55135e459aaaee5a7420f14b68e64518dde142
3
+ metadata.gz: bc550dfae2f16031ee4c8f7d560de4df0ab718b6dc96a2699b32801ccf8c3be1
4
+ data.tar.gz: cbe4241585f35825355c41ff0051f11274b4c9ce4d4fd9e1cea207717a32ab0c
5
5
  SHA512:
6
- metadata.gz: 8361715af7f71ab8216227cb0484942c0d0608cfaa941fcfc7e530a020d53d805e4e5ce064316ac36f90c4160850e48991d25fa924da6feefafcba13d052332c
7
- data.tar.gz: 0ae1b6160775abc6ef98ac2b2d3be2fc1f3ee46049cc2db8b7019a6e08285c3d5934c9508c6b63842227ca3972a15a4e27a965a700a2eb2224d2c59a161b5590
6
+ metadata.gz: 2f9c11b33d19ad23f31053a94d655cf6f5bb35e85dfdcbf04f6e573890d6b49abd6dd2d89bc73d0cfb1f52ad029e64ac38c3dff2da8e8dee4c295ef3e747da07
7
+ data.tar.gz: 287841e47268091226f675ff169e86cacc8e9ecda174158534b3dc0a2c21797a4623f613875d5d00a7343fb06815a8ed6a8edf1448c2ca34960fb344b6f65828
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.9.5
10
+ - Package version: 3.9.8
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.9.5.gem
27
+ gem install ./ultracart_api-3.9.8.gem
28
28
  ```
29
- (for development, run `gem install --dev ./ultracart_api-3.9.5.gem` to install the development dependencies)
29
+ (for development, run `gem install --dev ./ultracart_api-3.9.8.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.9.5'
35
+ gem 'ultracart_api', '~> 3.9.8'
36
36
 
37
37
  ### Install from Git
38
38
 
@@ -154,6 +154,7 @@ Class | Method | HTTP request | Description
154
154
  *UltracartClient::CouponApi* | [**update_coupon**](docs/CouponApi.md#update_coupon) | **PUT** /coupon/coupons/{coupon_oid} | Update a coupon
155
155
  *UltracartClient::CouponApi* | [**update_coupons**](docs/CouponApi.md#update_coupons) | **PUT** /coupon/coupons/batch | Update multiple coupons
156
156
  *UltracartClient::CouponApi* | [**upload_coupon_codes**](docs/CouponApi.md#upload_coupon_codes) | **POST** /coupon/coupons/{coupon_oid}/upload_codes | Upload one-time codes for a coupon
157
+ *UltracartClient::CustomerApi* | [**adjust_internal_certificate**](docs/CustomerApi.md#adjust_internal_certificate) | **POST** /customer/customers/{customer_profile_oid}/adjust_cashback_balance | Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
157
158
  *UltracartClient::CustomerApi* | [**delete_customer**](docs/CustomerApi.md#delete_customer) | **DELETE** /customer/customers/{customer_profile_oid} | Delete a customer
158
159
  *UltracartClient::CustomerApi* | [**get_customer**](docs/CustomerApi.md#get_customer) | **GET** /customer/customers/{customer_profile_oid} | Retrieve a customer
159
160
  *UltracartClient::CustomerApi* | [**get_customer_by_email**](docs/CustomerApi.md#get_customer_by_email) | **GET** /customer/customers/by_email/{email} | Retrieve a customer by Email
@@ -183,6 +184,7 @@ Class | Method | HTTP request | Description
183
184
  *UltracartClient::GiftCertificateApi* | [**update_gift_certificate**](docs/GiftCertificateApi.md#update_gift_certificate) | **PUT** /gift_certificate/gift_certificates/{gift_certificate_oid} | Update a gift certificate
184
185
  *UltracartClient::IntegrationLogApi* | [**get_integration_log**](docs/IntegrationLogApi.md#get_integration_log) | **GET** /integration_log/query/{pk}/{sk} | Retrieve an integration log
185
186
  *UltracartClient::IntegrationLogApi* | [**get_integration_log_file**](docs/IntegrationLogApi.md#get_integration_log_file) | **GET** /integration_log/query/{pk}/{sk}/{uuid} | Retrieve an integration log file
187
+ *UltracartClient::IntegrationLogApi* | [**get_integration_log_file_pdf**](docs/IntegrationLogApi.md#get_integration_log_file_pdf) | **GET** /integration_log/query/{pk}/{sk}/{uuid}/pdf | Retrieve an integration log file converted to PDF
186
188
  *UltracartClient::IntegrationLogApi* | [**get_integration_log_summaries_query**](docs/IntegrationLogApi.md#get_integration_log_summaries_query) | **POST** /integration_log/summary/query | Retrieve integration log summaries
187
189
  *UltracartClient::IntegrationLogApi* | [**get_integration_logs_query**](docs/IntegrationLogApi.md#get_integration_logs_query) | **POST** /integration_log/query | Retrieve integration logs
188
190
  *UltracartClient::ItemApi* | [**delete_item**](docs/ItemApi.md#delete_item) | **DELETE** /item/items/{merchant_item_oid} | Delete an item
@@ -199,6 +201,7 @@ Class | Method | HTTP request | Description
199
201
  *UltracartClient::OrderApi* | [**adjust_order_total**](docs/OrderApi.md#adjust_order_total) | **POST** /order/orders/{order_id}/adjust_order_total/{desired_total} | Adjusts an order total
200
202
  *UltracartClient::OrderApi* | [**cancel_order**](docs/OrderApi.md#cancel_order) | **POST** /order/orders/{order_id}/cancel | Cancel an order
201
203
  *UltracartClient::OrderApi* | [**delete_order**](docs/OrderApi.md#delete_order) | **DELETE** /order/orders/{order_id} | Delete an order
204
+ *UltracartClient::OrderApi* | [**duplicate_order**](docs/OrderApi.md#duplicate_order) | **POST** /order/orders/{order_id}/duplicate | Duplicate an order
202
205
  *UltracartClient::OrderApi* | [**format**](docs/OrderApi.md#format) | **POST** /order/orders/{order_id}/format | Format order
203
206
  *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
204
207
  *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.
@@ -442,6 +445,8 @@ Class | Method | HTTP request | Description
442
445
  - [UltracartClient::AccountsReceivableRetryStatsResponse](docs/AccountsReceivableRetryStatsResponse.md)
443
446
  - [UltracartClient::Activity](docs/Activity.md)
444
447
  - [UltracartClient::AddLibraryItemRequest](docs/AddLibraryItemRequest.md)
448
+ - [UltracartClient::AdjustInternalCertificateRequest](docs/AdjustInternalCertificateRequest.md)
449
+ - [UltracartClient::AdjustInternalCertificateResponse](docs/AdjustInternalCertificateResponse.md)
445
450
  - [UltracartClient::AffiliateClick](docs/AffiliateClick.md)
446
451
  - [UltracartClient::AffiliateClickQuery](docs/AffiliateClickQuery.md)
447
452
  - [UltracartClient::AffiliateClicksResponse](docs/AffiliateClicksResponse.md)
@@ -1151,6 +1156,9 @@ Not every change is committed to every SDK.
1151
1156
 
1152
1157
  | Version | Date | Comments |
1153
1158
  | --: | :-: | --- |
1159
+ | 3.9.8 | 04/26/2022 | OrderApi.duplicateOrder |
1160
+ | 3.9.7 | 04/25/2022 | integration logs method for zpl to pdf conversion |
1161
+ | 3.9.6 | 04/25/2022 | storefront communications email magic link setting |
1154
1162
  | 3.9.5 | 04/14/2022 | postcard screenshot bug fixes |
1155
1163
  | 3.9.4 | 04/13/2022 | Added spf DNS record to the sending domain object |
1156
1164
  | 3.9.3 | 04/06/2022 | fix return object on send webhook test method |
@@ -0,0 +1,13 @@
1
+ # UltracartClient::AdjustInternalCertificateRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **adjustment_amount** | **Float** | The adjustment amount | [optional]
7
+ **description** | **String** | Description of this adjustment, 50 characters max | [optional]
8
+ **entry_dts** | **String** | Optional timestamp for the adjustment, defaults to current time | [optional]
9
+ **expiration_days** | **Integer** | Optional expiration days from the entry_dts when these adjustment becomes worthless | [optional]
10
+ **order_id** | **String** | Optional order id if this adjustment is related to a particular order | [optional]
11
+ **vesting_days** | **Integer** | Optional days required for this adjustment to vest | [optional]
12
+
13
+
@@ -0,0 +1,13 @@
1
+ # UltracartClient::AdjustInternalCertificateResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **adjustment_amount** | **Float** | The adjustment amount | [optional]
7
+ **balance_amount** | **Float** | The balance amount after the adjustment was made | [optional]
8
+ **error** | [**Error**](Error.md) | | [optional]
9
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
10
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
11
+ **warning** | [**Warning**](Warning.md) | | [optional]
12
+
13
+
data/docs/AutoOrder.md CHANGED
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
7
7
  **auto_order_oid** | **Integer** | Auto order object identifier | [optional]
8
8
  **cancel_after_next_x_orders** | **Integer** | Cancel this auto order after X additional rebills | [optional]
9
9
  **cancel_downgrade** | **BOOLEAN** | True if the auto order was canceled because the customer purchased a downgrade item | [optional]
10
+ **cancel_reason** | **String** | The reason this auto order was canceled by either merchant or customer | [optional]
10
11
  **cancel_upgrade** | **BOOLEAN** | True if the auto order was canceled because the customer purchased an upgrade item | [optional]
11
12
  **canceled_by_user** | **String** | The user that canceled the auto order | [optional]
12
13
  **canceled_dts** | **String** | The date/time that the auto order was canceled | [optional]
data/docs/CustomerApi.md CHANGED
@@ -4,6 +4,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
+ [**adjust_internal_certificate**](CustomerApi.md#adjust_internal_certificate) | **POST** /customer/customers/{customer_profile_oid}/adjust_cashback_balance | Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
7
8
  [**delete_customer**](CustomerApi.md#delete_customer) | **DELETE** /customer/customers/{customer_profile_oid} | Delete a customer
8
9
  [**get_customer**](CustomerApi.md#get_customer) | **GET** /customer/customers/{customer_profile_oid} | Retrieve a customer
9
10
  [**get_customer_by_email**](CustomerApi.md#get_customer_by_email) | **GET** /customer/customers/by_email/{email} | Retrieve a customer by Email
@@ -19,6 +20,59 @@ Method | HTTP request | Description
19
20
  [**validate_email_verification_token**](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
20
21
 
21
22
 
23
+ # **adjust_internal_certificate**
24
+ > AdjustInternalCertificateResponse adjust_internal_certificate(customer_profile_oid, adjust_internal_certificate_request)
25
+
26
+ Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
27
+
28
+ Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
29
+
30
+ ### Example
31
+ ```ruby
32
+ # load the gem
33
+ require 'ultracart_api'
34
+
35
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
36
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
37
+ api_instance = UltracartClient::CustomerApi.new_using_api_key(simple_key, false, false)
38
+
39
+
40
+ customer_profile_oid = 56 # Integer | The customer profile oid
41
+
42
+ adjust_internal_certificate_request = UltracartClient::AdjustInternalCertificateRequest.new # AdjustInternalCertificateRequest | adjustInternalCertificateRequest
43
+
44
+
45
+ begin
46
+ #Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
47
+ result = api_instance.adjust_internal_certificate(customer_profile_oid, adjust_internal_certificate_request)
48
+ p result
49
+ rescue UltracartClient::ApiError => e
50
+ puts "Exception when calling CustomerApi->adjust_internal_certificate: #{e}"
51
+ end
52
+ ```
53
+
54
+ ### Parameters
55
+
56
+ Name | Type | Description | Notes
57
+ ------------- | ------------- | ------------- | -------------
58
+ **customer_profile_oid** | **Integer**| The customer profile oid |
59
+ **adjust_internal_certificate_request** | [**AdjustInternalCertificateRequest**](AdjustInternalCertificateRequest.md)| adjustInternalCertificateRequest |
60
+
61
+ ### Return type
62
+
63
+ [**AdjustInternalCertificateResponse**](AdjustInternalCertificateResponse.md)
64
+
65
+ ### Authorization
66
+
67
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
68
+
69
+ ### HTTP request headers
70
+
71
+ - **Content-Type**: application/json; charset=UTF-8
72
+ - **Accept**: application/json
73
+
74
+
75
+
22
76
  # **delete_customer**
23
77
  > delete_customer(customer_profile_oid)
24
78
 
@@ -3,7 +3,8 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **current_points** | **Integer** | Current Points | [optional]
6
+ **current_points** | **Integer** | Current points | [optional]
7
+ **internal_gift_certificate** | [**GiftCertificate**](GiftCertificate.md) | | [optional]
7
8
  **internal_gift_certificate_balance** | **String** | Loyalty Cashback / Store credit balance (internal gift certificate balance) | [optional]
8
9
  **internal_gift_certificate_oid** | **Integer** | Internal gift certificate oid used to tracking loyalty cashback / store credit. | [optional]
9
10
  **ledger_entries** | [**Array<CustomerLoyaltyLedger>**](CustomerLoyaltyLedger.md) | Ledger entries | [optional]
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
13
13
  **filter_profile_equation_json** | **String** | Filter profile equation json | [optional]
14
14
  **individually_render** | **BOOLEAN** | Individually render | [optional]
15
15
  **library_item_oid** | **Integer** | If this item was ever added to the Code Library, this is the oid for that library item, or 0 if never added before. This value is used to determine if a library item should be inserted or updated. | [optional]
16
+ **magic_link** | **BOOLEAN** | True if email links should contain magic link tokens to log the customer in automatically | [optional]
16
17
  **merchant_id** | **String** | Merchant ID | [optional]
17
18
  **pending_review** | **BOOLEAN** | True if the content of this email is pending review by UltraCart | [optional]
18
19
  **preview_text** | **String** | Preview text | [optional]
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
11
11
  **customer_histogram** | [**EmailPerformanceCustomerHistogram**](EmailPerformanceCustomerHistogram.md) | | [optional]
12
12
  **daily_stats** | [**Array<EmailPerformanceDaily>**](EmailPerformanceDaily.md) | Daily statistics used for charting | [optional]
13
13
  **delivered_count** | **Integer** | Delivered count | [optional]
14
+ **loyalty_program_type** | **String** | Loyalty Program Type | [optional]
14
15
  **max_active_customers** | **Integer** | Maximum active customers allowed under their billing plan | [optional]
15
16
  **max_emails_per_day** | **Integer** | Max emails per day | [optional]
16
17
  **max_emails_per_hour** | **Integer** | Max emails per hour | [optional]
@@ -6,6 +6,7 @@ Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**get_integration_log**](IntegrationLogApi.md#get_integration_log) | **GET** /integration_log/query/{pk}/{sk} | Retrieve an integration log
8
8
  [**get_integration_log_file**](IntegrationLogApi.md#get_integration_log_file) | **GET** /integration_log/query/{pk}/{sk}/{uuid} | Retrieve an integration log file
9
+ [**get_integration_log_file_pdf**](IntegrationLogApi.md#get_integration_log_file_pdf) | **GET** /integration_log/query/{pk}/{sk}/{uuid}/pdf | Retrieve an integration log file converted to PDF
9
10
  [**get_integration_log_summaries_query**](IntegrationLogApi.md#get_integration_log_summaries_query) | **POST** /integration_log/summary/query | Retrieve integration log summaries
10
11
  [**get_integration_logs_query**](IntegrationLogApi.md#get_integration_logs_query) | **POST** /integration_log/query | Retrieve integration logs
11
12
 
@@ -119,6 +120,62 @@ Name | Type | Description | Notes
119
120
 
120
121
 
121
122
 
123
+ # **get_integration_log_file_pdf**
124
+ > File get_integration_log_file_pdf(pk, sk, uuid)
125
+
126
+ Retrieve an integration log file converted to PDF
127
+
128
+ Retrieve an integration log file from the account based identifiers
129
+
130
+ ### Example
131
+ ```ruby
132
+ # load the gem
133
+ require 'ultracart_api'
134
+
135
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
136
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
137
+ api_instance = UltracartClient::IntegrationLogApi.new_using_api_key(simple_key, false, false)
138
+
139
+
140
+ pk = 'pk_example' # String |
141
+
142
+ sk = 'sk_example' # String |
143
+
144
+ uuid = 'uuid_example' # String |
145
+
146
+
147
+ begin
148
+ #Retrieve an integration log file converted to PDF
149
+ result = api_instance.get_integration_log_file_pdf(pk, sk, uuid)
150
+ p result
151
+ rescue UltracartClient::ApiError => e
152
+ puts "Exception when calling IntegrationLogApi->get_integration_log_file_pdf: #{e}"
153
+ end
154
+ ```
155
+
156
+ ### Parameters
157
+
158
+ Name | Type | Description | Notes
159
+ ------------- | ------------- | ------------- | -------------
160
+ **pk** | **String**| |
161
+ **sk** | **String**| |
162
+ **uuid** | **String**| |
163
+
164
+ ### Return type
165
+
166
+ **File**
167
+
168
+ ### Authorization
169
+
170
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
171
+
172
+ ### HTTP request headers
173
+
174
+ - **Content-Type**: application/json
175
+ - **Accept**: application/octet-stream
176
+
177
+
178
+
122
179
  # **get_integration_log_summaries_query**
123
180
  > IntegrationLogSummaryQueryResponse get_integration_log_summaries_query(integration_log_summaries_query)
124
181
 
data/docs/OrderApi.md CHANGED
@@ -7,6 +7,7 @@ Method | HTTP request | Description
7
7
  [**adjust_order_total**](OrderApi.md#adjust_order_total) | **POST** /order/orders/{order_id}/adjust_order_total/{desired_total} | Adjusts an order total
8
8
  [**cancel_order**](OrderApi.md#cancel_order) | **POST** /order/orders/{order_id}/cancel | Cancel an order
9
9
  [**delete_order**](OrderApi.md#delete_order) | **DELETE** /order/orders/{order_id} | Delete an order
10
+ [**duplicate_order**](OrderApi.md#duplicate_order) | **POST** /order/orders/{order_id}/duplicate | Duplicate an order
10
11
  [**format**](OrderApi.md#format) | **POST** /order/orders/{order_id}/format | Format order
11
12
  [**generate_order_token**](OrderApi.md#generate_order_token) | **GET** /order/orders/token/{order_id} | Generate an order token for a given order id
12
13
  [**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.
@@ -180,6 +181,60 @@ nil (empty response body)
180
181
 
181
182
 
182
183
 
184
+ # **duplicate_order**
185
+ > OrderResponse duplicate_order(order_id, opts)
186
+
187
+ Duplicate an order
188
+
189
+ Perform a duplicate of the specified order_id and return a new order located in Accounts Receivable.
190
+
191
+ ### Example
192
+ ```ruby
193
+ # load the gem
194
+ require 'ultracart_api'
195
+
196
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
197
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
198
+ api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
199
+
200
+
201
+ order_id = 'order_id_example' # String | The order id to duplicate.
202
+
203
+ opts = {
204
+ _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
205
+ }
206
+
207
+ begin
208
+ #Duplicate an order
209
+ result = api_instance.duplicate_order(order_id, opts)
210
+ p result
211
+ rescue UltracartClient::ApiError => e
212
+ puts "Exception when calling OrderApi->duplicate_order: #{e}"
213
+ end
214
+ ```
215
+
216
+ ### Parameters
217
+
218
+ Name | Type | Description | Notes
219
+ ------------- | ------------- | ------------- | -------------
220
+ **order_id** | **String**| The order id to duplicate. |
221
+ **_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
222
+
223
+ ### Return type
224
+
225
+ [**OrderResponse**](OrderResponse.md)
226
+
227
+ ### Authorization
228
+
229
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
230
+
231
+ ### HTTP request headers
232
+
233
+ - **Content-Type**: application/json; charset=UTF-8
234
+ - **Accept**: application/json
235
+
236
+
237
+
183
238
  # **format**
184
239
  > OrderFormatResponse format(order_id, format_options)
185
240
 
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
7
7
  **auto_order_oid** | **Integer** | Auto order object identifier | [optional]
8
8
  **cancel_after_next_x_orders** | **Integer** | Cancel this auto order after X additional rebills | [optional]
9
9
  **cancel_downgrade** | **BOOLEAN** | True if the auto order was canceled because the customer purchased a downgrade item | [optional]
10
+ **cancel_reason** | **String** | The reason this auto order was canceled by either merchant or customer | [optional]
10
11
  **cancel_upgrade** | **BOOLEAN** | True if the auto order was canceled because the customer purchased an upgrade item | [optional]
11
12
  **canceled_by_user** | **String** | The user that canceled the auto order | [optional]
12
13
  **canceled_dts** | **String** | The date/time that the auto order was canceled | [optional]
@@ -32,6 +32,67 @@ module UltracartClient
32
32
  UltracartClient::CustomerApi.new(api_client)
33
33
  end
34
34
 
35
+ # Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
36
+ # Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
37
+ # @param customer_profile_oid The customer profile oid
38
+ # @param adjust_internal_certificate_request adjustInternalCertificateRequest
39
+ # @param [Hash] opts the optional parameters
40
+ # @return [AdjustInternalCertificateResponse]
41
+ def adjust_internal_certificate(customer_profile_oid, adjust_internal_certificate_request, opts = {})
42
+ data, _status_code, _headers = adjust_internal_certificate_with_http_info(customer_profile_oid, adjust_internal_certificate_request, opts)
43
+ data
44
+ end
45
+
46
+ # Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
47
+ # Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
48
+ # @param customer_profile_oid The customer profile oid
49
+ # @param adjust_internal_certificate_request adjustInternalCertificateRequest
50
+ # @param [Hash] opts the optional parameters
51
+ # @return [Array<(AdjustInternalCertificateResponse, Fixnum, Hash)>] AdjustInternalCertificateResponse data, response status code and response headers
52
+ def adjust_internal_certificate_with_http_info(customer_profile_oid, adjust_internal_certificate_request, opts = {})
53
+ if @api_client.config.debugging
54
+ @api_client.config.logger.debug 'Calling API: CustomerApi.adjust_internal_certificate ...'
55
+ end
56
+ # verify the required parameter 'customer_profile_oid' is set
57
+ if @api_client.config.client_side_validation && customer_profile_oid.nil?
58
+ fail ArgumentError, "Missing the required parameter 'customer_profile_oid' when calling CustomerApi.adjust_internal_certificate"
59
+ end
60
+ # verify the required parameter 'adjust_internal_certificate_request' is set
61
+ if @api_client.config.client_side_validation && adjust_internal_certificate_request.nil?
62
+ fail ArgumentError, "Missing the required parameter 'adjust_internal_certificate_request' when calling CustomerApi.adjust_internal_certificate"
63
+ end
64
+ # resource path
65
+ local_var_path = '/customer/customers/{customer_profile_oid}/adjust_cashback_balance'.sub('{' + 'customer_profile_oid' + '}', customer_profile_oid.to_s)
66
+
67
+ # query parameters
68
+ query_params = {}
69
+
70
+ # header parameters
71
+ header_params = {}
72
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
73
+ # HTTP header 'Accept' (if needed)
74
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
75
+ # HTTP header 'Content-Type'
76
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
77
+
78
+ # form parameters
79
+ form_params = {}
80
+
81
+ # http body (model)
82
+ post_body = @api_client.object_to_http_body(adjust_internal_certificate_request)
83
+ auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
84
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
85
+ :header_params => header_params,
86
+ :query_params => query_params,
87
+ :form_params => form_params,
88
+ :body => post_body,
89
+ :auth_names => auth_names,
90
+ :return_type => 'AdjustInternalCertificateResponse')
91
+ if @api_client.config.debugging
92
+ @api_client.config.logger.debug "API called: CustomerApi#adjust_internal_certificate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
93
+ end
94
+ return data, status_code, headers
95
+ end
35
96
  # Delete a customer
36
97
  # Delete a customer on the UltraCart account.
37
98
  # @param customer_profile_oid The customer_profile_oid to delete.
@@ -160,6 +160,73 @@ module UltracartClient
160
160
  end
161
161
  return data, status_code, headers
162
162
  end
163
+ # Retrieve an integration log file converted to PDF
164
+ # Retrieve an integration log file from the account based identifiers
165
+ # @param pk
166
+ # @param sk
167
+ # @param uuid
168
+ # @param [Hash] opts the optional parameters
169
+ # @return [File]
170
+ def get_integration_log_file_pdf(pk, sk, uuid, opts = {})
171
+ data, _status_code, _headers = get_integration_log_file_pdf_with_http_info(pk, sk, uuid, opts)
172
+ data
173
+ end
174
+
175
+ # Retrieve an integration log file converted to PDF
176
+ # Retrieve an integration log file from the account based identifiers
177
+ # @param pk
178
+ # @param sk
179
+ # @param uuid
180
+ # @param [Hash] opts the optional parameters
181
+ # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
182
+ def get_integration_log_file_pdf_with_http_info(pk, sk, uuid, opts = {})
183
+ if @api_client.config.debugging
184
+ @api_client.config.logger.debug 'Calling API: IntegrationLogApi.get_integration_log_file_pdf ...'
185
+ end
186
+ # verify the required parameter 'pk' is set
187
+ if @api_client.config.client_side_validation && pk.nil?
188
+ fail ArgumentError, "Missing the required parameter 'pk' when calling IntegrationLogApi.get_integration_log_file_pdf"
189
+ end
190
+ # verify the required parameter 'sk' is set
191
+ if @api_client.config.client_side_validation && sk.nil?
192
+ fail ArgumentError, "Missing the required parameter 'sk' when calling IntegrationLogApi.get_integration_log_file_pdf"
193
+ end
194
+ # verify the required parameter 'uuid' is set
195
+ if @api_client.config.client_side_validation && uuid.nil?
196
+ fail ArgumentError, "Missing the required parameter 'uuid' when calling IntegrationLogApi.get_integration_log_file_pdf"
197
+ end
198
+ # resource path
199
+ local_var_path = '/integration_log/query/{pk}/{sk}/{uuid}/pdf'.sub('{' + 'pk' + '}', pk.to_s).sub('{' + 'sk' + '}', sk.to_s).sub('{' + 'uuid' + '}', uuid.to_s)
200
+
201
+ # query parameters
202
+ query_params = {}
203
+
204
+ # header parameters
205
+ header_params = {}
206
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
207
+ # HTTP header 'Accept' (if needed)
208
+ header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
209
+ # HTTP header 'Content-Type'
210
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
211
+
212
+ # form parameters
213
+ form_params = {}
214
+
215
+ # http body (model)
216
+ post_body = nil
217
+ auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
218
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
219
+ :header_params => header_params,
220
+ :query_params => query_params,
221
+ :form_params => form_params,
222
+ :body => post_body,
223
+ :auth_names => auth_names,
224
+ :return_type => 'File')
225
+ if @api_client.config.debugging
226
+ @api_client.config.logger.debug "API called: IntegrationLogApi#get_integration_log_file_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
227
+ end
228
+ return data, status_code, headers
229
+ end
163
230
  # Retrieve integration log summaries
164
231
  # Retrieves a set of integration log summaries from the account based on a query object.
165
232
  # @param integration_log_summaries_query Integration log summaries query
@@ -202,6 +202,64 @@ module UltracartClient
202
202
  end
203
203
  return data, status_code, headers
204
204
  end
205
+ # Duplicate an order
206
+ # Perform a duplicate of the specified order_id and return a new order located in Accounts Receivable.
207
+ # @param order_id The order id to duplicate.
208
+ # @param [Hash] opts the optional parameters
209
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
210
+ # @return [OrderResponse]
211
+ def duplicate_order(order_id, opts = {})
212
+ data, _status_code, _headers = duplicate_order_with_http_info(order_id, opts)
213
+ data
214
+ end
215
+
216
+ # Duplicate an order
217
+ # Perform a duplicate of the specified order_id and return a new order located in Accounts Receivable.
218
+ # @param order_id The order id to duplicate.
219
+ # @param [Hash] opts the optional parameters
220
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
221
+ # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
222
+ def duplicate_order_with_http_info(order_id, opts = {})
223
+ if @api_client.config.debugging
224
+ @api_client.config.logger.debug 'Calling API: OrderApi.duplicate_order ...'
225
+ end
226
+ # verify the required parameter 'order_id' is set
227
+ if @api_client.config.client_side_validation && order_id.nil?
228
+ fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.duplicate_order"
229
+ end
230
+ # resource path
231
+ local_var_path = '/order/orders/{order_id}/duplicate'.sub('{' + 'order_id' + '}', order_id.to_s)
232
+
233
+ # query parameters
234
+ query_params = {}
235
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
236
+
237
+ # header parameters
238
+ header_params = {}
239
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
240
+ # HTTP header 'Accept' (if needed)
241
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
242
+ # HTTP header 'Content-Type'
243
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
244
+
245
+ # form parameters
246
+ form_params = {}
247
+
248
+ # http body (model)
249
+ post_body = nil
250
+ auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
251
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
252
+ :header_params => header_params,
253
+ :query_params => query_params,
254
+ :form_params => form_params,
255
+ :body => post_body,
256
+ :auth_names => auth_names,
257
+ :return_type => 'OrderResponse')
258
+ if @api_client.config.debugging
259
+ @api_client.config.logger.debug "API called: OrderApi#duplicate_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
260
+ end
261
+ return data, status_code, headers
262
+ end
205
263
  # Format order
206
264
  # Format the order for display at text or html
207
265
  # @param order_id The order id to format