ultracart_api 3.10.19 → 4.0.34.rc

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