ultracart_api 3.11.0 → 4.0.32.rc

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (1773) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +9 -7
  3. data/README.md +1166 -1726
  4. data/Rakefile +10 -8
  5. data/docs/AccountsReceivableRetryConfig.md +46 -23
  6. data/docs/AccountsReceivableRetryConfigResponse.md +32 -15
  7. data/docs/AccountsReceivableRetryDayActivity.md +22 -10
  8. data/docs/AccountsReceivableRetryStatAccount.md +24 -11
  9. data/docs/AccountsReceivableRetryStatMetrics.md +38 -18
  10. data/docs/AccountsReceivableRetryStatRevenue.md +20 -9
  11. data/docs/AccountsReceivableRetryStatsResponse.md +28 -13
  12. data/docs/Activity.md +28 -15
  13. data/docs/AddLibraryItemRequest.md +38 -18
  14. data/docs/AdjustInternalCertificateRequest.md +28 -13
  15. data/docs/AdjustInternalCertificateResponse.md +28 -13
  16. data/docs/AffiliateApi.md +173 -126
  17. data/docs/AffiliateClick.md +38 -20
  18. data/docs/AffiliateClickQuery.md +28 -13
  19. data/docs/AffiliateClicksResponse.md +26 -12
  20. data/docs/AffiliateLedger.md +54 -26
  21. data/docs/AffiliateLedgerQuery.md +28 -13
  22. data/docs/AffiliateLedgersResponse.md +26 -12
  23. data/docs/AffiliateLink.md +44 -21
  24. data/docs/ApiUserApplicationProfile.md +26 -12
  25. data/docs/ApplyLibraryItemRequest.md +24 -11
  26. data/docs/ApplyLibraryItemResponse.md +38 -18
  27. data/docs/AutoOrder.md +60 -34
  28. data/docs/AutoOrderApi.md +693 -617
  29. data/docs/AutoOrderItem.md +64 -35
  30. data/docs/AutoOrderItemFutureSchedule.md +24 -11
  31. data/docs/AutoOrderItemOption.md +20 -9
  32. data/docs/AutoOrderItemSimpleSchedule.md +22 -10
  33. data/docs/AutoOrderLog.md +20 -9
  34. data/docs/AutoOrderQuery.md +58 -28
  35. data/docs/AutoOrderQueryBatch.md +18 -8
  36. data/docs/AutoOrderResponse.md +26 -12
  37. data/docs/AutoOrdersRequest.md +18 -8
  38. data/docs/AutoOrdersResponse.md +26 -12
  39. data/docs/AvalaraConfig.md +42 -20
  40. data/docs/BaseResponse.md +24 -11
  41. data/docs/Browser.md +22 -10
  42. data/docs/BrowserDevice.md +18 -8
  43. data/docs/BrowserOS.md +26 -12
  44. data/docs/BrowserUserAgent.md +24 -11
  45. data/docs/Cart.md +68 -33
  46. data/docs/CartAffiliate.md +20 -9
  47. data/docs/CartAffirmCheckoutResponse.md +20 -9
  48. data/docs/CartBilling.md +46 -24
  49. data/docs/CartBuysafe.md +28 -13
  50. data/docs/CartCheckout.md +44 -25
  51. data/docs/CartCoupon.md +18 -8
  52. data/docs/CartCurrencyConversion.md +20 -9
  53. data/docs/CartCustomerProfile.md +60 -30
  54. data/docs/CartCustomerProfileAddress.md +44 -21
  55. data/docs/CartCustomerProfileCreditCard.md +28 -13
  56. data/docs/CartFinalizeOrderRequest.md +20 -9
  57. data/docs/CartFinalizeOrderRequestOptions.md +42 -20
  58. data/docs/CartFinalizeOrderResponse.md +26 -12
  59. data/docs/CartGift.md +28 -13
  60. data/docs/CartGiftCertificate.md +22 -10
  61. data/docs/CartItem.md +74 -37
  62. data/docs/CartItemAttribute.md +22 -10
  63. data/docs/CartItemMultimedia.md +34 -16
  64. data/docs/CartItemMultimediaThumbnail.md +26 -12
  65. data/docs/CartItemOption.md +40 -19
  66. data/docs/CartItemOptionValue.md +26 -12
  67. data/docs/CartItemPhysical.md +24 -11
  68. data/docs/CartItemVariationSelection.md +20 -9
  69. data/docs/CartKitComponentOption.md +44 -21
  70. data/docs/CartMarketing.md +20 -10
  71. data/docs/CartPayment.md +30 -15
  72. data/docs/CartPaymentAffirm.md +18 -8
  73. data/docs/CartPaymentAmazon.md +18 -8
  74. data/docs/CartPaymentCheck.md +18 -8
  75. data/docs/CartPaymentCreditCard.md +34 -16
  76. data/docs/CartPaymentPurchaseOrder.md +18 -8
  77. data/docs/CartProfileLoginRequest.md +22 -10
  78. data/docs/CartProfileLoginResponse.md +20 -9
  79. data/docs/CartProfileRegisterRequest.md +20 -9
  80. data/docs/CartProfileRegisterResponse.md +20 -9
  81. data/docs/CartProperty.md +24 -11
  82. data/docs/CartResponse.md +20 -9
  83. data/docs/CartSettings.md +28 -13
  84. data/docs/CartSettingsBilling.md +18 -8
  85. data/docs/CartSettingsGift.md +24 -11
  86. data/docs/CartSettingsGiftWrap.md +22 -10
  87. data/docs/CartSettingsPayment.md +42 -20
  88. data/docs/CartSettingsPaymentAmazon.md +22 -10
  89. data/docs/CartSettingsPaymentCreditCard.md +22 -11
  90. data/docs/CartSettingsPaymentPayPal.md +26 -12
  91. data/docs/CartSettingsProvince.md +20 -9
  92. data/docs/CartSettingsShipping.md +26 -12
  93. data/docs/CartSettingsShippingCalendar.md +26 -12
  94. data/docs/CartSettingsShippingEstimate.md +44 -21
  95. data/docs/CartSettingsTaxes.md +18 -8
  96. data/docs/CartSettingsTerms.md +20 -9
  97. data/docs/CartShipping.md +54 -26
  98. data/docs/CartSummary.md +48 -27
  99. data/docs/CartTaxes.md +22 -10
  100. data/docs/CartUpsellAfter.md +22 -10
  101. data/docs/CartValidationRequest.md +20 -9
  102. data/docs/CartValidationResponse.md +20 -9
  103. data/docs/ChannelPartnerApi.md +382 -760
  104. data/docs/ChannelPartnerCancelResponse.md +26 -12
  105. data/docs/ChannelPartnerEstimateShippingResponse.md +26 -12
  106. data/docs/ChannelPartnerEstimateTaxResponse.md +26 -12
  107. data/docs/ChannelPartnerImportResponse.md +30 -14
  108. data/docs/ChannelPartnerOrder.md +176 -99
  109. data/docs/ChannelPartnerOrderItem.md +30 -14
  110. data/docs/ChannelPartnerOrderItemOption.md +20 -9
  111. data/docs/ChannelPartnerOrderTransaction.md +20 -9
  112. data/docs/ChannelPartnerOrderTransactionDetail.md +20 -9
  113. data/docs/ChannelPartnerShippingEstimate.md +20 -9
  114. data/docs/ChargebackApi.md +420 -301
  115. data/docs/ChargebackDispute.md +62 -30
  116. data/docs/ChargebackDisputeResponse.md +26 -12
  117. data/docs/ChargebackDisputesResponse.md +26 -12
  118. data/docs/CheckoutAllowedCountriesResponse.md +18 -8
  119. data/docs/CheckoutApi.md +1566 -1023
  120. data/docs/CheckoutHandoffRequest.md +32 -15
  121. data/docs/CheckoutHandoffResponse.md +22 -10
  122. data/docs/CheckoutSetupBrowserKeyRequest.md +18 -8
  123. data/docs/CheckoutSetupBrowserKeyResponse.md +18 -8
  124. data/docs/CheckoutStateProvinceResponse.md +18 -8
  125. data/docs/CityStateZip.md +26 -12
  126. data/docs/CountriesResponse.md +18 -8
  127. data/docs/Country.md +20 -9
  128. data/docs/Coupon.md +136 -74
  129. data/docs/CouponAmountOffItems.md +24 -12
  130. data/docs/CouponAmountOffShipping.md +22 -10
  131. data/docs/CouponAmountOffShippingWithItemsPurchase.md +24 -11
  132. data/docs/CouponAmountOffSubtotal.md +20 -9
  133. data/docs/CouponAmountOffSubtotalAndShipping.md +20 -9
  134. data/docs/CouponAmountOffSubtotalFreeShippingWithPurchase.md +24 -11
  135. data/docs/CouponAmountOffSubtotalWithBlockPurchase.md +24 -11
  136. data/docs/CouponAmountOffSubtotalWithItemsPurchase.md +24 -11
  137. data/docs/CouponAmountOffSubtotalWithPurchase.md +22 -10
  138. data/docs/CouponAmountShippingWithSubtotal.md +24 -11
  139. data/docs/CouponApi.md +1500 -1043
  140. data/docs/CouponAutoApplyCondition.md +22 -10
  141. data/docs/CouponAutoApplyConditions.md +28 -13
  142. data/docs/CouponAutomaticallyApplyCouponCodes.md +18 -8
  143. data/docs/CouponBuyOneGetOneLimit.md +20 -10
  144. data/docs/CouponCodesRequest.md +30 -14
  145. data/docs/CouponCodesResponse.md +28 -13
  146. data/docs/CouponDeletesRequest.md +20 -9
  147. data/docs/CouponDiscountItemWithItemPurchase.md +26 -14
  148. data/docs/CouponDiscountItems.md +24 -11
  149. data/docs/CouponEditorValues.md +36 -18
  150. data/docs/CouponExistsResponse.md +28 -13
  151. data/docs/CouponFreeItemAndShippingWithSubtotal.md +26 -12
  152. data/docs/CouponFreeItemWithItemPurchase.md +24 -13
  153. data/docs/CouponFreeItemWithSubtotal.md +24 -11
  154. data/docs/CouponFreeItemsWithItemPurchase.md +26 -12
  155. data/docs/CouponFreeItemsWithMixMatchPurchase.md +26 -12
  156. data/docs/CouponFreeShipping.md +18 -8
  157. data/docs/CouponFreeShippingSpecificItems.md +18 -8
  158. data/docs/CouponFreeShippingWithItemsPurchase.md +20 -9
  159. data/docs/CouponFreeShippingWithSubtotal.md +22 -10
  160. data/docs/CouponItemSearchResult.md +32 -15
  161. data/docs/CouponItemSearchResultsResponse.md +26 -12
  162. data/docs/CouponMultipleAmountsOffItems.md +20 -9
  163. data/docs/CouponPercentOffItemWithItemsQuantityPurchase.md +26 -14
  164. data/docs/CouponPercentOffItems.md +24 -13
  165. data/docs/CouponPercentOffItemsAndFreeShipping.md +22 -12
  166. data/docs/CouponPercentOffItemsWithItemsPurchase.md +24 -13
  167. data/docs/CouponPercentOffMsrpItems.md +24 -13
  168. data/docs/CouponPercentOffRetailPriceItems.md +24 -11
  169. data/docs/CouponPercentOffShipping.md +20 -9
  170. data/docs/CouponPercentOffSubtotal.md +18 -8
  171. data/docs/CouponPercentOffSubtotalAndFreeShipping.md +20 -9
  172. data/docs/CouponPercentOffSubtotalLimit.md +22 -10
  173. data/docs/CouponPercentOffSubtotalWithItemsPurchase.md +20 -9
  174. data/docs/CouponPercentOffSubtotalWithSubtotal.md +22 -10
  175. data/docs/CouponQuery.md +36 -17
  176. data/docs/CouponResponse.md +28 -13
  177. data/docs/CouponRestriction.md +24 -11
  178. data/docs/CouponTierAmount.md +22 -10
  179. data/docs/CouponTierItemDiscount.md +20 -9
  180. data/docs/CouponTierPercent.md +22 -10
  181. data/docs/CouponTierQuantityAmount.md +22 -10
  182. data/docs/CouponTierQuantityPercent.md +22 -10
  183. data/docs/CouponTieredAmountOffItems.md +22 -11
  184. data/docs/CouponTieredAmountOffSubtotal.md +20 -9
  185. data/docs/CouponTieredPercentOffItems.md +22 -11
  186. data/docs/CouponTieredPercentOffShipping.md +22 -10
  187. data/docs/CouponTieredPercentOffSubtotal.md +20 -9
  188. data/docs/CouponType.md +20 -9
  189. data/docs/CouponsRequest.md +18 -8
  190. data/docs/CouponsResponse.md +26 -12
  191. data/docs/Currency.md +26 -12
  192. data/docs/Customer.md +134 -71
  193. data/docs/CustomerActivity.md +24 -15
  194. data/docs/CustomerAffiliate.md +24 -11
  195. data/docs/CustomerApi.md +1380 -1347
  196. data/docs/CustomerAttachment.md +26 -12
  197. data/docs/CustomerBilling.md +50 -24
  198. data/docs/CustomerCard.md +32 -15
  199. data/docs/CustomerEditorValues.md +36 -19
  200. data/docs/CustomerEmail.md +28 -13
  201. data/docs/CustomerEmailListChanges.md +20 -9
  202. data/docs/CustomerLoyalty.md +30 -14
  203. data/docs/CustomerLoyaltyLedger.md +46 -22
  204. data/docs/CustomerLoyaltyRedemption.md +42 -20
  205. data/docs/CustomerOrdersSummary.md +24 -11
  206. data/docs/CustomerPricingTier.md +20 -9
  207. data/docs/CustomerPrivacy.md +24 -11
  208. data/docs/CustomerQuery.md +74 -37
  209. data/docs/CustomerQuotesSummary.md +24 -11
  210. data/docs/CustomerResponse.md +26 -12
  211. data/docs/CustomerReviewer.md +36 -17
  212. data/docs/CustomerShipping.md +50 -24
  213. data/docs/CustomerSoftwareEntitlement.md +32 -15
  214. data/docs/CustomerStoreCredit.md +28 -13
  215. data/docs/CustomerStoreCreditAddRequest.md +24 -11
  216. data/docs/CustomerStoreCreditLedgerEntry.md +30 -14
  217. data/docs/CustomerStoreCreditResponse.md +26 -12
  218. data/docs/CustomerTag.md +18 -8
  219. data/docs/CustomerTaxCodes.md +26 -12
  220. data/docs/CustomersResponse.md +26 -12
  221. data/docs/DataTablesServerSideResponse.md +24 -11
  222. data/docs/Distance.md +20 -9
  223. data/docs/DistributionCenter.md +86 -57
  224. data/docs/DistributionCentersResponse.md +26 -12
  225. data/docs/EmailBaseTemplateListResponse.md +18 -8
  226. data/docs/EmailCampaign.md +64 -33
  227. data/docs/EmailCampaignFolder.md +26 -12
  228. data/docs/EmailCampaignFolderResponse.md +26 -12
  229. data/docs/EmailCampaignFoldersResponse.md +26 -12
  230. data/docs/EmailCampaignResponse.md +26 -12
  231. data/docs/EmailCampaignsResponse.md +26 -12
  232. data/docs/EmailClick.md +20 -9
  233. data/docs/EmailClicksResponse.md +26 -12
  234. data/docs/EmailCommseq.md +24 -11
  235. data/docs/EmailCommseqEmail.md +68 -41
  236. data/docs/EmailCommseqEmailResponse.md +26 -12
  237. data/docs/EmailCommseqEmailSendTestRequest.md +36 -17
  238. data/docs/EmailCommseqEmailSendTestResponse.md +24 -11
  239. data/docs/EmailCommseqEmailsRequest.md +26 -12
  240. data/docs/EmailCommseqEmailsResponse.md +26 -12
  241. data/docs/EmailCommseqPostcard.md +42 -20
  242. data/docs/EmailCommseqPostcardResponse.md +26 -12
  243. data/docs/EmailCommseqPostcardSendTestRequest.md +42 -20
  244. data/docs/EmailCommseqPostcardSendTestResponse.md +30 -14
  245. data/docs/EmailCommseqPostcardsRequest.md +18 -8
  246. data/docs/EmailCommseqPostcardsResponse.md +26 -12
  247. data/docs/EmailCommseqResponse.md +26 -12
  248. data/docs/EmailCommseqStat.md +90 -44
  249. data/docs/EmailCommseqStatResponse.md +26 -12
  250. data/docs/EmailCommseqStep.md +36 -17
  251. data/docs/EmailCommseqStepLog.md +22 -10
  252. data/docs/EmailCommseqStepLogsResponse.md +26 -12
  253. data/docs/EmailCommseqWebhookSendTestRequest.md +30 -14
  254. data/docs/EmailCommseqWebhookSendTestResponse.md +30 -14
  255. data/docs/EmailCommseqsResponse.md +26 -12
  256. data/docs/EmailCustomer.md +32 -15
  257. data/docs/EmailCustomerEditorUrlResponse.md +26 -12
  258. data/docs/EmailCustomersResponse.md +26 -12
  259. data/docs/EmailDashboardActivity.md +30 -14
  260. data/docs/EmailDashboardActivityResponse.md +26 -12
  261. data/docs/EmailDashboardStatsResponse.md +26 -12
  262. data/docs/EmailDomain.md +42 -20
  263. data/docs/EmailEditorTokenResponse.md +26 -12
  264. data/docs/EmailFlow.md +72 -38
  265. data/docs/EmailFlowBackPopulateRequest.md +20 -9
  266. data/docs/EmailFlowBackPopulateResponse.md +24 -11
  267. data/docs/EmailFlowFolder.md +26 -12
  268. data/docs/EmailFlowFolderResponse.md +26 -12
  269. data/docs/EmailFlowFoldersResponse.md +26 -12
  270. data/docs/EmailFlowResponse.md +26 -12
  271. data/docs/EmailFlowsResponse.md +26 -12
  272. data/docs/EmailGlobalSettings.md +18 -8
  273. data/docs/EmailGlobalSettingsResponse.md +26 -12
  274. data/docs/EmailGlobalUnsubscribeRequest.md +18 -8
  275. data/docs/EmailGlobalUnsubscribeResponse.md +18 -8
  276. data/docs/EmailHistogramPropertyNamesResponse.md +18 -8
  277. data/docs/EmailHistogramPropertyValuesResponse.md +18 -8
  278. data/docs/EmailList.md +40 -19
  279. data/docs/EmailListArchiveResponse.md +26 -12
  280. data/docs/EmailListCustomer.md +24 -11
  281. data/docs/EmailListCustomersResponse.md +26 -12
  282. data/docs/EmailListResponse.md +26 -12
  283. data/docs/EmailListSegmentFolder.md +26 -12
  284. data/docs/EmailListSegmentFolderResponse.md +26 -12
  285. data/docs/EmailListSegmentFoldersResponse.md +26 -12
  286. data/docs/EmailListSegmentMembership.md +24 -11
  287. data/docs/EmailListSegmentUsedBy.md +22 -10
  288. data/docs/EmailListSubscribeResponse.md +20 -9
  289. data/docs/EmailListsResponse.md +26 -12
  290. data/docs/EmailOrder.md +24 -11
  291. data/docs/EmailOrdersResponse.md +26 -12
  292. data/docs/EmailPerformance.md +62 -30
  293. data/docs/EmailPerformanceCustomerHistogram.md +18 -8
  294. data/docs/EmailPerformanceCustomerHistogramPeriod.md +26 -12
  295. data/docs/EmailPerformanceDaily.md +30 -14
  296. data/docs/EmailPerformanceResponse.md +26 -12
  297. data/docs/EmailPlan.md +50 -24
  298. data/docs/EmailPlanAdditional.md +34 -16
  299. data/docs/EmailPlanResponse.md +26 -12
  300. data/docs/EmailPostcardStat.md +80 -39
  301. data/docs/EmailSegment.md +58 -29
  302. data/docs/EmailSegmentArchiveResponse.md +26 -12
  303. data/docs/EmailSegmentCustomer.md +24 -11
  304. data/docs/EmailSegmentCustomersResponse.md +26 -12
  305. data/docs/EmailSegmentDownloadPrepareResponse.md +32 -15
  306. data/docs/EmailSegmentResponse.md +26 -12
  307. data/docs/EmailSegmentsResponse.md +26 -12
  308. data/docs/EmailSendingDomainResponse.md +26 -12
  309. data/docs/EmailSendingDomainsResponse.md +26 -12
  310. data/docs/EmailSettings.md +40 -26
  311. data/docs/EmailSettingsResponse.md +26 -12
  312. data/docs/EmailStat.md +92 -45
  313. data/docs/EmailStatPostcardSummaryRequest.md +20 -9
  314. data/docs/EmailStatPostcardSummaryResponse.md +26 -12
  315. data/docs/EmailStatSummaryRequest.md +22 -10
  316. data/docs/EmailStatSummaryResponse.md +26 -12
  317. data/docs/EmailStepStat.md +56 -37
  318. data/docs/EmailStepStatRequest.md +20 -9
  319. data/docs/EmailStepStatResponse.md +26 -12
  320. data/docs/EmailStepWaitingRequest.md +18 -8
  321. data/docs/EmailStepWaitingResponse.md +18 -8
  322. data/docs/EmailTemplate.md +38 -18
  323. data/docs/EmailTemplatesResponse.md +26 -12
  324. data/docs/EmailThirdPartyList.md +20 -9
  325. data/docs/EmailThirdPartyListImportRequest.md +18 -8
  326. data/docs/EmailThirdPartyProvider.md +38 -18
  327. data/docs/EmailThirdPartyProvidersResponse.md +26 -12
  328. data/docs/EmailThirdPartyTag.md +20 -9
  329. data/docs/EmailVerifyTokenRequest.md +20 -9
  330. data/docs/EmailVerifyTokenResponse.md +26 -12
  331. data/docs/EmailVerifyTokenValidateRequest.md +18 -8
  332. data/docs/EmailVerifyTokenValidateResponse.md +24 -11
  333. data/docs/EmailWebhookEditorValuesResponse.md +30 -14
  334. data/docs/Error.md +26 -12
  335. data/docs/ErrorResponse.md +24 -11
  336. data/docs/Experiment.md +52 -31
  337. data/docs/ExperimentResponse.md +26 -12
  338. data/docs/ExperimentVariation.md +60 -30
  339. data/docs/ExperimentVariationStat.md +38 -20
  340. data/docs/ExperimentsResponse.md +26 -12
  341. data/docs/FulfillmentApi.md +459 -318
  342. data/docs/FulfillmentInventory.md +20 -9
  343. data/docs/FulfillmentShipment.md +26 -12
  344. data/docs/GeoPoint.md +20 -9
  345. data/docs/GeocodeRequest.md +26 -12
  346. data/docs/GeocodeResponse.md +28 -13
  347. data/docs/GiftCertificate.md +44 -21
  348. data/docs/GiftCertificateApi.md +622 -433
  349. data/docs/GiftCertificateCreateRequest.md +26 -12
  350. data/docs/GiftCertificateLedgerEntry.md +28 -13
  351. data/docs/GiftCertificateQuery.md +34 -16
  352. data/docs/GiftCertificateResponse.md +26 -12
  353. data/docs/GiftCertificatesResponse.md +26 -12
  354. data/docs/Group.md +26 -12
  355. data/docs/GroupResponse.md +26 -12
  356. data/docs/GroupUserMembership.md +26 -12
  357. data/docs/GroupsResponse.md +26 -12
  358. data/docs/HTTPHeader.md +20 -9
  359. data/docs/IntegrationLog.md +52 -26
  360. data/docs/IntegrationLogApi.md +400 -286
  361. data/docs/IntegrationLogFile.md +24 -11
  362. data/docs/IntegrationLogLog.md +20 -9
  363. data/docs/IntegrationLogQueryFilterValues.md +40 -19
  364. data/docs/IntegrationLogQueryRequest.md +42 -23
  365. data/docs/IntegrationLogQueryResponse.md +28 -13
  366. data/docs/IntegrationLogResponse.md +26 -12
  367. data/docs/IntegrationLogSummary.md +34 -16
  368. data/docs/IntegrationLogSummaryQueryRequest.md +20 -9
  369. data/docs/IntegrationLogSummaryQueryResponse.md +26 -12
  370. data/docs/Item.md +118 -58
  371. data/docs/ItemAccounting.md +20 -9
  372. data/docs/ItemAmember.md +20 -9
  373. data/docs/ItemApi.md +733 -1266
  374. data/docs/ItemAutoOrder.md +50 -29
  375. data/docs/ItemAutoOrderStep.md +46 -24
  376. data/docs/ItemAutoOrderStepArbitraryUnitCostSchedule.md +20 -9
  377. data/docs/ItemAutoOrderStepGrandfatherPricing.md +20 -9
  378. data/docs/ItemCCBill.md +28 -13
  379. data/docs/ItemChannelPartnerMapping.md +54 -26
  380. data/docs/ItemChargeback.md +20 -9
  381. data/docs/ItemChargebackAddendum.md +24 -11
  382. data/docs/ItemChargebackAdjustmentRequest.md +22 -10
  383. data/docs/ItemCheckout.md +24 -11
  384. data/docs/ItemContent.md +42 -23
  385. data/docs/ItemContentAssignment.md +28 -13
  386. data/docs/ItemContentAttribute.md +24 -11
  387. data/docs/ItemContentMultimedia.md +46 -22
  388. data/docs/ItemContentMultimediaThumbnail.md +28 -13
  389. data/docs/ItemDigitalDelivery.md +28 -13
  390. data/docs/ItemDigitalItem.md +26 -17
  391. data/docs/ItemEbay.md +154 -76
  392. data/docs/ItemEbayCategorySpecific.md +20 -9
  393. data/docs/ItemEbayMarketListing.md +26 -12
  394. data/docs/ItemEbayMarketPlaceAnalysis.md +36 -17
  395. data/docs/ItemEmailNotifications.md +20 -9
  396. data/docs/ItemEnrollment123.md +18 -8
  397. data/docs/ItemFulfillmentAddon.md +24 -12
  398. data/docs/ItemGiftCertificate.md +20 -9
  399. data/docs/ItemGoogleProductSearch.md +112 -55
  400. data/docs/ItemIdentifiers.md +24 -15
  401. data/docs/ItemInstantPaymentNotification.md +22 -10
  402. data/docs/ItemInstantPaymentNotifications.md +18 -8
  403. data/docs/ItemInternal.md +18 -8
  404. data/docs/ItemKitComponent.md +26 -12
  405. data/docs/ItemKitDefinition.md +18 -8
  406. data/docs/ItemOption.md +44 -21
  407. data/docs/ItemOptionValue.md +46 -22
  408. data/docs/ItemOptionValueAdditionalItem.md +20 -9
  409. data/docs/ItemOptionValueDigitalItem.md +20 -9
  410. data/docs/ItemPaymentProcessing.md +26 -13
  411. data/docs/ItemPhysical.md +24 -11
  412. data/docs/ItemPricing.md +52 -25
  413. data/docs/ItemPricingTier.md +26 -12
  414. data/docs/ItemPricingTierDiscount.md +20 -9
  415. data/docs/ItemPricingTierLimit.md +22 -12
  416. data/docs/ItemProperty.md +22 -10
  417. data/docs/ItemRealtimePricing.md +22 -10
  418. data/docs/ItemRelated.md +22 -10
  419. data/docs/ItemRelatedItem.md +22 -10
  420. data/docs/ItemReporting.md +20 -9
  421. data/docs/ItemResponse.md +26 -12
  422. data/docs/ItemRestriction.md +32 -15
  423. data/docs/ItemRestrictionItem.md +22 -10
  424. data/docs/ItemRevguard.md +30 -14
  425. data/docs/ItemReviews.md +34 -17
  426. data/docs/ItemSalesforce.md +20 -9
  427. data/docs/ItemShipping.md +112 -56
  428. data/docs/ItemShippingCase.md +24 -11
  429. data/docs/ItemShippingDestinationMarkup.md +28 -14
  430. data/docs/ItemShippingDestinationRestriction.md +22 -10
  431. data/docs/ItemShippingDistributionCenter.md +44 -21
  432. data/docs/ItemShippingMethod.md +46 -22
  433. data/docs/ItemShippingPackageRequirement.md +20 -9
  434. data/docs/ItemTag.md +20 -9
  435. data/docs/ItemTags.md +18 -8
  436. data/docs/ItemTax.md +24 -11
  437. data/docs/ItemTaxExemption.md +26 -12
  438. data/docs/ItemThirdPartyEmailMarketing.md +26 -12
  439. data/docs/ItemVariantItem.md +28 -13
  440. data/docs/ItemVariation.md +26 -12
  441. data/docs/ItemVariationOption.md +24 -11
  442. data/docs/ItemWishlistMember.md +22 -10
  443. data/docs/ItemsRequest.md +18 -8
  444. data/docs/ItemsResponse.md +26 -12
  445. data/docs/KeyValue.md +22 -10
  446. data/docs/LibraryFilterValues.md +24 -11
  447. data/docs/LibraryFilterValuesResponse.md +26 -12
  448. data/docs/LibraryItem.md +96 -47
  449. data/docs/LibraryItemAccount.md +22 -10
  450. data/docs/LibraryItemAsset.md +20 -9
  451. data/docs/LibraryItemAttribute.md +20 -9
  452. data/docs/LibraryItemEmail.md +22 -10
  453. data/docs/LibraryItemPublishedMeta.md +32 -15
  454. data/docs/LibraryItemPurchasedMeta.md +22 -10
  455. data/docs/LibraryItemQuery.md +40 -19
  456. data/docs/LibraryItemResponse.md +26 -12
  457. data/docs/LibraryItemScreenshot.md +20 -9
  458. data/docs/LibraryItemsResponse.md +26 -12
  459. data/docs/LinkedAccount.md +22 -10
  460. data/docs/ListSegmentMembership.md +22 -10
  461. data/docs/LookupRequest.md +26 -13
  462. data/docs/LookupResponse.md +26 -12
  463. data/docs/Mailgun.md +18 -8
  464. data/docs/Metric.md +32 -15
  465. data/docs/Notification.md +38 -18
  466. data/docs/OauthApi.md +179 -124
  467. data/docs/OauthRevokeSuccessResponse.md +20 -9
  468. data/docs/OauthTokenResponse.md +32 -15
  469. data/docs/Order.md +84 -46
  470. data/docs/OrderAffiliate.md +22 -10
  471. data/docs/OrderAffiliateLedger.md +34 -16
  472. data/docs/OrderApi.md +1856 -1522
  473. data/docs/OrderAutoOrder.md +56 -27
  474. data/docs/OrderBilling.md +48 -25
  475. data/docs/OrderBuysafe.md +28 -13
  476. data/docs/OrderByTokenQuery.md +18 -8
  477. data/docs/OrderChannelPartner.md +38 -18
  478. data/docs/OrderCheckout.md +44 -24
  479. data/docs/OrderCoupon.md +26 -12
  480. data/docs/OrderDigitalItem.md +32 -15
  481. data/docs/OrderDigitalOrder.md +26 -12
  482. data/docs/OrderEdi.md +24 -11
  483. data/docs/OrderFormat.md +48 -23
  484. data/docs/OrderFormatResponse.md +20 -9
  485. data/docs/OrderFraudScore.md +56 -27
  486. data/docs/OrderGift.md +36 -17
  487. data/docs/OrderGiftCertificate.md +22 -10
  488. data/docs/OrderInternal.md +26 -13
  489. data/docs/OrderItem.md +128 -73
  490. data/docs/OrderItemEdi.md +20 -9
  491. data/docs/OrderItemEdiIdentification.md +20 -9
  492. data/docs/OrderItemEdiLot.md +22 -10
  493. data/docs/OrderItemOption.md +38 -18
  494. data/docs/OrderItemOptionFileAttachment.md +24 -11
  495. data/docs/OrderItemProperty.md +24 -11
  496. data/docs/OrderItemTag.md +18 -8
  497. data/docs/OrderLinkedShipment.md +26 -12
  498. data/docs/OrderMarketing.md +22 -11
  499. data/docs/OrderPackingSlipResponse.md +26 -12
  500. data/docs/OrderPayment.md +52 -27
  501. data/docs/OrderPaymentCheck.md +18 -8
  502. data/docs/OrderPaymentCreditCard.md +38 -19
  503. data/docs/OrderPaymentECheck.md +36 -17
  504. data/docs/OrderPaymentInsurance.md +24 -11
  505. data/docs/OrderPaymentPurchaseOrder.md +18 -8
  506. data/docs/OrderPaymentTransaction.md +24 -12
  507. data/docs/OrderPaymentTransactionDetail.md +22 -10
  508. data/docs/OrderProcessPaymentRequest.md +20 -9
  509. data/docs/OrderProcessPaymentResponse.md +26 -12
  510. data/docs/OrderProperty.md +24 -11
  511. data/docs/OrderQuery.md +94 -50
  512. data/docs/OrderQueryBatch.md +18 -9
  513. data/docs/OrderQuote.md +22 -10
  514. data/docs/OrderReplacement.md +46 -22
  515. data/docs/OrderReplacementItem.md +22 -10
  516. data/docs/OrderReplacementResponse.md +28 -13
  517. data/docs/OrderResponse.md +26 -12
  518. data/docs/OrderSalesforce.md +18 -8
  519. data/docs/OrderShipping.md +76 -38
  520. data/docs/OrderSummary.md +56 -33
  521. data/docs/OrderTag.md +18 -8
  522. data/docs/OrderTaxes.md +50 -24
  523. data/docs/OrderTokenResponse.md +26 -12
  524. data/docs/OrderTrackingNumberDetail.md +40 -19
  525. data/docs/OrderTrackingNumberDetails.md +52 -25
  526. data/docs/OrdersResponse.md +26 -12
  527. data/docs/Permission.md +22 -10
  528. data/docs/PricingTier.md +78 -41
  529. data/docs/PricingTierNotification.md +22 -10
  530. data/docs/PricingTiersResponse.md +26 -12
  531. data/docs/Property.md +20 -9
  532. data/docs/PublishLibraryItemRequest.md +18 -8
  533. data/docs/RegisterAffiliateClickRequest.md +28 -13
  534. data/docs/RegisterAffiliateClickResponse.md +24 -11
  535. data/docs/ResponseMetadata.md +20 -9
  536. data/docs/ResultSet.md +28 -13
  537. data/docs/ScreenRecording.md +116 -57
  538. data/docs/ScreenRecordingAdPlatform.md +30 -14
  539. data/docs/ScreenRecordingFilter.md +136 -67
  540. data/docs/ScreenRecordingFilterGeoDistance.md +26 -12
  541. data/docs/ScreenRecordingFilterIpSearch.md +24 -11
  542. data/docs/ScreenRecordingFilterPageView.md +50 -24
  543. data/docs/ScreenRecordingFilterPageViewEvent.md +20 -9
  544. data/docs/ScreenRecordingFilterPageViewEventParam.md +26 -12
  545. data/docs/ScreenRecordingFilterPageViewParam.md +20 -9
  546. data/docs/ScreenRecordingFilterPageViewReferrerParam.md +20 -9
  547. data/docs/ScreenRecordingFilterRangeBigDecimal.md +26 -12
  548. data/docs/ScreenRecordingFilterRangeDate.md +20 -9
  549. data/docs/ScreenRecordingFilterRangeInteger.md +26 -12
  550. data/docs/ScreenRecordingFilterStringSearch.md +26 -12
  551. data/docs/ScreenRecordingFilterValues.md +58 -28
  552. data/docs/ScreenRecordingFilterValuesEvent.md +20 -9
  553. data/docs/ScreenRecordingFilterValuesEventParams.md +26 -12
  554. data/docs/ScreenRecordingFilterValuesPageParam.md +20 -9
  555. data/docs/ScreenRecordingFilterValuesPageView.md +28 -13
  556. data/docs/ScreenRecordingHeatmap.md +64 -31
  557. data/docs/ScreenRecordingHeatmapIndexRequest.md +18 -8
  558. data/docs/ScreenRecordingHeatmapIndexResponse.md +26 -12
  559. data/docs/ScreenRecordingHeatmapRequest.md +22 -10
  560. data/docs/ScreenRecordingHeatmapReset.md +18 -8
  561. data/docs/ScreenRecordingHeatmapResponse.md +26 -12
  562. data/docs/ScreenRecordingHeatmapUrl.md +28 -13
  563. data/docs/ScreenRecordingMerchantNotesRequest.md +18 -8
  564. data/docs/ScreenRecordingMultifield.md +26 -12
  565. data/docs/ScreenRecordingPageView.md +54 -26
  566. data/docs/ScreenRecordingPageViewDataResponse.md +26 -12
  567. data/docs/ScreenRecordingPageViewEvent.md +28 -13
  568. data/docs/ScreenRecordingPageViewEventParameter.md +20 -9
  569. data/docs/ScreenRecordingPageViewParameter.md +20 -9
  570. data/docs/ScreenRecordingQueryRequest.md +18 -8
  571. data/docs/ScreenRecordingQueryResponse.md +38 -18
  572. data/docs/ScreenRecordingResponse.md +28 -13
  573. data/docs/ScreenRecordingSegment.md +36 -17
  574. data/docs/ScreenRecordingSegmentResponse.md +26 -12
  575. data/docs/ScreenRecordingSegmentsResponse.md +26 -12
  576. data/docs/ScreenRecordingSettings.md +32 -15
  577. data/docs/ScreenRecordingSettingsResponse.md +26 -12
  578. data/docs/ScreenRecordingStoreFront.md +20 -9
  579. data/docs/ScreenRecordingTagsRequest.md +18 -8
  580. data/docs/ScreenRecordingTagsResponse.md +26 -12
  581. data/docs/ScreenRecordingUserAgent.md +26 -12
  582. data/docs/ScreenRecordingUserAgentDevice.md +18 -8
  583. data/docs/ScreenRecordingUserAgentOS.md +22 -10
  584. data/docs/ScreenRecordingUserProperty.md +20 -9
  585. data/docs/ScreenshotsResponse.md +26 -12
  586. data/docs/SelfConfig.md +18 -10
  587. data/docs/SimpleValue.md +20 -9
  588. data/docs/SingleSignOnAuthorizeRequest.md +20 -9
  589. data/docs/SingleSignOnAuthorizeResponse.md +20 -9
  590. data/docs/SingleSignOnTokenRequest.md +20 -9
  591. data/docs/SingleSignOnTokenResponse.md +22 -10
  592. data/docs/SovosConfig.md +30 -14
  593. data/docs/SsoApi.md +300 -201
  594. data/docs/StateProvince.md +20 -9
  595. data/docs/StepWaiting.md +20 -9
  596. data/docs/StorefrontApi.md +13005 -9377
  597. data/docs/TaxApi.md +2101 -1421
  598. data/docs/TaxCity.md +34 -16
  599. data/docs/TaxCountry.md +34 -16
  600. data/docs/TaxCountryCode.md +26 -12
  601. data/docs/TaxCounty.md +36 -17
  602. data/docs/TaxJarConfig.md +30 -14
  603. data/docs/TaxPostalCode.md +30 -14
  604. data/docs/TaxProviderActivateResult.md +20 -9
  605. data/docs/TaxProviderAvalara.md +24 -11
  606. data/docs/TaxProviderAvalaraCompaniesResult.md +18 -8
  607. data/docs/TaxProviderAvalaraCompany.md +26 -12
  608. data/docs/TaxProviderSelf.md +26 -12
  609. data/docs/TaxProviderSelfCountriesResponse.md +18 -8
  610. data/docs/TaxProviderSelfRegionsResponse.md +18 -8
  611. data/docs/TaxProviderSovos.md +24 -11
  612. data/docs/TaxProviderTaxJar.md +24 -11
  613. data/docs/TaxProviderTestResult.md +20 -9
  614. data/docs/TaxProviderUltraCart.md +26 -12
  615. data/docs/TaxProviderUltraCartState.md +36 -17
  616. data/docs/TaxProvidersResponse.md +34 -16
  617. data/docs/TaxState.md +52 -25
  618. data/docs/TaxStateCode.md +26 -12
  619. data/docs/TempMultimedia.md +30 -14
  620. data/docs/TempMultimediaResponse.md +26 -12
  621. data/docs/ThumbnailParametersRequest.md +26 -12
  622. data/docs/ThumbnailParametersResponse.md +26 -12
  623. data/docs/TransactionEmail.md +56 -27
  624. data/docs/TransactionEmailListResponse.md +26 -12
  625. data/docs/TransactionEmailOption.md +32 -15
  626. data/docs/TransactionEmailResponse.md +26 -12
  627. data/docs/Twilio.md +24 -16
  628. data/docs/TwilioResponse.md +28 -13
  629. data/docs/TwiliosResponse.md +26 -12
  630. data/docs/UltraCartConfig.md +18 -10
  631. data/docs/UploadCouponCodesRequest.md +26 -12
  632. data/docs/UploadCouponCodesResponse.md +30 -14
  633. data/docs/User.md +44 -21
  634. data/docs/UserApi.md +823 -558
  635. data/docs/UserGroupMembership.md +22 -10
  636. data/docs/UserLogin.md +24 -11
  637. data/docs/UserLoginsResponse.md +26 -12
  638. data/docs/UserResponse.md +26 -12
  639. data/docs/UsersResponse.md +26 -12
  640. data/docs/VerificationRecord.md +22 -10
  641. data/docs/Warning.md +20 -9
  642. data/docs/Webhook.md +52 -26
  643. data/docs/WebhookApi.md +636 -447
  644. data/docs/WebhookEventCategory.md +26 -12
  645. data/docs/WebhookEventSubscription.md +34 -17
  646. data/docs/WebhookLog.md +38 -19
  647. data/docs/WebhookLogResponse.md +26 -12
  648. data/docs/WebhookLogSummariesResponse.md +26 -12
  649. data/docs/WebhookLogSummary.md +22 -10
  650. data/docs/WebhookResponse.md +26 -12
  651. data/docs/WebhookSampleRequest.md +24 -0
  652. data/docs/WebhookSampleRequestResponse.md +26 -0
  653. data/docs/WebhooksResponse.md +26 -12
  654. data/docs/Weight.md +20 -9
  655. data/git_push.sh +57 -55
  656. data/lib/ultracart_api/api/affiliate_api.rb +191 -164
  657. data/lib/ultracart_api/api/auto_order_api.rb +672 -706
  658. data/lib/ultracart_api/api/channel_partner_api.rb +370 -865
  659. data/lib/ultracart_api/api/chargeback_api.rb +410 -356
  660. data/lib/ultracart_api/api/checkout_api.rb +1341 -1111
  661. data/lib/ultracart_api/api/coupon_api.rb +1390 -1161
  662. data/lib/ultracart_api/api/customer_api.rb +1292 -1523
  663. data/lib/ultracart_api/api/fulfillment_api.rb +452 -381
  664. data/lib/ultracart_api/api/gift_certificate_api.rb +594 -502
  665. data/lib/ultracart_api/api/integration_log_api.rb +404 -350
  666. data/lib/ultracart_api/api/item_api.rb +686 -1412
  667. data/lib/ultracart_api/api/oauth_api.rb +198 -171
  668. data/lib/ultracart_api/api/order_api.rb +1728 -1703
  669. data/lib/ultracart_api/api/sso_api.rb +289 -243
  670. data/lib/ultracart_api/api/storefront_api.rb +11407 -10583
  671. data/lib/ultracart_api/api/tax_api.rb +1916 -1580
  672. data/lib/ultracart_api/api/user_api.rb +755 -634
  673. data/lib/ultracart_api/api/webhook_api.rb +601 -514
  674. data/lib/ultracart_api/api_client.rb +399 -400
  675. data/lib/ultracart_api/api_error.rb +57 -38
  676. data/lib/ultracart_api/configuration.rb +302 -229
  677. data/lib/ultracart_api/models/accounts_receivable_retry_config.rb +364 -341
  678. data/lib/ultracart_api/models/accounts_receivable_retry_config_response.rb +287 -252
  679. data/lib/ultracart_api/models/accounts_receivable_retry_day_activity.rb +240 -205
  680. data/lib/ultracart_api/models/accounts_receivable_retry_stat_account.rb +250 -215
  681. data/lib/ultracart_api/models/accounts_receivable_retry_stat_metrics.rb +309 -274
  682. data/lib/ultracart_api/models/accounts_receivable_retry_stat_revenue.rb +228 -193
  683. data/lib/ultracart_api/models/accounts_receivable_retry_stats_response.rb +267 -232
  684. data/lib/ultracart_api/models/activity.rb +264 -247
  685. data/lib/ultracart_api/models/add_library_item_request.rb +324 -289
  686. data/lib/ultracart_api/models/adjust_internal_certificate_request.rb +270 -235
  687. data/lib/ultracart_api/models/adjust_internal_certificate_response.rb +267 -232
  688. data/lib/ultracart_api/models/affiliate_click.rb +319 -304
  689. data/lib/ultracart_api/models/affiliate_click_query.rb +270 -235
  690. data/lib/ultracart_api/models/affiliate_clicks_response.rb +259 -224
  691. data/lib/ultracart_api/models/affiliate_ledger.rb +431 -396
  692. data/lib/ultracart_api/models/affiliate_ledger_query.rb +270 -235
  693. data/lib/ultracart_api/models/affiliate_ledgers_response.rb +259 -224
  694. data/lib/ultracart_api/models/affiliate_link.rb +408 -373
  695. data/lib/ultracart_api/models/api_user_application_profile.rb +260 -225
  696. data/lib/ultracart_api/models/apply_library_item_request.rb +250 -215
  697. data/lib/ultracart_api/models/apply_library_item_response.rb +319 -284
  698. data/lib/ultracart_api/models/auto_order.rb +469 -485
  699. data/lib/ultracart_api/models/auto_order_item.rb +487 -492
  700. data/lib/ultracart_api/models/auto_order_item_future_schedule.rb +250 -215
  701. data/lib/ultracart_api/models/auto_order_item_option.rb +260 -225
  702. data/lib/ultracart_api/models/auto_order_item_simple_schedule.rb +274 -239
  703. data/lib/ultracart_api/models/auto_order_log.rb +230 -195
  704. data/lib/ultracart_api/models/auto_order_query.rb +480 -445
  705. data/lib/ultracart_api/models/auto_order_query_batch.rb +222 -187
  706. data/lib/ultracart_api/models/auto_order_response.rb +256 -221
  707. data/lib/ultracart_api/models/auto_orders_request.rb +222 -187
  708. data/lib/ultracart_api/models/auto_orders_response.rb +258 -223
  709. data/lib/ultracart_api/models/avalara_config.rb +340 -305
  710. data/lib/ultracart_api/models/base_response.rb +247 -212
  711. data/lib/ultracart_api/models/browser.rb +237 -202
  712. data/lib/ultracart_api/models/browser_device.rb +219 -184
  713. data/lib/ultracart_api/models/browser_os.rb +255 -220
  714. data/lib/ultracart_api/models/browser_user_agent.rb +246 -211
  715. data/lib/ultracart_api/models/cart.rb +506 -471
  716. data/lib/ultracart_api/models/cart_affiliate.rb +245 -210
  717. data/lib/ultracart_api/models/cart_affirm_checkout_response.rb +232 -197
  718. data/lib/ultracart_api/models/cart_billing.rb +572 -587
  719. data/lib/ultracart_api/models/cart_buysafe.rb +269 -234
  720. data/lib/ultracart_api/models/cart_checkout.rb +500 -550
  721. data/lib/ultracart_api/models/cart_coupon.rb +220 -185
  722. data/lib/ultracart_api/models/cart_currency_conversion.rb +232 -197
  723. data/lib/ultracart_api/models/cart_customer_profile.rb +438 -413
  724. data/lib/ultracart_api/models/cart_customer_profile_address.rb +350 -315
  725. data/lib/ultracart_api/models/cart_customer_profile_credit_card.rb +304 -269
  726. data/lib/ultracart_api/models/cart_finalize_order_request.rb +228 -193
  727. data/lib/ultracart_api/models/cart_finalize_order_request_options.rb +355 -320
  728. data/lib/ultracart_api/models/cart_finalize_order_response.rb +260 -225
  729. data/lib/ultracart_api/models/cart_gift.rb +313 -278
  730. data/lib/ultracart_api/models/cart_gift_certificate.rb +238 -203
  731. data/lib/ultracart_api/models/cart_item.rb +504 -481
  732. data/lib/ultracart_api/models/cart_item_attribute.rb +240 -205
  733. data/lib/ultracart_api/models/cart_item_multimedia.rb +336 -301
  734. data/lib/ultracart_api/models/cart_item_multimedia_thumbnail.rb +260 -225
  735. data/lib/ultracart_api/models/cart_item_option.rb +378 -343
  736. data/lib/ultracart_api/models/cart_item_option_value.rb +258 -223
  737. data/lib/ultracart_api/models/cart_item_physical.rb +246 -211
  738. data/lib/ultracart_api/models/cart_item_variation_selection.rb +230 -195
  739. data/lib/ultracart_api/models/cart_kit_component_option.rb +398 -363
  740. data/lib/ultracart_api/models/cart_marketing.rb +230 -205
  741. data/lib/ultracart_api/models/cart_payment.rb +275 -249
  742. data/lib/ultracart_api/models/cart_payment_affirm.rb +220 -185
  743. data/lib/ultracart_api/models/cart_payment_amazon.rb +220 -185
  744. data/lib/ultracart_api/models/cart_payment_check.rb +220 -185
  745. data/lib/ultracart_api/models/cart_payment_credit_card.rb +300 -265
  746. data/lib/ultracart_api/models/cart_payment_purchase_order.rb +220 -185
  747. data/lib/ultracart_api/models/cart_profile_login_request.rb +239 -204
  748. data/lib/ultracart_api/models/cart_profile_login_response.rb +231 -196
  749. data/lib/ultracart_api/models/cart_profile_register_request.rb +229 -194
  750. data/lib/ultracart_api/models/cart_profile_register_response.rb +231 -196
  751. data/lib/ultracart_api/models/cart_property.rb +280 -245
  752. data/lib/ultracart_api/models/cart_response.rb +231 -196
  753. data/lib/ultracart_api/models/cart_settings.rb +264 -229
  754. data/lib/ultracart_api/models/cart_settings_billing.rb +222 -187
  755. data/lib/ultracart_api/models/cart_settings_gift.rb +251 -216
  756. data/lib/ultracart_api/models/cart_settings_gift_wrap.rb +239 -204
  757. data/lib/ultracart_api/models/cart_settings_payment.rb +337 -302
  758. data/lib/ultracart_api/models/cart_settings_payment_amazon.rb +240 -205
  759. data/lib/ultracart_api/models/cart_settings_payment_credit_card.rb +242 -217
  760. data/lib/ultracart_api/models/cart_settings_payment_pay_pal.rb +260 -225
  761. data/lib/ultracart_api/models/cart_settings_province.rb +228 -193
  762. data/lib/ultracart_api/models/cart_settings_shipping.rb +262 -227
  763. data/lib/ultracart_api/models/cart_settings_shipping_calendar.rb +264 -229
  764. data/lib/ultracart_api/models/cart_settings_shipping_estimate.rb +345 -310
  765. data/lib/ultracart_api/models/cart_settings_taxes.rb +221 -186
  766. data/lib/ultracart_api/models/cart_settings_terms.rb +230 -195
  767. data/lib/ultracart_api/models/cart_shipping.rb +625 -590
  768. data/lib/ultracart_api/models/cart_summary.rb +354 -356
  769. data/lib/ultracart_api/models/cart_taxes.rb +255 -220
  770. data/lib/ultracart_api/models/cart_upsell_after.rb +255 -220
  771. data/lib/ultracart_api/models/cart_validation_request.rb +231 -196
  772. data/lib/ultracart_api/models/cart_validation_response.rb +231 -196
  773. data/lib/ultracart_api/models/channel_partner_cancel_response.rb +259 -224
  774. data/lib/ultracart_api/models/channel_partner_estimate_shipping_response.rb +259 -224
  775. data/lib/ultracart_api/models/channel_partner_estimate_tax_response.rb +256 -221
  776. data/lib/ultracart_api/models/channel_partner_import_response.rb +281 -246
  777. data/lib/ultracart_api/models/channel_partner_order.rb +1604 -1713
  778. data/lib/ultracart_api/models/channel_partner_order_item.rb +331 -296
  779. data/lib/ultracart_api/models/channel_partner_order_item_option.rb +230 -195
  780. data/lib/ultracart_api/models/channel_partner_order_transaction.rb +232 -197
  781. data/lib/ultracart_api/models/channel_partner_order_transaction_detail.rb +230 -195
  782. data/lib/ultracart_api/models/channel_partner_shipping_estimate.rb +230 -195
  783. data/lib/ultracart_api/models/chargeback_dispute.rb +649 -614
  784. data/lib/ultracart_api/models/chargeback_dispute_response.rb +256 -221
  785. data/lib/ultracart_api/models/chargeback_disputes_response.rb +258 -223
  786. data/lib/ultracart_api/models/checkout_allowed_countries_response.rb +221 -186
  787. data/lib/ultracart_api/models/checkout_handoff_request.rb +323 -288
  788. data/lib/ultracart_api/models/checkout_handoff_response.rb +241 -206
  789. data/lib/ultracart_api/models/checkout_setup_browser_key_request.rb +222 -187
  790. data/lib/ultracart_api/models/checkout_setup_browser_key_response.rb +220 -185
  791. data/lib/ultracart_api/models/checkout_state_province_response.rb +221 -186
  792. data/lib/ultracart_api/models/city_state_zip.rb +255 -220
  793. data/lib/ultracart_api/models/countries_response.rb +221 -186
  794. data/lib/ultracart_api/models/country.rb +260 -225
  795. data/lib/ultracart_api/models/coupon.rb +864 -917
  796. data/lib/ultracart_api/models/coupon_amount_off_items.rb +267 -244
  797. data/lib/ultracart_api/models/coupon_amount_off_shipping.rb +257 -222
  798. data/lib/ultracart_api/models/coupon_amount_off_shipping_with_items_purchase.rb +269 -234
  799. data/lib/ultracart_api/models/coupon_amount_off_subtotal.rb +245 -210
  800. data/lib/ultracart_api/models/coupon_amount_off_subtotal_and_shipping.rb +245 -210
  801. data/lib/ultracart_api/models/coupon_amount_off_subtotal_free_shipping_with_purchase.rb +267 -232
  802. data/lib/ultracart_api/models/coupon_amount_off_subtotal_with_block_purchase.rb +265 -230
  803. data/lib/ultracart_api/models/coupon_amount_off_subtotal_with_items_purchase.rb +267 -232
  804. data/lib/ultracart_api/models/coupon_amount_off_subtotal_with_purchase.rb +255 -220
  805. data/lib/ultracart_api/models/coupon_amount_shipping_with_subtotal.rb +267 -232
  806. data/lib/ultracart_api/models/coupon_auto_apply_condition.rb +239 -204
  807. data/lib/ultracart_api/models/coupon_auto_apply_conditions.rb +269 -234
  808. data/lib/ultracart_api/models/coupon_automatically_apply_coupon_codes.rb +222 -187
  809. data/lib/ultracart_api/models/coupon_buy_one_get_one_limit.rb +232 -209
  810. data/lib/ultracart_api/models/coupon_codes_request.rb +277 -242
  811. data/lib/ultracart_api/models/coupon_codes_response.rb +269 -234
  812. data/lib/ultracart_api/models/coupon_deletes_request.rb +234 -199
  813. data/lib/ultracart_api/models/coupon_discount_item_with_item_purchase.rb +275 -264
  814. data/lib/ultracart_api/models/coupon_discount_items.rb +267 -232
  815. data/lib/ultracart_api/models/coupon_editor_values.rb +330 -307
  816. data/lib/ultracart_api/models/coupon_exists_response.rb +267 -232
  817. data/lib/ultracart_api/models/coupon_free_item_and_shipping_with_subtotal.rb +279 -244
  818. data/lib/ultracart_api/models/coupon_free_item_with_item_purchase.rb +254 -243
  819. data/lib/ultracart_api/models/coupon_free_item_with_subtotal.rb +267 -232
  820. data/lib/ultracart_api/models/coupon_free_items_with_item_purchase.rb +260 -225
  821. data/lib/ultracart_api/models/coupon_free_items_with_mix_match_purchase.rb +260 -225
  822. data/lib/ultracart_api/models/coupon_free_shipping.rb +222 -187
  823. data/lib/ultracart_api/models/coupon_free_shipping_specific_items.rb +222 -187
  824. data/lib/ultracart_api/models/coupon_free_shipping_with_items_purchase.rb +234 -199
  825. data/lib/ultracart_api/models/coupon_free_shipping_with_subtotal.rb +257 -222
  826. data/lib/ultracart_api/models/coupon_item_search_result.rb +290 -255
  827. data/lib/ultracart_api/models/coupon_item_search_results_response.rb +259 -224
  828. data/lib/ultracart_api/models/coupon_multiple_amounts_off_items.rb +232 -197
  829. data/lib/ultracart_api/models/coupon_percent_off_item_with_items_quantity_purchase.rb +264 -253
  830. data/lib/ultracart_api/models/coupon_percent_off_items.rb +254 -243
  831. data/lib/ultracart_api/models/coupon_percent_off_items_and_free_shipping.rb +244 -233
  832. data/lib/ultracart_api/models/coupon_percent_off_items_with_items_purchase.rb +254 -243
  833. data/lib/ultracart_api/models/coupon_percent_off_msrp_items.rb +254 -239
  834. data/lib/ultracart_api/models/coupon_percent_off_retail_price_items.rb +254 -219
  835. data/lib/ultracart_api/models/coupon_percent_off_shipping.rb +232 -197
  836. data/lib/ultracart_api/models/coupon_percent_off_subtotal.rb +220 -185
  837. data/lib/ultracart_api/models/coupon_percent_off_subtotal_and_free_shipping.rb +232 -197
  838. data/lib/ultracart_api/models/coupon_percent_off_subtotal_limit.rb +255 -220
  839. data/lib/ultracart_api/models/coupon_percent_off_subtotal_with_items_purchase.rb +232 -197
  840. data/lib/ultracart_api/models/coupon_percent_off_subtotal_with_subtotal.rb +255 -220
  841. data/lib/ultracart_api/models/coupon_query.rb +310 -275
  842. data/lib/ultracart_api/models/coupon_response.rb +268 -233
  843. data/lib/ultracart_api/models/coupon_restriction.rb +246 -211
  844. data/lib/ultracart_api/models/coupon_tier_amount.rb +255 -220
  845. data/lib/ultracart_api/models/coupon_tier_item_discount.rb +232 -197
  846. data/lib/ultracart_api/models/coupon_tier_percent.rb +255 -220
  847. data/lib/ultracart_api/models/coupon_tier_quantity_amount.rb +255 -220
  848. data/lib/ultracart_api/models/coupon_tier_quantity_percent.rb +255 -220
  849. data/lib/ultracart_api/models/coupon_tiered_amount_off_items.rb +244 -221
  850. data/lib/ultracart_api/models/coupon_tiered_amount_off_subtotal.rb +234 -199
  851. data/lib/ultracart_api/models/coupon_tiered_percent_off_items.rb +244 -221
  852. data/lib/ultracart_api/models/coupon_tiered_percent_off_shipping.rb +259 -224
  853. data/lib/ultracart_api/models/coupon_tiered_percent_off_subtotal.rb +234 -199
  854. data/lib/ultracart_api/models/coupon_type.rb +230 -195
  855. data/lib/ultracart_api/models/coupons_request.rb +222 -187
  856. data/lib/ultracart_api/models/coupons_response.rb +258 -223
  857. data/lib/ultracart_api/models/currency.rb +260 -225
  858. data/lib/ultracart_api/models/customer.rb +978 -994
  859. data/lib/ultracart_api/models/customer_activity.rb +254 -255
  860. data/lib/ultracart_api/models/customer_affiliate.rb +250 -215
  861. data/lib/ultracart_api/models/customer_attachment.rb +260 -225
  862. data/lib/ultracart_api/models/customer_billing.rb +575 -540
  863. data/lib/ultracart_api/models/customer_card.rb +290 -255
  864. data/lib/ultracart_api/models/customer_editor_values.rb +328 -317
  865. data/lib/ultracart_api/models/customer_email.rb +300 -265
  866. data/lib/ultracart_api/models/customer_email_list_changes.rb +234 -199
  867. data/lib/ultracart_api/models/customer_loyalty.rb +283 -248
  868. data/lib/ultracart_api/models/customer_loyalty_ledger.rb +360 -325
  869. data/lib/ultracart_api/models/customer_loyalty_redemption.rb +340 -305
  870. data/lib/ultracart_api/models/customer_orders_summary.rb +250 -215
  871. data/lib/ultracart_api/models/customer_pricing_tier.rb +245 -210
  872. data/lib/ultracart_api/models/customer_privacy.rb +250 -215
  873. data/lib/ultracart_api/models/customer_query.rb +789 -766
  874. data/lib/ultracart_api/models/customer_quotes_summary.rb +250 -215
  875. data/lib/ultracart_api/models/customer_response.rb +256 -221
  876. data/lib/ultracart_api/models/customer_reviewer.rb +310 -275
  877. data/lib/ultracart_api/models/customer_shipping.rb +575 -540
  878. data/lib/ultracart_api/models/customer_software_entitlement.rb +365 -330
  879. data/lib/ultracart_api/models/customer_store_credit.rb +274 -239
  880. data/lib/ultracart_api/models/customer_store_credit_add_request.rb +250 -215
  881. data/lib/ultracart_api/models/customer_store_credit_ledger_entry.rb +295 -260
  882. data/lib/ultracart_api/models/customer_store_credit_response.rb +256 -221
  883. data/lib/ultracart_api/models/customer_tag.rb +235 -200
  884. data/lib/ultracart_api/models/customer_tax_codes.rb +260 -225
  885. data/lib/ultracart_api/models/customers_response.rb +258 -223
  886. data/lib/ultracart_api/models/data_tables_server_side_response.rb +248 -213
  887. data/lib/ultracart_api/models/distance.rb +264 -229
  888. data/lib/ultracart_api/models/distribution_center.rb +559 -674
  889. data/lib/ultracart_api/models/distribution_centers_response.rb +258 -223
  890. data/lib/ultracart_api/models/email_base_template_list_response.rb +221 -186
  891. data/lib/ultracart_api/models/email_campaign.rb +467 -452
  892. data/lib/ultracart_api/models/email_campaign_folder.rb +275 -240
  893. data/lib/ultracart_api/models/email_campaign_folder_response.rb +256 -221
  894. data/lib/ultracart_api/models/email_campaign_folders_response.rb +258 -223
  895. data/lib/ultracart_api/models/email_campaign_response.rb +256 -221
  896. data/lib/ultracart_api/models/email_campaigns_response.rb +258 -223
  897. data/lib/ultracart_api/models/email_click.rb +230 -195
  898. data/lib/ultracart_api/models/email_clicks_response.rb +258 -223
  899. data/lib/ultracart_api/models/email_commseq.rb +252 -217
  900. data/lib/ultracart_api/models/email_commseq_email.rb +470 -507
  901. data/lib/ultracart_api/models/email_commseq_email_response.rb +256 -221
  902. data/lib/ultracart_api/models/email_commseq_email_send_test_request.rb +304 -269
  903. data/lib/ultracart_api/models/email_commseq_email_send_test_response.rb +247 -212
  904. data/lib/ultracart_api/models/email_commseq_emails_request.rb +258 -223
  905. data/lib/ultracart_api/models/email_commseq_emails_response.rb +258 -223
  906. data/lib/ultracart_api/models/email_commseq_postcard.rb +340 -305
  907. data/lib/ultracart_api/models/email_commseq_postcard_response.rb +256 -221
  908. data/lib/ultracart_api/models/email_commseq_postcard_send_test_request.rb +329 -294
  909. data/lib/ultracart_api/models/email_commseq_postcard_send_test_response.rb +274 -239
  910. data/lib/ultracart_api/models/email_commseq_postcards_request.rb +221 -186
  911. data/lib/ultracart_api/models/email_commseq_postcards_response.rb +258 -223
  912. data/lib/ultracart_api/models/email_commseq_response.rb +256 -221
  913. data/lib/ultracart_api/models/email_commseq_stat.rb +580 -545
  914. data/lib/ultracart_api/models/email_commseq_stat_response.rb +256 -221
  915. data/lib/ultracart_api/models/email_commseq_step.rb +348 -313
  916. data/lib/ultracart_api/models/email_commseq_step_log.rb +240 -205
  917. data/lib/ultracart_api/models/email_commseq_step_logs_response.rb +258 -223
  918. data/lib/ultracart_api/models/email_commseq_webhook_send_test_request.rb +275 -240
  919. data/lib/ultracart_api/models/email_commseq_webhook_send_test_response.rb +277 -242
  920. data/lib/ultracart_api/models/email_commseqs_response.rb +258 -223
  921. data/lib/ultracart_api/models/email_customer.rb +292 -257
  922. data/lib/ultracart_api/models/email_customer_editor_url_response.rb +256 -221
  923. data/lib/ultracart_api/models/email_customers_response.rb +262 -227
  924. data/lib/ultracart_api/models/email_dashboard_activity.rb +280 -245
  925. data/lib/ultracart_api/models/email_dashboard_activity_response.rb +258 -223
  926. data/lib/ultracart_api/models/email_dashboard_stats_response.rb +258 -223
  927. data/lib/ultracart_api/models/email_domain.rb +329 -294
  928. data/lib/ultracart_api/models/email_editor_token_response.rb +256 -221
  929. data/lib/ultracart_api/models/email_flow.rb +505 -500
  930. data/lib/ultracart_api/models/email_flow_back_populate_request.rb +230 -195
  931. data/lib/ultracart_api/models/email_flow_back_populate_response.rb +247 -212
  932. data/lib/ultracart_api/models/email_flow_folder.rb +275 -240
  933. data/lib/ultracart_api/models/email_flow_folder_response.rb +256 -221
  934. data/lib/ultracart_api/models/email_flow_folders_response.rb +258 -223
  935. data/lib/ultracart_api/models/email_flow_response.rb +256 -221
  936. data/lib/ultracart_api/models/email_flows_response.rb +258 -223
  937. data/lib/ultracart_api/models/email_global_settings.rb +219 -184
  938. data/lib/ultracart_api/models/email_global_settings_response.rb +256 -221
  939. data/lib/ultracart_api/models/email_global_unsubscribe_request.rb +219 -184
  940. data/lib/ultracart_api/models/email_global_unsubscribe_response.rb +219 -184
  941. data/lib/ultracart_api/models/email_histogram_property_names_response.rb +221 -186
  942. data/lib/ultracart_api/models/email_histogram_property_values_response.rb +221 -186
  943. data/lib/ultracart_api/models/email_list.rb +347 -312
  944. data/lib/ultracart_api/models/email_list_archive_response.rb +256 -221
  945. data/lib/ultracart_api/models/email_list_customer.rb +250 -215
  946. data/lib/ultracart_api/models/email_list_customers_response.rb +262 -227
  947. data/lib/ultracart_api/models/email_list_response.rb +256 -221
  948. data/lib/ultracart_api/models/email_list_segment_folder.rb +275 -240
  949. data/lib/ultracart_api/models/email_list_segment_folder_response.rb +256 -221
  950. data/lib/ultracart_api/models/email_list_segment_folders_response.rb +258 -223
  951. data/lib/ultracart_api/models/email_list_segment_membership.rb +250 -215
  952. data/lib/ultracart_api/models/email_list_segment_used_by.rb +240 -205
  953. data/lib/ultracart_api/models/email_list_subscribe_response.rb +228 -193
  954. data/lib/ultracart_api/models/email_lists_response.rb +258 -223
  955. data/lib/ultracart_api/models/email_order.rb +249 -214
  956. data/lib/ultracart_api/models/email_orders_response.rb +258 -223
  957. data/lib/ultracart_api/models/email_performance.rb +475 -440
  958. data/lib/ultracart_api/models/email_performance_customer_histogram.rb +222 -187
  959. data/lib/ultracart_api/models/email_performance_customer_histogram_period.rb +260 -225
  960. data/lib/ultracart_api/models/email_performance_daily.rb +280 -245
  961. data/lib/ultracart_api/models/email_performance_response.rb +256 -221
  962. data/lib/ultracart_api/models/email_plan.rb +365 -330
  963. data/lib/ultracart_api/models/email_plan_additional.rb +291 -256
  964. data/lib/ultracart_api/models/email_plan_response.rb +256 -221
  965. data/lib/ultracart_api/models/email_postcard_stat.rb +531 -496
  966. data/lib/ultracart_api/models/email_segment.rb +445 -420
  967. data/lib/ultracart_api/models/email_segment_archive_response.rb +256 -221
  968. data/lib/ultracart_api/models/email_segment_customer.rb +250 -215
  969. data/lib/ultracart_api/models/email_segment_customers_response.rb +262 -227
  970. data/lib/ultracart_api/models/email_segment_download_prepare_response.rb +283 -248
  971. data/lib/ultracart_api/models/email_segment_response.rb +256 -221
  972. data/lib/ultracart_api/models/email_segments_response.rb +258 -223
  973. data/lib/ultracart_api/models/email_sending_domain_response.rb +256 -221
  974. data/lib/ultracart_api/models/email_sending_domains_response.rb +258 -223
  975. data/lib/ultracart_api/models/email_settings.rb +318 -351
  976. data/lib/ultracart_api/models/email_settings_response.rb +256 -221
  977. data/lib/ultracart_api/models/email_stat.rb +591 -556
  978. data/lib/ultracart_api/models/email_stat_postcard_summary_request.rb +230 -195
  979. data/lib/ultracart_api/models/email_stat_postcard_summary_response.rb +258 -223
  980. data/lib/ultracart_api/models/email_stat_summary_request.rb +241 -206
  981. data/lib/ultracart_api/models/email_stat_summary_response.rb +258 -223
  982. data/lib/ultracart_api/models/email_step_stat.rb +410 -475
  983. data/lib/ultracart_api/models/email_step_stat_request.rb +230 -195
  984. data/lib/ultracart_api/models/email_step_stat_response.rb +258 -223
  985. data/lib/ultracart_api/models/email_step_waiting_request.rb +221 -186
  986. data/lib/ultracart_api/models/email_step_waiting_response.rb +221 -186
  987. data/lib/ultracart_api/models/email_template.rb +365 -330
  988. data/lib/ultracart_api/models/email_templates_response.rb +258 -223
  989. data/lib/ultracart_api/models/email_third_party_list.rb +230 -195
  990. data/lib/ultracart_api/models/email_third_party_list_import_request.rb +222 -187
  991. data/lib/ultracart_api/models/email_third_party_provider.rb +324 -289
  992. data/lib/ultracart_api/models/email_third_party_providers_response.rb +258 -223
  993. data/lib/ultracart_api/models/email_third_party_tag.rb +230 -195
  994. data/lib/ultracart_api/models/email_verify_token_request.rb +230 -195
  995. data/lib/ultracart_api/models/email_verify_token_response.rb +257 -222
  996. data/lib/ultracart_api/models/email_verify_token_validate_request.rb +220 -185
  997. data/lib/ultracart_api/models/email_verify_token_validate_response.rb +247 -212
  998. data/lib/ultracart_api/models/email_webhook_editor_values_response.rb +278 -243
  999. data/lib/ultracart_api/models/error.rb +260 -225
  1000. data/lib/ultracart_api/models/error_response.rb +247 -212
  1001. data/lib/ultracart_api/models/experiment.rb +426 -463
  1002. data/lib/ultracart_api/models/experiment_response.rb +256 -221
  1003. data/lib/ultracart_api/models/experiment_variation.rb +432 -407
  1004. data/lib/ultracart_api/models/experiment_variation_stat.rb +320 -307
  1005. data/lib/ultracart_api/models/experiments_response.rb +258 -223
  1006. data/lib/ultracart_api/models/fulfillment_inventory.rb +228 -193
  1007. data/lib/ultracart_api/models/fulfillment_shipment.rb +262 -227
  1008. data/lib/ultracart_api/models/geo_point.rb +228 -193
  1009. data/lib/ultracart_api/models/geocode_request.rb +260 -225
  1010. data/lib/ultracart_api/models/geocode_response.rb +265 -230
  1011. data/lib/ultracart_api/models/gift_certificate.rb +367 -332
  1012. data/lib/ultracart_api/models/gift_certificate_create_request.rb +260 -225
  1013. data/lib/ultracart_api/models/gift_certificate_ledger_entry.rb +285 -250
  1014. data/lib/ultracart_api/models/gift_certificate_query.rb +300 -265
  1015. data/lib/ultracart_api/models/gift_certificate_response.rb +256 -221
  1016. data/lib/ultracart_api/models/gift_certificates_response.rb +258 -223
  1017. data/lib/ultracart_api/models/group.rb +266 -231
  1018. data/lib/ultracart_api/models/group_response.rb +256 -221
  1019. data/lib/ultracart_api/models/group_user_membership.rb +260 -225
  1020. data/lib/ultracart_api/models/groups_response.rb +258 -223
  1021. data/lib/ultracart_api/models/http_header.rb +230 -195
  1022. data/lib/ultracart_api/models/integration_log.rb +379 -355
  1023. data/lib/ultracart_api/models/integration_log_file.rb +246 -211
  1024. data/lib/ultracart_api/models/integration_log_log.rb +228 -193
  1025. data/lib/ultracart_api/models/integration_log_query_filter_values.rb +340 -305
  1026. data/lib/ultracart_api/models/integration_log_query_request.rb +333 -329
  1027. data/lib/ultracart_api/models/integration_log_query_response.rb +267 -232
  1028. data/lib/ultracart_api/models/integration_log_response.rb +256 -221
  1029. data/lib/ultracart_api/models/integration_log_summary.rb +291 -256
  1030. data/lib/ultracart_api/models/integration_log_summary_query_request.rb +230 -195
  1031. data/lib/ultracart_api/models/integration_log_summary_query_response.rb +258 -223
  1032. data/lib/ultracart_api/models/item.rb +748 -713
  1033. data/lib/ultracart_api/models/item_accounting.rb +260 -225
  1034. data/lib/ultracart_api/models/item_amember.rb +245 -210
  1035. data/lib/ultracart_api/models/item_auto_order.rb +403 -418
  1036. data/lib/ultracart_api/models/item_auto_order_step.rb +413 -398
  1037. data/lib/ultracart_api/models/item_auto_order_step_arbitrary_unit_cost_schedule.rb +230 -195
  1038. data/lib/ultracart_api/models/item_auto_order_step_grandfather_pricing.rb +230 -195
  1039. data/lib/ultracart_api/models/item_cc_bill.rb +270 -235
  1040. data/lib/ultracart_api/models/item_channel_partner_mapping.rb +445 -410
  1041. data/lib/ultracart_api/models/item_chargeback.rb +234 -199
  1042. data/lib/ultracart_api/models/item_chargeback_addendum.rb +250 -215
  1043. data/lib/ultracart_api/models/item_chargeback_adjustment_request.rb +240 -205
  1044. data/lib/ultracart_api/models/item_checkout.rb +265 -230
  1045. data/lib/ultracart_api/models/item_content.rb +361 -356
  1046. data/lib/ultracart_api/models/item_content_assignment.rb +285 -250
  1047. data/lib/ultracart_api/models/item_content_attribute.rb +280 -245
  1048. data/lib/ultracart_api/models/item_content_multimedia.rb +441 -406
  1049. data/lib/ultracart_api/models/item_content_multimedia_thumbnail.rb +270 -235
  1050. data/lib/ultracart_api/models/item_digital_delivery.rb +317 -282
  1051. data/lib/ultracart_api/models/item_digital_item.rb +305 -334
  1052. data/lib/ultracart_api/models/item_ebay.rb +901 -866
  1053. data/lib/ultracart_api/models/item_ebay_category_specific.rb +230 -195
  1054. data/lib/ultracart_api/models/item_ebay_market_listing.rb +260 -225
  1055. data/lib/ultracart_api/models/item_ebay_market_place_analysis.rb +311 -276
  1056. data/lib/ultracart_api/models/item_email_notifications.rb +230 -195
  1057. data/lib/ultracart_api/models/item_enrollment123.rb +220 -185
  1058. data/lib/ultracart_api/models/item_fulfillment_addon.rb +250 -225
  1059. data/lib/ultracart_api/models/item_gift_certificate.rb +230 -195
  1060. data/lib/ultracart_api/models/item_google_product_search.rb +1289 -1254
  1061. data/lib/ultracart_api/models/item_identifiers.rb +310 -375
  1062. data/lib/ultracart_api/models/item_instant_payment_notification.rb +270 -235
  1063. data/lib/ultracart_api/models/item_instant_payment_notifications.rb +222 -187
  1064. data/lib/ultracart_api/models/item_internal.rb +235 -200
  1065. data/lib/ultracart_api/models/item_kit_component.rb +260 -225
  1066. data/lib/ultracart_api/models/item_kit_definition.rb +222 -187
  1067. data/lib/ultracart_api/models/item_option.rb +416 -381
  1068. data/lib/ultracart_api/models/item_option_value.rb +409 -374
  1069. data/lib/ultracart_api/models/item_option_value_additional_item.rb +230 -195
  1070. data/lib/ultracart_api/models/item_option_value_digital_item.rb +230 -195
  1071. data/lib/ultracart_api/models/item_payment_processing.rb +264 -239
  1072. data/lib/ultracart_api/models/item_physical.rb +246 -211
  1073. data/lib/ultracart_api/models/item_pricing.rb +422 -387
  1074. data/lib/ultracart_api/models/item_pricing_tier.rb +261 -226
  1075. data/lib/ultracart_api/models/item_pricing_tier_discount.rb +230 -195
  1076. data/lib/ultracart_api/models/item_pricing_tier_limit.rb +240 -227
  1077. data/lib/ultracart_api/models/item_property.rb +270 -235
  1078. data/lib/ultracart_api/models/item_realtime_pricing.rb +240 -205
  1079. data/lib/ultracart_api/models/item_related.rb +242 -207
  1080. data/lib/ultracart_api/models/item_related_item.rb +274 -239
  1081. data/lib/ultracart_api/models/item_reporting.rb +232 -197
  1082. data/lib/ultracart_api/models/item_response.rb +256 -221
  1083. data/lib/ultracart_api/models/item_restriction.rb +292 -257
  1084. data/lib/ultracart_api/models/item_restriction_item.rb +274 -239
  1085. data/lib/ultracart_api/models/item_revguard.rb +280 -245
  1086. data/lib/ultracart_api/models/item_reviews.rb +300 -276
  1087. data/lib/ultracart_api/models/item_salesforce.rb +230 -195
  1088. data/lib/ultracart_api/models/item_shipping.rb +713 -688
  1089. data/lib/ultracart_api/models/item_shipping_case.rb +265 -230
  1090. data/lib/ultracart_api/models/item_shipping_destination_markup.rb +315 -290
  1091. data/lib/ultracart_api/models/item_shipping_destination_restriction.rb +304 -269
  1092. data/lib/ultracart_api/models/item_shipping_distribution_center.rb +380 -345
  1093. data/lib/ultracart_api/models/item_shipping_method.rb +394 -359
  1094. data/lib/ultracart_api/models/item_shipping_package_requirement.rb +230 -195
  1095. data/lib/ultracart_api/models/item_tag.rb +279 -244
  1096. data/lib/ultracart_api/models/item_tags.rb +222 -187
  1097. data/lib/ultracart_api/models/item_tax.rb +286 -251
  1098. data/lib/ultracart_api/models/item_tax_exemption.rb +335 -300
  1099. data/lib/ultracart_api/models/item_third_party_email_marketing.rb +302 -267
  1100. data/lib/ultracart_api/models/item_variant_item.rb +289 -254
  1101. data/lib/ultracart_api/models/item_variation.rb +292 -257
  1102. data/lib/ultracart_api/models/item_variation_option.rb +265 -230
  1103. data/lib/ultracart_api/models/item_wishlist_member.rb +255 -220
  1104. data/lib/ultracart_api/models/items_request.rb +222 -187
  1105. data/lib/ultracart_api/models/items_response.rb +259 -224
  1106. data/lib/ultracart_api/models/key_value.rb +240 -205
  1107. data/lib/ultracart_api/models/library_filter_values.rb +254 -219
  1108. data/lib/ultracart_api/models/library_filter_values_response.rb +256 -221
  1109. data/lib/ultracart_api/models/library_item.rb +606 -571
  1110. data/lib/ultracart_api/models/library_item_account.rb +237 -202
  1111. data/lib/ultracart_api/models/library_item_asset.rb +228 -193
  1112. data/lib/ultracart_api/models/library_item_attribute.rb +228 -193
  1113. data/lib/ultracart_api/models/library_item_email.rb +237 -202
  1114. data/lib/ultracart_api/models/library_item_published_meta.rb +290 -255
  1115. data/lib/ultracart_api/models/library_item_purchased_meta.rb +240 -205
  1116. data/lib/ultracart_api/models/library_item_query.rb +330 -295
  1117. data/lib/ultracart_api/models/library_item_response.rb +256 -221
  1118. data/lib/ultracart_api/models/library_item_screenshot.rb +228 -193
  1119. data/lib/ultracart_api/models/library_items_response.rb +259 -224
  1120. data/lib/ultracart_api/models/linked_account.rb +240 -205
  1121. data/lib/ultracart_api/models/list_segment_membership.rb +237 -202
  1122. data/lib/ultracart_api/models/lookup_request.rb +255 -229
  1123. data/lib/ultracart_api/models/lookup_response.rb +258 -223
  1124. data/lib/ultracart_api/models/mailgun.rb +219 -184
  1125. data/lib/ultracart_api/models/metric.rb +282 -247
  1126. data/lib/ultracart_api/models/notification.rb +322 -287
  1127. data/lib/ultracart_api/models/oauth_revoke_success_response.rb +230 -195
  1128. data/lib/ultracart_api/models/oauth_token_response.rb +321 -286
  1129. data/lib/ultracart_api/models/order.rb +604 -622
  1130. data/lib/ultracart_api/models/order_affiliate.rb +242 -207
  1131. data/lib/ultracart_api/models/order_affiliate_ledger.rb +334 -299
  1132. data/lib/ultracart_api/models/order_auto_order.rb +448 -413
  1133. data/lib/ultracart_api/models/order_billing.rb +597 -612
  1134. data/lib/ultracart_api/models/order_buysafe.rb +268 -233
  1135. data/lib/ultracart_api/models/order_by_token_query.rb +220 -185
  1136. data/lib/ultracart_api/models/order_channel_partner.rb +335 -300
  1137. data/lib/ultracart_api/models/order_checkout.rb +469 -509
  1138. data/lib/ultracart_api/models/order_coupon.rb +290 -255
  1139. data/lib/ultracart_api/models/order_digital_item.rb +290 -255
  1140. data/lib/ultracart_api/models/order_digital_order.rb +262 -227
  1141. data/lib/ultracart_api/models/order_edi.rb +265 -230
  1142. data/lib/ultracart_api/models/order_format.rb +404 -369
  1143. data/lib/ultracart_api/models/order_format_response.rb +232 -197
  1144. data/lib/ultracart_api/models/order_fraud_score.rb +444 -409
  1145. data/lib/ultracart_api/models/order_gift.rb +351 -316
  1146. data/lib/ultracart_api/models/order_gift_certificate.rb +239 -204
  1147. data/lib/ultracart_api/models/order_internal.rb +275 -252
  1148. data/lib/ultracart_api/models/order_item.rb +889 -1028
  1149. data/lib/ultracart_api/models/order_item_edi.rb +234 -199
  1150. data/lib/ultracart_api/models/order_item_edi_identification.rb +230 -195
  1151. data/lib/ultracart_api/models/order_item_edi_lot.rb +240 -205
  1152. data/lib/ultracart_api/models/order_item_option.rb +378 -343
  1153. data/lib/ultracart_api/models/order_item_option_file_attachment.rb +250 -215
  1154. data/lib/ultracart_api/models/order_item_property.rb +280 -245
  1155. data/lib/ultracart_api/models/order_item_tag.rb +235 -200
  1156. data/lib/ultracart_api/models/order_linked_shipment.rb +264 -229
  1157. data/lib/ultracart_api/models/order_marketing.rb +270 -245
  1158. data/lib/ultracart_api/models/order_packing_slip_response.rb +257 -222
  1159. data/lib/ultracart_api/models/order_payment.rb +432 -415
  1160. data/lib/ultracart_api/models/order_payment_check.rb +220 -185
  1161. data/lib/ultracart_api/models/order_payment_credit_card.rb +354 -328
  1162. data/lib/ultracart_api/models/order_payment_e_check.rb +476 -441
  1163. data/lib/ultracart_api/models/order_payment_insurance.rb +250 -215
  1164. data/lib/ultracart_api/models/order_payment_purchase_order.rb +220 -185
  1165. data/lib/ultracart_api/models/order_payment_transaction.rb +252 -227
  1166. data/lib/ultracart_api/models/order_payment_transaction_detail.rb +240 -205
  1167. data/lib/ultracart_api/models/order_process_payment_request.rb +230 -195
  1168. data/lib/ultracart_api/models/order_process_payment_response.rb +256 -221
  1169. data/lib/ultracart_api/models/order_property.rb +280 -245
  1170. data/lib/ultracart_api/models/order_query.rb +826 -843
  1171. data/lib/ultracart_api/models/order_query_batch.rb +222 -231
  1172. data/lib/ultracart_api/models/order_quote.rb +240 -205
  1173. data/lib/ultracart_api/models/order_replacement.rb +467 -432
  1174. data/lib/ultracart_api/models/order_replacement_item.rb +255 -220
  1175. data/lib/ultracart_api/models/order_replacement_response.rb +264 -229
  1176. data/lib/ultracart_api/models/order_response.rb +256 -221
  1177. data/lib/ultracart_api/models/order_salesforce.rb +220 -185
  1178. data/lib/ultracart_api/models/order_shipping.rb +770 -745
  1179. data/lib/ultracart_api/models/order_summary.rb +390 -411
  1180. data/lib/ultracart_api/models/order_tag.rb +235 -200
  1181. data/lib/ultracart_api/models/order_taxes.rb +395 -360
  1182. data/lib/ultracart_api/models/order_token_response.rb +257 -222
  1183. data/lib/ultracart_api/models/order_tracking_number_detail.rb +320 -285
  1184. data/lib/ultracart_api/models/order_tracking_number_details.rb +374 -339
  1185. data/lib/ultracart_api/models/orders_response.rb +259 -224
  1186. data/lib/ultracart_api/models/permission.rb +240 -205
  1187. data/lib/ultracart_api/models/pricing_tier.rb +533 -528
  1188. data/lib/ultracart_api/models/pricing_tier_notification.rb +270 -235
  1189. data/lib/ultracart_api/models/pricing_tiers_response.rb +259 -224
  1190. data/lib/ultracart_api/models/property.rb +228 -193
  1191. data/lib/ultracart_api/models/publish_library_item_request.rb +220 -185
  1192. data/lib/ultracart_api/models/register_affiliate_click_request.rb +270 -235
  1193. data/lib/ultracart_api/models/register_affiliate_click_response.rb +254 -219
  1194. data/lib/ultracart_api/models/response_metadata.rb +229 -194
  1195. data/lib/ultracart_api/models/result_set.rb +270 -235
  1196. data/lib/ultracart_api/models/screen_recording.rb +688 -653
  1197. data/lib/ultracart_api/models/screen_recording_ad_platform.rb +280 -245
  1198. data/lib/ultracart_api/models/screen_recording_filter.rb +758 -723
  1199. data/lib/ultracart_api/models/screen_recording_filter_geo_distance.rb +255 -220
  1200. data/lib/ultracart_api/models/screen_recording_filter_ip_search.rb +246 -211
  1201. data/lib/ultracart_api/models/screen_recording_filter_page_view.rb +369 -334
  1202. data/lib/ultracart_api/models/screen_recording_filter_page_view_event.rb +230 -195
  1203. data/lib/ultracart_api/models/screen_recording_filter_page_view_event_param.rb +255 -220
  1204. data/lib/ultracart_api/models/screen_recording_filter_page_view_param.rb +228 -193
  1205. data/lib/ultracart_api/models/screen_recording_filter_page_view_referrer_param.rb +228 -193
  1206. data/lib/ultracart_api/models/screen_recording_filter_range_big_decimal.rb +255 -220
  1207. data/lib/ultracart_api/models/screen_recording_filter_range_date.rb +230 -195
  1208. data/lib/ultracart_api/models/screen_recording_filter_range_integer.rb +255 -220
  1209. data/lib/ultracart_api/models/screen_recording_filter_string_search.rb +255 -220
  1210. data/lib/ultracart_api/models/screen_recording_filter_values.rb +435 -400
  1211. data/lib/ultracart_api/models/screen_recording_filter_values_event.rb +230 -195
  1212. data/lib/ultracart_api/models/screen_recording_filter_values_event_params.rb +263 -228
  1213. data/lib/ultracart_api/models/screen_recording_filter_values_page_param.rb +230 -195
  1214. data/lib/ultracart_api/models/screen_recording_filter_values_page_view.rb +272 -237
  1215. data/lib/ultracart_api/models/screen_recording_heatmap.rb +426 -391
  1216. data/lib/ultracart_api/models/screen_recording_heatmap_index_request.rb +219 -184
  1217. data/lib/ultracart_api/models/screen_recording_heatmap_index_response.rb +258 -223
  1218. data/lib/ultracart_api/models/screen_recording_heatmap_request.rb +239 -204
  1219. data/lib/ultracart_api/models/screen_recording_heatmap_reset.rb +219 -184
  1220. data/lib/ultracart_api/models/screen_recording_heatmap_response.rb +256 -221
  1221. data/lib/ultracart_api/models/screen_recording_heatmap_url.rb +266 -231
  1222. data/lib/ultracart_api/models/screen_recording_merchant_notes_request.rb +219 -184
  1223. data/lib/ultracart_api/models/screen_recording_multifield.rb +255 -220
  1224. data/lib/ultracart_api/models/screen_recording_page_view.rb +391 -356
  1225. data/lib/ultracart_api/models/screen_recording_page_view_data_response.rb +256 -221
  1226. data/lib/ultracart_api/models/screen_recording_page_view_event.rb +267 -232
  1227. data/lib/ultracart_api/models/screen_recording_page_view_event_parameter.rb +228 -193
  1228. data/lib/ultracart_api/models/screen_recording_page_view_parameter.rb +228 -193
  1229. data/lib/ultracart_api/models/screen_recording_query_request.rb +219 -184
  1230. data/lib/ultracart_api/models/screen_recording_query_response.rb +314 -279
  1231. data/lib/ultracart_api/models/screen_recording_response.rb +265 -230
  1232. data/lib/ultracart_api/models/screen_recording_segment.rb +302 -267
  1233. data/lib/ultracart_api/models/screen_recording_segment_response.rb +256 -221
  1234. data/lib/ultracart_api/models/screen_recording_segments_response.rb +258 -223
  1235. data/lib/ultracart_api/models/screen_recording_settings.rb +284 -249
  1236. data/lib/ultracart_api/models/screen_recording_settings_response.rb +256 -221
  1237. data/lib/ultracart_api/models/screen_recording_store_front.rb +228 -193
  1238. data/lib/ultracart_api/models/screen_recording_tags_request.rb +221 -186
  1239. data/lib/ultracart_api/models/screen_recording_tags_response.rb +258 -223
  1240. data/lib/ultracart_api/models/screen_recording_user_agent.rb +255 -220
  1241. data/lib/ultracart_api/models/screen_recording_user_agent_device.rb +219 -184
  1242. data/lib/ultracart_api/models/screen_recording_user_agent_os.rb +237 -202
  1243. data/lib/ultracart_api/models/screen_recording_user_property.rb +228 -193
  1244. data/lib/ultracart_api/models/screenshots_response.rb +259 -224
  1245. data/lib/ultracart_api/models/self_config.rb +220 -205
  1246. data/lib/ultracart_api/models/simple_value.rb +230 -195
  1247. data/lib/ultracart_api/models/single_sign_on_authorize_request.rb +230 -195
  1248. data/lib/ultracart_api/models/single_sign_on_authorize_response.rb +230 -195
  1249. data/lib/ultracart_api/models/single_sign_on_token_request.rb +230 -195
  1250. data/lib/ultracart_api/models/single_sign_on_token_response.rb +240 -205
  1251. data/lib/ultracart_api/models/sovos_config.rb +280 -245
  1252. data/lib/ultracart_api/models/state_province.rb +245 -210
  1253. data/lib/ultracart_api/models/step_waiting.rb +228 -193
  1254. data/lib/ultracart_api/models/tax_city.rb +302 -267
  1255. data/lib/ultracart_api/models/tax_country.rb +302 -267
  1256. data/lib/ultracart_api/models/tax_country_code.rb +260 -225
  1257. data/lib/ultracart_api/models/tax_county.rb +312 -277
  1258. data/lib/ultracart_api/models/tax_jar_config.rb +280 -245
  1259. data/lib/ultracart_api/models/tax_postal_code.rb +280 -245
  1260. data/lib/ultracart_api/models/tax_provider_activate_result.rb +229 -194
  1261. data/lib/ultracart_api/models/tax_provider_avalara.rb +249 -214
  1262. data/lib/ultracart_api/models/tax_provider_avalara_companies_result.rb +222 -187
  1263. data/lib/ultracart_api/models/tax_provider_avalara_company.rb +260 -225
  1264. data/lib/ultracart_api/models/tax_provider_self.rb +261 -226
  1265. data/lib/ultracart_api/models/tax_provider_self_countries_response.rb +222 -187
  1266. data/lib/ultracart_api/models/tax_provider_self_regions_response.rb +222 -187
  1267. data/lib/ultracart_api/models/tax_provider_sovos.rb +249 -214
  1268. data/lib/ultracart_api/models/tax_provider_tax_jar.rb +249 -214
  1269. data/lib/ultracart_api/models/tax_provider_test_result.rb +229 -194
  1270. data/lib/ultracart_api/models/tax_provider_ultra_cart.rb +261 -226
  1271. data/lib/ultracart_api/models/tax_provider_ultra_cart_state.rb +310 -275
  1272. data/lib/ultracart_api/models/tax_providers_response.rb +292 -257
  1273. data/lib/ultracart_api/models/tax_state.rb +392 -357
  1274. data/lib/ultracart_api/models/tax_state_code.rb +260 -225
  1275. data/lib/ultracart_api/models/temp_multimedia.rb +329 -294
  1276. data/lib/ultracart_api/models/temp_multimedia_response.rb +256 -221
  1277. data/lib/ultracart_api/models/thumbnail_parameters_request.rb +255 -220
  1278. data/lib/ultracart_api/models/thumbnail_parameters_response.rb +257 -222
  1279. data/lib/ultracart_api/models/transaction_email.rb +414 -379
  1280. data/lib/ultracart_api/models/transaction_email_list_response.rb +258 -223
  1281. data/lib/ultracart_api/models/transaction_email_option.rb +282 -247
  1282. data/lib/ultracart_api/models/transaction_email_response.rb +256 -221
  1283. data/lib/ultracart_api/models/twilio.rb +248 -258
  1284. data/lib/ultracart_api/models/twilio_response.rb +265 -230
  1285. data/lib/ultracart_api/models/twilios_response.rb +258 -223
  1286. data/lib/ultracart_api/models/ultra_cart_config.rb +220 -205
  1287. data/lib/ultracart_api/models/upload_coupon_codes_request.rb +259 -224
  1288. data/lib/ultracart_api/models/upload_coupon_codes_response.rb +283 -248
  1289. data/lib/ultracart_api/models/user.rb +377 -342
  1290. data/lib/ultracart_api/models/user_group_membership.rb +240 -205
  1291. data/lib/ultracart_api/models/user_login.rb +250 -215
  1292. data/lib/ultracart_api/models/user_logins_response.rb +259 -224
  1293. data/lib/ultracart_api/models/user_response.rb +256 -221
  1294. data/lib/ultracart_api/models/users_response.rb +258 -223
  1295. data/lib/ultracart_api/models/verification_record.rb +237 -202
  1296. data/lib/ultracart_api/models/warning.rb +230 -195
  1297. data/lib/ultracart_api/models/webhook.rb +437 -412
  1298. data/lib/ultracart_api/models/webhook_event_category.rb +264 -229
  1299. data/lib/ultracart_api/models/webhook_event_subscription.rb +300 -275
  1300. data/lib/ultracart_api/models/webhook_log.rb +324 -299
  1301. data/lib/ultracart_api/models/webhook_log_response.rb +256 -221
  1302. data/lib/ultracart_api/models/webhook_log_summaries_response.rb +259 -224
  1303. data/lib/ultracart_api/models/webhook_log_summary.rb +240 -205
  1304. data/lib/ultracart_api/models/webhook_response.rb +256 -221
  1305. data/lib/ultracart_api/models/{conversation_pbx_audio_usage_response.rb → webhook_sample_request.rb} +252 -245
  1306. data/lib/ultracart_api/models/{customer_wish_list_items_response.rb → webhook_sample_request_response.rb} +256 -223
  1307. data/lib/ultracart_api/models/webhooks_response.rb +258 -223
  1308. data/lib/ultracart_api/models/weight.rb +264 -229
  1309. data/lib/ultracart_api/version.rb +15 -15
  1310. data/lib/ultracart_api.rb +689 -917
  1311. data/spec/api_client_spec.rb +226 -243
  1312. data/spec/configuration_spec.rb +42 -42
  1313. data/spec/spec_helper.rb +111 -111
  1314. data/ultracart_api.gemspec +38 -46
  1315. metadata +9 -625
  1316. data/docs/AccountsReceivableRetryTransactionReject.md +0 -9
  1317. data/docs/AutoOrderAddonItem.md +0 -13
  1318. data/docs/AutoOrderAddonItemOption.md +0 -9
  1319. data/docs/AutoOrderConsolidate.md +0 -8
  1320. data/docs/AutoOrderManagement.md +0 -8
  1321. data/docs/CartItemProperty.md +0 -11
  1322. data/docs/CartPaymentHealthBenefitCard.md +0 -13
  1323. data/docs/ChannelPartner.md +0 -15
  1324. data/docs/ChannelPartnerShipToPreference.md +0 -14
  1325. data/docs/ChannelPartnerShipToPreferenceResponse.md +0 -12
  1326. data/docs/ChannelPartnerShipToPreferencesResponse.md +0 -12
  1327. data/docs/ChannelPartnersResponse.md +0 -12
  1328. data/docs/Conversation.md +0 -26
  1329. data/docs/ConversationAgentAuth.md +0 -22
  1330. data/docs/ConversationAgentAuthResponse.md +0 -12
  1331. data/docs/ConversationAgentProfile.md +0 -14
  1332. data/docs/ConversationAgentProfileResponse.md +0 -12
  1333. data/docs/ConversationApi.md +0 -4199
  1334. data/docs/ConversationAutocompleteRequest.md +0 -9
  1335. data/docs/ConversationAutocompleteResponse.md +0 -14
  1336. data/docs/ConversationAutocompleteValue.md +0 -9
  1337. data/docs/ConversationCannedMessage.md +0 -11
  1338. data/docs/ConversationCannedMessageResponse.md +0 -12
  1339. data/docs/ConversationCannedMessagesResponse.md +0 -12
  1340. data/docs/ConversationCannedMessagesSearch.md +0 -9
  1341. data/docs/ConversationDepartment.md +0 -12
  1342. data/docs/ConversationDepartmentMember.md +0 -10
  1343. data/docs/ConversationDepartmentMembersResponse.md +0 -12
  1344. data/docs/ConversationDepartmentResponse.md +0 -12
  1345. data/docs/ConversationDepartmentSettings.md +0 -7
  1346. data/docs/ConversationDepartmentsResponse.md +0 -12
  1347. data/docs/ConversationEngagement.md +0 -16
  1348. data/docs/ConversationEngagementEquation.md +0 -8
  1349. data/docs/ConversationEngagementEquationFunction.md +0 -21
  1350. data/docs/ConversationEngagementEquationGroup.md +0 -8
  1351. data/docs/ConversationEngagementResponse.md +0 -12
  1352. data/docs/ConversationEngagementsResponse.md +0 -12
  1353. data/docs/ConversationEventAddCoupon.md +0 -10
  1354. data/docs/ConversationEventAddItem.md +0 -10
  1355. data/docs/ConversationEventQueuePosition.md +0 -9
  1356. data/docs/ConversationEventRRWeb.md +0 -14
  1357. data/docs/ConversationEventReadMessage.md +0 -10
  1358. data/docs/ConversationEventTyping.md +0 -10
  1359. data/docs/ConversationEventWebchatContext.md +0 -10
  1360. data/docs/ConversationJoinRequest.md +0 -8
  1361. data/docs/ConversationLocationCountry.md +0 -10
  1362. data/docs/ConversationLocationStateProvince.md +0 -9
  1363. data/docs/ConversationLocationsResponse.md +0 -12
  1364. data/docs/ConversationMessage.md +0 -22
  1365. data/docs/ConversationMessageTranslation.md +0 -9
  1366. data/docs/ConversationMessageTransportStatus.md +0 -9
  1367. data/docs/ConversationMessagesResponse.md +0 -12
  1368. data/docs/ConversationMultimediaUploadUrl.md +0 -9
  1369. data/docs/ConversationMultimediaUploadUrlResponse.md +0 -12
  1370. data/docs/ConversationParticipant.md +0 -20
  1371. data/docs/ConversationPbxAgent.md +0 -23
  1372. data/docs/ConversationPbxAgentResponse.md +0 -12
  1373. data/docs/ConversationPbxAgentsResponse.md +0 -12
  1374. data/docs/ConversationPbxAudio.md +0 -17
  1375. data/docs/ConversationPbxAudioResponse.md +0 -12
  1376. data/docs/ConversationPbxAudioUploadUrl.md +0 -9
  1377. data/docs/ConversationPbxAudioUploadUrlResponse.md +0 -12
  1378. data/docs/ConversationPbxAudioUsageResponse.md +0 -14
  1379. data/docs/ConversationPbxAudiosResponse.md +0 -12
  1380. data/docs/ConversationPbxCustomerSnapshotRequest.md +0 -15
  1381. data/docs/ConversationPbxCustomerSnapshotResponse.md +0 -14
  1382. data/docs/ConversationPbxMenu.md +0 -18
  1383. data/docs/ConversationPbxMenuMapping.md +0 -11
  1384. data/docs/ConversationPbxMenuResponse.md +0 -12
  1385. data/docs/ConversationPbxMenusResponse.md +0 -12
  1386. data/docs/ConversationPbxPhoneNumber.md +0 -12
  1387. data/docs/ConversationPbxPhoneNumberResponse.md +0 -12
  1388. data/docs/ConversationPbxPhoneNumbersResponse.md +0 -12
  1389. data/docs/ConversationPbxQueue.md +0 -28
  1390. data/docs/ConversationPbxQueueMembers.md +0 -9
  1391. data/docs/ConversationPbxQueueResponse.md +0 -12
  1392. data/docs/ConversationPbxQueuesResponse.md +0 -12
  1393. data/docs/ConversationPbxTimeBased.md +0 -11
  1394. data/docs/ConversationPbxTimeBasedMapping.md +0 -11
  1395. data/docs/ConversationPbxTimeBasedMappingConfig.md +0 -9
  1396. data/docs/ConversationPbxTimeBasedResponse.md +0 -12
  1397. data/docs/ConversationPbxTimeBasedsResponse.md +0 -12
  1398. data/docs/ConversationPbxTimeRange.md +0 -12
  1399. data/docs/ConversationPbxTimeRangeConfig.md +0 -13
  1400. data/docs/ConversationPbxTimeRangeResponse.md +0 -12
  1401. data/docs/ConversationPbxTimeRangesResponse.md +0 -12
  1402. data/docs/ConversationPbxVoicemailMailbox.md +0 -19
  1403. data/docs/ConversationPbxVoicemailMailboxResponse.md +0 -12
  1404. data/docs/ConversationPbxVoicemailMailboxesResponse.md +0 -12
  1405. data/docs/ConversationPbxVoicemailMessage.md +0 -20
  1406. data/docs/ConversationPbxVoicemailMessageResponse.md +0 -12
  1407. data/docs/ConversationPbxVoicemailMessageSummariesResponse.md +0 -12
  1408. data/docs/ConversationPbxVoicemailMessageSummary.md +0 -17
  1409. data/docs/ConversationPermissions.md +0 -8
  1410. data/docs/ConversationPermissionsResponse.md +0 -12
  1411. data/docs/ConversationResponse.md +0 -12
  1412. data/docs/ConversationSearchRequest.md +0 -19
  1413. data/docs/ConversationSearchResponse.md +0 -11
  1414. data/docs/ConversationSentiment.md +0 -13
  1415. data/docs/ConversationStartRequest.md +0 -10
  1416. data/docs/ConversationStartResponse.md +0 -8
  1417. data/docs/ConversationSummary.md +0 -24
  1418. data/docs/ConversationTwilioAccount.md +0 -9
  1419. data/docs/ConversationWebchatContext.md +0 -15
  1420. data/docs/ConversationWebchatQueueStatus.md +0 -22
  1421. data/docs/ConversationWebchatQueueStatusAgent.md +0 -13
  1422. data/docs/ConversationWebchatQueueStatusQueueEntry.md +0 -15
  1423. data/docs/ConversationWebchatQueueStatusUpdateRequest.md +0 -8
  1424. data/docs/ConversationWebchatQueueStatusesResponse.md +0 -12
  1425. data/docs/ConversationWebsocketMessage.md +0 -31
  1426. data/docs/ConversationsResponse.md +0 -12
  1427. data/docs/CouponFreeItemWithItemPurchaseAndFreeShipping.md +0 -11
  1428. data/docs/CouponMoreLoyaltyCashback.md +0 -8
  1429. data/docs/CouponMoreLoyaltyPoints.md +0 -8
  1430. data/docs/CouponNoDiscount.md +0 -8
  1431. data/docs/CouponPercentMoreLoyaltyCashback.md +0 -8
  1432. data/docs/CouponPercentMoreLoyaltyPoints.md +0 -8
  1433. data/docs/CouponTieredPercentOffSubtotalBasedOnMSRP.md +0 -9
  1434. data/docs/CustomerEDI.md +0 -10
  1435. data/docs/CustomerMagicLinkResponse.md +0 -12
  1436. data/docs/CustomerMergeRequest.md +0 -9
  1437. data/docs/CustomerProperty.md +0 -11
  1438. data/docs/CustomerWishListItem.md +0 -14
  1439. data/docs/CustomerWishListItemResponse.md +0 -12
  1440. data/docs/CustomerWishListItemsResponse.md +0 -12
  1441. data/docs/DatawarehouseApi.md +0 -512
  1442. data/docs/EmailCommseqSequenceTestRequest.md +0 -22
  1443. data/docs/EmailCommseqSequenceTestResponse.md +0 -11
  1444. data/docs/EmailCommseqSmsSendTestRequest.md +0 -10
  1445. data/docs/EmailCommseqSmsSendTestResponse.md +0 -13
  1446. data/docs/EmailPostcardTracking.md +0 -32
  1447. data/docs/EmailPostcardTrackingResponse.md +0 -12
  1448. data/docs/EmailRateLimiter.md +0 -10
  1449. data/docs/EmailRateLimitersResponse.md +0 -12
  1450. data/docs/EmailSmsOrder.md +0 -11
  1451. data/docs/EmailSmsOrdersResponse.md +0 -12
  1452. data/docs/EmailSmsStat.md +0 -37
  1453. data/docs/EmailStatSmsSummaryRequest.md +0 -9
  1454. data/docs/EmailStatSmsSummaryResponse.md +0 -12
  1455. data/docs/FileManagerDirectory.md +0 -20
  1456. data/docs/FileManagerFile.md +0 -29
  1457. data/docs/FileManagerPage.md +0 -15
  1458. data/docs/FileManagerPageResponse.md +0 -12
  1459. data/docs/FileManagerUploadRequest.md +0 -10
  1460. data/docs/FileManagerUploadUrlResponse.md +0 -13
  1461. data/docs/HitPageView.md +0 -18
  1462. data/docs/HitPageViewMetaData.md +0 -9
  1463. data/docs/HitSessionStart.md +0 -24
  1464. data/docs/HitSessionUtm.md +0 -22
  1465. data/docs/ItemDigitalItemPdfMeta.md +0 -18
  1466. data/docs/ItemDigitalItemResponse.md +0 -12
  1467. data/docs/ItemDigitalItemsResponse.md +0 -12
  1468. data/docs/ItemInventorySnapshot.md +0 -13
  1469. data/docs/ItemInventorySnapshotDistributionCenter.md +0 -12
  1470. data/docs/ItemInventorySnapshotResponse.md +0 -12
  1471. data/docs/ItemReview.md +0 -45
  1472. data/docs/ItemReviewResponse.md +0 -12
  1473. data/docs/ItemReviewsResponse.md +0 -12
  1474. data/docs/OrderCurrentStageHistory.md +0 -10
  1475. data/docs/OrderEdiDocument.md +0 -21
  1476. data/docs/OrderEdiDocumentsResponse.md +0 -12
  1477. data/docs/OrderInvoiceResponse.md +0 -12
  1478. data/docs/OrderPaymentCreditCardDualVaulted.md +0 -10
  1479. data/docs/OrderPaymentCreditCardDualVaultedProperty.md +0 -9
  1480. data/docs/OrderPaymentHealthBenefitCard.md +0 -13
  1481. data/docs/OrderPaymentPayPal.md +0 -9
  1482. data/docs/OrderPointOfSale.md +0 -10
  1483. data/docs/OrderReason.md +0 -10
  1484. data/docs/OrderRefundableResponse.md +0 -20
  1485. data/docs/OrderTransactionalMerchantNote.md +0 -11
  1486. data/docs/OrderUtm.md +0 -39
  1487. data/docs/OrderValidationRequest.md +0 -9
  1488. data/docs/OrderValidationResponse.md +0 -10
  1489. data/docs/PointOfSaleLocation.md +0 -17
  1490. data/docs/PointOfSaleReader.md +0 -16
  1491. data/docs/PointOfSaleRegister.md +0 -11
  1492. data/docs/Report.md +0 -18
  1493. data/docs/ReportAuth.md +0 -11
  1494. data/docs/ReportAuthResponse.md +0 -12
  1495. data/docs/ReportDataSet.md +0 -24
  1496. data/docs/ReportDataSetColumn.md +0 -13
  1497. data/docs/ReportDataSetPage.md +0 -17
  1498. data/docs/ReportDataSetPageResponse.md +0 -12
  1499. data/docs/ReportDataSetQuery.md +0 -20
  1500. data/docs/ReportDataSetQueryOrderByColumn.md +0 -9
  1501. data/docs/ReportDataSetResponse.md +0 -12
  1502. data/docs/ReportDataSetRow.md +0 -8
  1503. data/docs/ReportDataSetSchema.md +0 -10
  1504. data/docs/ReportDataSource.md +0 -14
  1505. data/docs/ReportDataSourceSchema.md +0 -11
  1506. data/docs/ReportDryRunQueriesRequest.md +0 -13
  1507. data/docs/ReportDryRunQueriesResponse.md +0 -8
  1508. data/docs/ReportDryRunQueryResult.md +0 -9
  1509. data/docs/ReportExecuteQueriesRequest.md +0 -15
  1510. data/docs/ReportFilter.md +0 -13
  1511. data/docs/ReportFilterConnection.md +0 -10
  1512. data/docs/ReportPage.md +0 -13
  1513. data/docs/ReportPageFilter.md +0 -11
  1514. data/docs/ReportPageVisualization.md +0 -17
  1515. data/docs/ReportPageVisualizationDimension.md +0 -14
  1516. data/docs/ReportPageVisualizationMetric.md +0 -11
  1517. data/docs/ReportResponse.md +0 -12
  1518. data/docs/ReportWebsocketEvent.md +0 -9
  1519. data/docs/ReportsResponse.md +0 -12
  1520. data/docs/RulerValidationRequest.md +0 -8
  1521. data/docs/RulerValidationResponse.md +0 -9
  1522. data/docs/StoreFront.md +0 -18
  1523. data/docs/StoreFrontPageContentAttribute.md +0 -11
  1524. data/docs/StoreFrontsResponse.md +0 -12
  1525. data/docs/WebhookReflow.md +0 -9
  1526. data/docs/WebhookReflowResponse.md +0 -12
  1527. data/docs/WorkflowAgentAuth.md +0 -10
  1528. data/docs/WorkflowAgentAuthResponse.md +0 -12
  1529. data/docs/WorkflowApi.md +0 -620
  1530. data/docs/WorkflowAttachment.md +0 -12
  1531. data/docs/WorkflowAttachmentUploadUrl.md +0 -9
  1532. data/docs/WorkflowAttachmentUploadUrlResponse.md +0 -12
  1533. data/docs/WorkflowGroup.md +0 -9
  1534. data/docs/WorkflowGroupsResponse.md +0 -12
  1535. data/docs/WorkflowNote.md +0 -13
  1536. data/docs/WorkflowTask.md +0 -39
  1537. data/docs/WorkflowTaskHistory.md +0 -11
  1538. data/docs/WorkflowTaskOpenCountResponse.md +0 -12
  1539. data/docs/WorkflowTaskResponse.md +0 -12
  1540. data/docs/WorkflowTaskTagsResponse.md +0 -12
  1541. data/docs/WorkflowTasksRequest.md +0 -27
  1542. data/docs/WorkflowTasksResponse.md +0 -13
  1543. data/docs/WorkflowUser.md +0 -10
  1544. data/docs/WorkflowUserResponse.md +0 -12
  1545. data/docs/WorkflowUsersResponse.md +0 -13
  1546. data/lib/ultracart_api/api/conversation_api.rb +0 -4583
  1547. data/lib/ultracart_api/api/datawarehouse_api.rb +0 -584
  1548. data/lib/ultracart_api/api/workflow_api.rb +0 -693
  1549. data/lib/ultracart_api/models/accounts_receivable_retry_transaction_reject.rb +0 -195
  1550. data/lib/ultracart_api/models/auto_order_addon_item.rb +0 -232
  1551. data/lib/ultracart_api/models/auto_order_addon_item_option.rb +0 -225
  1552. data/lib/ultracart_api/models/auto_order_consolidate.rb +0 -186
  1553. data/lib/ultracart_api/models/auto_order_management.rb +0 -185
  1554. data/lib/ultracart_api/models/cart_item_property.rb +0 -245
  1555. data/lib/ultracart_api/models/cart_payment_health_benefit_card.rb +0 -235
  1556. data/lib/ultracart_api/models/channel_partner.rb +0 -255
  1557. data/lib/ultracart_api/models/channel_partner_ship_to_preference.rb +0 -262
  1558. data/lib/ultracart_api/models/channel_partner_ship_to_preference_response.rb +0 -221
  1559. data/lib/ultracart_api/models/channel_partner_ship_to_preferences_response.rb +0 -224
  1560. data/lib/ultracart_api/models/channel_partners_response.rb +0 -224
  1561. data/lib/ultracart_api/models/conversation.rb +0 -390
  1562. data/lib/ultracart_api/models/conversation_agent_auth.rb +0 -316
  1563. data/lib/ultracart_api/models/conversation_agent_auth_response.rb +0 -221
  1564. data/lib/ultracart_api/models/conversation_agent_profile.rb +0 -279
  1565. data/lib/ultracart_api/models/conversation_agent_profile_response.rb +0 -221
  1566. data/lib/ultracart_api/models/conversation_autocomplete_request.rb +0 -193
  1567. data/lib/ultracart_api/models/conversation_autocomplete_response.rb +0 -241
  1568. data/lib/ultracart_api/models/conversation_autocomplete_value.rb +0 -193
  1569. data/lib/ultracart_api/models/conversation_canned_message.rb +0 -213
  1570. data/lib/ultracart_api/models/conversation_canned_message_response.rb +0 -221
  1571. data/lib/ultracart_api/models/conversation_canned_messages_response.rb +0 -223
  1572. data/lib/ultracart_api/models/conversation_canned_messages_search.rb +0 -193
  1573. data/lib/ultracart_api/models/conversation_department.rb +0 -222
  1574. data/lib/ultracart_api/models/conversation_department_member.rb +0 -202
  1575. data/lib/ultracart_api/models/conversation_department_members_response.rb +0 -223
  1576. data/lib/ultracart_api/models/conversation_department_response.rb +0 -221
  1577. data/lib/ultracart_api/models/conversation_department_settings.rb +0 -175
  1578. data/lib/ultracart_api/models/conversation_departments_response.rb +0 -223
  1579. data/lib/ultracart_api/models/conversation_engagement.rb +0 -293
  1580. data/lib/ultracart_api/models/conversation_engagement_equation.rb +0 -186
  1581. data/lib/ultracart_api/models/conversation_engagement_equation_function.rb +0 -414
  1582. data/lib/ultracart_api/models/conversation_engagement_equation_group.rb +0 -186
  1583. data/lib/ultracart_api/models/conversation_engagement_response.rb +0 -221
  1584. data/lib/ultracart_api/models/conversation_engagements_response.rb +0 -223
  1585. data/lib/ultracart_api/models/conversation_event_add_coupon.rb +0 -202
  1586. data/lib/ultracart_api/models/conversation_event_add_item.rb +0 -204
  1587. data/lib/ultracart_api/models/conversation_event_queue_position.rb +0 -195
  1588. data/lib/ultracart_api/models/conversation_event_read_message.rb +0 -203
  1589. data/lib/ultracart_api/models/conversation_event_rr_web.rb +0 -273
  1590. data/lib/ultracart_api/models/conversation_event_typing.rb +0 -202
  1591. data/lib/ultracart_api/models/conversation_event_webchat_context.rb +0 -202
  1592. data/lib/ultracart_api/models/conversation_join_request.rb +0 -184
  1593. data/lib/ultracart_api/models/conversation_location_country.rb +0 -204
  1594. data/lib/ultracart_api/models/conversation_location_state_province.rb +0 -193
  1595. data/lib/ultracart_api/models/conversation_locations_response.rb +0 -223
  1596. data/lib/ultracart_api/models/conversation_message.rb +0 -356
  1597. data/lib/ultracart_api/models/conversation_message_translation.rb +0 -193
  1598. data/lib/ultracart_api/models/conversation_message_transport_status.rb +0 -228
  1599. data/lib/ultracart_api/models/conversation_messages_response.rb +0 -223
  1600. data/lib/ultracart_api/models/conversation_multimedia_upload_url.rb +0 -193
  1601. data/lib/ultracart_api/models/conversation_multimedia_upload_url_response.rb +0 -221
  1602. data/lib/ultracart_api/models/conversation_participant.rb +0 -295
  1603. data/lib/ultracart_api/models/conversation_pbx_agent.rb +0 -440
  1604. data/lib/ultracart_api/models/conversation_pbx_agent_response.rb +0 -221
  1605. data/lib/ultracart_api/models/conversation_pbx_agents_response.rb +0 -223
  1606. data/lib/ultracart_api/models/conversation_pbx_audio.rb +0 -365
  1607. data/lib/ultracart_api/models/conversation_pbx_audio_response.rb +0 -221
  1608. data/lib/ultracart_api/models/conversation_pbx_audio_upload_url.rb +0 -193
  1609. data/lib/ultracart_api/models/conversation_pbx_audio_upload_url_response.rb +0 -221
  1610. data/lib/ultracart_api/models/conversation_pbx_audios_response.rb +0 -223
  1611. data/lib/ultracart_api/models/conversation_pbx_customer_snapshot_request.rb +0 -248
  1612. data/lib/ultracart_api/models/conversation_pbx_customer_snapshot_response.rb +0 -245
  1613. data/lib/ultracart_api/models/conversation_pbx_menu.rb +0 -416
  1614. data/lib/ultracart_api/models/conversation_pbx_menu_mapping.rb +0 -269
  1615. data/lib/ultracart_api/models/conversation_pbx_menu_response.rb +0 -221
  1616. data/lib/ultracart_api/models/conversation_pbx_menus_response.rb +0 -223
  1617. data/lib/ultracart_api/models/conversation_pbx_phone_number.rb +0 -324
  1618. data/lib/ultracart_api/models/conversation_pbx_phone_number_response.rb +0 -221
  1619. data/lib/ultracart_api/models/conversation_pbx_phone_numbers_response.rb +0 -223
  1620. data/lib/ultracart_api/models/conversation_pbx_queue.rb +0 -534
  1621. data/lib/ultracart_api/models/conversation_pbx_queue_members.rb +0 -197
  1622. data/lib/ultracart_api/models/conversation_pbx_queue_response.rb +0 -221
  1623. data/lib/ultracart_api/models/conversation_pbx_queues_response.rb +0 -223
  1624. data/lib/ultracart_api/models/conversation_pbx_time_based.rb +0 -211
  1625. data/lib/ultracart_api/models/conversation_pbx_time_based_mapping.rb +0 -299
  1626. data/lib/ultracart_api/models/conversation_pbx_time_based_mapping_config.rb +0 -196
  1627. data/lib/ultracart_api/models/conversation_pbx_time_based_response.rb +0 -221
  1628. data/lib/ultracart_api/models/conversation_pbx_time_baseds_response.rb +0 -223
  1629. data/lib/ultracart_api/models/conversation_pbx_time_range.rb +0 -287
  1630. data/lib/ultracart_api/models/conversation_pbx_time_range_config.rb +0 -235
  1631. data/lib/ultracart_api/models/conversation_pbx_time_range_response.rb +0 -221
  1632. data/lib/ultracart_api/models/conversation_pbx_time_ranges_response.rb +0 -223
  1633. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb +0 -458
  1634. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox_response.rb +0 -221
  1635. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailboxes_response.rb +0 -223
  1636. data/lib/ultracart_api/models/conversation_pbx_voicemail_message.rb +0 -339
  1637. data/lib/ultracart_api/models/conversation_pbx_voicemail_message_response.rb +0 -221
  1638. data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summaries_response.rb +0 -223
  1639. data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summary.rb +0 -309
  1640. data/lib/ultracart_api/models/conversation_permissions.rb +0 -184
  1641. data/lib/ultracart_api/models/conversation_permissions_response.rb +0 -221
  1642. data/lib/ultracart_api/models/conversation_response.rb +0 -221
  1643. data/lib/ultracart_api/models/conversation_search_request.rb +0 -285
  1644. data/lib/ultracart_api/models/conversation_search_response.rb +0 -213
  1645. data/lib/ultracart_api/models/conversation_sentiment.rb +0 -269
  1646. data/lib/ultracart_api/models/conversation_start_request.rb +0 -204
  1647. data/lib/ultracart_api/models/conversation_start_response.rb +0 -184
  1648. data/lib/ultracart_api/models/conversation_summary.rb +0 -369
  1649. data/lib/ultracart_api/models/conversation_twilio_account.rb +0 -195
  1650. data/lib/ultracart_api/models/conversation_webchat_context.rb +0 -254
  1651. data/lib/ultracart_api/models/conversation_webchat_queue_status.rb +0 -315
  1652. data/lib/ultracart_api/models/conversation_webchat_queue_status_agent.rb +0 -266
  1653. data/lib/ultracart_api/models/conversation_webchat_queue_status_queue_entry.rb +0 -248
  1654. data/lib/ultracart_api/models/conversation_webchat_queue_status_update_request.rb +0 -219
  1655. data/lib/ultracart_api/models/conversation_webchat_queue_statuses_response.rb +0 -223
  1656. data/lib/ultracart_api/models/conversation_websocket_message.rb +0 -441
  1657. data/lib/ultracart_api/models/conversations_response.rb +0 -223
  1658. data/lib/ultracart_api/models/coupon_free_item_with_item_purchase_and_free_shipping.rb +0 -219
  1659. data/lib/ultracart_api/models/coupon_more_loyalty_cashback.rb +0 -185
  1660. data/lib/ultracart_api/models/coupon_more_loyalty_points.rb +0 -185
  1661. data/lib/ultracart_api/models/coupon_no_discount.rb +0 -185
  1662. data/lib/ultracart_api/models/coupon_percent_more_loyalty_cashback.rb +0 -185
  1663. data/lib/ultracart_api/models/coupon_percent_more_loyalty_points.rb +0 -185
  1664. data/lib/ultracart_api/models/coupon_tiered_percent_off_subtotal_based_on_msrp.rb +0 -199
  1665. data/lib/ultracart_api/models/customer_edi.rb +0 -205
  1666. data/lib/ultracart_api/models/customer_magic_link_response.rb +0 -222
  1667. data/lib/ultracart_api/models/customer_merge_request.rb +0 -195
  1668. data/lib/ultracart_api/models/customer_property.rb +0 -245
  1669. data/lib/ultracart_api/models/customer_wish_list_item.rb +0 -260
  1670. data/lib/ultracart_api/models/customer_wish_list_item_response.rb +0 -221
  1671. data/lib/ultracart_api/models/email_commseq_sequence_test_request.rb +0 -312
  1672. data/lib/ultracart_api/models/email_commseq_sequence_test_response.rb +0 -212
  1673. data/lib/ultracart_api/models/email_commseq_sms_send_test_request.rb +0 -202
  1674. data/lib/ultracart_api/models/email_commseq_sms_send_test_response.rb +0 -232
  1675. data/lib/ultracart_api/models/email_postcard_tracking.rb +0 -404
  1676. data/lib/ultracart_api/models/email_postcard_tracking_response.rb +0 -221
  1677. data/lib/ultracart_api/models/email_rate_limiter.rb +0 -202
  1678. data/lib/ultracart_api/models/email_rate_limiters_response.rb +0 -223
  1679. data/lib/ultracart_api/models/email_sms_order.rb +0 -214
  1680. data/lib/ultracart_api/models/email_sms_orders_response.rb +0 -223
  1681. data/lib/ultracart_api/models/email_sms_stat.rb +0 -476
  1682. data/lib/ultracart_api/models/email_stat_sms_summary_request.rb +0 -195
  1683. data/lib/ultracart_api/models/email_stat_sms_summary_response.rb +0 -223
  1684. data/lib/ultracart_api/models/file_manager_directory.rb +0 -292
  1685. data/lib/ultracart_api/models/file_manager_file.rb +0 -376
  1686. data/lib/ultracart_api/models/file_manager_page.rb +0 -253
  1687. data/lib/ultracart_api/models/file_manager_page_response.rb +0 -221
  1688. data/lib/ultracart_api/models/file_manager_upload_request.rb +0 -202
  1689. data/lib/ultracart_api/models/file_manager_upload_url_response.rb +0 -230
  1690. data/lib/ultracart_api/models/hit_page_view.rb +0 -276
  1691. data/lib/ultracart_api/models/hit_page_view_meta_data.rb +0 -193
  1692. data/lib/ultracart_api/models/hit_session_start.rb +0 -328
  1693. data/lib/ultracart_api/models/hit_session_utm.rb +0 -310
  1694. data/lib/ultracart_api/models/item_digital_item_pdf_meta.rb +0 -315
  1695. data/lib/ultracart_api/models/item_digital_item_response.rb +0 -221
  1696. data/lib/ultracart_api/models/item_digital_items_response.rb +0 -224
  1697. data/lib/ultracart_api/models/item_inventory_snapshot.rb +0 -231
  1698. data/lib/ultracart_api/models/item_inventory_snapshot_distribution_center.rb +0 -220
  1699. data/lib/ultracart_api/models/item_inventory_snapshot_response.rb +0 -224
  1700. data/lib/ultracart_api/models/item_review.rb +0 -826
  1701. data/lib/ultracart_api/models/item_review_response.rb +0 -221
  1702. data/lib/ultracart_api/models/item_reviews_response.rb +0 -224
  1703. data/lib/ultracart_api/models/order_current_stage_history.rb +0 -251
  1704. data/lib/ultracart_api/models/order_edi_document.rb +0 -337
  1705. data/lib/ultracart_api/models/order_edi_documents_response.rb +0 -224
  1706. data/lib/ultracart_api/models/order_invoice_response.rb +0 -222
  1707. data/lib/ultracart_api/models/order_payment_credit_card_dual_vaulted.rb +0 -204
  1708. data/lib/ultracart_api/models/order_payment_credit_card_dual_vaulted_property.rb +0 -193
  1709. data/lib/ultracart_api/models/order_payment_health_benefit_card.rb +0 -235
  1710. data/lib/ultracart_api/models/order_payment_pay_pal.rb +0 -195
  1711. data/lib/ultracart_api/models/order_point_of_sale.rb +0 -202
  1712. data/lib/ultracart_api/models/order_reason.rb +0 -205
  1713. data/lib/ultracart_api/models/order_refundable_response.rb +0 -310
  1714. data/lib/ultracart_api/models/order_transactional_merchant_note.rb +0 -215
  1715. data/lib/ultracart_api/models/order_utm.rb +0 -464
  1716. data/lib/ultracart_api/models/order_validation_request.rb +0 -196
  1717. data/lib/ultracart_api/models/order_validation_response.rb +0 -209
  1718. data/lib/ultracart_api/models/point_of_sale_location.rb +0 -290
  1719. data/lib/ultracart_api/models/point_of_sale_reader.rb +0 -299
  1720. data/lib/ultracart_api/models/point_of_sale_register.rb +0 -215
  1721. data/lib/ultracart_api/models/report.rb +0 -317
  1722. data/lib/ultracart_api/models/report_auth.rb +0 -212
  1723. data/lib/ultracart_api/models/report_auth_response.rb +0 -221
  1724. data/lib/ultracart_api/models/report_data_set.rb +0 -381
  1725. data/lib/ultracart_api/models/report_data_set_column.rb +0 -229
  1726. data/lib/ultracart_api/models/report_data_set_page.rb +0 -273
  1727. data/lib/ultracart_api/models/report_data_set_page_response.rb +0 -221
  1728. data/lib/ultracart_api/models/report_data_set_query.rb +0 -342
  1729. data/lib/ultracart_api/models/report_data_set_query_order_by_column.rb +0 -193
  1730. data/lib/ultracart_api/models/report_data_set_response.rb +0 -221
  1731. data/lib/ultracart_api/models/report_data_set_row.rb +0 -186
  1732. data/lib/ultracart_api/models/report_data_set_schema.rb +0 -238
  1733. data/lib/ultracart_api/models/report_data_source.rb +0 -242
  1734. data/lib/ultracart_api/models/report_data_source_schema.rb +0 -248
  1735. data/lib/ultracart_api/models/report_dry_run_queries_request.rb +0 -231
  1736. data/lib/ultracart_api/models/report_dry_run_queries_response.rb +0 -186
  1737. data/lib/ultracart_api/models/report_dry_run_query_result.rb +0 -193
  1738. data/lib/ultracart_api/models/report_execute_queries_request.rb +0 -288
  1739. data/lib/ultracart_api/models/report_filter.rb +0 -272
  1740. data/lib/ultracart_api/models/report_filter_connection.rb +0 -203
  1741. data/lib/ultracart_api/models/report_page.rb +0 -237
  1742. data/lib/ultracart_api/models/report_page_filter.rb +0 -214
  1743. data/lib/ultracart_api/models/report_page_visualization.rb +0 -309
  1744. data/lib/ultracart_api/models/report_page_visualization_dimension.rb +0 -244
  1745. data/lib/ultracart_api/models/report_page_visualization_metric.rb +0 -248
  1746. data/lib/ultracart_api/models/report_response.rb +0 -221
  1747. data/lib/ultracart_api/models/report_websocket_event.rb +0 -228
  1748. data/lib/ultracart_api/models/reports_response.rb +0 -223
  1749. data/lib/ultracart_api/models/ruler_validation_request.rb +0 -184
  1750. data/lib/ultracart_api/models/ruler_validation_response.rb +0 -193
  1751. data/lib/ultracart_api/models/store_front.rb +0 -274
  1752. data/lib/ultracart_api/models/store_front_page_content_attribute.rb +0 -245
  1753. data/lib/ultracart_api/models/store_fronts_response.rb +0 -223
  1754. data/lib/ultracart_api/models/webhook_reflow.rb +0 -193
  1755. data/lib/ultracart_api/models/webhook_reflow_response.rb +0 -221
  1756. data/lib/ultracart_api/models/workflow_agent_auth.rb +0 -202
  1757. data/lib/ultracart_api/models/workflow_agent_auth_response.rb +0 -221
  1758. data/lib/ultracart_api/models/workflow_attachment.rb +0 -225
  1759. data/lib/ultracart_api/models/workflow_attachment_upload_url.rb +0 -193
  1760. data/lib/ultracart_api/models/workflow_attachment_upload_url_response.rb +0 -221
  1761. data/lib/ultracart_api/models/workflow_group.rb +0 -195
  1762. data/lib/ultracart_api/models/workflow_groups_response.rb +0 -224
  1763. data/lib/ultracart_api/models/workflow_note.rb +0 -236
  1764. data/lib/ultracart_api/models/workflow_task.rb +0 -574
  1765. data/lib/ultracart_api/models/workflow_task_history.rb +0 -214
  1766. data/lib/ultracart_api/models/workflow_task_open_count_response.rb +0 -222
  1767. data/lib/ultracart_api/models/workflow_task_response.rb +0 -221
  1768. data/lib/ultracart_api/models/workflow_task_tags_response.rb +0 -224
  1769. data/lib/ultracart_api/models/workflow_tasks_request.rb +0 -434
  1770. data/lib/ultracart_api/models/workflow_tasks_response.rb +0 -234
  1771. data/lib/ultracart_api/models/workflow_user.rb +0 -205
  1772. data/lib/ultracart_api/models/workflow_user_response.rb +0 -221
  1773. data/lib/ultracart_api/models/workflow_users_response.rb +0 -234
data/docs/TaxApi.md CHANGED
@@ -1,1421 +1,2101 @@
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
-
49
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
50
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
51
- api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
52
-
53
-
54
- city = 'city_example' # String | The city being deleted.
55
-
56
- tax_city = UltracartClient::TaxCity.new # TaxCity | tax city to be deleted
57
-
58
-
59
- begin
60
- #Deletes a Self tax provider city
61
- api_instance.delete_tax_provider_self_city(city, tax_city)
62
- rescue UltracartClient::ApiError => e
63
- puts "Exception when calling TaxApi->delete_tax_provider_self_city: #{e}"
64
- end
65
- ```
66
-
67
- ### Parameters
68
-
69
- Name | Type | Description | Notes
70
- ------------- | ------------- | ------------- | -------------
71
- **city** | **String**| The city being deleted. |
72
- **tax_city** | [**TaxCity**](TaxCity.md)| tax city to be deleted |
73
-
74
- ### Return type
75
-
76
- nil (empty response body)
77
-
78
- ### Authorization
79
-
80
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
81
-
82
- ### HTTP request headers
83
-
84
- - **Content-Type**: application/json
85
- - **Accept**: application/json
86
-
87
-
88
-
89
- # **delete_tax_provider_self_country**
90
- > delete_tax_provider_self_country(country_code, tax_country)
91
-
92
- Deletes a Self tax provider country
93
-
94
- Deletes a Self tax provider country.
95
-
96
- ### Example
97
- ```ruby
98
- # load the gem
99
- require 'ultracart_api'
100
-
101
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
102
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
103
- api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
104
-
105
-
106
- country_code = 'country_code_example' # String | The country code being deleted.
107
-
108
- tax_country = UltracartClient::TaxCountry.new # TaxCountry | tax country to be deleted
109
-
110
-
111
- begin
112
- #Deletes a Self tax provider country
113
- api_instance.delete_tax_provider_self_country(country_code, tax_country)
114
- rescue UltracartClient::ApiError => e
115
- puts "Exception when calling TaxApi->delete_tax_provider_self_country: #{e}"
116
- end
117
- ```
118
-
119
- ### Parameters
120
-
121
- Name | Type | Description | Notes
122
- ------------- | ------------- | ------------- | -------------
123
- **country_code** | **String**| The country code being deleted. |
124
- **tax_country** | [**TaxCountry**](TaxCountry.md)| tax country to be deleted |
125
-
126
- ### Return type
127
-
128
- nil (empty response body)
129
-
130
- ### Authorization
131
-
132
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
133
-
134
- ### HTTP request headers
135
-
136
- - **Content-Type**: application/json
137
- - **Accept**: application/json
138
-
139
-
140
-
141
- # **delete_tax_provider_self_county**
142
- > delete_tax_provider_self_county(county, tax_county)
143
-
144
- Deletes a Self tax provider county
145
-
146
- Deletes a Self tax provider county.
147
-
148
- ### Example
149
- ```ruby
150
- # load the gem
151
- require 'ultracart_api'
152
-
153
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
154
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
155
- api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
156
-
157
-
158
- county = 'county_example' # String | The county being deleted.
159
-
160
- tax_county = UltracartClient::TaxCounty.new # TaxCounty | tax county to be deleted
161
-
162
-
163
- begin
164
- #Deletes a Self tax provider county
165
- api_instance.delete_tax_provider_self_county(county, tax_county)
166
- rescue UltracartClient::ApiError => e
167
- puts "Exception when calling TaxApi->delete_tax_provider_self_county: #{e}"
168
- end
169
- ```
170
-
171
- ### Parameters
172
-
173
- Name | Type | Description | Notes
174
- ------------- | ------------- | ------------- | -------------
175
- **county** | **String**| The county being deleted. |
176
- **tax_county** | [**TaxCounty**](TaxCounty.md)| tax county to be deleted |
177
-
178
- ### Return type
179
-
180
- nil (empty response body)
181
-
182
- ### Authorization
183
-
184
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
185
-
186
- ### HTTP request headers
187
-
188
- - **Content-Type**: application/json
189
- - **Accept**: application/json
190
-
191
-
192
-
193
- # **delete_tax_provider_self_postal_code**
194
- > delete_tax_provider_self_postal_code(postal_code, tax_postal_code)
195
-
196
- Deletes a Self tax provider postalCode
197
-
198
- Deletes a Self tax provider postalCode.
199
-
200
- ### Example
201
- ```ruby
202
- # load the gem
203
- require 'ultracart_api'
204
-
205
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
206
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
207
- api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
208
-
209
-
210
- postal_code = 'postal_code_example' # String | The postal code being deleted.
211
-
212
- tax_postal_code = UltracartClient::TaxPostalCode.new # TaxPostalCode | tax postal code to be deleted
213
-
214
-
215
- begin
216
- #Deletes a Self tax provider postalCode
217
- api_instance.delete_tax_provider_self_postal_code(postal_code, tax_postal_code)
218
- rescue UltracartClient::ApiError => e
219
- puts "Exception when calling TaxApi->delete_tax_provider_self_postal_code: #{e}"
220
- end
221
- ```
222
-
223
- ### Parameters
224
-
225
- Name | Type | Description | Notes
226
- ------------- | ------------- | ------------- | -------------
227
- **postal_code** | **String**| The postal code being deleted. |
228
- **tax_postal_code** | [**TaxPostalCode**](TaxPostalCode.md)| tax postal code to be deleted |
229
-
230
- ### Return type
231
-
232
- nil (empty response body)
233
-
234
- ### Authorization
235
-
236
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
237
-
238
- ### HTTP request headers
239
-
240
- - **Content-Type**: application/json
241
- - **Accept**: application/json
242
-
243
-
244
-
245
- # **delete_tax_provider_self_state**
246
- > delete_tax_provider_self_state(state_code, tax_state)
247
-
248
- Deletes a Self tax provider state
249
-
250
- Deletes a Self tax provider state.
251
-
252
- ### Example
253
- ```ruby
254
- # load the gem
255
- require 'ultracart_api'
256
-
257
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
258
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
259
- api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
260
-
261
-
262
- state_code = 'state_code_example' # String | The state code being deleted.
263
-
264
- tax_state = UltracartClient::TaxState.new # TaxState | tax state to be deleted
265
-
266
-
267
- begin
268
- #Deletes a Self tax provider state
269
- api_instance.delete_tax_provider_self_state(state_code, tax_state)
270
- rescue UltracartClient::ApiError => e
271
- puts "Exception when calling TaxApi->delete_tax_provider_self_state: #{e}"
272
- end
273
- ```
274
-
275
- ### Parameters
276
-
277
- Name | Type | Description | Notes
278
- ------------- | ------------- | ------------- | -------------
279
- **state_code** | **String**| The state code being deleted. |
280
- **tax_state** | [**TaxState**](TaxState.md)| tax state to be deleted |
281
-
282
- ### Return type
283
-
284
- nil (empty response body)
285
-
286
- ### Authorization
287
-
288
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
289
-
290
- ### HTTP request headers
291
-
292
- - **Content-Type**: application/json
293
- - **Accept**: application/json
294
-
295
-
296
-
297
- # **get_tax_provider_avalara**
298
- > TaxProviderAvalara get_tax_provider_avalara
299
-
300
- Retrieve the Avalara tax provider
301
-
302
- Retrieves the Avalara tax provider.
303
-
304
- ### Example
305
- ```ruby
306
- # load the gem
307
- require 'ultracart_api'
308
-
309
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
310
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
311
- api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
312
-
313
-
314
-
315
- begin
316
- #Retrieve the Avalara tax provider
317
- result = api_instance.get_tax_provider_avalara
318
- p result
319
- rescue UltracartClient::ApiError => e
320
- puts "Exception when calling TaxApi->get_tax_provider_avalara: #{e}"
321
- end
322
- ```
323
-
324
- ### Parameters
325
- This endpoint does not need any parameter.
326
-
327
- ### Return type
328
-
329
- [**TaxProviderAvalara**](TaxProviderAvalara.md)
330
-
331
- ### Authorization
332
-
333
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
334
-
335
- ### HTTP request headers
336
-
337
- - **Content-Type**: application/json
338
- - **Accept**: application/json
339
-
340
-
341
-
342
- # **get_tax_provider_avalara_companies**
343
- > TaxProviderAvalaraCompaniesResult get_tax_provider_avalara_companies(tax_provider_avalara)
344
-
345
- Returns Avalara Tax companies configured by the merchant
346
-
347
- Returns Avalara Tax companies configured by the merchant
348
-
349
- ### Example
350
- ```ruby
351
- # load the gem
352
- require 'ultracart_api'
353
-
354
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
355
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
356
- api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
357
-
358
-
359
- tax_provider_avalara = UltracartClient::TaxProviderAvalara.new # TaxProviderAvalara | TaxProviderAvalara object
360
-
361
-
362
- begin
363
- #Returns Avalara Tax companies configured by the merchant
364
- result = api_instance.get_tax_provider_avalara_companies(tax_provider_avalara)
365
- p result
366
- rescue UltracartClient::ApiError => e
367
- puts "Exception when calling TaxApi->get_tax_provider_avalara_companies: #{e}"
368
- end
369
- ```
370
-
371
- ### Parameters
372
-
373
- Name | Type | Description | Notes
374
- ------------- | ------------- | ------------- | -------------
375
- **tax_provider_avalara** | [**TaxProviderAvalara**](TaxProviderAvalara.md)| TaxProviderAvalara object |
376
-
377
- ### Return type
378
-
379
- [**TaxProviderAvalaraCompaniesResult**](TaxProviderAvalaraCompaniesResult.md)
380
-
381
- ### Authorization
382
-
383
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
384
-
385
- ### HTTP request headers
386
-
387
- - **Content-Type**: application/json
388
- - **Accept**: application/json
389
-
390
-
391
-
392
- # **get_tax_provider_avalara_test**
393
- > TaxProviderTestResult get_tax_provider_avalara_test
394
-
395
- Attempts to connect to Avalara and returns back the response
396
-
397
- Attempts to connect to Avalara and returns back the response.
398
-
399
- ### Example
400
- ```ruby
401
- # load the gem
402
- require 'ultracart_api'
403
-
404
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
405
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
406
- api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
407
-
408
-
409
-
410
- begin
411
- #Attempts to connect to Avalara and returns back the response
412
- result = api_instance.get_tax_provider_avalara_test
413
- p result
414
- rescue UltracartClient::ApiError => e
415
- puts "Exception when calling TaxApi->get_tax_provider_avalara_test: #{e}"
416
- end
417
- ```
418
-
419
- ### Parameters
420
- This endpoint does not need any parameter.
421
-
422
- ### Return type
423
-
424
- [**TaxProviderTestResult**](TaxProviderTestResult.md)
425
-
426
- ### Authorization
427
-
428
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
429
-
430
- ### HTTP request headers
431
-
432
- - **Content-Type**: application/json
433
- - **Accept**: application/json
434
-
435
-
436
-
437
- # **get_tax_provider_self**
438
- > TaxProviderSelf get_tax_provider_self
439
-
440
- Retrieve the Self tax provider
441
-
442
- Retrieves the Self tax provider.
443
-
444
- ### Example
445
- ```ruby
446
- # load the gem
447
- require 'ultracart_api'
448
-
449
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
450
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
451
- api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
452
-
453
-
454
-
455
- begin
456
- #Retrieve the Self tax provider
457
- result = api_instance.get_tax_provider_self
458
- p result
459
- rescue UltracartClient::ApiError => e
460
- puts "Exception when calling TaxApi->get_tax_provider_self: #{e}"
461
- end
462
- ```
463
-
464
- ### Parameters
465
- This endpoint does not need any parameter.
466
-
467
- ### Return type
468
-
469
- [**TaxProviderSelf**](TaxProviderSelf.md)
470
-
471
- ### Authorization
472
-
473
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
474
-
475
- ### HTTP request headers
476
-
477
- - **Content-Type**: application/json
478
- - **Accept**: application/json
479
-
480
-
481
-
482
- # **get_tax_provider_self_countries**
483
- > TaxProviderSelfCountriesResponse get_tax_provider_self_countries
484
-
485
- Retrieve the Self tax provider countries
486
-
487
- Retrieves the Self tax provider countries.
488
-
489
- ### Example
490
- ```ruby
491
- # load the gem
492
- require 'ultracart_api'
493
-
494
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
495
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
496
- api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
497
-
498
-
499
-
500
- begin
501
- #Retrieve the Self tax provider countries
502
- result = api_instance.get_tax_provider_self_countries
503
- p result
504
- rescue UltracartClient::ApiError => e
505
- puts "Exception when calling TaxApi->get_tax_provider_self_countries: #{e}"
506
- end
507
- ```
508
-
509
- ### Parameters
510
- This endpoint does not need any parameter.
511
-
512
- ### Return type
513
-
514
- [**TaxProviderSelfCountriesResponse**](TaxProviderSelfCountriesResponse.md)
515
-
516
- ### Authorization
517
-
518
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
519
-
520
- ### HTTP request headers
521
-
522
- - **Content-Type**: application/json
523
- - **Accept**: application/json
524
-
525
-
526
-
527
- # **get_tax_provider_self_regions_by_country_code**
528
- > TaxProviderSelfRegionsResponse get_tax_provider_self_regions_by_country_code(country_code)
529
-
530
- Retrieve the Self tax provider regions for a given country code
531
-
532
- Retrieves the Self tax provider regions for a given country code.
533
-
534
- ### Example
535
- ```ruby
536
- # load the gem
537
- require 'ultracart_api'
538
-
539
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
540
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
541
- api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
542
-
543
-
544
- country_code = 'country_code_example' # String | The country code regions desired.
545
-
546
-
547
- begin
548
- #Retrieve the Self tax provider regions for a given country code
549
- result = api_instance.get_tax_provider_self_regions_by_country_code(country_code)
550
- p result
551
- rescue UltracartClient::ApiError => e
552
- puts "Exception when calling TaxApi->get_tax_provider_self_regions_by_country_code: #{e}"
553
- end
554
- ```
555
-
556
- ### Parameters
557
-
558
- Name | Type | Description | Notes
559
- ------------- | ------------- | ------------- | -------------
560
- **country_code** | **String**| The country code regions desired. |
561
-
562
- ### Return type
563
-
564
- [**TaxProviderSelfRegionsResponse**](TaxProviderSelfRegionsResponse.md)
565
-
566
- ### Authorization
567
-
568
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
569
-
570
- ### HTTP request headers
571
-
572
- - **Content-Type**: application/json
573
- - **Accept**: application/json
574
-
575
-
576
-
577
- # **get_tax_provider_sovos**
578
- > TaxProviderSovos get_tax_provider_sovos
579
-
580
- Retrieve the Sovos tax provider
581
-
582
- Retrieves the Sovos tax provider.
583
-
584
- ### Example
585
- ```ruby
586
- # load the gem
587
- require 'ultracart_api'
588
-
589
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
590
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
591
- api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
592
-
593
-
594
-
595
- begin
596
- #Retrieve the Sovos tax provider
597
- result = api_instance.get_tax_provider_sovos
598
- p result
599
- rescue UltracartClient::ApiError => e
600
- puts "Exception when calling TaxApi->get_tax_provider_sovos: #{e}"
601
- end
602
- ```
603
-
604
- ### Parameters
605
- This endpoint does not need any parameter.
606
-
607
- ### Return type
608
-
609
- [**TaxProviderSovos**](TaxProviderSovos.md)
610
-
611
- ### Authorization
612
-
613
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
614
-
615
- ### HTTP request headers
616
-
617
- - **Content-Type**: application/json
618
- - **Accept**: application/json
619
-
620
-
621
-
622
- # **get_tax_provider_sovos_test**
623
- > TaxProviderTestResult get_tax_provider_sovos_test
624
-
625
- Attempts to connect to Sovos and returns back the response
626
-
627
- Attempts to connect to Sovos and returns back the response.
628
-
629
- ### Example
630
- ```ruby
631
- # load the gem
632
- require 'ultracart_api'
633
-
634
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
635
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
636
- api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
637
-
638
-
639
-
640
- begin
641
- #Attempts to connect to Sovos and returns back the response
642
- result = api_instance.get_tax_provider_sovos_test
643
- p result
644
- rescue UltracartClient::ApiError => e
645
- puts "Exception when calling TaxApi->get_tax_provider_sovos_test: #{e}"
646
- end
647
- ```
648
-
649
- ### Parameters
650
- This endpoint does not need any parameter.
651
-
652
- ### Return type
653
-
654
- [**TaxProviderTestResult**](TaxProviderTestResult.md)
655
-
656
- ### Authorization
657
-
658
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
659
-
660
- ### HTTP request headers
661
-
662
- - **Content-Type**: application/json
663
- - **Accept**: application/json
664
-
665
-
666
-
667
- # **get_tax_provider_tax_jar**
668
- > TaxProviderTaxJar get_tax_provider_tax_jar
669
-
670
- Retrieve the TaxJar tax provider
671
-
672
- Retrieves the TaxJar tax provider.
673
-
674
- ### Example
675
- ```ruby
676
- # load the gem
677
- require 'ultracart_api'
678
-
679
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
680
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
681
- api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
682
-
683
-
684
-
685
- begin
686
- #Retrieve the TaxJar tax provider
687
- result = api_instance.get_tax_provider_tax_jar
688
- p result
689
- rescue UltracartClient::ApiError => e
690
- puts "Exception when calling TaxApi->get_tax_provider_tax_jar: #{e}"
691
- end
692
- ```
693
-
694
- ### Parameters
695
- This endpoint does not need any parameter.
696
-
697
- ### Return type
698
-
699
- [**TaxProviderTaxJar**](TaxProviderTaxJar.md)
700
-
701
- ### Authorization
702
-
703
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
704
-
705
- ### HTTP request headers
706
-
707
- - **Content-Type**: application/json
708
- - **Accept**: application/json
709
-
710
-
711
-
712
- # **get_tax_provider_tax_jar_test**
713
- > TaxProviderTestResult get_tax_provider_tax_jar_test
714
-
715
- Attempts to connect to TaxJar and returns back the response
716
-
717
- Attempts to connect to TaxJar and returns back the response.
718
-
719
- ### Example
720
- ```ruby
721
- # load the gem
722
- require 'ultracart_api'
723
-
724
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
725
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
726
- api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
727
-
728
-
729
-
730
- begin
731
- #Attempts to connect to TaxJar and returns back the response
732
- result = api_instance.get_tax_provider_tax_jar_test
733
- p result
734
- rescue UltracartClient::ApiError => e
735
- puts "Exception when calling TaxApi->get_tax_provider_tax_jar_test: #{e}"
736
- end
737
- ```
738
-
739
- ### Parameters
740
- This endpoint does not need any parameter.
741
-
742
- ### Return type
743
-
744
- [**TaxProviderTestResult**](TaxProviderTestResult.md)
745
-
746
- ### Authorization
747
-
748
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
749
-
750
- ### HTTP request headers
751
-
752
- - **Content-Type**: application/json
753
- - **Accept**: application/json
754
-
755
-
756
-
757
- # **get_tax_provider_ultra_cart**
758
- > TaxProviderUltraCart get_tax_provider_ultra_cart
759
-
760
- Retrieve the UltraCart tax provider
761
-
762
- Retrieves the UltraCart tax provider.
763
-
764
- ### Example
765
- ```ruby
766
- # load the gem
767
- require 'ultracart_api'
768
-
769
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
770
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
771
- api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
772
-
773
-
774
-
775
- begin
776
- #Retrieve the UltraCart tax provider
777
- result = api_instance.get_tax_provider_ultra_cart
778
- p result
779
- rescue UltracartClient::ApiError => e
780
- puts "Exception when calling TaxApi->get_tax_provider_ultra_cart: #{e}"
781
- end
782
- ```
783
-
784
- ### Parameters
785
- This endpoint does not need any parameter.
786
-
787
- ### Return type
788
-
789
- [**TaxProviderUltraCart**](TaxProviderUltraCart.md)
790
-
791
- ### Authorization
792
-
793
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
794
-
795
- ### HTTP request headers
796
-
797
- - **Content-Type**: application/json
798
- - **Accept**: application/json
799
-
800
-
801
-
802
- # **get_tax_providers**
803
- > TaxProvidersResponse get_tax_providers(opts)
804
-
805
- Retrieve tax methods
806
-
807
- Retrieves tax methods for this account.
808
-
809
- ### Example
810
- ```ruby
811
- # load the gem
812
- require 'ultracart_api'
813
-
814
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
815
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
816
- api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
817
-
818
-
819
- opts = {
820
- _limit: 100, # Integer | The maximum number of records to return on this one API call. (Max 200)
821
- _offset: 0, # Integer | Pagination of the record set. Offset is a zero based index.
822
- _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
823
- }
824
-
825
- begin
826
- #Retrieve tax methods
827
- result = api_instance.get_tax_providers(opts)
828
- p result
829
- rescue UltracartClient::ApiError => e
830
- puts "Exception when calling TaxApi->get_tax_providers: #{e}"
831
- end
832
- ```
833
-
834
- ### Parameters
835
-
836
- Name | Type | Description | Notes
837
- ------------- | ------------- | ------------- | -------------
838
- **_limit** | **Integer**| The maximum number of records to return on this one API call. (Max 200) | [optional] [default to 100]
839
- **_offset** | **Integer**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
840
- **_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
841
-
842
- ### Return type
843
-
844
- [**TaxProvidersResponse**](TaxProvidersResponse.md)
845
-
846
- ### Authorization
847
-
848
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
849
-
850
- ### HTTP request headers
851
-
852
- - **Content-Type**: application/json
853
- - **Accept**: application/json
854
-
855
-
856
-
857
- # **set_active_tax_provider**
858
- > TaxProviderActivateResult set_active_tax_provider(provider_name)
859
-
860
- Toggle a tax provider to active
861
-
862
- Toggle a tax provider to active.
863
-
864
- ### Example
865
- ```ruby
866
- # load the gem
867
- require 'ultracart_api'
868
-
869
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
870
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
871
- api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
872
-
873
-
874
- provider_name = 'provider_name_example' # String | The tax provider to set active.
875
-
876
-
877
- begin
878
- #Toggle a tax provider to active
879
- result = api_instance.set_active_tax_provider(provider_name)
880
- p result
881
- rescue UltracartClient::ApiError => e
882
- puts "Exception when calling TaxApi->set_active_tax_provider: #{e}"
883
- end
884
- ```
885
-
886
- ### Parameters
887
-
888
- Name | Type | Description | Notes
889
- ------------- | ------------- | ------------- | -------------
890
- **provider_name** | **String**| The tax provider to set active. |
891
-
892
- ### Return type
893
-
894
- [**TaxProviderActivateResult**](TaxProviderActivateResult.md)
895
-
896
- ### Authorization
897
-
898
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
899
-
900
- ### HTTP request headers
901
-
902
- - **Content-Type**: application/json
903
- - **Accept**: application/json
904
-
905
-
906
-
907
- # **update_tax_provider_avalara**
908
- > TaxProviderAvalara update_tax_provider_avalara(tax_provider_avalara)
909
-
910
- Update the Avalara tax provider
911
-
912
- Update the Avalara tax provider.
913
-
914
- ### Example
915
- ```ruby
916
- # load the gem
917
- require 'ultracart_api'
918
-
919
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
920
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
921
- api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
922
-
923
-
924
- tax_provider_avalara = UltracartClient::TaxProviderAvalara.new # TaxProviderAvalara | TaxProviderAvalara object
925
-
926
-
927
- begin
928
- #Update the Avalara tax provider
929
- result = api_instance.update_tax_provider_avalara(tax_provider_avalara)
930
- p result
931
- rescue UltracartClient::ApiError => e
932
- puts "Exception when calling TaxApi->update_tax_provider_avalara: #{e}"
933
- end
934
- ```
935
-
936
- ### Parameters
937
-
938
- Name | Type | Description | Notes
939
- ------------- | ------------- | ------------- | -------------
940
- **tax_provider_avalara** | [**TaxProviderAvalara**](TaxProviderAvalara.md)| TaxProviderAvalara object |
941
-
942
- ### Return type
943
-
944
- [**TaxProviderAvalara**](TaxProviderAvalara.md)
945
-
946
- ### Authorization
947
-
948
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
949
-
950
- ### HTTP request headers
951
-
952
- - **Content-Type**: application/json
953
- - **Accept**: application/json
954
-
955
-
956
-
957
- # **update_tax_provider_self**
958
- > TaxProviderSelf update_tax_provider_self(tax_provider_self)
959
-
960
- Update the Self tax provider
961
-
962
- Update the Self tax provider.
963
-
964
- ### Example
965
- ```ruby
966
- # load the gem
967
- require 'ultracart_api'
968
-
969
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
970
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
971
- api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
972
-
973
-
974
- tax_provider_self = UltracartClient::TaxProviderSelf.new # TaxProviderSelf | TaxProviderSelf object
975
-
976
-
977
- begin
978
- #Update the Self tax provider
979
- result = api_instance.update_tax_provider_self(tax_provider_self)
980
- p result
981
- rescue UltracartClient::ApiError => e
982
- puts "Exception when calling TaxApi->update_tax_provider_self: #{e}"
983
- end
984
- ```
985
-
986
- ### Parameters
987
-
988
- Name | Type | Description | Notes
989
- ------------- | ------------- | ------------- | -------------
990
- **tax_provider_self** | [**TaxProviderSelf**](TaxProviderSelf.md)| TaxProviderSelf object |
991
-
992
- ### Return type
993
-
994
- [**TaxProviderSelf**](TaxProviderSelf.md)
995
-
996
- ### Authorization
997
-
998
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
999
-
1000
- ### HTTP request headers
1001
-
1002
- - **Content-Type**: application/json
1003
- - **Accept**: application/json
1004
-
1005
-
1006
-
1007
- # **update_tax_provider_self_city**
1008
- > TaxCity update_tax_provider_self_city(city, tax_city)
1009
-
1010
- Updates a Self tax provider city
1011
-
1012
- Updates a Self tax provider city.
1013
-
1014
- ### Example
1015
- ```ruby
1016
- # load the gem
1017
- require 'ultracart_api'
1018
-
1019
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1020
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1021
- api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
1022
-
1023
-
1024
- city = 'city_example' # String | The city being updated.
1025
-
1026
- tax_city = UltracartClient::TaxCity.new # TaxCity | tax city to be updated
1027
-
1028
-
1029
- begin
1030
- #Updates a Self tax provider city
1031
- result = api_instance.update_tax_provider_self_city(city, tax_city)
1032
- p result
1033
- rescue UltracartClient::ApiError => e
1034
- puts "Exception when calling TaxApi->update_tax_provider_self_city: #{e}"
1035
- end
1036
- ```
1037
-
1038
- ### Parameters
1039
-
1040
- Name | Type | Description | Notes
1041
- ------------- | ------------- | ------------- | -------------
1042
- **city** | **String**| The city being updated. |
1043
- **tax_city** | [**TaxCity**](TaxCity.md)| tax city to be updated |
1044
-
1045
- ### Return type
1046
-
1047
- [**TaxCity**](TaxCity.md)
1048
-
1049
- ### Authorization
1050
-
1051
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1052
-
1053
- ### HTTP request headers
1054
-
1055
- - **Content-Type**: application/json
1056
- - **Accept**: application/json
1057
-
1058
-
1059
-
1060
- # **update_tax_provider_self_country**
1061
- > TaxCountry update_tax_provider_self_country(country_code, tax_country)
1062
-
1063
- Updates a Self tax provider country
1064
-
1065
- Updates a Self tax provider country.
1066
-
1067
- ### Example
1068
- ```ruby
1069
- # load the gem
1070
- require 'ultracart_api'
1071
-
1072
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1073
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1074
- api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
1075
-
1076
-
1077
- country_code = 'country_code_example' # String | The country code being updated.
1078
-
1079
- tax_country = UltracartClient::TaxCountry.new # TaxCountry | tax country to be updated
1080
-
1081
-
1082
- begin
1083
- #Updates a Self tax provider country
1084
- result = api_instance.update_tax_provider_self_country(country_code, tax_country)
1085
- p result
1086
- rescue UltracartClient::ApiError => e
1087
- puts "Exception when calling TaxApi->update_tax_provider_self_country: #{e}"
1088
- end
1089
- ```
1090
-
1091
- ### Parameters
1092
-
1093
- Name | Type | Description | Notes
1094
- ------------- | ------------- | ------------- | -------------
1095
- **country_code** | **String**| The country code being updated. |
1096
- **tax_country** | [**TaxCountry**](TaxCountry.md)| tax country to be updated |
1097
-
1098
- ### Return type
1099
-
1100
- [**TaxCountry**](TaxCountry.md)
1101
-
1102
- ### Authorization
1103
-
1104
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1105
-
1106
- ### HTTP request headers
1107
-
1108
- - **Content-Type**: application/json
1109
- - **Accept**: application/json
1110
-
1111
-
1112
-
1113
- # **update_tax_provider_self_county**
1114
- > TaxCounty update_tax_provider_self_county(county, tax_county)
1115
-
1116
- Updates a Self tax provider county
1117
-
1118
- Updates a Self tax provider county.
1119
-
1120
- ### Example
1121
- ```ruby
1122
- # load the gem
1123
- require 'ultracart_api'
1124
-
1125
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1126
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1127
- api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
1128
-
1129
-
1130
- county = 'county_example' # String | The county being updated.
1131
-
1132
- tax_county = UltracartClient::TaxCounty.new # TaxCounty | tax county to be updated
1133
-
1134
-
1135
- begin
1136
- #Updates a Self tax provider county
1137
- result = api_instance.update_tax_provider_self_county(county, tax_county)
1138
- p result
1139
- rescue UltracartClient::ApiError => e
1140
- puts "Exception when calling TaxApi->update_tax_provider_self_county: #{e}"
1141
- end
1142
- ```
1143
-
1144
- ### Parameters
1145
-
1146
- Name | Type | Description | Notes
1147
- ------------- | ------------- | ------------- | -------------
1148
- **county** | **String**| The county being updated. |
1149
- **tax_county** | [**TaxCounty**](TaxCounty.md)| tax county to be updated |
1150
-
1151
- ### Return type
1152
-
1153
- [**TaxCounty**](TaxCounty.md)
1154
-
1155
- ### Authorization
1156
-
1157
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1158
-
1159
- ### HTTP request headers
1160
-
1161
- - **Content-Type**: application/json
1162
- - **Accept**: application/json
1163
-
1164
-
1165
-
1166
- # **update_tax_provider_self_postal_code**
1167
- > TaxPostalCode update_tax_provider_self_postal_code(postal_code, tax_postal_code)
1168
-
1169
- Updates a Self tax provider postalCode
1170
-
1171
- Updates a Self tax provider postalCode.
1172
-
1173
- ### Example
1174
- ```ruby
1175
- # load the gem
1176
- require 'ultracart_api'
1177
-
1178
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1179
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1180
- api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
1181
-
1182
-
1183
- postal_code = 'postal_code_example' # String | The postal code being updated.
1184
-
1185
- tax_postal_code = UltracartClient::TaxPostalCode.new # TaxPostalCode | tax postal code to be updated
1186
-
1187
-
1188
- begin
1189
- #Updates a Self tax provider postalCode
1190
- result = api_instance.update_tax_provider_self_postal_code(postal_code, tax_postal_code)
1191
- p result
1192
- rescue UltracartClient::ApiError => e
1193
- puts "Exception when calling TaxApi->update_tax_provider_self_postal_code: #{e}"
1194
- end
1195
- ```
1196
-
1197
- ### Parameters
1198
-
1199
- Name | Type | Description | Notes
1200
- ------------- | ------------- | ------------- | -------------
1201
- **postal_code** | **String**| The postal code being updated. |
1202
- **tax_postal_code** | [**TaxPostalCode**](TaxPostalCode.md)| tax postal code to be updated |
1203
-
1204
- ### Return type
1205
-
1206
- [**TaxPostalCode**](TaxPostalCode.md)
1207
-
1208
- ### Authorization
1209
-
1210
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1211
-
1212
- ### HTTP request headers
1213
-
1214
- - **Content-Type**: application/json
1215
- - **Accept**: application/json
1216
-
1217
-
1218
-
1219
- # **update_tax_provider_self_state**
1220
- > TaxState update_tax_provider_self_state(state_code, tax_state)
1221
-
1222
- Updates a Self tax provider state
1223
-
1224
- Updates a Self tax provider state.
1225
-
1226
- ### Example
1227
- ```ruby
1228
- # load the gem
1229
- require 'ultracart_api'
1230
-
1231
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1232
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1233
- api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
1234
-
1235
-
1236
- state_code = 'state_code_example' # String | The state code being updated.
1237
-
1238
- tax_state = UltracartClient::TaxState.new # TaxState | tax state to be updated
1239
-
1240
-
1241
- begin
1242
- #Updates a Self tax provider state
1243
- result = api_instance.update_tax_provider_self_state(state_code, tax_state)
1244
- p result
1245
- rescue UltracartClient::ApiError => e
1246
- puts "Exception when calling TaxApi->update_tax_provider_self_state: #{e}"
1247
- end
1248
- ```
1249
-
1250
- ### Parameters
1251
-
1252
- Name | Type | Description | Notes
1253
- ------------- | ------------- | ------------- | -------------
1254
- **state_code** | **String**| The state code being updated. |
1255
- **tax_state** | [**TaxState**](TaxState.md)| tax state to be updated |
1256
-
1257
- ### Return type
1258
-
1259
- [**TaxState**](TaxState.md)
1260
-
1261
- ### Authorization
1262
-
1263
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1264
-
1265
- ### HTTP request headers
1266
-
1267
- - **Content-Type**: application/json
1268
- - **Accept**: application/json
1269
-
1270
-
1271
-
1272
- # **update_tax_provider_sovos**
1273
- > TaxProviderSovos update_tax_provider_sovos(tax_provider_sovos)
1274
-
1275
- Update the Sovos tax provider
1276
-
1277
- Update the Sovos tax provider.
1278
-
1279
- ### Example
1280
- ```ruby
1281
- # load the gem
1282
- require 'ultracart_api'
1283
-
1284
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1285
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1286
- api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
1287
-
1288
-
1289
- tax_provider_sovos = UltracartClient::TaxProviderSovos.new # TaxProviderSovos | TaxProviderSovos object
1290
-
1291
-
1292
- begin
1293
- #Update the Sovos tax provider
1294
- result = api_instance.update_tax_provider_sovos(tax_provider_sovos)
1295
- p result
1296
- rescue UltracartClient::ApiError => e
1297
- puts "Exception when calling TaxApi->update_tax_provider_sovos: #{e}"
1298
- end
1299
- ```
1300
-
1301
- ### Parameters
1302
-
1303
- Name | Type | Description | Notes
1304
- ------------- | ------------- | ------------- | -------------
1305
- **tax_provider_sovos** | [**TaxProviderSovos**](TaxProviderSovos.md)| TaxProviderSovos object |
1306
-
1307
- ### Return type
1308
-
1309
- [**TaxProviderSovos**](TaxProviderSovos.md)
1310
-
1311
- ### Authorization
1312
-
1313
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1314
-
1315
- ### HTTP request headers
1316
-
1317
- - **Content-Type**: application/json
1318
- - **Accept**: application/json
1319
-
1320
-
1321
-
1322
- # **update_tax_provider_tax_jar**
1323
- > TaxProviderTaxJar update_tax_provider_tax_jar(tax_provider_tax_jar)
1324
-
1325
- Update the TaxJar tax provider
1326
-
1327
- Update the TaxJar tax provider.
1328
-
1329
- ### Example
1330
- ```ruby
1331
- # load the gem
1332
- require 'ultracart_api'
1333
-
1334
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1335
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1336
- api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
1337
-
1338
-
1339
- tax_provider_tax_jar = UltracartClient::TaxProviderTaxJar.new # TaxProviderTaxJar | TaxProviderTaxJar object
1340
-
1341
-
1342
- begin
1343
- #Update the TaxJar tax provider
1344
- result = api_instance.update_tax_provider_tax_jar(tax_provider_tax_jar)
1345
- p result
1346
- rescue UltracartClient::ApiError => e
1347
- puts "Exception when calling TaxApi->update_tax_provider_tax_jar: #{e}"
1348
- end
1349
- ```
1350
-
1351
- ### Parameters
1352
-
1353
- Name | Type | Description | Notes
1354
- ------------- | ------------- | ------------- | -------------
1355
- **tax_provider_tax_jar** | [**TaxProviderTaxJar**](TaxProviderTaxJar.md)| TaxProviderTaxJar object |
1356
-
1357
- ### Return type
1358
-
1359
- [**TaxProviderTaxJar**](TaxProviderTaxJar.md)
1360
-
1361
- ### Authorization
1362
-
1363
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1364
-
1365
- ### HTTP request headers
1366
-
1367
- - **Content-Type**: application/json
1368
- - **Accept**: application/json
1369
-
1370
-
1371
-
1372
- # **update_tax_provider_ultra_cart**
1373
- > TaxProviderUltraCart update_tax_provider_ultra_cart(tax_provider_ultracart)
1374
-
1375
- Update the UltraCart tax provider
1376
-
1377
- Update the UltraCart tax provider.
1378
-
1379
- ### Example
1380
- ```ruby
1381
- # load the gem
1382
- require 'ultracart_api'
1383
-
1384
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1385
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1386
- api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
1387
-
1388
-
1389
- tax_provider_ultracart = UltracartClient::TaxProviderUltraCart.new # TaxProviderUltraCart | TaxProviderUltraCart object
1390
-
1391
-
1392
- begin
1393
- #Update the UltraCart tax provider
1394
- result = api_instance.update_tax_provider_ultra_cart(tax_provider_ultracart)
1395
- p result
1396
- rescue UltracartClient::ApiError => e
1397
- puts "Exception when calling TaxApi->update_tax_provider_ultra_cart: #{e}"
1398
- end
1399
- ```
1400
-
1401
- ### Parameters
1402
-
1403
- Name | Type | Description | Notes
1404
- ------------- | ------------- | ------------- | -------------
1405
- **tax_provider_ultracart** | [**TaxProviderUltraCart**](TaxProviderUltraCart.md)| TaxProviderUltraCart object |
1406
-
1407
- ### Return type
1408
-
1409
- [**TaxProviderUltraCart**](TaxProviderUltraCart.md)
1410
-
1411
- ### Authorization
1412
-
1413
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1414
-
1415
- ### HTTP request headers
1416
-
1417
- - **Content-Type**: application/json
1418
- - **Accept**: application/json
1419
-
1420
-
1421
-
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
+
39
+ > delete_tax_provider_self_city(city, tax_city)
40
+
41
+ Deletes a Self tax provider city
42
+
43
+ Deletes a Self tax provider city.
44
+
45
+ ### Examples
46
+
47
+ ```ruby
48
+ require 'time'
49
+ require 'ultracart_api'
50
+ # setup authorization
51
+ UltracartClient.configure do |config|
52
+ # Configure OAuth2 access token for authorization: ultraCartOauth
53
+ config.access_token = 'YOUR ACCESS TOKEN'
54
+
55
+ # Configure API key authorization: ultraCartSimpleApiKey
56
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
57
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
58
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
59
+ end
60
+
61
+ api_instance = UltracartClient::TaxApi.new
62
+ city = 'city_example' # String | The city being deleted.
63
+ tax_city = UltracartClient::TaxCity.new # TaxCity | tax city to be deleted
64
+
65
+ begin
66
+ # Deletes a Self tax provider city
67
+ api_instance.delete_tax_provider_self_city(city, tax_city)
68
+ rescue UltracartClient::ApiError => e
69
+ puts "Error when calling TaxApi->delete_tax_provider_self_city: #{e}"
70
+ end
71
+ ```
72
+
73
+ #### Using the delete_tax_provider_self_city_with_http_info variant
74
+
75
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
76
+
77
+ > <Array(nil, Integer, Hash)> delete_tax_provider_self_city_with_http_info(city, tax_city)
78
+
79
+ ```ruby
80
+ begin
81
+ # Deletes a Self tax provider city
82
+ data, status_code, headers = api_instance.delete_tax_provider_self_city_with_http_info(city, tax_city)
83
+ p status_code # => 2xx
84
+ p headers # => { ... }
85
+ p data # => nil
86
+ rescue UltracartClient::ApiError => e
87
+ puts "Error when calling TaxApi->delete_tax_provider_self_city_with_http_info: #{e}"
88
+ end
89
+ ```
90
+
91
+ ### Parameters
92
+
93
+ | Name | Type | Description | Notes |
94
+ | ---- | ---- | ----------- | ----- |
95
+ | **city** | **String** | The city being deleted. | |
96
+ | **tax_city** | [**TaxCity**](TaxCity.md) | tax city to be deleted | |
97
+
98
+ ### Return type
99
+
100
+ nil (empty response body)
101
+
102
+ ### Authorization
103
+
104
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
105
+
106
+ ### HTTP request headers
107
+
108
+ - **Content-Type**: application/json
109
+ - **Accept**: application/json
110
+
111
+
112
+ ## delete_tax_provider_self_country
113
+
114
+ > delete_tax_provider_self_country(country_code, tax_country)
115
+
116
+ Deletes a Self tax provider country
117
+
118
+ Deletes a Self tax provider country.
119
+
120
+ ### Examples
121
+
122
+ ```ruby
123
+ require 'time'
124
+ require 'ultracart_api'
125
+ # setup authorization
126
+ UltracartClient.configure do |config|
127
+ # Configure OAuth2 access token for authorization: ultraCartOauth
128
+ config.access_token = 'YOUR ACCESS TOKEN'
129
+
130
+ # Configure API key authorization: ultraCartSimpleApiKey
131
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
132
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
133
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
134
+ end
135
+
136
+ api_instance = UltracartClient::TaxApi.new
137
+ country_code = 'country_code_example' # String | The country code being deleted.
138
+ tax_country = UltracartClient::TaxCountry.new # TaxCountry | tax country to be deleted
139
+
140
+ begin
141
+ # Deletes a Self tax provider country
142
+ api_instance.delete_tax_provider_self_country(country_code, tax_country)
143
+ rescue UltracartClient::ApiError => e
144
+ puts "Error when calling TaxApi->delete_tax_provider_self_country: #{e}"
145
+ end
146
+ ```
147
+
148
+ #### Using the delete_tax_provider_self_country_with_http_info variant
149
+
150
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
151
+
152
+ > <Array(nil, Integer, Hash)> delete_tax_provider_self_country_with_http_info(country_code, tax_country)
153
+
154
+ ```ruby
155
+ begin
156
+ # Deletes a Self tax provider country
157
+ data, status_code, headers = api_instance.delete_tax_provider_self_country_with_http_info(country_code, tax_country)
158
+ p status_code # => 2xx
159
+ p headers # => { ... }
160
+ p data # => nil
161
+ rescue UltracartClient::ApiError => e
162
+ puts "Error when calling TaxApi->delete_tax_provider_self_country_with_http_info: #{e}"
163
+ end
164
+ ```
165
+
166
+ ### Parameters
167
+
168
+ | Name | Type | Description | Notes |
169
+ | ---- | ---- | ----------- | ----- |
170
+ | **country_code** | **String** | The country code being deleted. | |
171
+ | **tax_country** | [**TaxCountry**](TaxCountry.md) | tax country to be deleted | |
172
+
173
+ ### Return type
174
+
175
+ nil (empty response body)
176
+
177
+ ### Authorization
178
+
179
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
180
+
181
+ ### HTTP request headers
182
+
183
+ - **Content-Type**: application/json
184
+ - **Accept**: application/json
185
+
186
+
187
+ ## delete_tax_provider_self_county
188
+
189
+ > delete_tax_provider_self_county(county, tax_county)
190
+
191
+ Deletes a Self tax provider county
192
+
193
+ Deletes a Self tax provider county.
194
+
195
+ ### Examples
196
+
197
+ ```ruby
198
+ require 'time'
199
+ require 'ultracart_api'
200
+ # setup authorization
201
+ UltracartClient.configure do |config|
202
+ # Configure OAuth2 access token for authorization: ultraCartOauth
203
+ config.access_token = 'YOUR ACCESS TOKEN'
204
+
205
+ # Configure API key authorization: ultraCartSimpleApiKey
206
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
207
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
208
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
209
+ end
210
+
211
+ api_instance = UltracartClient::TaxApi.new
212
+ county = 'county_example' # String | The county being deleted.
213
+ tax_county = UltracartClient::TaxCounty.new # TaxCounty | tax county to be deleted
214
+
215
+ begin
216
+ # Deletes a Self tax provider county
217
+ api_instance.delete_tax_provider_self_county(county, tax_county)
218
+ rescue UltracartClient::ApiError => e
219
+ puts "Error when calling TaxApi->delete_tax_provider_self_county: #{e}"
220
+ end
221
+ ```
222
+
223
+ #### Using the delete_tax_provider_self_county_with_http_info variant
224
+
225
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
226
+
227
+ > <Array(nil, Integer, Hash)> delete_tax_provider_self_county_with_http_info(county, tax_county)
228
+
229
+ ```ruby
230
+ begin
231
+ # Deletes a Self tax provider county
232
+ data, status_code, headers = api_instance.delete_tax_provider_self_county_with_http_info(county, tax_county)
233
+ p status_code # => 2xx
234
+ p headers # => { ... }
235
+ p data # => nil
236
+ rescue UltracartClient::ApiError => e
237
+ puts "Error when calling TaxApi->delete_tax_provider_self_county_with_http_info: #{e}"
238
+ end
239
+ ```
240
+
241
+ ### Parameters
242
+
243
+ | Name | Type | Description | Notes |
244
+ | ---- | ---- | ----------- | ----- |
245
+ | **county** | **String** | The county being deleted. | |
246
+ | **tax_county** | [**TaxCounty**](TaxCounty.md) | tax county to be deleted | |
247
+
248
+ ### Return type
249
+
250
+ nil (empty response body)
251
+
252
+ ### Authorization
253
+
254
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
255
+
256
+ ### HTTP request headers
257
+
258
+ - **Content-Type**: application/json
259
+ - **Accept**: application/json
260
+
261
+
262
+ ## delete_tax_provider_self_postal_code
263
+
264
+ > delete_tax_provider_self_postal_code(postal_code, tax_postal_code)
265
+
266
+ Deletes a Self tax provider postalCode
267
+
268
+ Deletes a Self tax provider postalCode.
269
+
270
+ ### Examples
271
+
272
+ ```ruby
273
+ require 'time'
274
+ require 'ultracart_api'
275
+ # setup authorization
276
+ UltracartClient.configure do |config|
277
+ # Configure OAuth2 access token for authorization: ultraCartOauth
278
+ config.access_token = 'YOUR ACCESS TOKEN'
279
+
280
+ # Configure API key authorization: ultraCartSimpleApiKey
281
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
282
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
283
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
284
+ end
285
+
286
+ api_instance = UltracartClient::TaxApi.new
287
+ postal_code = 'postal_code_example' # String | The postal code being deleted.
288
+ tax_postal_code = UltracartClient::TaxPostalCode.new # TaxPostalCode | tax postal code to be deleted
289
+
290
+ begin
291
+ # Deletes a Self tax provider postalCode
292
+ api_instance.delete_tax_provider_self_postal_code(postal_code, tax_postal_code)
293
+ rescue UltracartClient::ApiError => e
294
+ puts "Error when calling TaxApi->delete_tax_provider_self_postal_code: #{e}"
295
+ end
296
+ ```
297
+
298
+ #### Using the delete_tax_provider_self_postal_code_with_http_info variant
299
+
300
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
301
+
302
+ > <Array(nil, Integer, Hash)> delete_tax_provider_self_postal_code_with_http_info(postal_code, tax_postal_code)
303
+
304
+ ```ruby
305
+ begin
306
+ # Deletes a Self tax provider postalCode
307
+ data, status_code, headers = api_instance.delete_tax_provider_self_postal_code_with_http_info(postal_code, tax_postal_code)
308
+ p status_code # => 2xx
309
+ p headers # => { ... }
310
+ p data # => nil
311
+ rescue UltracartClient::ApiError => e
312
+ puts "Error when calling TaxApi->delete_tax_provider_self_postal_code_with_http_info: #{e}"
313
+ end
314
+ ```
315
+
316
+ ### Parameters
317
+
318
+ | Name | Type | Description | Notes |
319
+ | ---- | ---- | ----------- | ----- |
320
+ | **postal_code** | **String** | The postal code being deleted. | |
321
+ | **tax_postal_code** | [**TaxPostalCode**](TaxPostalCode.md) | tax postal code to be deleted | |
322
+
323
+ ### Return type
324
+
325
+ nil (empty response body)
326
+
327
+ ### Authorization
328
+
329
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
330
+
331
+ ### HTTP request headers
332
+
333
+ - **Content-Type**: application/json
334
+ - **Accept**: application/json
335
+
336
+
337
+ ## delete_tax_provider_self_state
338
+
339
+ > delete_tax_provider_self_state(state_code, tax_state)
340
+
341
+ Deletes a Self tax provider state
342
+
343
+ Deletes a Self tax provider state.
344
+
345
+ ### Examples
346
+
347
+ ```ruby
348
+ require 'time'
349
+ require 'ultracart_api'
350
+ # setup authorization
351
+ UltracartClient.configure do |config|
352
+ # Configure OAuth2 access token for authorization: ultraCartOauth
353
+ config.access_token = 'YOUR ACCESS TOKEN'
354
+
355
+ # Configure API key authorization: ultraCartSimpleApiKey
356
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
357
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
358
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
359
+ end
360
+
361
+ api_instance = UltracartClient::TaxApi.new
362
+ state_code = 'state_code_example' # String | The state code being deleted.
363
+ tax_state = UltracartClient::TaxState.new # TaxState | tax state to be deleted
364
+
365
+ begin
366
+ # Deletes a Self tax provider state
367
+ api_instance.delete_tax_provider_self_state(state_code, tax_state)
368
+ rescue UltracartClient::ApiError => e
369
+ puts "Error when calling TaxApi->delete_tax_provider_self_state: #{e}"
370
+ end
371
+ ```
372
+
373
+ #### Using the delete_tax_provider_self_state_with_http_info variant
374
+
375
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
376
+
377
+ > <Array(nil, Integer, Hash)> delete_tax_provider_self_state_with_http_info(state_code, tax_state)
378
+
379
+ ```ruby
380
+ begin
381
+ # Deletes a Self tax provider state
382
+ data, status_code, headers = api_instance.delete_tax_provider_self_state_with_http_info(state_code, tax_state)
383
+ p status_code # => 2xx
384
+ p headers # => { ... }
385
+ p data # => nil
386
+ rescue UltracartClient::ApiError => e
387
+ puts "Error when calling TaxApi->delete_tax_provider_self_state_with_http_info: #{e}"
388
+ end
389
+ ```
390
+
391
+ ### Parameters
392
+
393
+ | Name | Type | Description | Notes |
394
+ | ---- | ---- | ----------- | ----- |
395
+ | **state_code** | **String** | The state code being deleted. | |
396
+ | **tax_state** | [**TaxState**](TaxState.md) | tax state to be deleted | |
397
+
398
+ ### Return type
399
+
400
+ nil (empty response body)
401
+
402
+ ### Authorization
403
+
404
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
405
+
406
+ ### HTTP request headers
407
+
408
+ - **Content-Type**: application/json
409
+ - **Accept**: application/json
410
+
411
+
412
+ ## get_tax_provider_avalara
413
+
414
+ > <TaxProviderAvalara> get_tax_provider_avalara
415
+
416
+ Retrieve the Avalara tax provider
417
+
418
+ Retrieves the Avalara tax provider.
419
+
420
+ ### Examples
421
+
422
+ ```ruby
423
+ require 'time'
424
+ require 'ultracart_api'
425
+ # setup authorization
426
+ UltracartClient.configure do |config|
427
+ # Configure OAuth2 access token for authorization: ultraCartOauth
428
+ config.access_token = 'YOUR ACCESS TOKEN'
429
+
430
+ # Configure API key authorization: ultraCartSimpleApiKey
431
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
432
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
433
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
434
+ end
435
+
436
+ api_instance = UltracartClient::TaxApi.new
437
+
438
+ begin
439
+ # Retrieve the Avalara tax provider
440
+ result = api_instance.get_tax_provider_avalara
441
+ p result
442
+ rescue UltracartClient::ApiError => e
443
+ puts "Error when calling TaxApi->get_tax_provider_avalara: #{e}"
444
+ end
445
+ ```
446
+
447
+ #### Using the get_tax_provider_avalara_with_http_info variant
448
+
449
+ This returns an Array which contains the response data, status code and headers.
450
+
451
+ > <Array(<TaxProviderAvalara>, Integer, Hash)> get_tax_provider_avalara_with_http_info
452
+
453
+ ```ruby
454
+ begin
455
+ # Retrieve the Avalara tax provider
456
+ data, status_code, headers = api_instance.get_tax_provider_avalara_with_http_info
457
+ p status_code # => 2xx
458
+ p headers # => { ... }
459
+ p data # => <TaxProviderAvalara>
460
+ rescue UltracartClient::ApiError => e
461
+ puts "Error when calling TaxApi->get_tax_provider_avalara_with_http_info: #{e}"
462
+ end
463
+ ```
464
+
465
+ ### Parameters
466
+
467
+ This endpoint does not need any parameter.
468
+
469
+ ### Return type
470
+
471
+ [**TaxProviderAvalara**](TaxProviderAvalara.md)
472
+
473
+ ### Authorization
474
+
475
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
476
+
477
+ ### HTTP request headers
478
+
479
+ - **Content-Type**: Not defined
480
+ - **Accept**: application/json
481
+
482
+
483
+ ## get_tax_provider_avalara_companies
484
+
485
+ > <TaxProviderAvalaraCompaniesResult> get_tax_provider_avalara_companies(tax_provider_avalara)
486
+
487
+ Returns Avalara Tax companies configured by the merchant
488
+
489
+ Returns Avalara Tax companies configured by the merchant
490
+
491
+ ### Examples
492
+
493
+ ```ruby
494
+ require 'time'
495
+ require 'ultracart_api'
496
+ # setup authorization
497
+ UltracartClient.configure do |config|
498
+ # Configure OAuth2 access token for authorization: ultraCartOauth
499
+ config.access_token = 'YOUR ACCESS TOKEN'
500
+
501
+ # Configure API key authorization: ultraCartSimpleApiKey
502
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
503
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
504
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
505
+ end
506
+
507
+ api_instance = UltracartClient::TaxApi.new
508
+ tax_provider_avalara = UltracartClient::TaxProviderAvalara.new # TaxProviderAvalara | TaxProviderAvalara object
509
+
510
+ begin
511
+ # Returns Avalara Tax companies configured by the merchant
512
+ result = api_instance.get_tax_provider_avalara_companies(tax_provider_avalara)
513
+ p result
514
+ rescue UltracartClient::ApiError => e
515
+ puts "Error when calling TaxApi->get_tax_provider_avalara_companies: #{e}"
516
+ end
517
+ ```
518
+
519
+ #### Using the get_tax_provider_avalara_companies_with_http_info variant
520
+
521
+ This returns an Array which contains the response data, status code and headers.
522
+
523
+ > <Array(<TaxProviderAvalaraCompaniesResult>, Integer, Hash)> get_tax_provider_avalara_companies_with_http_info(tax_provider_avalara)
524
+
525
+ ```ruby
526
+ begin
527
+ # Returns Avalara Tax companies configured by the merchant
528
+ data, status_code, headers = api_instance.get_tax_provider_avalara_companies_with_http_info(tax_provider_avalara)
529
+ p status_code # => 2xx
530
+ p headers # => { ... }
531
+ p data # => <TaxProviderAvalaraCompaniesResult>
532
+ rescue UltracartClient::ApiError => e
533
+ puts "Error when calling TaxApi->get_tax_provider_avalara_companies_with_http_info: #{e}"
534
+ end
535
+ ```
536
+
537
+ ### Parameters
538
+
539
+ | Name | Type | Description | Notes |
540
+ | ---- | ---- | ----------- | ----- |
541
+ | **tax_provider_avalara** | [**TaxProviderAvalara**](TaxProviderAvalara.md) | TaxProviderAvalara object | |
542
+
543
+ ### Return type
544
+
545
+ [**TaxProviderAvalaraCompaniesResult**](TaxProviderAvalaraCompaniesResult.md)
546
+
547
+ ### Authorization
548
+
549
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
550
+
551
+ ### HTTP request headers
552
+
553
+ - **Content-Type**: application/json
554
+ - **Accept**: application/json
555
+
556
+
557
+ ## get_tax_provider_avalara_test
558
+
559
+ > <TaxProviderTestResult> get_tax_provider_avalara_test
560
+
561
+ Attempts to connect to Avalara and returns back the response
562
+
563
+ Attempts to connect to Avalara and returns back the response.
564
+
565
+ ### Examples
566
+
567
+ ```ruby
568
+ require 'time'
569
+ require 'ultracart_api'
570
+ # setup authorization
571
+ UltracartClient.configure do |config|
572
+ # Configure OAuth2 access token for authorization: ultraCartOauth
573
+ config.access_token = 'YOUR ACCESS TOKEN'
574
+
575
+ # Configure API key authorization: ultraCartSimpleApiKey
576
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
577
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
578
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
579
+ end
580
+
581
+ api_instance = UltracartClient::TaxApi.new
582
+
583
+ begin
584
+ # Attempts to connect to Avalara and returns back the response
585
+ result = api_instance.get_tax_provider_avalara_test
586
+ p result
587
+ rescue UltracartClient::ApiError => e
588
+ puts "Error when calling TaxApi->get_tax_provider_avalara_test: #{e}"
589
+ end
590
+ ```
591
+
592
+ #### Using the get_tax_provider_avalara_test_with_http_info variant
593
+
594
+ This returns an Array which contains the response data, status code and headers.
595
+
596
+ > <Array(<TaxProviderTestResult>, Integer, Hash)> get_tax_provider_avalara_test_with_http_info
597
+
598
+ ```ruby
599
+ begin
600
+ # Attempts to connect to Avalara and returns back the response
601
+ data, status_code, headers = api_instance.get_tax_provider_avalara_test_with_http_info
602
+ p status_code # => 2xx
603
+ p headers # => { ... }
604
+ p data # => <TaxProviderTestResult>
605
+ rescue UltracartClient::ApiError => e
606
+ puts "Error when calling TaxApi->get_tax_provider_avalara_test_with_http_info: #{e}"
607
+ end
608
+ ```
609
+
610
+ ### Parameters
611
+
612
+ This endpoint does not need any parameter.
613
+
614
+ ### Return type
615
+
616
+ [**TaxProviderTestResult**](TaxProviderTestResult.md)
617
+
618
+ ### Authorization
619
+
620
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
621
+
622
+ ### HTTP request headers
623
+
624
+ - **Content-Type**: Not defined
625
+ - **Accept**: application/json
626
+
627
+
628
+ ## get_tax_provider_self
629
+
630
+ > <TaxProviderSelf> get_tax_provider_self
631
+
632
+ Retrieve the Self tax provider
633
+
634
+ Retrieves the Self tax provider.
635
+
636
+ ### Examples
637
+
638
+ ```ruby
639
+ require 'time'
640
+ require 'ultracart_api'
641
+ # setup authorization
642
+ UltracartClient.configure do |config|
643
+ # Configure OAuth2 access token for authorization: ultraCartOauth
644
+ config.access_token = 'YOUR ACCESS TOKEN'
645
+
646
+ # Configure API key authorization: ultraCartSimpleApiKey
647
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
648
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
649
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
650
+ end
651
+
652
+ api_instance = UltracartClient::TaxApi.new
653
+
654
+ begin
655
+ # Retrieve the Self tax provider
656
+ result = api_instance.get_tax_provider_self
657
+ p result
658
+ rescue UltracartClient::ApiError => e
659
+ puts "Error when calling TaxApi->get_tax_provider_self: #{e}"
660
+ end
661
+ ```
662
+
663
+ #### Using the get_tax_provider_self_with_http_info variant
664
+
665
+ This returns an Array which contains the response data, status code and headers.
666
+
667
+ > <Array(<TaxProviderSelf>, Integer, Hash)> get_tax_provider_self_with_http_info
668
+
669
+ ```ruby
670
+ begin
671
+ # Retrieve the Self tax provider
672
+ data, status_code, headers = api_instance.get_tax_provider_self_with_http_info
673
+ p status_code # => 2xx
674
+ p headers # => { ... }
675
+ p data # => <TaxProviderSelf>
676
+ rescue UltracartClient::ApiError => e
677
+ puts "Error when calling TaxApi->get_tax_provider_self_with_http_info: #{e}"
678
+ end
679
+ ```
680
+
681
+ ### Parameters
682
+
683
+ This endpoint does not need any parameter.
684
+
685
+ ### Return type
686
+
687
+ [**TaxProviderSelf**](TaxProviderSelf.md)
688
+
689
+ ### Authorization
690
+
691
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
692
+
693
+ ### HTTP request headers
694
+
695
+ - **Content-Type**: Not defined
696
+ - **Accept**: application/json
697
+
698
+
699
+ ## get_tax_provider_self_countries
700
+
701
+ > <TaxProviderSelfCountriesResponse> get_tax_provider_self_countries
702
+
703
+ Retrieve the Self tax provider countries
704
+
705
+ Retrieves the Self tax provider countries.
706
+
707
+ ### Examples
708
+
709
+ ```ruby
710
+ require 'time'
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['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
721
+ end
722
+
723
+ api_instance = UltracartClient::TaxApi.new
724
+
725
+ begin
726
+ # Retrieve the Self tax provider countries
727
+ result = api_instance.get_tax_provider_self_countries
728
+ p result
729
+ rescue UltracartClient::ApiError => e
730
+ puts "Error when calling TaxApi->get_tax_provider_self_countries: #{e}"
731
+ end
732
+ ```
733
+
734
+ #### Using the get_tax_provider_self_countries_with_http_info variant
735
+
736
+ This returns an Array which contains the response data, status code and headers.
737
+
738
+ > <Array(<TaxProviderSelfCountriesResponse>, Integer, Hash)> get_tax_provider_self_countries_with_http_info
739
+
740
+ ```ruby
741
+ begin
742
+ # Retrieve the Self tax provider countries
743
+ data, status_code, headers = api_instance.get_tax_provider_self_countries_with_http_info
744
+ p status_code # => 2xx
745
+ p headers # => { ... }
746
+ p data # => <TaxProviderSelfCountriesResponse>
747
+ rescue UltracartClient::ApiError => e
748
+ puts "Error when calling TaxApi->get_tax_provider_self_countries_with_http_info: #{e}"
749
+ end
750
+ ```
751
+
752
+ ### Parameters
753
+
754
+ This endpoint does not need any parameter.
755
+
756
+ ### Return type
757
+
758
+ [**TaxProviderSelfCountriesResponse**](TaxProviderSelfCountriesResponse.md)
759
+
760
+ ### Authorization
761
+
762
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
763
+
764
+ ### HTTP request headers
765
+
766
+ - **Content-Type**: Not defined
767
+ - **Accept**: application/json
768
+
769
+
770
+ ## get_tax_provider_self_regions_by_country_code
771
+
772
+ > <TaxProviderSelfRegionsResponse> get_tax_provider_self_regions_by_country_code(country_code)
773
+
774
+ Retrieve the Self tax provider regions for a given country code
775
+
776
+ Retrieves the Self tax provider regions for a given country code.
777
+
778
+ ### Examples
779
+
780
+ ```ruby
781
+ require 'time'
782
+ require 'ultracart_api'
783
+ # setup authorization
784
+ UltracartClient.configure do |config|
785
+ # Configure OAuth2 access token for authorization: ultraCartOauth
786
+ config.access_token = 'YOUR ACCESS TOKEN'
787
+
788
+ # Configure API key authorization: ultraCartSimpleApiKey
789
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
790
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
791
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
792
+ end
793
+
794
+ api_instance = UltracartClient::TaxApi.new
795
+ country_code = 'country_code_example' # String | The country code regions desired.
796
+
797
+ begin
798
+ # Retrieve the Self tax provider regions for a given country code
799
+ result = api_instance.get_tax_provider_self_regions_by_country_code(country_code)
800
+ p result
801
+ rescue UltracartClient::ApiError => e
802
+ puts "Error when calling TaxApi->get_tax_provider_self_regions_by_country_code: #{e}"
803
+ end
804
+ ```
805
+
806
+ #### Using the get_tax_provider_self_regions_by_country_code_with_http_info variant
807
+
808
+ This returns an Array which contains the response data, status code and headers.
809
+
810
+ > <Array(<TaxProviderSelfRegionsResponse>, Integer, Hash)> get_tax_provider_self_regions_by_country_code_with_http_info(country_code)
811
+
812
+ ```ruby
813
+ begin
814
+ # Retrieve the Self tax provider regions for a given country code
815
+ data, status_code, headers = api_instance.get_tax_provider_self_regions_by_country_code_with_http_info(country_code)
816
+ p status_code # => 2xx
817
+ p headers # => { ... }
818
+ p data # => <TaxProviderSelfRegionsResponse>
819
+ rescue UltracartClient::ApiError => e
820
+ puts "Error when calling TaxApi->get_tax_provider_self_regions_by_country_code_with_http_info: #{e}"
821
+ end
822
+ ```
823
+
824
+ ### Parameters
825
+
826
+ | Name | Type | Description | Notes |
827
+ | ---- | ---- | ----------- | ----- |
828
+ | **country_code** | **String** | The country code regions desired. | |
829
+
830
+ ### Return type
831
+
832
+ [**TaxProviderSelfRegionsResponse**](TaxProviderSelfRegionsResponse.md)
833
+
834
+ ### Authorization
835
+
836
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
837
+
838
+ ### HTTP request headers
839
+
840
+ - **Content-Type**: Not defined
841
+ - **Accept**: application/json
842
+
843
+
844
+ ## get_tax_provider_sovos
845
+
846
+ > <TaxProviderSovos> get_tax_provider_sovos
847
+
848
+ Retrieve the Sovos tax provider
849
+
850
+ Retrieves the Sovos tax provider.
851
+
852
+ ### Examples
853
+
854
+ ```ruby
855
+ require 'time'
856
+ require 'ultracart_api'
857
+ # setup authorization
858
+ UltracartClient.configure do |config|
859
+ # Configure OAuth2 access token for authorization: ultraCartOauth
860
+ config.access_token = 'YOUR ACCESS TOKEN'
861
+
862
+ # Configure API key authorization: ultraCartSimpleApiKey
863
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
864
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
865
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
866
+ end
867
+
868
+ api_instance = UltracartClient::TaxApi.new
869
+
870
+ begin
871
+ # Retrieve the Sovos tax provider
872
+ result = api_instance.get_tax_provider_sovos
873
+ p result
874
+ rescue UltracartClient::ApiError => e
875
+ puts "Error when calling TaxApi->get_tax_provider_sovos: #{e}"
876
+ end
877
+ ```
878
+
879
+ #### Using the get_tax_provider_sovos_with_http_info variant
880
+
881
+ This returns an Array which contains the response data, status code and headers.
882
+
883
+ > <Array(<TaxProviderSovos>, Integer, Hash)> get_tax_provider_sovos_with_http_info
884
+
885
+ ```ruby
886
+ begin
887
+ # Retrieve the Sovos tax provider
888
+ data, status_code, headers = api_instance.get_tax_provider_sovos_with_http_info
889
+ p status_code # => 2xx
890
+ p headers # => { ... }
891
+ p data # => <TaxProviderSovos>
892
+ rescue UltracartClient::ApiError => e
893
+ puts "Error when calling TaxApi->get_tax_provider_sovos_with_http_info: #{e}"
894
+ end
895
+ ```
896
+
897
+ ### Parameters
898
+
899
+ This endpoint does not need any parameter.
900
+
901
+ ### Return type
902
+
903
+ [**TaxProviderSovos**](TaxProviderSovos.md)
904
+
905
+ ### Authorization
906
+
907
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
908
+
909
+ ### HTTP request headers
910
+
911
+ - **Content-Type**: Not defined
912
+ - **Accept**: application/json
913
+
914
+
915
+ ## get_tax_provider_sovos_test
916
+
917
+ > <TaxProviderTestResult> get_tax_provider_sovos_test
918
+
919
+ Attempts to connect to Sovos and returns back the response
920
+
921
+ Attempts to connect to Sovos and returns back the response.
922
+
923
+ ### Examples
924
+
925
+ ```ruby
926
+ require 'time'
927
+ require 'ultracart_api'
928
+ # setup authorization
929
+ UltracartClient.configure do |config|
930
+ # Configure OAuth2 access token for authorization: ultraCartOauth
931
+ config.access_token = 'YOUR ACCESS TOKEN'
932
+
933
+ # Configure API key authorization: ultraCartSimpleApiKey
934
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
935
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
936
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
937
+ end
938
+
939
+ api_instance = UltracartClient::TaxApi.new
940
+
941
+ begin
942
+ # Attempts to connect to Sovos and returns back the response
943
+ result = api_instance.get_tax_provider_sovos_test
944
+ p result
945
+ rescue UltracartClient::ApiError => e
946
+ puts "Error when calling TaxApi->get_tax_provider_sovos_test: #{e}"
947
+ end
948
+ ```
949
+
950
+ #### Using the get_tax_provider_sovos_test_with_http_info variant
951
+
952
+ This returns an Array which contains the response data, status code and headers.
953
+
954
+ > <Array(<TaxProviderTestResult>, Integer, Hash)> get_tax_provider_sovos_test_with_http_info
955
+
956
+ ```ruby
957
+ begin
958
+ # Attempts to connect to Sovos and returns back the response
959
+ data, status_code, headers = api_instance.get_tax_provider_sovos_test_with_http_info
960
+ p status_code # => 2xx
961
+ p headers # => { ... }
962
+ p data # => <TaxProviderTestResult>
963
+ rescue UltracartClient::ApiError => e
964
+ puts "Error when calling TaxApi->get_tax_provider_sovos_test_with_http_info: #{e}"
965
+ end
966
+ ```
967
+
968
+ ### Parameters
969
+
970
+ This endpoint does not need any parameter.
971
+
972
+ ### Return type
973
+
974
+ [**TaxProviderTestResult**](TaxProviderTestResult.md)
975
+
976
+ ### Authorization
977
+
978
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
979
+
980
+ ### HTTP request headers
981
+
982
+ - **Content-Type**: Not defined
983
+ - **Accept**: application/json
984
+
985
+
986
+ ## get_tax_provider_tax_jar
987
+
988
+ > <TaxProviderTaxJar> get_tax_provider_tax_jar
989
+
990
+ Retrieve the TaxJar tax provider
991
+
992
+ Retrieves the TaxJar tax provider.
993
+
994
+ ### Examples
995
+
996
+ ```ruby
997
+ require 'time'
998
+ require 'ultracart_api'
999
+ # setup authorization
1000
+ UltracartClient.configure do |config|
1001
+ # Configure OAuth2 access token for authorization: ultraCartOauth
1002
+ config.access_token = 'YOUR ACCESS TOKEN'
1003
+
1004
+ # Configure API key authorization: ultraCartSimpleApiKey
1005
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1006
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1007
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1008
+ end
1009
+
1010
+ api_instance = UltracartClient::TaxApi.new
1011
+
1012
+ begin
1013
+ # Retrieve the TaxJar tax provider
1014
+ result = api_instance.get_tax_provider_tax_jar
1015
+ p result
1016
+ rescue UltracartClient::ApiError => e
1017
+ puts "Error when calling TaxApi->get_tax_provider_tax_jar: #{e}"
1018
+ end
1019
+ ```
1020
+
1021
+ #### Using the get_tax_provider_tax_jar_with_http_info variant
1022
+
1023
+ This returns an Array which contains the response data, status code and headers.
1024
+
1025
+ > <Array(<TaxProviderTaxJar>, Integer, Hash)> get_tax_provider_tax_jar_with_http_info
1026
+
1027
+ ```ruby
1028
+ begin
1029
+ # Retrieve the TaxJar tax provider
1030
+ data, status_code, headers = api_instance.get_tax_provider_tax_jar_with_http_info
1031
+ p status_code # => 2xx
1032
+ p headers # => { ... }
1033
+ p data # => <TaxProviderTaxJar>
1034
+ rescue UltracartClient::ApiError => e
1035
+ puts "Error when calling TaxApi->get_tax_provider_tax_jar_with_http_info: #{e}"
1036
+ end
1037
+ ```
1038
+
1039
+ ### Parameters
1040
+
1041
+ This endpoint does not need any parameter.
1042
+
1043
+ ### Return type
1044
+
1045
+ [**TaxProviderTaxJar**](TaxProviderTaxJar.md)
1046
+
1047
+ ### Authorization
1048
+
1049
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1050
+
1051
+ ### HTTP request headers
1052
+
1053
+ - **Content-Type**: Not defined
1054
+ - **Accept**: application/json
1055
+
1056
+
1057
+ ## get_tax_provider_tax_jar_test
1058
+
1059
+ > <TaxProviderTestResult> get_tax_provider_tax_jar_test
1060
+
1061
+ Attempts to connect to TaxJar and returns back the response
1062
+
1063
+ Attempts to connect to TaxJar and returns back the response.
1064
+
1065
+ ### Examples
1066
+
1067
+ ```ruby
1068
+ require 'time'
1069
+ require 'ultracart_api'
1070
+ # setup authorization
1071
+ UltracartClient.configure do |config|
1072
+ # Configure OAuth2 access token for authorization: ultraCartOauth
1073
+ config.access_token = 'YOUR ACCESS TOKEN'
1074
+
1075
+ # Configure API key authorization: ultraCartSimpleApiKey
1076
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1077
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1078
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1079
+ end
1080
+
1081
+ api_instance = UltracartClient::TaxApi.new
1082
+
1083
+ begin
1084
+ # Attempts to connect to TaxJar and returns back the response
1085
+ result = api_instance.get_tax_provider_tax_jar_test
1086
+ p result
1087
+ rescue UltracartClient::ApiError => e
1088
+ puts "Error when calling TaxApi->get_tax_provider_tax_jar_test: #{e}"
1089
+ end
1090
+ ```
1091
+
1092
+ #### Using the get_tax_provider_tax_jar_test_with_http_info variant
1093
+
1094
+ This returns an Array which contains the response data, status code and headers.
1095
+
1096
+ > <Array(<TaxProviderTestResult>, Integer, Hash)> get_tax_provider_tax_jar_test_with_http_info
1097
+
1098
+ ```ruby
1099
+ begin
1100
+ # Attempts to connect to TaxJar and returns back the response
1101
+ data, status_code, headers = api_instance.get_tax_provider_tax_jar_test_with_http_info
1102
+ p status_code # => 2xx
1103
+ p headers # => { ... }
1104
+ p data # => <TaxProviderTestResult>
1105
+ rescue UltracartClient::ApiError => e
1106
+ puts "Error when calling TaxApi->get_tax_provider_tax_jar_test_with_http_info: #{e}"
1107
+ end
1108
+ ```
1109
+
1110
+ ### Parameters
1111
+
1112
+ This endpoint does not need any parameter.
1113
+
1114
+ ### Return type
1115
+
1116
+ [**TaxProviderTestResult**](TaxProviderTestResult.md)
1117
+
1118
+ ### Authorization
1119
+
1120
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1121
+
1122
+ ### HTTP request headers
1123
+
1124
+ - **Content-Type**: Not defined
1125
+ - **Accept**: application/json
1126
+
1127
+
1128
+ ## get_tax_provider_ultra_cart
1129
+
1130
+ > <TaxProviderUltraCart> get_tax_provider_ultra_cart
1131
+
1132
+ Retrieve the UltraCart tax provider
1133
+
1134
+ Retrieves the UltraCart tax provider.
1135
+
1136
+ ### Examples
1137
+
1138
+ ```ruby
1139
+ require 'time'
1140
+ require 'ultracart_api'
1141
+ # setup authorization
1142
+ UltracartClient.configure do |config|
1143
+ # Configure OAuth2 access token for authorization: ultraCartOauth
1144
+ config.access_token = 'YOUR ACCESS TOKEN'
1145
+
1146
+ # Configure API key authorization: ultraCartSimpleApiKey
1147
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1148
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1149
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1150
+ end
1151
+
1152
+ api_instance = UltracartClient::TaxApi.new
1153
+
1154
+ begin
1155
+ # Retrieve the UltraCart tax provider
1156
+ result = api_instance.get_tax_provider_ultra_cart
1157
+ p result
1158
+ rescue UltracartClient::ApiError => e
1159
+ puts "Error when calling TaxApi->get_tax_provider_ultra_cart: #{e}"
1160
+ end
1161
+ ```
1162
+
1163
+ #### Using the get_tax_provider_ultra_cart_with_http_info variant
1164
+
1165
+ This returns an Array which contains the response data, status code and headers.
1166
+
1167
+ > <Array(<TaxProviderUltraCart>, Integer, Hash)> get_tax_provider_ultra_cart_with_http_info
1168
+
1169
+ ```ruby
1170
+ begin
1171
+ # Retrieve the UltraCart tax provider
1172
+ data, status_code, headers = api_instance.get_tax_provider_ultra_cart_with_http_info
1173
+ p status_code # => 2xx
1174
+ p headers # => { ... }
1175
+ p data # => <TaxProviderUltraCart>
1176
+ rescue UltracartClient::ApiError => e
1177
+ puts "Error when calling TaxApi->get_tax_provider_ultra_cart_with_http_info: #{e}"
1178
+ end
1179
+ ```
1180
+
1181
+ ### Parameters
1182
+
1183
+ This endpoint does not need any parameter.
1184
+
1185
+ ### Return type
1186
+
1187
+ [**TaxProviderUltraCart**](TaxProviderUltraCart.md)
1188
+
1189
+ ### Authorization
1190
+
1191
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1192
+
1193
+ ### HTTP request headers
1194
+
1195
+ - **Content-Type**: Not defined
1196
+ - **Accept**: application/json
1197
+
1198
+
1199
+ ## get_tax_providers
1200
+
1201
+ > <TaxProvidersResponse> get_tax_providers(opts)
1202
+
1203
+ Retrieve tax methods
1204
+
1205
+ Retrieves tax methods for this account.
1206
+
1207
+ ### Examples
1208
+
1209
+ ```ruby
1210
+ require 'time'
1211
+ require 'ultracart_api'
1212
+ # setup authorization
1213
+ UltracartClient.configure do |config|
1214
+ # Configure OAuth2 access token for authorization: ultraCartOauth
1215
+ config.access_token = 'YOUR ACCESS TOKEN'
1216
+
1217
+ # Configure API key authorization: ultraCartSimpleApiKey
1218
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1219
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1220
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1221
+ end
1222
+
1223
+ api_instance = UltracartClient::TaxApi.new
1224
+ opts = {
1225
+ _limit: 56, # Integer | The maximum number of records to return on this one API call. (Max 200)
1226
+ _offset: 56, # Integer | Pagination of the record set. Offset is a zero based index.
1227
+ _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
1228
+ }
1229
+
1230
+ begin
1231
+ # Retrieve tax methods
1232
+ result = api_instance.get_tax_providers(opts)
1233
+ p result
1234
+ rescue UltracartClient::ApiError => e
1235
+ puts "Error when calling TaxApi->get_tax_providers: #{e}"
1236
+ end
1237
+ ```
1238
+
1239
+ #### Using the get_tax_providers_with_http_info variant
1240
+
1241
+ This returns an Array which contains the response data, status code and headers.
1242
+
1243
+ > <Array(<TaxProvidersResponse>, Integer, Hash)> get_tax_providers_with_http_info(opts)
1244
+
1245
+ ```ruby
1246
+ begin
1247
+ # Retrieve tax methods
1248
+ data, status_code, headers = api_instance.get_tax_providers_with_http_info(opts)
1249
+ p status_code # => 2xx
1250
+ p headers # => { ... }
1251
+ p data # => <TaxProvidersResponse>
1252
+ rescue UltracartClient::ApiError => e
1253
+ puts "Error when calling TaxApi->get_tax_providers_with_http_info: #{e}"
1254
+ end
1255
+ ```
1256
+
1257
+ ### Parameters
1258
+
1259
+ | Name | Type | Description | Notes |
1260
+ | ---- | ---- | ----------- | ----- |
1261
+ | **_limit** | **Integer** | The maximum number of records to return on this one API call. (Max 200) | [optional][default to 100] |
1262
+ | **_offset** | **Integer** | Pagination of the record set. Offset is a zero based index. | [optional][default to 0] |
1263
+ | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
1264
+
1265
+ ### Return type
1266
+
1267
+ [**TaxProvidersResponse**](TaxProvidersResponse.md)
1268
+
1269
+ ### Authorization
1270
+
1271
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1272
+
1273
+ ### HTTP request headers
1274
+
1275
+ - **Content-Type**: Not defined
1276
+ - **Accept**: application/json
1277
+
1278
+
1279
+ ## set_active_tax_provider
1280
+
1281
+ > <TaxProviderActivateResult> set_active_tax_provider(provider_name)
1282
+
1283
+ Toggle a tax provider to active
1284
+
1285
+ Toggle a tax provider to active.
1286
+
1287
+ ### Examples
1288
+
1289
+ ```ruby
1290
+ require 'time'
1291
+ require 'ultracart_api'
1292
+ # setup authorization
1293
+ UltracartClient.configure do |config|
1294
+ # Configure OAuth2 access token for authorization: ultraCartOauth
1295
+ config.access_token = 'YOUR ACCESS TOKEN'
1296
+
1297
+ # Configure API key authorization: ultraCartSimpleApiKey
1298
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1299
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1300
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1301
+ end
1302
+
1303
+ api_instance = UltracartClient::TaxApi.new
1304
+ provider_name = 'provider_name_example' # String | The tax provider to set active.
1305
+
1306
+ begin
1307
+ # Toggle a tax provider to active
1308
+ result = api_instance.set_active_tax_provider(provider_name)
1309
+ p result
1310
+ rescue UltracartClient::ApiError => e
1311
+ puts "Error when calling TaxApi->set_active_tax_provider: #{e}"
1312
+ end
1313
+ ```
1314
+
1315
+ #### Using the set_active_tax_provider_with_http_info variant
1316
+
1317
+ This returns an Array which contains the response data, status code and headers.
1318
+
1319
+ > <Array(<TaxProviderActivateResult>, Integer, Hash)> set_active_tax_provider_with_http_info(provider_name)
1320
+
1321
+ ```ruby
1322
+ begin
1323
+ # Toggle a tax provider to active
1324
+ data, status_code, headers = api_instance.set_active_tax_provider_with_http_info(provider_name)
1325
+ p status_code # => 2xx
1326
+ p headers # => { ... }
1327
+ p data # => <TaxProviderActivateResult>
1328
+ rescue UltracartClient::ApiError => e
1329
+ puts "Error when calling TaxApi->set_active_tax_provider_with_http_info: #{e}"
1330
+ end
1331
+ ```
1332
+
1333
+ ### Parameters
1334
+
1335
+ | Name | Type | Description | Notes |
1336
+ | ---- | ---- | ----------- | ----- |
1337
+ | **provider_name** | **String** | The tax provider to set active. | |
1338
+
1339
+ ### Return type
1340
+
1341
+ [**TaxProviderActivateResult**](TaxProviderActivateResult.md)
1342
+
1343
+ ### Authorization
1344
+
1345
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1346
+
1347
+ ### HTTP request headers
1348
+
1349
+ - **Content-Type**: Not defined
1350
+ - **Accept**: application/json
1351
+
1352
+
1353
+ ## update_tax_provider_avalara
1354
+
1355
+ > <TaxProviderAvalara> update_tax_provider_avalara(tax_provider_avalara)
1356
+
1357
+ Update the Avalara tax provider
1358
+
1359
+ Update the Avalara tax provider.
1360
+
1361
+ ### Examples
1362
+
1363
+ ```ruby
1364
+ require 'time'
1365
+ require 'ultracart_api'
1366
+ # setup authorization
1367
+ UltracartClient.configure do |config|
1368
+ # Configure OAuth2 access token for authorization: ultraCartOauth
1369
+ config.access_token = 'YOUR ACCESS TOKEN'
1370
+
1371
+ # Configure API key authorization: ultraCartSimpleApiKey
1372
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1373
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1374
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1375
+ end
1376
+
1377
+ api_instance = UltracartClient::TaxApi.new
1378
+ tax_provider_avalara = UltracartClient::TaxProviderAvalara.new # TaxProviderAvalara | TaxProviderAvalara object
1379
+
1380
+ begin
1381
+ # Update the Avalara tax provider
1382
+ result = api_instance.update_tax_provider_avalara(tax_provider_avalara)
1383
+ p result
1384
+ rescue UltracartClient::ApiError => e
1385
+ puts "Error when calling TaxApi->update_tax_provider_avalara: #{e}"
1386
+ end
1387
+ ```
1388
+
1389
+ #### Using the update_tax_provider_avalara_with_http_info variant
1390
+
1391
+ This returns an Array which contains the response data, status code and headers.
1392
+
1393
+ > <Array(<TaxProviderAvalara>, Integer, Hash)> update_tax_provider_avalara_with_http_info(tax_provider_avalara)
1394
+
1395
+ ```ruby
1396
+ begin
1397
+ # Update the Avalara tax provider
1398
+ data, status_code, headers = api_instance.update_tax_provider_avalara_with_http_info(tax_provider_avalara)
1399
+ p status_code # => 2xx
1400
+ p headers # => { ... }
1401
+ p data # => <TaxProviderAvalara>
1402
+ rescue UltracartClient::ApiError => e
1403
+ puts "Error when calling TaxApi->update_tax_provider_avalara_with_http_info: #{e}"
1404
+ end
1405
+ ```
1406
+
1407
+ ### Parameters
1408
+
1409
+ | Name | Type | Description | Notes |
1410
+ | ---- | ---- | ----------- | ----- |
1411
+ | **tax_provider_avalara** | [**TaxProviderAvalara**](TaxProviderAvalara.md) | TaxProviderAvalara object | |
1412
+
1413
+ ### Return type
1414
+
1415
+ [**TaxProviderAvalara**](TaxProviderAvalara.md)
1416
+
1417
+ ### Authorization
1418
+
1419
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1420
+
1421
+ ### HTTP request headers
1422
+
1423
+ - **Content-Type**: application/json
1424
+ - **Accept**: application/json
1425
+
1426
+
1427
+ ## update_tax_provider_self
1428
+
1429
+ > <TaxProviderSelf> update_tax_provider_self(tax_provider_self)
1430
+
1431
+ Update the Self tax provider
1432
+
1433
+ Update the Self tax provider.
1434
+
1435
+ ### Examples
1436
+
1437
+ ```ruby
1438
+ require 'time'
1439
+ require 'ultracart_api'
1440
+ # setup authorization
1441
+ UltracartClient.configure do |config|
1442
+ # Configure OAuth2 access token for authorization: ultraCartOauth
1443
+ config.access_token = 'YOUR ACCESS TOKEN'
1444
+
1445
+ # Configure API key authorization: ultraCartSimpleApiKey
1446
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1447
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1448
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1449
+ end
1450
+
1451
+ api_instance = UltracartClient::TaxApi.new
1452
+ tax_provider_self = UltracartClient::TaxProviderSelf.new # TaxProviderSelf | TaxProviderSelf object
1453
+
1454
+ begin
1455
+ # Update the Self tax provider
1456
+ result = api_instance.update_tax_provider_self(tax_provider_self)
1457
+ p result
1458
+ rescue UltracartClient::ApiError => e
1459
+ puts "Error when calling TaxApi->update_tax_provider_self: #{e}"
1460
+ end
1461
+ ```
1462
+
1463
+ #### Using the update_tax_provider_self_with_http_info variant
1464
+
1465
+ This returns an Array which contains the response data, status code and headers.
1466
+
1467
+ > <Array(<TaxProviderSelf>, Integer, Hash)> update_tax_provider_self_with_http_info(tax_provider_self)
1468
+
1469
+ ```ruby
1470
+ begin
1471
+ # Update the Self tax provider
1472
+ data, status_code, headers = api_instance.update_tax_provider_self_with_http_info(tax_provider_self)
1473
+ p status_code # => 2xx
1474
+ p headers # => { ... }
1475
+ p data # => <TaxProviderSelf>
1476
+ rescue UltracartClient::ApiError => e
1477
+ puts "Error when calling TaxApi->update_tax_provider_self_with_http_info: #{e}"
1478
+ end
1479
+ ```
1480
+
1481
+ ### Parameters
1482
+
1483
+ | Name | Type | Description | Notes |
1484
+ | ---- | ---- | ----------- | ----- |
1485
+ | **tax_provider_self** | [**TaxProviderSelf**](TaxProviderSelf.md) | TaxProviderSelf object | |
1486
+
1487
+ ### Return type
1488
+
1489
+ [**TaxProviderSelf**](TaxProviderSelf.md)
1490
+
1491
+ ### Authorization
1492
+
1493
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1494
+
1495
+ ### HTTP request headers
1496
+
1497
+ - **Content-Type**: application/json
1498
+ - **Accept**: application/json
1499
+
1500
+
1501
+ ## update_tax_provider_self_city
1502
+
1503
+ > <TaxCity> update_tax_provider_self_city(city, tax_city)
1504
+
1505
+ Updates a Self tax provider city
1506
+
1507
+ Updates a Self tax provider city.
1508
+
1509
+ ### Examples
1510
+
1511
+ ```ruby
1512
+ require 'time'
1513
+ require 'ultracart_api'
1514
+ # setup authorization
1515
+ UltracartClient.configure do |config|
1516
+ # Configure OAuth2 access token for authorization: ultraCartOauth
1517
+ config.access_token = 'YOUR ACCESS TOKEN'
1518
+
1519
+ # Configure API key authorization: ultraCartSimpleApiKey
1520
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1521
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1522
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1523
+ end
1524
+
1525
+ api_instance = UltracartClient::TaxApi.new
1526
+ city = 'city_example' # String | The city being updated.
1527
+ tax_city = UltracartClient::TaxCity.new # TaxCity | tax city to be updated
1528
+
1529
+ begin
1530
+ # Updates a Self tax provider city
1531
+ result = api_instance.update_tax_provider_self_city(city, tax_city)
1532
+ p result
1533
+ rescue UltracartClient::ApiError => e
1534
+ puts "Error when calling TaxApi->update_tax_provider_self_city: #{e}"
1535
+ end
1536
+ ```
1537
+
1538
+ #### Using the update_tax_provider_self_city_with_http_info variant
1539
+
1540
+ This returns an Array which contains the response data, status code and headers.
1541
+
1542
+ > <Array(<TaxCity>, Integer, Hash)> update_tax_provider_self_city_with_http_info(city, tax_city)
1543
+
1544
+ ```ruby
1545
+ begin
1546
+ # Updates a Self tax provider city
1547
+ data, status_code, headers = api_instance.update_tax_provider_self_city_with_http_info(city, tax_city)
1548
+ p status_code # => 2xx
1549
+ p headers # => { ... }
1550
+ p data # => <TaxCity>
1551
+ rescue UltracartClient::ApiError => e
1552
+ puts "Error when calling TaxApi->update_tax_provider_self_city_with_http_info: #{e}"
1553
+ end
1554
+ ```
1555
+
1556
+ ### Parameters
1557
+
1558
+ | Name | Type | Description | Notes |
1559
+ | ---- | ---- | ----------- | ----- |
1560
+ | **city** | **String** | The city being updated. | |
1561
+ | **tax_city** | [**TaxCity**](TaxCity.md) | tax city to be updated | |
1562
+
1563
+ ### Return type
1564
+
1565
+ [**TaxCity**](TaxCity.md)
1566
+
1567
+ ### Authorization
1568
+
1569
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1570
+
1571
+ ### HTTP request headers
1572
+
1573
+ - **Content-Type**: application/json
1574
+ - **Accept**: application/json
1575
+
1576
+
1577
+ ## update_tax_provider_self_country
1578
+
1579
+ > <TaxCountry> update_tax_provider_self_country(country_code, tax_country)
1580
+
1581
+ Updates a Self tax provider country
1582
+
1583
+ Updates a Self tax provider country.
1584
+
1585
+ ### Examples
1586
+
1587
+ ```ruby
1588
+ require 'time'
1589
+ require 'ultracart_api'
1590
+ # setup authorization
1591
+ UltracartClient.configure do |config|
1592
+ # Configure OAuth2 access token for authorization: ultraCartOauth
1593
+ config.access_token = 'YOUR ACCESS TOKEN'
1594
+
1595
+ # Configure API key authorization: ultraCartSimpleApiKey
1596
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1597
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1598
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1599
+ end
1600
+
1601
+ api_instance = UltracartClient::TaxApi.new
1602
+ country_code = 'country_code_example' # String | The country code being updated.
1603
+ tax_country = UltracartClient::TaxCountry.new # TaxCountry | tax country to be updated
1604
+
1605
+ begin
1606
+ # Updates a Self tax provider country
1607
+ result = api_instance.update_tax_provider_self_country(country_code, tax_country)
1608
+ p result
1609
+ rescue UltracartClient::ApiError => e
1610
+ puts "Error when calling TaxApi->update_tax_provider_self_country: #{e}"
1611
+ end
1612
+ ```
1613
+
1614
+ #### Using the update_tax_provider_self_country_with_http_info variant
1615
+
1616
+ This returns an Array which contains the response data, status code and headers.
1617
+
1618
+ > <Array(<TaxCountry>, Integer, Hash)> update_tax_provider_self_country_with_http_info(country_code, tax_country)
1619
+
1620
+ ```ruby
1621
+ begin
1622
+ # Updates a Self tax provider country
1623
+ data, status_code, headers = api_instance.update_tax_provider_self_country_with_http_info(country_code, tax_country)
1624
+ p status_code # => 2xx
1625
+ p headers # => { ... }
1626
+ p data # => <TaxCountry>
1627
+ rescue UltracartClient::ApiError => e
1628
+ puts "Error when calling TaxApi->update_tax_provider_self_country_with_http_info: #{e}"
1629
+ end
1630
+ ```
1631
+
1632
+ ### Parameters
1633
+
1634
+ | Name | Type | Description | Notes |
1635
+ | ---- | ---- | ----------- | ----- |
1636
+ | **country_code** | **String** | The country code being updated. | |
1637
+ | **tax_country** | [**TaxCountry**](TaxCountry.md) | tax country to be updated | |
1638
+
1639
+ ### Return type
1640
+
1641
+ [**TaxCountry**](TaxCountry.md)
1642
+
1643
+ ### Authorization
1644
+
1645
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1646
+
1647
+ ### HTTP request headers
1648
+
1649
+ - **Content-Type**: application/json
1650
+ - **Accept**: application/json
1651
+
1652
+
1653
+ ## update_tax_provider_self_county
1654
+
1655
+ > <TaxCounty> update_tax_provider_self_county(county, tax_county)
1656
+
1657
+ Updates a Self tax provider county
1658
+
1659
+ Updates a Self tax provider county.
1660
+
1661
+ ### Examples
1662
+
1663
+ ```ruby
1664
+ require 'time'
1665
+ require 'ultracart_api'
1666
+ # setup authorization
1667
+ UltracartClient.configure do |config|
1668
+ # Configure OAuth2 access token for authorization: ultraCartOauth
1669
+ config.access_token = 'YOUR ACCESS TOKEN'
1670
+
1671
+ # Configure API key authorization: ultraCartSimpleApiKey
1672
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1673
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1674
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1675
+ end
1676
+
1677
+ api_instance = UltracartClient::TaxApi.new
1678
+ county = 'county_example' # String | The county being updated.
1679
+ tax_county = UltracartClient::TaxCounty.new # TaxCounty | tax county to be updated
1680
+
1681
+ begin
1682
+ # Updates a Self tax provider county
1683
+ result = api_instance.update_tax_provider_self_county(county, tax_county)
1684
+ p result
1685
+ rescue UltracartClient::ApiError => e
1686
+ puts "Error when calling TaxApi->update_tax_provider_self_county: #{e}"
1687
+ end
1688
+ ```
1689
+
1690
+ #### Using the update_tax_provider_self_county_with_http_info variant
1691
+
1692
+ This returns an Array which contains the response data, status code and headers.
1693
+
1694
+ > <Array(<TaxCounty>, Integer, Hash)> update_tax_provider_self_county_with_http_info(county, tax_county)
1695
+
1696
+ ```ruby
1697
+ begin
1698
+ # Updates a Self tax provider county
1699
+ data, status_code, headers = api_instance.update_tax_provider_self_county_with_http_info(county, tax_county)
1700
+ p status_code # => 2xx
1701
+ p headers # => { ... }
1702
+ p data # => <TaxCounty>
1703
+ rescue UltracartClient::ApiError => e
1704
+ puts "Error when calling TaxApi->update_tax_provider_self_county_with_http_info: #{e}"
1705
+ end
1706
+ ```
1707
+
1708
+ ### Parameters
1709
+
1710
+ | Name | Type | Description | Notes |
1711
+ | ---- | ---- | ----------- | ----- |
1712
+ | **county** | **String** | The county being updated. | |
1713
+ | **tax_county** | [**TaxCounty**](TaxCounty.md) | tax county to be updated | |
1714
+
1715
+ ### Return type
1716
+
1717
+ [**TaxCounty**](TaxCounty.md)
1718
+
1719
+ ### Authorization
1720
+
1721
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1722
+
1723
+ ### HTTP request headers
1724
+
1725
+ - **Content-Type**: application/json
1726
+ - **Accept**: application/json
1727
+
1728
+
1729
+ ## update_tax_provider_self_postal_code
1730
+
1731
+ > <TaxPostalCode> update_tax_provider_self_postal_code(postal_code, tax_postal_code)
1732
+
1733
+ Updates a Self tax provider postalCode
1734
+
1735
+ Updates a Self tax provider postalCode.
1736
+
1737
+ ### Examples
1738
+
1739
+ ```ruby
1740
+ require 'time'
1741
+ require 'ultracart_api'
1742
+ # setup authorization
1743
+ UltracartClient.configure do |config|
1744
+ # Configure OAuth2 access token for authorization: ultraCartOauth
1745
+ config.access_token = 'YOUR ACCESS TOKEN'
1746
+
1747
+ # Configure API key authorization: ultraCartSimpleApiKey
1748
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1749
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1750
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1751
+ end
1752
+
1753
+ api_instance = UltracartClient::TaxApi.new
1754
+ postal_code = 'postal_code_example' # String | The postal code being updated.
1755
+ tax_postal_code = UltracartClient::TaxPostalCode.new # TaxPostalCode | tax postal code to be updated
1756
+
1757
+ begin
1758
+ # Updates a Self tax provider postalCode
1759
+ result = api_instance.update_tax_provider_self_postal_code(postal_code, tax_postal_code)
1760
+ p result
1761
+ rescue UltracartClient::ApiError => e
1762
+ puts "Error when calling TaxApi->update_tax_provider_self_postal_code: #{e}"
1763
+ end
1764
+ ```
1765
+
1766
+ #### Using the update_tax_provider_self_postal_code_with_http_info variant
1767
+
1768
+ This returns an Array which contains the response data, status code and headers.
1769
+
1770
+ > <Array(<TaxPostalCode>, Integer, Hash)> update_tax_provider_self_postal_code_with_http_info(postal_code, tax_postal_code)
1771
+
1772
+ ```ruby
1773
+ begin
1774
+ # Updates a Self tax provider postalCode
1775
+ data, status_code, headers = api_instance.update_tax_provider_self_postal_code_with_http_info(postal_code, tax_postal_code)
1776
+ p status_code # => 2xx
1777
+ p headers # => { ... }
1778
+ p data # => <TaxPostalCode>
1779
+ rescue UltracartClient::ApiError => e
1780
+ puts "Error when calling TaxApi->update_tax_provider_self_postal_code_with_http_info: #{e}"
1781
+ end
1782
+ ```
1783
+
1784
+ ### Parameters
1785
+
1786
+ | Name | Type | Description | Notes |
1787
+ | ---- | ---- | ----------- | ----- |
1788
+ | **postal_code** | **String** | The postal code being updated. | |
1789
+ | **tax_postal_code** | [**TaxPostalCode**](TaxPostalCode.md) | tax postal code to be updated | |
1790
+
1791
+ ### Return type
1792
+
1793
+ [**TaxPostalCode**](TaxPostalCode.md)
1794
+
1795
+ ### Authorization
1796
+
1797
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1798
+
1799
+ ### HTTP request headers
1800
+
1801
+ - **Content-Type**: application/json
1802
+ - **Accept**: application/json
1803
+
1804
+
1805
+ ## update_tax_provider_self_state
1806
+
1807
+ > <TaxState> update_tax_provider_self_state(state_code, tax_state)
1808
+
1809
+ Updates a Self tax provider state
1810
+
1811
+ Updates a Self tax provider state.
1812
+
1813
+ ### Examples
1814
+
1815
+ ```ruby
1816
+ require 'time'
1817
+ require 'ultracart_api'
1818
+ # setup authorization
1819
+ UltracartClient.configure do |config|
1820
+ # Configure OAuth2 access token for authorization: ultraCartOauth
1821
+ config.access_token = 'YOUR ACCESS TOKEN'
1822
+
1823
+ # Configure API key authorization: ultraCartSimpleApiKey
1824
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1825
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1826
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1827
+ end
1828
+
1829
+ api_instance = UltracartClient::TaxApi.new
1830
+ state_code = 'state_code_example' # String | The state code being updated.
1831
+ tax_state = UltracartClient::TaxState.new # TaxState | tax state to be updated
1832
+
1833
+ begin
1834
+ # Updates a Self tax provider state
1835
+ result = api_instance.update_tax_provider_self_state(state_code, tax_state)
1836
+ p result
1837
+ rescue UltracartClient::ApiError => e
1838
+ puts "Error when calling TaxApi->update_tax_provider_self_state: #{e}"
1839
+ end
1840
+ ```
1841
+
1842
+ #### Using the update_tax_provider_self_state_with_http_info variant
1843
+
1844
+ This returns an Array which contains the response data, status code and headers.
1845
+
1846
+ > <Array(<TaxState>, Integer, Hash)> update_tax_provider_self_state_with_http_info(state_code, tax_state)
1847
+
1848
+ ```ruby
1849
+ begin
1850
+ # Updates a Self tax provider state
1851
+ data, status_code, headers = api_instance.update_tax_provider_self_state_with_http_info(state_code, tax_state)
1852
+ p status_code # => 2xx
1853
+ p headers # => { ... }
1854
+ p data # => <TaxState>
1855
+ rescue UltracartClient::ApiError => e
1856
+ puts "Error when calling TaxApi->update_tax_provider_self_state_with_http_info: #{e}"
1857
+ end
1858
+ ```
1859
+
1860
+ ### Parameters
1861
+
1862
+ | Name | Type | Description | Notes |
1863
+ | ---- | ---- | ----------- | ----- |
1864
+ | **state_code** | **String** | The state code being updated. | |
1865
+ | **tax_state** | [**TaxState**](TaxState.md) | tax state to be updated | |
1866
+
1867
+ ### Return type
1868
+
1869
+ [**TaxState**](TaxState.md)
1870
+
1871
+ ### Authorization
1872
+
1873
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1874
+
1875
+ ### HTTP request headers
1876
+
1877
+ - **Content-Type**: application/json
1878
+ - **Accept**: application/json
1879
+
1880
+
1881
+ ## update_tax_provider_sovos
1882
+
1883
+ > <TaxProviderSovos> update_tax_provider_sovos(tax_provider_sovos)
1884
+
1885
+ Update the Sovos tax provider
1886
+
1887
+ Update the Sovos tax provider.
1888
+
1889
+ ### Examples
1890
+
1891
+ ```ruby
1892
+ require 'time'
1893
+ require 'ultracart_api'
1894
+ # setup authorization
1895
+ UltracartClient.configure do |config|
1896
+ # Configure OAuth2 access token for authorization: ultraCartOauth
1897
+ config.access_token = 'YOUR ACCESS TOKEN'
1898
+
1899
+ # Configure API key authorization: ultraCartSimpleApiKey
1900
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1901
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1902
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1903
+ end
1904
+
1905
+ api_instance = UltracartClient::TaxApi.new
1906
+ tax_provider_sovos = UltracartClient::TaxProviderSovos.new # TaxProviderSovos | TaxProviderSovos object
1907
+
1908
+ begin
1909
+ # Update the Sovos tax provider
1910
+ result = api_instance.update_tax_provider_sovos(tax_provider_sovos)
1911
+ p result
1912
+ rescue UltracartClient::ApiError => e
1913
+ puts "Error when calling TaxApi->update_tax_provider_sovos: #{e}"
1914
+ end
1915
+ ```
1916
+
1917
+ #### Using the update_tax_provider_sovos_with_http_info variant
1918
+
1919
+ This returns an Array which contains the response data, status code and headers.
1920
+
1921
+ > <Array(<TaxProviderSovos>, Integer, Hash)> update_tax_provider_sovos_with_http_info(tax_provider_sovos)
1922
+
1923
+ ```ruby
1924
+ begin
1925
+ # Update the Sovos tax provider
1926
+ data, status_code, headers = api_instance.update_tax_provider_sovos_with_http_info(tax_provider_sovos)
1927
+ p status_code # => 2xx
1928
+ p headers # => { ... }
1929
+ p data # => <TaxProviderSovos>
1930
+ rescue UltracartClient::ApiError => e
1931
+ puts "Error when calling TaxApi->update_tax_provider_sovos_with_http_info: #{e}"
1932
+ end
1933
+ ```
1934
+
1935
+ ### Parameters
1936
+
1937
+ | Name | Type | Description | Notes |
1938
+ | ---- | ---- | ----------- | ----- |
1939
+ | **tax_provider_sovos** | [**TaxProviderSovos**](TaxProviderSovos.md) | TaxProviderSovos object | |
1940
+
1941
+ ### Return type
1942
+
1943
+ [**TaxProviderSovos**](TaxProviderSovos.md)
1944
+
1945
+ ### Authorization
1946
+
1947
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1948
+
1949
+ ### HTTP request headers
1950
+
1951
+ - **Content-Type**: application/json
1952
+ - **Accept**: application/json
1953
+
1954
+
1955
+ ## update_tax_provider_tax_jar
1956
+
1957
+ > <TaxProviderTaxJar> update_tax_provider_tax_jar(tax_provider_tax_jar)
1958
+
1959
+ Update the TaxJar tax provider
1960
+
1961
+ Update the TaxJar tax provider.
1962
+
1963
+ ### Examples
1964
+
1965
+ ```ruby
1966
+ require 'time'
1967
+ require 'ultracart_api'
1968
+ # setup authorization
1969
+ UltracartClient.configure do |config|
1970
+ # Configure OAuth2 access token for authorization: ultraCartOauth
1971
+ config.access_token = 'YOUR ACCESS TOKEN'
1972
+
1973
+ # Configure API key authorization: ultraCartSimpleApiKey
1974
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1975
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1976
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1977
+ end
1978
+
1979
+ api_instance = UltracartClient::TaxApi.new
1980
+ tax_provider_tax_jar = UltracartClient::TaxProviderTaxJar.new # TaxProviderTaxJar | TaxProviderTaxJar object
1981
+
1982
+ begin
1983
+ # Update the TaxJar tax provider
1984
+ result = api_instance.update_tax_provider_tax_jar(tax_provider_tax_jar)
1985
+ p result
1986
+ rescue UltracartClient::ApiError => e
1987
+ puts "Error when calling TaxApi->update_tax_provider_tax_jar: #{e}"
1988
+ end
1989
+ ```
1990
+
1991
+ #### Using the update_tax_provider_tax_jar_with_http_info variant
1992
+
1993
+ This returns an Array which contains the response data, status code and headers.
1994
+
1995
+ > <Array(<TaxProviderTaxJar>, Integer, Hash)> update_tax_provider_tax_jar_with_http_info(tax_provider_tax_jar)
1996
+
1997
+ ```ruby
1998
+ begin
1999
+ # Update the TaxJar tax provider
2000
+ data, status_code, headers = api_instance.update_tax_provider_tax_jar_with_http_info(tax_provider_tax_jar)
2001
+ p status_code # => 2xx
2002
+ p headers # => { ... }
2003
+ p data # => <TaxProviderTaxJar>
2004
+ rescue UltracartClient::ApiError => e
2005
+ puts "Error when calling TaxApi->update_tax_provider_tax_jar_with_http_info: #{e}"
2006
+ end
2007
+ ```
2008
+
2009
+ ### Parameters
2010
+
2011
+ | Name | Type | Description | Notes |
2012
+ | ---- | ---- | ----------- | ----- |
2013
+ | **tax_provider_tax_jar** | [**TaxProviderTaxJar**](TaxProviderTaxJar.md) | TaxProviderTaxJar object | |
2014
+
2015
+ ### Return type
2016
+
2017
+ [**TaxProviderTaxJar**](TaxProviderTaxJar.md)
2018
+
2019
+ ### Authorization
2020
+
2021
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2022
+
2023
+ ### HTTP request headers
2024
+
2025
+ - **Content-Type**: application/json
2026
+ - **Accept**: application/json
2027
+
2028
+
2029
+ ## update_tax_provider_ultra_cart
2030
+
2031
+ > <TaxProviderUltraCart> update_tax_provider_ultra_cart(tax_provider_ultracart)
2032
+
2033
+ Update the UltraCart tax provider
2034
+
2035
+ Update the UltraCart tax provider.
2036
+
2037
+ ### Examples
2038
+
2039
+ ```ruby
2040
+ require 'time'
2041
+ require 'ultracart_api'
2042
+ # setup authorization
2043
+ UltracartClient.configure do |config|
2044
+ # Configure OAuth2 access token for authorization: ultraCartOauth
2045
+ config.access_token = 'YOUR ACCESS TOKEN'
2046
+
2047
+ # Configure API key authorization: ultraCartSimpleApiKey
2048
+ config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
2049
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2050
+ # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
2051
+ end
2052
+
2053
+ api_instance = UltracartClient::TaxApi.new
2054
+ tax_provider_ultracart = UltracartClient::TaxProviderUltraCart.new # TaxProviderUltraCart | TaxProviderUltraCart object
2055
+
2056
+ begin
2057
+ # Update the UltraCart tax provider
2058
+ result = api_instance.update_tax_provider_ultra_cart(tax_provider_ultracart)
2059
+ p result
2060
+ rescue UltracartClient::ApiError => e
2061
+ puts "Error when calling TaxApi->update_tax_provider_ultra_cart: #{e}"
2062
+ end
2063
+ ```
2064
+
2065
+ #### Using the update_tax_provider_ultra_cart_with_http_info variant
2066
+
2067
+ This returns an Array which contains the response data, status code and headers.
2068
+
2069
+ > <Array(<TaxProviderUltraCart>, Integer, Hash)> update_tax_provider_ultra_cart_with_http_info(tax_provider_ultracart)
2070
+
2071
+ ```ruby
2072
+ begin
2073
+ # Update the UltraCart tax provider
2074
+ data, status_code, headers = api_instance.update_tax_provider_ultra_cart_with_http_info(tax_provider_ultracart)
2075
+ p status_code # => 2xx
2076
+ p headers # => { ... }
2077
+ p data # => <TaxProviderUltraCart>
2078
+ rescue UltracartClient::ApiError => e
2079
+ puts "Error when calling TaxApi->update_tax_provider_ultra_cart_with_http_info: #{e}"
2080
+ end
2081
+ ```
2082
+
2083
+ ### Parameters
2084
+
2085
+ | Name | Type | Description | Notes |
2086
+ | ---- | ---- | ----------- | ----- |
2087
+ | **tax_provider_ultracart** | [**TaxProviderUltraCart**](TaxProviderUltraCart.md) | TaxProviderUltraCart object | |
2088
+
2089
+ ### Return type
2090
+
2091
+ [**TaxProviderUltraCart**](TaxProviderUltraCart.md)
2092
+
2093
+ ### Authorization
2094
+
2095
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2096
+
2097
+ ### HTTP request headers
2098
+
2099
+ - **Content-Type**: application/json
2100
+ - **Accept**: application/json
2101
+