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