ultracart_api 3.10.19 → 4.0.34.rc
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +9 -7
- data/README.md +1170 -1133
- data/Rakefile +10 -8
- data/docs/AccountsReceivableRetryConfig.md +46 -22
- data/docs/AccountsReceivableRetryConfigResponse.md +32 -15
- data/docs/AccountsReceivableRetryDayActivity.md +22 -10
- data/docs/AccountsReceivableRetryStatAccount.md +24 -11
- data/docs/AccountsReceivableRetryStatMetrics.md +38 -18
- data/docs/AccountsReceivableRetryStatRevenue.md +20 -9
- data/docs/AccountsReceivableRetryStatsResponse.md +28 -13
- data/docs/Activity.md +28 -13
- data/docs/AddLibraryItemRequest.md +38 -18
- data/docs/AdjustInternalCertificateRequest.md +28 -13
- data/docs/AdjustInternalCertificateResponse.md +28 -13
- data/docs/AffiliateApi.md +167 -126
- data/docs/AffiliateClick.md +38 -18
- data/docs/AffiliateClickQuery.md +28 -13
- data/docs/AffiliateClicksResponse.md +26 -12
- data/docs/AffiliateLedger.md +54 -26
- data/docs/AffiliateLedgerQuery.md +28 -13
- data/docs/AffiliateLedgersResponse.md +26 -12
- data/docs/AffiliateLink.md +44 -21
- data/docs/ApiUserApplicationProfile.md +26 -12
- data/docs/ApplyLibraryItemRequest.md +24 -11
- data/docs/ApplyLibraryItemResponse.md +38 -18
- data/docs/AutoOrder.md +60 -29
- data/docs/AutoOrderApi.md +669 -502
- data/docs/AutoOrderItem.md +64 -31
- data/docs/AutoOrderItemFutureSchedule.md +24 -11
- data/docs/AutoOrderItemOption.md +20 -9
- data/docs/AutoOrderItemSimpleSchedule.md +22 -10
- data/docs/AutoOrderLog.md +20 -9
- data/docs/AutoOrderQuery.md +58 -28
- data/docs/AutoOrderQueryBatch.md +18 -8
- data/docs/AutoOrderResponse.md +26 -12
- data/docs/AutoOrdersRequest.md +18 -8
- data/docs/AutoOrdersResponse.md +26 -12
- data/docs/AvalaraConfig.md +42 -20
- data/docs/BaseResponse.md +24 -11
- data/docs/Browser.md +22 -10
- data/docs/BrowserDevice.md +18 -8
- data/docs/BrowserOS.md +26 -12
- data/docs/BrowserUserAgent.md +24 -11
- data/docs/Cart.md +68 -33
- data/docs/CartAffiliate.md +20 -9
- data/docs/CartAffirmCheckoutResponse.md +20 -9
- data/docs/CartBilling.md +46 -22
- data/docs/CartBuysafe.md +28 -13
- data/docs/CartCheckout.md +44 -21
- data/docs/CartCoupon.md +18 -8
- data/docs/CartCurrencyConversion.md +20 -9
- data/docs/CartCustomerProfile.md +60 -29
- data/docs/CartCustomerProfileAddress.md +44 -21
- data/docs/CartCustomerProfileCreditCard.md +28 -13
- data/docs/CartFinalizeOrderRequest.md +20 -9
- data/docs/CartFinalizeOrderRequestOptions.md +42 -20
- data/docs/CartFinalizeOrderResponse.md +26 -12
- data/docs/CartGift.md +28 -13
- data/docs/CartGiftCertificate.md +22 -10
- data/docs/CartItem.md +74 -36
- data/docs/CartItemAttribute.md +22 -10
- data/docs/CartItemMultimedia.md +34 -16
- data/docs/CartItemMultimediaThumbnail.md +26 -12
- data/docs/CartItemOption.md +40 -19
- data/docs/CartItemOptionValue.md +26 -12
- data/docs/CartItemPhysical.md +24 -11
- data/docs/CartItemVariationSelection.md +20 -9
- data/docs/CartKitComponentOption.md +44 -21
- data/docs/CartMarketing.md +20 -9
- data/docs/CartPayment.md +30 -14
- data/docs/CartPaymentAffirm.md +18 -8
- data/docs/CartPaymentAmazon.md +18 -8
- data/docs/CartPaymentCheck.md +18 -8
- data/docs/CartPaymentCreditCard.md +34 -16
- data/docs/CartPaymentPurchaseOrder.md +18 -8
- data/docs/CartProfileLoginRequest.md +22 -10
- data/docs/CartProfileLoginResponse.md +20 -9
- data/docs/CartProfileRegisterRequest.md +20 -9
- data/docs/CartProfileRegisterResponse.md +20 -9
- data/docs/CartProperty.md +24 -11
- data/docs/CartResponse.md +20 -9
- data/docs/CartSettings.md +28 -13
- data/docs/CartSettingsBilling.md +18 -8
- data/docs/CartSettingsGift.md +24 -11
- data/docs/CartSettingsGiftWrap.md +22 -10
- data/docs/CartSettingsPayment.md +42 -20
- data/docs/CartSettingsPaymentAmazon.md +22 -10
- data/docs/CartSettingsPaymentCreditCard.md +22 -10
- data/docs/CartSettingsPaymentPayPal.md +26 -12
- data/docs/CartSettingsProvince.md +20 -9
- data/docs/CartSettingsShipping.md +26 -12
- data/docs/CartSettingsShippingCalendar.md +26 -12
- data/docs/CartSettingsShippingEstimate.md +44 -21
- data/docs/CartSettingsTaxes.md +18 -8
- data/docs/CartSettingsTerms.md +20 -9
- data/docs/CartShipping.md +54 -26
- data/docs/CartSummary.md +48 -23
- data/docs/CartTaxes.md +22 -10
- data/docs/CartUpsellAfter.md +22 -10
- data/docs/CartValidationRequest.md +20 -9
- data/docs/CartValidationResponse.md +20 -9
- data/docs/ChannelPartnerApi.md +367 -263
- data/docs/ChannelPartnerCancelResponse.md +26 -12
- data/docs/ChannelPartnerEstimateShippingResponse.md +26 -12
- data/docs/ChannelPartnerEstimateTaxResponse.md +26 -12
- data/docs/ChannelPartnerImportResponse.md +30 -14
- data/docs/ChannelPartnerOrder.md +176 -87
- data/docs/ChannelPartnerOrderItem.md +30 -14
- data/docs/ChannelPartnerOrderItemOption.md +20 -9
- data/docs/ChannelPartnerOrderTransaction.md +20 -9
- data/docs/ChannelPartnerOrderTransactionDetail.md +20 -9
- data/docs/ChannelPartnerShippingEstimate.md +20 -9
- data/docs/ChargebackApi.md +405 -301
- data/docs/ChargebackDispute.md +62 -30
- data/docs/ChargebackDisputeResponse.md +26 -12
- data/docs/ChargebackDisputesResponse.md +26 -12
- data/docs/CheckoutAllowedCountriesResponse.md +18 -8
- data/docs/CheckoutApi.md +1424 -1023
- data/docs/CheckoutHandoffRequest.md +32 -15
- data/docs/CheckoutHandoffResponse.md +22 -10
- data/docs/CheckoutSetupBrowserKeyRequest.md +18 -8
- data/docs/CheckoutSetupBrowserKeyResponse.md +18 -8
- data/docs/CheckoutStateProvinceResponse.md +18 -8
- data/docs/CityStateZip.md +26 -12
- data/docs/CountriesResponse.md +18 -8
- data/docs/Country.md +20 -9
- data/docs/Coupon.md +136 -67
- data/docs/CouponAmountOffItems.md +24 -11
- data/docs/CouponAmountOffShipping.md +22 -10
- data/docs/CouponAmountOffShippingWithItemsPurchase.md +24 -11
- data/docs/CouponAmountOffSubtotal.md +20 -9
- data/docs/CouponAmountOffSubtotalAndShipping.md +20 -9
- data/docs/CouponAmountOffSubtotalFreeShippingWithPurchase.md +24 -11
- data/docs/CouponAmountOffSubtotalWithBlockPurchase.md +24 -11
- data/docs/CouponAmountOffSubtotalWithItemsPurchase.md +24 -11
- data/docs/CouponAmountOffSubtotalWithPurchase.md +22 -10
- data/docs/CouponAmountShippingWithSubtotal.md +24 -11
- data/docs/CouponApi.md +1443 -1043
- data/docs/CouponAutoApplyCondition.md +22 -10
- data/docs/CouponAutoApplyConditions.md +28 -13
- data/docs/CouponAutomaticallyApplyCouponCodes.md +18 -8
- data/docs/CouponBuyOneGetOneLimit.md +20 -9
- data/docs/CouponCodesRequest.md +30 -14
- data/docs/CouponCodesResponse.md +28 -13
- data/docs/CouponDeletesRequest.md +20 -9
- data/docs/CouponDiscountItemWithItemPurchase.md +26 -12
- data/docs/CouponDiscountItems.md +24 -11
- data/docs/CouponEditorValues.md +36 -17
- data/docs/CouponExistsResponse.md +28 -13
- data/docs/CouponFreeItemAndShippingWithSubtotal.md +26 -12
- data/docs/CouponFreeItemWithItemPurchase.md +24 -11
- data/docs/CouponFreeItemWithSubtotal.md +24 -11
- data/docs/CouponFreeItemsWithItemPurchase.md +26 -12
- data/docs/CouponFreeItemsWithMixMatchPurchase.md +26 -12
- data/docs/CouponFreeShipping.md +18 -8
- data/docs/CouponFreeShippingSpecificItems.md +18 -8
- data/docs/CouponFreeShippingWithItemsPurchase.md +20 -9
- data/docs/CouponFreeShippingWithSubtotal.md +22 -10
- data/docs/CouponItemSearchResult.md +32 -15
- data/docs/CouponItemSearchResultsResponse.md +26 -12
- data/docs/CouponMultipleAmountsOffItems.md +20 -9
- data/docs/CouponPercentOffItemWithItemsQuantityPurchase.md +26 -12
- data/docs/CouponPercentOffItems.md +24 -11
- data/docs/CouponPercentOffItemsAndFreeShipping.md +22 -10
- data/docs/CouponPercentOffItemsWithItemsPurchase.md +24 -11
- data/docs/CouponPercentOffMsrpItems.md +24 -11
- data/docs/CouponPercentOffRetailPriceItems.md +24 -11
- data/docs/CouponPercentOffShipping.md +20 -9
- data/docs/CouponPercentOffSubtotal.md +18 -8
- data/docs/CouponPercentOffSubtotalAndFreeShipping.md +20 -9
- data/docs/CouponPercentOffSubtotalLimit.md +22 -10
- data/docs/CouponPercentOffSubtotalWithItemsPurchase.md +20 -9
- data/docs/CouponPercentOffSubtotalWithSubtotal.md +22 -10
- data/docs/CouponQuery.md +36 -17
- data/docs/CouponResponse.md +28 -13
- data/docs/CouponRestriction.md +24 -11
- data/docs/CouponTierAmount.md +22 -10
- data/docs/CouponTierItemDiscount.md +20 -9
- data/docs/CouponTierPercent.md +22 -10
- data/docs/CouponTierQuantityAmount.md +22 -10
- data/docs/CouponTierQuantityPercent.md +22 -10
- data/docs/CouponTieredAmountOffItems.md +22 -10
- data/docs/CouponTieredAmountOffSubtotal.md +20 -9
- data/docs/CouponTieredPercentOffItems.md +22 -10
- data/docs/CouponTieredPercentOffShipping.md +22 -10
- data/docs/CouponTieredPercentOffSubtotal.md +20 -9
- data/docs/CouponType.md +20 -9
- data/docs/CouponsRequest.md +18 -8
- data/docs/CouponsResponse.md +26 -12
- data/docs/Currency.md +26 -12
- data/docs/Customer.md +134 -66
- data/docs/CustomerActivity.md +32 -15
- data/docs/CustomerAffiliate.md +24 -11
- data/docs/CustomerApi.md +1401 -1023
- data/docs/CustomerAttachment.md +26 -12
- data/docs/CustomerBilling.md +50 -24
- data/docs/CustomerCard.md +32 -15
- data/docs/CustomerEditorValues.md +36 -17
- data/docs/CustomerEmail.md +28 -13
- data/docs/CustomerEmailListChanges.md +20 -9
- data/docs/CustomerLoyalty.md +30 -14
- data/docs/CustomerLoyaltyLedger.md +46 -22
- data/docs/CustomerLoyaltyRedemption.md +42 -20
- data/docs/CustomerMergeRequest.md +20 -9
- data/docs/CustomerOrdersSummary.md +24 -11
- data/docs/CustomerPricingTier.md +20 -9
- data/docs/CustomerPrivacy.md +24 -11
- data/docs/CustomerQuery.md +74 -36
- data/docs/CustomerQuotesSummary.md +24 -11
- data/docs/CustomerResponse.md +26 -12
- data/docs/CustomerReviewer.md +36 -17
- data/docs/CustomerShipping.md +50 -24
- data/docs/CustomerSoftwareEntitlement.md +32 -15
- data/docs/CustomerStoreCredit.md +28 -13
- data/docs/CustomerStoreCreditAddRequest.md +24 -11
- data/docs/CustomerStoreCreditLedgerEntry.md +30 -14
- data/docs/CustomerStoreCreditResponse.md +26 -12
- data/docs/CustomerTag.md +18 -8
- data/docs/CustomerTaxCodes.md +26 -12
- data/docs/CustomersResponse.md +26 -12
- data/docs/DataTablesServerSideResponse.md +24 -11
- data/docs/Distance.md +20 -9
- data/docs/DistributionCenter.md +86 -42
- data/docs/DistributionCentersResponse.md +26 -12
- data/docs/EmailBaseTemplateListResponse.md +18 -8
- data/docs/EmailCampaign.md +64 -31
- data/docs/EmailCampaignFolder.md +26 -12
- data/docs/EmailCampaignFolderResponse.md +26 -12
- data/docs/EmailCampaignFoldersResponse.md +26 -12
- data/docs/EmailCampaignResponse.md +26 -12
- data/docs/EmailCampaignsResponse.md +26 -12
- data/docs/EmailClick.md +20 -9
- data/docs/EmailClicksResponse.md +26 -12
- data/docs/EmailCommseq.md +24 -11
- data/docs/EmailCommseqEmail.md +68 -33
- data/docs/EmailCommseqEmailResponse.md +26 -12
- data/docs/EmailCommseqEmailSendTestRequest.md +36 -17
- data/docs/EmailCommseqEmailSendTestResponse.md +24 -11
- data/docs/EmailCommseqEmailsRequest.md +26 -12
- data/docs/EmailCommseqEmailsResponse.md +26 -12
- data/docs/EmailCommseqPostcard.md +42 -20
- data/docs/EmailCommseqPostcardResponse.md +26 -12
- data/docs/EmailCommseqPostcardSendTestRequest.md +42 -20
- data/docs/EmailCommseqPostcardSendTestResponse.md +30 -14
- data/docs/EmailCommseqPostcardsRequest.md +18 -8
- data/docs/EmailCommseqPostcardsResponse.md +26 -12
- data/docs/EmailCommseqResponse.md +26 -12
- data/docs/EmailCommseqStat.md +90 -44
- data/docs/EmailCommseqStatResponse.md +26 -12
- data/docs/EmailCommseqStep.md +36 -17
- data/docs/EmailCommseqStepLog.md +22 -10
- data/docs/EmailCommseqStepLogsResponse.md +26 -12
- data/docs/EmailCommseqWebhookSendTestRequest.md +30 -14
- data/docs/EmailCommseqWebhookSendTestResponse.md +30 -14
- data/docs/EmailCommseqsResponse.md +26 -12
- data/docs/EmailCustomer.md +32 -15
- data/docs/EmailCustomerEditorUrlResponse.md +26 -12
- data/docs/EmailCustomersResponse.md +26 -12
- data/docs/EmailDashboardActivity.md +30 -14
- data/docs/EmailDashboardActivityResponse.md +26 -12
- data/docs/EmailDashboardStatsResponse.md +26 -12
- data/docs/EmailDomain.md +42 -20
- data/docs/EmailEditorTokenResponse.md +26 -12
- data/docs/EmailFlow.md +72 -35
- data/docs/EmailFlowBackPopulateRequest.md +20 -9
- data/docs/EmailFlowBackPopulateResponse.md +24 -11
- data/docs/EmailFlowFolder.md +26 -12
- data/docs/EmailFlowFolderResponse.md +26 -12
- data/docs/EmailFlowFoldersResponse.md +26 -12
- data/docs/EmailFlowResponse.md +26 -12
- data/docs/EmailFlowsResponse.md +26 -12
- data/docs/EmailGlobalSettings.md +18 -8
- data/docs/EmailGlobalSettingsResponse.md +26 -12
- data/docs/EmailGlobalUnsubscribeRequest.md +18 -8
- data/docs/EmailGlobalUnsubscribeResponse.md +18 -8
- data/docs/EmailHistogramPropertyNamesResponse.md +18 -8
- data/docs/EmailHistogramPropertyValuesResponse.md +18 -8
- data/docs/EmailList.md +40 -19
- data/docs/EmailListArchiveResponse.md +26 -12
- data/docs/EmailListCustomer.md +24 -11
- data/docs/EmailListCustomersResponse.md +26 -12
- data/docs/EmailListResponse.md +26 -12
- data/docs/EmailListSegmentFolder.md +26 -12
- data/docs/EmailListSegmentFolderResponse.md +26 -12
- data/docs/EmailListSegmentFoldersResponse.md +26 -12
- data/docs/EmailListSegmentMembership.md +24 -11
- data/docs/EmailListSegmentUsedBy.md +22 -10
- data/docs/EmailListSubscribeResponse.md +20 -9
- data/docs/EmailListsResponse.md +26 -12
- data/docs/EmailOrder.md +24 -11
- data/docs/EmailOrdersResponse.md +26 -12
- data/docs/EmailPerformance.md +62 -30
- data/docs/EmailPerformanceCustomerHistogram.md +18 -8
- data/docs/EmailPerformanceCustomerHistogramPeriod.md +26 -12
- data/docs/EmailPerformanceDaily.md +30 -14
- data/docs/EmailPerformanceResponse.md +26 -12
- data/docs/EmailPlan.md +50 -24
- data/docs/EmailPlanAdditional.md +34 -16
- data/docs/EmailPlanResponse.md +26 -12
- data/docs/EmailPostcardStat.md +80 -39
- data/docs/EmailSegment.md +58 -28
- data/docs/EmailSegmentArchiveResponse.md +26 -12
- data/docs/EmailSegmentCustomer.md +24 -11
- data/docs/EmailSegmentCustomersResponse.md +26 -12
- data/docs/EmailSegmentDownloadPrepareResponse.md +32 -15
- data/docs/EmailSegmentResponse.md +26 -12
- data/docs/EmailSegmentsResponse.md +26 -12
- data/docs/EmailSendingDomainResponse.md +26 -12
- data/docs/EmailSendingDomainsResponse.md +26 -12
- data/docs/EmailSettings.md +40 -19
- data/docs/EmailSettingsResponse.md +26 -12
- data/docs/EmailStat.md +92 -45
- data/docs/EmailStatPostcardSummaryRequest.md +20 -9
- data/docs/EmailStatPostcardSummaryResponse.md +26 -12
- data/docs/EmailStatSummaryRequest.md +22 -10
- data/docs/EmailStatSummaryResponse.md +26 -12
- data/docs/EmailStepStat.md +56 -27
- data/docs/EmailStepStatRequest.md +20 -9
- data/docs/EmailStepStatResponse.md +26 -12
- data/docs/EmailStepWaitingRequest.md +18 -8
- data/docs/EmailStepWaitingResponse.md +18 -8
- data/docs/EmailTemplate.md +38 -18
- data/docs/EmailTemplatesResponse.md +26 -12
- data/docs/EmailThirdPartyList.md +20 -9
- data/docs/EmailThirdPartyListImportRequest.md +18 -8
- data/docs/EmailThirdPartyProvider.md +38 -18
- data/docs/EmailThirdPartyProvidersResponse.md +26 -12
- data/docs/EmailThirdPartyTag.md +20 -9
- data/docs/EmailVerifyTokenRequest.md +20 -9
- data/docs/EmailVerifyTokenResponse.md +26 -12
- data/docs/EmailVerifyTokenValidateRequest.md +18 -8
- data/docs/EmailVerifyTokenValidateResponse.md +24 -11
- data/docs/EmailWebhookEditorValuesResponse.md +30 -14
- data/docs/Error.md +26 -12
- data/docs/ErrorResponse.md +24 -11
- data/docs/Experiment.md +52 -25
- data/docs/ExperimentResponse.md +26 -12
- data/docs/ExperimentVariation.md +60 -29
- data/docs/ExperimentVariationStat.md +38 -18
- data/docs/ExperimentsResponse.md +26 -12
- data/docs/FulfillmentApi.md +441 -318
- data/docs/FulfillmentInventory.md +20 -9
- data/docs/FulfillmentShipment.md +26 -12
- data/docs/GeoPoint.md +20 -9
- data/docs/GeocodeRequest.md +26 -12
- data/docs/GeocodeResponse.md +28 -13
- data/docs/GiftCertificate.md +44 -21
- data/docs/GiftCertificateApi.md +598 -433
- data/docs/GiftCertificateCreateRequest.md +26 -12
- data/docs/GiftCertificateLedgerEntry.md +28 -13
- data/docs/GiftCertificateQuery.md +34 -16
- data/docs/GiftCertificateResponse.md +26 -12
- data/docs/GiftCertificatesResponse.md +26 -12
- data/docs/Group.md +26 -12
- data/docs/GroupResponse.md +26 -12
- data/docs/GroupUserMembership.md +26 -12
- data/docs/GroupsResponse.md +26 -12
- data/docs/HTTPHeader.md +20 -9
- data/docs/IntegrationLog.md +52 -25
- data/docs/IntegrationLogApi.md +385 -286
- data/docs/IntegrationLogFile.md +24 -11
- data/docs/IntegrationLogLog.md +20 -9
- data/docs/IntegrationLogQueryFilterValues.md +40 -19
- data/docs/IntegrationLogQueryRequest.md +42 -20
- data/docs/IntegrationLogQueryResponse.md +28 -13
- data/docs/IntegrationLogResponse.md +26 -12
- data/docs/IntegrationLogSummary.md +34 -16
- data/docs/IntegrationLogSummaryQueryRequest.md +20 -9
- data/docs/IntegrationLogSummaryQueryResponse.md +26 -12
- data/docs/Item.md +118 -58
- data/docs/ItemAccounting.md +20 -9
- data/docs/ItemAmember.md +20 -9
- data/docs/ItemApi.md +706 -517
- data/docs/ItemAutoOrder.md +50 -24
- data/docs/ItemAutoOrderStep.md +46 -22
- data/docs/ItemAutoOrderStepArbitraryUnitCostSchedule.md +20 -9
- data/docs/ItemAutoOrderStepGrandfatherPricing.md +20 -9
- data/docs/ItemCCBill.md +28 -13
- data/docs/ItemChannelPartnerMapping.md +54 -26
- data/docs/ItemChargeback.md +20 -9
- data/docs/ItemChargebackAddendum.md +24 -11
- data/docs/ItemChargebackAdjustmentRequest.md +22 -10
- data/docs/ItemCheckout.md +24 -11
- data/docs/ItemContent.md +42 -20
- data/docs/ItemContentAssignment.md +28 -13
- data/docs/ItemContentAttribute.md +24 -11
- data/docs/ItemContentMultimedia.md +46 -22
- data/docs/ItemContentMultimediaThumbnail.md +28 -13
- data/docs/ItemDigitalDelivery.md +28 -13
- data/docs/ItemDigitalItem.md +26 -12
- data/docs/ItemEbay.md +154 -76
- data/docs/ItemEbayCategorySpecific.md +20 -9
- data/docs/ItemEbayMarketListing.md +26 -12
- data/docs/ItemEbayMarketPlaceAnalysis.md +36 -17
- data/docs/ItemEmailNotifications.md +20 -9
- data/docs/ItemEnrollment123.md +18 -8
- data/docs/ItemFulfillmentAddon.md +24 -11
- data/docs/ItemGiftCertificate.md +20 -9
- data/docs/ItemGoogleProductSearch.md +112 -55
- data/docs/ItemIdentifiers.md +24 -11
- data/docs/ItemInstantPaymentNotification.md +22 -10
- data/docs/ItemInstantPaymentNotifications.md +18 -8
- data/docs/ItemInternal.md +18 -8
- data/docs/ItemKitComponent.md +26 -12
- data/docs/ItemKitDefinition.md +18 -8
- data/docs/ItemOption.md +44 -21
- data/docs/ItemOptionValue.md +46 -22
- data/docs/ItemOptionValueAdditionalItem.md +20 -9
- data/docs/ItemOptionValueDigitalItem.md +20 -9
- data/docs/ItemPaymentProcessing.md +26 -12
- data/docs/ItemPhysical.md +24 -11
- data/docs/ItemPricing.md +52 -25
- data/docs/ItemPricingTier.md +26 -12
- data/docs/ItemPricingTierDiscount.md +20 -9
- data/docs/ItemPricingTierLimit.md +22 -10
- data/docs/ItemProperty.md +22 -10
- data/docs/ItemRealtimePricing.md +22 -10
- data/docs/ItemRelated.md +22 -10
- data/docs/ItemRelatedItem.md +22 -10
- data/docs/ItemReporting.md +20 -9
- data/docs/ItemResponse.md +26 -12
- data/docs/ItemRestriction.md +32 -15
- data/docs/ItemRestrictionItem.md +22 -10
- data/docs/ItemRevguard.md +30 -14
- data/docs/ItemReviews.md +34 -16
- data/docs/ItemSalesforce.md +20 -9
- data/docs/ItemShipping.md +112 -55
- data/docs/ItemShippingCase.md +24 -11
- data/docs/ItemShippingDestinationMarkup.md +28 -13
- data/docs/ItemShippingDestinationRestriction.md +22 -10
- data/docs/ItemShippingDistributionCenter.md +44 -21
- data/docs/ItemShippingMethod.md +46 -22
- data/docs/ItemShippingPackageRequirement.md +20 -9
- data/docs/ItemTag.md +20 -9
- data/docs/ItemTags.md +18 -8
- data/docs/ItemTax.md +24 -11
- data/docs/ItemTaxExemption.md +26 -12
- data/docs/ItemThirdPartyEmailMarketing.md +26 -12
- data/docs/ItemVariantItem.md +28 -13
- data/docs/ItemVariation.md +26 -12
- data/docs/ItemVariationOption.md +24 -11
- data/docs/ItemWishlistMember.md +22 -10
- data/docs/ItemsRequest.md +18 -8
- data/docs/ItemsResponse.md +26 -12
- data/docs/KeyValue.md +22 -10
- data/docs/LibraryFilterValues.md +24 -11
- data/docs/LibraryFilterValuesResponse.md +26 -12
- data/docs/LibraryItem.md +96 -47
- data/docs/LibraryItemAccount.md +22 -10
- data/docs/LibraryItemAsset.md +20 -9
- data/docs/LibraryItemAttribute.md +20 -9
- data/docs/LibraryItemEmail.md +22 -10
- data/docs/LibraryItemPublishedMeta.md +32 -15
- data/docs/LibraryItemPurchasedMeta.md +22 -10
- data/docs/LibraryItemQuery.md +40 -19
- data/docs/LibraryItemResponse.md +26 -12
- data/docs/LibraryItemScreenshot.md +20 -9
- data/docs/LibraryItemsResponse.md +26 -12
- data/docs/LinkedAccount.md +22 -10
- data/docs/ListSegmentMembership.md +22 -10
- data/docs/LookupRequest.md +26 -12
- data/docs/LookupResponse.md +26 -12
- data/docs/Mailgun.md +18 -8
- data/docs/Metric.md +32 -15
- data/docs/Notification.md +38 -18
- data/docs/OauthApi.md +163 -124
- data/docs/OauthRevokeSuccessResponse.md +20 -9
- data/docs/OauthTokenResponse.md +32 -15
- data/docs/Order.md +84 -41
- data/docs/OrderAffiliate.md +22 -10
- data/docs/OrderAffiliateLedger.md +34 -16
- data/docs/OrderApi.md +1787 -1308
- data/docs/OrderAutoOrder.md +56 -27
- data/docs/OrderBilling.md +48 -23
- data/docs/OrderBuysafe.md +28 -13
- data/docs/OrderByTokenQuery.md +18 -8
- data/docs/OrderChannelPartner.md +38 -18
- data/docs/OrderCheckout.md +44 -21
- data/docs/OrderCoupon.md +26 -12
- data/docs/OrderDigitalItem.md +32 -15
- data/docs/OrderDigitalOrder.md +26 -12
- data/docs/OrderEdi.md +24 -11
- data/docs/OrderFormat.md +48 -23
- data/docs/OrderFormatResponse.md +20 -9
- data/docs/OrderFraudScore.md +56 -27
- data/docs/OrderGift.md +36 -17
- data/docs/OrderGiftCertificate.md +22 -10
- data/docs/OrderInternal.md +26 -12
- data/docs/OrderItem.md +128 -63
- data/docs/OrderItemEdi.md +20 -9
- data/docs/OrderItemEdiIdentification.md +20 -9
- data/docs/OrderItemEdiLot.md +22 -10
- data/docs/OrderItemOption.md +38 -18
- data/docs/OrderItemOptionFileAttachment.md +24 -11
- data/docs/OrderItemProperty.md +24 -11
- data/docs/OrderItemTag.md +18 -8
- data/docs/OrderLinkedShipment.md +26 -12
- data/docs/OrderMarketing.md +22 -10
- data/docs/OrderPackingSlipResponse.md +26 -12
- data/docs/OrderPayment.md +52 -25
- data/docs/OrderPaymentCheck.md +18 -8
- data/docs/OrderPaymentCreditCard.md +38 -18
- data/docs/OrderPaymentECheck.md +36 -17
- data/docs/OrderPaymentInsurance.md +24 -11
- data/docs/OrderPaymentPurchaseOrder.md +18 -8
- data/docs/OrderPaymentTransaction.md +24 -11
- data/docs/OrderPaymentTransactionDetail.md +22 -10
- data/docs/OrderProcessPaymentRequest.md +20 -9
- data/docs/OrderProcessPaymentResponse.md +26 -12
- data/docs/OrderProperty.md +24 -11
- data/docs/OrderQuery.md +94 -46
- data/docs/OrderQueryBatch.md +18 -8
- data/docs/OrderQuote.md +22 -10
- data/docs/OrderReplacement.md +46 -22
- data/docs/OrderReplacementItem.md +22 -10
- data/docs/OrderReplacementResponse.md +28 -13
- data/docs/OrderResponse.md +26 -12
- data/docs/OrderSalesforce.md +18 -8
- data/docs/OrderShipping.md +76 -37
- data/docs/OrderSummary.md +56 -27
- data/docs/OrderTag.md +18 -8
- data/docs/OrderTaxes.md +50 -24
- data/docs/OrderTokenResponse.md +26 -12
- data/docs/OrderTrackingNumberDetail.md +40 -19
- data/docs/OrderTrackingNumberDetails.md +52 -25
- data/docs/OrdersResponse.md +26 -12
- data/docs/Permission.md +22 -10
- data/docs/PricingTier.md +78 -38
- data/docs/PricingTierNotification.md +22 -10
- data/docs/PricingTiersResponse.md +26 -12
- data/docs/Property.md +20 -9
- data/docs/PublishLibraryItemRequest.md +18 -8
- data/docs/RegisterAffiliateClickRequest.md +28 -13
- data/docs/RegisterAffiliateClickResponse.md +24 -11
- data/docs/ResponseMetadata.md +20 -9
- data/docs/ResultSet.md +28 -13
- data/docs/ScreenRecording.md +116 -57
- data/docs/ScreenRecordingAdPlatform.md +30 -14
- data/docs/ScreenRecordingFilter.md +136 -67
- data/docs/ScreenRecordingFilterGeoDistance.md +26 -12
- data/docs/ScreenRecordingFilterIpSearch.md +24 -11
- data/docs/ScreenRecordingFilterPageView.md +50 -24
- data/docs/ScreenRecordingFilterPageViewEvent.md +20 -9
- data/docs/ScreenRecordingFilterPageViewEventParam.md +26 -12
- data/docs/ScreenRecordingFilterPageViewParam.md +20 -9
- data/docs/ScreenRecordingFilterPageViewReferrerParam.md +20 -9
- data/docs/ScreenRecordingFilterRangeBigDecimal.md +26 -12
- data/docs/ScreenRecordingFilterRangeDate.md +20 -9
- data/docs/ScreenRecordingFilterRangeInteger.md +26 -12
- data/docs/ScreenRecordingFilterStringSearch.md +26 -12
- data/docs/ScreenRecordingFilterValues.md +58 -28
- data/docs/ScreenRecordingFilterValuesEvent.md +20 -9
- data/docs/ScreenRecordingFilterValuesEventParams.md +26 -12
- data/docs/ScreenRecordingFilterValuesPageParam.md +20 -9
- data/docs/ScreenRecordingFilterValuesPageView.md +28 -13
- data/docs/ScreenRecordingHeatmap.md +64 -31
- data/docs/ScreenRecordingHeatmapIndexRequest.md +18 -8
- data/docs/ScreenRecordingHeatmapIndexResponse.md +26 -12
- data/docs/ScreenRecordingHeatmapRequest.md +22 -10
- data/docs/ScreenRecordingHeatmapReset.md +18 -8
- data/docs/ScreenRecordingHeatmapResponse.md +26 -12
- data/docs/ScreenRecordingHeatmapUrl.md +28 -13
- data/docs/ScreenRecordingMerchantNotesRequest.md +18 -8
- data/docs/ScreenRecordingMultifield.md +26 -12
- data/docs/ScreenRecordingPageView.md +54 -26
- data/docs/ScreenRecordingPageViewDataResponse.md +26 -12
- data/docs/ScreenRecordingPageViewEvent.md +28 -13
- data/docs/ScreenRecordingPageViewEventParameter.md +20 -9
- data/docs/ScreenRecordingPageViewParameter.md +20 -9
- data/docs/ScreenRecordingQueryRequest.md +18 -8
- data/docs/ScreenRecordingQueryResponse.md +38 -18
- data/docs/ScreenRecordingResponse.md +28 -13
- data/docs/ScreenRecordingSegment.md +36 -17
- data/docs/ScreenRecordingSegmentResponse.md +26 -12
- data/docs/ScreenRecordingSegmentsResponse.md +26 -12
- data/docs/ScreenRecordingSettings.md +32 -15
- data/docs/ScreenRecordingSettingsResponse.md +26 -12
- data/docs/ScreenRecordingStoreFront.md +20 -9
- data/docs/ScreenRecordingTagsRequest.md +18 -8
- data/docs/ScreenRecordingTagsResponse.md +26 -12
- data/docs/ScreenRecordingUserAgent.md +26 -12
- data/docs/ScreenRecordingUserAgentDevice.md +18 -8
- data/docs/ScreenRecordingUserAgentOS.md +22 -10
- data/docs/ScreenRecordingUserProperty.md +20 -9
- data/docs/ScreenshotsResponse.md +26 -12
- data/docs/SelfConfig.md +18 -8
- data/docs/SimpleValue.md +20 -9
- data/docs/SingleSignOnAuthorizeRequest.md +20 -9
- data/docs/SingleSignOnAuthorizeResponse.md +20 -9
- data/docs/SingleSignOnTokenRequest.md +20 -9
- data/docs/SingleSignOnTokenResponse.md +22 -10
- data/docs/SovosConfig.md +30 -14
- data/docs/SsoApi.md +288 -201
- data/docs/StateProvince.md +20 -9
- data/docs/StepWaiting.md +20 -9
- data/docs/StorefrontApi.md +11794 -8525
- data/docs/TaxApi.md +2017 -1421
- data/docs/TaxCity.md +34 -16
- data/docs/TaxCountry.md +34 -16
- data/docs/TaxCountryCode.md +26 -12
- data/docs/TaxCounty.md +36 -17
- data/docs/TaxJarConfig.md +30 -14
- data/docs/TaxPostalCode.md +30 -14
- data/docs/TaxProviderActivateResult.md +20 -9
- data/docs/TaxProviderAvalara.md +24 -11
- data/docs/TaxProviderAvalaraCompaniesResult.md +18 -8
- data/docs/TaxProviderAvalaraCompany.md +26 -12
- data/docs/TaxProviderSelf.md +26 -12
- data/docs/TaxProviderSelfCountriesResponse.md +18 -8
- data/docs/TaxProviderSelfRegionsResponse.md +18 -8
- data/docs/TaxProviderSovos.md +24 -11
- data/docs/TaxProviderTaxJar.md +24 -11
- data/docs/TaxProviderTestResult.md +20 -9
- data/docs/TaxProviderUltraCart.md +26 -12
- data/docs/TaxProviderUltraCartState.md +36 -17
- data/docs/TaxProvidersResponse.md +34 -16
- data/docs/TaxState.md +52 -25
- data/docs/TaxStateCode.md +26 -12
- data/docs/TempMultimedia.md +30 -14
- data/docs/TempMultimediaResponse.md +26 -12
- data/docs/ThumbnailParametersRequest.md +26 -12
- data/docs/ThumbnailParametersResponse.md +26 -12
- data/docs/TransactionEmail.md +56 -27
- data/docs/TransactionEmailListResponse.md +26 -12
- data/docs/TransactionEmailOption.md +32 -15
- data/docs/TransactionEmailResponse.md +26 -12
- data/docs/Twilio.md +24 -11
- data/docs/TwilioResponse.md +28 -13
- data/docs/TwiliosResponse.md +26 -12
- data/docs/UltraCartConfig.md +18 -8
- data/docs/UploadCouponCodesRequest.md +26 -12
- data/docs/UploadCouponCodesResponse.md +30 -14
- data/docs/User.md +44 -21
- data/docs/UserApi.md +790 -558
- data/docs/UserGroupMembership.md +22 -10
- data/docs/UserLogin.md +24 -11
- data/docs/UserLoginsResponse.md +26 -12
- data/docs/UserResponse.md +26 -12
- data/docs/UsersResponse.md +26 -12
- data/docs/VerificationRecord.md +22 -10
- data/docs/Warning.md +20 -9
- data/docs/Webhook.md +52 -25
- data/docs/WebhookApi.md +612 -447
- data/docs/WebhookEventCategory.md +26 -12
- data/docs/WebhookEventSubscription.md +34 -16
- data/docs/WebhookLog.md +38 -18
- data/docs/WebhookLogResponse.md +26 -12
- data/docs/WebhookLogSummariesResponse.md +26 -12
- data/docs/WebhookLogSummary.md +22 -10
- data/docs/WebhookResponse.md +26 -12
- data/docs/WebhookSampleRequest.md +24 -11
- data/docs/WebhookSampleRequestResponse.md +26 -12
- data/docs/WebhooksResponse.md +26 -12
- data/docs/Weight.md +20 -9
- data/git_push.sh +57 -55
- data/lib/ultracart_api/api/affiliate_api.rb +191 -164
- data/lib/ultracart_api/api/auto_order_api.rb +672 -581
- data/lib/ultracart_api/api/channel_partner_api.rb +370 -311
- data/lib/ultracart_api/api/chargeback_api.rb +410 -356
- data/lib/ultracart_api/api/checkout_api.rb +1341 -1111
- data/lib/ultracart_api/api/coupon_api.rb +1390 -1161
- data/lib/ultracart_api/api/customer_api.rb +1370 -1157
- data/lib/ultracart_api/api/fulfillment_api.rb +452 -381
- data/lib/ultracart_api/api/gift_certificate_api.rb +594 -502
- data/lib/ultracart_api/api/integration_log_api.rb +404 -350
- data/lib/ultracart_api/api/item_api.rb +686 -585
- data/lib/ultracart_api/api/oauth_api.rb +198 -171
- data/lib/ultracart_api/api/order_api.rb +1728 -1471
- data/lib/ultracart_api/api/sso_api.rb +289 -243
- data/lib/ultracart_api/api/storefront_api.rb +11407 -9617
- data/lib/ultracart_api/api/tax_api.rb +1916 -1580
- data/lib/ultracart_api/api/user_api.rb +755 -634
- data/lib/ultracart_api/api/webhook_api.rb +601 -514
- data/lib/ultracart_api/api_client.rb +399 -400
- data/lib/ultracart_api/api_error.rb +57 -38
- data/lib/ultracart_api/configuration.rb +302 -229
- data/lib/ultracart_api/models/accounts_receivable_retry_config.rb +364 -329
- data/lib/ultracart_api/models/accounts_receivable_retry_config_response.rb +287 -252
- data/lib/ultracart_api/models/accounts_receivable_retry_day_activity.rb +240 -205
- data/lib/ultracart_api/models/accounts_receivable_retry_stat_account.rb +250 -215
- data/lib/ultracart_api/models/accounts_receivable_retry_stat_metrics.rb +309 -274
- data/lib/ultracart_api/models/accounts_receivable_retry_stat_revenue.rb +228 -193
- data/lib/ultracart_api/models/accounts_receivable_retry_stats_response.rb +267 -232
- data/lib/ultracart_api/models/activity.rb +264 -229
- data/lib/ultracart_api/models/add_library_item_request.rb +324 -289
- data/lib/ultracart_api/models/adjust_internal_certificate_request.rb +270 -235
- data/lib/ultracart_api/models/adjust_internal_certificate_response.rb +267 -232
- data/lib/ultracart_api/models/affiliate_click.rb +319 -284
- data/lib/ultracart_api/models/affiliate_click_query.rb +270 -235
- data/lib/ultracart_api/models/affiliate_clicks_response.rb +259 -224
- data/lib/ultracart_api/models/affiliate_ledger.rb +431 -396
- data/lib/ultracart_api/models/affiliate_ledger_query.rb +270 -235
- data/lib/ultracart_api/models/affiliate_ledgers_response.rb +259 -224
- data/lib/ultracart_api/models/affiliate_link.rb +408 -373
- data/lib/ultracart_api/models/api_user_application_profile.rb +260 -225
- data/lib/ultracart_api/models/apply_library_item_request.rb +250 -215
- data/lib/ultracart_api/models/apply_library_item_response.rb +319 -284
- data/lib/ultracart_api/models/auto_order.rb +469 -434
- data/lib/ultracart_api/models/auto_order_item.rb +487 -452
- data/lib/ultracart_api/models/auto_order_item_future_schedule.rb +250 -215
- data/lib/ultracart_api/models/auto_order_item_option.rb +260 -225
- data/lib/ultracart_api/models/auto_order_item_simple_schedule.rb +274 -239
- data/lib/ultracart_api/models/auto_order_log.rb +230 -195
- data/lib/ultracart_api/models/auto_order_query.rb +480 -445
- data/lib/ultracart_api/models/auto_order_query_batch.rb +222 -187
- data/lib/ultracart_api/models/auto_order_response.rb +256 -221
- data/lib/ultracart_api/models/auto_orders_request.rb +222 -187
- data/lib/ultracart_api/models/auto_orders_response.rb +258 -223
- data/lib/ultracart_api/models/avalara_config.rb +340 -305
- data/lib/ultracart_api/models/base_response.rb +247 -212
- data/lib/ultracart_api/models/browser.rb +237 -202
- data/lib/ultracart_api/models/browser_device.rb +219 -184
- data/lib/ultracart_api/models/browser_os.rb +255 -220
- data/lib/ultracart_api/models/browser_user_agent.rb +246 -211
- data/lib/ultracart_api/models/cart.rb +506 -471
- data/lib/ultracart_api/models/cart_affiliate.rb +245 -210
- data/lib/ultracart_api/models/cart_affirm_checkout_response.rb +232 -197
- data/lib/ultracart_api/models/cart_billing.rb +572 -537
- data/lib/ultracart_api/models/cart_buysafe.rb +269 -234
- data/lib/ultracart_api/models/cart_checkout.rb +500 -465
- data/lib/ultracart_api/models/cart_coupon.rb +220 -185
- data/lib/ultracart_api/models/cart_currency_conversion.rb +232 -197
- data/lib/ultracart_api/models/cart_customer_profile.rb +438 -403
- data/lib/ultracart_api/models/cart_customer_profile_address.rb +350 -315
- data/lib/ultracart_api/models/cart_customer_profile_credit_card.rb +304 -269
- data/lib/ultracart_api/models/cart_finalize_order_request.rb +228 -193
- data/lib/ultracart_api/models/cart_finalize_order_request_options.rb +355 -320
- data/lib/ultracart_api/models/cart_finalize_order_response.rb +260 -225
- data/lib/ultracart_api/models/cart_gift.rb +313 -278
- data/lib/ultracart_api/models/cart_gift_certificate.rb +238 -203
- data/lib/ultracart_api/models/cart_item.rb +504 -469
- data/lib/ultracart_api/models/cart_item_attribute.rb +240 -205
- data/lib/ultracart_api/models/cart_item_multimedia.rb +336 -301
- data/lib/ultracart_api/models/cart_item_multimedia_thumbnail.rb +260 -225
- data/lib/ultracart_api/models/cart_item_option.rb +378 -343
- data/lib/ultracart_api/models/cart_item_option_value.rb +258 -223
- data/lib/ultracart_api/models/cart_item_physical.rb +246 -211
- data/lib/ultracart_api/models/cart_item_variation_selection.rb +230 -195
- data/lib/ultracart_api/models/cart_kit_component_option.rb +398 -363
- data/lib/ultracart_api/models/cart_marketing.rb +230 -195
- data/lib/ultracart_api/models/cart_payment.rb +275 -240
- data/lib/ultracart_api/models/cart_payment_affirm.rb +220 -185
- data/lib/ultracart_api/models/cart_payment_amazon.rb +220 -185
- data/lib/ultracart_api/models/cart_payment_check.rb +220 -185
- data/lib/ultracart_api/models/cart_payment_credit_card.rb +300 -265
- data/lib/ultracart_api/models/cart_payment_purchase_order.rb +220 -185
- data/lib/ultracart_api/models/cart_profile_login_request.rb +239 -204
- data/lib/ultracart_api/models/cart_profile_login_response.rb +231 -196
- data/lib/ultracart_api/models/cart_profile_register_request.rb +229 -194
- data/lib/ultracart_api/models/cart_profile_register_response.rb +231 -196
- data/lib/ultracart_api/models/cart_property.rb +280 -245
- data/lib/ultracart_api/models/cart_response.rb +231 -196
- data/lib/ultracart_api/models/cart_settings.rb +264 -229
- data/lib/ultracart_api/models/cart_settings_billing.rb +222 -187
- data/lib/ultracart_api/models/cart_settings_gift.rb +251 -216
- data/lib/ultracart_api/models/cart_settings_gift_wrap.rb +239 -204
- data/lib/ultracart_api/models/cart_settings_payment.rb +337 -302
- data/lib/ultracart_api/models/cart_settings_payment_amazon.rb +240 -205
- data/lib/ultracart_api/models/cart_settings_payment_credit_card.rb +242 -207
- data/lib/ultracart_api/models/cart_settings_payment_pay_pal.rb +260 -225
- data/lib/ultracart_api/models/cart_settings_province.rb +228 -193
- data/lib/ultracart_api/models/cart_settings_shipping.rb +262 -227
- data/lib/ultracart_api/models/cart_settings_shipping_calendar.rb +264 -229
- data/lib/ultracart_api/models/cart_settings_shipping_estimate.rb +345 -310
- data/lib/ultracart_api/models/cart_settings_taxes.rb +221 -186
- data/lib/ultracart_api/models/cart_settings_terms.rb +230 -195
- data/lib/ultracart_api/models/cart_shipping.rb +625 -590
- data/lib/ultracart_api/models/cart_summary.rb +354 -319
- data/lib/ultracart_api/models/cart_taxes.rb +255 -220
- data/lib/ultracart_api/models/cart_upsell_after.rb +255 -220
- data/lib/ultracart_api/models/cart_validation_request.rb +231 -196
- data/lib/ultracart_api/models/cart_validation_response.rb +231 -196
- data/lib/ultracart_api/models/channel_partner_cancel_response.rb +259 -224
- data/lib/ultracart_api/models/channel_partner_estimate_shipping_response.rb +259 -224
- data/lib/ultracart_api/models/channel_partner_estimate_tax_response.rb +256 -221
- data/lib/ultracart_api/models/channel_partner_import_response.rb +281 -246
- data/lib/ultracart_api/models/channel_partner_order.rb +1604 -1569
- data/lib/ultracart_api/models/channel_partner_order_item.rb +331 -296
- data/lib/ultracart_api/models/channel_partner_order_item_option.rb +230 -195
- data/lib/ultracart_api/models/channel_partner_order_transaction.rb +232 -197
- data/lib/ultracart_api/models/channel_partner_order_transaction_detail.rb +230 -195
- data/lib/ultracart_api/models/channel_partner_shipping_estimate.rb +230 -195
- data/lib/ultracart_api/models/chargeback_dispute.rb +649 -614
- data/lib/ultracart_api/models/chargeback_dispute_response.rb +256 -221
- data/lib/ultracart_api/models/chargeback_disputes_response.rb +258 -223
- data/lib/ultracart_api/models/checkout_allowed_countries_response.rb +221 -186
- data/lib/ultracart_api/models/checkout_handoff_request.rb +323 -288
- data/lib/ultracart_api/models/checkout_handoff_response.rb +241 -206
- data/lib/ultracart_api/models/checkout_setup_browser_key_request.rb +222 -187
- data/lib/ultracart_api/models/checkout_setup_browser_key_response.rb +220 -185
- data/lib/ultracart_api/models/checkout_state_province_response.rb +221 -186
- data/lib/ultracart_api/models/city_state_zip.rb +255 -220
- data/lib/ultracart_api/models/countries_response.rb +221 -186
- data/lib/ultracart_api/models/country.rb +260 -225
- data/lib/ultracart_api/models/coupon.rb +864 -829
- data/lib/ultracart_api/models/coupon_amount_off_items.rb +267 -232
- data/lib/ultracart_api/models/coupon_amount_off_shipping.rb +257 -222
- data/lib/ultracart_api/models/coupon_amount_off_shipping_with_items_purchase.rb +269 -234
- data/lib/ultracart_api/models/coupon_amount_off_subtotal.rb +245 -210
- data/lib/ultracart_api/models/coupon_amount_off_subtotal_and_shipping.rb +245 -210
- data/lib/ultracart_api/models/coupon_amount_off_subtotal_free_shipping_with_purchase.rb +267 -232
- data/lib/ultracart_api/models/coupon_amount_off_subtotal_with_block_purchase.rb +265 -230
- data/lib/ultracart_api/models/coupon_amount_off_subtotal_with_items_purchase.rb +267 -232
- data/lib/ultracart_api/models/coupon_amount_off_subtotal_with_purchase.rb +255 -220
- data/lib/ultracart_api/models/coupon_amount_shipping_with_subtotal.rb +267 -232
- data/lib/ultracart_api/models/coupon_auto_apply_condition.rb +239 -204
- data/lib/ultracart_api/models/coupon_auto_apply_conditions.rb +269 -234
- data/lib/ultracart_api/models/coupon_automatically_apply_coupon_codes.rb +222 -187
- data/lib/ultracart_api/models/coupon_buy_one_get_one_limit.rb +232 -197
- data/lib/ultracart_api/models/coupon_codes_request.rb +277 -242
- data/lib/ultracart_api/models/coupon_codes_response.rb +269 -234
- data/lib/ultracart_api/models/coupon_deletes_request.rb +234 -199
- data/lib/ultracart_api/models/coupon_discount_item_with_item_purchase.rb +275 -240
- data/lib/ultracart_api/models/coupon_discount_items.rb +267 -232
- data/lib/ultracart_api/models/coupon_editor_values.rb +330 -295
- data/lib/ultracart_api/models/coupon_exists_response.rb +267 -232
- data/lib/ultracart_api/models/coupon_free_item_and_shipping_with_subtotal.rb +279 -244
- data/lib/ultracart_api/models/coupon_free_item_with_item_purchase.rb +254 -219
- data/lib/ultracart_api/models/coupon_free_item_with_subtotal.rb +267 -232
- data/lib/ultracart_api/models/coupon_free_items_with_item_purchase.rb +260 -225
- data/lib/ultracart_api/models/coupon_free_items_with_mix_match_purchase.rb +260 -225
- data/lib/ultracart_api/models/coupon_free_shipping.rb +222 -187
- data/lib/ultracart_api/models/coupon_free_shipping_specific_items.rb +222 -187
- data/lib/ultracart_api/models/coupon_free_shipping_with_items_purchase.rb +234 -199
- data/lib/ultracart_api/models/coupon_free_shipping_with_subtotal.rb +257 -222
- data/lib/ultracart_api/models/coupon_item_search_result.rb +290 -255
- data/lib/ultracart_api/models/coupon_item_search_results_response.rb +259 -224
- data/lib/ultracart_api/models/coupon_multiple_amounts_off_items.rb +232 -197
- data/lib/ultracart_api/models/coupon_percent_off_item_with_items_quantity_purchase.rb +264 -229
- data/lib/ultracart_api/models/coupon_percent_off_items.rb +254 -219
- data/lib/ultracart_api/models/coupon_percent_off_items_and_free_shipping.rb +244 -209
- data/lib/ultracart_api/models/coupon_percent_off_items_with_items_purchase.rb +254 -219
- data/lib/ultracart_api/models/coupon_percent_off_msrp_items.rb +254 -219
- data/lib/ultracart_api/models/coupon_percent_off_retail_price_items.rb +254 -219
- data/lib/ultracart_api/models/coupon_percent_off_shipping.rb +232 -197
- data/lib/ultracart_api/models/coupon_percent_off_subtotal.rb +220 -185
- data/lib/ultracart_api/models/coupon_percent_off_subtotal_and_free_shipping.rb +232 -197
- data/lib/ultracart_api/models/coupon_percent_off_subtotal_limit.rb +255 -220
- data/lib/ultracart_api/models/coupon_percent_off_subtotal_with_items_purchase.rb +232 -197
- data/lib/ultracart_api/models/coupon_percent_off_subtotal_with_subtotal.rb +255 -220
- data/lib/ultracart_api/models/coupon_query.rb +310 -275
- data/lib/ultracart_api/models/coupon_response.rb +268 -233
- data/lib/ultracart_api/models/coupon_restriction.rb +246 -211
- data/lib/ultracart_api/models/coupon_tier_amount.rb +255 -220
- data/lib/ultracart_api/models/coupon_tier_item_discount.rb +232 -197
- data/lib/ultracart_api/models/coupon_tier_percent.rb +255 -220
- data/lib/ultracart_api/models/coupon_tier_quantity_amount.rb +255 -220
- data/lib/ultracart_api/models/coupon_tier_quantity_percent.rb +255 -220
- data/lib/ultracart_api/models/coupon_tiered_amount_off_items.rb +244 -209
- data/lib/ultracart_api/models/coupon_tiered_amount_off_subtotal.rb +234 -199
- data/lib/ultracart_api/models/coupon_tiered_percent_off_items.rb +244 -209
- data/lib/ultracart_api/models/coupon_tiered_percent_off_shipping.rb +259 -224
- data/lib/ultracart_api/models/coupon_tiered_percent_off_subtotal.rb +234 -199
- data/lib/ultracart_api/models/coupon_type.rb +230 -195
- data/lib/ultracart_api/models/coupons_request.rb +222 -187
- data/lib/ultracart_api/models/coupons_response.rb +258 -223
- data/lib/ultracart_api/models/currency.rb +260 -225
- data/lib/ultracart_api/models/customer.rb +978 -943
- data/lib/ultracart_api/models/customer_activity.rb +290 -255
- data/lib/ultracart_api/models/customer_affiliate.rb +250 -215
- data/lib/ultracart_api/models/customer_attachment.rb +260 -225
- data/lib/ultracart_api/models/customer_billing.rb +575 -540
- data/lib/ultracart_api/models/customer_card.rb +290 -255
- data/lib/ultracart_api/models/customer_editor_values.rb +328 -293
- data/lib/ultracart_api/models/customer_email.rb +300 -265
- data/lib/ultracart_api/models/customer_email_list_changes.rb +234 -199
- data/lib/ultracart_api/models/customer_loyalty.rb +283 -248
- data/lib/ultracart_api/models/customer_loyalty_ledger.rb +360 -325
- data/lib/ultracart_api/models/customer_loyalty_redemption.rb +340 -305
- data/lib/ultracart_api/models/customer_merge_request.rb +230 -195
- data/lib/ultracart_api/models/customer_orders_summary.rb +250 -215
- data/lib/ultracart_api/models/customer_pricing_tier.rb +245 -210
- data/lib/ultracart_api/models/customer_privacy.rb +250 -215
- data/lib/ultracart_api/models/customer_query.rb +789 -754
- data/lib/ultracart_api/models/customer_quotes_summary.rb +250 -215
- data/lib/ultracart_api/models/customer_response.rb +256 -221
- data/lib/ultracart_api/models/customer_reviewer.rb +310 -275
- data/lib/ultracart_api/models/customer_shipping.rb +575 -540
- data/lib/ultracart_api/models/customer_software_entitlement.rb +365 -330
- data/lib/ultracart_api/models/customer_store_credit.rb +274 -239
- data/lib/ultracart_api/models/customer_store_credit_add_request.rb +250 -215
- data/lib/ultracart_api/models/customer_store_credit_ledger_entry.rb +295 -260
- data/lib/ultracart_api/models/customer_store_credit_response.rb +256 -221
- data/lib/ultracart_api/models/customer_tag.rb +235 -200
- data/lib/ultracart_api/models/customer_tax_codes.rb +260 -225
- data/lib/ultracart_api/models/customers_response.rb +258 -223
- data/lib/ultracart_api/models/data_tables_server_side_response.rb +248 -213
- data/lib/ultracart_api/models/distance.rb +264 -229
- data/lib/ultracart_api/models/distribution_center.rb +559 -524
- data/lib/ultracart_api/models/distribution_centers_response.rb +258 -223
- data/lib/ultracart_api/models/email_base_template_list_response.rb +221 -186
- data/lib/ultracart_api/models/email_campaign.rb +467 -432
- data/lib/ultracart_api/models/email_campaign_folder.rb +275 -240
- data/lib/ultracart_api/models/email_campaign_folder_response.rb +256 -221
- data/lib/ultracart_api/models/email_campaign_folders_response.rb +258 -223
- data/lib/ultracart_api/models/email_campaign_response.rb +256 -221
- data/lib/ultracart_api/models/email_campaigns_response.rb +258 -223
- data/lib/ultracart_api/models/email_click.rb +230 -195
- data/lib/ultracart_api/models/email_clicks_response.rb +258 -223
- data/lib/ultracart_api/models/email_commseq.rb +252 -217
- data/lib/ultracart_api/models/email_commseq_email.rb +470 -435
- data/lib/ultracart_api/models/email_commseq_email_response.rb +256 -221
- data/lib/ultracart_api/models/email_commseq_email_send_test_request.rb +304 -269
- data/lib/ultracart_api/models/email_commseq_email_send_test_response.rb +247 -212
- data/lib/ultracart_api/models/email_commseq_emails_request.rb +258 -223
- data/lib/ultracart_api/models/email_commseq_emails_response.rb +258 -223
- data/lib/ultracart_api/models/email_commseq_postcard.rb +340 -305
- data/lib/ultracart_api/models/email_commseq_postcard_response.rb +256 -221
- data/lib/ultracart_api/models/email_commseq_postcard_send_test_request.rb +329 -294
- data/lib/ultracart_api/models/email_commseq_postcard_send_test_response.rb +274 -239
- data/lib/ultracart_api/models/email_commseq_postcards_request.rb +221 -186
- data/lib/ultracart_api/models/email_commseq_postcards_response.rb +258 -223
- data/lib/ultracart_api/models/email_commseq_response.rb +256 -221
- data/lib/ultracart_api/models/email_commseq_stat.rb +580 -545
- data/lib/ultracart_api/models/email_commseq_stat_response.rb +256 -221
- data/lib/ultracart_api/models/email_commseq_step.rb +348 -313
- data/lib/ultracart_api/models/email_commseq_step_log.rb +240 -205
- data/lib/ultracart_api/models/email_commseq_step_logs_response.rb +258 -223
- data/lib/ultracart_api/models/email_commseq_webhook_send_test_request.rb +275 -240
- data/lib/ultracart_api/models/email_commseq_webhook_send_test_response.rb +277 -242
- data/lib/ultracart_api/models/email_commseqs_response.rb +258 -223
- data/lib/ultracart_api/models/email_customer.rb +292 -257
- data/lib/ultracart_api/models/email_customer_editor_url_response.rb +256 -221
- data/lib/ultracart_api/models/email_customers_response.rb +262 -227
- data/lib/ultracart_api/models/email_dashboard_activity.rb +280 -245
- data/lib/ultracart_api/models/email_dashboard_activity_response.rb +258 -223
- data/lib/ultracart_api/models/email_dashboard_stats_response.rb +258 -223
- data/lib/ultracart_api/models/email_domain.rb +329 -294
- data/lib/ultracart_api/models/email_editor_token_response.rb +256 -221
- data/lib/ultracart_api/models/email_flow.rb +505 -470
- data/lib/ultracart_api/models/email_flow_back_populate_request.rb +230 -195
- data/lib/ultracart_api/models/email_flow_back_populate_response.rb +247 -212
- data/lib/ultracart_api/models/email_flow_folder.rb +275 -240
- data/lib/ultracart_api/models/email_flow_folder_response.rb +256 -221
- data/lib/ultracart_api/models/email_flow_folders_response.rb +258 -223
- data/lib/ultracart_api/models/email_flow_response.rb +256 -221
- data/lib/ultracart_api/models/email_flows_response.rb +258 -223
- data/lib/ultracart_api/models/email_global_settings.rb +219 -184
- data/lib/ultracart_api/models/email_global_settings_response.rb +256 -221
- data/lib/ultracart_api/models/email_global_unsubscribe_request.rb +219 -184
- data/lib/ultracart_api/models/email_global_unsubscribe_response.rb +219 -184
- data/lib/ultracart_api/models/email_histogram_property_names_response.rb +221 -186
- data/lib/ultracart_api/models/email_histogram_property_values_response.rb +221 -186
- data/lib/ultracart_api/models/email_list.rb +347 -312
- data/lib/ultracart_api/models/email_list_archive_response.rb +256 -221
- data/lib/ultracart_api/models/email_list_customer.rb +250 -215
- data/lib/ultracart_api/models/email_list_customers_response.rb +262 -227
- data/lib/ultracart_api/models/email_list_response.rb +256 -221
- data/lib/ultracart_api/models/email_list_segment_folder.rb +275 -240
- data/lib/ultracart_api/models/email_list_segment_folder_response.rb +256 -221
- data/lib/ultracart_api/models/email_list_segment_folders_response.rb +258 -223
- data/lib/ultracart_api/models/email_list_segment_membership.rb +250 -215
- data/lib/ultracart_api/models/email_list_segment_used_by.rb +240 -205
- data/lib/ultracart_api/models/email_list_subscribe_response.rb +228 -193
- data/lib/ultracart_api/models/email_lists_response.rb +258 -223
- data/lib/ultracart_api/models/email_order.rb +249 -214
- data/lib/ultracart_api/models/email_orders_response.rb +258 -223
- data/lib/ultracart_api/models/email_performance.rb +475 -440
- data/lib/ultracart_api/models/email_performance_customer_histogram.rb +222 -187
- data/lib/ultracart_api/models/email_performance_customer_histogram_period.rb +260 -225
- data/lib/ultracart_api/models/email_performance_daily.rb +280 -245
- data/lib/ultracart_api/models/email_performance_response.rb +256 -221
- data/lib/ultracart_api/models/email_plan.rb +365 -330
- data/lib/ultracart_api/models/email_plan_additional.rb +291 -256
- data/lib/ultracart_api/models/email_plan_response.rb +256 -221
- data/lib/ultracart_api/models/email_postcard_stat.rb +531 -496
- data/lib/ultracart_api/models/email_segment.rb +445 -410
- data/lib/ultracart_api/models/email_segment_archive_response.rb +256 -221
- data/lib/ultracart_api/models/email_segment_customer.rb +250 -215
- data/lib/ultracart_api/models/email_segment_customers_response.rb +262 -227
- data/lib/ultracart_api/models/email_segment_download_prepare_response.rb +283 -248
- data/lib/ultracart_api/models/email_segment_response.rb +256 -221
- data/lib/ultracart_api/models/email_segments_response.rb +258 -223
- data/lib/ultracart_api/models/email_sending_domain_response.rb +256 -221
- data/lib/ultracart_api/models/email_sending_domains_response.rb +258 -223
- data/lib/ultracart_api/models/email_settings.rb +318 -283
- data/lib/ultracart_api/models/email_settings_response.rb +256 -221
- data/lib/ultracart_api/models/email_stat.rb +591 -556
- data/lib/ultracart_api/models/email_stat_postcard_summary_request.rb +230 -195
- data/lib/ultracart_api/models/email_stat_postcard_summary_response.rb +258 -223
- data/lib/ultracart_api/models/email_stat_summary_request.rb +241 -206
- data/lib/ultracart_api/models/email_stat_summary_response.rb +258 -223
- data/lib/ultracart_api/models/email_step_stat.rb +410 -375
- data/lib/ultracart_api/models/email_step_stat_request.rb +230 -195
- data/lib/ultracart_api/models/email_step_stat_response.rb +258 -223
- data/lib/ultracart_api/models/email_step_waiting_request.rb +221 -186
- data/lib/ultracart_api/models/email_step_waiting_response.rb +221 -186
- data/lib/ultracart_api/models/email_template.rb +365 -330
- data/lib/ultracart_api/models/email_templates_response.rb +258 -223
- data/lib/ultracart_api/models/email_third_party_list.rb +230 -195
- data/lib/ultracart_api/models/email_third_party_list_import_request.rb +222 -187
- data/lib/ultracart_api/models/email_third_party_provider.rb +324 -289
- data/lib/ultracart_api/models/email_third_party_providers_response.rb +258 -223
- data/lib/ultracart_api/models/email_third_party_tag.rb +230 -195
- data/lib/ultracart_api/models/email_verify_token_request.rb +230 -195
- data/lib/ultracart_api/models/email_verify_token_response.rb +257 -222
- data/lib/ultracart_api/models/email_verify_token_validate_request.rb +220 -185
- data/lib/ultracart_api/models/email_verify_token_validate_response.rb +247 -212
- data/lib/ultracart_api/models/email_webhook_editor_values_response.rb +278 -243
- data/lib/ultracart_api/models/error.rb +260 -225
- data/lib/ultracart_api/models/error_response.rb +247 -212
- data/lib/ultracart_api/models/experiment.rb +426 -391
- data/lib/ultracart_api/models/experiment_response.rb +256 -221
- data/lib/ultracart_api/models/experiment_variation.rb +432 -397
- data/lib/ultracart_api/models/experiment_variation_stat.rb +320 -285
- data/lib/ultracart_api/models/experiments_response.rb +258 -223
- data/lib/ultracart_api/models/fulfillment_inventory.rb +228 -193
- data/lib/ultracart_api/models/fulfillment_shipment.rb +262 -227
- data/lib/ultracart_api/models/geo_point.rb +228 -193
- data/lib/ultracart_api/models/geocode_request.rb +260 -225
- data/lib/ultracart_api/models/geocode_response.rb +265 -230
- data/lib/ultracart_api/models/gift_certificate.rb +367 -332
- data/lib/ultracart_api/models/gift_certificate_create_request.rb +260 -225
- data/lib/ultracart_api/models/gift_certificate_ledger_entry.rb +285 -250
- data/lib/ultracart_api/models/gift_certificate_query.rb +300 -265
- data/lib/ultracart_api/models/gift_certificate_response.rb +256 -221
- data/lib/ultracart_api/models/gift_certificates_response.rb +258 -223
- data/lib/ultracart_api/models/group.rb +266 -231
- data/lib/ultracart_api/models/group_response.rb +256 -221
- data/lib/ultracart_api/models/group_user_membership.rb +260 -225
- data/lib/ultracart_api/models/groups_response.rb +258 -223
- data/lib/ultracart_api/models/http_header.rb +230 -195
- data/lib/ultracart_api/models/integration_log.rb +379 -344
- data/lib/ultracart_api/models/integration_log_file.rb +246 -211
- data/lib/ultracart_api/models/integration_log_log.rb +228 -193
- data/lib/ultracart_api/models/integration_log_query_filter_values.rb +340 -305
- data/lib/ultracart_api/models/integration_log_query_request.rb +333 -298
- data/lib/ultracart_api/models/integration_log_query_response.rb +267 -232
- data/lib/ultracart_api/models/integration_log_response.rb +256 -221
- data/lib/ultracart_api/models/integration_log_summary.rb +291 -256
- data/lib/ultracart_api/models/integration_log_summary_query_request.rb +230 -195
- data/lib/ultracart_api/models/integration_log_summary_query_response.rb +258 -223
- data/lib/ultracart_api/models/item.rb +748 -713
- data/lib/ultracart_api/models/item_accounting.rb +260 -225
- data/lib/ultracart_api/models/item_amember.rb +245 -210
- data/lib/ultracart_api/models/item_auto_order.rb +403 -368
- data/lib/ultracart_api/models/item_auto_order_step.rb +413 -378
- data/lib/ultracart_api/models/item_auto_order_step_arbitrary_unit_cost_schedule.rb +230 -195
- data/lib/ultracart_api/models/item_auto_order_step_grandfather_pricing.rb +230 -195
- data/lib/ultracart_api/models/item_cc_bill.rb +270 -235
- data/lib/ultracart_api/models/item_channel_partner_mapping.rb +445 -410
- data/lib/ultracart_api/models/item_chargeback.rb +234 -199
- data/lib/ultracart_api/models/item_chargeback_addendum.rb +250 -215
- data/lib/ultracart_api/models/item_chargeback_adjustment_request.rb +240 -205
- data/lib/ultracart_api/models/item_checkout.rb +265 -230
- data/lib/ultracart_api/models/item_content.rb +361 -326
- data/lib/ultracart_api/models/item_content_assignment.rb +285 -250
- data/lib/ultracart_api/models/item_content_attribute.rb +280 -245
- data/lib/ultracart_api/models/item_content_multimedia.rb +441 -406
- data/lib/ultracart_api/models/item_content_multimedia_thumbnail.rb +270 -235
- data/lib/ultracart_api/models/item_digital_delivery.rb +317 -282
- data/lib/ultracart_api/models/item_digital_item.rb +305 -270
- data/lib/ultracart_api/models/item_ebay.rb +901 -866
- data/lib/ultracart_api/models/item_ebay_category_specific.rb +230 -195
- data/lib/ultracart_api/models/item_ebay_market_listing.rb +260 -225
- data/lib/ultracart_api/models/item_ebay_market_place_analysis.rb +311 -276
- data/lib/ultracart_api/models/item_email_notifications.rb +230 -195
- data/lib/ultracart_api/models/item_enrollment123.rb +220 -185
- data/lib/ultracart_api/models/item_fulfillment_addon.rb +250 -215
- data/lib/ultracart_api/models/item_gift_certificate.rb +230 -195
- data/lib/ultracart_api/models/item_google_product_search.rb +1289 -1254
- data/lib/ultracart_api/models/item_identifiers.rb +310 -275
- data/lib/ultracart_api/models/item_instant_payment_notification.rb +270 -235
- data/lib/ultracart_api/models/item_instant_payment_notifications.rb +222 -187
- data/lib/ultracart_api/models/item_internal.rb +235 -200
- data/lib/ultracart_api/models/item_kit_component.rb +260 -225
- data/lib/ultracart_api/models/item_kit_definition.rb +222 -187
- data/lib/ultracart_api/models/item_option.rb +416 -381
- data/lib/ultracart_api/models/item_option_value.rb +409 -374
- data/lib/ultracart_api/models/item_option_value_additional_item.rb +230 -195
- data/lib/ultracart_api/models/item_option_value_digital_item.rb +230 -195
- data/lib/ultracart_api/models/item_payment_processing.rb +264 -229
- data/lib/ultracart_api/models/item_physical.rb +246 -211
- data/lib/ultracart_api/models/item_pricing.rb +422 -387
- data/lib/ultracart_api/models/item_pricing_tier.rb +261 -226
- data/lib/ultracart_api/models/item_pricing_tier_discount.rb +230 -195
- data/lib/ultracart_api/models/item_pricing_tier_limit.rb +240 -205
- data/lib/ultracart_api/models/item_property.rb +270 -235
- data/lib/ultracart_api/models/item_realtime_pricing.rb +240 -205
- data/lib/ultracart_api/models/item_related.rb +242 -207
- data/lib/ultracart_api/models/item_related_item.rb +274 -239
- data/lib/ultracart_api/models/item_reporting.rb +232 -197
- data/lib/ultracart_api/models/item_response.rb +256 -221
- data/lib/ultracart_api/models/item_restriction.rb +292 -257
- data/lib/ultracart_api/models/item_restriction_item.rb +274 -239
- data/lib/ultracart_api/models/item_revguard.rb +280 -245
- data/lib/ultracart_api/models/item_reviews.rb +300 -265
- data/lib/ultracart_api/models/item_salesforce.rb +230 -195
- data/lib/ultracart_api/models/item_shipping.rb +713 -678
- data/lib/ultracart_api/models/item_shipping_case.rb +265 -230
- data/lib/ultracart_api/models/item_shipping_destination_markup.rb +315 -280
- data/lib/ultracart_api/models/item_shipping_destination_restriction.rb +304 -269
- data/lib/ultracart_api/models/item_shipping_distribution_center.rb +380 -345
- data/lib/ultracart_api/models/item_shipping_method.rb +394 -359
- data/lib/ultracart_api/models/item_shipping_package_requirement.rb +230 -195
- data/lib/ultracart_api/models/item_tag.rb +279 -244
- data/lib/ultracart_api/models/item_tags.rb +222 -187
- data/lib/ultracart_api/models/item_tax.rb +286 -251
- data/lib/ultracart_api/models/item_tax_exemption.rb +335 -300
- data/lib/ultracart_api/models/item_third_party_email_marketing.rb +302 -267
- data/lib/ultracart_api/models/item_variant_item.rb +289 -254
- data/lib/ultracart_api/models/item_variation.rb +292 -257
- data/lib/ultracart_api/models/item_variation_option.rb +265 -230
- data/lib/ultracart_api/models/item_wishlist_member.rb +255 -220
- data/lib/ultracart_api/models/items_request.rb +222 -187
- data/lib/ultracart_api/models/items_response.rb +259 -224
- data/lib/ultracart_api/models/key_value.rb +240 -205
- data/lib/ultracart_api/models/library_filter_values.rb +254 -219
- data/lib/ultracart_api/models/library_filter_values_response.rb +256 -221
- data/lib/ultracart_api/models/library_item.rb +606 -571
- data/lib/ultracart_api/models/library_item_account.rb +237 -202
- data/lib/ultracart_api/models/library_item_asset.rb +228 -193
- data/lib/ultracart_api/models/library_item_attribute.rb +228 -193
- data/lib/ultracart_api/models/library_item_email.rb +237 -202
- data/lib/ultracart_api/models/library_item_published_meta.rb +290 -255
- data/lib/ultracart_api/models/library_item_purchased_meta.rb +240 -205
- data/lib/ultracart_api/models/library_item_query.rb +330 -295
- data/lib/ultracart_api/models/library_item_response.rb +256 -221
- data/lib/ultracart_api/models/library_item_screenshot.rb +228 -193
- data/lib/ultracart_api/models/library_items_response.rb +259 -224
- data/lib/ultracart_api/models/linked_account.rb +240 -205
- data/lib/ultracart_api/models/list_segment_membership.rb +237 -202
- data/lib/ultracart_api/models/lookup_request.rb +255 -220
- data/lib/ultracart_api/models/lookup_response.rb +258 -223
- data/lib/ultracart_api/models/mailgun.rb +219 -184
- data/lib/ultracart_api/models/metric.rb +282 -247
- data/lib/ultracart_api/models/notification.rb +322 -287
- data/lib/ultracart_api/models/oauth_revoke_success_response.rb +230 -195
- data/lib/ultracart_api/models/oauth_token_response.rb +321 -286
- data/lib/ultracart_api/models/order.rb +604 -569
- data/lib/ultracart_api/models/order_affiliate.rb +242 -207
- data/lib/ultracart_api/models/order_affiliate_ledger.rb +334 -299
- data/lib/ultracart_api/models/order_auto_order.rb +448 -413
- data/lib/ultracart_api/models/order_billing.rb +597 -562
- data/lib/ultracart_api/models/order_buysafe.rb +268 -233
- data/lib/ultracart_api/models/order_by_token_query.rb +220 -185
- data/lib/ultracart_api/models/order_channel_partner.rb +335 -300
- data/lib/ultracart_api/models/order_checkout.rb +469 -434
- data/lib/ultracart_api/models/order_coupon.rb +290 -255
- data/lib/ultracart_api/models/order_digital_item.rb +290 -255
- data/lib/ultracart_api/models/order_digital_order.rb +262 -227
- data/lib/ultracart_api/models/order_edi.rb +265 -230
- data/lib/ultracart_api/models/order_format.rb +404 -369
- data/lib/ultracart_api/models/order_format_response.rb +232 -197
- data/lib/ultracart_api/models/order_fraud_score.rb +444 -409
- data/lib/ultracart_api/models/order_gift.rb +351 -316
- data/lib/ultracart_api/models/order_gift_certificate.rb +239 -204
- data/lib/ultracart_api/models/order_internal.rb +275 -240
- data/lib/ultracart_api/models/order_item.rb +889 -854
- data/lib/ultracart_api/models/order_item_edi.rb +234 -199
- data/lib/ultracart_api/models/order_item_edi_identification.rb +230 -195
- data/lib/ultracart_api/models/order_item_edi_lot.rb +240 -205
- data/lib/ultracart_api/models/order_item_option.rb +378 -343
- data/lib/ultracart_api/models/order_item_option_file_attachment.rb +250 -215
- data/lib/ultracart_api/models/order_item_property.rb +280 -245
- data/lib/ultracart_api/models/order_item_tag.rb +235 -200
- data/lib/ultracart_api/models/order_linked_shipment.rb +264 -229
- data/lib/ultracart_api/models/order_marketing.rb +270 -235
- data/lib/ultracart_api/models/order_packing_slip_response.rb +257 -222
- data/lib/ultracart_api/models/order_payment.rb +432 -397
- data/lib/ultracart_api/models/order_payment_check.rb +220 -185
- data/lib/ultracart_api/models/order_payment_credit_card.rb +354 -319
- data/lib/ultracart_api/models/order_payment_e_check.rb +476 -441
- data/lib/ultracart_api/models/order_payment_insurance.rb +250 -215
- data/lib/ultracart_api/models/order_payment_purchase_order.rb +220 -185
- data/lib/ultracart_api/models/order_payment_transaction.rb +252 -217
- data/lib/ultracart_api/models/order_payment_transaction_detail.rb +240 -205
- data/lib/ultracart_api/models/order_process_payment_request.rb +230 -195
- data/lib/ultracart_api/models/order_process_payment_response.rb +256 -221
- data/lib/ultracart_api/models/order_property.rb +280 -245
- data/lib/ultracart_api/models/order_query.rb +826 -791
- data/lib/ultracart_api/models/order_query_batch.rb +222 -187
- data/lib/ultracart_api/models/order_quote.rb +240 -205
- data/lib/ultracart_api/models/order_replacement.rb +467 -432
- data/lib/ultracart_api/models/order_replacement_item.rb +255 -220
- data/lib/ultracart_api/models/order_replacement_response.rb +264 -229
- data/lib/ultracart_api/models/order_response.rb +256 -221
- data/lib/ultracart_api/models/order_salesforce.rb +220 -185
- data/lib/ultracart_api/models/order_shipping.rb +770 -735
- data/lib/ultracart_api/models/order_summary.rb +390 -355
- data/lib/ultracart_api/models/order_tag.rb +235 -200
- data/lib/ultracart_api/models/order_taxes.rb +395 -360
- data/lib/ultracart_api/models/order_token_response.rb +257 -222
- data/lib/ultracart_api/models/order_tracking_number_detail.rb +320 -285
- data/lib/ultracart_api/models/order_tracking_number_details.rb +374 -339
- data/lib/ultracart_api/models/orders_response.rb +259 -224
- data/lib/ultracart_api/models/permission.rb +240 -205
- data/lib/ultracart_api/models/pricing_tier.rb +533 -498
- data/lib/ultracart_api/models/pricing_tier_notification.rb +270 -235
- data/lib/ultracart_api/models/pricing_tiers_response.rb +259 -224
- data/lib/ultracart_api/models/property.rb +228 -193
- data/lib/ultracart_api/models/publish_library_item_request.rb +220 -185
- data/lib/ultracart_api/models/register_affiliate_click_request.rb +270 -235
- data/lib/ultracart_api/models/register_affiliate_click_response.rb +254 -219
- data/lib/ultracart_api/models/response_metadata.rb +229 -194
- data/lib/ultracart_api/models/result_set.rb +270 -235
- data/lib/ultracart_api/models/screen_recording.rb +688 -653
- data/lib/ultracart_api/models/screen_recording_ad_platform.rb +280 -245
- data/lib/ultracart_api/models/screen_recording_filter.rb +758 -723
- data/lib/ultracart_api/models/screen_recording_filter_geo_distance.rb +255 -220
- data/lib/ultracart_api/models/screen_recording_filter_ip_search.rb +246 -211
- data/lib/ultracart_api/models/screen_recording_filter_page_view.rb +369 -334
- data/lib/ultracart_api/models/screen_recording_filter_page_view_event.rb +230 -195
- data/lib/ultracart_api/models/screen_recording_filter_page_view_event_param.rb +255 -220
- data/lib/ultracart_api/models/screen_recording_filter_page_view_param.rb +228 -193
- data/lib/ultracart_api/models/screen_recording_filter_page_view_referrer_param.rb +228 -193
- data/lib/ultracart_api/models/screen_recording_filter_range_big_decimal.rb +255 -220
- data/lib/ultracart_api/models/screen_recording_filter_range_date.rb +230 -195
- data/lib/ultracart_api/models/screen_recording_filter_range_integer.rb +255 -220
- data/lib/ultracart_api/models/screen_recording_filter_string_search.rb +255 -220
- data/lib/ultracart_api/models/screen_recording_filter_values.rb +435 -400
- data/lib/ultracart_api/models/screen_recording_filter_values_event.rb +230 -195
- data/lib/ultracart_api/models/screen_recording_filter_values_event_params.rb +263 -228
- data/lib/ultracart_api/models/screen_recording_filter_values_page_param.rb +230 -195
- data/lib/ultracart_api/models/screen_recording_filter_values_page_view.rb +272 -237
- data/lib/ultracart_api/models/screen_recording_heatmap.rb +426 -391
- data/lib/ultracart_api/models/screen_recording_heatmap_index_request.rb +219 -184
- data/lib/ultracart_api/models/screen_recording_heatmap_index_response.rb +258 -223
- data/lib/ultracart_api/models/screen_recording_heatmap_request.rb +239 -204
- data/lib/ultracart_api/models/screen_recording_heatmap_reset.rb +219 -184
- data/lib/ultracart_api/models/screen_recording_heatmap_response.rb +256 -221
- data/lib/ultracart_api/models/screen_recording_heatmap_url.rb +266 -231
- data/lib/ultracart_api/models/screen_recording_merchant_notes_request.rb +219 -184
- data/lib/ultracart_api/models/screen_recording_multifield.rb +255 -220
- data/lib/ultracart_api/models/screen_recording_page_view.rb +391 -356
- data/lib/ultracart_api/models/screen_recording_page_view_data_response.rb +256 -221
- data/lib/ultracart_api/models/screen_recording_page_view_event.rb +267 -232
- data/lib/ultracart_api/models/screen_recording_page_view_event_parameter.rb +228 -193
- data/lib/ultracart_api/models/screen_recording_page_view_parameter.rb +228 -193
- data/lib/ultracart_api/models/screen_recording_query_request.rb +219 -184
- data/lib/ultracart_api/models/screen_recording_query_response.rb +314 -279
- data/lib/ultracart_api/models/screen_recording_response.rb +265 -230
- data/lib/ultracart_api/models/screen_recording_segment.rb +302 -267
- data/lib/ultracart_api/models/screen_recording_segment_response.rb +256 -221
- data/lib/ultracart_api/models/screen_recording_segments_response.rb +258 -223
- data/lib/ultracart_api/models/screen_recording_settings.rb +284 -249
- data/lib/ultracart_api/models/screen_recording_settings_response.rb +256 -221
- data/lib/ultracart_api/models/screen_recording_store_front.rb +228 -193
- data/lib/ultracart_api/models/screen_recording_tags_request.rb +221 -186
- data/lib/ultracart_api/models/screen_recording_tags_response.rb +258 -223
- data/lib/ultracart_api/models/screen_recording_user_agent.rb +255 -220
- data/lib/ultracart_api/models/screen_recording_user_agent_device.rb +219 -184
- data/lib/ultracart_api/models/screen_recording_user_agent_os.rb +237 -202
- data/lib/ultracart_api/models/screen_recording_user_property.rb +228 -193
- data/lib/ultracart_api/models/screenshots_response.rb +259 -224
- data/lib/ultracart_api/models/self_config.rb +220 -185
- data/lib/ultracart_api/models/simple_value.rb +230 -195
- data/lib/ultracart_api/models/single_sign_on_authorize_request.rb +230 -195
- data/lib/ultracart_api/models/single_sign_on_authorize_response.rb +230 -195
- data/lib/ultracart_api/models/single_sign_on_token_request.rb +230 -195
- data/lib/ultracart_api/models/single_sign_on_token_response.rb +240 -205
- data/lib/ultracart_api/models/sovos_config.rb +280 -245
- data/lib/ultracart_api/models/state_province.rb +245 -210
- data/lib/ultracart_api/models/step_waiting.rb +228 -193
- data/lib/ultracart_api/models/tax_city.rb +302 -267
- data/lib/ultracart_api/models/tax_country.rb +302 -267
- data/lib/ultracart_api/models/tax_country_code.rb +260 -225
- data/lib/ultracart_api/models/tax_county.rb +312 -277
- data/lib/ultracart_api/models/tax_jar_config.rb +280 -245
- data/lib/ultracart_api/models/tax_postal_code.rb +280 -245
- data/lib/ultracart_api/models/tax_provider_activate_result.rb +229 -194
- data/lib/ultracart_api/models/tax_provider_avalara.rb +249 -214
- data/lib/ultracart_api/models/tax_provider_avalara_companies_result.rb +222 -187
- data/lib/ultracart_api/models/tax_provider_avalara_company.rb +260 -225
- data/lib/ultracart_api/models/tax_provider_self.rb +261 -226
- data/lib/ultracart_api/models/tax_provider_self_countries_response.rb +222 -187
- data/lib/ultracart_api/models/tax_provider_self_regions_response.rb +222 -187
- data/lib/ultracart_api/models/tax_provider_sovos.rb +249 -214
- data/lib/ultracart_api/models/tax_provider_tax_jar.rb +249 -214
- data/lib/ultracart_api/models/tax_provider_test_result.rb +229 -194
- data/lib/ultracart_api/models/tax_provider_ultra_cart.rb +261 -226
- data/lib/ultracart_api/models/tax_provider_ultra_cart_state.rb +310 -275
- data/lib/ultracart_api/models/tax_providers_response.rb +292 -257
- data/lib/ultracart_api/models/tax_state.rb +392 -357
- data/lib/ultracart_api/models/tax_state_code.rb +260 -225
- data/lib/ultracart_api/models/temp_multimedia.rb +329 -294
- data/lib/ultracart_api/models/temp_multimedia_response.rb +256 -221
- data/lib/ultracart_api/models/thumbnail_parameters_request.rb +255 -220
- data/lib/ultracart_api/models/thumbnail_parameters_response.rb +257 -222
- data/lib/ultracart_api/models/transaction_email.rb +414 -379
- data/lib/ultracart_api/models/transaction_email_list_response.rb +258 -223
- data/lib/ultracart_api/models/transaction_email_option.rb +282 -247
- data/lib/ultracart_api/models/transaction_email_response.rb +256 -221
- data/lib/ultracart_api/models/twilio.rb +248 -213
- data/lib/ultracart_api/models/twilio_response.rb +265 -230
- data/lib/ultracart_api/models/twilios_response.rb +258 -223
- data/lib/ultracart_api/models/ultra_cart_config.rb +220 -185
- data/lib/ultracart_api/models/upload_coupon_codes_request.rb +259 -224
- data/lib/ultracart_api/models/upload_coupon_codes_response.rb +283 -248
- data/lib/ultracart_api/models/user.rb +377 -342
- data/lib/ultracart_api/models/user_group_membership.rb +240 -205
- data/lib/ultracart_api/models/user_login.rb +250 -215
- data/lib/ultracart_api/models/user_logins_response.rb +259 -224
- data/lib/ultracart_api/models/user_response.rb +256 -221
- data/lib/ultracart_api/models/users_response.rb +258 -223
- data/lib/ultracart_api/models/verification_record.rb +237 -202
- data/lib/ultracart_api/models/warning.rb +230 -195
- data/lib/ultracart_api/models/webhook.rb +437 -402
- data/lib/ultracart_api/models/webhook_event_category.rb +264 -229
- data/lib/ultracart_api/models/webhook_event_subscription.rb +300 -265
- data/lib/ultracart_api/models/webhook_log.rb +324 -289
- data/lib/ultracart_api/models/webhook_log_response.rb +256 -221
- data/lib/ultracart_api/models/webhook_log_summaries_response.rb +259 -224
- data/lib/ultracart_api/models/webhook_log_summary.rb +240 -205
- data/lib/ultracart_api/models/webhook_response.rb +256 -221
- data/lib/ultracart_api/models/webhook_sample_request.rb +252 -217
- data/lib/ultracart_api/models/webhook_sample_request_response.rb +256 -221
- data/lib/ultracart_api/models/webhooks_response.rb +258 -223
- data/lib/ultracart_api/models/weight.rb +264 -229
- data/lib/ultracart_api/version.rb +15 -15
- data/lib/ultracart_api.rb +690 -691
- data/spec/api_client_spec.rb +226 -243
- data/spec/configuration_spec.rb +42 -42
- data/spec/spec_helper.rb +111 -111
- data/ultracart_api.gemspec +38 -46
- metadata +4 -166
- data/docs/CouponNoDiscount.md +0 -7
- data/lib/ultracart_api/models/coupon_no_discount.rb +0 -175
data/docs/CustomerApi.md
CHANGED
|
@@ -1,1023 +1,1401 @@
|
|
|
1
|
-
# UltracartClient::CustomerApi
|
|
2
|
-
|
|
3
|
-
All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
4
|
-
|
|
5
|
-
Method | HTTP request | Description
|
|
6
|
-
|
|
7
|
-
[**add_customer_store_credit**](CustomerApi.md#add_customer_store_credit) | **POST** /customer/customers/{customer_profile_oid}/store_credit | Adds store credit to a customer
|
|
8
|
-
[**adjust_internal_certificate**](CustomerApi.md#adjust_internal_certificate) | **POST** /customer/customers/{customer_profile_oid}/adjust_cashback_balance | Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
|
|
9
|
-
[**delete_customer**](CustomerApi.md#delete_customer) | **DELETE** /customer/customers/{customer_profile_oid} | Delete a customer
|
|
10
|
-
[**get_customer**](CustomerApi.md#get_customer) | **GET** /customer/customers/{customer_profile_oid} | Retrieve a customer
|
|
11
|
-
[**get_customer_by_email**](CustomerApi.md#get_customer_by_email) | **GET** /customer/customers/by_email/{email} | Retrieve a customer by Email
|
|
12
|
-
[**get_customer_editor_values**](CustomerApi.md#get_customer_editor_values) | **GET** /customer/editor_values | Retrieve values needed for a customer profile editor
|
|
13
|
-
[**get_customer_email_lists**](CustomerApi.md#get_customer_email_lists) | **GET** /customer/email_lists | Retrieve all email lists across all storefronts
|
|
14
|
-
[**get_customer_store_credit**](CustomerApi.md#get_customer_store_credit) | **GET** /customer/customers/{customer_profile_oid}/store_credit | Retrieve the customer store credit accumulated through loyalty programs
|
|
15
|
-
[**get_customers**](CustomerApi.md#get_customers) | **GET** /customer/customers | Retrieve customers
|
|
16
|
-
[**get_customers_by_query**](CustomerApi.md#get_customers_by_query) | **POST** /customer/customers/query | Retrieve customers by query
|
|
17
|
-
[**get_customers_for_data_tables**](CustomerApi.md#get_customers_for_data_tables) | **POST** /customer/customers/dataTables | Retrieve customers for DataTables plugin
|
|
18
|
-
[**get_email_verification_token**](CustomerApi.md#get_email_verification_token) | **POST** /customer/customers/email_verify/get_token | Create a token that can be used to verify a customer email address
|
|
19
|
-
[**insert_customer**](CustomerApi.md#insert_customer) | **POST** /customer/customers | Insert a customer
|
|
20
|
-
[**merge_customer**](CustomerApi.md#merge_customer) | **PUT** /customer/customers/{customer_profile_oid}/merge | Merge customer into this customer
|
|
21
|
-
[**search_customer_profile_values**](CustomerApi.md#search_customer_profile_values) | **POST** /customer/search | Searches for all matching values (using POST)
|
|
22
|
-
[**update_customer**](CustomerApi.md#update_customer) | **PUT** /customer/customers/{customer_profile_oid} | Update a customer
|
|
23
|
-
[**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
|
|
24
|
-
[**validate_email_verification_token**](CustomerApi.md#validate_email_verification_token) | **POST** /customer/customers/email_verify/validate_token | Validate a token that can be used to verify a customer email address
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
#
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
#
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
#
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
###
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
#
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
customer_profile_oid
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
###
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
#
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
###
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
#
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
```
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
###
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
Retrieve
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
**
|
|
526
|
-
**
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
p
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
**
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
###
|
|
591
|
-
|
|
592
|
-
[
|
|
593
|
-
|
|
594
|
-
###
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
#
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
opts = {
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
#
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
```
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
**
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
[
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
#
|
|
761
|
-
|
|
762
|
-
|
|
763
|
-
|
|
764
|
-
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
|
|
770
|
-
|
|
771
|
-
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
#
|
|
787
|
-
|
|
788
|
-
rescue UltracartClient::ApiError => e
|
|
789
|
-
puts "
|
|
790
|
-
end
|
|
791
|
-
```
|
|
792
|
-
|
|
793
|
-
### Parameters
|
|
794
|
-
|
|
795
|
-
Name | Type | Description
|
|
796
|
-
|
|
797
|
-
**
|
|
798
|
-
**
|
|
799
|
-
**
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
|
|
816
|
-
|
|
817
|
-
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
|
|
823
|
-
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
|
|
848
|
-
|
|
849
|
-
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
|
|
854
|
-
|
|
855
|
-
|
|
856
|
-
|
|
857
|
-
|
|
858
|
-
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
#
|
|
865
|
-
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
###
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
|
|
875
|
-
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
|
|
880
|
-
|
|
881
|
-
|
|
882
|
-
|
|
883
|
-
|
|
884
|
-
|
|
885
|
-
|
|
886
|
-
|
|
887
|
-
|
|
888
|
-
|
|
889
|
-
|
|
890
|
-
|
|
891
|
-
|
|
892
|
-
|
|
893
|
-
|
|
894
|
-
|
|
895
|
-
|
|
896
|
-
|
|
897
|
-
|
|
898
|
-
|
|
899
|
-
|
|
900
|
-
|
|
901
|
-
|
|
902
|
-
|
|
903
|
-
|
|
904
|
-
|
|
905
|
-
|
|
906
|
-
|
|
907
|
-
|
|
908
|
-
|
|
909
|
-
|
|
910
|
-
|
|
911
|
-
|
|
912
|
-
|
|
913
|
-
|
|
914
|
-
|
|
915
|
-
|
|
916
|
-
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
|
|
920
|
-
|
|
921
|
-
|
|
922
|
-
|
|
923
|
-
|
|
924
|
-
|
|
925
|
-
|
|
926
|
-
|
|
927
|
-
|
|
928
|
-
|
|
929
|
-
|
|
930
|
-
|
|
931
|
-
|
|
932
|
-
|
|
933
|
-
|
|
934
|
-
|
|
935
|
-
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
|
|
939
|
-
|
|
940
|
-
|
|
941
|
-
|
|
942
|
-
|
|
943
|
-
|
|
944
|
-
|
|
945
|
-
|
|
946
|
-
|
|
947
|
-
|
|
948
|
-
|
|
949
|
-
|
|
950
|
-
|
|
951
|
-
|
|
952
|
-
###
|
|
953
|
-
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
|
|
958
|
-
|
|
959
|
-
|
|
960
|
-
|
|
961
|
-
|
|
962
|
-
|
|
963
|
-
|
|
964
|
-
|
|
965
|
-
|
|
966
|
-
|
|
967
|
-
|
|
968
|
-
|
|
969
|
-
|
|
970
|
-
|
|
971
|
-
|
|
972
|
-
|
|
973
|
-
|
|
974
|
-
|
|
975
|
-
|
|
976
|
-
|
|
977
|
-
|
|
978
|
-
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
|
|
983
|
-
|
|
984
|
-
|
|
985
|
-
|
|
986
|
-
#
|
|
987
|
-
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
|
|
991
|
-
|
|
992
|
-
|
|
993
|
-
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
|
|
997
|
-
|
|
998
|
-
|
|
999
|
-
|
|
1000
|
-
|
|
1001
|
-
|
|
1002
|
-
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1
|
+
# UltracartClient::CustomerApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**add_customer_store_credit**](CustomerApi.md#add_customer_store_credit) | **POST** /customer/customers/{customer_profile_oid}/store_credit | Adds store credit to a customer |
|
|
8
|
+
| [**adjust_internal_certificate**](CustomerApi.md#adjust_internal_certificate) | **POST** /customer/customers/{customer_profile_oid}/adjust_cashback_balance | Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed. |
|
|
9
|
+
| [**delete_customer**](CustomerApi.md#delete_customer) | **DELETE** /customer/customers/{customer_profile_oid} | Delete a customer |
|
|
10
|
+
| [**get_customer**](CustomerApi.md#get_customer) | **GET** /customer/customers/{customer_profile_oid} | Retrieve a customer |
|
|
11
|
+
| [**get_customer_by_email**](CustomerApi.md#get_customer_by_email) | **GET** /customer/customers/by_email/{email} | Retrieve a customer by Email |
|
|
12
|
+
| [**get_customer_editor_values**](CustomerApi.md#get_customer_editor_values) | **GET** /customer/editor_values | Retrieve values needed for a customer profile editor |
|
|
13
|
+
| [**get_customer_email_lists**](CustomerApi.md#get_customer_email_lists) | **GET** /customer/email_lists | Retrieve all email lists across all storefronts |
|
|
14
|
+
| [**get_customer_store_credit**](CustomerApi.md#get_customer_store_credit) | **GET** /customer/customers/{customer_profile_oid}/store_credit | Retrieve the customer store credit accumulated through loyalty programs |
|
|
15
|
+
| [**get_customers**](CustomerApi.md#get_customers) | **GET** /customer/customers | Retrieve customers |
|
|
16
|
+
| [**get_customers_by_query**](CustomerApi.md#get_customers_by_query) | **POST** /customer/customers/query | Retrieve customers by query |
|
|
17
|
+
| [**get_customers_for_data_tables**](CustomerApi.md#get_customers_for_data_tables) | **POST** /customer/customers/dataTables | Retrieve customers for DataTables plugin |
|
|
18
|
+
| [**get_email_verification_token**](CustomerApi.md#get_email_verification_token) | **POST** /customer/customers/email_verify/get_token | Create a token that can be used to verify a customer email address |
|
|
19
|
+
| [**insert_customer**](CustomerApi.md#insert_customer) | **POST** /customer/customers | Insert a customer |
|
|
20
|
+
| [**merge_customer**](CustomerApi.md#merge_customer) | **PUT** /customer/customers/{customer_profile_oid}/merge | Merge customer into this customer |
|
|
21
|
+
| [**search_customer_profile_values**](CustomerApi.md#search_customer_profile_values) | **POST** /customer/search | Searches for all matching values (using POST) |
|
|
22
|
+
| [**update_customer**](CustomerApi.md#update_customer) | **PUT** /customer/customers/{customer_profile_oid} | Update a customer |
|
|
23
|
+
| [**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 |
|
|
24
|
+
| [**validate_email_verification_token**](CustomerApi.md#validate_email_verification_token) | **POST** /customer/customers/email_verify/validate_token | Validate a token that can be used to verify a customer email address |
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
## add_customer_store_credit
|
|
28
|
+
|
|
29
|
+
> <BaseResponse> add_customer_store_credit(customer_profile_oid, store_credit_request)
|
|
30
|
+
|
|
31
|
+
Adds store credit to a customer
|
|
32
|
+
|
|
33
|
+
Adds store credit to a customer
|
|
34
|
+
|
|
35
|
+
### Examples
|
|
36
|
+
|
|
37
|
+
```ruby
|
|
38
|
+
require 'time'
|
|
39
|
+
require 'ultracart_api'
|
|
40
|
+
require 'json'
|
|
41
|
+
require 'yaml'
|
|
42
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
43
|
+
|
|
44
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
45
|
+
# As such, this might not be the best way to use this object.
|
|
46
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
47
|
+
|
|
48
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
49
|
+
customer_profile_oid = 56 # Integer | The customer oid to credit.
|
|
50
|
+
store_credit_request = UltracartClient::CustomerStoreCreditAddRequest.new # CustomerStoreCreditAddRequest | Store credit to add
|
|
51
|
+
|
|
52
|
+
begin
|
|
53
|
+
# Adds store credit to a customer
|
|
54
|
+
result = api_instance.add_customer_store_credit(customer_profile_oid, store_credit_request)
|
|
55
|
+
p result
|
|
56
|
+
rescue UltracartClient::ApiError => e
|
|
57
|
+
puts "Error when calling CustomerApi->add_customer_store_credit: #{e}"
|
|
58
|
+
end
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
#### Using the add_customer_store_credit_with_http_info variant
|
|
62
|
+
|
|
63
|
+
This returns an Array which contains the response data, status code and headers.
|
|
64
|
+
|
|
65
|
+
> <Array(<BaseResponse>, Integer, Hash)> add_customer_store_credit_with_http_info(customer_profile_oid, store_credit_request)
|
|
66
|
+
|
|
67
|
+
```ruby
|
|
68
|
+
begin
|
|
69
|
+
# Adds store credit to a customer
|
|
70
|
+
data, status_code, headers = api_instance.add_customer_store_credit_with_http_info(customer_profile_oid, store_credit_request)
|
|
71
|
+
p status_code # => 2xx
|
|
72
|
+
p headers # => { ... }
|
|
73
|
+
p data # => <BaseResponse>
|
|
74
|
+
rescue UltracartClient::ApiError => e
|
|
75
|
+
puts "Error when calling CustomerApi->add_customer_store_credit_with_http_info: #{e}"
|
|
76
|
+
end
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
### Parameters
|
|
80
|
+
|
|
81
|
+
| Name | Type | Description | Notes |
|
|
82
|
+
| ---- | ---- | ----------- | ----- |
|
|
83
|
+
| **customer_profile_oid** | **Integer** | The customer oid to credit. | |
|
|
84
|
+
| **store_credit_request** | [**CustomerStoreCreditAddRequest**](CustomerStoreCreditAddRequest.md) | Store credit to add | |
|
|
85
|
+
|
|
86
|
+
### Return type
|
|
87
|
+
|
|
88
|
+
[**BaseResponse**](BaseResponse.md)
|
|
89
|
+
|
|
90
|
+
### Authorization
|
|
91
|
+
|
|
92
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
93
|
+
|
|
94
|
+
### HTTP request headers
|
|
95
|
+
|
|
96
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
97
|
+
- **Accept**: application/json
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
## adjust_internal_certificate
|
|
101
|
+
|
|
102
|
+
> <AdjustInternalCertificateResponse> adjust_internal_certificate(customer_profile_oid, adjust_internal_certificate_request)
|
|
103
|
+
|
|
104
|
+
Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
|
|
105
|
+
|
|
106
|
+
Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
|
|
107
|
+
|
|
108
|
+
### Examples
|
|
109
|
+
|
|
110
|
+
```ruby
|
|
111
|
+
require 'time'
|
|
112
|
+
require 'ultracart_api'
|
|
113
|
+
require 'json'
|
|
114
|
+
require 'yaml'
|
|
115
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
116
|
+
|
|
117
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
118
|
+
# As such, this might not be the best way to use this object.
|
|
119
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
120
|
+
|
|
121
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
122
|
+
customer_profile_oid = 56 # Integer | The customer profile oid
|
|
123
|
+
adjust_internal_certificate_request = UltracartClient::AdjustInternalCertificateRequest.new # AdjustInternalCertificateRequest | adjustInternalCertificateRequest
|
|
124
|
+
|
|
125
|
+
begin
|
|
126
|
+
# Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
|
|
127
|
+
result = api_instance.adjust_internal_certificate(customer_profile_oid, adjust_internal_certificate_request)
|
|
128
|
+
p result
|
|
129
|
+
rescue UltracartClient::ApiError => e
|
|
130
|
+
puts "Error when calling CustomerApi->adjust_internal_certificate: #{e}"
|
|
131
|
+
end
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
#### Using the adjust_internal_certificate_with_http_info variant
|
|
135
|
+
|
|
136
|
+
This returns an Array which contains the response data, status code and headers.
|
|
137
|
+
|
|
138
|
+
> <Array(<AdjustInternalCertificateResponse>, Integer, Hash)> adjust_internal_certificate_with_http_info(customer_profile_oid, adjust_internal_certificate_request)
|
|
139
|
+
|
|
140
|
+
```ruby
|
|
141
|
+
begin
|
|
142
|
+
# Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
|
|
143
|
+
data, status_code, headers = api_instance.adjust_internal_certificate_with_http_info(customer_profile_oid, adjust_internal_certificate_request)
|
|
144
|
+
p status_code # => 2xx
|
|
145
|
+
p headers # => { ... }
|
|
146
|
+
p data # => <AdjustInternalCertificateResponse>
|
|
147
|
+
rescue UltracartClient::ApiError => e
|
|
148
|
+
puts "Error when calling CustomerApi->adjust_internal_certificate_with_http_info: #{e}"
|
|
149
|
+
end
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
### Parameters
|
|
153
|
+
|
|
154
|
+
| Name | Type | Description | Notes |
|
|
155
|
+
| ---- | ---- | ----------- | ----- |
|
|
156
|
+
| **customer_profile_oid** | **Integer** | The customer profile oid | |
|
|
157
|
+
| **adjust_internal_certificate_request** | [**AdjustInternalCertificateRequest**](AdjustInternalCertificateRequest.md) | adjustInternalCertificateRequest | |
|
|
158
|
+
|
|
159
|
+
### Return type
|
|
160
|
+
|
|
161
|
+
[**AdjustInternalCertificateResponse**](AdjustInternalCertificateResponse.md)
|
|
162
|
+
|
|
163
|
+
### Authorization
|
|
164
|
+
|
|
165
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
166
|
+
|
|
167
|
+
### HTTP request headers
|
|
168
|
+
|
|
169
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
170
|
+
- **Accept**: application/json
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
## delete_customer
|
|
174
|
+
|
|
175
|
+
> delete_customer(customer_profile_oid)
|
|
176
|
+
|
|
177
|
+
Delete a customer
|
|
178
|
+
|
|
179
|
+
Delete a customer on the UltraCart account.
|
|
180
|
+
|
|
181
|
+
### Examples
|
|
182
|
+
|
|
183
|
+
```ruby
|
|
184
|
+
require 'time'
|
|
185
|
+
require 'ultracart_api'
|
|
186
|
+
require 'json'
|
|
187
|
+
require 'yaml'
|
|
188
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
189
|
+
|
|
190
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
191
|
+
# As such, this might not be the best way to use this object.
|
|
192
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
193
|
+
|
|
194
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
195
|
+
customer_profile_oid = 56 # Integer | The customer_profile_oid to delete.
|
|
196
|
+
|
|
197
|
+
begin
|
|
198
|
+
# Delete a customer
|
|
199
|
+
api_instance.delete_customer(customer_profile_oid)
|
|
200
|
+
rescue UltracartClient::ApiError => e
|
|
201
|
+
puts "Error when calling CustomerApi->delete_customer: #{e}"
|
|
202
|
+
end
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
#### Using the delete_customer_with_http_info variant
|
|
206
|
+
|
|
207
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
208
|
+
|
|
209
|
+
> <Array(nil, Integer, Hash)> delete_customer_with_http_info(customer_profile_oid)
|
|
210
|
+
|
|
211
|
+
```ruby
|
|
212
|
+
begin
|
|
213
|
+
# Delete a customer
|
|
214
|
+
data, status_code, headers = api_instance.delete_customer_with_http_info(customer_profile_oid)
|
|
215
|
+
p status_code # => 2xx
|
|
216
|
+
p headers # => { ... }
|
|
217
|
+
p data # => nil
|
|
218
|
+
rescue UltracartClient::ApiError => e
|
|
219
|
+
puts "Error when calling CustomerApi->delete_customer_with_http_info: #{e}"
|
|
220
|
+
end
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
### Parameters
|
|
224
|
+
|
|
225
|
+
| Name | Type | Description | Notes |
|
|
226
|
+
| ---- | ---- | ----------- | ----- |
|
|
227
|
+
| **customer_profile_oid** | **Integer** | The customer_profile_oid to delete. | |
|
|
228
|
+
|
|
229
|
+
### Return type
|
|
230
|
+
|
|
231
|
+
nil (empty response body)
|
|
232
|
+
|
|
233
|
+
### Authorization
|
|
234
|
+
|
|
235
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
236
|
+
|
|
237
|
+
### HTTP request headers
|
|
238
|
+
|
|
239
|
+
- **Content-Type**: Not defined
|
|
240
|
+
- **Accept**: application/json
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
## get_customer
|
|
244
|
+
|
|
245
|
+
> <CustomerResponse> get_customer(customer_profile_oid, opts)
|
|
246
|
+
|
|
247
|
+
Retrieve a customer
|
|
248
|
+
|
|
249
|
+
Retrieves a single customer using the specified customer profile oid.
|
|
250
|
+
|
|
251
|
+
### Examples
|
|
252
|
+
|
|
253
|
+
```ruby
|
|
254
|
+
require 'time'
|
|
255
|
+
require 'ultracart_api'
|
|
256
|
+
require 'json'
|
|
257
|
+
require 'yaml'
|
|
258
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
259
|
+
|
|
260
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
261
|
+
# As such, this might not be the best way to use this object.
|
|
262
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
263
|
+
|
|
264
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
265
|
+
customer_profile_oid = 56 # Integer | The customer oid to retrieve.
|
|
266
|
+
opts = {
|
|
267
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
268
|
+
}
|
|
269
|
+
|
|
270
|
+
begin
|
|
271
|
+
# Retrieve a customer
|
|
272
|
+
result = api_instance.get_customer(customer_profile_oid, opts)
|
|
273
|
+
p result
|
|
274
|
+
rescue UltracartClient::ApiError => e
|
|
275
|
+
puts "Error when calling CustomerApi->get_customer: #{e}"
|
|
276
|
+
end
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
#### Using the get_customer_with_http_info variant
|
|
280
|
+
|
|
281
|
+
This returns an Array which contains the response data, status code and headers.
|
|
282
|
+
|
|
283
|
+
> <Array(<CustomerResponse>, Integer, Hash)> get_customer_with_http_info(customer_profile_oid, opts)
|
|
284
|
+
|
|
285
|
+
```ruby
|
|
286
|
+
begin
|
|
287
|
+
# Retrieve a customer
|
|
288
|
+
data, status_code, headers = api_instance.get_customer_with_http_info(customer_profile_oid, opts)
|
|
289
|
+
p status_code # => 2xx
|
|
290
|
+
p headers # => { ... }
|
|
291
|
+
p data # => <CustomerResponse>
|
|
292
|
+
rescue UltracartClient::ApiError => e
|
|
293
|
+
puts "Error when calling CustomerApi->get_customer_with_http_info: #{e}"
|
|
294
|
+
end
|
|
295
|
+
```
|
|
296
|
+
|
|
297
|
+
### Parameters
|
|
298
|
+
|
|
299
|
+
| Name | Type | Description | Notes |
|
|
300
|
+
| ---- | ---- | ----------- | ----- |
|
|
301
|
+
| **customer_profile_oid** | **Integer** | The customer oid to retrieve. | |
|
|
302
|
+
| **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
|
|
303
|
+
|
|
304
|
+
### Return type
|
|
305
|
+
|
|
306
|
+
[**CustomerResponse**](CustomerResponse.md)
|
|
307
|
+
|
|
308
|
+
### Authorization
|
|
309
|
+
|
|
310
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
311
|
+
|
|
312
|
+
### HTTP request headers
|
|
313
|
+
|
|
314
|
+
- **Content-Type**: Not defined
|
|
315
|
+
- **Accept**: application/json
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
## get_customer_by_email
|
|
319
|
+
|
|
320
|
+
> <CustomerResponse> get_customer_by_email(email, opts)
|
|
321
|
+
|
|
322
|
+
Retrieve a customer by Email
|
|
323
|
+
|
|
324
|
+
Retrieves a single customer using the specified customer email address.
|
|
325
|
+
|
|
326
|
+
### Examples
|
|
327
|
+
|
|
328
|
+
```ruby
|
|
329
|
+
require 'time'
|
|
330
|
+
require 'ultracart_api'
|
|
331
|
+
require 'json'
|
|
332
|
+
require 'yaml'
|
|
333
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
334
|
+
|
|
335
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
336
|
+
# As such, this might not be the best way to use this object.
|
|
337
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
338
|
+
|
|
339
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
340
|
+
email = 'email_example' # String | The email address of the customer to retrieve.
|
|
341
|
+
opts = {
|
|
342
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
343
|
+
}
|
|
344
|
+
|
|
345
|
+
begin
|
|
346
|
+
# Retrieve a customer by Email
|
|
347
|
+
result = api_instance.get_customer_by_email(email, opts)
|
|
348
|
+
p result
|
|
349
|
+
rescue UltracartClient::ApiError => e
|
|
350
|
+
puts "Error when calling CustomerApi->get_customer_by_email: #{e}"
|
|
351
|
+
end
|
|
352
|
+
```
|
|
353
|
+
|
|
354
|
+
#### Using the get_customer_by_email_with_http_info variant
|
|
355
|
+
|
|
356
|
+
This returns an Array which contains the response data, status code and headers.
|
|
357
|
+
|
|
358
|
+
> <Array(<CustomerResponse>, Integer, Hash)> get_customer_by_email_with_http_info(email, opts)
|
|
359
|
+
|
|
360
|
+
```ruby
|
|
361
|
+
begin
|
|
362
|
+
# Retrieve a customer by Email
|
|
363
|
+
data, status_code, headers = api_instance.get_customer_by_email_with_http_info(email, opts)
|
|
364
|
+
p status_code # => 2xx
|
|
365
|
+
p headers # => { ... }
|
|
366
|
+
p data # => <CustomerResponse>
|
|
367
|
+
rescue UltracartClient::ApiError => e
|
|
368
|
+
puts "Error when calling CustomerApi->get_customer_by_email_with_http_info: #{e}"
|
|
369
|
+
end
|
|
370
|
+
```
|
|
371
|
+
|
|
372
|
+
### Parameters
|
|
373
|
+
|
|
374
|
+
| Name | Type | Description | Notes |
|
|
375
|
+
| ---- | ---- | ----------- | ----- |
|
|
376
|
+
| **email** | **String** | The email address of the customer to retrieve. | |
|
|
377
|
+
| **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
|
|
378
|
+
|
|
379
|
+
### Return type
|
|
380
|
+
|
|
381
|
+
[**CustomerResponse**](CustomerResponse.md)
|
|
382
|
+
|
|
383
|
+
### Authorization
|
|
384
|
+
|
|
385
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
386
|
+
|
|
387
|
+
### HTTP request headers
|
|
388
|
+
|
|
389
|
+
- **Content-Type**: Not defined
|
|
390
|
+
- **Accept**: application/json
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
## get_customer_editor_values
|
|
394
|
+
|
|
395
|
+
> <CustomerEditorValues> get_customer_editor_values
|
|
396
|
+
|
|
397
|
+
Retrieve values needed for a customer profile editor
|
|
398
|
+
|
|
399
|
+
Retrieve values needed for a customer profile editor.
|
|
400
|
+
|
|
401
|
+
### Examples
|
|
402
|
+
|
|
403
|
+
```ruby
|
|
404
|
+
require 'time'
|
|
405
|
+
require 'ultracart_api'
|
|
406
|
+
require 'json'
|
|
407
|
+
require 'yaml'
|
|
408
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
409
|
+
|
|
410
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
411
|
+
# As such, this might not be the best way to use this object.
|
|
412
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
413
|
+
|
|
414
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
415
|
+
|
|
416
|
+
begin
|
|
417
|
+
# Retrieve values needed for a customer profile editor
|
|
418
|
+
result = api_instance.get_customer_editor_values
|
|
419
|
+
p result
|
|
420
|
+
rescue UltracartClient::ApiError => e
|
|
421
|
+
puts "Error when calling CustomerApi->get_customer_editor_values: #{e}"
|
|
422
|
+
end
|
|
423
|
+
```
|
|
424
|
+
|
|
425
|
+
#### Using the get_customer_editor_values_with_http_info variant
|
|
426
|
+
|
|
427
|
+
This returns an Array which contains the response data, status code and headers.
|
|
428
|
+
|
|
429
|
+
> <Array(<CustomerEditorValues>, Integer, Hash)> get_customer_editor_values_with_http_info
|
|
430
|
+
|
|
431
|
+
```ruby
|
|
432
|
+
begin
|
|
433
|
+
# Retrieve values needed for a customer profile editor
|
|
434
|
+
data, status_code, headers = api_instance.get_customer_editor_values_with_http_info
|
|
435
|
+
p status_code # => 2xx
|
|
436
|
+
p headers # => { ... }
|
|
437
|
+
p data # => <CustomerEditorValues>
|
|
438
|
+
rescue UltracartClient::ApiError => e
|
|
439
|
+
puts "Error when calling CustomerApi->get_customer_editor_values_with_http_info: #{e}"
|
|
440
|
+
end
|
|
441
|
+
```
|
|
442
|
+
|
|
443
|
+
### Parameters
|
|
444
|
+
|
|
445
|
+
This endpoint does not need any parameter.
|
|
446
|
+
|
|
447
|
+
### Return type
|
|
448
|
+
|
|
449
|
+
[**CustomerEditorValues**](CustomerEditorValues.md)
|
|
450
|
+
|
|
451
|
+
### Authorization
|
|
452
|
+
|
|
453
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
454
|
+
|
|
455
|
+
### HTTP request headers
|
|
456
|
+
|
|
457
|
+
- **Content-Type**: Not defined
|
|
458
|
+
- **Accept**: application/json
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
## get_customer_email_lists
|
|
462
|
+
|
|
463
|
+
> <EmailListsResponse> get_customer_email_lists
|
|
464
|
+
|
|
465
|
+
Retrieve all email lists across all storefronts
|
|
466
|
+
|
|
467
|
+
Retrieve all email lists across all storefronts
|
|
468
|
+
|
|
469
|
+
### Examples
|
|
470
|
+
|
|
471
|
+
```ruby
|
|
472
|
+
require 'time'
|
|
473
|
+
require 'ultracart_api'
|
|
474
|
+
require 'json'
|
|
475
|
+
require 'yaml'
|
|
476
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
477
|
+
|
|
478
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
479
|
+
# As such, this might not be the best way to use this object.
|
|
480
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
481
|
+
|
|
482
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
483
|
+
|
|
484
|
+
begin
|
|
485
|
+
# Retrieve all email lists across all storefronts
|
|
486
|
+
result = api_instance.get_customer_email_lists
|
|
487
|
+
p result
|
|
488
|
+
rescue UltracartClient::ApiError => e
|
|
489
|
+
puts "Error when calling CustomerApi->get_customer_email_lists: #{e}"
|
|
490
|
+
end
|
|
491
|
+
```
|
|
492
|
+
|
|
493
|
+
#### Using the get_customer_email_lists_with_http_info variant
|
|
494
|
+
|
|
495
|
+
This returns an Array which contains the response data, status code and headers.
|
|
496
|
+
|
|
497
|
+
> <Array(<EmailListsResponse>, Integer, Hash)> get_customer_email_lists_with_http_info
|
|
498
|
+
|
|
499
|
+
```ruby
|
|
500
|
+
begin
|
|
501
|
+
# Retrieve all email lists across all storefronts
|
|
502
|
+
data, status_code, headers = api_instance.get_customer_email_lists_with_http_info
|
|
503
|
+
p status_code # => 2xx
|
|
504
|
+
p headers # => { ... }
|
|
505
|
+
p data # => <EmailListsResponse>
|
|
506
|
+
rescue UltracartClient::ApiError => e
|
|
507
|
+
puts "Error when calling CustomerApi->get_customer_email_lists_with_http_info: #{e}"
|
|
508
|
+
end
|
|
509
|
+
```
|
|
510
|
+
|
|
511
|
+
### Parameters
|
|
512
|
+
|
|
513
|
+
This endpoint does not need any parameter.
|
|
514
|
+
|
|
515
|
+
### Return type
|
|
516
|
+
|
|
517
|
+
[**EmailListsResponse**](EmailListsResponse.md)
|
|
518
|
+
|
|
519
|
+
### Authorization
|
|
520
|
+
|
|
521
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
522
|
+
|
|
523
|
+
### HTTP request headers
|
|
524
|
+
|
|
525
|
+
- **Content-Type**: Not defined
|
|
526
|
+
- **Accept**: application/json
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
## get_customer_store_credit
|
|
530
|
+
|
|
531
|
+
> <CustomerStoreCreditResponse> get_customer_store_credit(customer_profile_oid)
|
|
532
|
+
|
|
533
|
+
Retrieve the customer store credit accumulated through loyalty programs
|
|
534
|
+
|
|
535
|
+
Retrieve the customer store credit accumulated through loyalty programs
|
|
536
|
+
|
|
537
|
+
### Examples
|
|
538
|
+
|
|
539
|
+
```ruby
|
|
540
|
+
require 'time'
|
|
541
|
+
require 'ultracart_api'
|
|
542
|
+
require 'json'
|
|
543
|
+
require 'yaml'
|
|
544
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
545
|
+
|
|
546
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
547
|
+
# As such, this might not be the best way to use this object.
|
|
548
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
549
|
+
|
|
550
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
551
|
+
customer_profile_oid = 56 # Integer | The customer oid to retrieve.
|
|
552
|
+
|
|
553
|
+
begin
|
|
554
|
+
# Retrieve the customer store credit accumulated through loyalty programs
|
|
555
|
+
result = api_instance.get_customer_store_credit(customer_profile_oid)
|
|
556
|
+
p result
|
|
557
|
+
rescue UltracartClient::ApiError => e
|
|
558
|
+
puts "Error when calling CustomerApi->get_customer_store_credit: #{e}"
|
|
559
|
+
end
|
|
560
|
+
```
|
|
561
|
+
|
|
562
|
+
#### Using the get_customer_store_credit_with_http_info variant
|
|
563
|
+
|
|
564
|
+
This returns an Array which contains the response data, status code and headers.
|
|
565
|
+
|
|
566
|
+
> <Array(<CustomerStoreCreditResponse>, Integer, Hash)> get_customer_store_credit_with_http_info(customer_profile_oid)
|
|
567
|
+
|
|
568
|
+
```ruby
|
|
569
|
+
begin
|
|
570
|
+
# Retrieve the customer store credit accumulated through loyalty programs
|
|
571
|
+
data, status_code, headers = api_instance.get_customer_store_credit_with_http_info(customer_profile_oid)
|
|
572
|
+
p status_code # => 2xx
|
|
573
|
+
p headers # => { ... }
|
|
574
|
+
p data # => <CustomerStoreCreditResponse>
|
|
575
|
+
rescue UltracartClient::ApiError => e
|
|
576
|
+
puts "Error when calling CustomerApi->get_customer_store_credit_with_http_info: #{e}"
|
|
577
|
+
end
|
|
578
|
+
```
|
|
579
|
+
|
|
580
|
+
### Parameters
|
|
581
|
+
|
|
582
|
+
| Name | Type | Description | Notes |
|
|
583
|
+
| ---- | ---- | ----------- | ----- |
|
|
584
|
+
| **customer_profile_oid** | **Integer** | The customer oid to retrieve. | |
|
|
585
|
+
|
|
586
|
+
### Return type
|
|
587
|
+
|
|
588
|
+
[**CustomerStoreCreditResponse**](CustomerStoreCreditResponse.md)
|
|
589
|
+
|
|
590
|
+
### Authorization
|
|
591
|
+
|
|
592
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
593
|
+
|
|
594
|
+
### HTTP request headers
|
|
595
|
+
|
|
596
|
+
- **Content-Type**: Not defined
|
|
597
|
+
- **Accept**: application/json
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
## get_customers
|
|
601
|
+
|
|
602
|
+
> <CustomersResponse> get_customers(opts)
|
|
603
|
+
|
|
604
|
+
Retrieve customers
|
|
605
|
+
|
|
606
|
+
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.
|
|
607
|
+
|
|
608
|
+
### Examples
|
|
609
|
+
|
|
610
|
+
```ruby
|
|
611
|
+
require 'time'
|
|
612
|
+
require 'ultracart_api'
|
|
613
|
+
require 'json'
|
|
614
|
+
require 'yaml'
|
|
615
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
616
|
+
|
|
617
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
618
|
+
# As such, this might not be the best way to use this object.
|
|
619
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
620
|
+
|
|
621
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
622
|
+
opts = {
|
|
623
|
+
email: 'email_example', # String | Email
|
|
624
|
+
qb_class: 'qb_class_example', # String | Quickbooks class
|
|
625
|
+
quickbooks_code: 'quickbooks_code_example', # String | Quickbooks code
|
|
626
|
+
last_modified_dts_start: 'last_modified_dts_start_example', # String | Last modified date start
|
|
627
|
+
last_modified_dts_end: 'last_modified_dts_end_example', # String | Last modified date end
|
|
628
|
+
signup_dts_start: 'signup_dts_start_example', # String | Signup date start
|
|
629
|
+
signup_dts_end: 'signup_dts_end_example', # String | Signup date end
|
|
630
|
+
billing_first_name: 'billing_first_name_example', # String | Billing first name
|
|
631
|
+
billing_last_name: 'billing_last_name_example', # String | Billing last name
|
|
632
|
+
billing_company: 'billing_company_example', # String | Billing company
|
|
633
|
+
billing_city: 'billing_city_example', # String | Billing city
|
|
634
|
+
billing_state: 'billing_state_example', # String | Billing state
|
|
635
|
+
billing_postal_code: 'billing_postal_code_example', # String | Billing postal code
|
|
636
|
+
billing_country_code: 'billing_country_code_example', # String | Billing country code
|
|
637
|
+
billing_day_phone: 'billing_day_phone_example', # String | Billing day phone
|
|
638
|
+
billing_evening_phone: 'billing_evening_phone_example', # String | Billing evening phone
|
|
639
|
+
shipping_first_name: 'shipping_first_name_example', # String | Shipping first name
|
|
640
|
+
shipping_last_name: 'shipping_last_name_example', # String | Shipping last name
|
|
641
|
+
shipping_company: 'shipping_company_example', # String | Shipping company
|
|
642
|
+
shipping_city: 'shipping_city_example', # String | Shipping city
|
|
643
|
+
shipping_state: 'shipping_state_example', # String | Shipping state
|
|
644
|
+
shipping_postal_code: 'shipping_postal_code_example', # String | Shipping postal code
|
|
645
|
+
shipping_country_code: 'shipping_country_code_example', # String | Shipping country code
|
|
646
|
+
shipping_day_phone: 'shipping_day_phone_example', # String | Shipping day phone
|
|
647
|
+
shipping_evening_phone: 'shipping_evening_phone_example', # String | Shipping evening phone
|
|
648
|
+
pricing_tier_oid: 56, # Integer | Pricing tier oid
|
|
649
|
+
pricing_tier_name: 'pricing_tier_name_example', # String | Pricing tier name
|
|
650
|
+
_limit: 56, # Integer | The maximum number of records to return on this one API call. (Max 200)
|
|
651
|
+
_offset: 56, # Integer | Pagination of the record set. Offset is a zero based index.
|
|
652
|
+
_since: '_since_example', # String | Fetch customers that have been created/modified since this date/time.
|
|
653
|
+
_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.
|
|
654
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
655
|
+
}
|
|
656
|
+
|
|
657
|
+
begin
|
|
658
|
+
# Retrieve customers
|
|
659
|
+
result = api_instance.get_customers(opts)
|
|
660
|
+
p result
|
|
661
|
+
rescue UltracartClient::ApiError => e
|
|
662
|
+
puts "Error when calling CustomerApi->get_customers: #{e}"
|
|
663
|
+
end
|
|
664
|
+
```
|
|
665
|
+
|
|
666
|
+
#### Using the get_customers_with_http_info variant
|
|
667
|
+
|
|
668
|
+
This returns an Array which contains the response data, status code and headers.
|
|
669
|
+
|
|
670
|
+
> <Array(<CustomersResponse>, Integer, Hash)> get_customers_with_http_info(opts)
|
|
671
|
+
|
|
672
|
+
```ruby
|
|
673
|
+
begin
|
|
674
|
+
# Retrieve customers
|
|
675
|
+
data, status_code, headers = api_instance.get_customers_with_http_info(opts)
|
|
676
|
+
p status_code # => 2xx
|
|
677
|
+
p headers # => { ... }
|
|
678
|
+
p data # => <CustomersResponse>
|
|
679
|
+
rescue UltracartClient::ApiError => e
|
|
680
|
+
puts "Error when calling CustomerApi->get_customers_with_http_info: #{e}"
|
|
681
|
+
end
|
|
682
|
+
```
|
|
683
|
+
|
|
684
|
+
### Parameters
|
|
685
|
+
|
|
686
|
+
| Name | Type | Description | Notes |
|
|
687
|
+
| ---- | ---- | ----------- | ----- |
|
|
688
|
+
| **email** | **String** | Email | [optional] |
|
|
689
|
+
| **qb_class** | **String** | Quickbooks class | [optional] |
|
|
690
|
+
| **quickbooks_code** | **String** | Quickbooks code | [optional] |
|
|
691
|
+
| **last_modified_dts_start** | **String** | Last modified date start | [optional] |
|
|
692
|
+
| **last_modified_dts_end** | **String** | Last modified date end | [optional] |
|
|
693
|
+
| **signup_dts_start** | **String** | Signup date start | [optional] |
|
|
694
|
+
| **signup_dts_end** | **String** | Signup date end | [optional] |
|
|
695
|
+
| **billing_first_name** | **String** | Billing first name | [optional] |
|
|
696
|
+
| **billing_last_name** | **String** | Billing last name | [optional] |
|
|
697
|
+
| **billing_company** | **String** | Billing company | [optional] |
|
|
698
|
+
| **billing_city** | **String** | Billing city | [optional] |
|
|
699
|
+
| **billing_state** | **String** | Billing state | [optional] |
|
|
700
|
+
| **billing_postal_code** | **String** | Billing postal code | [optional] |
|
|
701
|
+
| **billing_country_code** | **String** | Billing country code | [optional] |
|
|
702
|
+
| **billing_day_phone** | **String** | Billing day phone | [optional] |
|
|
703
|
+
| **billing_evening_phone** | **String** | Billing evening phone | [optional] |
|
|
704
|
+
| **shipping_first_name** | **String** | Shipping first name | [optional] |
|
|
705
|
+
| **shipping_last_name** | **String** | Shipping last name | [optional] |
|
|
706
|
+
| **shipping_company** | **String** | Shipping company | [optional] |
|
|
707
|
+
| **shipping_city** | **String** | Shipping city | [optional] |
|
|
708
|
+
| **shipping_state** | **String** | Shipping state | [optional] |
|
|
709
|
+
| **shipping_postal_code** | **String** | Shipping postal code | [optional] |
|
|
710
|
+
| **shipping_country_code** | **String** | Shipping country code | [optional] |
|
|
711
|
+
| **shipping_day_phone** | **String** | Shipping day phone | [optional] |
|
|
712
|
+
| **shipping_evening_phone** | **String** | Shipping evening phone | [optional] |
|
|
713
|
+
| **pricing_tier_oid** | **Integer** | Pricing tier oid | [optional] |
|
|
714
|
+
| **pricing_tier_name** | **String** | Pricing tier name | [optional] |
|
|
715
|
+
| **_limit** | **Integer** | The maximum number of records to return on this one API call. (Max 200) | [optional][default to 100] |
|
|
716
|
+
| **_offset** | **Integer** | Pagination of the record set. Offset is a zero based index. | [optional][default to 0] |
|
|
717
|
+
| **_since** | **String** | Fetch customers that have been created/modified since this date/time. | [optional] |
|
|
718
|
+
| **_sort** | **String** | The sort order of the customers. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional] |
|
|
719
|
+
| **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
|
|
720
|
+
|
|
721
|
+
### Return type
|
|
722
|
+
|
|
723
|
+
[**CustomersResponse**](CustomersResponse.md)
|
|
724
|
+
|
|
725
|
+
### Authorization
|
|
726
|
+
|
|
727
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
728
|
+
|
|
729
|
+
### HTTP request headers
|
|
730
|
+
|
|
731
|
+
- **Content-Type**: Not defined
|
|
732
|
+
- **Accept**: application/json
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
## get_customers_by_query
|
|
736
|
+
|
|
737
|
+
> <CustomersResponse> get_customers_by_query(customer_query, opts)
|
|
738
|
+
|
|
739
|
+
Retrieve customers by query
|
|
740
|
+
|
|
741
|
+
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.
|
|
742
|
+
|
|
743
|
+
### Examples
|
|
744
|
+
|
|
745
|
+
```ruby
|
|
746
|
+
require 'time'
|
|
747
|
+
require 'ultracart_api'
|
|
748
|
+
require 'json'
|
|
749
|
+
require 'yaml'
|
|
750
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
751
|
+
|
|
752
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
753
|
+
# As such, this might not be the best way to use this object.
|
|
754
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
755
|
+
|
|
756
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
757
|
+
customer_query = UltracartClient::CustomerQuery.new # CustomerQuery | Customer query
|
|
758
|
+
opts = {
|
|
759
|
+
_limit: 56, # Integer | The maximum number of records to return on this one API call. (Max 200)
|
|
760
|
+
_offset: 56, # Integer | Pagination of the record set. Offset is a zero based index.
|
|
761
|
+
_since: '_since_example', # String | Fetch customers that have been created/modified since this date/time.
|
|
762
|
+
_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.
|
|
763
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
764
|
+
}
|
|
765
|
+
|
|
766
|
+
begin
|
|
767
|
+
# Retrieve customers by query
|
|
768
|
+
result = api_instance.get_customers_by_query(customer_query, opts)
|
|
769
|
+
p result
|
|
770
|
+
rescue UltracartClient::ApiError => e
|
|
771
|
+
puts "Error when calling CustomerApi->get_customers_by_query: #{e}"
|
|
772
|
+
end
|
|
773
|
+
```
|
|
774
|
+
|
|
775
|
+
#### Using the get_customers_by_query_with_http_info variant
|
|
776
|
+
|
|
777
|
+
This returns an Array which contains the response data, status code and headers.
|
|
778
|
+
|
|
779
|
+
> <Array(<CustomersResponse>, Integer, Hash)> get_customers_by_query_with_http_info(customer_query, opts)
|
|
780
|
+
|
|
781
|
+
```ruby
|
|
782
|
+
begin
|
|
783
|
+
# Retrieve customers by query
|
|
784
|
+
data, status_code, headers = api_instance.get_customers_by_query_with_http_info(customer_query, opts)
|
|
785
|
+
p status_code # => 2xx
|
|
786
|
+
p headers # => { ... }
|
|
787
|
+
p data # => <CustomersResponse>
|
|
788
|
+
rescue UltracartClient::ApiError => e
|
|
789
|
+
puts "Error when calling CustomerApi->get_customers_by_query_with_http_info: #{e}"
|
|
790
|
+
end
|
|
791
|
+
```
|
|
792
|
+
|
|
793
|
+
### Parameters
|
|
794
|
+
|
|
795
|
+
| Name | Type | Description | Notes |
|
|
796
|
+
| ---- | ---- | ----------- | ----- |
|
|
797
|
+
| **customer_query** | [**CustomerQuery**](CustomerQuery.md) | Customer query | |
|
|
798
|
+
| **_limit** | **Integer** | The maximum number of records to return on this one API call. (Max 200) | [optional][default to 100] |
|
|
799
|
+
| **_offset** | **Integer** | Pagination of the record set. Offset is a zero based index. | [optional][default to 0] |
|
|
800
|
+
| **_since** | **String** | Fetch customers that have been created/modified since this date/time. | [optional] |
|
|
801
|
+
| **_sort** | **String** | The sort order of the customers. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional] |
|
|
802
|
+
| **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
|
|
803
|
+
|
|
804
|
+
### Return type
|
|
805
|
+
|
|
806
|
+
[**CustomersResponse**](CustomersResponse.md)
|
|
807
|
+
|
|
808
|
+
### Authorization
|
|
809
|
+
|
|
810
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
811
|
+
|
|
812
|
+
### HTTP request headers
|
|
813
|
+
|
|
814
|
+
- **Content-Type**: application/json
|
|
815
|
+
- **Accept**: application/json
|
|
816
|
+
|
|
817
|
+
|
|
818
|
+
## get_customers_for_data_tables
|
|
819
|
+
|
|
820
|
+
> <DataTablesServerSideResponse> get_customers_for_data_tables(opts)
|
|
821
|
+
|
|
822
|
+
Retrieve customers for DataTables plugin
|
|
823
|
+
|
|
824
|
+
Retrieves customers from the account. If no searches are specified, all customers will be returned.
|
|
825
|
+
|
|
826
|
+
### Examples
|
|
827
|
+
|
|
828
|
+
```ruby
|
|
829
|
+
require 'time'
|
|
830
|
+
require 'ultracart_api'
|
|
831
|
+
require 'json'
|
|
832
|
+
require 'yaml'
|
|
833
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
834
|
+
|
|
835
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
836
|
+
# As such, this might not be the best way to use this object.
|
|
837
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
838
|
+
|
|
839
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
840
|
+
opts = {
|
|
841
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
842
|
+
}
|
|
843
|
+
|
|
844
|
+
begin
|
|
845
|
+
# Retrieve customers for DataTables plugin
|
|
846
|
+
result = api_instance.get_customers_for_data_tables(opts)
|
|
847
|
+
p result
|
|
848
|
+
rescue UltracartClient::ApiError => e
|
|
849
|
+
puts "Error when calling CustomerApi->get_customers_for_data_tables: #{e}"
|
|
850
|
+
end
|
|
851
|
+
```
|
|
852
|
+
|
|
853
|
+
#### Using the get_customers_for_data_tables_with_http_info variant
|
|
854
|
+
|
|
855
|
+
This returns an Array which contains the response data, status code and headers.
|
|
856
|
+
|
|
857
|
+
> <Array(<DataTablesServerSideResponse>, Integer, Hash)> get_customers_for_data_tables_with_http_info(opts)
|
|
858
|
+
|
|
859
|
+
```ruby
|
|
860
|
+
begin
|
|
861
|
+
# Retrieve customers for DataTables plugin
|
|
862
|
+
data, status_code, headers = api_instance.get_customers_for_data_tables_with_http_info(opts)
|
|
863
|
+
p status_code # => 2xx
|
|
864
|
+
p headers # => { ... }
|
|
865
|
+
p data # => <DataTablesServerSideResponse>
|
|
866
|
+
rescue UltracartClient::ApiError => e
|
|
867
|
+
puts "Error when calling CustomerApi->get_customers_for_data_tables_with_http_info: #{e}"
|
|
868
|
+
end
|
|
869
|
+
```
|
|
870
|
+
|
|
871
|
+
### Parameters
|
|
872
|
+
|
|
873
|
+
| Name | Type | Description | Notes |
|
|
874
|
+
| ---- | ---- | ----------- | ----- |
|
|
875
|
+
| **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
|
|
876
|
+
|
|
877
|
+
### Return type
|
|
878
|
+
|
|
879
|
+
[**DataTablesServerSideResponse**](DataTablesServerSideResponse.md)
|
|
880
|
+
|
|
881
|
+
### Authorization
|
|
882
|
+
|
|
883
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
884
|
+
|
|
885
|
+
### HTTP request headers
|
|
886
|
+
|
|
887
|
+
- **Content-Type**: Not defined
|
|
888
|
+
- **Accept**: application/json
|
|
889
|
+
|
|
890
|
+
|
|
891
|
+
## get_email_verification_token
|
|
892
|
+
|
|
893
|
+
> <EmailVerifyTokenResponse> get_email_verification_token(token_request)
|
|
894
|
+
|
|
895
|
+
Create a token that can be used to verify a customer email address
|
|
896
|
+
|
|
897
|
+
Create a token that can be used to verify a customer email address. The implementation of how a customer interacts with this token is left to the merchant.
|
|
898
|
+
|
|
899
|
+
### Examples
|
|
900
|
+
|
|
901
|
+
```ruby
|
|
902
|
+
require 'time'
|
|
903
|
+
require 'ultracart_api'
|
|
904
|
+
require 'json'
|
|
905
|
+
require 'yaml'
|
|
906
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
907
|
+
|
|
908
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
909
|
+
# As such, this might not be the best way to use this object.
|
|
910
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
911
|
+
|
|
912
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
913
|
+
token_request = UltracartClient::EmailVerifyTokenRequest.new # EmailVerifyTokenRequest | Token request
|
|
914
|
+
|
|
915
|
+
begin
|
|
916
|
+
# Create a token that can be used to verify a customer email address
|
|
917
|
+
result = api_instance.get_email_verification_token(token_request)
|
|
918
|
+
p result
|
|
919
|
+
rescue UltracartClient::ApiError => e
|
|
920
|
+
puts "Error when calling CustomerApi->get_email_verification_token: #{e}"
|
|
921
|
+
end
|
|
922
|
+
```
|
|
923
|
+
|
|
924
|
+
#### Using the get_email_verification_token_with_http_info variant
|
|
925
|
+
|
|
926
|
+
This returns an Array which contains the response data, status code and headers.
|
|
927
|
+
|
|
928
|
+
> <Array(<EmailVerifyTokenResponse>, Integer, Hash)> get_email_verification_token_with_http_info(token_request)
|
|
929
|
+
|
|
930
|
+
```ruby
|
|
931
|
+
begin
|
|
932
|
+
# Create a token that can be used to verify a customer email address
|
|
933
|
+
data, status_code, headers = api_instance.get_email_verification_token_with_http_info(token_request)
|
|
934
|
+
p status_code # => 2xx
|
|
935
|
+
p headers # => { ... }
|
|
936
|
+
p data # => <EmailVerifyTokenResponse>
|
|
937
|
+
rescue UltracartClient::ApiError => e
|
|
938
|
+
puts "Error when calling CustomerApi->get_email_verification_token_with_http_info: #{e}"
|
|
939
|
+
end
|
|
940
|
+
```
|
|
941
|
+
|
|
942
|
+
### Parameters
|
|
943
|
+
|
|
944
|
+
| Name | Type | Description | Notes |
|
|
945
|
+
| ---- | ---- | ----------- | ----- |
|
|
946
|
+
| **token_request** | [**EmailVerifyTokenRequest**](EmailVerifyTokenRequest.md) | Token request | |
|
|
947
|
+
|
|
948
|
+
### Return type
|
|
949
|
+
|
|
950
|
+
[**EmailVerifyTokenResponse**](EmailVerifyTokenResponse.md)
|
|
951
|
+
|
|
952
|
+
### Authorization
|
|
953
|
+
|
|
954
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
955
|
+
|
|
956
|
+
### HTTP request headers
|
|
957
|
+
|
|
958
|
+
- **Content-Type**: application/json
|
|
959
|
+
- **Accept**: application/json
|
|
960
|
+
|
|
961
|
+
|
|
962
|
+
## insert_customer
|
|
963
|
+
|
|
964
|
+
> <CustomerResponse> insert_customer(customer, opts)
|
|
965
|
+
|
|
966
|
+
Insert a customer
|
|
967
|
+
|
|
968
|
+
Insert a customer on the UltraCart account.
|
|
969
|
+
|
|
970
|
+
### Examples
|
|
971
|
+
|
|
972
|
+
```ruby
|
|
973
|
+
require 'time'
|
|
974
|
+
require 'ultracart_api'
|
|
975
|
+
require 'json'
|
|
976
|
+
require 'yaml'
|
|
977
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
978
|
+
|
|
979
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
980
|
+
# As such, this might not be the best way to use this object.
|
|
981
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
982
|
+
|
|
983
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
984
|
+
customer = UltracartClient::Customer.new # Customer | Customer to insert
|
|
985
|
+
opts = {
|
|
986
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
987
|
+
}
|
|
988
|
+
|
|
989
|
+
begin
|
|
990
|
+
# Insert a customer
|
|
991
|
+
result = api_instance.insert_customer(customer, opts)
|
|
992
|
+
p result
|
|
993
|
+
rescue UltracartClient::ApiError => e
|
|
994
|
+
puts "Error when calling CustomerApi->insert_customer: #{e}"
|
|
995
|
+
end
|
|
996
|
+
```
|
|
997
|
+
|
|
998
|
+
#### Using the insert_customer_with_http_info variant
|
|
999
|
+
|
|
1000
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1001
|
+
|
|
1002
|
+
> <Array(<CustomerResponse>, Integer, Hash)> insert_customer_with_http_info(customer, opts)
|
|
1003
|
+
|
|
1004
|
+
```ruby
|
|
1005
|
+
begin
|
|
1006
|
+
# Insert a customer
|
|
1007
|
+
data, status_code, headers = api_instance.insert_customer_with_http_info(customer, opts)
|
|
1008
|
+
p status_code # => 2xx
|
|
1009
|
+
p headers # => { ... }
|
|
1010
|
+
p data # => <CustomerResponse>
|
|
1011
|
+
rescue UltracartClient::ApiError => e
|
|
1012
|
+
puts "Error when calling CustomerApi->insert_customer_with_http_info: #{e}"
|
|
1013
|
+
end
|
|
1014
|
+
```
|
|
1015
|
+
|
|
1016
|
+
### Parameters
|
|
1017
|
+
|
|
1018
|
+
| Name | Type | Description | Notes |
|
|
1019
|
+
| ---- | ---- | ----------- | ----- |
|
|
1020
|
+
| **customer** | [**Customer**](Customer.md) | Customer to insert | |
|
|
1021
|
+
| **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
|
|
1022
|
+
|
|
1023
|
+
### Return type
|
|
1024
|
+
|
|
1025
|
+
[**CustomerResponse**](CustomerResponse.md)
|
|
1026
|
+
|
|
1027
|
+
### Authorization
|
|
1028
|
+
|
|
1029
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1030
|
+
|
|
1031
|
+
### HTTP request headers
|
|
1032
|
+
|
|
1033
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
1034
|
+
- **Accept**: application/json
|
|
1035
|
+
|
|
1036
|
+
|
|
1037
|
+
## merge_customer
|
|
1038
|
+
|
|
1039
|
+
> merge_customer(customer_profile_oid, customer, opts)
|
|
1040
|
+
|
|
1041
|
+
Merge customer into this customer
|
|
1042
|
+
|
|
1043
|
+
Merge customer into this customer.
|
|
1044
|
+
|
|
1045
|
+
### Examples
|
|
1046
|
+
|
|
1047
|
+
```ruby
|
|
1048
|
+
require 'time'
|
|
1049
|
+
require 'ultracart_api'
|
|
1050
|
+
require 'json'
|
|
1051
|
+
require 'yaml'
|
|
1052
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
1053
|
+
|
|
1054
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
1055
|
+
# As such, this might not be the best way to use this object.
|
|
1056
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
1057
|
+
|
|
1058
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
1059
|
+
customer_profile_oid = 56 # Integer | The customer_profile_oid to update.
|
|
1060
|
+
customer = UltracartClient::CustomerMergeRequest.new # CustomerMergeRequest | Customer to merge into this profile.
|
|
1061
|
+
opts = {
|
|
1062
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
1063
|
+
}
|
|
1064
|
+
|
|
1065
|
+
begin
|
|
1066
|
+
# Merge customer into this customer
|
|
1067
|
+
api_instance.merge_customer(customer_profile_oid, customer, opts)
|
|
1068
|
+
rescue UltracartClient::ApiError => e
|
|
1069
|
+
puts "Error when calling CustomerApi->merge_customer: #{e}"
|
|
1070
|
+
end
|
|
1071
|
+
```
|
|
1072
|
+
|
|
1073
|
+
#### Using the merge_customer_with_http_info variant
|
|
1074
|
+
|
|
1075
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
1076
|
+
|
|
1077
|
+
> <Array(nil, Integer, Hash)> merge_customer_with_http_info(customer_profile_oid, customer, opts)
|
|
1078
|
+
|
|
1079
|
+
```ruby
|
|
1080
|
+
begin
|
|
1081
|
+
# Merge customer into this customer
|
|
1082
|
+
data, status_code, headers = api_instance.merge_customer_with_http_info(customer_profile_oid, customer, opts)
|
|
1083
|
+
p status_code # => 2xx
|
|
1084
|
+
p headers # => { ... }
|
|
1085
|
+
p data # => nil
|
|
1086
|
+
rescue UltracartClient::ApiError => e
|
|
1087
|
+
puts "Error when calling CustomerApi->merge_customer_with_http_info: #{e}"
|
|
1088
|
+
end
|
|
1089
|
+
```
|
|
1090
|
+
|
|
1091
|
+
### Parameters
|
|
1092
|
+
|
|
1093
|
+
| Name | Type | Description | Notes |
|
|
1094
|
+
| ---- | ---- | ----------- | ----- |
|
|
1095
|
+
| **customer_profile_oid** | **Integer** | The customer_profile_oid to update. | |
|
|
1096
|
+
| **customer** | [**CustomerMergeRequest**](CustomerMergeRequest.md) | Customer to merge into this profile. | |
|
|
1097
|
+
| **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
|
|
1098
|
+
|
|
1099
|
+
### Return type
|
|
1100
|
+
|
|
1101
|
+
nil (empty response body)
|
|
1102
|
+
|
|
1103
|
+
### Authorization
|
|
1104
|
+
|
|
1105
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1106
|
+
|
|
1107
|
+
### HTTP request headers
|
|
1108
|
+
|
|
1109
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
1110
|
+
- **Accept**: application/json
|
|
1111
|
+
|
|
1112
|
+
|
|
1113
|
+
## search_customer_profile_values
|
|
1114
|
+
|
|
1115
|
+
> <LookupResponse> search_customer_profile_values(lookup_request)
|
|
1116
|
+
|
|
1117
|
+
Searches for all matching values (using POST)
|
|
1118
|
+
|
|
1119
|
+
### Examples
|
|
1120
|
+
|
|
1121
|
+
```ruby
|
|
1122
|
+
require 'time'
|
|
1123
|
+
require 'ultracart_api'
|
|
1124
|
+
require 'json'
|
|
1125
|
+
require 'yaml'
|
|
1126
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
1127
|
+
|
|
1128
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
1129
|
+
# As such, this might not be the best way to use this object.
|
|
1130
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
1131
|
+
|
|
1132
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
1133
|
+
lookup_request = UltracartClient::LookupRequest.new # LookupRequest | LookupRequest
|
|
1134
|
+
|
|
1135
|
+
begin
|
|
1136
|
+
# Searches for all matching values (using POST)
|
|
1137
|
+
result = api_instance.search_customer_profile_values(lookup_request)
|
|
1138
|
+
p result
|
|
1139
|
+
rescue UltracartClient::ApiError => e
|
|
1140
|
+
puts "Error when calling CustomerApi->search_customer_profile_values: #{e}"
|
|
1141
|
+
end
|
|
1142
|
+
```
|
|
1143
|
+
|
|
1144
|
+
#### Using the search_customer_profile_values_with_http_info variant
|
|
1145
|
+
|
|
1146
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1147
|
+
|
|
1148
|
+
> <Array(<LookupResponse>, Integer, Hash)> search_customer_profile_values_with_http_info(lookup_request)
|
|
1149
|
+
|
|
1150
|
+
```ruby
|
|
1151
|
+
begin
|
|
1152
|
+
# Searches for all matching values (using POST)
|
|
1153
|
+
data, status_code, headers = api_instance.search_customer_profile_values_with_http_info(lookup_request)
|
|
1154
|
+
p status_code # => 2xx
|
|
1155
|
+
p headers # => { ... }
|
|
1156
|
+
p data # => <LookupResponse>
|
|
1157
|
+
rescue UltracartClient::ApiError => e
|
|
1158
|
+
puts "Error when calling CustomerApi->search_customer_profile_values_with_http_info: #{e}"
|
|
1159
|
+
end
|
|
1160
|
+
```
|
|
1161
|
+
|
|
1162
|
+
### Parameters
|
|
1163
|
+
|
|
1164
|
+
| Name | Type | Description | Notes |
|
|
1165
|
+
| ---- | ---- | ----------- | ----- |
|
|
1166
|
+
| **lookup_request** | [**LookupRequest**](LookupRequest.md) | LookupRequest | |
|
|
1167
|
+
|
|
1168
|
+
### Return type
|
|
1169
|
+
|
|
1170
|
+
[**LookupResponse**](LookupResponse.md)
|
|
1171
|
+
|
|
1172
|
+
### Authorization
|
|
1173
|
+
|
|
1174
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1175
|
+
|
|
1176
|
+
### HTTP request headers
|
|
1177
|
+
|
|
1178
|
+
- **Content-Type**: application/json
|
|
1179
|
+
- **Accept**: application/json
|
|
1180
|
+
|
|
1181
|
+
|
|
1182
|
+
## update_customer
|
|
1183
|
+
|
|
1184
|
+
> <CustomerResponse> update_customer(customer_profile_oid, customer, opts)
|
|
1185
|
+
|
|
1186
|
+
Update a customer
|
|
1187
|
+
|
|
1188
|
+
Update a customer on the UltraCart account.
|
|
1189
|
+
|
|
1190
|
+
### Examples
|
|
1191
|
+
|
|
1192
|
+
```ruby
|
|
1193
|
+
require 'time'
|
|
1194
|
+
require 'ultracart_api'
|
|
1195
|
+
require 'json'
|
|
1196
|
+
require 'yaml'
|
|
1197
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
1198
|
+
|
|
1199
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
1200
|
+
# As such, this might not be the best way to use this object.
|
|
1201
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
1202
|
+
|
|
1203
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
1204
|
+
customer_profile_oid = 56 # Integer | The customer_profile_oid to update.
|
|
1205
|
+
customer = UltracartClient::Customer.new # Customer | Customer to update
|
|
1206
|
+
opts = {
|
|
1207
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
1208
|
+
}
|
|
1209
|
+
|
|
1210
|
+
begin
|
|
1211
|
+
# Update a customer
|
|
1212
|
+
result = api_instance.update_customer(customer_profile_oid, customer, opts)
|
|
1213
|
+
p result
|
|
1214
|
+
rescue UltracartClient::ApiError => e
|
|
1215
|
+
puts "Error when calling CustomerApi->update_customer: #{e}"
|
|
1216
|
+
end
|
|
1217
|
+
```
|
|
1218
|
+
|
|
1219
|
+
#### Using the update_customer_with_http_info variant
|
|
1220
|
+
|
|
1221
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1222
|
+
|
|
1223
|
+
> <Array(<CustomerResponse>, Integer, Hash)> update_customer_with_http_info(customer_profile_oid, customer, opts)
|
|
1224
|
+
|
|
1225
|
+
```ruby
|
|
1226
|
+
begin
|
|
1227
|
+
# Update a customer
|
|
1228
|
+
data, status_code, headers = api_instance.update_customer_with_http_info(customer_profile_oid, customer, opts)
|
|
1229
|
+
p status_code # => 2xx
|
|
1230
|
+
p headers # => { ... }
|
|
1231
|
+
p data # => <CustomerResponse>
|
|
1232
|
+
rescue UltracartClient::ApiError => e
|
|
1233
|
+
puts "Error when calling CustomerApi->update_customer_with_http_info: #{e}"
|
|
1234
|
+
end
|
|
1235
|
+
```
|
|
1236
|
+
|
|
1237
|
+
### Parameters
|
|
1238
|
+
|
|
1239
|
+
| Name | Type | Description | Notes |
|
|
1240
|
+
| ---- | ---- | ----------- | ----- |
|
|
1241
|
+
| **customer_profile_oid** | **Integer** | The customer_profile_oid to update. | |
|
|
1242
|
+
| **customer** | [**Customer**](Customer.md) | Customer to update | |
|
|
1243
|
+
| **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
|
|
1244
|
+
|
|
1245
|
+
### Return type
|
|
1246
|
+
|
|
1247
|
+
[**CustomerResponse**](CustomerResponse.md)
|
|
1248
|
+
|
|
1249
|
+
### Authorization
|
|
1250
|
+
|
|
1251
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1252
|
+
|
|
1253
|
+
### HTTP request headers
|
|
1254
|
+
|
|
1255
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
1256
|
+
- **Accept**: application/json
|
|
1257
|
+
|
|
1258
|
+
|
|
1259
|
+
## update_customer_email_lists
|
|
1260
|
+
|
|
1261
|
+
> <CustomerEmailListChanges> update_customer_email_lists(customer_profile_oid, list_changes)
|
|
1262
|
+
|
|
1263
|
+
Update email list subscriptions for a customer
|
|
1264
|
+
|
|
1265
|
+
Update email list subscriptions for a customer
|
|
1266
|
+
|
|
1267
|
+
### Examples
|
|
1268
|
+
|
|
1269
|
+
```ruby
|
|
1270
|
+
require 'time'
|
|
1271
|
+
require 'ultracart_api'
|
|
1272
|
+
require 'json'
|
|
1273
|
+
require 'yaml'
|
|
1274
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
1275
|
+
|
|
1276
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
1277
|
+
# As such, this might not be the best way to use this object.
|
|
1278
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
1279
|
+
|
|
1280
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
1281
|
+
customer_profile_oid = 56 # Integer | The customer profile oid
|
|
1282
|
+
list_changes = UltracartClient::CustomerEmailListChanges.new # CustomerEmailListChanges | List changes
|
|
1283
|
+
|
|
1284
|
+
begin
|
|
1285
|
+
# Update email list subscriptions for a customer
|
|
1286
|
+
result = api_instance.update_customer_email_lists(customer_profile_oid, list_changes)
|
|
1287
|
+
p result
|
|
1288
|
+
rescue UltracartClient::ApiError => e
|
|
1289
|
+
puts "Error when calling CustomerApi->update_customer_email_lists: #{e}"
|
|
1290
|
+
end
|
|
1291
|
+
```
|
|
1292
|
+
|
|
1293
|
+
#### Using the update_customer_email_lists_with_http_info variant
|
|
1294
|
+
|
|
1295
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1296
|
+
|
|
1297
|
+
> <Array(<CustomerEmailListChanges>, Integer, Hash)> update_customer_email_lists_with_http_info(customer_profile_oid, list_changes)
|
|
1298
|
+
|
|
1299
|
+
```ruby
|
|
1300
|
+
begin
|
|
1301
|
+
# Update email list subscriptions for a customer
|
|
1302
|
+
data, status_code, headers = api_instance.update_customer_email_lists_with_http_info(customer_profile_oid, list_changes)
|
|
1303
|
+
p status_code # => 2xx
|
|
1304
|
+
p headers # => { ... }
|
|
1305
|
+
p data # => <CustomerEmailListChanges>
|
|
1306
|
+
rescue UltracartClient::ApiError => e
|
|
1307
|
+
puts "Error when calling CustomerApi->update_customer_email_lists_with_http_info: #{e}"
|
|
1308
|
+
end
|
|
1309
|
+
```
|
|
1310
|
+
|
|
1311
|
+
### Parameters
|
|
1312
|
+
|
|
1313
|
+
| Name | Type | Description | Notes |
|
|
1314
|
+
| ---- | ---- | ----------- | ----- |
|
|
1315
|
+
| **customer_profile_oid** | **Integer** | The customer profile oid | |
|
|
1316
|
+
| **list_changes** | [**CustomerEmailListChanges**](CustomerEmailListChanges.md) | List changes | |
|
|
1317
|
+
|
|
1318
|
+
### Return type
|
|
1319
|
+
|
|
1320
|
+
[**CustomerEmailListChanges**](CustomerEmailListChanges.md)
|
|
1321
|
+
|
|
1322
|
+
### Authorization
|
|
1323
|
+
|
|
1324
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1325
|
+
|
|
1326
|
+
### HTTP request headers
|
|
1327
|
+
|
|
1328
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
1329
|
+
- **Accept**: application/json
|
|
1330
|
+
|
|
1331
|
+
|
|
1332
|
+
## validate_email_verification_token
|
|
1333
|
+
|
|
1334
|
+
> <EmailVerifyTokenValidateResponse> validate_email_verification_token(validation_request)
|
|
1335
|
+
|
|
1336
|
+
Validate a token that can be used to verify a customer email address
|
|
1337
|
+
|
|
1338
|
+
Validate a token that can be used to verify a customer email address. The implementation of how a customer interacts with this token is left to the merchant.
|
|
1339
|
+
|
|
1340
|
+
### Examples
|
|
1341
|
+
|
|
1342
|
+
```ruby
|
|
1343
|
+
require 'time'
|
|
1344
|
+
require 'ultracart_api'
|
|
1345
|
+
require 'json'
|
|
1346
|
+
require 'yaml'
|
|
1347
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
1348
|
+
|
|
1349
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
1350
|
+
# As such, this might not be the best way to use this object.
|
|
1351
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
1352
|
+
|
|
1353
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
1354
|
+
validation_request = UltracartClient::EmailVerifyTokenValidateRequest.new # EmailVerifyTokenValidateRequest | Token validation request
|
|
1355
|
+
|
|
1356
|
+
begin
|
|
1357
|
+
# Validate a token that can be used to verify a customer email address
|
|
1358
|
+
result = api_instance.validate_email_verification_token(validation_request)
|
|
1359
|
+
p result
|
|
1360
|
+
rescue UltracartClient::ApiError => e
|
|
1361
|
+
puts "Error when calling CustomerApi->validate_email_verification_token: #{e}"
|
|
1362
|
+
end
|
|
1363
|
+
```
|
|
1364
|
+
|
|
1365
|
+
#### Using the validate_email_verification_token_with_http_info variant
|
|
1366
|
+
|
|
1367
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1368
|
+
|
|
1369
|
+
> <Array(<EmailVerifyTokenValidateResponse>, Integer, Hash)> validate_email_verification_token_with_http_info(validation_request)
|
|
1370
|
+
|
|
1371
|
+
```ruby
|
|
1372
|
+
begin
|
|
1373
|
+
# Validate a token that can be used to verify a customer email address
|
|
1374
|
+
data, status_code, headers = api_instance.validate_email_verification_token_with_http_info(validation_request)
|
|
1375
|
+
p status_code # => 2xx
|
|
1376
|
+
p headers # => { ... }
|
|
1377
|
+
p data # => <EmailVerifyTokenValidateResponse>
|
|
1378
|
+
rescue UltracartClient::ApiError => e
|
|
1379
|
+
puts "Error when calling CustomerApi->validate_email_verification_token_with_http_info: #{e}"
|
|
1380
|
+
end
|
|
1381
|
+
```
|
|
1382
|
+
|
|
1383
|
+
### Parameters
|
|
1384
|
+
|
|
1385
|
+
| Name | Type | Description | Notes |
|
|
1386
|
+
| ---- | ---- | ----------- | ----- |
|
|
1387
|
+
| **validation_request** | [**EmailVerifyTokenValidateRequest**](EmailVerifyTokenValidateRequest.md) | Token validation request | |
|
|
1388
|
+
|
|
1389
|
+
### Return type
|
|
1390
|
+
|
|
1391
|
+
[**EmailVerifyTokenValidateResponse**](EmailVerifyTokenValidateResponse.md)
|
|
1392
|
+
|
|
1393
|
+
### Authorization
|
|
1394
|
+
|
|
1395
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1396
|
+
|
|
1397
|
+
### HTTP request headers
|
|
1398
|
+
|
|
1399
|
+
- **Content-Type**: application/json
|
|
1400
|
+
- **Accept**: application/json
|
|
1401
|
+
|