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