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
data/docs/CouponQuery.md
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# UltracartClient::CouponQuery
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**affiliate_oid** | **Integer** | Affiliate oid | [optional]
|
|
7
|
+
**coupon_type** | **String** | The type of coupon. | [optional]
|
|
8
|
+
**description** | **String** | Description of this coupon | [optional]
|
|
9
|
+
**exclude_expired** | **BOOLEAN** | Exclude expired coupons if true | [optional]
|
|
10
|
+
**expiration_dts_begin** | **String** | Expiration date begin | [optional]
|
|
11
|
+
**expiration_dts_end** | **String** | Expiration date begin | [optional]
|
|
12
|
+
**merchant_code** | **String** | Merchant code is a unique character string for this coupon. | [optional]
|
|
13
|
+
**start_dts_begin** | **String** | Start date begin | [optional]
|
|
14
|
+
**start_dts_end** | **String** | Start date end | [optional]
|
|
15
|
+
|
|
16
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# UltracartClient::CouponResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**coupon** | [**Coupon**](Coupon.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,11 @@
|
|
|
1
|
+
# UltracartClient::CouponRestriction
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**invalid_for_this** | **BOOLEAN** | | [optional]
|
|
7
|
+
**name** | **String** | | [optional]
|
|
8
|
+
**valid_for_this** | **BOOLEAN** | | [optional]
|
|
9
|
+
**valid_only_for_this** | **BOOLEAN** | | [optional]
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# UltracartClient::CouponTierAmount
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**discount_amount** | **Float** | The amount of subtotal discount | [optional]
|
|
7
|
+
**subtotal_amount** | **Float** | The amount of subtotal required to receive the discount amount | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# UltracartClient::CouponTierItemDiscount
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**discount_amount** | **Float** | The amount of subtotal discount | [optional]
|
|
7
|
+
**items** | **Array<String>** | A list of items which will receive this discount. | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# UltracartClient::CouponTierPercent
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**discount_percent** | **Float** | The percent of subtotal discount | [optional]
|
|
7
|
+
**subtotal_amount** | **Float** | The amount of subtotal required to receive the discount percent | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# UltracartClient::CouponTierQuantityAmount
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**discount_amount** | **Float** | The amount of discount per item. | [optional]
|
|
7
|
+
**item_quantity** | **Integer** | The quantity of item purchased (in units) | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# UltracartClient::CouponTierQuantityPercent
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**discount_percent** | **Float** | The percent of discount per item. | [optional]
|
|
7
|
+
**item_quantity** | **Integer** | The quantity of item purchased (in units) | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# UltracartClient::CouponTieredAmountOffItem
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**item** | **String** | The item being discounted by this coupon. | [optional]
|
|
7
|
+
**limit** | **Float** | The maximum amount of total discount by this coupon. | [optional]
|
|
8
|
+
**tiers** | [**Array<CouponTierQuantityAmount>**](CouponTierQuantityAmount.md) | A list of discount tiers. | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# UltracartClient::CouponTieredAmountOffSubtotal
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**items** | **Array<String>** | An optional list of items of which a quantity of one or many must be purchased for coupon to be valid. If empty, all items apply toward subtotal amount. | [optional]
|
|
7
|
+
**tiers** | [**Array<CouponTierAmount>**](CouponTierAmount.md) | A list of discount tiers. | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# UltracartClient::CouponTieredPercentOffItems
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**items** | **Array<String>** | A list of items of which at least one must be purchased for coupon to be valid. | [optional]
|
|
7
|
+
**limit** | **Float** | The maximum amount of total discount by this coupon. | [optional]
|
|
8
|
+
**tiers** | [**Array<CouponTierQuantityPercent>**](CouponTierQuantityPercent.md) | A list of discount tiers. | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# UltracartClient::CouponTieredPercentOffShipping
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**shipping_methods** | **Array<String>** | One or more shipping methods that may receive this discount | [optional]
|
|
7
|
+
**tiers** | [**Array<CouponTierPercent>**](CouponTierPercent.md) | A list of discount tiers. | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# UltracartClient::CouponTieredPercentOffSubtotal
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**items** | **Array<String>** | An optional list of items of which a quantity of one or many must be purchased for coupon to be valid. If empty, all items apply toward subtotal amount. | [optional]
|
|
7
|
+
**tiers** | [**Array<CouponTierPercent>**](CouponTierPercent.md) | A list of discount tiers. | [optional]
|
|
8
|
+
|
|
9
|
+
|
data/docs/CouponType.md
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# UltracartClient::CouponType
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**localized** | **String** | A friendly display of the coupon type suitable for human reading | [optional]
|
|
7
|
+
**name** | **String** | The name of the coupon type | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# UltracartClient::CouponsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**coupons** | [**Array<Coupon>**](Coupon.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/Currency.md
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# UltracartClient::Currency
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**currency_code** | **String** | Currency code of the localized value | [optional]
|
|
7
|
+
**exchange_rate** | **Float** | Exchange rate used to localize | [optional]
|
|
8
|
+
**localized** | **Float** | Value localized to the customer | [optional]
|
|
9
|
+
**localized_formatted** | **String** | Value localized and formatted for the customer | [optional]
|
|
10
|
+
**value** | **Float** | Value in base currency | [optional]
|
|
11
|
+
|
|
12
|
+
|
data/docs/Customer.md
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# UltracartClient::Customer
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**activity** | [**CustomerActivity**](CustomerActivity.md) | | [optional]
|
|
7
|
+
**affiliate_oid** | **Integer** | Affiliate oid | [optional]
|
|
8
|
+
**allow_3rd_party_billing** | **BOOLEAN** | Allow 3rd party billing | [optional]
|
|
9
|
+
**allow_cod** | **BOOLEAN** | Allow COD | [optional]
|
|
10
|
+
**allow_purchase_order** | **BOOLEAN** | Allow purchase orders by this customer | [optional]
|
|
11
|
+
**allow_quote_request** | **BOOLEAN** | Allow quote request | [optional]
|
|
12
|
+
**allow_selection_of_address_type** | **BOOLEAN** | Allow selection of residential or business address type | [optional]
|
|
13
|
+
**attachments** | [**Array<CustomerAttachment>**](CustomerAttachment.md) | Attachments | [optional]
|
|
14
|
+
**auto_approve_cod** | **BOOLEAN** | Auto approve COD | [optional]
|
|
15
|
+
**auto_approve_purchase_order** | **BOOLEAN** | Auto approve purchase orders by this customer | [optional]
|
|
16
|
+
**automatic_merchant_notes** | **String** | Automatic merchant notes are added to every order placed | [optional]
|
|
17
|
+
**billing** | [**Array<CustomerBilling>**](CustomerBilling.md) | Billing addresses for this customer | [optional]
|
|
18
|
+
**business_notes** | **String** | Business notes (internally visible only) | [optional]
|
|
19
|
+
**cards** | [**Array<CustomerCard>**](CustomerCard.md) | Credit Cards for this customer | [optional]
|
|
20
|
+
**cc_emails** | [**Array<CustomerEmail>**](CustomerEmail.md) | Additional emails to CC notification | [optional]
|
|
21
|
+
**customer_profile_oid** | **Integer** | Customer profile object identifier | [optional]
|
|
22
|
+
**dhl_account_number** | **String** | DHL account number | [optional]
|
|
23
|
+
**dhl_duty_account_number** | **String** | DHL duty account number | [optional]
|
|
24
|
+
**email** | **String** | Email address of this customer profile | [optional]
|
|
25
|
+
**exempt_shipping_handling_charge** | **BOOLEAN** | Exempt shipping handling charge | [optional]
|
|
26
|
+
**fedex_account_number** | **String** | FedEx account number | [optional]
|
|
27
|
+
**free_shipping** | **BOOLEAN** | This customer always receives free shipping | [optional]
|
|
28
|
+
**free_shipping_minimum** | **Float** | If free_shipping is true, this is the minimum subtotal required for free shipping | [optional]
|
|
29
|
+
**last_modified_by** | **String** | Last modified by | [optional]
|
|
30
|
+
**last_modified_dts** | **String** | Last modified date | [optional]
|
|
31
|
+
**loyalty** | [**CustomerLoyalty**](CustomerLoyalty.md) | | [optional]
|
|
32
|
+
**maximum_item_count** | **Integer** | Maximum item count | [optional]
|
|
33
|
+
**minimum_item_count** | **Integer** | Minimum item count | [optional]
|
|
34
|
+
**minimum_subtotal** | **Float** | Minimum subtotal | [optional]
|
|
35
|
+
**no_coupons** | **BOOLEAN** | No coupons | [optional]
|
|
36
|
+
**no_free_shipping** | **BOOLEAN** | No free shipping regardless of coupons or item level settings | [optional]
|
|
37
|
+
**no_realtime_charge** | **BOOLEAN** | No realtime charge | [optional]
|
|
38
|
+
**orders** | [**Array<Order>**](Order.md) | Orders associated with this customer profile | [optional]
|
|
39
|
+
**orders_summary** | [**CustomerOrdersSummary**](CustomerOrdersSummary.md) | | [optional]
|
|
40
|
+
**password** | **String** | Password (may only be set, never read) | [optional]
|
|
41
|
+
**pricing_tiers** | [**Array<CustomerPricingTier>**](CustomerPricingTier.md) | Pricing tiers for this customer | [optional]
|
|
42
|
+
**privacy** | [**CustomerPrivacy**](CustomerPrivacy.md) | | [optional]
|
|
43
|
+
**qb_class** | **String** | QuickBooks class to import this customer as | [optional]
|
|
44
|
+
**qb_code** | **String** | QuickBooks name to import this customer as | [optional]
|
|
45
|
+
**quotes** | [**Array<Order>**](Order.md) | Quotes associated with this customer profile | [optional]
|
|
46
|
+
**quotes_summary** | [**CustomerQuotesSummary**](CustomerQuotesSummary.md) | | [optional]
|
|
47
|
+
**referral_source** | **String** | Referral Source | [optional]
|
|
48
|
+
**reviewer** | [**CustomerReviewer**](CustomerReviewer.md) | | [optional]
|
|
49
|
+
**sales_rep_code** | **String** | Sales rep code | [optional]
|
|
50
|
+
**send_signup_notification** | **BOOLEAN** | Send signup notification, if true during customer creation, will send a notification. | [optional]
|
|
51
|
+
**shipping** | [**Array<CustomerShipping>**](CustomerShipping.md) | Shipping addresses for this customer | [optional]
|
|
52
|
+
**signup_dts** | **String** | Signup date | [optional]
|
|
53
|
+
**software_entitlements** | [**Array<CustomerSoftwareEntitlement>**](CustomerSoftwareEntitlement.md) | Software entitlements owned by this customer | [optional]
|
|
54
|
+
**suppress_buysafe** | **BOOLEAN** | Suppress buySAFE (deprecated) | [optional]
|
|
55
|
+
**tags** | [**Array<CustomerTag>**](CustomerTag.md) | Tags for this customer | [optional]
|
|
56
|
+
**tax_codes** | [**CustomerTaxCodes**](CustomerTaxCodes.md) | | [optional]
|
|
57
|
+
**tax_exempt** | **BOOLEAN** | True if the customer is tax exempt | [optional]
|
|
58
|
+
**tax_id** | **String** | Tax ID | [optional]
|
|
59
|
+
**terms** | **String** | Terms for this customer | [optional]
|
|
60
|
+
**track_separately** | **BOOLEAN** | True if the customer should be tracked separately in QuickBooks | [optional]
|
|
61
|
+
**unapproved** | **BOOLEAN** | Unapproved | [optional]
|
|
62
|
+
**ups_account_number** | **String** | UPS account number | [optional]
|
|
63
|
+
**website_url** | **String** | Website url | [optional]
|
|
64
|
+
|
|
65
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# UltracartClient::CustomerActivity
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**activities** | [**Array<Activity>**](Activity.md) | | [optional]
|
|
7
|
+
**memberships** | [**Array<ListSegmentMembership>**](ListSegmentMembership.md) | | [optional]
|
|
8
|
+
**metrics** | [**Array<Metric>**](Metric.md) | | [optional]
|
|
9
|
+
**properties_list** | [**Array<Property>**](Property.md) | | [optional]
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# UltracartClient::CustomerAffiliate
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**affiliate_oid** | **Integer** | Affiliate object identifier | [optional]
|
|
7
|
+
**email** | **String** | email | [optional]
|
|
8
|
+
|
|
9
|
+
|
data/docs/CustomerApi.md
ADDED
|
@@ -0,0 +1,670 @@
|
|
|
1
|
+
# UltracartClient::CustomerApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**delete_customer**](CustomerApi.md#delete_customer) | **DELETE** /customer/customers/{customer_profile_oid} | Delete a customer
|
|
8
|
+
[**get_customer**](CustomerApi.md#get_customer) | **GET** /customer/customers/{customer_profile_oid} | Retrieve a customer
|
|
9
|
+
[**get_customers**](CustomerApi.md#get_customers) | **GET** /customer/customers | Retrieve customers
|
|
10
|
+
[**get_customers_by_query**](CustomerApi.md#get_customers_by_query) | **POST** /customer/customers/query | Retrieve customers by query
|
|
11
|
+
[**get_customers_for_data_tables**](CustomerApi.md#get_customers_for_data_tables) | **POST** /customer/customers/dataTables | Retrieve customers for DataTables plugin
|
|
12
|
+
[**get_editor_values**](CustomerApi.md#get_editor_values) | **GET** /customer/editor_values | Retrieve values needed for a customer profile editor
|
|
13
|
+
[**get_email_lists**](CustomerApi.md#get_email_lists) | **GET** /customer/email_lists | Retrieve all email lists across all storefronts
|
|
14
|
+
[**insert_customer**](CustomerApi.md#insert_customer) | **POST** /customer/customers | Insert a customer
|
|
15
|
+
[**update_customer**](CustomerApi.md#update_customer) | **PUT** /customer/customers/{customer_profile_oid} | Update a customer
|
|
16
|
+
[**update_customer_email_lists**](CustomerApi.md#update_customer_email_lists) | **POST** /customer/customers/{customer_profile_oid}/email_lists | Update email list subscriptions for a customer
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
# **delete_customer**
|
|
20
|
+
> CustomerResponse delete_customer(customer_profile_oid)
|
|
21
|
+
|
|
22
|
+
Delete a customer
|
|
23
|
+
|
|
24
|
+
Delete a customer on the UltraCart account.
|
|
25
|
+
|
|
26
|
+
### Example
|
|
27
|
+
```ruby
|
|
28
|
+
# load the gem
|
|
29
|
+
require 'ultracart_api'
|
|
30
|
+
# setup authorization
|
|
31
|
+
UltracartClient.configure do |config|
|
|
32
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
33
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
34
|
+
|
|
35
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
36
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
37
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
38
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
api_instance = UltracartClient::CustomerApi.new
|
|
42
|
+
|
|
43
|
+
customer_profile_oid = 56 # Integer | The customer_profile_oid to delete.
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
begin
|
|
47
|
+
#Delete a customer
|
|
48
|
+
result = api_instance.delete_customer(customer_profile_oid)
|
|
49
|
+
p result
|
|
50
|
+
rescue UltracartClient::ApiError => e
|
|
51
|
+
puts "Exception when calling CustomerApi->delete_customer: #{e}"
|
|
52
|
+
end
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### Parameters
|
|
56
|
+
|
|
57
|
+
Name | Type | Description | Notes
|
|
58
|
+
------------- | ------------- | ------------- | -------------
|
|
59
|
+
**customer_profile_oid** | **Integer**| The customer_profile_oid to delete. |
|
|
60
|
+
|
|
61
|
+
### Return type
|
|
62
|
+
|
|
63
|
+
[**CustomerResponse**](CustomerResponse.md)
|
|
64
|
+
|
|
65
|
+
### Authorization
|
|
66
|
+
|
|
67
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
68
|
+
|
|
69
|
+
### HTTP request headers
|
|
70
|
+
|
|
71
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
72
|
+
- **Accept**: application/json
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
# **get_customer**
|
|
77
|
+
> CustomerResponse get_customer(customer_profile_oid, opts)
|
|
78
|
+
|
|
79
|
+
Retrieve a customer
|
|
80
|
+
|
|
81
|
+
Retrieves a single customer using the specified customer profile oid.
|
|
82
|
+
|
|
83
|
+
### Example
|
|
84
|
+
```ruby
|
|
85
|
+
# load the gem
|
|
86
|
+
require 'ultracart_api'
|
|
87
|
+
# setup authorization
|
|
88
|
+
UltracartClient.configure do |config|
|
|
89
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
90
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
91
|
+
|
|
92
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
93
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
94
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
95
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
96
|
+
end
|
|
97
|
+
|
|
98
|
+
api_instance = UltracartClient::CustomerApi.new
|
|
99
|
+
|
|
100
|
+
customer_profile_oid = 56 # Integer | The customer oid to retrieve.
|
|
101
|
+
|
|
102
|
+
opts = {
|
|
103
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
begin
|
|
107
|
+
#Retrieve a customer
|
|
108
|
+
result = api_instance.get_customer(customer_profile_oid, opts)
|
|
109
|
+
p result
|
|
110
|
+
rescue UltracartClient::ApiError => e
|
|
111
|
+
puts "Exception when calling CustomerApi->get_customer: #{e}"
|
|
112
|
+
end
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
### Parameters
|
|
116
|
+
|
|
117
|
+
Name | Type | Description | Notes
|
|
118
|
+
------------- | ------------- | ------------- | -------------
|
|
119
|
+
**customer_profile_oid** | **Integer**| The customer oid to retrieve. |
|
|
120
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
|
121
|
+
|
|
122
|
+
### Return type
|
|
123
|
+
|
|
124
|
+
[**CustomerResponse**](CustomerResponse.md)
|
|
125
|
+
|
|
126
|
+
### Authorization
|
|
127
|
+
|
|
128
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
129
|
+
|
|
130
|
+
### HTTP request headers
|
|
131
|
+
|
|
132
|
+
- **Content-Type**: application/json
|
|
133
|
+
- **Accept**: application/json
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
# **get_customers**
|
|
138
|
+
> CustomersResponse get_customers(opts)
|
|
139
|
+
|
|
140
|
+
Retrieve customers
|
|
141
|
+
|
|
142
|
+
Retrieves customers from the account. If no parameters are specified, all customers will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
|
143
|
+
|
|
144
|
+
### Example
|
|
145
|
+
```ruby
|
|
146
|
+
# load the gem
|
|
147
|
+
require 'ultracart_api'
|
|
148
|
+
# setup authorization
|
|
149
|
+
UltracartClient.configure do |config|
|
|
150
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
151
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
152
|
+
|
|
153
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
154
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
155
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
156
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
157
|
+
end
|
|
158
|
+
|
|
159
|
+
api_instance = UltracartClient::CustomerApi.new
|
|
160
|
+
|
|
161
|
+
opts = {
|
|
162
|
+
email: 'email_example', # String | Email
|
|
163
|
+
qb_class: 'qb_class_example', # String | Quickbooks class
|
|
164
|
+
quickbooks_code: 'quickbooks_code_example', # String | Quickbooks code
|
|
165
|
+
last_modified_dts_start: 'last_modified_dts_start_example', # String | Last modified date start
|
|
166
|
+
last_modified_dts_end: 'last_modified_dts_end_example', # String | Last modified date end
|
|
167
|
+
signup_dts_start: 'signup_dts_start_example', # String | Signup date start
|
|
168
|
+
signup_dts_end: 'signup_dts_end_example', # String | Signup date end
|
|
169
|
+
billing_first_name: 'billing_first_name_example', # String | Billing first name
|
|
170
|
+
billing_last_name: 'billing_last_name_example', # String | Billing last name
|
|
171
|
+
billing_company: 'billing_company_example', # String | Billing company
|
|
172
|
+
billing_city: 'billing_city_example', # String | Billing city
|
|
173
|
+
billing_state: 'billing_state_example', # String | Billing state
|
|
174
|
+
billing_postal_code: 'billing_postal_code_example', # String | Billing postal code
|
|
175
|
+
billing_country_code: 'billing_country_code_example', # String | Billing country code
|
|
176
|
+
billing_day_phone: 'billing_day_phone_example', # String | Billing day phone
|
|
177
|
+
billing_evening_phone: 'billing_evening_phone_example', # String | Billing evening phone
|
|
178
|
+
shipping_first_name: 'shipping_first_name_example', # String | Shipping first name
|
|
179
|
+
shipping_last_name: 'shipping_last_name_example', # String | Shipping last name
|
|
180
|
+
shipping_company: 'shipping_company_example', # String | Shipping company
|
|
181
|
+
shipping_city: 'shipping_city_example', # String | Shipping city
|
|
182
|
+
shipping_state: 'shipping_state_example', # String | Shipping state
|
|
183
|
+
shipping_postal_code: 'shipping_postal_code_example', # String | Shipping postal code
|
|
184
|
+
shipping_country_code: 'shipping_country_code_example', # String | Shipping country code
|
|
185
|
+
shipping_day_phone: 'shipping_day_phone_example', # String | Shipping day phone
|
|
186
|
+
shipping_evening_phone: 'shipping_evening_phone_example', # String | Shipping evening phone
|
|
187
|
+
pricing_tier_oid: 56, # Integer | Pricing tier oid
|
|
188
|
+
pricing_tier_name: 'pricing_tier_name_example', # String | Pricing tier name
|
|
189
|
+
_limit: 100, # Integer | The maximum number of records to return on this one API call. (Max 200)
|
|
190
|
+
_offset: 0, # Integer | Pagination of the record set. Offset is a zero based index.
|
|
191
|
+
_since: '_since_example', # String | Fetch customers that have been created/modified since this date/time.
|
|
192
|
+
_sort: '_sort_example', # String | The sort order of the customers. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
|
193
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
194
|
+
}
|
|
195
|
+
|
|
196
|
+
begin
|
|
197
|
+
#Retrieve customers
|
|
198
|
+
result = api_instance.get_customers(opts)
|
|
199
|
+
p result
|
|
200
|
+
rescue UltracartClient::ApiError => e
|
|
201
|
+
puts "Exception when calling CustomerApi->get_customers: #{e}"
|
|
202
|
+
end
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
### Parameters
|
|
206
|
+
|
|
207
|
+
Name | Type | Description | Notes
|
|
208
|
+
------------- | ------------- | ------------- | -------------
|
|
209
|
+
**email** | **String**| Email | [optional]
|
|
210
|
+
**qb_class** | **String**| Quickbooks class | [optional]
|
|
211
|
+
**quickbooks_code** | **String**| Quickbooks code | [optional]
|
|
212
|
+
**last_modified_dts_start** | **String**| Last modified date start | [optional]
|
|
213
|
+
**last_modified_dts_end** | **String**| Last modified date end | [optional]
|
|
214
|
+
**signup_dts_start** | **String**| Signup date start | [optional]
|
|
215
|
+
**signup_dts_end** | **String**| Signup date end | [optional]
|
|
216
|
+
**billing_first_name** | **String**| Billing first name | [optional]
|
|
217
|
+
**billing_last_name** | **String**| Billing last name | [optional]
|
|
218
|
+
**billing_company** | **String**| Billing company | [optional]
|
|
219
|
+
**billing_city** | **String**| Billing city | [optional]
|
|
220
|
+
**billing_state** | **String**| Billing state | [optional]
|
|
221
|
+
**billing_postal_code** | **String**| Billing postal code | [optional]
|
|
222
|
+
**billing_country_code** | **String**| Billing country code | [optional]
|
|
223
|
+
**billing_day_phone** | **String**| Billing day phone | [optional]
|
|
224
|
+
**billing_evening_phone** | **String**| Billing evening phone | [optional]
|
|
225
|
+
**shipping_first_name** | **String**| Shipping first name | [optional]
|
|
226
|
+
**shipping_last_name** | **String**| Shipping last name | [optional]
|
|
227
|
+
**shipping_company** | **String**| Shipping company | [optional]
|
|
228
|
+
**shipping_city** | **String**| Shipping city | [optional]
|
|
229
|
+
**shipping_state** | **String**| Shipping state | [optional]
|
|
230
|
+
**shipping_postal_code** | **String**| Shipping postal code | [optional]
|
|
231
|
+
**shipping_country_code** | **String**| Shipping country code | [optional]
|
|
232
|
+
**shipping_day_phone** | **String**| Shipping day phone | [optional]
|
|
233
|
+
**shipping_evening_phone** | **String**| Shipping evening phone | [optional]
|
|
234
|
+
**pricing_tier_oid** | **Integer**| Pricing tier oid | [optional]
|
|
235
|
+
**pricing_tier_name** | **String**| Pricing tier name | [optional]
|
|
236
|
+
**_limit** | **Integer**| The maximum number of records to return on this one API call. (Max 200) | [optional] [default to 100]
|
|
237
|
+
**_offset** | **Integer**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
|
|
238
|
+
**_since** | **String**| Fetch customers that have been created/modified since this date/time. | [optional]
|
|
239
|
+
**_sort** | **String**| The sort order of the customers. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional]
|
|
240
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
|
241
|
+
|
|
242
|
+
### Return type
|
|
243
|
+
|
|
244
|
+
[**CustomersResponse**](CustomersResponse.md)
|
|
245
|
+
|
|
246
|
+
### Authorization
|
|
247
|
+
|
|
248
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
249
|
+
|
|
250
|
+
### HTTP request headers
|
|
251
|
+
|
|
252
|
+
- **Content-Type**: application/json
|
|
253
|
+
- **Accept**: application/json
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
# **get_customers_by_query**
|
|
258
|
+
> CustomersResponse get_customers_by_query(customer_query, opts)
|
|
259
|
+
|
|
260
|
+
Retrieve customers by query
|
|
261
|
+
|
|
262
|
+
Retrieves customers from the account. If no parameters are specified, all customers will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
|
263
|
+
|
|
264
|
+
### Example
|
|
265
|
+
```ruby
|
|
266
|
+
# load the gem
|
|
267
|
+
require 'ultracart_api'
|
|
268
|
+
# setup authorization
|
|
269
|
+
UltracartClient.configure do |config|
|
|
270
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
271
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
272
|
+
|
|
273
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
274
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
275
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
276
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
277
|
+
end
|
|
278
|
+
|
|
279
|
+
api_instance = UltracartClient::CustomerApi.new
|
|
280
|
+
|
|
281
|
+
customer_query = UltracartClient::CustomerQuery.new # CustomerQuery | Customer query
|
|
282
|
+
|
|
283
|
+
opts = {
|
|
284
|
+
_limit: 100, # Integer | The maximum number of records to return on this one API call. (Max 200)
|
|
285
|
+
_offset: 0, # Integer | Pagination of the record set. Offset is a zero based index.
|
|
286
|
+
_since: '_since_example', # String | Fetch customers that have been created/modified since this date/time.
|
|
287
|
+
_sort: '_sort_example', # String | The sort order of the customers. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
|
288
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
289
|
+
}
|
|
290
|
+
|
|
291
|
+
begin
|
|
292
|
+
#Retrieve customers by query
|
|
293
|
+
result = api_instance.get_customers_by_query(customer_query, opts)
|
|
294
|
+
p result
|
|
295
|
+
rescue UltracartClient::ApiError => e
|
|
296
|
+
puts "Exception when calling CustomerApi->get_customers_by_query: #{e}"
|
|
297
|
+
end
|
|
298
|
+
```
|
|
299
|
+
|
|
300
|
+
### Parameters
|
|
301
|
+
|
|
302
|
+
Name | Type | Description | Notes
|
|
303
|
+
------------- | ------------- | ------------- | -------------
|
|
304
|
+
**customer_query** | [**CustomerQuery**](CustomerQuery.md)| Customer query |
|
|
305
|
+
**_limit** | **Integer**| The maximum number of records to return on this one API call. (Max 200) | [optional] [default to 100]
|
|
306
|
+
**_offset** | **Integer**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
|
|
307
|
+
**_since** | **String**| Fetch customers that have been created/modified since this date/time. | [optional]
|
|
308
|
+
**_sort** | **String**| The sort order of the customers. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional]
|
|
309
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
|
310
|
+
|
|
311
|
+
### Return type
|
|
312
|
+
|
|
313
|
+
[**CustomersResponse**](CustomersResponse.md)
|
|
314
|
+
|
|
315
|
+
### Authorization
|
|
316
|
+
|
|
317
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
318
|
+
|
|
319
|
+
### HTTP request headers
|
|
320
|
+
|
|
321
|
+
- **Content-Type**: application/json
|
|
322
|
+
- **Accept**: application/json
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
# **get_customers_for_data_tables**
|
|
327
|
+
> DataTablesServerSideResponse get_customers_for_data_tables(opts)
|
|
328
|
+
|
|
329
|
+
Retrieve customers for DataTables plugin
|
|
330
|
+
|
|
331
|
+
Retrieves customers from the account. If no searches are specified, all customers will be returned.
|
|
332
|
+
|
|
333
|
+
### Example
|
|
334
|
+
```ruby
|
|
335
|
+
# load the gem
|
|
336
|
+
require 'ultracart_api'
|
|
337
|
+
# setup authorization
|
|
338
|
+
UltracartClient.configure do |config|
|
|
339
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
340
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
341
|
+
|
|
342
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
343
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
344
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
345
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
346
|
+
end
|
|
347
|
+
|
|
348
|
+
api_instance = UltracartClient::CustomerApi.new
|
|
349
|
+
|
|
350
|
+
opts = {
|
|
351
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
352
|
+
}
|
|
353
|
+
|
|
354
|
+
begin
|
|
355
|
+
#Retrieve customers for DataTables plugin
|
|
356
|
+
result = api_instance.get_customers_for_data_tables(opts)
|
|
357
|
+
p result
|
|
358
|
+
rescue UltracartClient::ApiError => e
|
|
359
|
+
puts "Exception when calling CustomerApi->get_customers_for_data_tables: #{e}"
|
|
360
|
+
end
|
|
361
|
+
```
|
|
362
|
+
|
|
363
|
+
### Parameters
|
|
364
|
+
|
|
365
|
+
Name | Type | Description | Notes
|
|
366
|
+
------------- | ------------- | ------------- | -------------
|
|
367
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
|
368
|
+
|
|
369
|
+
### Return type
|
|
370
|
+
|
|
371
|
+
[**DataTablesServerSideResponse**](DataTablesServerSideResponse.md)
|
|
372
|
+
|
|
373
|
+
### Authorization
|
|
374
|
+
|
|
375
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
376
|
+
|
|
377
|
+
### HTTP request headers
|
|
378
|
+
|
|
379
|
+
- **Content-Type**: application/json
|
|
380
|
+
- **Accept**: application/json
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
# **get_editor_values**
|
|
385
|
+
> CustomerEditorValues get_editor_values
|
|
386
|
+
|
|
387
|
+
Retrieve values needed for a customer profile editor
|
|
388
|
+
|
|
389
|
+
Retrieve values needed for a customer profile editor.
|
|
390
|
+
|
|
391
|
+
### Example
|
|
392
|
+
```ruby
|
|
393
|
+
# load the gem
|
|
394
|
+
require 'ultracart_api'
|
|
395
|
+
# setup authorization
|
|
396
|
+
UltracartClient.configure do |config|
|
|
397
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
398
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
399
|
+
|
|
400
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
401
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
402
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
403
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
404
|
+
end
|
|
405
|
+
|
|
406
|
+
api_instance = UltracartClient::CustomerApi.new
|
|
407
|
+
|
|
408
|
+
begin
|
|
409
|
+
#Retrieve values needed for a customer profile editor
|
|
410
|
+
result = api_instance.get_editor_values
|
|
411
|
+
p result
|
|
412
|
+
rescue UltracartClient::ApiError => e
|
|
413
|
+
puts "Exception when calling CustomerApi->get_editor_values: #{e}"
|
|
414
|
+
end
|
|
415
|
+
```
|
|
416
|
+
|
|
417
|
+
### Parameters
|
|
418
|
+
This endpoint does not need any parameter.
|
|
419
|
+
|
|
420
|
+
### Return type
|
|
421
|
+
|
|
422
|
+
[**CustomerEditorValues**](CustomerEditorValues.md)
|
|
423
|
+
|
|
424
|
+
### Authorization
|
|
425
|
+
|
|
426
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
427
|
+
|
|
428
|
+
### HTTP request headers
|
|
429
|
+
|
|
430
|
+
- **Content-Type**: application/json
|
|
431
|
+
- **Accept**: application/json
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
# **get_email_lists**
|
|
436
|
+
> EmailListsResponse get_email_lists
|
|
437
|
+
|
|
438
|
+
Retrieve all email lists across all storefronts
|
|
439
|
+
|
|
440
|
+
Retrieve all email lists across all storefronts
|
|
441
|
+
|
|
442
|
+
### Example
|
|
443
|
+
```ruby
|
|
444
|
+
# load the gem
|
|
445
|
+
require 'ultracart_api'
|
|
446
|
+
# setup authorization
|
|
447
|
+
UltracartClient.configure do |config|
|
|
448
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
449
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
450
|
+
|
|
451
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
452
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
453
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
454
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
455
|
+
end
|
|
456
|
+
|
|
457
|
+
api_instance = UltracartClient::CustomerApi.new
|
|
458
|
+
|
|
459
|
+
begin
|
|
460
|
+
#Retrieve all email lists across all storefronts
|
|
461
|
+
result = api_instance.get_email_lists
|
|
462
|
+
p result
|
|
463
|
+
rescue UltracartClient::ApiError => e
|
|
464
|
+
puts "Exception when calling CustomerApi->get_email_lists: #{e}"
|
|
465
|
+
end
|
|
466
|
+
```
|
|
467
|
+
|
|
468
|
+
### Parameters
|
|
469
|
+
This endpoint does not need any parameter.
|
|
470
|
+
|
|
471
|
+
### Return type
|
|
472
|
+
|
|
473
|
+
[**EmailListsResponse**](EmailListsResponse.md)
|
|
474
|
+
|
|
475
|
+
### Authorization
|
|
476
|
+
|
|
477
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
478
|
+
|
|
479
|
+
### HTTP request headers
|
|
480
|
+
|
|
481
|
+
- **Content-Type**: application/json
|
|
482
|
+
- **Accept**: application/json
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
# **insert_customer**
|
|
487
|
+
> CustomerResponse insert_customer(customer, opts)
|
|
488
|
+
|
|
489
|
+
Insert a customer
|
|
490
|
+
|
|
491
|
+
Insert a customer on the UltraCart account.
|
|
492
|
+
|
|
493
|
+
### Example
|
|
494
|
+
```ruby
|
|
495
|
+
# load the gem
|
|
496
|
+
require 'ultracart_api'
|
|
497
|
+
# setup authorization
|
|
498
|
+
UltracartClient.configure do |config|
|
|
499
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
500
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
501
|
+
|
|
502
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
503
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
504
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
505
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
506
|
+
end
|
|
507
|
+
|
|
508
|
+
api_instance = UltracartClient::CustomerApi.new
|
|
509
|
+
|
|
510
|
+
customer = UltracartClient::Customer.new # Customer | Customer to insert
|
|
511
|
+
|
|
512
|
+
opts = {
|
|
513
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
514
|
+
}
|
|
515
|
+
|
|
516
|
+
begin
|
|
517
|
+
#Insert a customer
|
|
518
|
+
result = api_instance.insert_customer(customer, opts)
|
|
519
|
+
p result
|
|
520
|
+
rescue UltracartClient::ApiError => e
|
|
521
|
+
puts "Exception when calling CustomerApi->insert_customer: #{e}"
|
|
522
|
+
end
|
|
523
|
+
```
|
|
524
|
+
|
|
525
|
+
### Parameters
|
|
526
|
+
|
|
527
|
+
Name | Type | Description | Notes
|
|
528
|
+
------------- | ------------- | ------------- | -------------
|
|
529
|
+
**customer** | [**Customer**](Customer.md)| Customer to insert |
|
|
530
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
|
531
|
+
|
|
532
|
+
### Return type
|
|
533
|
+
|
|
534
|
+
[**CustomerResponse**](CustomerResponse.md)
|
|
535
|
+
|
|
536
|
+
### Authorization
|
|
537
|
+
|
|
538
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
539
|
+
|
|
540
|
+
### HTTP request headers
|
|
541
|
+
|
|
542
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
543
|
+
- **Accept**: application/json
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
# **update_customer**
|
|
548
|
+
> CustomerResponse update_customer(customer, customer_profile_oid, opts)
|
|
549
|
+
|
|
550
|
+
Update a customer
|
|
551
|
+
|
|
552
|
+
Update a customer on the UltraCart account.
|
|
553
|
+
|
|
554
|
+
### Example
|
|
555
|
+
```ruby
|
|
556
|
+
# load the gem
|
|
557
|
+
require 'ultracart_api'
|
|
558
|
+
# setup authorization
|
|
559
|
+
UltracartClient.configure do |config|
|
|
560
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
561
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
562
|
+
|
|
563
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
564
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
565
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
566
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
567
|
+
end
|
|
568
|
+
|
|
569
|
+
api_instance = UltracartClient::CustomerApi.new
|
|
570
|
+
|
|
571
|
+
customer = UltracartClient::Customer.new # Customer | Customer to update
|
|
572
|
+
|
|
573
|
+
customer_profile_oid = 56 # Integer | The customer_profile_oid to update.
|
|
574
|
+
|
|
575
|
+
opts = {
|
|
576
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
577
|
+
}
|
|
578
|
+
|
|
579
|
+
begin
|
|
580
|
+
#Update a customer
|
|
581
|
+
result = api_instance.update_customer(customer, customer_profile_oid, opts)
|
|
582
|
+
p result
|
|
583
|
+
rescue UltracartClient::ApiError => e
|
|
584
|
+
puts "Exception when calling CustomerApi->update_customer: #{e}"
|
|
585
|
+
end
|
|
586
|
+
```
|
|
587
|
+
|
|
588
|
+
### Parameters
|
|
589
|
+
|
|
590
|
+
Name | Type | Description | Notes
|
|
591
|
+
------------- | ------------- | ------------- | -------------
|
|
592
|
+
**customer** | [**Customer**](Customer.md)| Customer to update |
|
|
593
|
+
**customer_profile_oid** | **Integer**| The customer_profile_oid to update. |
|
|
594
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
|
595
|
+
|
|
596
|
+
### Return type
|
|
597
|
+
|
|
598
|
+
[**CustomerResponse**](CustomerResponse.md)
|
|
599
|
+
|
|
600
|
+
### Authorization
|
|
601
|
+
|
|
602
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
603
|
+
|
|
604
|
+
### HTTP request headers
|
|
605
|
+
|
|
606
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
607
|
+
- **Accept**: application/json
|
|
608
|
+
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
# **update_customer_email_lists**
|
|
612
|
+
> CustomerEmailListChanges update_customer_email_lists(customer_profile_oid, list_changes)
|
|
613
|
+
|
|
614
|
+
Update email list subscriptions for a customer
|
|
615
|
+
|
|
616
|
+
Update email list subscriptions for a customer
|
|
617
|
+
|
|
618
|
+
### Example
|
|
619
|
+
```ruby
|
|
620
|
+
# load the gem
|
|
621
|
+
require 'ultracart_api'
|
|
622
|
+
# setup authorization
|
|
623
|
+
UltracartClient.configure do |config|
|
|
624
|
+
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
625
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
626
|
+
|
|
627
|
+
# Configure API key authorization: ultraCartSimpleApiKey
|
|
628
|
+
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
629
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
630
|
+
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
631
|
+
end
|
|
632
|
+
|
|
633
|
+
api_instance = UltracartClient::CustomerApi.new
|
|
634
|
+
|
|
635
|
+
customer_profile_oid = 56 # Integer | The customer profile oid
|
|
636
|
+
|
|
637
|
+
list_changes = UltracartClient::CustomerEmailListChanges.new # CustomerEmailListChanges | List changes
|
|
638
|
+
|
|
639
|
+
|
|
640
|
+
begin
|
|
641
|
+
#Update email list subscriptions for a customer
|
|
642
|
+
result = api_instance.update_customer_email_lists(customer_profile_oid, list_changes)
|
|
643
|
+
p result
|
|
644
|
+
rescue UltracartClient::ApiError => e
|
|
645
|
+
puts "Exception when calling CustomerApi->update_customer_email_lists: #{e}"
|
|
646
|
+
end
|
|
647
|
+
```
|
|
648
|
+
|
|
649
|
+
### Parameters
|
|
650
|
+
|
|
651
|
+
Name | Type | Description | Notes
|
|
652
|
+
------------- | ------------- | ------------- | -------------
|
|
653
|
+
**customer_profile_oid** | **Integer**| The customer profile oid |
|
|
654
|
+
**list_changes** | [**CustomerEmailListChanges**](CustomerEmailListChanges.md)| List changes |
|
|
655
|
+
|
|
656
|
+
### Return type
|
|
657
|
+
|
|
658
|
+
[**CustomerEmailListChanges**](CustomerEmailListChanges.md)
|
|
659
|
+
|
|
660
|
+
### Authorization
|
|
661
|
+
|
|
662
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
663
|
+
|
|
664
|
+
### HTTP request headers
|
|
665
|
+
|
|
666
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
667
|
+
- **Accept**: application/json
|
|
668
|
+
|
|
669
|
+
|
|
670
|
+
|