ultra_cart_rest_api_v2 3.9.6 → 3.10.0

package/README.md

@@ -5,7 +5,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0.0
-- Package version: 3.9.6
+- Package version: 3.10.0
 - Build package: io.swagger.codegen.languages.JavascriptClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -136,6 +136,10 @@ Class | Method | HTTP request | Description
 *UltraCartRestApiV2.AutoOrderApi* | [**getAutoOrdersByQuery**](docs/AutoOrderApi.md#getAutoOrdersByQuery) | **POST** /auto_order/auto_orders/query | Retrieve auto orders by query
 *UltraCartRestApiV2.AutoOrderApi* | [**updateAutoOrder**](docs/AutoOrderApi.md#updateAutoOrder) | **PUT** /auto_order/auto_orders/{auto_order_oid} | Update an auto order
 *UltraCartRestApiV2.AutoOrderApi* | [**updateAutoOrdersBatch**](docs/AutoOrderApi.md#updateAutoOrdersBatch) | **PUT** /auto_order/auto_orders/batch | Update multiple auto orders
+*UltraCartRestApiV2.ChannelPartnerApi* | [**cancelOrderByChannelPartnerOrderId**](docs/ChannelPartnerApi.md#cancelOrderByChannelPartnerOrderId) | **DELETE** /channel_partner/cancel/by_channel_partner_order_id/{order_id} | Cancel channel partner order by channel partner order id
+*UltraCartRestApiV2.ChannelPartnerApi* | [**cancelOrderByChannelUltraCartOrderId**](docs/ChannelPartnerApi.md#cancelOrderByChannelUltraCartOrderId) | **DELETE** /channel_partner/cancel/by_ultracart_order_id/{order_id} | Cancel channel partner order by UltraCart order id
+*UltraCartRestApiV2.ChannelPartnerApi* | [**estimateShippingForChannelPartnerOrder**](docs/ChannelPartnerApi.md#estimateShippingForChannelPartnerOrder) | **POST** /channel_partner/estimate_shipping | Estimate shipping for channel partner order
+*UltraCartRestApiV2.ChannelPartnerApi* | [**importChannelPartnerOrder**](docs/ChannelPartnerApi.md#importChannelPartnerOrder) | **POST** /channel_partner/import | Insert channel partner order
 *UltraCartRestApiV2.ChargebackApi* | [**deleteChargeback**](docs/ChargebackApi.md#deleteChargeback) | **DELETE** /chargeback/chargebacks/{chargeback_dispute_oid} | Delete a chargeback
 *UltraCartRestApiV2.ChargebackApi* | [**getChargebackDispute**](docs/ChargebackApi.md#getChargebackDispute) | **GET** /chargeback/chargebacks/{chargeback_dispute_oid} | Retrieve a chargeback
 *UltraCartRestApiV2.ChargebackApi* | [**getChargebackDisputes**](docs/ChargebackApi.md#getChargebackDisputes) | **GET** /chargeback/chargebacks | Retrieve chargebacks
@@ -194,6 +198,7 @@ Class | Method | HTTP request | Description
 *UltraCartRestApiV2.CouponApi* | [**updateCoupon**](docs/CouponApi.md#updateCoupon) | **PUT** /coupon/coupons/{coupon_oid} | Update a coupon
 *UltraCartRestApiV2.CouponApi* | [**updateCoupons**](docs/CouponApi.md#updateCoupons) | **PUT** /coupon/coupons/batch | Update multiple coupons
 *UltraCartRestApiV2.CouponApi* | [**uploadCouponCodes**](docs/CouponApi.md#uploadCouponCodes) | **POST** /coupon/coupons/{coupon_oid}/upload_codes | Upload one-time codes for a coupon
+*UltraCartRestApiV2.CustomerApi* | [**adjustInternalCertificate**](docs/CustomerApi.md#adjustInternalCertificate) | **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.
 *UltraCartRestApiV2.CustomerApi* | [**deleteCustomer**](docs/CustomerApi.md#deleteCustomer) | **DELETE** /customer/customers/{customer_profile_oid} | Delete a customer
 *UltraCartRestApiV2.CustomerApi* | [**getCustomer**](docs/CustomerApi.md#getCustomer) | **GET** /customer/customers/{customer_profile_oid} | Retrieve a customer
 *UltraCartRestApiV2.CustomerApi* | [**getCustomerByEmail**](docs/CustomerApi.md#getCustomerByEmail) | **GET** /customer/customers/by_email/{email} | Retrieve a customer by Email
@@ -223,6 +228,7 @@ Class | Method | HTTP request | Description
 *UltraCartRestApiV2.GiftCertificateApi* | [**updateGiftCertificate**](docs/GiftCertificateApi.md#updateGiftCertificate) | **PUT** /gift_certificate/gift_certificates/{gift_certificate_oid} | Update a gift certificate
 *UltraCartRestApiV2.IntegrationLogApi* | [**getIntegrationLog**](docs/IntegrationLogApi.md#getIntegrationLog) | **GET** /integration_log/query/{pk}/{sk} | Retrieve an integration log
 *UltraCartRestApiV2.IntegrationLogApi* | [**getIntegrationLogFile**](docs/IntegrationLogApi.md#getIntegrationLogFile) | **GET** /integration_log/query/{pk}/{sk}/{uuid} | Retrieve an integration log file
+*UltraCartRestApiV2.IntegrationLogApi* | [**getIntegrationLogFilePdf**](docs/IntegrationLogApi.md#getIntegrationLogFilePdf) | **GET** /integration_log/query/{pk}/{sk}/{uuid}/pdf | Retrieve an integration log file converted to PDF
 *UltraCartRestApiV2.IntegrationLogApi* | [**getIntegrationLogSummariesQuery**](docs/IntegrationLogApi.md#getIntegrationLogSummariesQuery) | **POST** /integration_log/summary/query | Retrieve integration log summaries
 *UltraCartRestApiV2.IntegrationLogApi* | [**getIntegrationLogsQuery**](docs/IntegrationLogApi.md#getIntegrationLogsQuery) | **POST** /integration_log/query | Retrieve integration logs
 *UltraCartRestApiV2.ItemApi* | [**deleteItem**](docs/ItemApi.md#deleteItem) | **DELETE** /item/items/{merchant_item_oid} | Delete an item
@@ -239,6 +245,7 @@ Class | Method | HTTP request | Description
 *UltraCartRestApiV2.OrderApi* | [**adjustOrderTotal**](docs/OrderApi.md#adjustOrderTotal) | **POST** /order/orders/{order_id}/adjust_order_total/{desired_total} | Adjusts an order total
 *UltraCartRestApiV2.OrderApi* | [**cancelOrder**](docs/OrderApi.md#cancelOrder) | **POST** /order/orders/{order_id}/cancel | Cancel an order
 *UltraCartRestApiV2.OrderApi* | [**deleteOrder**](docs/OrderApi.md#deleteOrder) | **DELETE** /order/orders/{order_id} | Delete an order
+*UltraCartRestApiV2.OrderApi* | [**duplicateOrder**](docs/OrderApi.md#duplicateOrder) | **POST** /order/orders/{order_id}/duplicate | Duplicate an order
 *UltraCartRestApiV2.OrderApi* | [**format**](docs/OrderApi.md#format) | **POST** /order/orders/{order_id}/format | Format order
 *UltraCartRestApiV2.OrderApi* | [**generateOrderToken**](docs/OrderApi.md#generateOrderToken) | **GET** /order/orders/token/{order_id} | Generate an order token for a given order id
 *UltraCartRestApiV2.OrderApi* | [**generatePackingSlipAllDC**](docs/OrderApi.md#generatePackingSlipAllDC) | **GET** /order/orders/{order_id}/packing_slip | Generate a packing slip for this order across all distribution centers.
@@ -482,6 +489,8 @@ Class | Method | HTTP request | Description
  - [UltraCartRestApiV2.AccountsReceivableRetryStatsResponse](docs/AccountsReceivableRetryStatsResponse.md)
  - [UltraCartRestApiV2.Activity](docs/Activity.md)
  - [UltraCartRestApiV2.AddLibraryItemRequest](docs/AddLibraryItemRequest.md)
+ - [UltraCartRestApiV2.AdjustInternalCertificateRequest](docs/AdjustInternalCertificateRequest.md)
+ - [UltraCartRestApiV2.AdjustInternalCertificateResponse](docs/AdjustInternalCertificateResponse.md)
  - [UltraCartRestApiV2.AffiliateClick](docs/AffiliateClick.md)
  - [UltraCartRestApiV2.AffiliateClickQuery](docs/AffiliateClickQuery.md)
  - [UltraCartRestApiV2.AffiliateClicksResponse](docs/AffiliateClicksResponse.md)
@@ -567,6 +576,15 @@ Class | Method | HTTP request | Description
  - [UltraCartRestApiV2.CartUpsellAfter](docs/CartUpsellAfter.md)
  - [UltraCartRestApiV2.CartValidationRequest](docs/CartValidationRequest.md)
  - [UltraCartRestApiV2.CartValidationResponse](docs/CartValidationResponse.md)
+ - [UltraCartRestApiV2.ChannelPartnerCancelResponse](docs/ChannelPartnerCancelResponse.md)
+ - [UltraCartRestApiV2.ChannelPartnerEstimateShippingResponse](docs/ChannelPartnerEstimateShippingResponse.md)
+ - [UltraCartRestApiV2.ChannelPartnerImportResponse](docs/ChannelPartnerImportResponse.md)
+ - [UltraCartRestApiV2.ChannelPartnerOrder](docs/ChannelPartnerOrder.md)
+ - [UltraCartRestApiV2.ChannelPartnerOrderItem](docs/ChannelPartnerOrderItem.md)
+ - [UltraCartRestApiV2.ChannelPartnerOrderItemOption](docs/ChannelPartnerOrderItemOption.md)
+ - [UltraCartRestApiV2.ChannelPartnerOrderTransaction](docs/ChannelPartnerOrderTransaction.md)
+ - [UltraCartRestApiV2.ChannelPartnerOrderTransactionDetail](docs/ChannelPartnerOrderTransactionDetail.md)
+ - [UltraCartRestApiV2.ChannelPartnerShippingEstimate](docs/ChannelPartnerShippingEstimate.md)
  - [UltraCartRestApiV2.ChargebackDispute](docs/ChargebackDispute.md)
  - [UltraCartRestApiV2.ChargebackDisputeResponse](docs/ChargebackDisputeResponse.md)
  - [UltraCartRestApiV2.ChargebackDisputesResponse](docs/ChargebackDisputesResponse.md)
@@ -1148,6 +1166,8 @@ Class | Method | HTTP request | Description
   - auto_order_write: Allows you to write auto order information.
   - chargeback_read: Allows you to read chargeback information.
   - chargeback_write: Allows you to write chargeback information.
+  - channel_partner_read: Allows you to read channel partner information.
+  - channel_partner_write: Allows you to write channel partner information.
   - checkout_read: Allows you to read checkout information.
   - checkout_write: Allows you to write checkout information.
   - configuration_read: Allows you to read configuration information.
@@ -1191,6 +1211,9 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.0 | 05/10/2022 | beta release of ChannelPartnerApi |
+| 3.9.8 | 04/26/2022 | OrderApi.duplicateOrder |
+| 3.9.7 | 04/25/2022 | integration logs method for zpl to pdf conversion |
 | 3.9.6 | 04/25/2022 | storefront communications email magic link setting |
 | 3.9.5 | 04/14/2022 | postcard screenshot bug fixes |
 | 3.9.4 | 04/13/2022 | Added spf DNS record to the sending domain object |

package/docs/AdjustInternalCertificateRequest.md

@@ -0,0 +1,13 @@
+# UltraCartRestApiV2.AdjustInternalCertificateRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**adjustment_amount** | **Number** | The adjustment amount | [optional] 
+**description** | **String** | Description of this adjustment, 50 characters max | [optional] 
+**entry_dts** | **String** | Optional timestamp for the adjustment, defaults to current time | [optional] 
+**expiration_days** | **Number** | Optional expiration days from the entry_dts when these adjustment becomes worthless | [optional] 
+**order_id** | **String** | Optional order id if this adjustment is related to a particular order | [optional] 
+**vesting_days** | **Number** | Optional days required for this adjustment to vest | [optional] 
+
+

package/docs/AdjustInternalCertificateResponse.md

@@ -0,0 +1,13 @@
+# UltraCartRestApiV2.AdjustInternalCertificateResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**adjustment_amount** | **Number** | The adjustment amount | [optional] 
+**balance_amount** | **Number** | The balance amount after the adjustment was made | [optional] 
+**error** | [**Error**](Error.md) |  | [optional] 
+**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**success** | **Boolean** | Indicates if API call was successful | [optional] 
+**warning** | [**Warning**](Warning.md) |  | [optional] 
+
+

package/docs/CartSettingsShippingEstimate.md

@@ -14,6 +14,7 @@ Name | Type | Description | Notes
 **estimated_delivery** | **String** | Date of the estimated delivery (or range) | [optional] 
 **lift_gate_option** | **Boolean** | True if a lift gate option for this method should be offered to the customer | [optional] 
 **name** | **String** | Shipping method name | [optional] 
+**pickup** | **Boolean** | True if this shipping method requires customers to physically pickup product themselves | [optional] 
 **tax** | [**Currency**](Currency.md) |  | [optional] 
 **total_tax** | [**Currency**](Currency.md) |  | [optional] 
 

package/docs/ChannelPartnerApi.md

@@ -0,0 +1,212 @@
+# UltraCartRestApiV2.ChannelPartnerApi
+
+All URIs are relative to *https://secure.ultracart.com/rest/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**cancelOrderByChannelPartnerOrderId**](ChannelPartnerApi.md#cancelOrderByChannelPartnerOrderId) | **DELETE** /channel_partner/cancel/by_channel_partner_order_id/{order_id} | Cancel channel partner order by channel partner order id
+[**cancelOrderByChannelUltraCartOrderId**](ChannelPartnerApi.md#cancelOrderByChannelUltraCartOrderId) | **DELETE** /channel_partner/cancel/by_ultracart_order_id/{order_id} | Cancel channel partner order by UltraCart order id
+[**estimateShippingForChannelPartnerOrder**](ChannelPartnerApi.md#estimateShippingForChannelPartnerOrder) | **POST** /channel_partner/estimate_shipping | Estimate shipping for channel partner order
+[**importChannelPartnerOrder**](ChannelPartnerApi.md#importChannelPartnerOrder) | **POST** /channel_partner/import | Insert channel partner order
+
+
+<a name="cancelOrderByChannelPartnerOrderId"></a>
+# **cancelOrderByChannelPartnerOrderId**
+> ChannelPartnerCancelResponse cancelOrderByChannelPartnerOrderId(order_id)
+
+Cancel channel partner order by channel partner order id
+
+Cancel channel partner order by channel partner order id 
+
+### Example
+```javascript
+var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
+
+// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
+UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
+var apiInstance = new UltraCartRestApiV2.ChannelPartnerApi();
+
+
+var order_id = "order_id_example"; // String | The channel partner order id to delete.
+
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+apiInstance.cancelOrderByChannelPartnerOrderId(order_id, callback);
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **order_id** | **String**| The channel partner order id to delete. | 
+
+### Return type
+
+[**ChannelPartnerCancelResponse**](ChannelPartnerCancelResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+<a name="cancelOrderByChannelUltraCartOrderId"></a>
+# **cancelOrderByChannelUltraCartOrderId**
+> ChannelPartnerCancelResponse cancelOrderByChannelUltraCartOrderId(order_id)
+
+Cancel channel partner order by UltraCart order id
+
+Cancel channel partner order by UltraCart order id 
+
+### Example
+```javascript
+var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
+
+// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
+UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
+var apiInstance = new UltraCartRestApiV2.ChannelPartnerApi();
+
+
+var order_id = "order_id_example"; // String | The UltraCart order id to delete.
+
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+apiInstance.cancelOrderByChannelUltraCartOrderId(order_id, callback);
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **order_id** | **String**| The UltraCart order id to delete. | 
+
+### Return type
+
+[**ChannelPartnerCancelResponse**](ChannelPartnerCancelResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+<a name="estimateShippingForChannelPartnerOrder"></a>
+# **estimateShippingForChannelPartnerOrder**
+> ChannelPartnerEstimateShippingResponse estimateShippingForChannelPartnerOrder(channel_partner_order)
+
+Estimate shipping for channel partner order
+
+Estimate shipping for order from a channel partner. 
+
+### Example
+```javascript
+var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
+
+// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
+UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
+var apiInstance = new UltraCartRestApiV2.ChannelPartnerApi();
+
+
+var channel_partner_order = new UltraCartRestApiV2.ChannelPartnerOrder(); // ChannelPartnerOrder | Order needing shipping estimate
+
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+apiInstance.estimateShippingForChannelPartnerOrder(channel_partner_order, callback);
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **channel_partner_order** | [**ChannelPartnerOrder**](ChannelPartnerOrder.md)| Order needing shipping estimate | 
+
+### Return type
+
+[**ChannelPartnerEstimateShippingResponse**](ChannelPartnerEstimateShippingResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+<a name="importChannelPartnerOrder"></a>
+# **importChannelPartnerOrder**
+> ChannelPartnerImportResponse importChannelPartnerOrder(channel_partner_order)
+
+Insert channel partner order
+
+Insert order from a channel partner. 
+
+### Example
+```javascript
+var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
+
+// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
+UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
+var apiInstance = new UltraCartRestApiV2.ChannelPartnerApi();
+
+
+var channel_partner_order = new UltraCartRestApiV2.ChannelPartnerOrder(); // ChannelPartnerOrder | Order to insert
+
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+apiInstance.importChannelPartnerOrder(channel_partner_order, callback);
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **channel_partner_order** | [**ChannelPartnerOrder**](ChannelPartnerOrder.md)| Order to insert | 
+
+### Return type
+
+[**ChannelPartnerImportResponse**](ChannelPartnerImportResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+

package/docs/ChannelPartnerCancelResponse.md

@@ -0,0 +1,12 @@
+# UltraCartRestApiV2.ChannelPartnerCancelResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cancel_errors** | **[String]** | Array of errors if errors occurred | [optional] 
+**error** | [**Error**](Error.md) |  | [optional] 
+**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**success** | **Boolean** | Indicates if API call was successful | [optional] 
+**warning** | [**Warning**](Warning.md) |  | [optional] 
+
+

package/docs/ChannelPartnerEstimateShippingResponse.md

@@ -0,0 +1,12 @@
+# UltraCartRestApiV2.ChannelPartnerEstimateShippingResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**Error**](Error.md) |  | [optional] 
+**estimates** | [**[ChannelPartnerShippingEstimate]**](ChannelPartnerShippingEstimate.md) | An array of shipping methods and their costs | [optional] 
+**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**success** | **Boolean** | Indicates if API call was successful | [optional] 
+**warning** | [**Warning**](Warning.md) |  | [optional] 
+
+

package/docs/ChannelPartnerImportResponse.md

@@ -0,0 +1,13 @@
+# UltraCartRestApiV2.ChannelPartnerImportResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**Error**](Error.md) |  | [optional] 
+**import_errors** | **[String]** | Array of errors if errors occurred | [optional] 
+**import_warnings** | **[String]** | Array of warnings if warnings occurred | [optional] 
+**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**success** | **Boolean** | Indicates if API call was successful | [optional] 
+**warning** | [**Warning**](Warning.md) |  | [optional] 
+
+

package/docs/ChannelPartnerOrder.md

@@ -0,0 +1,116 @@
+# UltraCartRestApiV2.ChannelPartnerOrder
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**advertisingSource** | **String** | advertising_source | [optional] 
+**affiliate_id** | **String** | Affiliate Id | [optional] 
+**affiliate_sub_id** | **String** | Affiliate Sub Id | [optional] 
+**arbitrary_shipping_handling_total** | **Number** | Arbitrary shipping handling total | [optional] 
+**arbitrary_tax** | **Number** | Arbitrary tax for overriding calculated taxes | [optional] 
+**arbitrary_tax_rate** | **Number** | Arbitrary tax rate | [optional] 
+**arbitrary_taxable_subtotal** | **Number** | Arbitrary taxable subtotal | [optional] 
+**associate_with_customer_profile_if_present** | **Boolean** | If true any matching customer profile based on email is associated with this order | [optional] 
+**auto_approve_purchase_order** | **Boolean** | If true any purchase orders are automatically approved | [optional] 
+**billto_address1** | **String** | Billing Address line 1 | [optional] 
+**billto_address2** | **String** | Billing Address line 2 | [optional] 
+**billto_city** | **String** | Billing City | [optional] 
+**billto_company** | **String** | Billing Company | [optional] 
+**billto_country_code** | **String** | Billing ISO-3166 two letter country code | [optional] 
+**billto_day_phone** | **String** | Billing Day phone | [optional] 
+**billto_evening_phone** | **String** | Billing Evening phone | [optional] 
+**billto_first_name** | **String** | Billing First name | [optional] 
+**billto_last_name** | **String** | Billing Last name | [optional] 
+**billto_postal_code** | **String** | Billing Postal code | [optional] 
+**billto_state_region** | **String** | Billing State for United States otherwise region or province for other countries | [optional] 
+**billto_title** | **String** | Billing Title | [optional] 
+**cc_email** | **String** | CC email. | [optional] 
+**channel_partner_order_id** | **String** | The id for this order within the channel partner system. | [optional] 
+**consider_recurring** | **Boolean** | If true this order is marked as an auto order (recurring) | [optional] 
+**coupons** | **[String]** | Array of coupon codes | [optional] 
+**credit_card_authorization_amount** | **Number** | The amount authorized externally | [optional] 
+**credit_card_authorization_dts** | **String** | Date/Time of credit card authorization in ISO8601 format | [optional] 
+**credit_card_authorization_number** | **String** | The reference number provided by an externally processed transaction | [optional] 
+**credit_card_expiration_month** | **Number** | Credit card expiration month | [optional] 
+**credit_card_expiration_year** | **Number** | Credit card expiration year | [optional] 
+**credit_card_type** | **String** | Credit card type | [optional] 
+**custom_field1** | **String** | Custom field 1 | [optional] 
+**custom_field2** | **String** | Custom field 2 | [optional] 
+**custom_field3** | **String** | Custom field 3 | [optional] 
+**custom_field4** | **String** | Custom field 4 | [optional] 
+**custom_field5** | **String** | Custom field 5 | [optional] 
+**custom_field6** | **String** | Custom field 6 | [optional] 
+**custom_field7** | **String** | Custom field 7 | [optional] 
+**delivery_date** | **String** | Date the customer is requesting delivery on. Typically used for perishable product delivery. | [optional] 
+**email** | **String** | Email | [optional] 
+**gift** | **Boolean** | True if this order is a gift | [optional] 
+**gift_email** | **String** | Email address of the gift recipient | [optional] 
+**gift_message** | **String** | Message to the gift recipient | [optional] 
+**hosted_fields_card_token** | **String** | The token provided by UltraCart hosted fields when a credit card number is uploaded into the system.  This is the only way to provide a credit card number. | [optional] 
+**hosted_fields_cvv_token** | **String** | The token provided by UltraCart hosted fields when a credit card cvv is uploaded into the system.  This is the only way to provide a cvv number. | [optional] 
+**insurance_application_id** | **String** | Insurance application id | [optional] 
+**insurance_claim_id** | **String** | Insurance claim id | [optional] 
+**ip_address** | **String** | IP Address of the customer | [optional] 
+**items** | [**[ChannelPartnerOrderItem]**](ChannelPartnerOrderItem.md) | Items | [optional] 
+**least_cost_route** | **Boolean** | If true the least expensive shipping method is automatically chosen during the order import | [optional] 
+**least_cost_route_shipping_methods** | **[String]** | An optional array of shipping methods to restict choices if least_cost_route is true | [optional] 
+**mailing_list_opt_in** | **Boolean** | If true the customer is subscribed to any configured mailing lists | [optional] 
+**no_realtime_payment_processing** | **Boolean** | If true no payment processing is done and the order is placed into Accounts Receivable | [optional] 
+**payment_method** | **String** | Payment method | [optional] 
+**purchase_order_number** | **String** | Purchase order number | [optional] 
+**rotating_transaction_gateway_code** | **String** | The rotating transaction gateway code for the gateway used to charge this order | [optional] 
+**screen_branding_theme_code** | **String** | Screen branding theme code | [optional] 
+**ship_on_date** | **String** | Date the customer is requesting that the order ship on.  Typically used for perishable product delivery. | [optional] 
+**ship_to_residential** | **Boolean** | True if the shipping adress is residential.  Effects the methods that are available to the customer as well as the price of the shipping method. | [optional] 
+**shipping_method** | **String** | Shipping method | [optional] 
+**shipto_address1** | **String** | Shipping Address line 1 | [optional] 
+**shipto_address2** | **String** | Shipping Address line 2 | [optional] 
+**shipto_city** | **String** | Shipping City | [optional] 
+**shipto_company** | **String** | Shipping Company | [optional] 
+**shipto_country_code** | **String** | Shipping ISO-3166 two letter country code | [optional] 
+**shipto_day_phone** | **String** | Shipping Day phone | [optional] 
+**shipto_evening_phone** | **String** | Shipping Evening phone | [optional] 
+**shipto_first_name** | **String** | Shipping First name | [optional] 
+**shipto_last_name** | **String** | Shipping Last name | [optional] 
+**shipto_postal_code** | **String** | Shipping Postal code | [optional] 
+**shipto_state_region** | **String** | Shipping State for United States otherwise region or province for other countries | [optional] 
+**shipto_title** | **String** | Shipping Title | [optional] 
+**skip_payment_processing** | **Boolean** | If true the order is placed directly into the shipping department | [optional] 
+**special_instructions** | **String** | Special instructions from the customer regarding shipping | [optional] 
+**store_completed** | **Boolean** | If true the order bypasses shipping and is marked completed | [optional] 
+**store_if_payment_declines** | **Boolean** | If true any failed payments are placed into Accounts Receivable.  If false any failed payments result in a rejected order resulting in errors thrown during the insert routine | [optional] 
+**tax_county** | **String** | The optional shipping county used to determine exact taxes | [optional] 
+**tax_exempt** | **Boolean** | If true this order is marked as being tax exempt | [optional] 
+**transaction** | [**ChannelPartnerOrderTransaction**](ChannelPartnerOrderTransaction.md) |  | [optional] 
+**treat_warnings_as_errors** | **Boolean** | If true all warnings are considered errors, this is true by default | [optional] 
+
+
+<a name="PaymentMethodEnum"></a>
+## Enum: PaymentMethodEnum
+
+
+* `Affirm` (value: `"Affirm"`)
+
+* `Amazon` (value: `"Amazon"`)
+
+* `Check` (value: `"Check"`)
+
+* `COD` (value: `"COD"`)
+
+* `Credit_Card` (value: `"Credit Card"`)
+
+* `LoanHero` (value: `"LoanHero"`)
+
+* `Money_Order` (value: `"Money Order"`)
+
+* `PayPal` (value: `"PayPal"`)
+
+* `Purchase_Order` (value: `"Purchase Order"`)
+
+* `Quote_Request` (value: `"Quote Request"`)
+
+* `Wire_Transfer` (value: `"Wire Transfer"`)
+
+
+
+

package/docs/ChannelPartnerOrderItem.md

@@ -0,0 +1,45 @@
+# UltraCartRestApiV2.ChannelPartnerOrderItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**arbitrary_unit_cost** | **Number** | Arbitrary unit cost for this item that differs from the listed price | [optional] 
+**auto_order_last_rebill_dts** | **String** | Optional date/time of the last rebill if this item is part of an auto (recurring) order | [optional] 
+**auto_order_schedule** | **String** | The frequency schedule for this item if this item is part of an auto (recurring) order | [optional] 
+**merchant_item_id** | **String** | Item ID | [optional] 
+**options** | [**[ChannelPartnerOrderItemOption]**](ChannelPartnerOrderItemOption.md) | Item options | [optional] 
+**quantity** | **Number** | Quantity | [optional] 
+**upsell** | **Boolean** | True if this item was an upsell item. | [optional] 
+
+
+<a name="AutoOrderScheduleEnum"></a>
+## Enum: AutoOrderScheduleEnum
+
+
+* `Weekly` (value: `"Weekly"`)
+
+* `Every_10_Days` (value: `"Every 10 Days"`)
+
+* `Biweekly` (value: `"Biweekly"`)
+
+* `Every_24_Days` (value: `"Every 24 Days"`)
+
+* `Every_28_Days` (value: `"Every 28 Days"`)
+
+* `Monthly` (value: `"Monthly"`)
+
+* `Every_45_Days` (value: `"Every 45 Days"`)
+
+* `Every_2_Months` (value: `"Every 2 Months"`)
+
+* `Every_3_Months` (value: `"Every 3 Months"`)
+
+* `Every_4_Months` (value: `"Every 4 Months"`)
+
+* `Every_6_Months` (value: `"Every 6 Months"`)
+
+* `Yearly` (value: `"Yearly"`)
+
+
+
+

package/docs/ChannelPartnerOrderItemOption.md

@@ -0,0 +1,9 @@
+# UltraCartRestApiV2.ChannelPartnerOrderItemOption
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the item option. | [optional] 
+**value** | **String** | The value of the item option. | [optional] 
+
+

package/docs/ChannelPartnerOrderTransaction.md

@@ -0,0 +1,9 @@
+# UltraCartRestApiV2.ChannelPartnerOrderTransaction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**details** | [**[ChannelPartnerOrderTransactionDetail]**](ChannelPartnerOrderTransactionDetail.md) | Transaction gateway details | [optional] 
+**successful** | **Boolean** | True if the transaction was successfully charged | [optional] 
+
+

package/docs/ChannelPartnerOrderTransactionDetail.md

@@ -0,0 +1,9 @@
+# UltraCartRestApiV2.ChannelPartnerOrderTransactionDetail
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the item option. | [optional] 
+**value** | **String** | The value of the item option. | [optional] 
+
+

package/docs/ChannelPartnerShippingEstimate.md

@@ -0,0 +1,9 @@
+# UltraCartRestApiV2.ChannelPartnerShippingEstimate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**shipping_handling_total** | **Number** | The total estimate for this shipping method based on the provided order. | [optional] 
+**shipping_method** | **String** | The name of the shipping method | [optional] 
+
+

package/docs/CustomerApi.md

@@ -4,6 +4,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**adjustInternalCertificate**](CustomerApi.md#adjustInternalCertificate) | **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.
 [**deleteCustomer**](CustomerApi.md#deleteCustomer) | **DELETE** /customer/customers/{customer_profile_oid} | Delete a customer
 [**getCustomer**](CustomerApi.md#getCustomer) | **GET** /customer/customers/{customer_profile_oid} | Retrieve a customer
 [**getCustomerByEmail**](CustomerApi.md#getCustomerByEmail) | **GET** /customer/customers/by_email/{email} | Retrieve a customer by Email
@@ -19,6 +20,59 @@ Method | HTTP request | Description
 [**validateEmailVerificationToken**](CustomerApi.md#validateEmailVerificationToken) | **POST** /customer/customers/email_verify/validate_token | Validate a token that can be used to verify a customer email address
 
 
+<a name="adjustInternalCertificate"></a>
+# **adjustInternalCertificate**
+> AdjustInternalCertificateResponse adjustInternalCertificate(customer_profile_oid, adjust_internal_certificate_request)
+
+Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
+
+Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed. 
+
+### Example
+```javascript
+var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
+
+// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
+UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
+var apiInstance = new UltraCartRestApiV2.CustomerApi();
+
+
+var customer_profile_oid = 56; // Number | The customer profile oid
+
+var adjust_internal_certificate_request = new UltraCartRestApiV2.AdjustInternalCertificateRequest(); // AdjustInternalCertificateRequest | adjustInternalCertificateRequest
+
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+apiInstance.adjustInternalCertificate(customer_profile_oid, adjust_internal_certificate_request, callback);
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **customer_profile_oid** | **Number**| The customer profile oid | 
+ **adjust_internal_certificate_request** | [**AdjustInternalCertificateRequest**](AdjustInternalCertificateRequest.md)| adjustInternalCertificateRequest | 
+
+### Return type
+
+[**AdjustInternalCertificateResponse**](AdjustInternalCertificateResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
 <a name="deleteCustomer"></a>
 # **deleteCustomer**
 > deleteCustomer(customer_profile_oid)