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