ultracart_api 3.0.74
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/LICENSE +201 -0
- data/README.md +1055 -0
- data/Rakefile +8 -0
- data/docs/AccountsReceivableRetryConfig.md +21 -0
- data/docs/AccountsReceivableRetryConfigResponse.md +15 -0
- data/docs/AccountsReceivableRetryDayActivity.md +10 -0
- data/docs/AccountsReceivableRetryStatAccount.md +11 -0
- data/docs/AccountsReceivableRetryStatMetrics.md +18 -0
- data/docs/AccountsReceivableRetryStatRevenue.md +9 -0
- data/docs/AccountsReceivableRetryStatsResponse.md +13 -0
- data/docs/Activity.md +13 -0
- data/docs/AddLibraryItemRequest.md +18 -0
- data/docs/AffiliateApi.md +140 -0
- data/docs/AffiliateClick.md +18 -0
- data/docs/AffiliateClickQuery.md +13 -0
- data/docs/AffiliateClicksResponse.md +12 -0
- data/docs/AffiliateLedger.md +25 -0
- data/docs/AffiliateLedgerQuery.md +13 -0
- data/docs/AffiliateLedgersResponse.md +12 -0
- data/docs/AffiliateLink.md +21 -0
- data/docs/ApiUserApplicationProfile.md +12 -0
- data/docs/ApplyLibraryItemRequest.md +10 -0
- data/docs/ApplyLibraryItemResponse.md +18 -0
- data/docs/AutoOrder.md +27 -0
- data/docs/AutoOrderApi.md +558 -0
- data/docs/AutoOrderItem.md +31 -0
- data/docs/AutoOrderItemFutureSchedule.md +11 -0
- data/docs/AutoOrderItemOption.md +9 -0
- data/docs/AutoOrderItemSimpleSchedule.md +10 -0
- data/docs/AutoOrderQuery.md +26 -0
- data/docs/AutoOrderQueryBatch.md +8 -0
- data/docs/AutoOrderResponse.md +12 -0
- data/docs/AutoOrdersRequest.md +8 -0
- data/docs/AutoOrdersResponse.md +12 -0
- data/docs/AvalaraConfig.md +20 -0
- data/docs/BaseResponse.md +11 -0
- data/docs/Cart.md +32 -0
- data/docs/CartAffiliate.md +9 -0
- data/docs/CartAffirmCheckoutResponse.md +9 -0
- data/docs/CartBilling.md +22 -0
- data/docs/CartBuysafe.md +13 -0
- data/docs/CartCheckout.md +21 -0
- data/docs/CartCoupon.md +8 -0
- data/docs/CartCurrencyConversion.md +9 -0
- data/docs/CartCustomerProfile.md +29 -0
- data/docs/CartCustomerProfileAddress.md +21 -0
- data/docs/CartCustomerProfileCreditCard.md +13 -0
- data/docs/CartFinalizeOrderRequest.md +9 -0
- data/docs/CartFinalizeOrderRequestOptions.md +20 -0
- data/docs/CartFinalizeOrderResponse.md +12 -0
- data/docs/CartGift.md +13 -0
- data/docs/CartGiftCertificate.md +10 -0
- data/docs/CartItem.md +36 -0
- data/docs/CartItemAttribute.md +10 -0
- data/docs/CartItemMultimedia.md +16 -0
- data/docs/CartItemMultimediaThumbnail.md +12 -0
- data/docs/CartItemOption.md +19 -0
- data/docs/CartItemOptionValue.md +12 -0
- data/docs/CartItemPhysical.md +11 -0
- data/docs/CartItemVariationSelection.md +9 -0
- data/docs/CartKitComponentOption.md +21 -0
- data/docs/CartMarketing.md +9 -0
- data/docs/CartPayment.md +14 -0
- data/docs/CartPaymentAffirm.md +8 -0
- data/docs/CartPaymentAmazon.md +8 -0
- data/docs/CartPaymentCheck.md +8 -0
- data/docs/CartPaymentCreditCard.md +16 -0
- data/docs/CartPaymentPurchaseOrder.md +8 -0
- data/docs/CartProfileLoginRequest.md +10 -0
- data/docs/CartProfileLoginResponse.md +9 -0
- data/docs/CartProfileRegisterRequest.md +9 -0
- data/docs/CartProfileRegisterResponse.md +9 -0
- data/docs/CartProperty.md +11 -0
- data/docs/CartResponse.md +9 -0
- data/docs/CartSettings.md +13 -0
- data/docs/CartSettingsBilling.md +8 -0
- data/docs/CartSettingsGift.md +11 -0
- data/docs/CartSettingsGiftWrap.md +10 -0
- data/docs/CartSettingsPayment.md +20 -0
- data/docs/CartSettingsPaymentAmazon.md +10 -0
- data/docs/CartSettingsPaymentCreditCard.md +10 -0
- data/docs/CartSettingsPaymentPayPal.md +12 -0
- data/docs/CartSettingsProvince.md +9 -0
- data/docs/CartSettingsShipping.md +12 -0
- data/docs/CartSettingsShippingCalendar.md +12 -0
- data/docs/CartSettingsShippingEstimate.md +20 -0
- data/docs/CartSettingsTaxes.md +8 -0
- data/docs/CartSettingsTerms.md +9 -0
- data/docs/CartShipping.md +26 -0
- data/docs/CartSummary.md +23 -0
- data/docs/CartTaxes.md +10 -0
- data/docs/CartUpsellAfter.md +10 -0
- data/docs/CartValidationRequest.md +9 -0
- data/docs/CartValidationResponse.md +9 -0
- data/docs/ChargebackApi.md +336 -0
- data/docs/ChargebackDispute.md +30 -0
- data/docs/ChargebackDisputeResponse.md +12 -0
- data/docs/ChargebackDisputesResponse.md +12 -0
- data/docs/CheckoutAllowedCountriesResponse.md +8 -0
- data/docs/CheckoutApi.md +1240 -0
- data/docs/CheckoutHandoffRequest.md +15 -0
- data/docs/CheckoutHandoffResponse.md +10 -0
- data/docs/CheckoutSetupBrowserKeyRequest.md +8 -0
- data/docs/CheckoutSetupBrowserKeyResponse.md +8 -0
- data/docs/CheckoutStateProvinceResponse.md +8 -0
- data/docs/CityStateZip.md +12 -0
- data/docs/CountriesResponse.md +8 -0
- data/docs/Country.md +9 -0
- data/docs/Coupon.md +63 -0
- data/docs/CouponAmountOffItems.md +11 -0
- data/docs/CouponAmountOffShipping.md +10 -0
- data/docs/CouponAmountOffShippingWithItemsPurchase.md +11 -0
- data/docs/CouponAmountOffSubtotal.md +9 -0
- data/docs/CouponAmountOffSubtotalAndShipping.md +9 -0
- data/docs/CouponAmountOffSubtotalFreeShippingWithPurchase.md +11 -0
- data/docs/CouponAmountOffSubtotalWithBlockPurchase.md +11 -0
- data/docs/CouponAmountOffSubtotalWithItemsPurchase.md +11 -0
- data/docs/CouponApi.md +1174 -0
- data/docs/CouponAutoApplyCondition.md +10 -0
- data/docs/CouponAutoApplyConditions.md +13 -0
- data/docs/CouponAutomaticallyApplyCouponCodes.md +8 -0
- data/docs/CouponBuyOneGetOneLimit.md +9 -0
- data/docs/CouponCodesRequest.md +14 -0
- data/docs/CouponCodesResponse.md +13 -0
- data/docs/CouponDeletesRequest.md +9 -0
- data/docs/CouponDiscountItemWithItemPurchase.md +12 -0
- data/docs/CouponDiscountItems.md +11 -0
- data/docs/CouponEditorValues.md +17 -0
- data/docs/CouponExistsResponse.md +13 -0
- data/docs/CouponFreeItemAndShippingWithSubtotal.md +12 -0
- data/docs/CouponFreeItemWithItemPurchase.md +11 -0
- data/docs/CouponFreeItemWithSubtotal.md +11 -0
- data/docs/CouponFreeItemsWithItemPurchase.md +12 -0
- data/docs/CouponFreeItemsWithMixMatchPurchase.md +12 -0
- data/docs/CouponFreeShipping.md +8 -0
- data/docs/CouponFreeShippingSpecificItems.md +8 -0
- data/docs/CouponFreeShippingWithItemsPurchase.md +9 -0
- data/docs/CouponFreeShippingWithSubtotal.md +10 -0
- data/docs/CouponItemSearchResult.md +15 -0
- data/docs/CouponItemSearchResultsResponse.md +12 -0
- data/docs/CouponMultipleAmountsOffItems.md +9 -0
- data/docs/CouponNoDiscount.md +7 -0
- data/docs/CouponPercentOffItemWithItemsQuantityPurchase.md +12 -0
- data/docs/CouponPercentOffItems.md +11 -0
- data/docs/CouponPercentOffItemsAndFreeShipping.md +10 -0
- data/docs/CouponPercentOffItemsWithItemsPurchase.md +11 -0
- data/docs/CouponPercentOffRetailPriceItems.md +11 -0
- data/docs/CouponPercentOffShipping.md +9 -0
- data/docs/CouponPercentOffSubtotal.md +8 -0
- data/docs/CouponPercentOffSubtotalAndFreeShipping.md +9 -0
- data/docs/CouponPercentOffSubtotalLimit.md +10 -0
- data/docs/CouponPercentOffSubtotalWithItemsPurchase.md +9 -0
- data/docs/CouponPercentOffSubtotalWithSubtotal.md +10 -0
- data/docs/CouponQuery.md +16 -0
- data/docs/CouponResponse.md +12 -0
- data/docs/CouponRestriction.md +11 -0
- data/docs/CouponTierAmount.md +9 -0
- data/docs/CouponTierItemDiscount.md +9 -0
- data/docs/CouponTierPercent.md +9 -0
- data/docs/CouponTierQuantityAmount.md +9 -0
- data/docs/CouponTierQuantityPercent.md +9 -0
- data/docs/CouponTieredAmountOffItem.md +10 -0
- data/docs/CouponTieredAmountOffSubtotal.md +9 -0
- data/docs/CouponTieredPercentOffItems.md +10 -0
- data/docs/CouponTieredPercentOffShipping.md +9 -0
- data/docs/CouponTieredPercentOffSubtotal.md +9 -0
- data/docs/CouponType.md +9 -0
- data/docs/CouponsRequest.md +8 -0
- data/docs/CouponsResponse.md +12 -0
- data/docs/Currency.md +12 -0
- data/docs/Customer.md +65 -0
- data/docs/CustomerActivity.md +11 -0
- data/docs/CustomerAffiliate.md +9 -0
- data/docs/CustomerApi.md +670 -0
- data/docs/CustomerAttachment.md +12 -0
- data/docs/CustomerBilling.md +24 -0
- data/docs/CustomerCard.md +15 -0
- data/docs/CustomerEditorValues.md +15 -0
- data/docs/CustomerEmail.md +13 -0
- data/docs/CustomerEmailListChanges.md +9 -0
- data/docs/CustomerLoyalty.md +10 -0
- data/docs/CustomerLoyaltyLedger.md +22 -0
- data/docs/CustomerLoyaltyRedemption.md +20 -0
- data/docs/CustomerOrdersSummary.md +11 -0
- data/docs/CustomerPricingTier.md +9 -0
- data/docs/CustomerPrivacy.md +11 -0
- data/docs/CustomerQuery.md +36 -0
- data/docs/CustomerQuotesSummary.md +11 -0
- data/docs/CustomerResponse.md +12 -0
- data/docs/CustomerReviewer.md +17 -0
- data/docs/CustomerShipping.md +24 -0
- data/docs/CustomerSoftwareEntitlement.md +15 -0
- data/docs/CustomerTag.md +8 -0
- data/docs/CustomerTaxCodes.md +12 -0
- data/docs/CustomersResponse.md +12 -0
- data/docs/DataTablesServerSideResponse.md +11 -0
- data/docs/Distance.md +9 -0
- data/docs/DistributionCenter.md +41 -0
- data/docs/DistributionCentersResponse.md +12 -0
- data/docs/EmailBaseTemplateListResponse.md +8 -0
- data/docs/EmailCampaign.md +30 -0
- data/docs/EmailCampaignFolder.md +12 -0
- data/docs/EmailCampaignFolderResponse.md +12 -0
- data/docs/EmailCampaignFoldersResponse.md +12 -0
- data/docs/EmailCampaignResponse.md +12 -0
- data/docs/EmailCampaignsResponse.md +12 -0
- data/docs/EmailClick.md +9 -0
- data/docs/EmailClicksResponse.md +12 -0
- data/docs/EmailCommseq.md +11 -0
- data/docs/EmailCommseqEmail.md +31 -0
- data/docs/EmailCommseqEmailResponse.md +12 -0
- data/docs/EmailCommseqEmailSendTestRequest.md +17 -0
- data/docs/EmailCommseqEmailSendTestResponse.md +11 -0
- data/docs/EmailCommseqEmailsRequest.md +12 -0
- data/docs/EmailCommseqEmailsResponse.md +12 -0
- data/docs/EmailCommseqPostcard.md +18 -0
- data/docs/EmailCommseqPostcardResponse.md +12 -0
- data/docs/EmailCommseqPostcardSendTestRequest.md +19 -0
- data/docs/EmailCommseqPostcardSendTestResponse.md +14 -0
- data/docs/EmailCommseqPostcardsRequest.md +8 -0
- data/docs/EmailCommseqPostcardsResponse.md +12 -0
- data/docs/EmailCommseqResponse.md +12 -0
- data/docs/EmailCommseqStat.md +44 -0
- data/docs/EmailCommseqStatResponse.md +12 -0
- data/docs/EmailCommseqStep.md +17 -0
- data/docs/EmailCommseqsResponse.md +12 -0
- data/docs/EmailCustomer.md +15 -0
- data/docs/EmailCustomerEditorUrlResponse.md +12 -0
- data/docs/EmailCustomersResponse.md +12 -0
- data/docs/EmailDashboardActivity.md +14 -0
- data/docs/EmailDashboardActivityResponse.md +12 -0
- data/docs/EmailDashboardStatsResponse.md +12 -0
- data/docs/EmailDomain.md +18 -0
- data/docs/EmailEditorTokenResponse.md +12 -0
- data/docs/EmailFlow.md +34 -0
- data/docs/EmailFlowBackPopulateRequest.md +9 -0
- data/docs/EmailFlowBackPopulateResponse.md +11 -0
- data/docs/EmailFlowFolder.md +12 -0
- data/docs/EmailFlowFolderResponse.md +12 -0
- data/docs/EmailFlowFoldersResponse.md +12 -0
- data/docs/EmailFlowResponse.md +12 -0
- data/docs/EmailFlowsResponse.md +12 -0
- data/docs/EmailGlobalSettings.md +8 -0
- data/docs/EmailGlobalSettingsResponse.md +12 -0
- data/docs/EmailGlobalUnsubscribeRequest.md +8 -0
- data/docs/EmailGlobalUnsubscribeResponse.md +8 -0
- data/docs/EmailHistogramPropertyNamesResponse.md +8 -0
- data/docs/EmailHistogramPropertyValuesResponse.md +8 -0
- data/docs/EmailList.md +18 -0
- data/docs/EmailListArchiveResponse.md +12 -0
- data/docs/EmailListCustomer.md +11 -0
- data/docs/EmailListCustomersResponse.md +12 -0
- data/docs/EmailListResponse.md +12 -0
- data/docs/EmailListSegmentMembership.md +11 -0
- data/docs/EmailListSegmentUsedBy.md +10 -0
- data/docs/EmailListSubscribeResponse.md +9 -0
- data/docs/EmailListsResponse.md +12 -0
- data/docs/EmailOrder.md +11 -0
- data/docs/EmailOrdersResponse.md +12 -0
- data/docs/EmailPerformance.md +29 -0
- data/docs/EmailPerformanceCustomerHistogram.md +8 -0
- data/docs/EmailPerformanceCustomerHistogramPeriod.md +12 -0
- data/docs/EmailPerformanceDaily.md +14 -0
- data/docs/EmailPerformanceResponse.md +12 -0
- data/docs/EmailPlan.md +23 -0
- data/docs/EmailPlanAdditional.md +13 -0
- data/docs/EmailPlanResponse.md +12 -0
- data/docs/EmailPostcardStat.md +39 -0
- data/docs/EmailSegment.md +21 -0
- data/docs/EmailSegmentArchiveResponse.md +12 -0
- data/docs/EmailSegmentCustomer.md +11 -0
- data/docs/EmailSegmentCustomersResponse.md +12 -0
- data/docs/EmailSegmentDownloadPrepareResponse.md +15 -0
- data/docs/EmailSegmentResponse.md +12 -0
- data/docs/EmailSegmentsResponse.md +12 -0
- data/docs/EmailSendingDomainResponse.md +12 -0
- data/docs/EmailSendingDomainsResponse.md +12 -0
- data/docs/EmailSettings.md +19 -0
- data/docs/EmailSettingsResponse.md +12 -0
- data/docs/EmailStat.md +45 -0
- data/docs/EmailStatPostcardSummaryRequest.md +9 -0
- data/docs/EmailStatPostcardSummaryResponse.md +12 -0
- data/docs/EmailStatSummaryRequest.md +10 -0
- data/docs/EmailStatSummaryResponse.md +12 -0
- data/docs/EmailStepStat.md +27 -0
- data/docs/EmailStepStatRequest.md +9 -0
- data/docs/EmailStepStatResponse.md +12 -0
- data/docs/EmailStepWaitingRequest.md +8 -0
- data/docs/EmailStepWaitingResponse.md +8 -0
- data/docs/EmailTemplate.md +18 -0
- data/docs/EmailTemplatesResponse.md +12 -0
- data/docs/EmailThirdPartyList.md +9 -0
- data/docs/EmailThirdPartyListImportRequest.md +8 -0
- data/docs/EmailThirdPartyProvider.md +16 -0
- data/docs/EmailThirdPartyProvidersResponse.md +12 -0
- data/docs/Error.md +11 -0
- data/docs/ErrorResponse.md +11 -0
- data/docs/Experiment.md +25 -0
- data/docs/ExperimentResponse.md +12 -0
- data/docs/ExperimentVariation.md +26 -0
- data/docs/ExperimentsResponse.md +12 -0
- data/docs/FulfillmentApi.md +298 -0
- data/docs/FulfillmentInventory.md +9 -0
- data/docs/FulfillmentShipment.md +12 -0
- data/docs/GeoPoint.md +9 -0
- data/docs/GeocodeRequest.md +12 -0
- data/docs/GeocodeResponse.md +13 -0
- data/docs/Group.md +12 -0
- data/docs/GroupResponse.md +12 -0
- data/docs/GroupUserMembership.md +12 -0
- data/docs/GroupsResponse.md +12 -0
- data/docs/HTTPHeader.md +9 -0
- data/docs/Item.md +57 -0
- data/docs/ItemAccounting.md +9 -0
- data/docs/ItemAmember.md +9 -0
- data/docs/ItemApi.md +580 -0
- data/docs/ItemAutoOrder.md +23 -0
- data/docs/ItemAutoOrderStep.md +22 -0
- data/docs/ItemAutoOrderStepArbitraryUnitCostSchedule.md +9 -0
- data/docs/ItemAutoOrderStepGrandfatherPricing.md +9 -0
- data/docs/ItemCCBill.md +13 -0
- data/docs/ItemChannelPartnerMapping.md +25 -0
- data/docs/ItemChargeback.md +9 -0
- data/docs/ItemChargebackAddendum.md +11 -0
- data/docs/ItemChargebackAdjustmentRequest.md +10 -0
- data/docs/ItemCheckout.md +10 -0
- data/docs/ItemContent.md +19 -0
- data/docs/ItemContentAssignment.md +12 -0
- data/docs/ItemContentAttribute.md +11 -0
- data/docs/ItemContentMultimedia.md +22 -0
- data/docs/ItemContentMultimediaThumbnail.md +13 -0
- data/docs/ItemDigitalDelivery.md +13 -0
- data/docs/ItemDigitalItem.md +12 -0
- data/docs/ItemEbay.md +76 -0
- data/docs/ItemEbayCategorySpecific.md +9 -0
- data/docs/ItemEbayMarketListing.md +12 -0
- data/docs/ItemEbayMarketPlaceAnalysis.md +17 -0
- data/docs/ItemEmailNotifications.md +9 -0
- data/docs/ItemEnrollment123.md +8 -0
- data/docs/ItemGiftCertificate.md +9 -0
- data/docs/ItemGoogleProductSearch.md +55 -0
- data/docs/ItemIdentifiers.md +11 -0
- data/docs/ItemInstantPaymentNotification.md +10 -0
- data/docs/ItemInstantPaymentNotifications.md +8 -0
- data/docs/ItemInternal.md +8 -0
- data/docs/ItemKitComponent.md +12 -0
- data/docs/ItemKitDefinition.md +8 -0
- data/docs/ItemOption.md +21 -0
- data/docs/ItemOptionValue.md +22 -0
- data/docs/ItemOptionValueAdditionalItem.md +9 -0
- data/docs/ItemOptionValueDigitalItem.md +9 -0
- data/docs/ItemPaymentProcessing.md +12 -0
- data/docs/ItemPhysical.md +11 -0
- data/docs/ItemPricing.md +25 -0
- data/docs/ItemPricingTier.md +12 -0
- data/docs/ItemPricingTierDiscount.md +9 -0
- data/docs/ItemPricingTierLimit.md +10 -0
- data/docs/ItemProperty.md +10 -0
- data/docs/ItemRealtimePricing.md +10 -0
- data/docs/ItemRelated.md +10 -0
- data/docs/ItemRelatedItem.md +10 -0
- data/docs/ItemReporting.md +9 -0
- data/docs/ItemResponse.md +12 -0
- data/docs/ItemRestriction.md +15 -0
- data/docs/ItemRestrictionItem.md +10 -0
- data/docs/ItemRevguard.md +14 -0
- data/docs/ItemReviews.md +14 -0
- data/docs/ItemSalesforce.md +9 -0
- data/docs/ItemShipping.md +55 -0
- data/docs/ItemShippingCase.md +11 -0
- data/docs/ItemShippingDestinationMarkup.md +13 -0
- data/docs/ItemShippingDestinationRestriction.md +10 -0
- data/docs/ItemShippingDistributionCenter.md +20 -0
- data/docs/ItemShippingMethod.md +22 -0
- data/docs/ItemShippingPackageRequirement.md +9 -0
- data/docs/ItemTag.md +9 -0
- data/docs/ItemTags.md +8 -0
- data/docs/ItemTax.md +10 -0
- data/docs/ItemTaxExemption.md +12 -0
- data/docs/ItemThirdPartyEmailMarketing.md +12 -0
- data/docs/ItemVariantItem.md +13 -0
- data/docs/ItemVariation.md +12 -0
- data/docs/ItemVariationOption.md +11 -0
- data/docs/ItemWishlistMember.md +10 -0
- data/docs/ItemsRequest.md +8 -0
- data/docs/ItemsResponse.md +12 -0
- data/docs/KeyValue.md +10 -0
- data/docs/LibraryFilterValues.md +11 -0
- data/docs/LibraryFilterValuesResponse.md +12 -0
- data/docs/LibraryItem.md +47 -0
- data/docs/LibraryItemAccount.md +10 -0
- data/docs/LibraryItemAsset.md +9 -0
- data/docs/LibraryItemAttribute.md +10 -0
- data/docs/LibraryItemEmail.md +10 -0
- data/docs/LibraryItemPublishedMeta.md +15 -0
- data/docs/LibraryItemPurchasedMeta.md +10 -0
- data/docs/LibraryItemQuery.md +19 -0
- data/docs/LibraryItemResponse.md +12 -0
- data/docs/LibraryItemScreenshot.md +9 -0
- data/docs/LibraryItemsResponse.md +12 -0
- data/docs/LinkedAccount.md +10 -0
- data/docs/ListSegmentMembership.md +10 -0
- data/docs/LookupRequest.md +12 -0
- data/docs/LookupResponse.md +12 -0
- data/docs/Metric.md +15 -0
- data/docs/Notification.md +18 -0
- data/docs/OauthApi.md +148 -0
- data/docs/OauthRevokeSuccessResponse.md +9 -0
- data/docs/OauthTokenResponse.md +15 -0
- data/docs/Order.md +41 -0
- data/docs/OrderAffiliate.md +10 -0
- data/docs/OrderAffiliateLedger.md +16 -0
- data/docs/OrderApi.md +1293 -0
- data/docs/OrderAutoOrder.md +26 -0
- data/docs/OrderBilling.md +22 -0
- data/docs/OrderBuysafe.md +13 -0
- data/docs/OrderByTokenQuery.md +8 -0
- data/docs/OrderChannelPartner.md +17 -0
- data/docs/OrderCheckout.md +19 -0
- data/docs/OrderCoupon.md +11 -0
- data/docs/OrderDigitalItem.md +15 -0
- data/docs/OrderDigitalOrder.md +12 -0
- data/docs/OrderEdi.md +11 -0
- data/docs/OrderFormat.md +23 -0
- data/docs/OrderFormatResponse.md +9 -0
- data/docs/OrderFraudScore.md +27 -0
- data/docs/OrderGift.md +17 -0
- data/docs/OrderGiftCertificate.md +10 -0
- data/docs/OrderInternal.md +12 -0
- data/docs/OrderItem.md +61 -0
- data/docs/OrderItemEdi.md +9 -0
- data/docs/OrderItemEdiIdentification.md +9 -0
- data/docs/OrderItemEdiLot.md +10 -0
- data/docs/OrderItemOption.md +18 -0
- data/docs/OrderItemOptionFileAttachment.md +11 -0
- data/docs/OrderItemProperty.md +11 -0
- data/docs/OrderItemTag.md +8 -0
- data/docs/OrderLinkedShipment.md +12 -0
- data/docs/OrderMarketing.md +10 -0
- data/docs/OrderPayment.md +24 -0
- data/docs/OrderPaymentCheck.md +8 -0
- data/docs/OrderPaymentCreditCard.md +18 -0
- data/docs/OrderPaymentECheck.md +17 -0
- data/docs/OrderPaymentPurchaseOrder.md +8 -0
- data/docs/OrderPaymentTransaction.md +11 -0
- data/docs/OrderPaymentTransactionDetail.md +10 -0
- data/docs/OrderProcessPaymentRequest.md +8 -0
- data/docs/OrderProcessPaymentResponse.md +12 -0
- data/docs/OrderProperty.md +11 -0
- data/docs/OrderQuery.md +37 -0
- data/docs/OrderQueryBatch.md +8 -0
- data/docs/OrderQuote.md +10 -0
- data/docs/OrderReplacement.md +22 -0
- data/docs/OrderReplacementItem.md +10 -0
- data/docs/OrderReplacementResponse.md +13 -0
- data/docs/OrderResponse.md +12 -0
- data/docs/OrderSalesforce.md +8 -0
- data/docs/OrderShipping.md +36 -0
- data/docs/OrderSummary.md +24 -0
- data/docs/OrderTag.md +8 -0
- data/docs/OrderTaxes.md +24 -0
- data/docs/OrderTokenResponse.md +12 -0
- data/docs/OrderTrackingNumberDetail.md +17 -0
- data/docs/OrderTrackingNumberDetails.md +24 -0
- data/docs/OrdersResponse.md +12 -0
- data/docs/Permission.md +10 -0
- data/docs/PricingTier.md +38 -0
- data/docs/PricingTierNotification.md +10 -0
- data/docs/PricingTiersResponse.md +12 -0
- data/docs/Property.md +9 -0
- data/docs/PublishLibraryItemRequest.md +8 -0
- data/docs/RegisterAffiliateClickRequest.md +13 -0
- data/docs/RegisterAffiliateClickResponse.md +11 -0
- data/docs/ResponseMetadata.md +9 -0
- data/docs/ResultSet.md +13 -0
- data/docs/ScreenRecording.md +39 -0
- data/docs/ScreenRecordingFilter.md +34 -0
- data/docs/ScreenRecordingFilterGeoDistance.md +12 -0
- data/docs/ScreenRecordingFilterIpSearch.md +11 -0
- data/docs/ScreenRecordingFilterPageView.md +14 -0
- data/docs/ScreenRecordingFilterPageViewEvent.md +9 -0
- data/docs/ScreenRecordingFilterPageViewEventParam.md +12 -0
- data/docs/ScreenRecordingFilterPageViewParam.md +9 -0
- data/docs/ScreenRecordingFilterPageViewReferrerParam.md +9 -0
- data/docs/ScreenRecordingFilterRangeBigDecimal.md +12 -0
- data/docs/ScreenRecordingFilterRangeDate.md +9 -0
- data/docs/ScreenRecordingFilterRangeInteger.md +12 -0
- data/docs/ScreenRecordingFilterStringSearch.md +12 -0
- data/docs/ScreenRecordingFilterValues.md +17 -0
- data/docs/ScreenRecordingFilterValuesEvent.md +9 -0
- data/docs/ScreenRecordingFilterValuesEventParams.md +12 -0
- data/docs/ScreenRecordingMultifield.md +12 -0
- data/docs/ScreenRecordingPageView.md +22 -0
- data/docs/ScreenRecordingPageViewEvent.md +11 -0
- data/docs/ScreenRecordingPageViewEventParameter.md +9 -0
- data/docs/ScreenRecordingPageViewParameter.md +9 -0
- data/docs/ScreenRecordingQueryRequest.md +8 -0
- data/docs/ScreenRecordingQueryResponse.md +14 -0
- data/docs/ScreenRecordingResponse.md +12 -0
- data/docs/ScreenRecordingSegment.md +14 -0
- data/docs/ScreenRecordingSegmentResponse.md +12 -0
- data/docs/ScreenRecordingSegmentsResponse.md +12 -0
- data/docs/ScreenRecordingSettings.md +8 -0
- data/docs/ScreenRecordingSettingsResponse.md +12 -0
- data/docs/ScreenRecordingStoreFront.md +9 -0
- data/docs/ScreenRecordingTagsRequest.md +8 -0
- data/docs/ScreenRecordingTagsResponse.md +12 -0
- data/docs/ScreenRecordingUserAgent.md +12 -0
- data/docs/ScreenRecordingUserAgentDevice.md +8 -0
- data/docs/ScreenRecordingUserAgentOS.md +10 -0
- data/docs/ScreenRecordingUserProperty.md +9 -0
- data/docs/ScreenshotsResponse.md +12 -0
- data/docs/SelfConfig.md +8 -0
- data/docs/SimpleValue.md +9 -0
- data/docs/SovosConfig.md +14 -0
- data/docs/StateProvince.md +9 -0
- data/docs/StepWaiting.md +9 -0
- data/docs/StorefrontApi.md +9186 -0
- data/docs/TaxApi.md +1608 -0
- data/docs/TaxCity.md +16 -0
- data/docs/TaxCountry.md +16 -0
- data/docs/TaxCountryCode.md +12 -0
- data/docs/TaxCounty.md +17 -0
- data/docs/TaxJarConfig.md +13 -0
- data/docs/TaxPostalCode.md +14 -0
- data/docs/TaxProviderActivateResult.md +9 -0
- data/docs/TaxProviderAvalara.md +11 -0
- data/docs/TaxProviderAvalaraCompaniesResult.md +8 -0
- data/docs/TaxProviderAvalaraCompany.md +12 -0
- data/docs/TaxProviderSelf.md +12 -0
- data/docs/TaxProviderSelfCountriesResponse.md +8 -0
- data/docs/TaxProviderSelfRegionsResponse.md +8 -0
- data/docs/TaxProviderSovos.md +11 -0
- data/docs/TaxProviderTaxJar.md +11 -0
- data/docs/TaxProviderTestResult.md +9 -0
- data/docs/TaxProviderUltraCart.md +12 -0
- data/docs/TaxProviderUltraCartState.md +14 -0
- data/docs/TaxProvidersResponse.md +16 -0
- data/docs/TaxState.md +22 -0
- data/docs/TaxStateCode.md +12 -0
- data/docs/TempMultimedia.md +14 -0
- data/docs/TempMultimediaResponse.md +12 -0
- data/docs/ThumbnailParametersRequest.md +12 -0
- data/docs/ThumbnailParametersResponse.md +12 -0
- data/docs/TransactionEmail.md +27 -0
- data/docs/TransactionEmailListResponse.md +12 -0
- data/docs/TransactionEmailOption.md +15 -0
- data/docs/TransactionEmailResponse.md +12 -0
- data/docs/UltraCartConfig.md +8 -0
- data/docs/UploadCouponCodesRequest.md +12 -0
- data/docs/UploadCouponCodesResponse.md +14 -0
- data/docs/User.md +21 -0
- data/docs/UserApi.md +633 -0
- data/docs/UserGroupMembership.md +10 -0
- data/docs/UserLogin.md +11 -0
- data/docs/UserLoginsResponse.md +12 -0
- data/docs/UserResponse.md +12 -0
- data/docs/UsersResponse.md +12 -0
- data/docs/VerificationRecord.md +10 -0
- data/docs/Warning.md +9 -0
- data/docs/Webhook.md +25 -0
- data/docs/WebhookApi.md +503 -0
- data/docs/WebhookEventCategory.md +12 -0
- data/docs/WebhookEventSubscription.md +16 -0
- data/docs/WebhookLog.md +17 -0
- data/docs/WebhookLogResponse.md +12 -0
- data/docs/WebhookLogSummariesResponse.md +12 -0
- data/docs/WebhookLogSummary.md +10 -0
- data/docs/WebhookResponse.md +12 -0
- data/docs/WebhookSampleRequest.md +11 -0
- data/docs/WebhookSampleRequestResponse.md +12 -0
- data/docs/WebhooksResponse.md +12 -0
- data/docs/Weight.md +9 -0
- data/git_push.sh +55 -0
- data/lib/ultracart_api.rb +609 -0
- data/lib/ultracart_api/api/affiliate_api.rb +151 -0
- data/lib/ultracart_api/api/auto_order_api.rb +568 -0
- data/lib/ultracart_api/api/chargeback_api.rb +343 -0
- data/lib/ultracart_api/api/checkout_api.rb +1098 -0
- data/lib/ultracart_api/api/coupon_api.rb +1148 -0
- data/lib/ultracart_api/api/customer_api.rb +684 -0
- data/lib/ultracart_api/api/fulfillment_api.rb +307 -0
- data/lib/ultracart_api/api/item_api.rb +572 -0
- data/lib/ultracart_api/api/oauth_api.rb +158 -0
- data/lib/ultracart_api/api/order_api.rb +1293 -0
- data/lib/ultracart_api/api/storefront_api.rb +8493 -0
- data/lib/ultracart_api/api/tax_api.rb +1567 -0
- data/lib/ultracart_api/api/user_api.rb +621 -0
- data/lib/ultracart_api/api/webhook_api.rb +501 -0
- data/lib/ultracart_api/api_client.rb +400 -0
- data/lib/ultracart_api/api_error.rb +38 -0
- data/lib/ultracart_api/configuration.rb +229 -0
- data/lib/ultracart_api/models/accounts_receivable_retry_config.rb +319 -0
- data/lib/ultracart_api/models/accounts_receivable_retry_config_response.rb +252 -0
- data/lib/ultracart_api/models/accounts_receivable_retry_day_activity.rb +205 -0
- data/lib/ultracart_api/models/accounts_receivable_retry_stat_account.rb +215 -0
- data/lib/ultracart_api/models/accounts_receivable_retry_stat_metrics.rb +274 -0
- data/lib/ultracart_api/models/accounts_receivable_retry_stat_revenue.rb +193 -0
- data/lib/ultracart_api/models/accounts_receivable_retry_stats_response.rb +232 -0
- data/lib/ultracart_api/models/activity.rb +229 -0
- data/lib/ultracart_api/models/add_library_item_request.rb +289 -0
- data/lib/ultracart_api/models/affiliate_click.rb +284 -0
- data/lib/ultracart_api/models/affiliate_click_query.rb +235 -0
- data/lib/ultracart_api/models/affiliate_clicks_response.rb +224 -0
- data/lib/ultracart_api/models/affiliate_ledger.rb +386 -0
- data/lib/ultracart_api/models/affiliate_ledger_query.rb +235 -0
- data/lib/ultracart_api/models/affiliate_ledgers_response.rb +224 -0
- data/lib/ultracart_api/models/affiliate_link.rb +373 -0
- data/lib/ultracart_api/models/api_user_application_profile.rb +225 -0
- data/lib/ultracart_api/models/apply_library_item_request.rb +205 -0
- data/lib/ultracart_api/models/apply_library_item_response.rb +284 -0
- data/lib/ultracart_api/models/auto_order.rb +412 -0
- data/lib/ultracart_api/models/auto_order_item.rb +452 -0
- data/lib/ultracart_api/models/auto_order_item_future_schedule.rb +215 -0
- data/lib/ultracart_api/models/auto_order_item_option.rb +225 -0
- data/lib/ultracart_api/models/auto_order_item_simple_schedule.rb +239 -0
- data/lib/ultracart_api/models/auto_order_query.rb +425 -0
- data/lib/ultracart_api/models/auto_order_query_batch.rb +187 -0
- data/lib/ultracart_api/models/auto_order_response.rb +221 -0
- data/lib/ultracart_api/models/auto_orders_request.rb +187 -0
- data/lib/ultracart_api/models/auto_orders_response.rb +223 -0
- data/lib/ultracart_api/models/avalara_config.rb +305 -0
- data/lib/ultracart_api/models/base_response.rb +212 -0
- data/lib/ultracart_api/models/cart.rb +461 -0
- data/lib/ultracart_api/models/cart_affiliate.rb +210 -0
- data/lib/ultracart_api/models/cart_affirm_checkout_response.rb +197 -0
- data/lib/ultracart_api/models/cart_billing.rb +537 -0
- data/lib/ultracart_api/models/cart_buysafe.rb +234 -0
- data/lib/ultracart_api/models/cart_checkout.rb +465 -0
- data/lib/ultracart_api/models/cart_coupon.rb +185 -0
- data/lib/ultracart_api/models/cart_currency_conversion.rb +197 -0
- data/lib/ultracart_api/models/cart_customer_profile.rb +403 -0
- data/lib/ultracart_api/models/cart_customer_profile_address.rb +315 -0
- data/lib/ultracart_api/models/cart_customer_profile_credit_card.rb +269 -0
- data/lib/ultracart_api/models/cart_finalize_order_request.rb +193 -0
- data/lib/ultracart_api/models/cart_finalize_order_request_options.rb +320 -0
- data/lib/ultracart_api/models/cart_finalize_order_response.rb +225 -0
- data/lib/ultracart_api/models/cart_gift.rb +278 -0
- data/lib/ultracart_api/models/cart_gift_certificate.rb +203 -0
- data/lib/ultracart_api/models/cart_item.rb +469 -0
- data/lib/ultracart_api/models/cart_item_attribute.rb +205 -0
- data/lib/ultracart_api/models/cart_item_multimedia.rb +301 -0
- data/lib/ultracart_api/models/cart_item_multimedia_thumbnail.rb +225 -0
- data/lib/ultracart_api/models/cart_item_option.rb +343 -0
- data/lib/ultracart_api/models/cart_item_option_value.rb +223 -0
- data/lib/ultracart_api/models/cart_item_physical.rb +211 -0
- data/lib/ultracart_api/models/cart_item_variation_selection.rb +195 -0
- data/lib/ultracart_api/models/cart_kit_component_option.rb +363 -0
- data/lib/ultracart_api/models/cart_marketing.rb +195 -0
- data/lib/ultracart_api/models/cart_payment.rb +240 -0
- data/lib/ultracart_api/models/cart_payment_affirm.rb +185 -0
- data/lib/ultracart_api/models/cart_payment_amazon.rb +185 -0
- data/lib/ultracart_api/models/cart_payment_check.rb +185 -0
- data/lib/ultracart_api/models/cart_payment_credit_card.rb +265 -0
- data/lib/ultracart_api/models/cart_payment_purchase_order.rb +185 -0
- data/lib/ultracart_api/models/cart_profile_login_request.rb +204 -0
- data/lib/ultracart_api/models/cart_profile_login_response.rb +196 -0
- data/lib/ultracart_api/models/cart_profile_register_request.rb +194 -0
- data/lib/ultracart_api/models/cart_profile_register_response.rb +196 -0
- data/lib/ultracart_api/models/cart_property.rb +245 -0
- data/lib/ultracart_api/models/cart_response.rb +196 -0
- data/lib/ultracart_api/models/cart_settings.rb +229 -0
- data/lib/ultracart_api/models/cart_settings_billing.rb +187 -0
- data/lib/ultracart_api/models/cart_settings_gift.rb +216 -0
- data/lib/ultracart_api/models/cart_settings_gift_wrap.rb +204 -0
- data/lib/ultracart_api/models/cart_settings_payment.rb +302 -0
- data/lib/ultracart_api/models/cart_settings_payment_amazon.rb +205 -0
- data/lib/ultracart_api/models/cart_settings_payment_credit_card.rb +207 -0
- data/lib/ultracart_api/models/cart_settings_payment_pay_pal.rb +225 -0
- data/lib/ultracart_api/models/cart_settings_province.rb +193 -0
- data/lib/ultracart_api/models/cart_settings_shipping.rb +227 -0
- data/lib/ultracart_api/models/cart_settings_shipping_calendar.rb +229 -0
- data/lib/ultracart_api/models/cart_settings_shipping_estimate.rb +300 -0
- data/lib/ultracart_api/models/cart_settings_taxes.rb +186 -0
- data/lib/ultracart_api/models/cart_settings_terms.rb +195 -0
- data/lib/ultracart_api/models/cart_shipping.rb +590 -0
- data/lib/ultracart_api/models/cart_summary.rb +319 -0
- data/lib/ultracart_api/models/cart_taxes.rb +220 -0
- data/lib/ultracart_api/models/cart_upsell_after.rb +220 -0
- data/lib/ultracart_api/models/cart_validation_request.rb +196 -0
- data/lib/ultracart_api/models/cart_validation_response.rb +196 -0
- data/lib/ultracart_api/models/chargeback_dispute.rb +614 -0
- data/lib/ultracart_api/models/chargeback_dispute_response.rb +221 -0
- data/lib/ultracart_api/models/chargeback_disputes_response.rb +223 -0
- data/lib/ultracart_api/models/checkout_allowed_countries_response.rb +186 -0
- data/lib/ultracart_api/models/checkout_handoff_request.rb +288 -0
- data/lib/ultracart_api/models/checkout_handoff_response.rb +206 -0
- data/lib/ultracart_api/models/checkout_setup_browser_key_request.rb +187 -0
- data/lib/ultracart_api/models/checkout_setup_browser_key_response.rb +185 -0
- data/lib/ultracart_api/models/checkout_state_province_response.rb +186 -0
- data/lib/ultracart_api/models/city_state_zip.rb +220 -0
- data/lib/ultracart_api/models/countries_response.rb +186 -0
- data/lib/ultracart_api/models/country.rb +225 -0
- data/lib/ultracart_api/models/coupon.rb +792 -0
- data/lib/ultracart_api/models/coupon_amount_off_items.rb +232 -0
- data/lib/ultracart_api/models/coupon_amount_off_shipping.rb +222 -0
- data/lib/ultracart_api/models/coupon_amount_off_shipping_with_items_purchase.rb +234 -0
- data/lib/ultracart_api/models/coupon_amount_off_subtotal.rb +210 -0
- data/lib/ultracart_api/models/coupon_amount_off_subtotal_and_shipping.rb +210 -0
- data/lib/ultracart_api/models/coupon_amount_off_subtotal_free_shipping_with_purchase.rb +232 -0
- data/lib/ultracart_api/models/coupon_amount_off_subtotal_with_block_purchase.rb +230 -0
- data/lib/ultracart_api/models/coupon_amount_off_subtotal_with_items_purchase.rb +232 -0
- data/lib/ultracart_api/models/coupon_auto_apply_condition.rb +204 -0
- data/lib/ultracart_api/models/coupon_auto_apply_conditions.rb +234 -0
- data/lib/ultracart_api/models/coupon_automatically_apply_coupon_codes.rb +187 -0
- data/lib/ultracart_api/models/coupon_buy_one_get_one_limit.rb +197 -0
- data/lib/ultracart_api/models/coupon_codes_request.rb +242 -0
- data/lib/ultracart_api/models/coupon_codes_response.rb +234 -0
- data/lib/ultracart_api/models/coupon_deletes_request.rb +199 -0
- data/lib/ultracart_api/models/coupon_discount_item_with_item_purchase.rb +240 -0
- data/lib/ultracart_api/models/coupon_discount_items.rb +232 -0
- data/lib/ultracart_api/models/coupon_editor_values.rb +295 -0
- data/lib/ultracart_api/models/coupon_exists_response.rb +232 -0
- data/lib/ultracart_api/models/coupon_free_item_and_shipping_with_subtotal.rb +244 -0
- data/lib/ultracart_api/models/coupon_free_item_with_item_purchase.rb +219 -0
- data/lib/ultracart_api/models/coupon_free_item_with_subtotal.rb +232 -0
- data/lib/ultracart_api/models/coupon_free_items_with_item_purchase.rb +225 -0
- data/lib/ultracart_api/models/coupon_free_items_with_mix_match_purchase.rb +225 -0
- data/lib/ultracart_api/models/coupon_free_shipping.rb +187 -0
- data/lib/ultracart_api/models/coupon_free_shipping_specific_items.rb +187 -0
- data/lib/ultracart_api/models/coupon_free_shipping_with_items_purchase.rb +199 -0
- data/lib/ultracart_api/models/coupon_free_shipping_with_subtotal.rb +222 -0
- data/lib/ultracart_api/models/coupon_item_search_result.rb +255 -0
- data/lib/ultracart_api/models/coupon_item_search_results_response.rb +224 -0
- data/lib/ultracart_api/models/coupon_multiple_amounts_off_items.rb +197 -0
- data/lib/ultracart_api/models/coupon_no_discount.rb +175 -0
- data/lib/ultracart_api/models/coupon_percent_off_item_with_items_quantity_purchase.rb +229 -0
- data/lib/ultracart_api/models/coupon_percent_off_items.rb +219 -0
- data/lib/ultracart_api/models/coupon_percent_off_items_and_free_shipping.rb +209 -0
- data/lib/ultracart_api/models/coupon_percent_off_items_with_items_purchase.rb +219 -0
- data/lib/ultracart_api/models/coupon_percent_off_retail_price_items.rb +219 -0
- data/lib/ultracart_api/models/coupon_percent_off_shipping.rb +197 -0
- data/lib/ultracart_api/models/coupon_percent_off_subtotal.rb +185 -0
- data/lib/ultracart_api/models/coupon_percent_off_subtotal_and_free_shipping.rb +197 -0
- data/lib/ultracart_api/models/coupon_percent_off_subtotal_limit.rb +220 -0
- data/lib/ultracart_api/models/coupon_percent_off_subtotal_with_items_purchase.rb +197 -0
- data/lib/ultracart_api/models/coupon_percent_off_subtotal_with_subtotal.rb +220 -0
- data/lib/ultracart_api/models/coupon_query.rb +265 -0
- data/lib/ultracart_api/models/coupon_response.rb +221 -0
- data/lib/ultracart_api/models/coupon_restriction.rb +211 -0
- data/lib/ultracart_api/models/coupon_tier_amount.rb +195 -0
- data/lib/ultracart_api/models/coupon_tier_item_discount.rb +197 -0
- data/lib/ultracart_api/models/coupon_tier_percent.rb +195 -0
- data/lib/ultracart_api/models/coupon_tier_quantity_amount.rb +195 -0
- data/lib/ultracart_api/models/coupon_tier_quantity_percent.rb +195 -0
- data/lib/ultracart_api/models/coupon_tiered_amount_off_item.rb +207 -0
- data/lib/ultracart_api/models/coupon_tiered_amount_off_subtotal.rb +199 -0
- data/lib/ultracart_api/models/coupon_tiered_percent_off_items.rb +209 -0
- data/lib/ultracart_api/models/coupon_tiered_percent_off_shipping.rb +199 -0
- data/lib/ultracart_api/models/coupon_tiered_percent_off_subtotal.rb +199 -0
- data/lib/ultracart_api/models/coupon_type.rb +195 -0
- data/lib/ultracart_api/models/coupons_request.rb +187 -0
- data/lib/ultracart_api/models/coupons_response.rb +223 -0
- data/lib/ultracart_api/models/currency.rb +225 -0
- data/lib/ultracart_api/models/customer.rb +933 -0
- data/lib/ultracart_api/models/customer_activity.rb +219 -0
- data/lib/ultracart_api/models/customer_affiliate.rb +195 -0
- data/lib/ultracart_api/models/customer_attachment.rb +225 -0
- data/lib/ultracart_api/models/customer_billing.rb +540 -0
- data/lib/ultracart_api/models/customer_card.rb +255 -0
- data/lib/ultracart_api/models/customer_editor_values.rb +271 -0
- data/lib/ultracart_api/models/customer_email.rb +265 -0
- data/lib/ultracart_api/models/customer_email_list_changes.rb +199 -0
- data/lib/ultracart_api/models/customer_loyalty.rb +209 -0
- data/lib/ultracart_api/models/customer_loyalty_ledger.rb +325 -0
- data/lib/ultracart_api/models/customer_loyalty_redemption.rb +305 -0
- data/lib/ultracart_api/models/customer_orders_summary.rb +215 -0
- data/lib/ultracart_api/models/customer_pricing_tier.rb +210 -0
- data/lib/ultracart_api/models/customer_privacy.rb +215 -0
- data/lib/ultracart_api/models/customer_query.rb +754 -0
- data/lib/ultracart_api/models/customer_quotes_summary.rb +215 -0
- data/lib/ultracart_api/models/customer_response.rb +221 -0
- data/lib/ultracart_api/models/customer_reviewer.rb +275 -0
- data/lib/ultracart_api/models/customer_shipping.rb +540 -0
- data/lib/ultracart_api/models/customer_software_entitlement.rb +330 -0
- data/lib/ultracart_api/models/customer_tag.rb +200 -0
- data/lib/ultracart_api/models/customer_tax_codes.rb +225 -0
- data/lib/ultracart_api/models/customers_response.rb +223 -0
- data/lib/ultracart_api/models/data_tables_server_side_response.rb +213 -0
- data/lib/ultracart_api/models/distance.rb +229 -0
- data/lib/ultracart_api/models/distribution_center.rb +514 -0
- data/lib/ultracart_api/models/distribution_centers_response.rb +223 -0
- data/lib/ultracart_api/models/email_base_template_list_response.rb +186 -0
- data/lib/ultracart_api/models/email_campaign.rb +422 -0
- data/lib/ultracart_api/models/email_campaign_folder.rb +240 -0
- data/lib/ultracart_api/models/email_campaign_folder_response.rb +221 -0
- data/lib/ultracart_api/models/email_campaign_folders_response.rb +223 -0
- data/lib/ultracart_api/models/email_campaign_response.rb +221 -0
- data/lib/ultracart_api/models/email_campaigns_response.rb +223 -0
- data/lib/ultracart_api/models/email_click.rb +195 -0
- data/lib/ultracart_api/models/email_clicks_response.rb +223 -0
- data/lib/ultracart_api/models/email_commseq.rb +217 -0
- data/lib/ultracart_api/models/email_commseq_email.rb +415 -0
- data/lib/ultracart_api/models/email_commseq_email_response.rb +221 -0
- data/lib/ultracart_api/models/email_commseq_email_send_test_request.rb +269 -0
- data/lib/ultracart_api/models/email_commseq_email_send_test_response.rb +212 -0
- data/lib/ultracart_api/models/email_commseq_emails_request.rb +223 -0
- data/lib/ultracart_api/models/email_commseq_emails_response.rb +223 -0
- data/lib/ultracart_api/models/email_commseq_postcard.rb +285 -0
- data/lib/ultracart_api/models/email_commseq_postcard_response.rb +221 -0
- data/lib/ultracart_api/models/email_commseq_postcard_send_test_request.rb +285 -0
- data/lib/ultracart_api/models/email_commseq_postcard_send_test_response.rb +239 -0
- data/lib/ultracart_api/models/email_commseq_postcards_request.rb +186 -0
- data/lib/ultracart_api/models/email_commseq_postcards_response.rb +223 -0
- data/lib/ultracart_api/models/email_commseq_response.rb +221 -0
- data/lib/ultracart_api/models/email_commseq_stat.rb +545 -0
- data/lib/ultracart_api/models/email_commseq_stat_response.rb +221 -0
- data/lib/ultracart_api/models/email_commseq_step.rb +313 -0
- data/lib/ultracart_api/models/email_commseqs_response.rb +223 -0
- data/lib/ultracart_api/models/email_customer.rb +257 -0
- data/lib/ultracart_api/models/email_customer_editor_url_response.rb +221 -0
- data/lib/ultracart_api/models/email_customers_response.rb +227 -0
- data/lib/ultracart_api/models/email_dashboard_activity.rb +245 -0
- data/lib/ultracart_api/models/email_dashboard_activity_response.rb +223 -0
- data/lib/ultracart_api/models/email_dashboard_stats_response.rb +223 -0
- data/lib/ultracart_api/models/email_domain.rb +276 -0
- data/lib/ultracart_api/models/email_editor_token_response.rb +221 -0
- data/lib/ultracart_api/models/email_flow.rb +460 -0
- data/lib/ultracart_api/models/email_flow_back_populate_request.rb +195 -0
- data/lib/ultracart_api/models/email_flow_back_populate_response.rb +212 -0
- data/lib/ultracart_api/models/email_flow_folder.rb +240 -0
- data/lib/ultracart_api/models/email_flow_folder_response.rb +221 -0
- data/lib/ultracart_api/models/email_flow_folders_response.rb +223 -0
- data/lib/ultracart_api/models/email_flow_response.rb +221 -0
- data/lib/ultracart_api/models/email_flows_response.rb +223 -0
- data/lib/ultracart_api/models/email_global_settings.rb +184 -0
- data/lib/ultracart_api/models/email_global_settings_response.rb +221 -0
- data/lib/ultracart_api/models/email_global_unsubscribe_request.rb +184 -0
- data/lib/ultracart_api/models/email_global_unsubscribe_response.rb +184 -0
- data/lib/ultracart_api/models/email_histogram_property_names_response.rb +186 -0
- data/lib/ultracart_api/models/email_histogram_property_values_response.rb +186 -0
- data/lib/ultracart_api/models/email_list.rb +302 -0
- data/lib/ultracart_api/models/email_list_archive_response.rb +221 -0
- data/lib/ultracart_api/models/email_list_customer.rb +215 -0
- data/lib/ultracart_api/models/email_list_customers_response.rb +227 -0
- data/lib/ultracart_api/models/email_list_response.rb +221 -0
- data/lib/ultracart_api/models/email_list_segment_membership.rb +215 -0
- data/lib/ultracart_api/models/email_list_segment_used_by.rb +205 -0
- data/lib/ultracart_api/models/email_list_subscribe_response.rb +193 -0
- data/lib/ultracart_api/models/email_lists_response.rb +223 -0
- data/lib/ultracart_api/models/email_order.rb +214 -0
- data/lib/ultracart_api/models/email_orders_response.rb +223 -0
- data/lib/ultracart_api/models/email_performance.rb +396 -0
- data/lib/ultracart_api/models/email_performance_customer_histogram.rb +187 -0
- data/lib/ultracart_api/models/email_performance_customer_histogram_period.rb +225 -0
- data/lib/ultracart_api/models/email_performance_daily.rb +245 -0
- data/lib/ultracart_api/models/email_performance_response.rb +221 -0
- data/lib/ultracart_api/models/email_plan.rb +321 -0
- data/lib/ultracart_api/models/email_plan_additional.rb +229 -0
- data/lib/ultracart_api/models/email_plan_response.rb +221 -0
- data/lib/ultracart_api/models/email_postcard_stat.rb +496 -0
- data/lib/ultracart_api/models/email_segment.rb +332 -0
- data/lib/ultracart_api/models/email_segment_archive_response.rb +221 -0
- data/lib/ultracart_api/models/email_segment_customer.rb +215 -0
- data/lib/ultracart_api/models/email_segment_customers_response.rb +227 -0
- data/lib/ultracart_api/models/email_segment_download_prepare_response.rb +248 -0
- data/lib/ultracart_api/models/email_segment_response.rb +221 -0
- data/lib/ultracart_api/models/email_segments_response.rb +223 -0
- data/lib/ultracart_api/models/email_sending_domain_response.rb +221 -0
- data/lib/ultracart_api/models/email_sending_domains_response.rb +223 -0
- data/lib/ultracart_api/models/email_settings.rb +283 -0
- data/lib/ultracart_api/models/email_settings_response.rb +221 -0
- data/lib/ultracart_api/models/email_stat.rb +556 -0
- data/lib/ultracart_api/models/email_stat_postcard_summary_request.rb +195 -0
- data/lib/ultracart_api/models/email_stat_postcard_summary_response.rb +223 -0
- data/lib/ultracart_api/models/email_stat_summary_request.rb +206 -0
- data/lib/ultracart_api/models/email_stat_summary_response.rb +223 -0
- data/lib/ultracart_api/models/email_step_stat.rb +375 -0
- data/lib/ultracart_api/models/email_step_stat_request.rb +195 -0
- data/lib/ultracart_api/models/email_step_stat_response.rb +223 -0
- data/lib/ultracart_api/models/email_step_waiting_request.rb +186 -0
- data/lib/ultracart_api/models/email_step_waiting_response.rb +186 -0
- data/lib/ultracart_api/models/email_template.rb +330 -0
- data/lib/ultracart_api/models/email_templates_response.rb +223 -0
- data/lib/ultracart_api/models/email_third_party_list.rb +195 -0
- data/lib/ultracart_api/models/email_third_party_list_import_request.rb +187 -0
- data/lib/ultracart_api/models/email_third_party_provider.rb +267 -0
- data/lib/ultracart_api/models/email_third_party_providers_response.rb +223 -0
- data/lib/ultracart_api/models/error.rb +215 -0
- data/lib/ultracart_api/models/error_response.rb +212 -0
- data/lib/ultracart_api/models/experiment.rb +391 -0
- data/lib/ultracart_api/models/experiment_response.rb +221 -0
- data/lib/ultracart_api/models/experiment_variation.rb +365 -0
- data/lib/ultracart_api/models/experiments_response.rb +223 -0
- data/lib/ultracart_api/models/fulfillment_inventory.rb +193 -0
- data/lib/ultracart_api/models/fulfillment_shipment.rb +227 -0
- data/lib/ultracart_api/models/geo_point.rb +193 -0
- data/lib/ultracart_api/models/geocode_request.rb +225 -0
- data/lib/ultracart_api/models/geocode_response.rb +230 -0
- data/lib/ultracart_api/models/group.rb +231 -0
- data/lib/ultracart_api/models/group_response.rb +221 -0
- data/lib/ultracart_api/models/group_user_membership.rb +225 -0
- data/lib/ultracart_api/models/groups_response.rb +223 -0
- data/lib/ultracart_api/models/http_header.rb +195 -0
- data/lib/ultracart_api/models/item.rb +701 -0
- data/lib/ultracart_api/models/item_accounting.rb +225 -0
- data/lib/ultracart_api/models/item_amember.rb +210 -0
- data/lib/ultracart_api/models/item_auto_order.rb +358 -0
- data/lib/ultracart_api/models/item_auto_order_step.rb +378 -0
- data/lib/ultracart_api/models/item_auto_order_step_arbitrary_unit_cost_schedule.rb +195 -0
- data/lib/ultracart_api/models/item_auto_order_step_grandfather_pricing.rb +195 -0
- data/lib/ultracart_api/models/item_cc_bill.rb +235 -0
- data/lib/ultracart_api/models/item_channel_partner_mapping.rb +400 -0
- data/lib/ultracart_api/models/item_chargeback.rb +199 -0
- data/lib/ultracart_api/models/item_chargeback_addendum.rb +215 -0
- data/lib/ultracart_api/models/item_chargeback_adjustment_request.rb +205 -0
- data/lib/ultracart_api/models/item_checkout.rb +220 -0
- data/lib/ultracart_api/models/item_content.rb +316 -0
- data/lib/ultracart_api/models/item_content_assignment.rb +240 -0
- data/lib/ultracart_api/models/item_content_attribute.rb +245 -0
- data/lib/ultracart_api/models/item_content_multimedia.rb +406 -0
- data/lib/ultracart_api/models/item_content_multimedia_thumbnail.rb +235 -0
- data/lib/ultracart_api/models/item_digital_delivery.rb +282 -0
- data/lib/ultracart_api/models/item_digital_item.rb +270 -0
- data/lib/ultracart_api/models/item_ebay.rb +866 -0
- data/lib/ultracart_api/models/item_ebay_category_specific.rb +195 -0
- data/lib/ultracart_api/models/item_ebay_market_listing.rb +225 -0
- data/lib/ultracart_api/models/item_ebay_market_place_analysis.rb +276 -0
- data/lib/ultracart_api/models/item_email_notifications.rb +195 -0
- data/lib/ultracart_api/models/item_enrollment123.rb +185 -0
- data/lib/ultracart_api/models/item_gift_certificate.rb +195 -0
- data/lib/ultracart_api/models/item_google_product_search.rb +1254 -0
- data/lib/ultracart_api/models/item_identifiers.rb +275 -0
- data/lib/ultracart_api/models/item_instant_payment_notification.rb +235 -0
- data/lib/ultracart_api/models/item_instant_payment_notifications.rb +187 -0
- data/lib/ultracart_api/models/item_internal.rb +200 -0
- data/lib/ultracart_api/models/item_kit_component.rb +225 -0
- data/lib/ultracart_api/models/item_kit_definition.rb +187 -0
- data/lib/ultracart_api/models/item_option.rb +381 -0
- data/lib/ultracart_api/models/item_option_value.rb +374 -0
- data/lib/ultracart_api/models/item_option_value_additional_item.rb +195 -0
- data/lib/ultracart_api/models/item_option_value_digital_item.rb +195 -0
- data/lib/ultracart_api/models/item_payment_processing.rb +229 -0
- data/lib/ultracart_api/models/item_physical.rb +211 -0
- data/lib/ultracart_api/models/item_pricing.rb +387 -0
- data/lib/ultracart_api/models/item_pricing_tier.rb +226 -0
- data/lib/ultracart_api/models/item_pricing_tier_discount.rb +195 -0
- data/lib/ultracart_api/models/item_pricing_tier_limit.rb +205 -0
- data/lib/ultracart_api/models/item_property.rb +235 -0
- data/lib/ultracart_api/models/item_realtime_pricing.rb +205 -0
- data/lib/ultracart_api/models/item_related.rb +207 -0
- data/lib/ultracart_api/models/item_related_item.rb +239 -0
- data/lib/ultracart_api/models/item_reporting.rb +197 -0
- data/lib/ultracart_api/models/item_response.rb +221 -0
- data/lib/ultracart_api/models/item_restriction.rb +257 -0
- data/lib/ultracart_api/models/item_restriction_item.rb +239 -0
- data/lib/ultracart_api/models/item_revguard.rb +245 -0
- data/lib/ultracart_api/models/item_reviews.rb +245 -0
- data/lib/ultracart_api/models/item_salesforce.rb +195 -0
- data/lib/ultracart_api/models/item_shipping.rb +678 -0
- data/lib/ultracart_api/models/item_shipping_case.rb +230 -0
- data/lib/ultracart_api/models/item_shipping_destination_markup.rb +280 -0
- data/lib/ultracart_api/models/item_shipping_destination_restriction.rb +269 -0
- data/lib/ultracart_api/models/item_shipping_distribution_center.rb +335 -0
- data/lib/ultracart_api/models/item_shipping_method.rb +359 -0
- data/lib/ultracart_api/models/item_shipping_package_requirement.rb +195 -0
- data/lib/ultracart_api/models/item_tag.rb +244 -0
- data/lib/ultracart_api/models/item_tags.rb +187 -0
- data/lib/ultracart_api/models/item_tax.rb +207 -0
- data/lib/ultracart_api/models/item_tax_exemption.rb +300 -0
- data/lib/ultracart_api/models/item_third_party_email_marketing.rb +267 -0
- data/lib/ultracart_api/models/item_variant_item.rb +254 -0
- data/lib/ultracart_api/models/item_variation.rb +257 -0
- data/lib/ultracart_api/models/item_variation_option.rb +230 -0
- data/lib/ultracart_api/models/item_wishlist_member.rb +220 -0
- data/lib/ultracart_api/models/items_request.rb +187 -0
- data/lib/ultracart_api/models/items_response.rb +224 -0
- data/lib/ultracart_api/models/key_value.rb +205 -0
- data/lib/ultracart_api/models/library_filter_values.rb +219 -0
- data/lib/ultracart_api/models/library_filter_values_response.rb +221 -0
- data/lib/ultracart_api/models/library_item.rb +571 -0
- data/lib/ultracart_api/models/library_item_account.rb +202 -0
- data/lib/ultracart_api/models/library_item_asset.rb +193 -0
- data/lib/ultracart_api/models/library_item_attribute.rb +202 -0
- data/lib/ultracart_api/models/library_item_email.rb +202 -0
- data/lib/ultracart_api/models/library_item_published_meta.rb +255 -0
- data/lib/ultracart_api/models/library_item_purchased_meta.rb +205 -0
- data/lib/ultracart_api/models/library_item_query.rb +295 -0
- data/lib/ultracart_api/models/library_item_response.rb +221 -0
- data/lib/ultracart_api/models/library_item_screenshot.rb +193 -0
- data/lib/ultracart_api/models/library_items_response.rb +224 -0
- data/lib/ultracart_api/models/linked_account.rb +205 -0
- data/lib/ultracart_api/models/list_segment_membership.rb +202 -0
- data/lib/ultracart_api/models/lookup_request.rb +220 -0
- data/lib/ultracart_api/models/lookup_response.rb +223 -0
- data/lib/ultracart_api/models/metric.rb +247 -0
- data/lib/ultracart_api/models/notification.rb +287 -0
- data/lib/ultracart_api/models/oauth_revoke_success_response.rb +195 -0
- data/lib/ultracart_api/models/oauth_token_response.rb +286 -0
- data/lib/ultracart_api/models/order.rb +569 -0
- data/lib/ultracart_api/models/order_affiliate.rb +207 -0
- data/lib/ultracart_api/models/order_affiliate_ledger.rb +299 -0
- data/lib/ultracart_api/models/order_auto_order.rb +403 -0
- data/lib/ultracart_api/models/order_billing.rb +537 -0
- data/lib/ultracart_api/models/order_buysafe.rb +233 -0
- data/lib/ultracart_api/models/order_by_token_query.rb +185 -0
- data/lib/ultracart_api/models/order_channel_partner.rb +275 -0
- data/lib/ultracart_api/models/order_checkout.rb +415 -0
- data/lib/ultracart_api/models/order_coupon.rb +245 -0
- data/lib/ultracart_api/models/order_digital_item.rb +255 -0
- data/lib/ultracart_api/models/order_digital_order.rb +227 -0
- data/lib/ultracart_api/models/order_edi.rb +230 -0
- data/lib/ultracart_api/models/order_format.rb +369 -0
- data/lib/ultracart_api/models/order_format_response.rb +197 -0
- data/lib/ultracart_api/models/order_fraud_score.rb +409 -0
- data/lib/ultracart_api/models/order_gift.rb +316 -0
- data/lib/ultracart_api/models/order_gift_certificate.rb +204 -0
- data/lib/ultracart_api/models/order_internal.rb +240 -0
- data/lib/ultracart_api/models/order_item.rb +800 -0
- data/lib/ultracart_api/models/order_item_edi.rb +199 -0
- data/lib/ultracart_api/models/order_item_edi_identification.rb +195 -0
- data/lib/ultracart_api/models/order_item_edi_lot.rb +205 -0
- data/lib/ultracart_api/models/order_item_option.rb +343 -0
- data/lib/ultracart_api/models/order_item_option_file_attachment.rb +215 -0
- data/lib/ultracart_api/models/order_item_property.rb +245 -0
- data/lib/ultracart_api/models/order_item_tag.rb +200 -0
- data/lib/ultracart_api/models/order_linked_shipment.rb +229 -0
- data/lib/ultracart_api/models/order_marketing.rb +235 -0
- data/lib/ultracart_api/models/order_payment.rb +388 -0
- data/lib/ultracart_api/models/order_payment_check.rb +185 -0
- data/lib/ultracart_api/models/order_payment_credit_card.rb +319 -0
- data/lib/ultracart_api/models/order_payment_e_check.rb +441 -0
- data/lib/ultracart_api/models/order_payment_purchase_order.rb +185 -0
- data/lib/ultracart_api/models/order_payment_transaction.rb +217 -0
- data/lib/ultracart_api/models/order_payment_transaction_detail.rb +205 -0
- data/lib/ultracart_api/models/order_process_payment_request.rb +185 -0
- data/lib/ultracart_api/models/order_process_payment_response.rb +221 -0
- data/lib/ultracart_api/models/order_property.rb +245 -0
- data/lib/ultracart_api/models/order_query.rb +701 -0
- data/lib/ultracart_api/models/order_query_batch.rb +187 -0
- data/lib/ultracart_api/models/order_quote.rb +205 -0
- data/lib/ultracart_api/models/order_replacement.rb +432 -0
- data/lib/ultracart_api/models/order_replacement_item.rb +220 -0
- data/lib/ultracart_api/models/order_replacement_response.rb +229 -0
- data/lib/ultracart_api/models/order_response.rb +221 -0
- data/lib/ultracart_api/models/order_salesforce.rb +185 -0
- data/lib/ultracart_api/models/order_shipping.rb +710 -0
- data/lib/ultracart_api/models/order_summary.rb +328 -0
- data/lib/ultracart_api/models/order_tag.rb +200 -0
- data/lib/ultracart_api/models/order_taxes.rb +360 -0
- data/lib/ultracart_api/models/order_token_response.rb +222 -0
- data/lib/ultracart_api/models/order_tracking_number_detail.rb +265 -0
- data/lib/ultracart_api/models/order_tracking_number_details.rb +330 -0
- data/lib/ultracart_api/models/orders_response.rb +224 -0
- data/lib/ultracart_api/models/permission.rb +205 -0
- data/lib/ultracart_api/models/pricing_tier.rb +498 -0
- data/lib/ultracart_api/models/pricing_tier_notification.rb +235 -0
- data/lib/ultracart_api/models/pricing_tiers_response.rb +224 -0
- data/lib/ultracart_api/models/property.rb +193 -0
- data/lib/ultracart_api/models/publish_library_item_request.rb +185 -0
- data/lib/ultracart_api/models/register_affiliate_click_request.rb +235 -0
- data/lib/ultracart_api/models/register_affiliate_click_response.rb +219 -0
- data/lib/ultracart_api/models/response_metadata.rb +194 -0
- data/lib/ultracart_api/models/result_set.rb +235 -0
- data/lib/ultracart_api/models/screen_recording.rb +477 -0
- data/lib/ultracart_api/models/screen_recording_filter.rb +426 -0
- data/lib/ultracart_api/models/screen_recording_filter_geo_distance.rb +220 -0
- data/lib/ultracart_api/models/screen_recording_filter_ip_search.rb +211 -0
- data/lib/ultracart_api/models/screen_recording_filter_page_view.rb +244 -0
- data/lib/ultracart_api/models/screen_recording_filter_page_view_event.rb +195 -0
- data/lib/ultracart_api/models/screen_recording_filter_page_view_event_param.rb +220 -0
- data/lib/ultracart_api/models/screen_recording_filter_page_view_param.rb +193 -0
- data/lib/ultracart_api/models/screen_recording_filter_page_view_referrer_param.rb +193 -0
- data/lib/ultracart_api/models/screen_recording_filter_range_big_decimal.rb +220 -0
- data/lib/ultracart_api/models/screen_recording_filter_range_date.rb +195 -0
- data/lib/ultracart_api/models/screen_recording_filter_range_integer.rb +220 -0
- data/lib/ultracart_api/models/screen_recording_filter_string_search.rb +220 -0
- data/lib/ultracart_api/models/screen_recording_filter_values.rb +283 -0
- data/lib/ultracart_api/models/screen_recording_filter_values_event.rb +195 -0
- data/lib/ultracart_api/models/screen_recording_filter_values_event_params.rb +228 -0
- data/lib/ultracart_api/models/screen_recording_multifield.rb +220 -0
- data/lib/ultracart_api/models/screen_recording_page_view.rb +318 -0
- data/lib/ultracart_api/models/screen_recording_page_view_event.rb +214 -0
- data/lib/ultracart_api/models/screen_recording_page_view_event_parameter.rb +193 -0
- data/lib/ultracart_api/models/screen_recording_page_view_parameter.rb +193 -0
- data/lib/ultracart_api/models/screen_recording_query_request.rb +184 -0
- data/lib/ultracart_api/models/screen_recording_query_response.rb +241 -0
- data/lib/ultracart_api/models/screen_recording_response.rb +221 -0
- data/lib/ultracart_api/models/screen_recording_segment.rb +238 -0
- data/lib/ultracart_api/models/screen_recording_segment_response.rb +221 -0
- data/lib/ultracart_api/models/screen_recording_segments_response.rb +223 -0
- data/lib/ultracart_api/models/screen_recording_settings.rb +184 -0
- data/lib/ultracart_api/models/screen_recording_settings_response.rb +221 -0
- data/lib/ultracart_api/models/screen_recording_store_front.rb +193 -0
- data/lib/ultracart_api/models/screen_recording_tags_request.rb +186 -0
- data/lib/ultracart_api/models/screen_recording_tags_response.rb +223 -0
- data/lib/ultracart_api/models/screen_recording_user_agent.rb +220 -0
- data/lib/ultracart_api/models/screen_recording_user_agent_device.rb +184 -0
- data/lib/ultracart_api/models/screen_recording_user_agent_os.rb +202 -0
- data/lib/ultracart_api/models/screen_recording_user_property.rb +193 -0
- data/lib/ultracart_api/models/screenshots_response.rb +224 -0
- data/lib/ultracart_api/models/self_config.rb +185 -0
- data/lib/ultracart_api/models/simple_value.rb +195 -0
- data/lib/ultracart_api/models/sovos_config.rb +245 -0
- data/lib/ultracart_api/models/state_province.rb +210 -0
- data/lib/ultracart_api/models/step_waiting.rb +193 -0
- data/lib/ultracart_api/models/tax_city.rb +267 -0
- data/lib/ultracart_api/models/tax_country.rb +267 -0
- data/lib/ultracart_api/models/tax_country_code.rb +225 -0
- data/lib/ultracart_api/models/tax_county.rb +277 -0
- data/lib/ultracart_api/models/tax_jar_config.rb +235 -0
- data/lib/ultracart_api/models/tax_postal_code.rb +245 -0
- data/lib/ultracart_api/models/tax_provider_activate_result.rb +194 -0
- data/lib/ultracart_api/models/tax_provider_avalara.rb +214 -0
- data/lib/ultracart_api/models/tax_provider_avalara_companies_result.rb +187 -0
- data/lib/ultracart_api/models/tax_provider_avalara_company.rb +225 -0
- data/lib/ultracart_api/models/tax_provider_self.rb +226 -0
- data/lib/ultracart_api/models/tax_provider_self_countries_response.rb +187 -0
- data/lib/ultracart_api/models/tax_provider_self_regions_response.rb +187 -0
- data/lib/ultracart_api/models/tax_provider_sovos.rb +214 -0
- data/lib/ultracart_api/models/tax_provider_tax_jar.rb +214 -0
- data/lib/ultracart_api/models/tax_provider_test_result.rb +194 -0
- data/lib/ultracart_api/models/tax_provider_ultra_cart.rb +226 -0
- data/lib/ultracart_api/models/tax_provider_ultra_cart_state.rb +245 -0
- data/lib/ultracart_api/models/tax_providers_response.rb +257 -0
- data/lib/ultracart_api/models/tax_state.rb +327 -0
- data/lib/ultracart_api/models/tax_state_code.rb +225 -0
- data/lib/ultracart_api/models/temp_multimedia.rb +294 -0
- data/lib/ultracart_api/models/temp_multimedia_response.rb +221 -0
- data/lib/ultracart_api/models/thumbnail_parameters_request.rb +220 -0
- data/lib/ultracart_api/models/thumbnail_parameters_response.rb +222 -0
- data/lib/ultracart_api/models/transaction_email.rb +379 -0
- data/lib/ultracart_api/models/transaction_email_list_response.rb +223 -0
- data/lib/ultracart_api/models/transaction_email_option.rb +247 -0
- data/lib/ultracart_api/models/transaction_email_response.rb +221 -0
- data/lib/ultracart_api/models/ultra_cart_config.rb +185 -0
- data/lib/ultracart_api/models/upload_coupon_codes_request.rb +224 -0
- data/lib/ultracart_api/models/upload_coupon_codes_response.rb +248 -0
- data/lib/ultracart_api/models/user.rb +327 -0
- data/lib/ultracart_api/models/user_group_membership.rb +205 -0
- data/lib/ultracart_api/models/user_login.rb +215 -0
- data/lib/ultracart_api/models/user_logins_response.rb +224 -0
- data/lib/ultracart_api/models/user_response.rb +221 -0
- data/lib/ultracart_api/models/users_response.rb +223 -0
- data/lib/ultracart_api/models/verification_record.rb +202 -0
- data/lib/ultracart_api/models/warning.rb +195 -0
- data/lib/ultracart_api/models/webhook.rb +402 -0
- data/lib/ultracart_api/models/webhook_event_category.rb +229 -0
- data/lib/ultracart_api/models/webhook_event_subscription.rb +265 -0
- data/lib/ultracart_api/models/webhook_log.rb +279 -0
- data/lib/ultracart_api/models/webhook_log_response.rb +221 -0
- data/lib/ultracart_api/models/webhook_log_summaries_response.rb +224 -0
- data/lib/ultracart_api/models/webhook_log_summary.rb +205 -0
- data/lib/ultracart_api/models/webhook_response.rb +221 -0
- data/lib/ultracart_api/models/webhook_sample_request.rb +217 -0
- data/lib/ultracart_api/models/webhook_sample_request_response.rb +221 -0
- data/lib/ultracart_api/models/webhooks_response.rb +223 -0
- data/lib/ultracart_api/models/weight.rb +229 -0
- data/lib/ultracart_api/version.rb +15 -0
- data/spec/api_client_spec.rb +243 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/spec_helper.rb +111 -0
- data/ultracart_api.gemspec +45 -0
- metadata +1380 -0
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# UltracartClient::ChargebackDispute
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**account_number** | **String** | Account number | [optional]
|
|
7
|
+
**adjustment_request_text** | **String** | Adjustment request text | [optional]
|
|
8
|
+
**amount** | **Float** | Amount | [optional]
|
|
9
|
+
**auth_code** | **String** | Auth code | [optional]
|
|
10
|
+
**case_number** | **String** | Case number | [optional]
|
|
11
|
+
**chargeback_dispute_oid** | **Integer** | Chargeback Dispute Oid | [optional]
|
|
12
|
+
**chargeback_dts** | **String** | Chargeback dts | [optional]
|
|
13
|
+
**currency** | **String** | Currency | [optional]
|
|
14
|
+
**customer_care_notes** | **String** | Customer care notes | [optional]
|
|
15
|
+
**encryption_key** | **String** | Encryption key | [optional]
|
|
16
|
+
**expiration_dts** | **String** | Expiration Dts | [optional]
|
|
17
|
+
**fax_failure_reason** | **String** | Fax failure reason | [optional]
|
|
18
|
+
**fax_number** | **String** | Fax number | [optional]
|
|
19
|
+
**fax_transaction_id** | **Integer** | Fax transaction id | [optional]
|
|
20
|
+
**icsid** | **String** | icsid | [optional]
|
|
21
|
+
**merchant_account_profile_oid** | **Integer** | Merchant account profile oid | [optional]
|
|
22
|
+
**order** | [**Order**](Order.md) | | [optional]
|
|
23
|
+
**order_id** | **String** | Order Id | [optional]
|
|
24
|
+
**partial_card_number** | **String** | Partial card number | [optional]
|
|
25
|
+
**pdf_file_oid** | **String** | PDF file oid | [optional]
|
|
26
|
+
**reason_code** | **String** | Reason code | [optional]
|
|
27
|
+
**status** | **String** | Status | [optional]
|
|
28
|
+
**website_url** | **String** | Website URL | [optional]
|
|
29
|
+
|
|
30
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# UltracartClient::ChargebackDisputeResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**chargeback** | [**ChargebackDispute**](ChargebackDispute.md) | | [optional]
|
|
7
|
+
**error** | [**Error**](Error.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
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# UltracartClient::ChargebackDisputesResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**chargebacks** | [**Array<ChargebackDispute>**](ChargebackDispute.md) | | [optional]
|
|
7
|
+
**error** | [**Error**](Error.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
|
+
|
data/docs/CheckoutApi.md
ADDED
|
@@ -0,0 +1,1240 @@
|
|
|
1
|
+
# UltracartClient::CheckoutApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**city_state**](CheckoutApi.md#city_state) | **POST** /checkout/city_state | City/State for Zip
|
|
8
|
+
[**finalize_order**](CheckoutApi.md#finalize_order) | **POST** /checkout/cart/finalizeOrder | Finalize Order
|
|
9
|
+
[**get_affirm_checkout**](CheckoutApi.md#get_affirm_checkout) | **GET** /checkout/cart/{cart_id}/affirmCheckout | Get affirm checkout (by cart id)
|
|
10
|
+
[**get_allowed_countries**](CheckoutApi.md#get_allowed_countries) | **POST** /checkout/allowedCountries | Allowed countries
|
|
11
|
+
[**get_cart**](CheckoutApi.md#get_cart) | **GET** /checkout/cart | Get cart
|
|
12
|
+
[**get_cart_by_cart_id**](CheckoutApi.md#get_cart_by_cart_id) | **GET** /checkout/cart/{cart_id} | Get cart (by cart id)
|
|
13
|
+
[**get_cart_by_return_code**](CheckoutApi.md#get_cart_by_return_code) | **GET** /checkout/return/{return_code} | Get cart (by return code)
|
|
14
|
+
[**get_cart_by_return_token**](CheckoutApi.md#get_cart_by_return_token) | **GET** /checkout/return_token | Get cart (by return token)
|
|
15
|
+
[**get_state_provinces_for_country**](CheckoutApi.md#get_state_provinces_for_country) | **POST** /checkout/stateProvincesForCountry/{country_code} | Get state/province list for a country code
|
|
16
|
+
[**handoff_cart**](CheckoutApi.md#handoff_cart) | **POST** /checkout/cart/handoff | Handoff cart
|
|
17
|
+
[**login**](CheckoutApi.md#login) | **POST** /checkout/cart/profile/login | Profile login
|
|
18
|
+
[**logout**](CheckoutApi.md#logout) | **POST** /checkout/cart/profile/logout | Profile logout
|
|
19
|
+
[**register**](CheckoutApi.md#register) | **POST** /checkout/cart/profile/register | Profile registration
|
|
20
|
+
[**register_affiliate_click**](CheckoutApi.md#register_affiliate_click) | **POST** /checkout/affiliateClick/register | Register affiliate click
|
|
21
|
+
[**related_items_for_cart**](CheckoutApi.md#related_items_for_cart) | **POST** /checkout/related_items | Related items
|
|
22
|
+
[**related_items_for_item**](CheckoutApi.md#related_items_for_item) | **POST** /checkout/relatedItems/{item_id} | Related items (specific item)
|
|
23
|
+
[**setup_browser_key**](CheckoutApi.md#setup_browser_key) | **PUT** /checkout/browser_key | Setup Browser Application
|
|
24
|
+
[**update_cart**](CheckoutApi.md#update_cart) | **PUT** /checkout/cart | Update cart
|
|
25
|
+
[**validate_cart**](CheckoutApi.md#validate_cart) | **POST** /checkout/cart/validate | Validate
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
# **city_state**
|
|
29
|
+
> CityStateZip city_state(cart)
|
|
30
|
+
|
|
31
|
+
City/State for Zip
|
|
32
|
+
|
|
33
|
+
Look up the city and state for the shipping zip code. Useful for building an auto complete for parts of the shipping address
|
|
34
|
+
|
|
35
|
+
### Example
|
|
36
|
+
```ruby
|
|
37
|
+
# load the gem
|
|
38
|
+
require 'ultracart_api'
|
|
39
|
+
# setup authorization
|
|
40
|
+
UltracartClient.configure do |config|
|
|
41
|
+
# Configure API key authorization: ultraCartBrowserApiKey
|
|
42
|
+
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
43
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
44
|
+
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
45
|
+
|
|
46
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
47
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
48
|
+
|
|
49
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
50
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
51
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
52
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
api_instance = UltracartClient::CheckoutApi.new
|
|
56
|
+
|
|
57
|
+
cart = UltracartClient::Cart.new # Cart | Cart
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
begin
|
|
61
|
+
#City/State for Zip
|
|
62
|
+
result = api_instance.city_state(cart)
|
|
63
|
+
p result
|
|
64
|
+
rescue UltracartClient::ApiError => e
|
|
65
|
+
puts "Exception when calling CheckoutApi->city_state: #{e}"
|
|
66
|
+
end
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### Parameters
|
|
70
|
+
|
|
71
|
+
Name | Type | Description | Notes
|
|
72
|
+
------------- | ------------- | ------------- | -------------
|
|
73
|
+
**cart** | [**Cart**](Cart.md)| Cart |
|
|
74
|
+
|
|
75
|
+
### Return type
|
|
76
|
+
|
|
77
|
+
[**CityStateZip**](CityStateZip.md)
|
|
78
|
+
|
|
79
|
+
### Authorization
|
|
80
|
+
|
|
81
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
82
|
+
|
|
83
|
+
### HTTP request headers
|
|
84
|
+
|
|
85
|
+
- **Content-Type**: application/json
|
|
86
|
+
- **Accept**: application/json
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
# **finalize_order**
|
|
91
|
+
> CartFinalizeOrderResponse finalize_order(finalize_request)
|
|
92
|
+
|
|
93
|
+
Finalize Order
|
|
94
|
+
|
|
95
|
+
Finalize the cart into an order. This method can not be called with browser key authentication. It is ONLY meant for server side code to call.
|
|
96
|
+
|
|
97
|
+
### Example
|
|
98
|
+
```ruby
|
|
99
|
+
# load the gem
|
|
100
|
+
require 'ultracart_api'
|
|
101
|
+
# setup authorization
|
|
102
|
+
UltracartClient.configure do |config|
|
|
103
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
104
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
105
|
+
|
|
106
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
107
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
108
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
109
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
110
|
+
end
|
|
111
|
+
|
|
112
|
+
api_instance = UltracartClient::CheckoutApi.new
|
|
113
|
+
|
|
114
|
+
finalize_request = UltracartClient::CartFinalizeOrderRequest.new # CartFinalizeOrderRequest | Finalize request
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
begin
|
|
118
|
+
#Finalize Order
|
|
119
|
+
result = api_instance.finalize_order(finalize_request)
|
|
120
|
+
p result
|
|
121
|
+
rescue UltracartClient::ApiError => e
|
|
122
|
+
puts "Exception when calling CheckoutApi->finalize_order: #{e}"
|
|
123
|
+
end
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
### Parameters
|
|
127
|
+
|
|
128
|
+
Name | Type | Description | Notes
|
|
129
|
+
------------- | ------------- | ------------- | -------------
|
|
130
|
+
**finalize_request** | [**CartFinalizeOrderRequest**](CartFinalizeOrderRequest.md)| Finalize request |
|
|
131
|
+
|
|
132
|
+
### Return type
|
|
133
|
+
|
|
134
|
+
[**CartFinalizeOrderResponse**](CartFinalizeOrderResponse.md)
|
|
135
|
+
|
|
136
|
+
### Authorization
|
|
137
|
+
|
|
138
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
139
|
+
|
|
140
|
+
### HTTP request headers
|
|
141
|
+
|
|
142
|
+
- **Content-Type**: application/json
|
|
143
|
+
- **Accept**: application/json
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
# **get_affirm_checkout**
|
|
148
|
+
> CartAffirmCheckoutResponse get_affirm_checkout(cart_id)
|
|
149
|
+
|
|
150
|
+
Get affirm checkout (by cart id)
|
|
151
|
+
|
|
152
|
+
Get a Affirm checkout object for the specified cart_id parameter.
|
|
153
|
+
|
|
154
|
+
### Example
|
|
155
|
+
```ruby
|
|
156
|
+
# load the gem
|
|
157
|
+
require 'ultracart_api'
|
|
158
|
+
# setup authorization
|
|
159
|
+
UltracartClient.configure do |config|
|
|
160
|
+
# Configure API key authorization: ultraCartBrowserApiKey
|
|
161
|
+
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
162
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
163
|
+
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
164
|
+
|
|
165
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
166
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
167
|
+
|
|
168
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
169
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
170
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
171
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
172
|
+
end
|
|
173
|
+
|
|
174
|
+
api_instance = UltracartClient::CheckoutApi.new
|
|
175
|
+
|
|
176
|
+
cart_id = 'cart_id_example' # String | Cart ID to retrieve
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
begin
|
|
180
|
+
#Get affirm checkout (by cart id)
|
|
181
|
+
result = api_instance.get_affirm_checkout(cart_id)
|
|
182
|
+
p result
|
|
183
|
+
rescue UltracartClient::ApiError => e
|
|
184
|
+
puts "Exception when calling CheckoutApi->get_affirm_checkout: #{e}"
|
|
185
|
+
end
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
### Parameters
|
|
189
|
+
|
|
190
|
+
Name | Type | Description | Notes
|
|
191
|
+
------------- | ------------- | ------------- | -------------
|
|
192
|
+
**cart_id** | **String**| Cart ID to retrieve |
|
|
193
|
+
|
|
194
|
+
### Return type
|
|
195
|
+
|
|
196
|
+
[**CartAffirmCheckoutResponse**](CartAffirmCheckoutResponse.md)
|
|
197
|
+
|
|
198
|
+
### Authorization
|
|
199
|
+
|
|
200
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
201
|
+
|
|
202
|
+
### HTTP request headers
|
|
203
|
+
|
|
204
|
+
- **Content-Type**: application/json
|
|
205
|
+
- **Accept**: application/json
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
# **get_allowed_countries**
|
|
210
|
+
> CheckoutAllowedCountriesResponse get_allowed_countries
|
|
211
|
+
|
|
212
|
+
Allowed countries
|
|
213
|
+
|
|
214
|
+
Lookup the allowed countries for this merchant id
|
|
215
|
+
|
|
216
|
+
### Example
|
|
217
|
+
```ruby
|
|
218
|
+
# load the gem
|
|
219
|
+
require 'ultracart_api'
|
|
220
|
+
# setup authorization
|
|
221
|
+
UltracartClient.configure do |config|
|
|
222
|
+
# Configure API key authorization: ultraCartBrowserApiKey
|
|
223
|
+
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
224
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
225
|
+
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
226
|
+
|
|
227
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
228
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
229
|
+
|
|
230
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
231
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
232
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
233
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
234
|
+
end
|
|
235
|
+
|
|
236
|
+
api_instance = UltracartClient::CheckoutApi.new
|
|
237
|
+
|
|
238
|
+
begin
|
|
239
|
+
#Allowed countries
|
|
240
|
+
result = api_instance.get_allowed_countries
|
|
241
|
+
p result
|
|
242
|
+
rescue UltracartClient::ApiError => e
|
|
243
|
+
puts "Exception when calling CheckoutApi->get_allowed_countries: #{e}"
|
|
244
|
+
end
|
|
245
|
+
```
|
|
246
|
+
|
|
247
|
+
### Parameters
|
|
248
|
+
This endpoint does not need any parameter.
|
|
249
|
+
|
|
250
|
+
### Return type
|
|
251
|
+
|
|
252
|
+
[**CheckoutAllowedCountriesResponse**](CheckoutAllowedCountriesResponse.md)
|
|
253
|
+
|
|
254
|
+
### Authorization
|
|
255
|
+
|
|
256
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
257
|
+
|
|
258
|
+
### HTTP request headers
|
|
259
|
+
|
|
260
|
+
- **Content-Type**: application/json
|
|
261
|
+
- **Accept**: application/json
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
# **get_cart**
|
|
266
|
+
> CartResponse get_cart(opts)
|
|
267
|
+
|
|
268
|
+
Get cart
|
|
269
|
+
|
|
270
|
+
If the cookie is set on the browser making the request then it will return their active cart. Otherwise it will create a new cart.
|
|
271
|
+
|
|
272
|
+
### Example
|
|
273
|
+
```ruby
|
|
274
|
+
# load the gem
|
|
275
|
+
require 'ultracart_api'
|
|
276
|
+
# setup authorization
|
|
277
|
+
UltracartClient.configure do |config|
|
|
278
|
+
# Configure API key authorization: ultraCartBrowserApiKey
|
|
279
|
+
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
280
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
281
|
+
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
282
|
+
|
|
283
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
284
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
285
|
+
|
|
286
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
287
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
288
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
289
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
290
|
+
end
|
|
291
|
+
|
|
292
|
+
api_instance = UltracartClient::CheckoutApi.new
|
|
293
|
+
|
|
294
|
+
opts = {
|
|
295
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
296
|
+
}
|
|
297
|
+
|
|
298
|
+
begin
|
|
299
|
+
#Get cart
|
|
300
|
+
result = api_instance.get_cart(opts)
|
|
301
|
+
p result
|
|
302
|
+
rescue UltracartClient::ApiError => e
|
|
303
|
+
puts "Exception when calling CheckoutApi->get_cart: #{e}"
|
|
304
|
+
end
|
|
305
|
+
```
|
|
306
|
+
|
|
307
|
+
### Parameters
|
|
308
|
+
|
|
309
|
+
Name | Type | Description | Notes
|
|
310
|
+
------------- | ------------- | ------------- | -------------
|
|
311
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
|
312
|
+
|
|
313
|
+
### Return type
|
|
314
|
+
|
|
315
|
+
[**CartResponse**](CartResponse.md)
|
|
316
|
+
|
|
317
|
+
### Authorization
|
|
318
|
+
|
|
319
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
320
|
+
|
|
321
|
+
### HTTP request headers
|
|
322
|
+
|
|
323
|
+
- **Content-Type**: application/json
|
|
324
|
+
- **Accept**: application/json
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
# **get_cart_by_cart_id**
|
|
329
|
+
> CartResponse get_cart_by_cart_id(cart_id, opts)
|
|
330
|
+
|
|
331
|
+
Get cart (by cart id)
|
|
332
|
+
|
|
333
|
+
Get a cart specified by the cart_id parameter.
|
|
334
|
+
|
|
335
|
+
### Example
|
|
336
|
+
```ruby
|
|
337
|
+
# load the gem
|
|
338
|
+
require 'ultracart_api'
|
|
339
|
+
# setup authorization
|
|
340
|
+
UltracartClient.configure do |config|
|
|
341
|
+
# Configure API key authorization: ultraCartBrowserApiKey
|
|
342
|
+
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
343
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
344
|
+
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
345
|
+
|
|
346
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
347
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
348
|
+
|
|
349
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
350
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
351
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
352
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
353
|
+
end
|
|
354
|
+
|
|
355
|
+
api_instance = UltracartClient::CheckoutApi.new
|
|
356
|
+
|
|
357
|
+
cart_id = 'cart_id_example' # String | Cart ID to retrieve
|
|
358
|
+
|
|
359
|
+
opts = {
|
|
360
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
361
|
+
}
|
|
362
|
+
|
|
363
|
+
begin
|
|
364
|
+
#Get cart (by cart id)
|
|
365
|
+
result = api_instance.get_cart_by_cart_id(cart_id, opts)
|
|
366
|
+
p result
|
|
367
|
+
rescue UltracartClient::ApiError => e
|
|
368
|
+
puts "Exception when calling CheckoutApi->get_cart_by_cart_id: #{e}"
|
|
369
|
+
end
|
|
370
|
+
```
|
|
371
|
+
|
|
372
|
+
### Parameters
|
|
373
|
+
|
|
374
|
+
Name | Type | Description | Notes
|
|
375
|
+
------------- | ------------- | ------------- | -------------
|
|
376
|
+
**cart_id** | **String**| Cart ID to retrieve |
|
|
377
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
|
378
|
+
|
|
379
|
+
### Return type
|
|
380
|
+
|
|
381
|
+
[**CartResponse**](CartResponse.md)
|
|
382
|
+
|
|
383
|
+
### Authorization
|
|
384
|
+
|
|
385
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
386
|
+
|
|
387
|
+
### HTTP request headers
|
|
388
|
+
|
|
389
|
+
- **Content-Type**: application/json
|
|
390
|
+
- **Accept**: application/json
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
# **get_cart_by_return_code**
|
|
395
|
+
> CartResponse get_cart_by_return_code(return_code, opts)
|
|
396
|
+
|
|
397
|
+
Get cart (by return code)
|
|
398
|
+
|
|
399
|
+
Get a cart specified by the return code parameter.
|
|
400
|
+
|
|
401
|
+
### Example
|
|
402
|
+
```ruby
|
|
403
|
+
# load the gem
|
|
404
|
+
require 'ultracart_api'
|
|
405
|
+
# setup authorization
|
|
406
|
+
UltracartClient.configure do |config|
|
|
407
|
+
# Configure API key authorization: ultraCartBrowserApiKey
|
|
408
|
+
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
409
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
410
|
+
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
411
|
+
|
|
412
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
413
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
414
|
+
|
|
415
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
416
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
417
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
418
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
419
|
+
end
|
|
420
|
+
|
|
421
|
+
api_instance = UltracartClient::CheckoutApi.new
|
|
422
|
+
|
|
423
|
+
return_code = 'return_code_example' # String | Return code to lookup cart ID by
|
|
424
|
+
|
|
425
|
+
opts = {
|
|
426
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
427
|
+
}
|
|
428
|
+
|
|
429
|
+
begin
|
|
430
|
+
#Get cart (by return code)
|
|
431
|
+
result = api_instance.get_cart_by_return_code(return_code, opts)
|
|
432
|
+
p result
|
|
433
|
+
rescue UltracartClient::ApiError => e
|
|
434
|
+
puts "Exception when calling CheckoutApi->get_cart_by_return_code: #{e}"
|
|
435
|
+
end
|
|
436
|
+
```
|
|
437
|
+
|
|
438
|
+
### Parameters
|
|
439
|
+
|
|
440
|
+
Name | Type | Description | Notes
|
|
441
|
+
------------- | ------------- | ------------- | -------------
|
|
442
|
+
**return_code** | **String**| Return code to lookup cart ID by |
|
|
443
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
|
444
|
+
|
|
445
|
+
### Return type
|
|
446
|
+
|
|
447
|
+
[**CartResponse**](CartResponse.md)
|
|
448
|
+
|
|
449
|
+
### Authorization
|
|
450
|
+
|
|
451
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
452
|
+
|
|
453
|
+
### HTTP request headers
|
|
454
|
+
|
|
455
|
+
- **Content-Type**: application/json
|
|
456
|
+
- **Accept**: application/json
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
# **get_cart_by_return_token**
|
|
461
|
+
> CartResponse get_cart_by_return_token(opts)
|
|
462
|
+
|
|
463
|
+
Get cart (by return token)
|
|
464
|
+
|
|
465
|
+
Get a cart specified by the encrypted return token parameter.
|
|
466
|
+
|
|
467
|
+
### Example
|
|
468
|
+
```ruby
|
|
469
|
+
# load the gem
|
|
470
|
+
require 'ultracart_api'
|
|
471
|
+
# setup authorization
|
|
472
|
+
UltracartClient.configure do |config|
|
|
473
|
+
# Configure API key authorization: ultraCartBrowserApiKey
|
|
474
|
+
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
475
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
476
|
+
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
477
|
+
|
|
478
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
479
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
480
|
+
|
|
481
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
482
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
483
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
484
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
485
|
+
end
|
|
486
|
+
|
|
487
|
+
api_instance = UltracartClient::CheckoutApi.new
|
|
488
|
+
|
|
489
|
+
opts = {
|
|
490
|
+
return_token: 'return_token_example', # String | Return token provided by StoreFront Communications
|
|
491
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
492
|
+
}
|
|
493
|
+
|
|
494
|
+
begin
|
|
495
|
+
#Get cart (by return token)
|
|
496
|
+
result = api_instance.get_cart_by_return_token(opts)
|
|
497
|
+
p result
|
|
498
|
+
rescue UltracartClient::ApiError => e
|
|
499
|
+
puts "Exception when calling CheckoutApi->get_cart_by_return_token: #{e}"
|
|
500
|
+
end
|
|
501
|
+
```
|
|
502
|
+
|
|
503
|
+
### Parameters
|
|
504
|
+
|
|
505
|
+
Name | Type | Description | Notes
|
|
506
|
+
------------- | ------------- | ------------- | -------------
|
|
507
|
+
**return_token** | **String**| Return token provided by StoreFront Communications | [optional]
|
|
508
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
|
509
|
+
|
|
510
|
+
### Return type
|
|
511
|
+
|
|
512
|
+
[**CartResponse**](CartResponse.md)
|
|
513
|
+
|
|
514
|
+
### Authorization
|
|
515
|
+
|
|
516
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
517
|
+
|
|
518
|
+
### HTTP request headers
|
|
519
|
+
|
|
520
|
+
- **Content-Type**: application/json
|
|
521
|
+
- **Accept**: application/json
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
# **get_state_provinces_for_country**
|
|
526
|
+
> CheckoutStateProvinceResponse get_state_provinces_for_country(country_code)
|
|
527
|
+
|
|
528
|
+
Get state/province list for a country code
|
|
529
|
+
|
|
530
|
+
Lookup a state/province list for a given country code
|
|
531
|
+
|
|
532
|
+
### Example
|
|
533
|
+
```ruby
|
|
534
|
+
# load the gem
|
|
535
|
+
require 'ultracart_api'
|
|
536
|
+
# setup authorization
|
|
537
|
+
UltracartClient.configure do |config|
|
|
538
|
+
# Configure API key authorization: ultraCartBrowserApiKey
|
|
539
|
+
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
540
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
541
|
+
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
542
|
+
|
|
543
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
544
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
545
|
+
|
|
546
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
547
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
548
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
549
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
550
|
+
end
|
|
551
|
+
|
|
552
|
+
api_instance = UltracartClient::CheckoutApi.new
|
|
553
|
+
|
|
554
|
+
country_code = 'country_code_example' # String | Two letter ISO country code
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
begin
|
|
558
|
+
#Get state/province list for a country code
|
|
559
|
+
result = api_instance.get_state_provinces_for_country(country_code)
|
|
560
|
+
p result
|
|
561
|
+
rescue UltracartClient::ApiError => e
|
|
562
|
+
puts "Exception when calling CheckoutApi->get_state_provinces_for_country: #{e}"
|
|
563
|
+
end
|
|
564
|
+
```
|
|
565
|
+
|
|
566
|
+
### Parameters
|
|
567
|
+
|
|
568
|
+
Name | Type | Description | Notes
|
|
569
|
+
------------- | ------------- | ------------- | -------------
|
|
570
|
+
**country_code** | **String**| Two letter ISO country code |
|
|
571
|
+
|
|
572
|
+
### Return type
|
|
573
|
+
|
|
574
|
+
[**CheckoutStateProvinceResponse**](CheckoutStateProvinceResponse.md)
|
|
575
|
+
|
|
576
|
+
### Authorization
|
|
577
|
+
|
|
578
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
579
|
+
|
|
580
|
+
### HTTP request headers
|
|
581
|
+
|
|
582
|
+
- **Content-Type**: application/json
|
|
583
|
+
- **Accept**: application/json
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
# **handoff_cart**
|
|
588
|
+
> CheckoutHandoffResponse handoff_cart(handoff_request, opts)
|
|
589
|
+
|
|
590
|
+
Handoff cart
|
|
591
|
+
|
|
592
|
+
Handoff the browser to UltraCart for view cart on StoreFront, transfer to PayPal, transfer to Affirm, transfer to Sezzle or finalization of the order (including upsell processing).
|
|
593
|
+
|
|
594
|
+
### Example
|
|
595
|
+
```ruby
|
|
596
|
+
# load the gem
|
|
597
|
+
require 'ultracart_api'
|
|
598
|
+
# setup authorization
|
|
599
|
+
UltracartClient.configure do |config|
|
|
600
|
+
# Configure API key authorization: ultraCartBrowserApiKey
|
|
601
|
+
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
602
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
603
|
+
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
604
|
+
|
|
605
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
606
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
607
|
+
|
|
608
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
609
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
610
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
611
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
612
|
+
end
|
|
613
|
+
|
|
614
|
+
api_instance = UltracartClient::CheckoutApi.new
|
|
615
|
+
|
|
616
|
+
handoff_request = UltracartClient::CheckoutHandoffRequest.new # CheckoutHandoffRequest | Handoff request
|
|
617
|
+
|
|
618
|
+
opts = {
|
|
619
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
620
|
+
}
|
|
621
|
+
|
|
622
|
+
begin
|
|
623
|
+
#Handoff cart
|
|
624
|
+
result = api_instance.handoff_cart(handoff_request, opts)
|
|
625
|
+
p result
|
|
626
|
+
rescue UltracartClient::ApiError => e
|
|
627
|
+
puts "Exception when calling CheckoutApi->handoff_cart: #{e}"
|
|
628
|
+
end
|
|
629
|
+
```
|
|
630
|
+
|
|
631
|
+
### Parameters
|
|
632
|
+
|
|
633
|
+
Name | Type | Description | Notes
|
|
634
|
+
------------- | ------------- | ------------- | -------------
|
|
635
|
+
**handoff_request** | [**CheckoutHandoffRequest**](CheckoutHandoffRequest.md)| Handoff request |
|
|
636
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
|
637
|
+
|
|
638
|
+
### Return type
|
|
639
|
+
|
|
640
|
+
[**CheckoutHandoffResponse**](CheckoutHandoffResponse.md)
|
|
641
|
+
|
|
642
|
+
### Authorization
|
|
643
|
+
|
|
644
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
645
|
+
|
|
646
|
+
### HTTP request headers
|
|
647
|
+
|
|
648
|
+
- **Content-Type**: application/json
|
|
649
|
+
- **Accept**: application/json
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
|
|
653
|
+
# **login**
|
|
654
|
+
> CartProfileLoginResponse login(login_request, opts)
|
|
655
|
+
|
|
656
|
+
Profile login
|
|
657
|
+
|
|
658
|
+
Login in to the customer profile specified by cart.billing.email and password
|
|
659
|
+
|
|
660
|
+
### Example
|
|
661
|
+
```ruby
|
|
662
|
+
# load the gem
|
|
663
|
+
require 'ultracart_api'
|
|
664
|
+
# setup authorization
|
|
665
|
+
UltracartClient.configure do |config|
|
|
666
|
+
# Configure API key authorization: ultraCartBrowserApiKey
|
|
667
|
+
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
668
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
669
|
+
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
670
|
+
|
|
671
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
672
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
673
|
+
|
|
674
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
675
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
676
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
677
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
678
|
+
end
|
|
679
|
+
|
|
680
|
+
api_instance = UltracartClient::CheckoutApi.new
|
|
681
|
+
|
|
682
|
+
login_request = UltracartClient::CartProfileLoginRequest.new # CartProfileLoginRequest | Login request
|
|
683
|
+
|
|
684
|
+
opts = {
|
|
685
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
686
|
+
}
|
|
687
|
+
|
|
688
|
+
begin
|
|
689
|
+
#Profile login
|
|
690
|
+
result = api_instance.login(login_request, opts)
|
|
691
|
+
p result
|
|
692
|
+
rescue UltracartClient::ApiError => e
|
|
693
|
+
puts "Exception when calling CheckoutApi->login: #{e}"
|
|
694
|
+
end
|
|
695
|
+
```
|
|
696
|
+
|
|
697
|
+
### Parameters
|
|
698
|
+
|
|
699
|
+
Name | Type | Description | Notes
|
|
700
|
+
------------- | ------------- | ------------- | -------------
|
|
701
|
+
**login_request** | [**CartProfileLoginRequest**](CartProfileLoginRequest.md)| Login request |
|
|
702
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
|
703
|
+
|
|
704
|
+
### Return type
|
|
705
|
+
|
|
706
|
+
[**CartProfileLoginResponse**](CartProfileLoginResponse.md)
|
|
707
|
+
|
|
708
|
+
### Authorization
|
|
709
|
+
|
|
710
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
711
|
+
|
|
712
|
+
### HTTP request headers
|
|
713
|
+
|
|
714
|
+
- **Content-Type**: application/json
|
|
715
|
+
- **Accept**: application/json
|
|
716
|
+
|
|
717
|
+
|
|
718
|
+
|
|
719
|
+
# **logout**
|
|
720
|
+
> CartResponse logout(cart, opts)
|
|
721
|
+
|
|
722
|
+
Profile logout
|
|
723
|
+
|
|
724
|
+
Log the cart out of the current profile. No error will occur if they are not logged in.
|
|
725
|
+
|
|
726
|
+
### Example
|
|
727
|
+
```ruby
|
|
728
|
+
# load the gem
|
|
729
|
+
require 'ultracart_api'
|
|
730
|
+
# setup authorization
|
|
731
|
+
UltracartClient.configure do |config|
|
|
732
|
+
# Configure API key authorization: ultraCartBrowserApiKey
|
|
733
|
+
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
734
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
735
|
+
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
736
|
+
|
|
737
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
738
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
739
|
+
|
|
740
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
741
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
742
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
743
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
744
|
+
end
|
|
745
|
+
|
|
746
|
+
api_instance = UltracartClient::CheckoutApi.new
|
|
747
|
+
|
|
748
|
+
cart = UltracartClient::Cart.new # Cart | Cart
|
|
749
|
+
|
|
750
|
+
opts = {
|
|
751
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
752
|
+
}
|
|
753
|
+
|
|
754
|
+
begin
|
|
755
|
+
#Profile logout
|
|
756
|
+
result = api_instance.logout(cart, opts)
|
|
757
|
+
p result
|
|
758
|
+
rescue UltracartClient::ApiError => e
|
|
759
|
+
puts "Exception when calling CheckoutApi->logout: #{e}"
|
|
760
|
+
end
|
|
761
|
+
```
|
|
762
|
+
|
|
763
|
+
### Parameters
|
|
764
|
+
|
|
765
|
+
Name | Type | Description | Notes
|
|
766
|
+
------------- | ------------- | ------------- | -------------
|
|
767
|
+
**cart** | [**Cart**](Cart.md)| Cart |
|
|
768
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
|
769
|
+
|
|
770
|
+
### Return type
|
|
771
|
+
|
|
772
|
+
[**CartResponse**](CartResponse.md)
|
|
773
|
+
|
|
774
|
+
### Authorization
|
|
775
|
+
|
|
776
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
777
|
+
|
|
778
|
+
### HTTP request headers
|
|
779
|
+
|
|
780
|
+
- **Content-Type**: application/json
|
|
781
|
+
- **Accept**: application/json
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
|
|
785
|
+
# **register**
|
|
786
|
+
> CartProfileRegisterResponse register(register_request, opts)
|
|
787
|
+
|
|
788
|
+
Profile registration
|
|
789
|
+
|
|
790
|
+
Register a new customer profile. Requires the cart.billing object to be populated along with the password.
|
|
791
|
+
|
|
792
|
+
### Example
|
|
793
|
+
```ruby
|
|
794
|
+
# load the gem
|
|
795
|
+
require 'ultracart_api'
|
|
796
|
+
# setup authorization
|
|
797
|
+
UltracartClient.configure do |config|
|
|
798
|
+
# Configure API key authorization: ultraCartBrowserApiKey
|
|
799
|
+
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
800
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
801
|
+
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
802
|
+
|
|
803
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
804
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
805
|
+
|
|
806
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
807
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
808
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
809
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
810
|
+
end
|
|
811
|
+
|
|
812
|
+
api_instance = UltracartClient::CheckoutApi.new
|
|
813
|
+
|
|
814
|
+
register_request = UltracartClient::CartProfileRegisterRequest.new # CartProfileRegisterRequest | Register request
|
|
815
|
+
|
|
816
|
+
opts = {
|
|
817
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
818
|
+
}
|
|
819
|
+
|
|
820
|
+
begin
|
|
821
|
+
#Profile registration
|
|
822
|
+
result = api_instance.register(register_request, opts)
|
|
823
|
+
p result
|
|
824
|
+
rescue UltracartClient::ApiError => e
|
|
825
|
+
puts "Exception when calling CheckoutApi->register: #{e}"
|
|
826
|
+
end
|
|
827
|
+
```
|
|
828
|
+
|
|
829
|
+
### Parameters
|
|
830
|
+
|
|
831
|
+
Name | Type | Description | Notes
|
|
832
|
+
------------- | ------------- | ------------- | -------------
|
|
833
|
+
**register_request** | [**CartProfileRegisterRequest**](CartProfileRegisterRequest.md)| Register request |
|
|
834
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
|
835
|
+
|
|
836
|
+
### Return type
|
|
837
|
+
|
|
838
|
+
[**CartProfileRegisterResponse**](CartProfileRegisterResponse.md)
|
|
839
|
+
|
|
840
|
+
### Authorization
|
|
841
|
+
|
|
842
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
843
|
+
|
|
844
|
+
### HTTP request headers
|
|
845
|
+
|
|
846
|
+
- **Content-Type**: application/json
|
|
847
|
+
- **Accept**: application/json
|
|
848
|
+
|
|
849
|
+
|
|
850
|
+
|
|
851
|
+
# **register_affiliate_click**
|
|
852
|
+
> RegisterAffiliateClickResponse register_affiliate_click(register_affiliate_click_request, opts)
|
|
853
|
+
|
|
854
|
+
Register affiliate click
|
|
855
|
+
|
|
856
|
+
Register an affiliate click. Used by custom checkouts that are completely API based and do not perform checkout handoff.
|
|
857
|
+
|
|
858
|
+
### Example
|
|
859
|
+
```ruby
|
|
860
|
+
# load the gem
|
|
861
|
+
require 'ultracart_api'
|
|
862
|
+
# setup authorization
|
|
863
|
+
UltracartClient.configure do |config|
|
|
864
|
+
# Configure API key authorization: ultraCartBrowserApiKey
|
|
865
|
+
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
866
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
867
|
+
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
868
|
+
|
|
869
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
870
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
871
|
+
|
|
872
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
873
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
874
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
875
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
876
|
+
end
|
|
877
|
+
|
|
878
|
+
api_instance = UltracartClient::CheckoutApi.new
|
|
879
|
+
|
|
880
|
+
register_affiliate_click_request = UltracartClient::RegisterAffiliateClickRequest.new # RegisterAffiliateClickRequest | Register affiliate click request
|
|
881
|
+
|
|
882
|
+
opts = {
|
|
883
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
884
|
+
}
|
|
885
|
+
|
|
886
|
+
begin
|
|
887
|
+
#Register affiliate click
|
|
888
|
+
result = api_instance.register_affiliate_click(register_affiliate_click_request, opts)
|
|
889
|
+
p result
|
|
890
|
+
rescue UltracartClient::ApiError => e
|
|
891
|
+
puts "Exception when calling CheckoutApi->register_affiliate_click: #{e}"
|
|
892
|
+
end
|
|
893
|
+
```
|
|
894
|
+
|
|
895
|
+
### Parameters
|
|
896
|
+
|
|
897
|
+
Name | Type | Description | Notes
|
|
898
|
+
------------- | ------------- | ------------- | -------------
|
|
899
|
+
**register_affiliate_click_request** | [**RegisterAffiliateClickRequest**](RegisterAffiliateClickRequest.md)| Register affiliate click request |
|
|
900
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
|
901
|
+
|
|
902
|
+
### Return type
|
|
903
|
+
|
|
904
|
+
[**RegisterAffiliateClickResponse**](RegisterAffiliateClickResponse.md)
|
|
905
|
+
|
|
906
|
+
### Authorization
|
|
907
|
+
|
|
908
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
909
|
+
|
|
910
|
+
### HTTP request headers
|
|
911
|
+
|
|
912
|
+
- **Content-Type**: application/json
|
|
913
|
+
- **Accept**: application/json
|
|
914
|
+
|
|
915
|
+
|
|
916
|
+
|
|
917
|
+
# **related_items_for_cart**
|
|
918
|
+
> ItemsResponse related_items_for_cart(cart, opts)
|
|
919
|
+
|
|
920
|
+
Related items
|
|
921
|
+
|
|
922
|
+
Retrieve all the related items for the cart contents. Expansion is limited to content, content.assignments, content.attributes, content.multimedia, content.multimedia.thumbnails, options, pricing, and pricing.tiers.
|
|
923
|
+
|
|
924
|
+
### Example
|
|
925
|
+
```ruby
|
|
926
|
+
# load the gem
|
|
927
|
+
require 'ultracart_api'
|
|
928
|
+
# setup authorization
|
|
929
|
+
UltracartClient.configure do |config|
|
|
930
|
+
# Configure API key authorization: ultraCartBrowserApiKey
|
|
931
|
+
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
932
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
933
|
+
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
934
|
+
|
|
935
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
936
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
937
|
+
|
|
938
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
939
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
940
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
941
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
942
|
+
end
|
|
943
|
+
|
|
944
|
+
api_instance = UltracartClient::CheckoutApi.new
|
|
945
|
+
|
|
946
|
+
cart = UltracartClient::Cart.new # Cart | Cart
|
|
947
|
+
|
|
948
|
+
opts = {
|
|
949
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See item resource documentation for examples
|
|
950
|
+
}
|
|
951
|
+
|
|
952
|
+
begin
|
|
953
|
+
#Related items
|
|
954
|
+
result = api_instance.related_items_for_cart(cart, opts)
|
|
955
|
+
p result
|
|
956
|
+
rescue UltracartClient::ApiError => e
|
|
957
|
+
puts "Exception when calling CheckoutApi->related_items_for_cart: #{e}"
|
|
958
|
+
end
|
|
959
|
+
```
|
|
960
|
+
|
|
961
|
+
### Parameters
|
|
962
|
+
|
|
963
|
+
Name | Type | Description | Notes
|
|
964
|
+
------------- | ------------- | ------------- | -------------
|
|
965
|
+
**cart** | [**Cart**](Cart.md)| Cart |
|
|
966
|
+
**_expand** | **String**| The object expansion to perform on the result. See item resource documentation for examples | [optional]
|
|
967
|
+
|
|
968
|
+
### Return type
|
|
969
|
+
|
|
970
|
+
[**ItemsResponse**](ItemsResponse.md)
|
|
971
|
+
|
|
972
|
+
### Authorization
|
|
973
|
+
|
|
974
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
975
|
+
|
|
976
|
+
### HTTP request headers
|
|
977
|
+
|
|
978
|
+
- **Content-Type**: application/json
|
|
979
|
+
- **Accept**: application/json
|
|
980
|
+
|
|
981
|
+
|
|
982
|
+
|
|
983
|
+
# **related_items_for_item**
|
|
984
|
+
> ItemsResponse related_items_for_item(item_id, cart, opts)
|
|
985
|
+
|
|
986
|
+
Related items (specific item)
|
|
987
|
+
|
|
988
|
+
Retrieve all the related items for the cart contents. Expansion is limited to content, content.assignments, content.attributes, content.multimedia, content.multimedia.thumbnails, options, pricing, and pricing.tiers.
|
|
989
|
+
|
|
990
|
+
### Example
|
|
991
|
+
```ruby
|
|
992
|
+
# load the gem
|
|
993
|
+
require 'ultracart_api'
|
|
994
|
+
# setup authorization
|
|
995
|
+
UltracartClient.configure do |config|
|
|
996
|
+
# Configure API key authorization: ultraCartBrowserApiKey
|
|
997
|
+
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
998
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
999
|
+
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
1000
|
+
|
|
1001
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
1002
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1003
|
+
|
|
1004
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
1005
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
1006
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1007
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
1008
|
+
end
|
|
1009
|
+
|
|
1010
|
+
api_instance = UltracartClient::CheckoutApi.new
|
|
1011
|
+
|
|
1012
|
+
item_id = 'item_id_example' # String | Item ID to retrieve related items for
|
|
1013
|
+
|
|
1014
|
+
cart = UltracartClient::Cart.new # Cart | Cart
|
|
1015
|
+
|
|
1016
|
+
opts = {
|
|
1017
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See item resource documentation for examples
|
|
1018
|
+
}
|
|
1019
|
+
|
|
1020
|
+
begin
|
|
1021
|
+
#Related items (specific item)
|
|
1022
|
+
result = api_instance.related_items_for_item(item_id, cart, opts)
|
|
1023
|
+
p result
|
|
1024
|
+
rescue UltracartClient::ApiError => e
|
|
1025
|
+
puts "Exception when calling CheckoutApi->related_items_for_item: #{e}"
|
|
1026
|
+
end
|
|
1027
|
+
```
|
|
1028
|
+
|
|
1029
|
+
### Parameters
|
|
1030
|
+
|
|
1031
|
+
Name | Type | Description | Notes
|
|
1032
|
+
------------- | ------------- | ------------- | -------------
|
|
1033
|
+
**item_id** | **String**| Item ID to retrieve related items for |
|
|
1034
|
+
**cart** | [**Cart**](Cart.md)| Cart |
|
|
1035
|
+
**_expand** | **String**| The object expansion to perform on the result. See item resource documentation for examples | [optional]
|
|
1036
|
+
|
|
1037
|
+
### Return type
|
|
1038
|
+
|
|
1039
|
+
[**ItemsResponse**](ItemsResponse.md)
|
|
1040
|
+
|
|
1041
|
+
### Authorization
|
|
1042
|
+
|
|
1043
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1044
|
+
|
|
1045
|
+
### HTTP request headers
|
|
1046
|
+
|
|
1047
|
+
- **Content-Type**: application/json
|
|
1048
|
+
- **Accept**: application/json
|
|
1049
|
+
|
|
1050
|
+
|
|
1051
|
+
|
|
1052
|
+
# **setup_browser_key**
|
|
1053
|
+
> CheckoutSetupBrowserKeyResponse setup_browser_key(browser_key_request)
|
|
1054
|
+
|
|
1055
|
+
Setup Browser Application
|
|
1056
|
+
|
|
1057
|
+
Setup a browser key authenticated application with checkout permissions. This REST call must be made with an authentication scheme that is not browser key. The new application will be linked to the application that makes this call. If this application is disabled / deleted, then so will the application setup by this call. The purpose of this call is to allow an OAuth applicaiton, such as the Wordpress plugin, to setup the proper browser based authentication for the REST checkout API to use.
|
|
1058
|
+
|
|
1059
|
+
### Example
|
|
1060
|
+
```ruby
|
|
1061
|
+
# load the gem
|
|
1062
|
+
require 'ultracart_api'
|
|
1063
|
+
# setup authorization
|
|
1064
|
+
UltracartClient.configure do |config|
|
|
1065
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
1066
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1067
|
+
|
|
1068
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
1069
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
1070
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1071
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
1072
|
+
end
|
|
1073
|
+
|
|
1074
|
+
api_instance = UltracartClient::CheckoutApi.new
|
|
1075
|
+
|
|
1076
|
+
browser_key_request = UltracartClient::CheckoutSetupBrowserKeyRequest.new # CheckoutSetupBrowserKeyRequest | Setup browser key request
|
|
1077
|
+
|
|
1078
|
+
|
|
1079
|
+
begin
|
|
1080
|
+
#Setup Browser Application
|
|
1081
|
+
result = api_instance.setup_browser_key(browser_key_request)
|
|
1082
|
+
p result
|
|
1083
|
+
rescue UltracartClient::ApiError => e
|
|
1084
|
+
puts "Exception when calling CheckoutApi->setup_browser_key: #{e}"
|
|
1085
|
+
end
|
|
1086
|
+
```
|
|
1087
|
+
|
|
1088
|
+
### Parameters
|
|
1089
|
+
|
|
1090
|
+
Name | Type | Description | Notes
|
|
1091
|
+
------------- | ------------- | ------------- | -------------
|
|
1092
|
+
**browser_key_request** | [**CheckoutSetupBrowserKeyRequest**](CheckoutSetupBrowserKeyRequest.md)| Setup browser key request |
|
|
1093
|
+
|
|
1094
|
+
### Return type
|
|
1095
|
+
|
|
1096
|
+
[**CheckoutSetupBrowserKeyResponse**](CheckoutSetupBrowserKeyResponse.md)
|
|
1097
|
+
|
|
1098
|
+
### Authorization
|
|
1099
|
+
|
|
1100
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1101
|
+
|
|
1102
|
+
### HTTP request headers
|
|
1103
|
+
|
|
1104
|
+
- **Content-Type**: application/json
|
|
1105
|
+
- **Accept**: application/json
|
|
1106
|
+
|
|
1107
|
+
|
|
1108
|
+
|
|
1109
|
+
# **update_cart**
|
|
1110
|
+
> CartResponse update_cart(cart, opts)
|
|
1111
|
+
|
|
1112
|
+
Update cart
|
|
1113
|
+
|
|
1114
|
+
Update the cart.
|
|
1115
|
+
|
|
1116
|
+
### Example
|
|
1117
|
+
```ruby
|
|
1118
|
+
# load the gem
|
|
1119
|
+
require 'ultracart_api'
|
|
1120
|
+
# setup authorization
|
|
1121
|
+
UltracartClient.configure do |config|
|
|
1122
|
+
# Configure API key authorization: ultraCartBrowserApiKey
|
|
1123
|
+
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
1124
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1125
|
+
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
1126
|
+
|
|
1127
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
1128
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1129
|
+
|
|
1130
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
1131
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
1132
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1133
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
1134
|
+
end
|
|
1135
|
+
|
|
1136
|
+
api_instance = UltracartClient::CheckoutApi.new
|
|
1137
|
+
|
|
1138
|
+
cart = UltracartClient::Cart.new # Cart | Cart
|
|
1139
|
+
|
|
1140
|
+
opts = {
|
|
1141
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
1142
|
+
}
|
|
1143
|
+
|
|
1144
|
+
begin
|
|
1145
|
+
#Update cart
|
|
1146
|
+
result = api_instance.update_cart(cart, opts)
|
|
1147
|
+
p result
|
|
1148
|
+
rescue UltracartClient::ApiError => e
|
|
1149
|
+
puts "Exception when calling CheckoutApi->update_cart: #{e}"
|
|
1150
|
+
end
|
|
1151
|
+
```
|
|
1152
|
+
|
|
1153
|
+
### Parameters
|
|
1154
|
+
|
|
1155
|
+
Name | Type | Description | Notes
|
|
1156
|
+
------------- | ------------- | ------------- | -------------
|
|
1157
|
+
**cart** | [**Cart**](Cart.md)| Cart |
|
|
1158
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
|
1159
|
+
|
|
1160
|
+
### Return type
|
|
1161
|
+
|
|
1162
|
+
[**CartResponse**](CartResponse.md)
|
|
1163
|
+
|
|
1164
|
+
### Authorization
|
|
1165
|
+
|
|
1166
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1167
|
+
|
|
1168
|
+
### HTTP request headers
|
|
1169
|
+
|
|
1170
|
+
- **Content-Type**: application/json
|
|
1171
|
+
- **Accept**: application/json
|
|
1172
|
+
|
|
1173
|
+
|
|
1174
|
+
|
|
1175
|
+
# **validate_cart**
|
|
1176
|
+
> CartValidationResponse validate_cart(validation_request, opts)
|
|
1177
|
+
|
|
1178
|
+
Validate
|
|
1179
|
+
|
|
1180
|
+
Validate the cart for errors. Specific checks can be passed and multiple validations can occur throughout your checkout flow.
|
|
1181
|
+
|
|
1182
|
+
### Example
|
|
1183
|
+
```ruby
|
|
1184
|
+
# load the gem
|
|
1185
|
+
require 'ultracart_api'
|
|
1186
|
+
# setup authorization
|
|
1187
|
+
UltracartClient.configure do |config|
|
|
1188
|
+
# Configure API key authorization: ultraCartBrowserApiKey
|
|
1189
|
+
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
1190
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1191
|
+
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
1192
|
+
|
|
1193
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
1194
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1195
|
+
|
|
1196
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
1197
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
1198
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1199
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
1200
|
+
end
|
|
1201
|
+
|
|
1202
|
+
api_instance = UltracartClient::CheckoutApi.new
|
|
1203
|
+
|
|
1204
|
+
validation_request = UltracartClient::CartValidationRequest.new # CartValidationRequest | Validation request
|
|
1205
|
+
|
|
1206
|
+
opts = {
|
|
1207
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
1208
|
+
}
|
|
1209
|
+
|
|
1210
|
+
begin
|
|
1211
|
+
#Validate
|
|
1212
|
+
result = api_instance.validate_cart(validation_request, opts)
|
|
1213
|
+
p result
|
|
1214
|
+
rescue UltracartClient::ApiError => e
|
|
1215
|
+
puts "Exception when calling CheckoutApi->validate_cart: #{e}"
|
|
1216
|
+
end
|
|
1217
|
+
```
|
|
1218
|
+
|
|
1219
|
+
### Parameters
|
|
1220
|
+
|
|
1221
|
+
Name | Type | Description | Notes
|
|
1222
|
+
------------- | ------------- | ------------- | -------------
|
|
1223
|
+
**validation_request** | [**CartValidationRequest**](CartValidationRequest.md)| Validation request |
|
|
1224
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
|
1225
|
+
|
|
1226
|
+
### Return type
|
|
1227
|
+
|
|
1228
|
+
[**CartValidationResponse**](CartValidationResponse.md)
|
|
1229
|
+
|
|
1230
|
+
### Authorization
|
|
1231
|
+
|
|
1232
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1233
|
+
|
|
1234
|
+
### HTTP request headers
|
|
1235
|
+
|
|
1236
|
+
- **Content-Type**: application/json
|
|
1237
|
+
- **Accept**: application/json
|
|
1238
|
+
|
|
1239
|
+
|
|
1240
|
+
|