ultra_cart_rest_api_v2 3.10.13 → 4.0.6-RC

package/docs/CartKitComponentOption.md

@@ -1,40 +0,0 @@
-# UltraCartRestApiV2.CartKitComponentOption
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**cost_if_specified** | [**Currency**](Currency.md) |  | [optional] 
-**cost_per_letter** | [**Currency**](Currency.md) |  | [optional] 
-**cost_per_line** | [**Currency**](Currency.md) |  | [optional] 
-**ignore_if_default** | **Boolean** | True if the default answer is ignored | [optional] 
-**item_id** | **String** | Kit component item id | [optional] 
-**item_oid** | **Number** | Unique identifier for the kit component item | [optional] 
-**label** | **String** | Display label for the option | [optional] 
-**name** | **String** | Name of the option | [optional] 
-**one_time_fee** | **Boolean** | Charge the fee a single time instead of multiplying by the quantity | [optional] 
-**option_oid** | **Number** | Unique identifier for the option | [optional] 
-**required** | **Boolean** | True if the customer is required to select a value | [optional] 
-**selected_value** | **String** | The value of the option specified by the customer | [optional] 
-**type** | **String** | Type of option | [optional] 
-**values** | [**[CartItemOptionValue]**](CartItemOptionValue.md) | Values that the customer can select from for radio or select type options | [optional] 
-
-
-<a name="TypeEnum"></a>
-## Enum: TypeEnum
-
-
-* `single` (value: `"single"`)
-
-* `multiline` (value: `"multiline"`)
-
-* `dropdown` (value: `"dropdown"`)
-
-* `hidden` (value: `"hidden"`)
-
-* `radio` (value: `"radio"`)
-
-* `fixed` (value: `"fixed"`)
-
-
-
-

package/docs/CartMarketing.md

@@ -1,9 +0,0 @@
-# UltraCartRestApiV2.CartMarketing
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**advertising_source** | **String** | The advertising source the customer indicated | [optional] 
-**mailing_list_opt_in** | **Boolean** | True if the customer agrees to receiving marketing emails | [optional] 
-
-

package/docs/CartPayment.md

@@ -1,14 +0,0 @@
-# UltraCartRestApiV2.CartPayment
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**affirm** | [**CartPaymentAffirm**](CartPaymentAffirm.md) |  | [optional] 
-**amazon** | [**CartPaymentAmazon**](CartPaymentAmazon.md) |  | [optional] 
-**check** | [**CartPaymentCheck**](CartPaymentCheck.md) |  | [optional] 
-**credit_card** | [**CartPaymentCreditCard**](CartPaymentCreditCard.md) |  | [optional] 
-**payment_method** | **String** | Payment method | [optional] 
-**purchase_order** | [**CartPaymentPurchaseOrder**](CartPaymentPurchaseOrder.md) |  | [optional] 
-**rtg_code** | **String** | Rotating transaction gateway code | [optional] 
-
-

package/docs/CartPaymentAffirm.md

@@ -1,8 +0,0 @@
-# UltraCartRestApiV2.CartPaymentAffirm
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**affirm_checkout_token** | **String** | Affirm checkout token | [optional] 
-
-

package/docs/CartPaymentAmazon.md

@@ -1,8 +0,0 @@
-# UltraCartRestApiV2.CartPaymentAmazon
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**amazon_order_reference_id** | **String** | Amazon order reference id | [optional] 
-
-

package/docs/CartPaymentCheck.md

@@ -1,8 +0,0 @@
-# UltraCartRestApiV2.CartPaymentCheck
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**check_number** | **Number** | Check number they are paying with | [optional] 
-
-

package/docs/CartPaymentCreditCard.md

@@ -1,16 +0,0 @@
-# UltraCartRestApiV2.CartPaymentCreditCard
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**card_expiration_month** | **Number** | Card expiration month (1-12) | [optional] 
-**card_expiration_year** | **Number** | Card expiration year (four digit year) | [optional] 
-**card_number** | **String** | Card number (masked to the last 4) | [optional] 
-**card_number_token** | **String** | Hosted field token for the card number | [optional] 
-**card_type** | **String** | Card type | [optional] 
-**card_verification_number** | **String** | Card verification number (masked) | [optional] 
-**card_verification_number_token** | **String** | Hosted field token for the card verification number | [optional] 
-**customer_profile_credit_card_id** | **Number** | ID of the stored credit card to use | [optional] 
-**store_credit_card** | **Boolean** | True if the customer wants to store the card on their profile for future re-use | [optional] 
-
-

package/docs/CartPaymentPurchaseOrder.md

@@ -1,8 +0,0 @@
-# UltraCartRestApiV2.CartPaymentPurchaseOrder
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**purchase_order_number** | **String** | Purchase order number | [optional] 
-
-

package/docs/CartProfileLoginRequest.md

@@ -1,10 +0,0 @@
-# UltraCartRestApiV2.CartProfileLoginRequest
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**cart** | [**Cart**](Cart.md) |  | [optional] 
-**customer_profile_oid** | **Number** | Unique identifier for customer profile.  Can not be used with browser key authentication type. | [optional] 
-**password** | **String** | Password for the profile | [optional] 
-
-

package/docs/CartProfileLoginResponse.md

@@ -1,9 +0,0 @@
-# UltraCartRestApiV2.CartProfileLoginResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**cart** | [**Cart**](Cart.md) |  | [optional] 
-**errors** | **[String]** | Errors to display to the customer if they failed any of the validations checked | [optional] 
-
-

package/docs/CartProfileRegisterRequest.md

@@ -1,9 +0,0 @@
-# UltraCartRestApiV2.CartProfileRegisterRequest
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**cart** | [**Cart**](Cart.md) |  | [optional] 
-**password** | **String** | Password for the profile | [optional] 
-
-

package/docs/CartProfileRegisterResponse.md

@@ -1,9 +0,0 @@
-# UltraCartRestApiV2.CartProfileRegisterResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**cart** | [**Cart**](Cart.md) |  | [optional] 
-**errors** | **[String]** | Errors to display to the customer if they failed any of the validations checked | [optional] 
-
-

package/docs/CartProperty.md

@@ -1,11 +0,0 @@
-# UltraCartRestApiV2.CartProperty
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**display** | **Boolean** | True if this property is displayed to the customer | [optional] 
-**expiration_dts** | **String** | The date/time that the property expires and is deleted | [optional] 
-**name** | **String** | Name | [optional] 
-**value** | **String** | Value | [optional] 
-
-

package/docs/CartResponse.md

@@ -1,9 +0,0 @@
-# UltraCartRestApiV2.CartResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**cart** | [**Cart**](Cart.md) |  | [optional] 
-**errors** | **[String]** | Errors that should be displayed to the customer | [optional] 
-
-

package/docs/CartSettings.md

@@ -1,13 +0,0 @@
-# UltraCartRestApiV2.CartSettings
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**billing** | [**CartSettingsBilling**](CartSettingsBilling.md) |  | [optional] 
-**gift** | [**CartSettingsGift**](CartSettingsGift.md) |  | [optional] 
-**payment** | [**CartSettingsPayment**](CartSettingsPayment.md) |  | [optional] 
-**shipping** | [**CartSettingsShipping**](CartSettingsShipping.md) |  | [optional] 
-**taxes** | [**CartSettingsTaxes**](CartSettingsTaxes.md) |  | [optional] 
-**terms** | [**CartSettingsTerms**](CartSettingsTerms.md) |  | [optional] 
-
-

package/docs/CartSettingsBilling.md

@@ -1,8 +0,0 @@
-# UltraCartRestApiV2.CartSettingsBilling
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**provinces** | [**[CartSettingsProvince]**](CartSettingsProvince.md) | Provinces | [optional] 
-
-

package/docs/CartSettingsGift.md

@@ -1,11 +0,0 @@
-# UltraCartRestApiV2.CartSettingsGift
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**allow_gifts** | **Boolean** | True if this checkout supports gift giving | [optional] 
-**gift_charge** | [**Currency**](Currency.md) |  | [optional] 
-**gift_wraps** | [**[CartSettingsGiftWrap]**](CartSettingsGiftWrap.md) | The gift wraps available for the customer to select from | [optional] 
-**max_message_length** | **Number** | The maximum length of the gift message the giver can enter | [optional] 
-
-

package/docs/CartSettingsGiftWrap.md

@@ -1,10 +0,0 @@
-# UltraCartRestApiV2.CartSettingsGiftWrap
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**cost** | [**Currency**](Currency.md) |  | [optional] 
-**title** | **String** | Title of the gift wrap | [optional] 
-**url** | **String** | URL for the sample of the gift wrap | [optional] 
-
-

package/docs/CartSettingsPayment.md

@@ -1,20 +0,0 @@
-# UltraCartRestApiV2.CartSettingsPayment
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**amazon** | [**CartSettingsPaymentAmazon**](CartSettingsPaymentAmazon.md) |  | [optional] 
-**credit_card** | [**CartSettingsPaymentCreditCard**](CartSettingsPaymentCreditCard.md) |  | [optional] 
-**need_payment** | **Boolean** | True if this card requires a payment from the customer | [optional] 
-**paypal** | [**CartSettingsPaymentPayPal**](CartSettingsPaymentPayPal.md) |  | [optional] 
-**supports_amazon** | **Boolean** | True if Amazon payments are available on this order | [optional] 
-**supports_check** | **Boolean** | True if check payments are available on this order | [optional] 
-**supports_cod** | **Boolean** | True if COD payments are available on this order | [optional] 
-**supports_credit_card** | **Boolean** | True if credit card payments are available on this order | [optional] 
-**supports_money_order** | **Boolean** | True if money order payments are available on this order | [optional] 
-**supports_paypal** | **Boolean** | True if PayPal payments are available on this order | [optional] 
-**supports_purchase_order** | **Boolean** | True if purchase order payments are available on this order | [optional] 
-**supports_quote_request** | **Boolean** | True if quote requests payments are available on this order | [optional] 
-**supports_wire_transfer** | **Boolean** | True if wire transfer payments are available on this order | [optional] 
-
-

package/docs/CartSettingsPaymentAmazon.md

@@ -1,10 +0,0 @@
-# UltraCartRestApiV2.CartSettingsPaymentAmazon
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**amazon_button_url** | **String** | Amazon button URL | [optional] 
-**amazon_merchant_id** | **String** | Amazon merchant ID | [optional] 
-**amazon_widget_url** | **String** | Amazon widget URL | [optional] 
-
-

package/docs/CartSettingsPaymentCreditCard.md

@@ -1,10 +0,0 @@
-# UltraCartRestApiV2.CartSettingsPaymentCreditCard
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**collect_credit_card_verification_number** | **Boolean** | True if the credit card verification number should be collected | [optional] 
-**credit_card_types** | **[String]** | Available credit card types | [optional] 
-**hosted_fields_shopping_cart_token** | **String** | The shoppingCartToken needed for proper initialization of hosted fields collection | [optional] 
-
-

package/docs/CartSettingsPaymentPayPal.md

@@ -1,12 +0,0 @@
-# UltraCartRestApiV2.CartSettingsPaymentPayPal
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**paypal_button_alt_text** | **String** | PayPal button alt text | [optional] 
-**paypal_button_url** | **String** | PayPal button URL | [optional] 
-**paypal_credit_button_url** | **String** | PayPal Credit button URL | [optional] 
-**paypal_credit_legal_image_url** | **String** | PayPal Credit legal image URL | [optional] 
-**paypal_credit_legal_url** | **String** | PayPal Credit legal URL | [optional] 
-
-

package/docs/CartSettingsProvince.md

@@ -1,9 +0,0 @@
-# UltraCartRestApiV2.CartSettingsProvince
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **String** |  | [optional] 
-**province** | **String** |  | [optional] 
-
-

package/docs/CartSettingsShipping.md

@@ -1,12 +0,0 @@
-# UltraCartRestApiV2.CartSettingsShipping
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**deliver_on_date** | [**CartSettingsShippingCalendar**](CartSettingsShippingCalendar.md) |  | [optional] 
-**estimates** | [**[CartSettingsShippingEstimate]**](CartSettingsShippingEstimate.md) | Estimates for this cart | [optional] 
-**need_shipping** | **Boolean** | True if this order needs shipping | [optional] 
-**provinces** | [**[CartSettingsProvince]**](CartSettingsProvince.md) | Provinces | [optional] 
-**ship_on_date** | [**CartSettingsShippingCalendar**](CartSettingsShippingCalendar.md) |  | [optional] 
-
-

package/docs/CartSettingsShippingCalendar.md

@@ -1,12 +0,0 @@
-# UltraCartRestApiV2.CartSettingsShippingCalendar
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**blackouts** | **[String]** | Specified dates that are blacked out on the calendar in ISO8601 format | [optional] 
-**days_of_week** | **[Boolean]** | Days of week that should be enabled on the calendar (0 - Sunday through 6 - Saturday) | [optional] 
-**earliest** | **String** | The earliest date that can be selected on the calendar | [optional] 
-**require** | **Boolean** | True if the customer is required to select a date | [optional] 
-**show** | **Boolean** | True if this calendar should be shown to the customer | [optional] 
-
-

package/docs/CartSettingsShippingEstimate.md

@@ -1,21 +0,0 @@
-# UltraCartRestApiV2.CartSettingsShippingEstimate
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**allow_3rd_party_billing** | **Boolean** | True if this method allows the customer to use their own shipper account number | [optional] 
-**comment** | **String** | Comment to display to the customer about this method | [optional] 
-**cost** | [**Currency**](Currency.md) |  | [optional] 
-**cost_before_discount** | [**Currency**](Currency.md) |  | [optional] 
-**default_method** | **Boolean** | True if this is the default method | [optional] 
-**discount** | [**Currency**](Currency.md) |  | [optional] 
-**discounted** | **Boolean** | True if this method is discounted because of a coupon | [optional] 
-**display_name** | **String** | The name to display to the customer | [optional] 
-**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/CartSettingsTaxes.md

@@ -1,8 +0,0 @@
-# UltraCartRestApiV2.CartSettingsTaxes
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**counties** | **[String]** |  | [optional] 
-
-

package/docs/CartSettingsTerms.md

@@ -1,9 +0,0 @@
-# UltraCartRestApiV2.CartSettingsTerms
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**html** | **String** | HTML version of the terms | [optional] 
-**text** | **String** | Text version of the terms. | [optional] 
-
-

package/docs/CartShipping.md

@@ -1,26 +0,0 @@
-# UltraCartRestApiV2.CartShipping
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**address1** | **String** | Address line 1 | [optional] 
-**address2** | **String** | Address line 2 | [optional] 
-**city** | **String** | City | [optional] 
-**company** | **String** | Company | [optional] 
-**country_code** | **String** | ISO-3166 two letter country code | [optional] 
-**day_phone** | **String** | Day time phone | [optional] 
-**delivery_date** | **String** | Date the customer is requesting delivery on. Typically used for perishable product delivery. | [optional] 
-**evening_phone** | **String** | Evening phone | [optional] 
-**first_name** | **String** | First name | [optional] 
-**last_name** | **String** | Last name | [optional] 
-**lift_gate** | **Boolean** | Lift gate requested (LTL shipping methods only) | [optional] 
-**postal_code** | **String** | Postal 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_3rd_party_account_number** | **String** | 3rd party account number to ship against for UPS or FedEx | [optional] 
-**shipping_method** | **String** | Shipping method | [optional] 
-**special_instructions** | **String** | Special instructions from the customer regarding shipping | [optional] 
-**state_region** | **String** | State/Region | [optional] 
-**title** | **String** | Title | [optional] 
-
-

package/docs/CartSummary.md

@@ -1,23 +0,0 @@
-# UltraCartRestApiV2.CartSummary
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**arbitrary_shipping_handling_total** | [**Currency**](Currency.md) |  | [optional] 
-**arbitrary_tax** | [**Currency**](Currency.md) |  | [optional] 
-**arbitrary_tax_rate** | [**Currency**](Currency.md) |  | [optional] 
-**arbitrary_taxable_subtotal** | [**Currency**](Currency.md) |  | [optional] 
-**shipping_handling** | [**Currency**](Currency.md) |  | [optional] 
-**shipping_handling_discount** | [**Currency**](Currency.md) |  | [optional] 
-**shipping_handling_with_discount** | [**Currency**](Currency.md) |  | [optional] 
-**subtotal** | [**Currency**](Currency.md) |  | [optional] 
-**subtotal_discount** | [**Currency**](Currency.md) |  | [optional] 
-**subtotal_with_discount** | [**Currency**](Currency.md) |  | [optional] 
-**surcharge** | [**Currency**](Currency.md) |  | [optional] 
-**tax** | [**Currency**](Currency.md) |  | [optional] 
-**taxable_subtotal** | [**Currency**](Currency.md) |  | [optional] 
-**taxable_subtotal_discount** | [**Currency**](Currency.md) |  | [optional] 
-**taxable_subtotal_with_discount** | [**Currency**](Currency.md) |  | [optional] 
-**total** | [**Currency**](Currency.md) |  | [optional] 
-
-

package/docs/CartTaxes.md

@@ -1,10 +0,0 @@
-# UltraCartRestApiV2.CartTaxes
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**county** | **String** | Tax county if the state requires it. | [optional] 
-**exempt** | **Boolean** | True if tax exempt | [optional] 
-**rate** | **Number** | Tax rate | [optional] 
-
-

package/docs/CartUpsellAfter.md

@@ -1,10 +0,0 @@
-# UltraCartRestApiV2.CartUpsellAfter
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**finalize_after_dts** | **String** | The date/time after which the cart will finalize into an order. | [optional] 
-**finalize_after_minutes** | **Number** | The amount of inactivity in minutes after which the cart should be finalized into an order.  This will calculate the finalize_after_dts field. | [optional] 
-**upsell_path_code** | **String** | Upsell path code | [optional] 
-
-

package/docs/CartValidationRequest.md

@@ -1,9 +0,0 @@
-# UltraCartRestApiV2.CartValidationRequest
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**cart** | [**Cart**](Cart.md) |  | [optional] 
-**checks** | **[String]** | Checks to perform | [optional] 
-
-

package/docs/CartValidationResponse.md

@@ -1,9 +0,0 @@
-# UltraCartRestApiV2.CartValidationResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**cart** | [**Cart**](Cart.md) |  | [optional] 
-**errors** | **[String]** | Errors to display to the customer if they failed any of the validations checked | [optional] 
-
-