ultracart_api 3.11.21 → 4.0.32.rc

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (1845) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +9 -7
  3. data/README.md +1166 -1807
  4. data/Rakefile +10 -8
  5. data/docs/AccountsReceivableRetryConfig.md +46 -23
  6. data/docs/AccountsReceivableRetryConfigResponse.md +32 -15
  7. data/docs/AccountsReceivableRetryDayActivity.md +22 -10
  8. data/docs/AccountsReceivableRetryStatAccount.md +24 -11
  9. data/docs/AccountsReceivableRetryStatMetrics.md +38 -18
  10. data/docs/AccountsReceivableRetryStatRevenue.md +20 -9
  11. data/docs/AccountsReceivableRetryStatsResponse.md +28 -13
  12. data/docs/Activity.md +28 -15
  13. data/docs/AddLibraryItemRequest.md +38 -18
  14. data/docs/AdjustInternalCertificateRequest.md +28 -13
  15. data/docs/AdjustInternalCertificateResponse.md +28 -13
  16. data/docs/AffiliateApi.md +173 -126
  17. data/docs/AffiliateClick.md +38 -20
  18. data/docs/AffiliateClickQuery.md +28 -13
  19. data/docs/AffiliateClicksResponse.md +26 -12
  20. data/docs/AffiliateLedger.md +54 -26
  21. data/docs/AffiliateLedgerQuery.md +28 -13
  22. data/docs/AffiliateLedgersResponse.md +26 -12
  23. data/docs/AffiliateLink.md +44 -21
  24. data/docs/ApiUserApplicationProfile.md +26 -12
  25. data/docs/ApplyLibraryItemRequest.md +24 -11
  26. data/docs/ApplyLibraryItemResponse.md +38 -18
  27. data/docs/AutoOrder.md +60 -34
  28. data/docs/AutoOrderApi.md +693 -675
  29. data/docs/AutoOrderItem.md +64 -35
  30. data/docs/AutoOrderItemFutureSchedule.md +24 -11
  31. data/docs/AutoOrderItemOption.md +20 -9
  32. data/docs/AutoOrderItemSimpleSchedule.md +22 -10
  33. data/docs/AutoOrderLog.md +20 -9
  34. data/docs/AutoOrderQuery.md +58 -28
  35. data/docs/AutoOrderQueryBatch.md +18 -8
  36. data/docs/AutoOrderResponse.md +26 -12
  37. data/docs/AutoOrdersRequest.md +18 -8
  38. data/docs/AutoOrdersResponse.md +26 -12
  39. data/docs/AvalaraConfig.md +42 -20
  40. data/docs/BaseResponse.md +24 -11
  41. data/docs/Browser.md +22 -10
  42. data/docs/BrowserDevice.md +18 -8
  43. data/docs/BrowserOS.md +26 -12
  44. data/docs/BrowserUserAgent.md +24 -11
  45. data/docs/Cart.md +68 -33
  46. data/docs/CartAffiliate.md +20 -9
  47. data/docs/CartAffirmCheckoutResponse.md +20 -9
  48. data/docs/CartBilling.md +46 -24
  49. data/docs/CartBuysafe.md +28 -13
  50. data/docs/CartCheckout.md +44 -25
  51. data/docs/CartCoupon.md +18 -8
  52. data/docs/CartCurrencyConversion.md +20 -9
  53. data/docs/CartCustomerProfile.md +60 -30
  54. data/docs/CartCustomerProfileAddress.md +44 -21
  55. data/docs/CartCustomerProfileCreditCard.md +28 -13
  56. data/docs/CartFinalizeOrderRequest.md +20 -9
  57. data/docs/CartFinalizeOrderRequestOptions.md +42 -20
  58. data/docs/CartFinalizeOrderResponse.md +26 -12
  59. data/docs/CartGift.md +28 -13
  60. data/docs/CartGiftCertificate.md +22 -10
  61. data/docs/CartItem.md +74 -37
  62. data/docs/CartItemAttribute.md +22 -10
  63. data/docs/CartItemMultimedia.md +34 -16
  64. data/docs/CartItemMultimediaThumbnail.md +26 -12
  65. data/docs/CartItemOption.md +40 -19
  66. data/docs/CartItemOptionValue.md +26 -12
  67. data/docs/CartItemPhysical.md +24 -11
  68. data/docs/CartItemVariationSelection.md +20 -9
  69. data/docs/CartKitComponentOption.md +44 -21
  70. data/docs/CartMarketing.md +20 -10
  71. data/docs/CartPayment.md +30 -15
  72. data/docs/CartPaymentAffirm.md +18 -8
  73. data/docs/CartPaymentAmazon.md +18 -8
  74. data/docs/CartPaymentCheck.md +18 -8
  75. data/docs/CartPaymentCreditCard.md +34 -16
  76. data/docs/CartPaymentPurchaseOrder.md +18 -8
  77. data/docs/CartProfileLoginRequest.md +22 -10
  78. data/docs/CartProfileLoginResponse.md +20 -9
  79. data/docs/CartProfileRegisterRequest.md +20 -9
  80. data/docs/CartProfileRegisterResponse.md +20 -9
  81. data/docs/CartProperty.md +24 -11
  82. data/docs/CartResponse.md +20 -9
  83. data/docs/CartSettings.md +28 -13
  84. data/docs/CartSettingsBilling.md +18 -8
  85. data/docs/CartSettingsGift.md +24 -11
  86. data/docs/CartSettingsGiftWrap.md +22 -10
  87. data/docs/CartSettingsPayment.md +42 -20
  88. data/docs/CartSettingsPaymentAmazon.md +22 -10
  89. data/docs/CartSettingsPaymentCreditCard.md +22 -11
  90. data/docs/CartSettingsPaymentPayPal.md +26 -12
  91. data/docs/CartSettingsProvince.md +20 -9
  92. data/docs/CartSettingsShipping.md +26 -12
  93. data/docs/CartSettingsShippingCalendar.md +26 -12
  94. data/docs/CartSettingsShippingEstimate.md +44 -21
  95. data/docs/CartSettingsTaxes.md +18 -8
  96. data/docs/CartSettingsTerms.md +20 -9
  97. data/docs/CartShipping.md +54 -26
  98. data/docs/CartSummary.md +48 -27
  99. data/docs/CartTaxes.md +22 -10
  100. data/docs/CartUpsellAfter.md +22 -12
  101. data/docs/CartValidationRequest.md +20 -9
  102. data/docs/CartValidationResponse.md +20 -9
  103. data/docs/ChannelPartnerApi.md +382 -811
  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 -100
  109. data/docs/ChannelPartnerOrderItem.md +30 -15
  110. data/docs/ChannelPartnerOrderItemOption.md +20 -9
  111. data/docs/ChannelPartnerOrderTransaction.md +20 -9
  112. data/docs/ChannelPartnerOrderTransactionDetail.md +20 -9
  113. data/docs/ChannelPartnerShippingEstimate.md +20 -9
  114. data/docs/ChargebackApi.md +420 -0
  115. data/docs/ChargebackDispute.md +62 -0
  116. data/docs/ChargebackDisputeResponse.md +26 -0
  117. data/docs/ChargebackDisputesResponse.md +26 -0
  118. data/docs/CheckoutAllowedCountriesResponse.md +18 -8
  119. data/docs/CheckoutApi.md +1566 -1023
  120. data/docs/CheckoutHandoffRequest.md +32 -15
  121. data/docs/CheckoutHandoffResponse.md +22 -10
  122. data/docs/CheckoutSetupBrowserKeyRequest.md +18 -8
  123. data/docs/CheckoutSetupBrowserKeyResponse.md +18 -8
  124. data/docs/CheckoutStateProvinceResponse.md +18 -8
  125. data/docs/CityStateZip.md +26 -12
  126. data/docs/CountriesResponse.md +18 -8
  127. data/docs/Country.md +20 -9
  128. data/docs/Coupon.md +136 -74
  129. data/docs/CouponAmountOffItems.md +24 -12
  130. data/docs/CouponAmountOffShipping.md +22 -10
  131. data/docs/CouponAmountOffShippingWithItemsPurchase.md +24 -11
  132. data/docs/CouponAmountOffSubtotal.md +20 -9
  133. data/docs/CouponAmountOffSubtotalAndShipping.md +20 -9
  134. data/docs/CouponAmountOffSubtotalFreeShippingWithPurchase.md +24 -11
  135. data/docs/CouponAmountOffSubtotalWithBlockPurchase.md +24 -11
  136. data/docs/CouponAmountOffSubtotalWithItemsPurchase.md +24 -11
  137. data/docs/CouponAmountOffSubtotalWithPurchase.md +22 -10
  138. data/docs/CouponAmountShippingWithSubtotal.md +24 -11
  139. data/docs/CouponApi.md +1500 -1043
  140. data/docs/CouponAutoApplyCondition.md +22 -10
  141. data/docs/CouponAutoApplyConditions.md +28 -13
  142. data/docs/CouponAutomaticallyApplyCouponCodes.md +18 -8
  143. data/docs/CouponBuyOneGetOneLimit.md +20 -10
  144. data/docs/CouponCodesRequest.md +30 -14
  145. data/docs/CouponCodesResponse.md +28 -13
  146. data/docs/CouponDeletesRequest.md +20 -9
  147. data/docs/CouponDiscountItemWithItemPurchase.md +26 -14
  148. data/docs/CouponDiscountItems.md +24 -11
  149. data/docs/CouponEditorValues.md +36 -18
  150. data/docs/CouponExistsResponse.md +28 -13
  151. data/docs/CouponFreeItemAndShippingWithSubtotal.md +26 -12
  152. data/docs/CouponFreeItemWithItemPurchase.md +24 -13
  153. data/docs/CouponFreeItemWithSubtotal.md +24 -11
  154. data/docs/CouponFreeItemsWithItemPurchase.md +26 -12
  155. data/docs/CouponFreeItemsWithMixMatchPurchase.md +26 -12
  156. data/docs/CouponFreeShipping.md +18 -8
  157. data/docs/CouponFreeShippingSpecificItems.md +18 -8
  158. data/docs/CouponFreeShippingWithItemsPurchase.md +20 -9
  159. data/docs/CouponFreeShippingWithSubtotal.md +22 -10
  160. data/docs/CouponItemSearchResult.md +32 -15
  161. data/docs/CouponItemSearchResultsResponse.md +26 -12
  162. data/docs/CouponMultipleAmountsOffItems.md +20 -9
  163. data/docs/CouponPercentOffItemWithItemsQuantityPurchase.md +26 -14
  164. data/docs/CouponPercentOffItems.md +24 -13
  165. data/docs/CouponPercentOffItemsAndFreeShipping.md +22 -12
  166. data/docs/CouponPercentOffItemsWithItemsPurchase.md +24 -13
  167. data/docs/CouponPercentOffMsrpItems.md +24 -13
  168. data/docs/CouponPercentOffRetailPriceItems.md +24 -11
  169. data/docs/CouponPercentOffShipping.md +20 -9
  170. data/docs/CouponPercentOffSubtotal.md +18 -8
  171. data/docs/CouponPercentOffSubtotalAndFreeShipping.md +20 -9
  172. data/docs/CouponPercentOffSubtotalLimit.md +22 -10
  173. data/docs/CouponPercentOffSubtotalWithItemsPurchase.md +20 -9
  174. data/docs/CouponPercentOffSubtotalWithSubtotal.md +22 -10
  175. data/docs/CouponQuery.md +36 -17
  176. data/docs/CouponResponse.md +28 -13
  177. data/docs/CouponRestriction.md +24 -11
  178. data/docs/CouponTierAmount.md +22 -10
  179. data/docs/CouponTierItemDiscount.md +20 -9
  180. data/docs/CouponTierPercent.md +22 -10
  181. data/docs/CouponTierQuantityAmount.md +22 -10
  182. data/docs/CouponTierQuantityPercent.md +22 -10
  183. data/docs/CouponTieredAmountOffItems.md +22 -11
  184. data/docs/CouponTieredAmountOffSubtotal.md +20 -9
  185. data/docs/CouponTieredPercentOffItems.md +22 -11
  186. data/docs/CouponTieredPercentOffShipping.md +22 -10
  187. data/docs/CouponTieredPercentOffSubtotal.md +20 -9
  188. data/docs/CouponType.md +20 -9
  189. data/docs/CouponsRequest.md +18 -8
  190. data/docs/CouponsResponse.md +26 -12
  191. data/docs/Currency.md +26 -12
  192. data/docs/Customer.md +134 -71
  193. data/docs/CustomerActivity.md +24 -15
  194. data/docs/CustomerAffiliate.md +24 -11
  195. data/docs/CustomerApi.md +1380 -1347
  196. data/docs/CustomerAttachment.md +26 -12
  197. data/docs/CustomerBilling.md +50 -24
  198. data/docs/CustomerCard.md +32 -15
  199. data/docs/CustomerEditorValues.md +36 -19
  200. data/docs/CustomerEmail.md +28 -13
  201. data/docs/CustomerEmailListChanges.md +20 -9
  202. data/docs/CustomerLoyalty.md +30 -14
  203. data/docs/CustomerLoyaltyLedger.md +46 -22
  204. data/docs/CustomerLoyaltyRedemption.md +42 -20
  205. data/docs/CustomerOrdersSummary.md +24 -11
  206. data/docs/CustomerPricingTier.md +20 -9
  207. data/docs/CustomerPrivacy.md +24 -11
  208. data/docs/CustomerQuery.md +74 -37
  209. data/docs/CustomerQuotesSummary.md +24 -11
  210. data/docs/CustomerResponse.md +26 -12
  211. data/docs/CustomerReviewer.md +36 -17
  212. data/docs/CustomerShipping.md +50 -24
  213. data/docs/CustomerSoftwareEntitlement.md +32 -15
  214. data/docs/CustomerStoreCredit.md +28 -13
  215. data/docs/CustomerStoreCreditAddRequest.md +24 -11
  216. data/docs/CustomerStoreCreditLedgerEntry.md +30 -14
  217. data/docs/CustomerStoreCreditResponse.md +26 -12
  218. data/docs/CustomerTag.md +18 -8
  219. data/docs/CustomerTaxCodes.md +26 -12
  220. data/docs/CustomersResponse.md +26 -12
  221. data/docs/DataTablesServerSideResponse.md +24 -11
  222. data/docs/Distance.md +20 -9
  223. data/docs/DistributionCenter.md +86 -57
  224. data/docs/DistributionCentersResponse.md +26 -12
  225. data/docs/EmailBaseTemplateListResponse.md +18 -8
  226. data/docs/EmailCampaign.md +64 -35
  227. data/docs/EmailCampaignFolder.md +26 -12
  228. data/docs/EmailCampaignFolderResponse.md +26 -12
  229. data/docs/EmailCampaignFoldersResponse.md +26 -12
  230. data/docs/EmailCampaignResponse.md +26 -12
  231. data/docs/EmailCampaignsResponse.md +26 -12
  232. data/docs/EmailClick.md +20 -9
  233. data/docs/EmailClicksResponse.md +26 -12
  234. data/docs/EmailCommseq.md +24 -11
  235. data/docs/EmailCommseqEmail.md +68 -41
  236. data/docs/EmailCommseqEmailResponse.md +26 -12
  237. data/docs/EmailCommseqEmailSendTestRequest.md +36 -17
  238. data/docs/EmailCommseqEmailSendTestResponse.md +24 -11
  239. data/docs/EmailCommseqEmailsRequest.md +26 -12
  240. data/docs/EmailCommseqEmailsResponse.md +26 -12
  241. data/docs/EmailCommseqPostcard.md +42 -20
  242. data/docs/EmailCommseqPostcardResponse.md +26 -12
  243. data/docs/EmailCommseqPostcardSendTestRequest.md +42 -20
  244. data/docs/EmailCommseqPostcardSendTestResponse.md +30 -14
  245. data/docs/EmailCommseqPostcardsRequest.md +18 -8
  246. data/docs/EmailCommseqPostcardsResponse.md +26 -12
  247. data/docs/EmailCommseqResponse.md +26 -12
  248. data/docs/EmailCommseqStat.md +90 -44
  249. data/docs/EmailCommseqStatResponse.md +26 -12
  250. data/docs/EmailCommseqStep.md +36 -17
  251. data/docs/EmailCommseqStepLog.md +22 -10
  252. data/docs/EmailCommseqStepLogsResponse.md +26 -12
  253. data/docs/EmailCommseqWebhookSendTestRequest.md +30 -14
  254. data/docs/EmailCommseqWebhookSendTestResponse.md +30 -14
  255. data/docs/EmailCommseqsResponse.md +26 -12
  256. data/docs/EmailCustomer.md +32 -15
  257. data/docs/EmailCustomerEditorUrlResponse.md +26 -12
  258. data/docs/EmailCustomersResponse.md +26 -12
  259. data/docs/EmailDashboardActivity.md +30 -14
  260. data/docs/EmailDashboardActivityResponse.md +26 -12
  261. data/docs/EmailDashboardStatsResponse.md +26 -12
  262. data/docs/EmailDomain.md +42 -20
  263. data/docs/EmailEditorTokenResponse.md +26 -12
  264. data/docs/EmailFlow.md +72 -38
  265. data/docs/EmailFlowBackPopulateRequest.md +20 -9
  266. data/docs/EmailFlowBackPopulateResponse.md +24 -11
  267. data/docs/EmailFlowFolder.md +26 -12
  268. data/docs/EmailFlowFolderResponse.md +26 -12
  269. data/docs/EmailFlowFoldersResponse.md +26 -12
  270. data/docs/EmailFlowResponse.md +26 -12
  271. data/docs/EmailFlowsResponse.md +26 -12
  272. data/docs/EmailGlobalSettings.md +18 -8
  273. data/docs/EmailGlobalSettingsResponse.md +26 -12
  274. data/docs/EmailGlobalUnsubscribeRequest.md +18 -8
  275. data/docs/EmailGlobalUnsubscribeResponse.md +18 -8
  276. data/docs/EmailHistogramPropertyNamesResponse.md +18 -8
  277. data/docs/EmailHistogramPropertyValuesResponse.md +18 -8
  278. data/docs/EmailList.md +40 -19
  279. data/docs/EmailListArchiveResponse.md +26 -12
  280. data/docs/EmailListCustomer.md +24 -11
  281. data/docs/EmailListCustomersResponse.md +26 -12
  282. data/docs/EmailListResponse.md +26 -12
  283. data/docs/EmailListSegmentFolder.md +26 -12
  284. data/docs/EmailListSegmentFolderResponse.md +26 -12
  285. data/docs/EmailListSegmentFoldersResponse.md +26 -12
  286. data/docs/EmailListSegmentMembership.md +24 -11
  287. data/docs/EmailListSegmentUsedBy.md +22 -10
  288. data/docs/EmailListSubscribeResponse.md +20 -9
  289. data/docs/EmailListsResponse.md +26 -12
  290. data/docs/EmailOrder.md +24 -11
  291. data/docs/EmailOrdersResponse.md +26 -12
  292. data/docs/EmailPerformance.md +62 -30
  293. data/docs/EmailPerformanceCustomerHistogram.md +18 -8
  294. data/docs/EmailPerformanceCustomerHistogramPeriod.md +26 -12
  295. data/docs/EmailPerformanceDaily.md +30 -14
  296. data/docs/EmailPerformanceResponse.md +26 -12
  297. data/docs/EmailPlan.md +50 -24
  298. data/docs/EmailPlanAdditional.md +34 -16
  299. data/docs/EmailPlanResponse.md +26 -12
  300. data/docs/EmailPostcardStat.md +80 -39
  301. data/docs/EmailSegment.md +58 -29
  302. data/docs/EmailSegmentArchiveResponse.md +26 -12
  303. data/docs/EmailSegmentCustomer.md +24 -11
  304. data/docs/EmailSegmentCustomersResponse.md +26 -12
  305. data/docs/EmailSegmentDownloadPrepareResponse.md +32 -15
  306. data/docs/EmailSegmentResponse.md +26 -12
  307. data/docs/EmailSegmentsResponse.md +26 -12
  308. data/docs/EmailSendingDomainResponse.md +26 -12
  309. data/docs/EmailSendingDomainsResponse.md +26 -12
  310. data/docs/EmailSettings.md +40 -26
  311. data/docs/EmailSettingsResponse.md +26 -12
  312. data/docs/EmailStat.md +92 -45
  313. data/docs/EmailStatPostcardSummaryRequest.md +20 -9
  314. data/docs/EmailStatPostcardSummaryResponse.md +26 -12
  315. data/docs/EmailStatSummaryRequest.md +22 -10
  316. data/docs/EmailStatSummaryResponse.md +26 -12
  317. data/docs/EmailStepStat.md +56 -37
  318. data/docs/EmailStepStatRequest.md +20 -9
  319. data/docs/EmailStepStatResponse.md +26 -12
  320. data/docs/EmailStepWaitingRequest.md +18 -8
  321. data/docs/EmailStepWaitingResponse.md +18 -8
  322. data/docs/EmailTemplate.md +38 -18
  323. data/docs/EmailTemplatesResponse.md +26 -12
  324. data/docs/EmailThirdPartyList.md +20 -9
  325. data/docs/EmailThirdPartyListImportRequest.md +18 -8
  326. data/docs/EmailThirdPartyProvider.md +38 -18
  327. data/docs/EmailThirdPartyProvidersResponse.md +26 -12
  328. data/docs/EmailThirdPartyTag.md +20 -9
  329. data/docs/EmailVerifyTokenRequest.md +20 -9
  330. data/docs/EmailVerifyTokenResponse.md +26 -12
  331. data/docs/EmailVerifyTokenValidateRequest.md +18 -8
  332. data/docs/EmailVerifyTokenValidateResponse.md +24 -11
  333. data/docs/EmailWebhookEditorValuesResponse.md +30 -14
  334. data/docs/Error.md +26 -12
  335. data/docs/ErrorResponse.md +24 -11
  336. data/docs/Experiment.md +52 -31
  337. data/docs/ExperimentResponse.md +26 -12
  338. data/docs/ExperimentVariation.md +60 -30
  339. data/docs/ExperimentVariationStat.md +38 -20
  340. data/docs/ExperimentsResponse.md +26 -12
  341. data/docs/FulfillmentApi.md +459 -318
  342. data/docs/FulfillmentInventory.md +20 -9
  343. data/docs/FulfillmentShipment.md +26 -12
  344. data/docs/GeoPoint.md +20 -9
  345. data/docs/GeocodeRequest.md +26 -12
  346. data/docs/GeocodeResponse.md +28 -13
  347. data/docs/GiftCertificate.md +44 -21
  348. data/docs/GiftCertificateApi.md +622 -433
  349. data/docs/GiftCertificateCreateRequest.md +26 -12
  350. data/docs/GiftCertificateLedgerEntry.md +28 -13
  351. data/docs/GiftCertificateQuery.md +34 -16
  352. data/docs/GiftCertificateResponse.md +26 -12
  353. data/docs/GiftCertificatesResponse.md +26 -12
  354. data/docs/Group.md +26 -12
  355. data/docs/GroupResponse.md +26 -12
  356. data/docs/GroupUserMembership.md +26 -12
  357. data/docs/GroupsResponse.md +26 -12
  358. data/docs/HTTPHeader.md +20 -9
  359. data/docs/IntegrationLog.md +52 -26
  360. data/docs/IntegrationLogApi.md +400 -286
  361. data/docs/IntegrationLogFile.md +24 -11
  362. data/docs/IntegrationLogLog.md +20 -9
  363. data/docs/IntegrationLogQueryFilterValues.md +40 -19
  364. data/docs/IntegrationLogQueryRequest.md +42 -23
  365. data/docs/IntegrationLogQueryResponse.md +28 -13
  366. data/docs/IntegrationLogResponse.md +26 -12
  367. data/docs/IntegrationLogSummary.md +34 -16
  368. data/docs/IntegrationLogSummaryQueryRequest.md +20 -9
  369. data/docs/IntegrationLogSummaryQueryResponse.md +26 -12
  370. data/docs/Item.md +118 -58
  371. data/docs/ItemAccounting.md +20 -9
  372. data/docs/ItemAmember.md +20 -9
  373. data/docs/ItemApi.md +733 -1266
  374. data/docs/ItemAutoOrder.md +50 -29
  375. data/docs/ItemAutoOrderStep.md +46 -24
  376. data/docs/ItemAutoOrderStepArbitraryUnitCostSchedule.md +20 -9
  377. data/docs/ItemAutoOrderStepGrandfatherPricing.md +20 -9
  378. data/docs/ItemCCBill.md +28 -13
  379. data/docs/ItemChannelPartnerMapping.md +54 -26
  380. data/docs/ItemChargeback.md +20 -9
  381. data/docs/ItemChargebackAddendum.md +24 -11
  382. data/docs/ItemChargebackAdjustmentRequest.md +22 -10
  383. data/docs/ItemCheckout.md +24 -11
  384. data/docs/ItemContent.md +42 -23
  385. data/docs/ItemContentAssignment.md +28 -13
  386. data/docs/ItemContentAttribute.md +24 -11
  387. data/docs/ItemContentMultimedia.md +46 -22
  388. data/docs/ItemContentMultimediaThumbnail.md +28 -13
  389. data/docs/ItemDigitalDelivery.md +28 -13
  390. data/docs/ItemDigitalItem.md +26 -17
  391. data/docs/ItemEbay.md +154 -76
  392. data/docs/ItemEbayCategorySpecific.md +20 -9
  393. data/docs/ItemEbayMarketListing.md +26 -12
  394. data/docs/ItemEbayMarketPlaceAnalysis.md +36 -17
  395. data/docs/ItemEmailNotifications.md +20 -9
  396. data/docs/ItemEnrollment123.md +18 -8
  397. data/docs/ItemFulfillmentAddon.md +24 -12
  398. data/docs/ItemGiftCertificate.md +20 -9
  399. data/docs/ItemGoogleProductSearch.md +112 -55
  400. data/docs/ItemIdentifiers.md +24 -15
  401. data/docs/ItemInstantPaymentNotification.md +22 -10
  402. data/docs/ItemInstantPaymentNotifications.md +18 -8
  403. data/docs/ItemInternal.md +18 -8
  404. data/docs/ItemKitComponent.md +26 -12
  405. data/docs/ItemKitDefinition.md +18 -8
  406. data/docs/ItemOption.md +44 -21
  407. data/docs/ItemOptionValue.md +46 -22
  408. data/docs/ItemOptionValueAdditionalItem.md +20 -9
  409. data/docs/ItemOptionValueDigitalItem.md +20 -9
  410. data/docs/ItemPaymentProcessing.md +26 -13
  411. data/docs/ItemPhysical.md +24 -11
  412. data/docs/ItemPricing.md +52 -25
  413. data/docs/ItemPricingTier.md +26 -12
  414. data/docs/ItemPricingTierDiscount.md +20 -9
  415. data/docs/ItemPricingTierLimit.md +22 -12
  416. data/docs/ItemProperty.md +22 -10
  417. data/docs/ItemRealtimePricing.md +22 -10
  418. data/docs/ItemRelated.md +22 -10
  419. data/docs/ItemRelatedItem.md +22 -10
  420. data/docs/ItemReporting.md +20 -9
  421. data/docs/ItemResponse.md +26 -12
  422. data/docs/ItemRestriction.md +32 -16
  423. data/docs/ItemRestrictionItem.md +22 -10
  424. data/docs/ItemRevguard.md +30 -14
  425. data/docs/ItemReviews.md +34 -17
  426. data/docs/ItemSalesforce.md +20 -9
  427. data/docs/ItemShipping.md +112 -56
  428. data/docs/ItemShippingCase.md +24 -11
  429. data/docs/ItemShippingDestinationMarkup.md +28 -14
  430. data/docs/ItemShippingDestinationRestriction.md +22 -10
  431. data/docs/ItemShippingDistributionCenter.md +44 -21
  432. data/docs/ItemShippingMethod.md +46 -22
  433. data/docs/ItemShippingPackageRequirement.md +20 -9
  434. data/docs/ItemTag.md +20 -9
  435. data/docs/ItemTags.md +18 -8
  436. data/docs/ItemTax.md +24 -11
  437. data/docs/ItemTaxExemption.md +26 -12
  438. data/docs/ItemThirdPartyEmailMarketing.md +26 -12
  439. data/docs/ItemVariantItem.md +28 -13
  440. data/docs/ItemVariation.md +26 -12
  441. data/docs/ItemVariationOption.md +24 -11
  442. data/docs/ItemWishlistMember.md +22 -10
  443. data/docs/ItemsRequest.md +18 -8
  444. data/docs/ItemsResponse.md +26 -12
  445. data/docs/KeyValue.md +22 -10
  446. data/docs/LibraryFilterValues.md +24 -11
  447. data/docs/LibraryFilterValuesResponse.md +26 -12
  448. data/docs/LibraryItem.md +96 -47
  449. data/docs/LibraryItemAccount.md +22 -10
  450. data/docs/LibraryItemAsset.md +20 -9
  451. data/docs/LibraryItemAttribute.md +20 -9
  452. data/docs/LibraryItemEmail.md +22 -10
  453. data/docs/LibraryItemPublishedMeta.md +32 -15
  454. data/docs/LibraryItemPurchasedMeta.md +22 -10
  455. data/docs/LibraryItemQuery.md +40 -19
  456. data/docs/LibraryItemResponse.md +26 -12
  457. data/docs/LibraryItemScreenshot.md +20 -9
  458. data/docs/LibraryItemsResponse.md +26 -12
  459. data/docs/LinkedAccount.md +22 -10
  460. data/docs/ListSegmentMembership.md +22 -10
  461. data/docs/LookupRequest.md +26 -13
  462. data/docs/LookupResponse.md +26 -12
  463. data/docs/Mailgun.md +18 -8
  464. data/docs/Metric.md +32 -15
  465. data/docs/Notification.md +38 -18
  466. data/docs/OauthApi.md +179 -124
  467. data/docs/OauthRevokeSuccessResponse.md +20 -9
  468. data/docs/OauthTokenResponse.md +32 -15
  469. data/docs/Order.md +84 -46
  470. data/docs/OrderAffiliate.md +22 -10
  471. data/docs/OrderAffiliateLedger.md +34 -16
  472. data/docs/OrderApi.md +1856 -1684
  473. data/docs/OrderAutoOrder.md +56 -27
  474. data/docs/OrderBilling.md +48 -25
  475. data/docs/OrderBuysafe.md +28 -13
  476. data/docs/OrderByTokenQuery.md +18 -8
  477. data/docs/OrderChannelPartner.md +38 -18
  478. data/docs/OrderCheckout.md +44 -24
  479. data/docs/OrderCoupon.md +26 -12
  480. data/docs/OrderDigitalItem.md +32 -15
  481. data/docs/OrderDigitalOrder.md +26 -12
  482. data/docs/OrderEdi.md +24 -11
  483. data/docs/OrderFormat.md +48 -23
  484. data/docs/OrderFormatResponse.md +20 -9
  485. data/docs/OrderFraudScore.md +56 -27
  486. data/docs/OrderGift.md +36 -17
  487. data/docs/OrderGiftCertificate.md +22 -10
  488. data/docs/OrderInternal.md +26 -13
  489. data/docs/OrderItem.md +128 -73
  490. data/docs/OrderItemEdi.md +20 -9
  491. data/docs/OrderItemEdiIdentification.md +20 -9
  492. data/docs/OrderItemEdiLot.md +22 -10
  493. data/docs/OrderItemOption.md +38 -18
  494. data/docs/OrderItemOptionFileAttachment.md +24 -11
  495. data/docs/OrderItemProperty.md +24 -11
  496. data/docs/OrderItemTag.md +18 -8
  497. data/docs/OrderLinkedShipment.md +26 -12
  498. data/docs/OrderMarketing.md +22 -11
  499. data/docs/OrderPackingSlipResponse.md +26 -12
  500. data/docs/OrderPayment.md +52 -27
  501. data/docs/OrderPaymentCheck.md +18 -8
  502. data/docs/OrderPaymentCreditCard.md +38 -19
  503. data/docs/OrderPaymentECheck.md +36 -17
  504. data/docs/OrderPaymentInsurance.md +24 -11
  505. data/docs/OrderPaymentPurchaseOrder.md +18 -8
  506. data/docs/OrderPaymentTransaction.md +24 -12
  507. data/docs/OrderPaymentTransactionDetail.md +22 -10
  508. data/docs/OrderProcessPaymentRequest.md +20 -9
  509. data/docs/OrderProcessPaymentResponse.md +26 -12
  510. data/docs/OrderProperty.md +24 -13
  511. data/docs/OrderQuery.md +94 -50
  512. data/docs/OrderQueryBatch.md +18 -9
  513. data/docs/OrderQuote.md +22 -10
  514. data/docs/OrderReplacement.md +46 -22
  515. data/docs/OrderReplacementItem.md +22 -10
  516. data/docs/OrderReplacementResponse.md +28 -13
  517. data/docs/OrderResponse.md +26 -12
  518. data/docs/OrderSalesforce.md +18 -8
  519. data/docs/OrderShipping.md +76 -38
  520. data/docs/OrderSummary.md +56 -33
  521. data/docs/OrderTag.md +18 -8
  522. data/docs/OrderTaxes.md +50 -24
  523. data/docs/OrderTokenResponse.md +26 -12
  524. data/docs/OrderTrackingNumberDetail.md +40 -19
  525. data/docs/OrderTrackingNumberDetails.md +52 -25
  526. data/docs/OrdersResponse.md +26 -12
  527. data/docs/Permission.md +22 -10
  528. data/docs/PricingTier.md +78 -41
  529. data/docs/PricingTierNotification.md +22 -10
  530. data/docs/PricingTiersResponse.md +26 -12
  531. data/docs/Property.md +20 -9
  532. data/docs/PublishLibraryItemRequest.md +18 -8
  533. data/docs/RegisterAffiliateClickRequest.md +28 -13
  534. data/docs/RegisterAffiliateClickResponse.md +24 -11
  535. data/docs/ResponseMetadata.md +20 -9
  536. data/docs/ResultSet.md +28 -13
  537. data/docs/ScreenRecording.md +116 -57
  538. data/docs/ScreenRecordingAdPlatform.md +30 -14
  539. data/docs/ScreenRecordingFilter.md +136 -67
  540. data/docs/ScreenRecordingFilterGeoDistance.md +26 -12
  541. data/docs/ScreenRecordingFilterIpSearch.md +24 -11
  542. data/docs/ScreenRecordingFilterPageView.md +50 -24
  543. data/docs/ScreenRecordingFilterPageViewEvent.md +20 -9
  544. data/docs/ScreenRecordingFilterPageViewEventParam.md +26 -12
  545. data/docs/ScreenRecordingFilterPageViewParam.md +20 -9
  546. data/docs/ScreenRecordingFilterPageViewReferrerParam.md +20 -9
  547. data/docs/ScreenRecordingFilterRangeBigDecimal.md +26 -12
  548. data/docs/ScreenRecordingFilterRangeDate.md +20 -9
  549. data/docs/ScreenRecordingFilterRangeInteger.md +26 -12
  550. data/docs/ScreenRecordingFilterStringSearch.md +26 -12
  551. data/docs/ScreenRecordingFilterValues.md +58 -28
  552. data/docs/ScreenRecordingFilterValuesEvent.md +20 -9
  553. data/docs/ScreenRecordingFilterValuesEventParams.md +26 -12
  554. data/docs/ScreenRecordingFilterValuesPageParam.md +20 -9
  555. data/docs/ScreenRecordingFilterValuesPageView.md +28 -13
  556. data/docs/ScreenRecordingHeatmap.md +64 -31
  557. data/docs/ScreenRecordingHeatmapIndexRequest.md +18 -8
  558. data/docs/ScreenRecordingHeatmapIndexResponse.md +26 -12
  559. data/docs/ScreenRecordingHeatmapRequest.md +22 -10
  560. data/docs/ScreenRecordingHeatmapReset.md +18 -8
  561. data/docs/ScreenRecordingHeatmapResponse.md +26 -12
  562. data/docs/ScreenRecordingHeatmapUrl.md +28 -13
  563. data/docs/ScreenRecordingMerchantNotesRequest.md +18 -8
  564. data/docs/ScreenRecordingMultifield.md +26 -12
  565. data/docs/ScreenRecordingPageView.md +54 -26
  566. data/docs/ScreenRecordingPageViewDataResponse.md +26 -12
  567. data/docs/ScreenRecordingPageViewEvent.md +28 -13
  568. data/docs/ScreenRecordingPageViewEventParameter.md +20 -9
  569. data/docs/ScreenRecordingPageViewParameter.md +20 -9
  570. data/docs/ScreenRecordingQueryRequest.md +18 -8
  571. data/docs/ScreenRecordingQueryResponse.md +38 -18
  572. data/docs/ScreenRecordingResponse.md +28 -13
  573. data/docs/ScreenRecordingSegment.md +36 -17
  574. data/docs/ScreenRecordingSegmentResponse.md +26 -12
  575. data/docs/ScreenRecordingSegmentsResponse.md +26 -12
  576. data/docs/ScreenRecordingSettings.md +32 -15
  577. data/docs/ScreenRecordingSettingsResponse.md +26 -12
  578. data/docs/ScreenRecordingStoreFront.md +20 -9
  579. data/docs/ScreenRecordingTagsRequest.md +18 -8
  580. data/docs/ScreenRecordingTagsResponse.md +26 -12
  581. data/docs/ScreenRecordingUserAgent.md +26 -12
  582. data/docs/ScreenRecordingUserAgentDevice.md +18 -8
  583. data/docs/ScreenRecordingUserAgentOS.md +22 -10
  584. data/docs/ScreenRecordingUserProperty.md +20 -9
  585. data/docs/ScreenshotsResponse.md +26 -12
  586. data/docs/SelfConfig.md +18 -10
  587. data/docs/SimpleValue.md +20 -9
  588. data/docs/SingleSignOnAuthorizeRequest.md +20 -9
  589. data/docs/SingleSignOnAuthorizeResponse.md +20 -9
  590. data/docs/SingleSignOnTokenRequest.md +20 -9
  591. data/docs/SingleSignOnTokenResponse.md +22 -10
  592. data/docs/SovosConfig.md +30 -14
  593. data/docs/SsoApi.md +300 -201
  594. data/docs/StateProvince.md +20 -9
  595. data/docs/StepWaiting.md +20 -9
  596. data/docs/StorefrontApi.md +13005 -9426
  597. data/docs/TaxApi.md +2101 -1421
  598. data/docs/TaxCity.md +34 -16
  599. data/docs/TaxCountry.md +34 -16
  600. data/docs/TaxCountryCode.md +26 -12
  601. data/docs/TaxCounty.md +36 -17
  602. data/docs/TaxJarConfig.md +30 -14
  603. data/docs/TaxPostalCode.md +30 -14
  604. data/docs/TaxProviderActivateResult.md +20 -9
  605. data/docs/TaxProviderAvalara.md +24 -11
  606. data/docs/TaxProviderAvalaraCompaniesResult.md +18 -8
  607. data/docs/TaxProviderAvalaraCompany.md +26 -12
  608. data/docs/TaxProviderSelf.md +26 -12
  609. data/docs/TaxProviderSelfCountriesResponse.md +18 -8
  610. data/docs/TaxProviderSelfRegionsResponse.md +18 -8
  611. data/docs/TaxProviderSovos.md +24 -11
  612. data/docs/TaxProviderTaxJar.md +24 -11
  613. data/docs/TaxProviderTestResult.md +20 -9
  614. data/docs/TaxProviderUltraCart.md +26 -12
  615. data/docs/TaxProviderUltraCartState.md +36 -17
  616. data/docs/TaxProvidersResponse.md +34 -16
  617. data/docs/TaxState.md +52 -25
  618. data/docs/TaxStateCode.md +26 -12
  619. data/docs/TempMultimedia.md +30 -14
  620. data/docs/TempMultimediaResponse.md +26 -12
  621. data/docs/ThumbnailParametersRequest.md +26 -12
  622. data/docs/ThumbnailParametersResponse.md +26 -12
  623. data/docs/TransactionEmail.md +56 -27
  624. data/docs/TransactionEmailListResponse.md +26 -12
  625. data/docs/TransactionEmailOption.md +32 -15
  626. data/docs/TransactionEmailResponse.md +26 -12
  627. data/docs/Twilio.md +24 -16
  628. data/docs/TwilioResponse.md +28 -13
  629. data/docs/TwiliosResponse.md +26 -12
  630. data/docs/UltraCartConfig.md +18 -10
  631. data/docs/UploadCouponCodesRequest.md +26 -12
  632. data/docs/UploadCouponCodesResponse.md +30 -14
  633. data/docs/User.md +44 -21
  634. data/docs/UserApi.md +823 -558
  635. data/docs/UserGroupMembership.md +22 -10
  636. data/docs/UserLogin.md +24 -11
  637. data/docs/UserLoginsResponse.md +26 -12
  638. data/docs/UserResponse.md +26 -12
  639. data/docs/UsersResponse.md +26 -12
  640. data/docs/VerificationRecord.md +22 -10
  641. data/docs/Warning.md +20 -9
  642. data/docs/Webhook.md +52 -26
  643. data/docs/WebhookApi.md +636 -447
  644. data/docs/WebhookEventCategory.md +26 -12
  645. data/docs/WebhookEventSubscription.md +34 -17
  646. data/docs/WebhookLog.md +38 -19
  647. data/docs/WebhookLogResponse.md +26 -12
  648. data/docs/WebhookLogSummariesResponse.md +26 -12
  649. data/docs/WebhookLogSummary.md +22 -10
  650. data/docs/WebhookResponse.md +26 -12
  651. data/docs/WebhookSampleRequest.md +24 -0
  652. data/docs/WebhookSampleRequestResponse.md +26 -0
  653. data/docs/WebhooksResponse.md +26 -12
  654. data/docs/Weight.md +20 -9
  655. data/git_push.sh +57 -55
  656. data/lib/ultracart_api/api/affiliate_api.rb +191 -164
  657. data/lib/ultracart_api/api/auto_order_api.rb +672 -770
  658. data/lib/ultracart_api/api/channel_partner_api.rb +370 -920
  659. data/lib/ultracart_api/api/chargeback_api.rb +410 -0
  660. data/lib/ultracart_api/api/checkout_api.rb +1341 -1111
  661. data/lib/ultracart_api/api/coupon_api.rb +1390 -1161
  662. data/lib/ultracart_api/api/customer_api.rb +1292 -1523
  663. data/lib/ultracart_api/api/fulfillment_api.rb +452 -381
  664. data/lib/ultracart_api/api/gift_certificate_api.rb +594 -502
  665. data/lib/ultracart_api/api/integration_log_api.rb +404 -350
  666. data/lib/ultracart_api/api/item_api.rb +686 -1412
  667. data/lib/ultracart_api/api/oauth_api.rb +198 -171
  668. data/lib/ultracart_api/api/order_api.rb +1728 -1878
  669. data/lib/ultracart_api/api/sso_api.rb +289 -243
  670. data/lib/ultracart_api/api/storefront_api.rb +11407 -10636
  671. data/lib/ultracart_api/api/tax_api.rb +1916 -1580
  672. data/lib/ultracart_api/api/user_api.rb +755 -634
  673. data/lib/ultracart_api/api/webhook_api.rb +601 -514
  674. data/lib/ultracart_api/api_client.rb +399 -400
  675. data/lib/ultracart_api/api_error.rb +57 -38
  676. data/lib/ultracart_api/configuration.rb +302 -229
  677. data/lib/ultracart_api/models/accounts_receivable_retry_config.rb +364 -341
  678. data/lib/ultracart_api/models/accounts_receivable_retry_config_response.rb +287 -252
  679. data/lib/ultracart_api/models/accounts_receivable_retry_day_activity.rb +240 -205
  680. data/lib/ultracart_api/models/accounts_receivable_retry_stat_account.rb +250 -215
  681. data/lib/ultracart_api/models/accounts_receivable_retry_stat_metrics.rb +309 -274
  682. data/lib/ultracart_api/models/accounts_receivable_retry_stat_revenue.rb +228 -193
  683. data/lib/ultracart_api/models/accounts_receivable_retry_stats_response.rb +267 -232
  684. data/lib/ultracart_api/models/activity.rb +264 -247
  685. data/lib/ultracart_api/models/add_library_item_request.rb +324 -289
  686. data/lib/ultracart_api/models/adjust_internal_certificate_request.rb +270 -235
  687. data/lib/ultracart_api/models/adjust_internal_certificate_response.rb +267 -232
  688. data/lib/ultracart_api/models/affiliate_click.rb +319 -304
  689. data/lib/ultracart_api/models/affiliate_click_query.rb +270 -235
  690. data/lib/ultracart_api/models/affiliate_clicks_response.rb +259 -224
  691. data/lib/ultracart_api/models/affiliate_ledger.rb +431 -396
  692. data/lib/ultracart_api/models/affiliate_ledger_query.rb +270 -235
  693. data/lib/ultracart_api/models/affiliate_ledgers_response.rb +259 -224
  694. data/lib/ultracart_api/models/affiliate_link.rb +408 -373
  695. data/lib/ultracart_api/models/api_user_application_profile.rb +260 -225
  696. data/lib/ultracart_api/models/apply_library_item_request.rb +250 -215
  697. data/lib/ultracart_api/models/apply_library_item_response.rb +319 -284
  698. data/lib/ultracart_api/models/auto_order.rb +469 -485
  699. data/lib/ultracart_api/models/auto_order_item.rb +487 -492
  700. data/lib/ultracart_api/models/auto_order_item_future_schedule.rb +250 -215
  701. data/lib/ultracart_api/models/auto_order_item_option.rb +260 -225
  702. data/lib/ultracart_api/models/auto_order_item_simple_schedule.rb +274 -239
  703. data/lib/ultracart_api/models/auto_order_log.rb +230 -195
  704. data/lib/ultracart_api/models/auto_order_query.rb +480 -445
  705. data/lib/ultracart_api/models/auto_order_query_batch.rb +222 -187
  706. data/lib/ultracart_api/models/auto_order_response.rb +256 -221
  707. data/lib/ultracart_api/models/auto_orders_request.rb +222 -187
  708. data/lib/ultracart_api/models/auto_orders_response.rb +258 -223
  709. data/lib/ultracart_api/models/avalara_config.rb +340 -305
  710. data/lib/ultracart_api/models/base_response.rb +247 -212
  711. data/lib/ultracart_api/models/browser.rb +237 -202
  712. data/lib/ultracart_api/models/browser_device.rb +219 -184
  713. data/lib/ultracart_api/models/browser_os.rb +255 -220
  714. data/lib/ultracart_api/models/browser_user_agent.rb +246 -211
  715. data/lib/ultracart_api/models/cart.rb +506 -471
  716. data/lib/ultracart_api/models/cart_affiliate.rb +245 -210
  717. data/lib/ultracart_api/models/cart_affirm_checkout_response.rb +232 -197
  718. data/lib/ultracart_api/models/cart_billing.rb +572 -587
  719. data/lib/ultracart_api/models/cart_buysafe.rb +269 -234
  720. data/lib/ultracart_api/models/cart_checkout.rb +500 -550
  721. data/lib/ultracart_api/models/cart_coupon.rb +220 -185
  722. data/lib/ultracart_api/models/cart_currency_conversion.rb +232 -197
  723. data/lib/ultracart_api/models/cart_customer_profile.rb +438 -413
  724. data/lib/ultracart_api/models/cart_customer_profile_address.rb +350 -315
  725. data/lib/ultracart_api/models/cart_customer_profile_credit_card.rb +304 -269
  726. data/lib/ultracart_api/models/cart_finalize_order_request.rb +228 -193
  727. data/lib/ultracart_api/models/cart_finalize_order_request_options.rb +355 -320
  728. data/lib/ultracart_api/models/cart_finalize_order_response.rb +260 -225
  729. data/lib/ultracart_api/models/cart_gift.rb +313 -278
  730. data/lib/ultracart_api/models/cart_gift_certificate.rb +238 -203
  731. data/lib/ultracart_api/models/cart_item.rb +504 -481
  732. data/lib/ultracart_api/models/cart_item_attribute.rb +240 -205
  733. data/lib/ultracart_api/models/cart_item_multimedia.rb +336 -301
  734. data/lib/ultracart_api/models/cart_item_multimedia_thumbnail.rb +260 -225
  735. data/lib/ultracart_api/models/cart_item_option.rb +378 -343
  736. data/lib/ultracart_api/models/cart_item_option_value.rb +258 -223
  737. data/lib/ultracart_api/models/cart_item_physical.rb +246 -211
  738. data/lib/ultracart_api/models/cart_item_variation_selection.rb +230 -195
  739. data/lib/ultracart_api/models/cart_kit_component_option.rb +398 -363
  740. data/lib/ultracart_api/models/cart_marketing.rb +230 -205
  741. data/lib/ultracart_api/models/cart_payment.rb +275 -249
  742. data/lib/ultracart_api/models/cart_payment_affirm.rb +220 -185
  743. data/lib/ultracart_api/models/cart_payment_amazon.rb +220 -185
  744. data/lib/ultracart_api/models/cart_payment_check.rb +220 -185
  745. data/lib/ultracart_api/models/cart_payment_credit_card.rb +300 -265
  746. data/lib/ultracart_api/models/cart_payment_purchase_order.rb +220 -185
  747. data/lib/ultracart_api/models/cart_profile_login_request.rb +239 -204
  748. data/lib/ultracart_api/models/cart_profile_login_response.rb +231 -196
  749. data/lib/ultracart_api/models/cart_profile_register_request.rb +229 -194
  750. data/lib/ultracart_api/models/cart_profile_register_response.rb +231 -196
  751. data/lib/ultracart_api/models/cart_property.rb +280 -245
  752. data/lib/ultracart_api/models/cart_response.rb +231 -196
  753. data/lib/ultracart_api/models/cart_settings.rb +264 -229
  754. data/lib/ultracart_api/models/cart_settings_billing.rb +222 -187
  755. data/lib/ultracart_api/models/cart_settings_gift.rb +251 -216
  756. data/lib/ultracart_api/models/cart_settings_gift_wrap.rb +239 -204
  757. data/lib/ultracart_api/models/cart_settings_payment.rb +337 -302
  758. data/lib/ultracart_api/models/cart_settings_payment_amazon.rb +240 -205
  759. data/lib/ultracart_api/models/cart_settings_payment_credit_card.rb +242 -217
  760. data/lib/ultracart_api/models/cart_settings_payment_pay_pal.rb +260 -225
  761. data/lib/ultracart_api/models/cart_settings_province.rb +228 -193
  762. data/lib/ultracart_api/models/cart_settings_shipping.rb +262 -227
  763. data/lib/ultracart_api/models/cart_settings_shipping_calendar.rb +264 -229
  764. data/lib/ultracart_api/models/cart_settings_shipping_estimate.rb +345 -310
  765. data/lib/ultracart_api/models/cart_settings_taxes.rb +221 -186
  766. data/lib/ultracart_api/models/cart_settings_terms.rb +230 -195
  767. data/lib/ultracart_api/models/cart_shipping.rb +625 -590
  768. data/lib/ultracart_api/models/cart_summary.rb +354 -356
  769. data/lib/ultracart_api/models/cart_taxes.rb +255 -220
  770. data/lib/ultracart_api/models/cart_upsell_after.rb +255 -240
  771. data/lib/ultracart_api/models/cart_validation_request.rb +231 -196
  772. data/lib/ultracart_api/models/cart_validation_response.rb +231 -196
  773. data/lib/ultracart_api/models/channel_partner_cancel_response.rb +259 -224
  774. data/lib/ultracart_api/models/channel_partner_estimate_shipping_response.rb +259 -224
  775. data/lib/ultracart_api/models/channel_partner_estimate_tax_response.rb +256 -221
  776. data/lib/ultracart_api/models/channel_partner_import_response.rb +281 -246
  777. data/lib/ultracart_api/models/channel_partner_order.rb +1604 -1723
  778. data/lib/ultracart_api/models/channel_partner_order_item.rb +331 -308
  779. data/lib/ultracart_api/models/channel_partner_order_item_option.rb +230 -195
  780. data/lib/ultracart_api/models/channel_partner_order_transaction.rb +232 -197
  781. data/lib/ultracart_api/models/channel_partner_order_transaction_detail.rb +230 -195
  782. data/lib/ultracart_api/models/channel_partner_shipping_estimate.rb +230 -195
  783. data/lib/ultracart_api/models/chargeback_dispute.rb +649 -0
  784. data/lib/ultracart_api/models/{conversation_pbx_customer_snapshot_response.rb → chargeback_dispute_response.rb} +256 -245
  785. data/lib/ultracart_api/models/{conversation_pbx_audio_usage_response.rb → chargeback_disputes_response.rb} +258 -245
  786. data/lib/ultracart_api/models/checkout_allowed_countries_response.rb +221 -186
  787. data/lib/ultracart_api/models/checkout_handoff_request.rb +323 -288
  788. data/lib/ultracart_api/models/checkout_handoff_response.rb +241 -206
  789. data/lib/ultracart_api/models/checkout_setup_browser_key_request.rb +222 -187
  790. data/lib/ultracart_api/models/checkout_setup_browser_key_response.rb +220 -185
  791. data/lib/ultracart_api/models/checkout_state_province_response.rb +221 -186
  792. data/lib/ultracart_api/models/city_state_zip.rb +255 -220
  793. data/lib/ultracart_api/models/countries_response.rb +221 -186
  794. data/lib/ultracart_api/models/country.rb +260 -225
  795. data/lib/ultracart_api/models/coupon.rb +864 -917
  796. data/lib/ultracart_api/models/coupon_amount_off_items.rb +267 -244
  797. data/lib/ultracart_api/models/coupon_amount_off_shipping.rb +257 -222
  798. data/lib/ultracart_api/models/coupon_amount_off_shipping_with_items_purchase.rb +269 -234
  799. data/lib/ultracart_api/models/coupon_amount_off_subtotal.rb +245 -210
  800. data/lib/ultracart_api/models/coupon_amount_off_subtotal_and_shipping.rb +245 -210
  801. data/lib/ultracart_api/models/coupon_amount_off_subtotal_free_shipping_with_purchase.rb +267 -232
  802. data/lib/ultracart_api/models/coupon_amount_off_subtotal_with_block_purchase.rb +265 -230
  803. data/lib/ultracart_api/models/coupon_amount_off_subtotal_with_items_purchase.rb +267 -232
  804. data/lib/ultracart_api/models/coupon_amount_off_subtotal_with_purchase.rb +255 -220
  805. data/lib/ultracart_api/models/coupon_amount_shipping_with_subtotal.rb +267 -232
  806. data/lib/ultracart_api/models/coupon_auto_apply_condition.rb +239 -204
  807. data/lib/ultracart_api/models/coupon_auto_apply_conditions.rb +269 -234
  808. data/lib/ultracart_api/models/coupon_automatically_apply_coupon_codes.rb +222 -187
  809. data/lib/ultracart_api/models/coupon_buy_one_get_one_limit.rb +232 -209
  810. data/lib/ultracart_api/models/coupon_codes_request.rb +277 -242
  811. data/lib/ultracart_api/models/coupon_codes_response.rb +269 -234
  812. data/lib/ultracart_api/models/coupon_deletes_request.rb +234 -199
  813. data/lib/ultracart_api/models/coupon_discount_item_with_item_purchase.rb +275 -264
  814. data/lib/ultracart_api/models/coupon_discount_items.rb +267 -232
  815. data/lib/ultracart_api/models/coupon_editor_values.rb +330 -307
  816. data/lib/ultracart_api/models/coupon_exists_response.rb +267 -232
  817. data/lib/ultracart_api/models/coupon_free_item_and_shipping_with_subtotal.rb +279 -244
  818. data/lib/ultracart_api/models/coupon_free_item_with_item_purchase.rb +254 -243
  819. data/lib/ultracart_api/models/coupon_free_item_with_subtotal.rb +267 -232
  820. data/lib/ultracart_api/models/coupon_free_items_with_item_purchase.rb +260 -225
  821. data/lib/ultracart_api/models/coupon_free_items_with_mix_match_purchase.rb +260 -225
  822. data/lib/ultracart_api/models/coupon_free_shipping.rb +222 -187
  823. data/lib/ultracart_api/models/coupon_free_shipping_specific_items.rb +222 -187
  824. data/lib/ultracart_api/models/coupon_free_shipping_with_items_purchase.rb +234 -199
  825. data/lib/ultracart_api/models/coupon_free_shipping_with_subtotal.rb +257 -222
  826. data/lib/ultracart_api/models/coupon_item_search_result.rb +290 -255
  827. data/lib/ultracart_api/models/coupon_item_search_results_response.rb +259 -224
  828. data/lib/ultracart_api/models/coupon_multiple_amounts_off_items.rb +232 -197
  829. data/lib/ultracart_api/models/coupon_percent_off_item_with_items_quantity_purchase.rb +264 -253
  830. data/lib/ultracart_api/models/coupon_percent_off_items.rb +254 -243
  831. data/lib/ultracart_api/models/coupon_percent_off_items_and_free_shipping.rb +244 -233
  832. data/lib/ultracart_api/models/coupon_percent_off_items_with_items_purchase.rb +254 -243
  833. data/lib/ultracart_api/models/coupon_percent_off_msrp_items.rb +254 -239
  834. data/lib/ultracart_api/models/coupon_percent_off_retail_price_items.rb +254 -219
  835. data/lib/ultracart_api/models/coupon_percent_off_shipping.rb +232 -197
  836. data/lib/ultracart_api/models/coupon_percent_off_subtotal.rb +220 -185
  837. data/lib/ultracart_api/models/coupon_percent_off_subtotal_and_free_shipping.rb +232 -197
  838. data/lib/ultracart_api/models/coupon_percent_off_subtotal_limit.rb +255 -220
  839. data/lib/ultracart_api/models/coupon_percent_off_subtotal_with_items_purchase.rb +232 -197
  840. data/lib/ultracart_api/models/coupon_percent_off_subtotal_with_subtotal.rb +255 -220
  841. data/lib/ultracart_api/models/coupon_query.rb +310 -275
  842. data/lib/ultracart_api/models/coupon_response.rb +268 -233
  843. data/lib/ultracart_api/models/coupon_restriction.rb +246 -211
  844. data/lib/ultracart_api/models/coupon_tier_amount.rb +255 -220
  845. data/lib/ultracart_api/models/coupon_tier_item_discount.rb +232 -197
  846. data/lib/ultracart_api/models/coupon_tier_percent.rb +255 -220
  847. data/lib/ultracart_api/models/coupon_tier_quantity_amount.rb +255 -220
  848. data/lib/ultracart_api/models/coupon_tier_quantity_percent.rb +255 -220
  849. data/lib/ultracart_api/models/coupon_tiered_amount_off_items.rb +244 -221
  850. data/lib/ultracart_api/models/coupon_tiered_amount_off_subtotal.rb +234 -199
  851. data/lib/ultracart_api/models/coupon_tiered_percent_off_items.rb +244 -221
  852. data/lib/ultracart_api/models/coupon_tiered_percent_off_shipping.rb +259 -224
  853. data/lib/ultracart_api/models/coupon_tiered_percent_off_subtotal.rb +234 -199
  854. data/lib/ultracart_api/models/coupon_type.rb +230 -195
  855. data/lib/ultracart_api/models/coupons_request.rb +222 -187
  856. data/lib/ultracart_api/models/coupons_response.rb +258 -223
  857. data/lib/ultracart_api/models/currency.rb +260 -225
  858. data/lib/ultracart_api/models/customer.rb +978 -994
  859. data/lib/ultracart_api/models/customer_activity.rb +254 -255
  860. data/lib/ultracart_api/models/customer_affiliate.rb +250 -215
  861. data/lib/ultracart_api/models/customer_attachment.rb +260 -225
  862. data/lib/ultracart_api/models/customer_billing.rb +575 -540
  863. data/lib/ultracart_api/models/customer_card.rb +290 -255
  864. data/lib/ultracart_api/models/customer_editor_values.rb +328 -317
  865. data/lib/ultracart_api/models/customer_email.rb +300 -265
  866. data/lib/ultracart_api/models/customer_email_list_changes.rb +234 -199
  867. data/lib/ultracart_api/models/customer_loyalty.rb +283 -248
  868. data/lib/ultracart_api/models/customer_loyalty_ledger.rb +360 -325
  869. data/lib/ultracart_api/models/customer_loyalty_redemption.rb +340 -305
  870. data/lib/ultracart_api/models/customer_orders_summary.rb +250 -215
  871. data/lib/ultracart_api/models/customer_pricing_tier.rb +245 -210
  872. data/lib/ultracart_api/models/customer_privacy.rb +250 -215
  873. data/lib/ultracart_api/models/customer_query.rb +789 -766
  874. data/lib/ultracart_api/models/customer_quotes_summary.rb +250 -215
  875. data/lib/ultracart_api/models/customer_response.rb +256 -221
  876. data/lib/ultracart_api/models/customer_reviewer.rb +310 -275
  877. data/lib/ultracart_api/models/customer_shipping.rb +575 -540
  878. data/lib/ultracart_api/models/customer_software_entitlement.rb +365 -330
  879. data/lib/ultracart_api/models/customer_store_credit.rb +274 -239
  880. data/lib/ultracart_api/models/customer_store_credit_add_request.rb +250 -215
  881. data/lib/ultracart_api/models/customer_store_credit_ledger_entry.rb +295 -260
  882. data/lib/ultracart_api/models/customer_store_credit_response.rb +256 -221
  883. data/lib/ultracart_api/models/customer_tag.rb +235 -200
  884. data/lib/ultracart_api/models/customer_tax_codes.rb +260 -225
  885. data/lib/ultracart_api/models/customers_response.rb +258 -223
  886. data/lib/ultracart_api/models/data_tables_server_side_response.rb +248 -213
  887. data/lib/ultracart_api/models/distance.rb +264 -229
  888. data/lib/ultracart_api/models/distribution_center.rb +559 -674
  889. data/lib/ultracart_api/models/distribution_centers_response.rb +258 -223
  890. data/lib/ultracart_api/models/email_base_template_list_response.rb +221 -186
  891. data/lib/ultracart_api/models/email_campaign.rb +467 -472
  892. data/lib/ultracart_api/models/email_campaign_folder.rb +275 -240
  893. data/lib/ultracart_api/models/email_campaign_folder_response.rb +256 -221
  894. data/lib/ultracart_api/models/email_campaign_folders_response.rb +258 -223
  895. data/lib/ultracart_api/models/email_campaign_response.rb +256 -221
  896. data/lib/ultracart_api/models/email_campaigns_response.rb +258 -223
  897. data/lib/ultracart_api/models/email_click.rb +230 -195
  898. data/lib/ultracart_api/models/email_clicks_response.rb +258 -223
  899. data/lib/ultracart_api/models/email_commseq.rb +252 -217
  900. data/lib/ultracart_api/models/email_commseq_email.rb +470 -507
  901. data/lib/ultracart_api/models/email_commseq_email_response.rb +256 -221
  902. data/lib/ultracart_api/models/email_commseq_email_send_test_request.rb +304 -269
  903. data/lib/ultracart_api/models/email_commseq_email_send_test_response.rb +247 -212
  904. data/lib/ultracart_api/models/email_commseq_emails_request.rb +258 -223
  905. data/lib/ultracart_api/models/email_commseq_emails_response.rb +258 -223
  906. data/lib/ultracart_api/models/email_commseq_postcard.rb +340 -305
  907. data/lib/ultracart_api/models/email_commseq_postcard_response.rb +256 -221
  908. data/lib/ultracart_api/models/email_commseq_postcard_send_test_request.rb +329 -294
  909. data/lib/ultracart_api/models/email_commseq_postcard_send_test_response.rb +274 -239
  910. data/lib/ultracart_api/models/email_commseq_postcards_request.rb +221 -186
  911. data/lib/ultracart_api/models/email_commseq_postcards_response.rb +258 -223
  912. data/lib/ultracart_api/models/email_commseq_response.rb +256 -221
  913. data/lib/ultracart_api/models/email_commseq_stat.rb +580 -545
  914. data/lib/ultracart_api/models/email_commseq_stat_response.rb +256 -221
  915. data/lib/ultracart_api/models/email_commseq_step.rb +348 -313
  916. data/lib/ultracart_api/models/email_commseq_step_log.rb +240 -205
  917. data/lib/ultracart_api/models/email_commseq_step_logs_response.rb +258 -223
  918. data/lib/ultracart_api/models/email_commseq_webhook_send_test_request.rb +275 -240
  919. data/lib/ultracart_api/models/email_commseq_webhook_send_test_response.rb +277 -242
  920. data/lib/ultracart_api/models/email_commseqs_response.rb +258 -223
  921. data/lib/ultracart_api/models/email_customer.rb +292 -257
  922. data/lib/ultracart_api/models/email_customer_editor_url_response.rb +256 -221
  923. data/lib/ultracart_api/models/email_customers_response.rb +262 -227
  924. data/lib/ultracart_api/models/email_dashboard_activity.rb +280 -245
  925. data/lib/ultracart_api/models/email_dashboard_activity_response.rb +258 -223
  926. data/lib/ultracart_api/models/email_dashboard_stats_response.rb +258 -223
  927. data/lib/ultracart_api/models/email_domain.rb +329 -294
  928. data/lib/ultracart_api/models/email_editor_token_response.rb +256 -221
  929. data/lib/ultracart_api/models/email_flow.rb +505 -500
  930. data/lib/ultracart_api/models/email_flow_back_populate_request.rb +230 -195
  931. data/lib/ultracart_api/models/email_flow_back_populate_response.rb +247 -212
  932. data/lib/ultracart_api/models/email_flow_folder.rb +275 -240
  933. data/lib/ultracart_api/models/email_flow_folder_response.rb +256 -221
  934. data/lib/ultracart_api/models/email_flow_folders_response.rb +258 -223
  935. data/lib/ultracart_api/models/email_flow_response.rb +256 -221
  936. data/lib/ultracart_api/models/email_flows_response.rb +258 -223
  937. data/lib/ultracart_api/models/email_global_settings.rb +219 -184
  938. data/lib/ultracart_api/models/email_global_settings_response.rb +256 -221
  939. data/lib/ultracart_api/models/email_global_unsubscribe_request.rb +219 -184
  940. data/lib/ultracart_api/models/email_global_unsubscribe_response.rb +219 -184
  941. data/lib/ultracart_api/models/email_histogram_property_names_response.rb +221 -186
  942. data/lib/ultracart_api/models/email_histogram_property_values_response.rb +221 -186
  943. data/lib/ultracart_api/models/email_list.rb +347 -312
  944. data/lib/ultracart_api/models/email_list_archive_response.rb +256 -221
  945. data/lib/ultracart_api/models/email_list_customer.rb +250 -215
  946. data/lib/ultracart_api/models/email_list_customers_response.rb +262 -227
  947. data/lib/ultracart_api/models/email_list_response.rb +256 -221
  948. data/lib/ultracart_api/models/email_list_segment_folder.rb +275 -240
  949. data/lib/ultracart_api/models/email_list_segment_folder_response.rb +256 -221
  950. data/lib/ultracart_api/models/email_list_segment_folders_response.rb +258 -223
  951. data/lib/ultracart_api/models/email_list_segment_membership.rb +250 -215
  952. data/lib/ultracart_api/models/email_list_segment_used_by.rb +240 -205
  953. data/lib/ultracart_api/models/email_list_subscribe_response.rb +228 -193
  954. data/lib/ultracart_api/models/email_lists_response.rb +258 -223
  955. data/lib/ultracart_api/models/email_order.rb +249 -214
  956. data/lib/ultracart_api/models/email_orders_response.rb +258 -223
  957. data/lib/ultracart_api/models/email_performance.rb +475 -440
  958. data/lib/ultracart_api/models/email_performance_customer_histogram.rb +222 -187
  959. data/lib/ultracart_api/models/email_performance_customer_histogram_period.rb +260 -225
  960. data/lib/ultracart_api/models/email_performance_daily.rb +280 -245
  961. data/lib/ultracart_api/models/email_performance_response.rb +256 -221
  962. data/lib/ultracart_api/models/email_plan.rb +365 -330
  963. data/lib/ultracart_api/models/email_plan_additional.rb +291 -256
  964. data/lib/ultracart_api/models/email_plan_response.rb +256 -221
  965. data/lib/ultracart_api/models/email_postcard_stat.rb +531 -496
  966. data/lib/ultracart_api/models/email_segment.rb +445 -420
  967. data/lib/ultracart_api/models/email_segment_archive_response.rb +256 -221
  968. data/lib/ultracart_api/models/email_segment_customer.rb +250 -215
  969. data/lib/ultracart_api/models/email_segment_customers_response.rb +262 -227
  970. data/lib/ultracart_api/models/email_segment_download_prepare_response.rb +283 -248
  971. data/lib/ultracart_api/models/email_segment_response.rb +256 -221
  972. data/lib/ultracart_api/models/email_segments_response.rb +258 -223
  973. data/lib/ultracart_api/models/email_sending_domain_response.rb +256 -221
  974. data/lib/ultracart_api/models/email_sending_domains_response.rb +258 -223
  975. data/lib/ultracart_api/models/email_settings.rb +318 -351
  976. data/lib/ultracart_api/models/email_settings_response.rb +256 -221
  977. data/lib/ultracart_api/models/email_stat.rb +591 -556
  978. data/lib/ultracart_api/models/email_stat_postcard_summary_request.rb +230 -195
  979. data/lib/ultracart_api/models/email_stat_postcard_summary_response.rb +258 -223
  980. data/lib/ultracart_api/models/email_stat_summary_request.rb +241 -206
  981. data/lib/ultracart_api/models/email_stat_summary_response.rb +258 -223
  982. data/lib/ultracart_api/models/email_step_stat.rb +410 -475
  983. data/lib/ultracart_api/models/email_step_stat_request.rb +230 -195
  984. data/lib/ultracart_api/models/email_step_stat_response.rb +258 -223
  985. data/lib/ultracart_api/models/email_step_waiting_request.rb +221 -186
  986. data/lib/ultracart_api/models/email_step_waiting_response.rb +221 -186
  987. data/lib/ultracart_api/models/email_template.rb +365 -330
  988. data/lib/ultracart_api/models/email_templates_response.rb +258 -223
  989. data/lib/ultracart_api/models/email_third_party_list.rb +230 -195
  990. data/lib/ultracart_api/models/email_third_party_list_import_request.rb +222 -187
  991. data/lib/ultracart_api/models/email_third_party_provider.rb +324 -289
  992. data/lib/ultracart_api/models/email_third_party_providers_response.rb +258 -223
  993. data/lib/ultracart_api/models/email_third_party_tag.rb +230 -195
  994. data/lib/ultracart_api/models/email_verify_token_request.rb +230 -195
  995. data/lib/ultracart_api/models/email_verify_token_response.rb +257 -222
  996. data/lib/ultracart_api/models/email_verify_token_validate_request.rb +220 -185
  997. data/lib/ultracart_api/models/email_verify_token_validate_response.rb +247 -212
  998. data/lib/ultracart_api/models/email_webhook_editor_values_response.rb +278 -243
  999. data/lib/ultracart_api/models/error.rb +260 -225
  1000. data/lib/ultracart_api/models/error_response.rb +247 -212
  1001. data/lib/ultracart_api/models/experiment.rb +426 -463
  1002. data/lib/ultracart_api/models/experiment_response.rb +256 -221
  1003. data/lib/ultracart_api/models/experiment_variation.rb +432 -407
  1004. data/lib/ultracart_api/models/experiment_variation_stat.rb +320 -307
  1005. data/lib/ultracart_api/models/experiments_response.rb +258 -223
  1006. data/lib/ultracart_api/models/fulfillment_inventory.rb +228 -193
  1007. data/lib/ultracart_api/models/fulfillment_shipment.rb +262 -227
  1008. data/lib/ultracart_api/models/geo_point.rb +228 -193
  1009. data/lib/ultracart_api/models/geocode_request.rb +260 -225
  1010. data/lib/ultracart_api/models/geocode_response.rb +265 -230
  1011. data/lib/ultracart_api/models/gift_certificate.rb +367 -332
  1012. data/lib/ultracart_api/models/gift_certificate_create_request.rb +260 -225
  1013. data/lib/ultracart_api/models/gift_certificate_ledger_entry.rb +285 -250
  1014. data/lib/ultracart_api/models/gift_certificate_query.rb +300 -265
  1015. data/lib/ultracart_api/models/gift_certificate_response.rb +256 -221
  1016. data/lib/ultracart_api/models/gift_certificates_response.rb +258 -223
  1017. data/lib/ultracart_api/models/group.rb +266 -231
  1018. data/lib/ultracart_api/models/group_response.rb +256 -221
  1019. data/lib/ultracart_api/models/group_user_membership.rb +260 -225
  1020. data/lib/ultracart_api/models/groups_response.rb +258 -223
  1021. data/lib/ultracart_api/models/http_header.rb +230 -195
  1022. data/lib/ultracart_api/models/integration_log.rb +379 -355
  1023. data/lib/ultracart_api/models/integration_log_file.rb +246 -211
  1024. data/lib/ultracart_api/models/integration_log_log.rb +228 -193
  1025. data/lib/ultracart_api/models/integration_log_query_filter_values.rb +340 -305
  1026. data/lib/ultracart_api/models/integration_log_query_request.rb +333 -329
  1027. data/lib/ultracart_api/models/integration_log_query_response.rb +267 -232
  1028. data/lib/ultracart_api/models/integration_log_response.rb +256 -221
  1029. data/lib/ultracart_api/models/integration_log_summary.rb +291 -256
  1030. data/lib/ultracart_api/models/integration_log_summary_query_request.rb +230 -195
  1031. data/lib/ultracart_api/models/integration_log_summary_query_response.rb +258 -223
  1032. data/lib/ultracart_api/models/item.rb +748 -713
  1033. data/lib/ultracart_api/models/item_accounting.rb +260 -225
  1034. data/lib/ultracart_api/models/item_amember.rb +245 -210
  1035. data/lib/ultracart_api/models/item_auto_order.rb +403 -418
  1036. data/lib/ultracart_api/models/item_auto_order_step.rb +413 -398
  1037. data/lib/ultracart_api/models/item_auto_order_step_arbitrary_unit_cost_schedule.rb +230 -195
  1038. data/lib/ultracart_api/models/item_auto_order_step_grandfather_pricing.rb +230 -195
  1039. data/lib/ultracart_api/models/item_cc_bill.rb +270 -235
  1040. data/lib/ultracart_api/models/item_channel_partner_mapping.rb +445 -410
  1041. data/lib/ultracart_api/models/item_chargeback.rb +234 -199
  1042. data/lib/ultracart_api/models/item_chargeback_addendum.rb +250 -215
  1043. data/lib/ultracart_api/models/item_chargeback_adjustment_request.rb +240 -205
  1044. data/lib/ultracart_api/models/item_checkout.rb +265 -230
  1045. data/lib/ultracart_api/models/item_content.rb +361 -356
  1046. data/lib/ultracart_api/models/item_content_assignment.rb +285 -250
  1047. data/lib/ultracart_api/models/item_content_attribute.rb +280 -245
  1048. data/lib/ultracart_api/models/item_content_multimedia.rb +441 -406
  1049. data/lib/ultracart_api/models/item_content_multimedia_thumbnail.rb +270 -235
  1050. data/lib/ultracart_api/models/item_digital_delivery.rb +317 -282
  1051. data/lib/ultracart_api/models/item_digital_item.rb +305 -334
  1052. data/lib/ultracart_api/models/item_ebay.rb +901 -866
  1053. data/lib/ultracart_api/models/item_ebay_category_specific.rb +230 -195
  1054. data/lib/ultracart_api/models/item_ebay_market_listing.rb +260 -225
  1055. data/lib/ultracart_api/models/item_ebay_market_place_analysis.rb +311 -276
  1056. data/lib/ultracart_api/models/item_email_notifications.rb +230 -195
  1057. data/lib/ultracart_api/models/item_enrollment123.rb +220 -185
  1058. data/lib/ultracart_api/models/item_fulfillment_addon.rb +250 -225
  1059. data/lib/ultracart_api/models/item_gift_certificate.rb +230 -195
  1060. data/lib/ultracart_api/models/item_google_product_search.rb +1289 -1254
  1061. data/lib/ultracart_api/models/item_identifiers.rb +310 -375
  1062. data/lib/ultracart_api/models/item_instant_payment_notification.rb +270 -235
  1063. data/lib/ultracart_api/models/item_instant_payment_notifications.rb +222 -187
  1064. data/lib/ultracart_api/models/item_internal.rb +235 -200
  1065. data/lib/ultracart_api/models/item_kit_component.rb +260 -225
  1066. data/lib/ultracart_api/models/item_kit_definition.rb +222 -187
  1067. data/lib/ultracart_api/models/item_option.rb +416 -381
  1068. data/lib/ultracart_api/models/item_option_value.rb +409 -374
  1069. data/lib/ultracart_api/models/item_option_value_additional_item.rb +230 -195
  1070. data/lib/ultracart_api/models/item_option_value_digital_item.rb +230 -195
  1071. data/lib/ultracart_api/models/item_payment_processing.rb +264 -239
  1072. data/lib/ultracart_api/models/item_physical.rb +246 -211
  1073. data/lib/ultracart_api/models/item_pricing.rb +422 -387
  1074. data/lib/ultracart_api/models/item_pricing_tier.rb +261 -226
  1075. data/lib/ultracart_api/models/item_pricing_tier_discount.rb +230 -195
  1076. data/lib/ultracart_api/models/item_pricing_tier_limit.rb +240 -227
  1077. data/lib/ultracart_api/models/item_property.rb +270 -235
  1078. data/lib/ultracart_api/models/item_realtime_pricing.rb +240 -205
  1079. data/lib/ultracart_api/models/item_related.rb +242 -207
  1080. data/lib/ultracart_api/models/item_related_item.rb +274 -239
  1081. data/lib/ultracart_api/models/item_reporting.rb +232 -197
  1082. data/lib/ultracart_api/models/item_response.rb +256 -221
  1083. data/lib/ultracart_api/models/item_restriction.rb +292 -267
  1084. data/lib/ultracart_api/models/item_restriction_item.rb +274 -239
  1085. data/lib/ultracart_api/models/item_revguard.rb +280 -245
  1086. data/lib/ultracart_api/models/item_reviews.rb +300 -276
  1087. data/lib/ultracart_api/models/item_salesforce.rb +230 -195
  1088. data/lib/ultracart_api/models/item_shipping.rb +713 -688
  1089. data/lib/ultracart_api/models/item_shipping_case.rb +265 -230
  1090. data/lib/ultracart_api/models/item_shipping_destination_markup.rb +315 -290
  1091. data/lib/ultracart_api/models/item_shipping_destination_restriction.rb +304 -269
  1092. data/lib/ultracart_api/models/item_shipping_distribution_center.rb +380 -345
  1093. data/lib/ultracart_api/models/item_shipping_method.rb +394 -359
  1094. data/lib/ultracart_api/models/item_shipping_package_requirement.rb +230 -195
  1095. data/lib/ultracart_api/models/item_tag.rb +279 -244
  1096. data/lib/ultracart_api/models/item_tags.rb +222 -187
  1097. data/lib/ultracart_api/models/item_tax.rb +286 -251
  1098. data/lib/ultracart_api/models/item_tax_exemption.rb +335 -300
  1099. data/lib/ultracart_api/models/item_third_party_email_marketing.rb +302 -267
  1100. data/lib/ultracart_api/models/item_variant_item.rb +289 -254
  1101. data/lib/ultracart_api/models/item_variation.rb +292 -257
  1102. data/lib/ultracart_api/models/item_variation_option.rb +265 -230
  1103. data/lib/ultracart_api/models/item_wishlist_member.rb +255 -220
  1104. data/lib/ultracart_api/models/items_request.rb +222 -187
  1105. data/lib/ultracart_api/models/items_response.rb +259 -224
  1106. data/lib/ultracart_api/models/key_value.rb +240 -205
  1107. data/lib/ultracart_api/models/library_filter_values.rb +254 -219
  1108. data/lib/ultracart_api/models/library_filter_values_response.rb +256 -221
  1109. data/lib/ultracart_api/models/library_item.rb +606 -571
  1110. data/lib/ultracart_api/models/library_item_account.rb +237 -202
  1111. data/lib/ultracart_api/models/library_item_asset.rb +228 -193
  1112. data/lib/ultracart_api/models/library_item_attribute.rb +228 -193
  1113. data/lib/ultracart_api/models/library_item_email.rb +237 -202
  1114. data/lib/ultracart_api/models/library_item_published_meta.rb +290 -255
  1115. data/lib/ultracart_api/models/library_item_purchased_meta.rb +240 -205
  1116. data/lib/ultracart_api/models/library_item_query.rb +330 -295
  1117. data/lib/ultracart_api/models/library_item_response.rb +256 -221
  1118. data/lib/ultracart_api/models/library_item_screenshot.rb +228 -193
  1119. data/lib/ultracart_api/models/library_items_response.rb +259 -224
  1120. data/lib/ultracart_api/models/linked_account.rb +240 -205
  1121. data/lib/ultracart_api/models/list_segment_membership.rb +237 -202
  1122. data/lib/ultracart_api/models/lookup_request.rb +255 -229
  1123. data/lib/ultracart_api/models/lookup_response.rb +258 -223
  1124. data/lib/ultracart_api/models/mailgun.rb +219 -184
  1125. data/lib/ultracart_api/models/metric.rb +282 -247
  1126. data/lib/ultracart_api/models/notification.rb +322 -287
  1127. data/lib/ultracart_api/models/oauth_revoke_success_response.rb +230 -195
  1128. data/lib/ultracart_api/models/oauth_token_response.rb +321 -286
  1129. data/lib/ultracart_api/models/order.rb +604 -622
  1130. data/lib/ultracart_api/models/order_affiliate.rb +242 -207
  1131. data/lib/ultracart_api/models/order_affiliate_ledger.rb +334 -299
  1132. data/lib/ultracart_api/models/order_auto_order.rb +448 -413
  1133. data/lib/ultracart_api/models/order_billing.rb +597 -612
  1134. data/lib/ultracart_api/models/order_buysafe.rb +268 -233
  1135. data/lib/ultracart_api/models/order_by_token_query.rb +220 -185
  1136. data/lib/ultracart_api/models/order_channel_partner.rb +335 -300
  1137. data/lib/ultracart_api/models/order_checkout.rb +469 -509
  1138. data/lib/ultracart_api/models/order_coupon.rb +290 -255
  1139. data/lib/ultracart_api/models/order_digital_item.rb +290 -255
  1140. data/lib/ultracart_api/models/order_digital_order.rb +262 -227
  1141. data/lib/ultracart_api/models/order_edi.rb +265 -230
  1142. data/lib/ultracart_api/models/order_format.rb +404 -369
  1143. data/lib/ultracart_api/models/order_format_response.rb +232 -197
  1144. data/lib/ultracart_api/models/order_fraud_score.rb +444 -409
  1145. data/lib/ultracart_api/models/order_gift.rb +351 -316
  1146. data/lib/ultracart_api/models/order_gift_certificate.rb +239 -204
  1147. data/lib/ultracart_api/models/order_internal.rb +275 -252
  1148. data/lib/ultracart_api/models/order_item.rb +889 -1028
  1149. data/lib/ultracart_api/models/order_item_edi.rb +234 -199
  1150. data/lib/ultracart_api/models/order_item_edi_identification.rb +230 -195
  1151. data/lib/ultracart_api/models/order_item_edi_lot.rb +240 -205
  1152. data/lib/ultracart_api/models/order_item_option.rb +378 -343
  1153. data/lib/ultracart_api/models/order_item_option_file_attachment.rb +250 -215
  1154. data/lib/ultracart_api/models/order_item_property.rb +280 -245
  1155. data/lib/ultracart_api/models/order_item_tag.rb +235 -200
  1156. data/lib/ultracart_api/models/order_linked_shipment.rb +264 -229
  1157. data/lib/ultracart_api/models/order_marketing.rb +270 -245
  1158. data/lib/ultracart_api/models/order_packing_slip_response.rb +257 -222
  1159. data/lib/ultracart_api/models/order_payment.rb +432 -415
  1160. data/lib/ultracart_api/models/order_payment_check.rb +220 -185
  1161. data/lib/ultracart_api/models/order_payment_credit_card.rb +354 -328
  1162. data/lib/ultracart_api/models/order_payment_e_check.rb +476 -441
  1163. data/lib/ultracart_api/models/order_payment_insurance.rb +250 -215
  1164. data/lib/ultracart_api/models/order_payment_purchase_order.rb +220 -185
  1165. data/lib/ultracart_api/models/order_payment_transaction.rb +252 -227
  1166. data/lib/ultracart_api/models/order_payment_transaction_detail.rb +240 -205
  1167. data/lib/ultracart_api/models/order_process_payment_request.rb +230 -195
  1168. data/lib/ultracart_api/models/order_process_payment_response.rb +256 -221
  1169. data/lib/ultracart_api/models/order_property.rb +280 -280
  1170. data/lib/ultracart_api/models/order_query.rb +826 -843
  1171. data/lib/ultracart_api/models/order_query_batch.rb +222 -231
  1172. data/lib/ultracart_api/models/order_quote.rb +240 -205
  1173. data/lib/ultracart_api/models/order_replacement.rb +467 -432
  1174. data/lib/ultracart_api/models/order_replacement_item.rb +255 -220
  1175. data/lib/ultracart_api/models/order_replacement_response.rb +264 -229
  1176. data/lib/ultracart_api/models/order_response.rb +256 -221
  1177. data/lib/ultracart_api/models/order_salesforce.rb +220 -185
  1178. data/lib/ultracart_api/models/order_shipping.rb +770 -745
  1179. data/lib/ultracart_api/models/order_summary.rb +390 -411
  1180. data/lib/ultracart_api/models/order_tag.rb +235 -200
  1181. data/lib/ultracart_api/models/order_taxes.rb +395 -360
  1182. data/lib/ultracart_api/models/order_token_response.rb +257 -222
  1183. data/lib/ultracart_api/models/order_tracking_number_detail.rb +320 -285
  1184. data/lib/ultracart_api/models/order_tracking_number_details.rb +374 -339
  1185. data/lib/ultracart_api/models/orders_response.rb +259 -224
  1186. data/lib/ultracart_api/models/permission.rb +240 -205
  1187. data/lib/ultracart_api/models/pricing_tier.rb +533 -528
  1188. data/lib/ultracart_api/models/pricing_tier_notification.rb +270 -235
  1189. data/lib/ultracart_api/models/pricing_tiers_response.rb +259 -224
  1190. data/lib/ultracart_api/models/property.rb +228 -193
  1191. data/lib/ultracart_api/models/publish_library_item_request.rb +220 -185
  1192. data/lib/ultracart_api/models/register_affiliate_click_request.rb +270 -235
  1193. data/lib/ultracart_api/models/register_affiliate_click_response.rb +254 -219
  1194. data/lib/ultracart_api/models/response_metadata.rb +229 -194
  1195. data/lib/ultracart_api/models/result_set.rb +270 -235
  1196. data/lib/ultracart_api/models/screen_recording.rb +688 -653
  1197. data/lib/ultracart_api/models/screen_recording_ad_platform.rb +280 -245
  1198. data/lib/ultracart_api/models/screen_recording_filter.rb +758 -723
  1199. data/lib/ultracart_api/models/screen_recording_filter_geo_distance.rb +255 -220
  1200. data/lib/ultracart_api/models/screen_recording_filter_ip_search.rb +246 -211
  1201. data/lib/ultracart_api/models/screen_recording_filter_page_view.rb +369 -334
  1202. data/lib/ultracart_api/models/screen_recording_filter_page_view_event.rb +230 -195
  1203. data/lib/ultracart_api/models/screen_recording_filter_page_view_event_param.rb +255 -220
  1204. data/lib/ultracart_api/models/screen_recording_filter_page_view_param.rb +228 -193
  1205. data/lib/ultracart_api/models/screen_recording_filter_page_view_referrer_param.rb +228 -193
  1206. data/lib/ultracart_api/models/screen_recording_filter_range_big_decimal.rb +255 -220
  1207. data/lib/ultracart_api/models/screen_recording_filter_range_date.rb +230 -195
  1208. data/lib/ultracart_api/models/screen_recording_filter_range_integer.rb +255 -220
  1209. data/lib/ultracart_api/models/screen_recording_filter_string_search.rb +255 -220
  1210. data/lib/ultracart_api/models/screen_recording_filter_values.rb +435 -400
  1211. data/lib/ultracart_api/models/screen_recording_filter_values_event.rb +230 -195
  1212. data/lib/ultracart_api/models/screen_recording_filter_values_event_params.rb +263 -228
  1213. data/lib/ultracart_api/models/screen_recording_filter_values_page_param.rb +230 -195
  1214. data/lib/ultracart_api/models/screen_recording_filter_values_page_view.rb +272 -237
  1215. data/lib/ultracart_api/models/screen_recording_heatmap.rb +426 -391
  1216. data/lib/ultracart_api/models/screen_recording_heatmap_index_request.rb +219 -184
  1217. data/lib/ultracart_api/models/screen_recording_heatmap_index_response.rb +258 -223
  1218. data/lib/ultracart_api/models/screen_recording_heatmap_request.rb +239 -204
  1219. data/lib/ultracart_api/models/screen_recording_heatmap_reset.rb +219 -184
  1220. data/lib/ultracart_api/models/screen_recording_heatmap_response.rb +256 -221
  1221. data/lib/ultracart_api/models/screen_recording_heatmap_url.rb +266 -231
  1222. data/lib/ultracart_api/models/screen_recording_merchant_notes_request.rb +219 -184
  1223. data/lib/ultracart_api/models/screen_recording_multifield.rb +255 -220
  1224. data/lib/ultracart_api/models/screen_recording_page_view.rb +391 -356
  1225. data/lib/ultracart_api/models/screen_recording_page_view_data_response.rb +256 -221
  1226. data/lib/ultracart_api/models/screen_recording_page_view_event.rb +267 -232
  1227. data/lib/ultracart_api/models/screen_recording_page_view_event_parameter.rb +228 -193
  1228. data/lib/ultracart_api/models/screen_recording_page_view_parameter.rb +228 -193
  1229. data/lib/ultracart_api/models/screen_recording_query_request.rb +219 -184
  1230. data/lib/ultracart_api/models/screen_recording_query_response.rb +314 -279
  1231. data/lib/ultracart_api/models/screen_recording_response.rb +265 -230
  1232. data/lib/ultracart_api/models/screen_recording_segment.rb +302 -267
  1233. data/lib/ultracart_api/models/screen_recording_segment_response.rb +256 -221
  1234. data/lib/ultracart_api/models/screen_recording_segments_response.rb +258 -223
  1235. data/lib/ultracart_api/models/screen_recording_settings.rb +284 -249
  1236. data/lib/ultracart_api/models/screen_recording_settings_response.rb +256 -221
  1237. data/lib/ultracart_api/models/screen_recording_store_front.rb +228 -193
  1238. data/lib/ultracart_api/models/screen_recording_tags_request.rb +221 -186
  1239. data/lib/ultracart_api/models/screen_recording_tags_response.rb +258 -223
  1240. data/lib/ultracart_api/models/screen_recording_user_agent.rb +255 -220
  1241. data/lib/ultracart_api/models/screen_recording_user_agent_device.rb +219 -184
  1242. data/lib/ultracart_api/models/screen_recording_user_agent_os.rb +237 -202
  1243. data/lib/ultracart_api/models/screen_recording_user_property.rb +228 -193
  1244. data/lib/ultracart_api/models/screenshots_response.rb +259 -224
  1245. data/lib/ultracart_api/models/self_config.rb +220 -205
  1246. data/lib/ultracart_api/models/simple_value.rb +230 -195
  1247. data/lib/ultracart_api/models/single_sign_on_authorize_request.rb +230 -195
  1248. data/lib/ultracart_api/models/single_sign_on_authorize_response.rb +230 -195
  1249. data/lib/ultracart_api/models/single_sign_on_token_request.rb +230 -195
  1250. data/lib/ultracart_api/models/single_sign_on_token_response.rb +240 -205
  1251. data/lib/ultracart_api/models/sovos_config.rb +280 -245
  1252. data/lib/ultracart_api/models/state_province.rb +245 -210
  1253. data/lib/ultracart_api/models/step_waiting.rb +228 -193
  1254. data/lib/ultracart_api/models/tax_city.rb +302 -267
  1255. data/lib/ultracart_api/models/tax_country.rb +302 -267
  1256. data/lib/ultracart_api/models/tax_country_code.rb +260 -225
  1257. data/lib/ultracart_api/models/tax_county.rb +312 -277
  1258. data/lib/ultracart_api/models/tax_jar_config.rb +280 -245
  1259. data/lib/ultracart_api/models/tax_postal_code.rb +280 -245
  1260. data/lib/ultracart_api/models/tax_provider_activate_result.rb +229 -194
  1261. data/lib/ultracart_api/models/tax_provider_avalara.rb +249 -214
  1262. data/lib/ultracart_api/models/tax_provider_avalara_companies_result.rb +222 -187
  1263. data/lib/ultracart_api/models/tax_provider_avalara_company.rb +260 -225
  1264. data/lib/ultracart_api/models/tax_provider_self.rb +261 -226
  1265. data/lib/ultracart_api/models/tax_provider_self_countries_response.rb +222 -187
  1266. data/lib/ultracart_api/models/tax_provider_self_regions_response.rb +222 -187
  1267. data/lib/ultracart_api/models/tax_provider_sovos.rb +249 -214
  1268. data/lib/ultracart_api/models/tax_provider_tax_jar.rb +249 -214
  1269. data/lib/ultracart_api/models/tax_provider_test_result.rb +229 -194
  1270. data/lib/ultracart_api/models/tax_provider_ultra_cart.rb +261 -226
  1271. data/lib/ultracart_api/models/tax_provider_ultra_cart_state.rb +310 -275
  1272. data/lib/ultracart_api/models/tax_providers_response.rb +292 -257
  1273. data/lib/ultracart_api/models/tax_state.rb +392 -357
  1274. data/lib/ultracart_api/models/tax_state_code.rb +260 -225
  1275. data/lib/ultracart_api/models/temp_multimedia.rb +329 -294
  1276. data/lib/ultracart_api/models/temp_multimedia_response.rb +256 -221
  1277. data/lib/ultracart_api/models/thumbnail_parameters_request.rb +255 -220
  1278. data/lib/ultracart_api/models/thumbnail_parameters_response.rb +257 -222
  1279. data/lib/ultracart_api/models/transaction_email.rb +414 -379
  1280. data/lib/ultracart_api/models/transaction_email_list_response.rb +258 -223
  1281. data/lib/ultracart_api/models/transaction_email_option.rb +282 -247
  1282. data/lib/ultracart_api/models/transaction_email_response.rb +256 -221
  1283. data/lib/ultracart_api/models/twilio.rb +248 -258
  1284. data/lib/ultracart_api/models/twilio_response.rb +265 -230
  1285. data/lib/ultracart_api/models/twilios_response.rb +258 -223
  1286. data/lib/ultracart_api/models/ultra_cart_config.rb +220 -205
  1287. data/lib/ultracart_api/models/upload_coupon_codes_request.rb +259 -224
  1288. data/lib/ultracart_api/models/upload_coupon_codes_response.rb +283 -248
  1289. data/lib/ultracart_api/models/user.rb +377 -342
  1290. data/lib/ultracart_api/models/user_group_membership.rb +240 -205
  1291. data/lib/ultracart_api/models/user_login.rb +250 -215
  1292. data/lib/ultracart_api/models/user_logins_response.rb +259 -224
  1293. data/lib/ultracart_api/models/user_response.rb +256 -221
  1294. data/lib/ultracart_api/models/users_response.rb +258 -223
  1295. data/lib/ultracart_api/models/verification_record.rb +237 -202
  1296. data/lib/ultracart_api/models/warning.rb +230 -195
  1297. data/lib/ultracart_api/models/webhook.rb +437 -412
  1298. data/lib/ultracart_api/models/webhook_event_category.rb +264 -229
  1299. data/lib/ultracart_api/models/webhook_event_subscription.rb +300 -275
  1300. data/lib/ultracart_api/models/webhook_log.rb +324 -299
  1301. data/lib/ultracart_api/models/webhook_log_response.rb +256 -221
  1302. data/lib/ultracart_api/models/webhook_log_summaries_response.rb +259 -224
  1303. data/lib/ultracart_api/models/webhook_log_summary.rb +240 -205
  1304. data/lib/ultracart_api/models/webhook_response.rb +256 -221
  1305. data/lib/ultracart_api/models/{report_page_visualization_metric.rb → webhook_sample_request.rb} +252 -248
  1306. data/lib/ultracart_api/models/{customer_wish_list_items_response.rb → webhook_sample_request_response.rb} +256 -223
  1307. data/lib/ultracart_api/models/webhooks_response.rb +258 -223
  1308. data/lib/ultracart_api/models/weight.rb +264 -229
  1309. data/lib/ultracart_api/version.rb +15 -15
  1310. data/lib/ultracart_api.rb +689 -950
  1311. data/spec/api_client_spec.rb +226 -243
  1312. data/spec/configuration_spec.rb +42 -42
  1313. data/spec/spec_helper.rb +111 -111
  1314. data/ultracart_api.gemspec +38 -46
  1315. metadata +17 -699
  1316. data/docs/AccountsReceivableRetryTransactionReject.md +0 -9
  1317. data/docs/AutoOrderAddonItem.md +0 -13
  1318. data/docs/AutoOrderAddonItemOption.md +0 -9
  1319. data/docs/AutoOrderConsolidate.md +0 -8
  1320. data/docs/AutoOrderManagement.md +0 -8
  1321. data/docs/CartItemProperty.md +0 -11
  1322. data/docs/CartPaymentHealthBenefitCard.md +0 -13
  1323. data/docs/ChanelPartnerReasonCodesResponse.md +0 -18
  1324. data/docs/ChannelPartner.md +0 -15
  1325. data/docs/ChannelPartnerOrderItemProperty.md +0 -11
  1326. data/docs/ChannelPartnerShipToPreference.md +0 -14
  1327. data/docs/ChannelPartnerShipToPreferenceResponse.md +0 -12
  1328. data/docs/ChannelPartnerShipToPreferencesResponse.md +0 -12
  1329. data/docs/ChannelPartnersResponse.md +0 -12
  1330. data/docs/Conversation.md +0 -28
  1331. data/docs/ConversationAgentAuth.md +0 -22
  1332. data/docs/ConversationAgentAuthResponse.md +0 -12
  1333. data/docs/ConversationAgentProfile.md +0 -19
  1334. data/docs/ConversationAgentProfileResponse.md +0 -12
  1335. data/docs/ConversationAgentProfilesResponse.md +0 -12
  1336. data/docs/ConversationApi.md +0 -4439
  1337. data/docs/ConversationAutocompleteRequest.md +0 -9
  1338. data/docs/ConversationAutocompleteResponse.md +0 -14
  1339. data/docs/ConversationAutocompleteValue.md +0 -9
  1340. data/docs/ConversationCannedMessage.md +0 -11
  1341. data/docs/ConversationCannedMessageResponse.md +0 -12
  1342. data/docs/ConversationCannedMessagesResponse.md +0 -12
  1343. data/docs/ConversationCannedMessagesSearch.md +0 -9
  1344. data/docs/ConversationDepartment.md +0 -12
  1345. data/docs/ConversationDepartmentMember.md +0 -10
  1346. data/docs/ConversationDepartmentMembersResponse.md +0 -12
  1347. data/docs/ConversationDepartmentResponse.md +0 -12
  1348. data/docs/ConversationDepartmentSettings.md +0 -7
  1349. data/docs/ConversationDepartmentsResponse.md +0 -12
  1350. data/docs/ConversationEngagement.md +0 -16
  1351. data/docs/ConversationEngagementEquation.md +0 -8
  1352. data/docs/ConversationEngagementEquationFunction.md +0 -21
  1353. data/docs/ConversationEngagementEquationGroup.md +0 -8
  1354. data/docs/ConversationEngagementResponse.md +0 -12
  1355. data/docs/ConversationEngagementsResponse.md +0 -12
  1356. data/docs/ConversationEventAddCoupon.md +0 -10
  1357. data/docs/ConversationEventAddItem.md +0 -10
  1358. data/docs/ConversationEventQueuePosition.md +0 -9
  1359. data/docs/ConversationEventRRWeb.md +0 -14
  1360. data/docs/ConversationEventReadMessage.md +0 -10
  1361. data/docs/ConversationEventTyping.md +0 -10
  1362. data/docs/ConversationEventWebchatContext.md +0 -10
  1363. data/docs/ConversationJoinRequest.md +0 -8
  1364. data/docs/ConversationLocationCountry.md +0 -10
  1365. data/docs/ConversationLocationStateProvince.md +0 -9
  1366. data/docs/ConversationLocationsResponse.md +0 -12
  1367. data/docs/ConversationMessage.md +0 -22
  1368. data/docs/ConversationMessageTranslation.md +0 -9
  1369. data/docs/ConversationMessageTransportStatus.md +0 -9
  1370. data/docs/ConversationMessagesResponse.md +0 -12
  1371. data/docs/ConversationMultimediaUploadUrl.md +0 -9
  1372. data/docs/ConversationMultimediaUploadUrlResponse.md +0 -12
  1373. data/docs/ConversationParticipant.md +0 -20
  1374. data/docs/ConversationPbxAgent.md +0 -23
  1375. data/docs/ConversationPbxAgentResponse.md +0 -12
  1376. data/docs/ConversationPbxAgentsResponse.md +0 -12
  1377. data/docs/ConversationPbxAudio.md +0 -17
  1378. data/docs/ConversationPbxAudioResponse.md +0 -12
  1379. data/docs/ConversationPbxAudioUploadUrl.md +0 -9
  1380. data/docs/ConversationPbxAudioUploadUrlResponse.md +0 -12
  1381. data/docs/ConversationPbxAudioUsageResponse.md +0 -14
  1382. data/docs/ConversationPbxAudiosResponse.md +0 -12
  1383. data/docs/ConversationPbxCustomerSnapshotRequest.md +0 -15
  1384. data/docs/ConversationPbxCustomerSnapshotResponse.md +0 -14
  1385. data/docs/ConversationPbxMenu.md +0 -18
  1386. data/docs/ConversationPbxMenuMapping.md +0 -11
  1387. data/docs/ConversationPbxMenuResponse.md +0 -12
  1388. data/docs/ConversationPbxMenusResponse.md +0 -12
  1389. data/docs/ConversationPbxPhoneNumber.md +0 -12
  1390. data/docs/ConversationPbxPhoneNumberResponse.md +0 -12
  1391. data/docs/ConversationPbxPhoneNumbersResponse.md +0 -12
  1392. data/docs/ConversationPbxQueue.md +0 -28
  1393. data/docs/ConversationPbxQueueMembers.md +0 -9
  1394. data/docs/ConversationPbxQueueResponse.md +0 -12
  1395. data/docs/ConversationPbxQueuesResponse.md +0 -12
  1396. data/docs/ConversationPbxTimeBased.md +0 -11
  1397. data/docs/ConversationPbxTimeBasedMapping.md +0 -11
  1398. data/docs/ConversationPbxTimeBasedMappingConfig.md +0 -9
  1399. data/docs/ConversationPbxTimeBasedResponse.md +0 -12
  1400. data/docs/ConversationPbxTimeBasedsResponse.md +0 -12
  1401. data/docs/ConversationPbxTimeRange.md +0 -12
  1402. data/docs/ConversationPbxTimeRangeConfig.md +0 -13
  1403. data/docs/ConversationPbxTimeRangeResponse.md +0 -12
  1404. data/docs/ConversationPbxTimeRangesResponse.md +0 -12
  1405. data/docs/ConversationPbxVoicemailMailbox.md +0 -19
  1406. data/docs/ConversationPbxVoicemailMailboxResponse.md +0 -12
  1407. data/docs/ConversationPbxVoicemailMailboxesResponse.md +0 -12
  1408. data/docs/ConversationPbxVoicemailMessage.md +0 -20
  1409. data/docs/ConversationPbxVoicemailMessageResponse.md +0 -12
  1410. data/docs/ConversationPbxVoicemailMessageSummariesResponse.md +0 -12
  1411. data/docs/ConversationPbxVoicemailMessageSummary.md +0 -17
  1412. data/docs/ConversationPermissions.md +0 -8
  1413. data/docs/ConversationPermissionsResponse.md +0 -12
  1414. data/docs/ConversationResponse.md +0 -12
  1415. data/docs/ConversationSearchRequest.md +0 -19
  1416. data/docs/ConversationSearchResponse.md +0 -11
  1417. data/docs/ConversationSentiment.md +0 -13
  1418. data/docs/ConversationStartRequest.md +0 -10
  1419. data/docs/ConversationStartResponse.md +0 -8
  1420. data/docs/ConversationSummary.md +0 -24
  1421. data/docs/ConversationTwilioAccount.md +0 -9
  1422. data/docs/ConversationVirtualAgentBudget.md +0 -11
  1423. data/docs/ConversationVirtualAgentBudgetResponse.md +0 -12
  1424. data/docs/ConversationVirtualAgentCapabilities.md +0 -21
  1425. data/docs/ConversationVirtualAgentCapabilitiesResponse.md +0 -12
  1426. data/docs/ConversationVirtualAgentCapabilityZohoDeskDepartment.md +0 -9
  1427. data/docs/ConversationWebchatContext.md +0 -15
  1428. data/docs/ConversationWebchatQueueStatus.md +0 -22
  1429. data/docs/ConversationWebchatQueueStatusAgent.md +0 -13
  1430. data/docs/ConversationWebchatQueueStatusQueueEntry.md +0 -15
  1431. data/docs/ConversationWebchatQueueStatusUpdateRequest.md +0 -8
  1432. data/docs/ConversationWebchatQueueStatusesResponse.md +0 -12
  1433. data/docs/ConversationWebsocketMessage.md +0 -31
  1434. data/docs/ConversationsResponse.md +0 -12
  1435. data/docs/CouponFreeItemWithItemPurchaseAndFreeShipping.md +0 -11
  1436. data/docs/CouponMoreLoyaltyCashback.md +0 -8
  1437. data/docs/CouponMoreLoyaltyPoints.md +0 -8
  1438. data/docs/CouponNoDiscount.md +0 -8
  1439. data/docs/CouponPercentMoreLoyaltyCashback.md +0 -8
  1440. data/docs/CouponPercentMoreLoyaltyPoints.md +0 -8
  1441. data/docs/CouponTieredPercentOffSubtotalBasedOnMSRP.md +0 -9
  1442. data/docs/CustomDashboard.md +0 -12
  1443. data/docs/CustomDashboardExecutionParameter.md +0 -11
  1444. data/docs/CustomDashboardPage.md +0 -10
  1445. data/docs/CustomDashboardPageReport.md +0 -12
  1446. data/docs/CustomDashboardResponse.md +0 -12
  1447. data/docs/CustomDashboardSchedule.md +0 -12
  1448. data/docs/CustomDashboardScheduleResponse.md +0 -12
  1449. data/docs/CustomDashboardSchedulesResponse.md +0 -12
  1450. data/docs/CustomDashboardsResponse.md +0 -12
  1451. data/docs/CustomReport.md +0 -18
  1452. data/docs/CustomReportAccountConfig.md +0 -17
  1453. data/docs/CustomReportAccountConfigResponse.md +0 -12
  1454. data/docs/CustomReportAnalysisRequest.md +0 -9
  1455. data/docs/CustomReportAnalysisResponse.md +0 -12
  1456. data/docs/CustomReportChartPngUploadResponse.md +0 -13
  1457. data/docs/CustomReportExecutionParameter.md +0 -11
  1458. data/docs/CustomReportExecutionRequest.md +0 -8
  1459. data/docs/CustomReportExecutionResponse.md +0 -15
  1460. data/docs/CustomReportParameter.md +0 -13
  1461. data/docs/CustomReportParameterOption.md +0 -9
  1462. data/docs/CustomReportQuery.md +0 -13
  1463. data/docs/CustomReportResponse.md +0 -12
  1464. data/docs/CustomReportTooltip.md +0 -9
  1465. data/docs/CustomReportsExecutionReportData.md +0 -10
  1466. data/docs/CustomReportsExecutionRequest.md +0 -9
  1467. data/docs/CustomReportsExecutionResponse.md +0 -13
  1468. data/docs/CustomReportsResponse.md +0 -12
  1469. data/docs/CustomerEDI.md +0 -10
  1470. data/docs/CustomerMagicLinkResponse.md +0 -12
  1471. data/docs/CustomerMergeRequest.md +0 -9
  1472. data/docs/CustomerProperty.md +0 -11
  1473. data/docs/CustomerWishListItem.md +0 -14
  1474. data/docs/CustomerWishListItemResponse.md +0 -12
  1475. data/docs/CustomerWishListItemsResponse.md +0 -12
  1476. data/docs/DatawarehouseApi.md +0 -1538
  1477. data/docs/EmailCommseqSequenceTestRequest.md +0 -22
  1478. data/docs/EmailCommseqSequenceTestResponse.md +0 -11
  1479. data/docs/EmailCommseqSmsSendTestRequest.md +0 -10
  1480. data/docs/EmailCommseqSmsSendTestResponse.md +0 -13
  1481. data/docs/EmailEditorValuesResponse.md +0 -12
  1482. data/docs/EmailPostcardTracking.md +0 -32
  1483. data/docs/EmailPostcardTrackingResponse.md +0 -12
  1484. data/docs/EmailRateLimiter.md +0 -10
  1485. data/docs/EmailRateLimitersResponse.md +0 -12
  1486. data/docs/EmailSmsOrder.md +0 -11
  1487. data/docs/EmailSmsOrdersResponse.md +0 -12
  1488. data/docs/EmailSmsStat.md +0 -37
  1489. data/docs/EmailStatSmsSummaryRequest.md +0 -9
  1490. data/docs/EmailStatSmsSummaryResponse.md +0 -12
  1491. data/docs/FileManagerDirectory.md +0 -20
  1492. data/docs/FileManagerFile.md +0 -29
  1493. data/docs/FileManagerPage.md +0 -15
  1494. data/docs/FileManagerPageResponse.md +0 -12
  1495. data/docs/FileManagerUploadRequest.md +0 -10
  1496. data/docs/FileManagerUploadUrlResponse.md +0 -13
  1497. data/docs/HitPageView.md +0 -18
  1498. data/docs/HitPageViewMetaData.md +0 -9
  1499. data/docs/HitSessionStart.md +0 -24
  1500. data/docs/HitSessionUtm.md +0 -22
  1501. data/docs/ItemDigitalItemPdfMeta.md +0 -18
  1502. data/docs/ItemDigitalItemResponse.md +0 -12
  1503. data/docs/ItemDigitalItemsResponse.md +0 -12
  1504. data/docs/ItemInventorySnapshot.md +0 -13
  1505. data/docs/ItemInventorySnapshotDistributionCenter.md +0 -12
  1506. data/docs/ItemInventorySnapshotResponse.md +0 -12
  1507. data/docs/ItemReview.md +0 -45
  1508. data/docs/ItemReviewResponse.md +0 -12
  1509. data/docs/ItemReviewsResponse.md +0 -12
  1510. data/docs/OrderCurrentStageHistory.md +0 -10
  1511. data/docs/OrderEdiDocument.md +0 -21
  1512. data/docs/OrderEdiDocumentsResponse.md +0 -12
  1513. data/docs/OrderInvoiceResponse.md +0 -12
  1514. data/docs/OrderPaymentCreditCardDualVaulted.md +0 -10
  1515. data/docs/OrderPaymentCreditCardDualVaultedProperty.md +0 -9
  1516. data/docs/OrderPaymentHealthBenefitCard.md +0 -13
  1517. data/docs/OrderPaymentPayPal.md +0 -9
  1518. data/docs/OrderPointOfSale.md +0 -10
  1519. data/docs/OrderReason.md +0 -10
  1520. data/docs/OrderRefundableResponse.md +0 -20
  1521. data/docs/OrderTransactionalMerchantNote.md +0 -11
  1522. data/docs/OrderUtm.md +0 -39
  1523. data/docs/OrderValidationRequest.md +0 -9
  1524. data/docs/OrderValidationResponse.md +0 -10
  1525. data/docs/PointOfSaleLocation.md +0 -17
  1526. data/docs/PointOfSaleReader.md +0 -16
  1527. data/docs/PointOfSaleRegister.md +0 -11
  1528. data/docs/ReplaceOrderItemIdRequest.md +0 -11
  1529. data/docs/Report.md +0 -18
  1530. data/docs/ReportAuth.md +0 -11
  1531. data/docs/ReportAuthResponse.md +0 -12
  1532. data/docs/ReportDataSet.md +0 -24
  1533. data/docs/ReportDataSetColumn.md +0 -13
  1534. data/docs/ReportDataSetPage.md +0 -17
  1535. data/docs/ReportDataSetPageResponse.md +0 -12
  1536. data/docs/ReportDataSetQuery.md +0 -20
  1537. data/docs/ReportDataSetQueryOrderByColumn.md +0 -9
  1538. data/docs/ReportDataSetResponse.md +0 -12
  1539. data/docs/ReportDataSetRow.md +0 -8
  1540. data/docs/ReportDataSetSchema.md +0 -10
  1541. data/docs/ReportDataSource.md +0 -14
  1542. data/docs/ReportDataSourceSchema.md +0 -11
  1543. data/docs/ReportDryRunQueriesRequest.md +0 -13
  1544. data/docs/ReportDryRunQueriesResponse.md +0 -8
  1545. data/docs/ReportDryRunQueryResult.md +0 -9
  1546. data/docs/ReportExecuteQueriesRequest.md +0 -15
  1547. data/docs/ReportFilter.md +0 -13
  1548. data/docs/ReportFilterConnection.md +0 -10
  1549. data/docs/ReportPage.md +0 -13
  1550. data/docs/ReportPageFilter.md +0 -11
  1551. data/docs/ReportPageVisualization.md +0 -17
  1552. data/docs/ReportPageVisualizationDimension.md +0 -14
  1553. data/docs/ReportPageVisualizationMetric.md +0 -11
  1554. data/docs/ReportResponse.md +0 -12
  1555. data/docs/ReportWebsocketEvent.md +0 -9
  1556. data/docs/ReportsResponse.md +0 -12
  1557. data/docs/RulerValidationRequest.md +0 -8
  1558. data/docs/RulerValidationResponse.md +0 -9
  1559. data/docs/StoreFront.md +0 -18
  1560. data/docs/StoreFrontPageContentAttribute.md +0 -11
  1561. data/docs/StoreFrontsResponse.md +0 -12
  1562. data/docs/WebhookReflow.md +0 -9
  1563. data/docs/WebhookReflowResponse.md +0 -12
  1564. data/docs/WorkflowAgentAuth.md +0 -10
  1565. data/docs/WorkflowAgentAuthResponse.md +0 -12
  1566. data/docs/WorkflowApi.md +0 -620
  1567. data/docs/WorkflowAttachment.md +0 -12
  1568. data/docs/WorkflowAttachmentUploadUrl.md +0 -9
  1569. data/docs/WorkflowAttachmentUploadUrlResponse.md +0 -12
  1570. data/docs/WorkflowGroup.md +0 -9
  1571. data/docs/WorkflowGroupsResponse.md +0 -12
  1572. data/docs/WorkflowNote.md +0 -13
  1573. data/docs/WorkflowTask.md +0 -39
  1574. data/docs/WorkflowTaskHistory.md +0 -11
  1575. data/docs/WorkflowTaskOpenCountResponse.md +0 -12
  1576. data/docs/WorkflowTaskResponse.md +0 -12
  1577. data/docs/WorkflowTaskTagsResponse.md +0 -12
  1578. data/docs/WorkflowTasksRequest.md +0 -27
  1579. data/docs/WorkflowTasksResponse.md +0 -13
  1580. data/docs/WorkflowUser.md +0 -10
  1581. data/docs/WorkflowUserResponse.md +0 -12
  1582. data/docs/WorkflowUsersResponse.md +0 -13
  1583. data/lib/ultracart_api/api/conversation_api.rb +0 -4840
  1584. data/lib/ultracart_api/api/datawarehouse_api.rb +0 -1711
  1585. data/lib/ultracart_api/api/workflow_api.rb +0 -693
  1586. data/lib/ultracart_api/models/accounts_receivable_retry_transaction_reject.rb +0 -195
  1587. data/lib/ultracart_api/models/auto_order_addon_item.rb +0 -232
  1588. data/lib/ultracart_api/models/auto_order_addon_item_option.rb +0 -225
  1589. data/lib/ultracart_api/models/auto_order_consolidate.rb +0 -186
  1590. data/lib/ultracart_api/models/auto_order_management.rb +0 -185
  1591. data/lib/ultracart_api/models/cart_item_property.rb +0 -245
  1592. data/lib/ultracart_api/models/cart_payment_health_benefit_card.rb +0 -235
  1593. data/lib/ultracart_api/models/chanel_partner_reason_codes_response.rb +0 -290
  1594. data/lib/ultracart_api/models/channel_partner.rb +0 -255
  1595. data/lib/ultracart_api/models/channel_partner_order_item_property.rb +0 -245
  1596. data/lib/ultracart_api/models/channel_partner_ship_to_preference.rb +0 -262
  1597. data/lib/ultracart_api/models/channel_partner_ship_to_preference_response.rb +0 -221
  1598. data/lib/ultracart_api/models/channel_partner_ship_to_preferences_response.rb +0 -224
  1599. data/lib/ultracart_api/models/channel_partners_response.rb +0 -224
  1600. data/lib/ultracart_api/models/conversation.rb +0 -410
  1601. data/lib/ultracart_api/models/conversation_agent_auth.rb +0 -316
  1602. data/lib/ultracart_api/models/conversation_agent_auth_response.rb +0 -221
  1603. data/lib/ultracart_api/models/conversation_agent_profile.rb +0 -329
  1604. data/lib/ultracart_api/models/conversation_agent_profile_response.rb +0 -221
  1605. data/lib/ultracart_api/models/conversation_agent_profiles_response.rb +0 -223
  1606. data/lib/ultracart_api/models/conversation_autocomplete_request.rb +0 -193
  1607. data/lib/ultracart_api/models/conversation_autocomplete_response.rb +0 -241
  1608. data/lib/ultracart_api/models/conversation_autocomplete_value.rb +0 -193
  1609. data/lib/ultracart_api/models/conversation_canned_message.rb +0 -213
  1610. data/lib/ultracart_api/models/conversation_canned_message_response.rb +0 -221
  1611. data/lib/ultracart_api/models/conversation_canned_messages_response.rb +0 -223
  1612. data/lib/ultracart_api/models/conversation_canned_messages_search.rb +0 -193
  1613. data/lib/ultracart_api/models/conversation_department.rb +0 -222
  1614. data/lib/ultracart_api/models/conversation_department_member.rb +0 -202
  1615. data/lib/ultracart_api/models/conversation_department_members_response.rb +0 -223
  1616. data/lib/ultracart_api/models/conversation_department_response.rb +0 -221
  1617. data/lib/ultracart_api/models/conversation_department_settings.rb +0 -175
  1618. data/lib/ultracart_api/models/conversation_departments_response.rb +0 -223
  1619. data/lib/ultracart_api/models/conversation_engagement.rb +0 -293
  1620. data/lib/ultracart_api/models/conversation_engagement_equation.rb +0 -186
  1621. data/lib/ultracart_api/models/conversation_engagement_equation_function.rb +0 -414
  1622. data/lib/ultracart_api/models/conversation_engagement_equation_group.rb +0 -186
  1623. data/lib/ultracart_api/models/conversation_engagement_response.rb +0 -221
  1624. data/lib/ultracart_api/models/conversation_engagements_response.rb +0 -223
  1625. data/lib/ultracart_api/models/conversation_event_add_coupon.rb +0 -202
  1626. data/lib/ultracart_api/models/conversation_event_add_item.rb +0 -204
  1627. data/lib/ultracart_api/models/conversation_event_queue_position.rb +0 -195
  1628. data/lib/ultracart_api/models/conversation_event_read_message.rb +0 -203
  1629. data/lib/ultracart_api/models/conversation_event_rr_web.rb +0 -273
  1630. data/lib/ultracart_api/models/conversation_event_typing.rb +0 -202
  1631. data/lib/ultracart_api/models/conversation_event_webchat_context.rb +0 -202
  1632. data/lib/ultracart_api/models/conversation_join_request.rb +0 -184
  1633. data/lib/ultracart_api/models/conversation_location_country.rb +0 -204
  1634. data/lib/ultracart_api/models/conversation_location_state_province.rb +0 -193
  1635. data/lib/ultracart_api/models/conversation_locations_response.rb +0 -223
  1636. data/lib/ultracart_api/models/conversation_message.rb +0 -356
  1637. data/lib/ultracart_api/models/conversation_message_translation.rb +0 -193
  1638. data/lib/ultracart_api/models/conversation_message_transport_status.rb +0 -228
  1639. data/lib/ultracart_api/models/conversation_messages_response.rb +0 -223
  1640. data/lib/ultracart_api/models/conversation_multimedia_upload_url.rb +0 -193
  1641. data/lib/ultracart_api/models/conversation_multimedia_upload_url_response.rb +0 -221
  1642. data/lib/ultracart_api/models/conversation_participant.rb +0 -295
  1643. data/lib/ultracart_api/models/conversation_pbx_agent.rb +0 -440
  1644. data/lib/ultracart_api/models/conversation_pbx_agent_response.rb +0 -221
  1645. data/lib/ultracart_api/models/conversation_pbx_agents_response.rb +0 -223
  1646. data/lib/ultracart_api/models/conversation_pbx_audio.rb +0 -365
  1647. data/lib/ultracart_api/models/conversation_pbx_audio_response.rb +0 -221
  1648. data/lib/ultracart_api/models/conversation_pbx_audio_upload_url.rb +0 -193
  1649. data/lib/ultracart_api/models/conversation_pbx_audio_upload_url_response.rb +0 -221
  1650. data/lib/ultracart_api/models/conversation_pbx_audios_response.rb +0 -223
  1651. data/lib/ultracart_api/models/conversation_pbx_customer_snapshot_request.rb +0 -248
  1652. data/lib/ultracart_api/models/conversation_pbx_menu.rb +0 -416
  1653. data/lib/ultracart_api/models/conversation_pbx_menu_mapping.rb +0 -269
  1654. data/lib/ultracart_api/models/conversation_pbx_menu_response.rb +0 -221
  1655. data/lib/ultracart_api/models/conversation_pbx_menus_response.rb +0 -223
  1656. data/lib/ultracart_api/models/conversation_pbx_phone_number.rb +0 -324
  1657. data/lib/ultracart_api/models/conversation_pbx_phone_number_response.rb +0 -221
  1658. data/lib/ultracart_api/models/conversation_pbx_phone_numbers_response.rb +0 -223
  1659. data/lib/ultracart_api/models/conversation_pbx_queue.rb +0 -534
  1660. data/lib/ultracart_api/models/conversation_pbx_queue_members.rb +0 -197
  1661. data/lib/ultracart_api/models/conversation_pbx_queue_response.rb +0 -221
  1662. data/lib/ultracart_api/models/conversation_pbx_queues_response.rb +0 -223
  1663. data/lib/ultracart_api/models/conversation_pbx_time_based.rb +0 -211
  1664. data/lib/ultracart_api/models/conversation_pbx_time_based_mapping.rb +0 -299
  1665. data/lib/ultracart_api/models/conversation_pbx_time_based_mapping_config.rb +0 -196
  1666. data/lib/ultracart_api/models/conversation_pbx_time_based_response.rb +0 -221
  1667. data/lib/ultracart_api/models/conversation_pbx_time_baseds_response.rb +0 -223
  1668. data/lib/ultracart_api/models/conversation_pbx_time_range.rb +0 -287
  1669. data/lib/ultracart_api/models/conversation_pbx_time_range_config.rb +0 -235
  1670. data/lib/ultracart_api/models/conversation_pbx_time_range_response.rb +0 -221
  1671. data/lib/ultracart_api/models/conversation_pbx_time_ranges_response.rb +0 -223
  1672. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb +0 -458
  1673. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox_response.rb +0 -221
  1674. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailboxes_response.rb +0 -223
  1675. data/lib/ultracart_api/models/conversation_pbx_voicemail_message.rb +0 -339
  1676. data/lib/ultracart_api/models/conversation_pbx_voicemail_message_response.rb +0 -221
  1677. data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summaries_response.rb +0 -223
  1678. data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summary.rb +0 -309
  1679. data/lib/ultracart_api/models/conversation_permissions.rb +0 -184
  1680. data/lib/ultracart_api/models/conversation_permissions_response.rb +0 -221
  1681. data/lib/ultracart_api/models/conversation_response.rb +0 -221
  1682. data/lib/ultracart_api/models/conversation_search_request.rb +0 -285
  1683. data/lib/ultracart_api/models/conversation_search_response.rb +0 -213
  1684. data/lib/ultracart_api/models/conversation_sentiment.rb +0 -269
  1685. data/lib/ultracart_api/models/conversation_start_request.rb +0 -204
  1686. data/lib/ultracart_api/models/conversation_start_response.rb +0 -184
  1687. data/lib/ultracart_api/models/conversation_summary.rb +0 -369
  1688. data/lib/ultracart_api/models/conversation_twilio_account.rb +0 -195
  1689. data/lib/ultracart_api/models/conversation_virtual_agent_budget.rb +0 -211
  1690. data/lib/ultracart_api/models/conversation_virtual_agent_budget_response.rb +0 -221
  1691. data/lib/ultracart_api/models/conversation_virtual_agent_capabilities.rb +0 -342
  1692. data/lib/ultracart_api/models/conversation_virtual_agent_capabilities_response.rb +0 -221
  1693. data/lib/ultracart_api/models/conversation_virtual_agent_capability_zoho_desk_department.rb +0 -193
  1694. data/lib/ultracart_api/models/conversation_webchat_context.rb +0 -254
  1695. data/lib/ultracart_api/models/conversation_webchat_queue_status.rb +0 -315
  1696. data/lib/ultracart_api/models/conversation_webchat_queue_status_agent.rb +0 -266
  1697. data/lib/ultracart_api/models/conversation_webchat_queue_status_queue_entry.rb +0 -248
  1698. data/lib/ultracart_api/models/conversation_webchat_queue_status_update_request.rb +0 -219
  1699. data/lib/ultracart_api/models/conversation_webchat_queue_statuses_response.rb +0 -223
  1700. data/lib/ultracart_api/models/conversation_websocket_message.rb +0 -441
  1701. data/lib/ultracart_api/models/conversations_response.rb +0 -223
  1702. data/lib/ultracart_api/models/coupon_free_item_with_item_purchase_and_free_shipping.rb +0 -219
  1703. data/lib/ultracart_api/models/coupon_more_loyalty_cashback.rb +0 -185
  1704. data/lib/ultracart_api/models/coupon_more_loyalty_points.rb +0 -185
  1705. data/lib/ultracart_api/models/coupon_no_discount.rb +0 -185
  1706. data/lib/ultracart_api/models/coupon_percent_more_loyalty_cashback.rb +0 -185
  1707. data/lib/ultracart_api/models/coupon_percent_more_loyalty_points.rb +0 -185
  1708. data/lib/ultracart_api/models/coupon_tiered_percent_off_subtotal_based_on_msrp.rb +0 -199
  1709. data/lib/ultracart_api/models/custom_dashboard.rb +0 -224
  1710. data/lib/ultracart_api/models/custom_dashboard_execution_parameter.rb +0 -211
  1711. data/lib/ultracart_api/models/custom_dashboard_page.rb +0 -204
  1712. data/lib/ultracart_api/models/custom_dashboard_page_report.rb +0 -220
  1713. data/lib/ultracart_api/models/custom_dashboard_response.rb +0 -221
  1714. data/lib/ultracart_api/models/custom_dashboard_schedule.rb +0 -223
  1715. data/lib/ultracart_api/models/custom_dashboard_schedule_response.rb +0 -221
  1716. data/lib/ultracart_api/models/custom_dashboard_schedules_response.rb +0 -224
  1717. data/lib/ultracart_api/models/custom_dashboards_response.rb +0 -224
  1718. data/lib/ultracart_api/models/custom_report.rb +0 -280
  1719. data/lib/ultracart_api/models/custom_report_account_config.rb +0 -270
  1720. data/lib/ultracart_api/models/custom_report_account_config_response.rb +0 -221
  1721. data/lib/ultracart_api/models/custom_report_analysis_request.rb +0 -193
  1722. data/lib/ultracart_api/models/custom_report_analysis_response.rb +0 -221
  1723. data/lib/ultracart_api/models/custom_report_chart_png_upload_response.rb +0 -230
  1724. data/lib/ultracart_api/models/custom_report_execution_parameter.rb +0 -211
  1725. data/lib/ultracart_api/models/custom_report_execution_request.rb +0 -186
  1726. data/lib/ultracart_api/models/custom_report_execution_response.rb +0 -250
  1727. data/lib/ultracart_api/models/custom_report_parameter.rb +0 -231
  1728. data/lib/ultracart_api/models/custom_report_parameter_option.rb +0 -193
  1729. data/lib/ultracart_api/models/custom_report_query.rb +0 -231
  1730. data/lib/ultracart_api/models/custom_report_response.rb +0 -221
  1731. data/lib/ultracart_api/models/custom_report_tooltip.rb +0 -193
  1732. data/lib/ultracart_api/models/custom_reports_execution_report_data.rb +0 -202
  1733. data/lib/ultracart_api/models/custom_reports_execution_request.rb +0 -197
  1734. data/lib/ultracart_api/models/custom_reports_execution_response.rb +0 -234
  1735. data/lib/ultracart_api/models/custom_reports_response.rb +0 -224
  1736. data/lib/ultracart_api/models/customer_edi.rb +0 -205
  1737. data/lib/ultracart_api/models/customer_magic_link_response.rb +0 -222
  1738. data/lib/ultracart_api/models/customer_merge_request.rb +0 -195
  1739. data/lib/ultracart_api/models/customer_property.rb +0 -245
  1740. data/lib/ultracart_api/models/customer_wish_list_item.rb +0 -260
  1741. data/lib/ultracart_api/models/customer_wish_list_item_response.rb +0 -221
  1742. data/lib/ultracart_api/models/email_commseq_sequence_test_request.rb +0 -312
  1743. data/lib/ultracart_api/models/email_commseq_sequence_test_response.rb +0 -212
  1744. data/lib/ultracart_api/models/email_commseq_sms_send_test_request.rb +0 -202
  1745. data/lib/ultracart_api/models/email_commseq_sms_send_test_response.rb +0 -232
  1746. data/lib/ultracart_api/models/email_editor_values_response.rb +0 -223
  1747. data/lib/ultracart_api/models/email_postcard_tracking.rb +0 -404
  1748. data/lib/ultracart_api/models/email_postcard_tracking_response.rb +0 -221
  1749. data/lib/ultracart_api/models/email_rate_limiter.rb +0 -202
  1750. data/lib/ultracart_api/models/email_rate_limiters_response.rb +0 -223
  1751. data/lib/ultracart_api/models/email_sms_order.rb +0 -214
  1752. data/lib/ultracart_api/models/email_sms_orders_response.rb +0 -223
  1753. data/lib/ultracart_api/models/email_sms_stat.rb +0 -476
  1754. data/lib/ultracart_api/models/email_stat_sms_summary_request.rb +0 -195
  1755. data/lib/ultracart_api/models/email_stat_sms_summary_response.rb +0 -223
  1756. data/lib/ultracart_api/models/file_manager_directory.rb +0 -292
  1757. data/lib/ultracart_api/models/file_manager_file.rb +0 -376
  1758. data/lib/ultracart_api/models/file_manager_page.rb +0 -253
  1759. data/lib/ultracart_api/models/file_manager_page_response.rb +0 -221
  1760. data/lib/ultracart_api/models/file_manager_upload_request.rb +0 -202
  1761. data/lib/ultracart_api/models/file_manager_upload_url_response.rb +0 -230
  1762. data/lib/ultracart_api/models/hit_page_view.rb +0 -276
  1763. data/lib/ultracart_api/models/hit_page_view_meta_data.rb +0 -193
  1764. data/lib/ultracart_api/models/hit_session_start.rb +0 -328
  1765. data/lib/ultracart_api/models/hit_session_utm.rb +0 -310
  1766. data/lib/ultracart_api/models/item_digital_item_pdf_meta.rb +0 -315
  1767. data/lib/ultracart_api/models/item_digital_item_response.rb +0 -221
  1768. data/lib/ultracart_api/models/item_digital_items_response.rb +0 -224
  1769. data/lib/ultracart_api/models/item_inventory_snapshot.rb +0 -231
  1770. data/lib/ultracart_api/models/item_inventory_snapshot_distribution_center.rb +0 -220
  1771. data/lib/ultracart_api/models/item_inventory_snapshot_response.rb +0 -224
  1772. data/lib/ultracart_api/models/item_review.rb +0 -826
  1773. data/lib/ultracart_api/models/item_review_response.rb +0 -221
  1774. data/lib/ultracart_api/models/item_reviews_response.rb +0 -224
  1775. data/lib/ultracart_api/models/order_current_stage_history.rb +0 -251
  1776. data/lib/ultracart_api/models/order_edi_document.rb +0 -337
  1777. data/lib/ultracart_api/models/order_edi_documents_response.rb +0 -224
  1778. data/lib/ultracart_api/models/order_invoice_response.rb +0 -222
  1779. data/lib/ultracart_api/models/order_payment_credit_card_dual_vaulted.rb +0 -204
  1780. data/lib/ultracart_api/models/order_payment_credit_card_dual_vaulted_property.rb +0 -193
  1781. data/lib/ultracart_api/models/order_payment_health_benefit_card.rb +0 -235
  1782. data/lib/ultracart_api/models/order_payment_pay_pal.rb +0 -195
  1783. data/lib/ultracart_api/models/order_point_of_sale.rb +0 -202
  1784. data/lib/ultracart_api/models/order_reason.rb +0 -205
  1785. data/lib/ultracart_api/models/order_refundable_response.rb +0 -310
  1786. data/lib/ultracart_api/models/order_transactional_merchant_note.rb +0 -215
  1787. data/lib/ultracart_api/models/order_utm.rb +0 -464
  1788. data/lib/ultracart_api/models/order_validation_request.rb +0 -196
  1789. data/lib/ultracart_api/models/order_validation_response.rb +0 -209
  1790. data/lib/ultracart_api/models/point_of_sale_location.rb +0 -290
  1791. data/lib/ultracart_api/models/point_of_sale_reader.rb +0 -299
  1792. data/lib/ultracart_api/models/point_of_sale_register.rb +0 -215
  1793. data/lib/ultracart_api/models/replace_order_item_id_request.rb +0 -245
  1794. data/lib/ultracart_api/models/report.rb +0 -317
  1795. data/lib/ultracart_api/models/report_auth.rb +0 -212
  1796. data/lib/ultracart_api/models/report_auth_response.rb +0 -221
  1797. data/lib/ultracart_api/models/report_data_set.rb +0 -381
  1798. data/lib/ultracart_api/models/report_data_set_column.rb +0 -229
  1799. data/lib/ultracart_api/models/report_data_set_page.rb +0 -273
  1800. data/lib/ultracart_api/models/report_data_set_page_response.rb +0 -221
  1801. data/lib/ultracart_api/models/report_data_set_query.rb +0 -342
  1802. data/lib/ultracart_api/models/report_data_set_query_order_by_column.rb +0 -193
  1803. data/lib/ultracart_api/models/report_data_set_response.rb +0 -221
  1804. data/lib/ultracart_api/models/report_data_set_row.rb +0 -186
  1805. data/lib/ultracart_api/models/report_data_set_schema.rb +0 -238
  1806. data/lib/ultracart_api/models/report_data_source.rb +0 -242
  1807. data/lib/ultracart_api/models/report_data_source_schema.rb +0 -248
  1808. data/lib/ultracart_api/models/report_dry_run_queries_request.rb +0 -231
  1809. data/lib/ultracart_api/models/report_dry_run_queries_response.rb +0 -186
  1810. data/lib/ultracart_api/models/report_dry_run_query_result.rb +0 -193
  1811. data/lib/ultracart_api/models/report_execute_queries_request.rb +0 -288
  1812. data/lib/ultracart_api/models/report_filter.rb +0 -272
  1813. data/lib/ultracart_api/models/report_filter_connection.rb +0 -203
  1814. data/lib/ultracart_api/models/report_page.rb +0 -237
  1815. data/lib/ultracart_api/models/report_page_filter.rb +0 -214
  1816. data/lib/ultracart_api/models/report_page_visualization.rb +0 -309
  1817. data/lib/ultracart_api/models/report_page_visualization_dimension.rb +0 -244
  1818. data/lib/ultracart_api/models/report_response.rb +0 -221
  1819. data/lib/ultracart_api/models/report_websocket_event.rb +0 -228
  1820. data/lib/ultracart_api/models/reports_response.rb +0 -223
  1821. data/lib/ultracart_api/models/ruler_validation_request.rb +0 -184
  1822. data/lib/ultracart_api/models/ruler_validation_response.rb +0 -193
  1823. data/lib/ultracart_api/models/store_front.rb +0 -274
  1824. data/lib/ultracart_api/models/store_front_page_content_attribute.rb +0 -245
  1825. data/lib/ultracart_api/models/store_fronts_response.rb +0 -223
  1826. data/lib/ultracart_api/models/webhook_reflow.rb +0 -193
  1827. data/lib/ultracart_api/models/webhook_reflow_response.rb +0 -221
  1828. data/lib/ultracart_api/models/workflow_agent_auth.rb +0 -202
  1829. data/lib/ultracart_api/models/workflow_agent_auth_response.rb +0 -221
  1830. data/lib/ultracart_api/models/workflow_attachment.rb +0 -225
  1831. data/lib/ultracart_api/models/workflow_attachment_upload_url.rb +0 -193
  1832. data/lib/ultracart_api/models/workflow_attachment_upload_url_response.rb +0 -221
  1833. data/lib/ultracart_api/models/workflow_group.rb +0 -195
  1834. data/lib/ultracart_api/models/workflow_groups_response.rb +0 -224
  1835. data/lib/ultracart_api/models/workflow_note.rb +0 -236
  1836. data/lib/ultracart_api/models/workflow_task.rb +0 -574
  1837. data/lib/ultracart_api/models/workflow_task_history.rb +0 -214
  1838. data/lib/ultracart_api/models/workflow_task_open_count_response.rb +0 -222
  1839. data/lib/ultracart_api/models/workflow_task_response.rb +0 -221
  1840. data/lib/ultracart_api/models/workflow_task_tags_response.rb +0 -224
  1841. data/lib/ultracart_api/models/workflow_tasks_request.rb +0 -434
  1842. data/lib/ultracart_api/models/workflow_tasks_response.rb +0 -234
  1843. data/lib/ultracart_api/models/workflow_user.rb +0 -205
  1844. data/lib/ultracart_api/models/workflow_user_response.rb +0 -221
  1845. data/lib/ultracart_api/models/workflow_users_response.rb +0 -234
@@ -1,1878 +1,1728 @@
1
- =begin
2
- #UltraCart Rest API V2
3
-
4
- #UltraCart REST API Version 2
5
-
6
- OpenAPI spec version: 2.0.0
7
- Contact: support@ultracart.com
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.4.15-SNAPSHOT
10
-
11
- =end
12
-
13
- require 'addressable/uri'
14
-
15
- module UltracartClient
16
- class OrderApi
17
- attr_accessor :api_client
18
-
19
- def initialize(api_client = ApiClient.default)
20
- @api_client = api_client
21
- end
22
-
23
- def self.new_using_api_key(simple_key, verify_ssl = true, debugging = false)
24
- api_config = Configuration.new
25
- api_config.api_key_prefix['x-ultracart-simple-key'] = simple_key
26
- api_config.api_version = '2017-03-01'
27
- api_config.verify_ssl = verify_ssl
28
-
29
- api_client = ApiClient.new(api_config)
30
- api_client.config.debugging = debugging
31
-
32
- UltracartClient::OrderApi.new(api_client)
33
- end
34
-
35
- # Adjusts an order total
36
- # Adjusts an order total. Adjusts individual items appropriately and considers taxes. Desired total should be provided in the same currency as the order and must be less than the current total and greater than zero. This call will change the order total. It returns true if the desired total is achieved. If the goal seeking algorithm falls short (usually by pennies), this method returns back false. View the merchant notes for the order for further details.
37
- # @param order_id The order id to cancel.
38
- # @param desired_total The desired total with no formatting. example 123.45
39
- # @param [Hash] opts the optional parameters
40
- # @return [BaseResponse]
41
- def adjust_order_total(order_id, desired_total, opts = {})
42
- data, _status_code, _headers = adjust_order_total_with_http_info(order_id, desired_total, opts)
43
- data
44
- end
45
-
46
- # Adjusts an order total
47
- # Adjusts an order total. Adjusts individual items appropriately and considers taxes. Desired total should be provided in the same currency as the order and must be less than the current total and greater than zero. This call will change the order total. It returns true if the desired total is achieved. If the goal seeking algorithm falls short (usually by pennies), this method returns back false. View the merchant notes for the order for further details.
48
- # @param order_id The order id to cancel.
49
- # @param desired_total The desired total with no formatting. example 123.45
50
- # @param [Hash] opts the optional parameters
51
- # @return [Array<(BaseResponse, Fixnum, Hash)>] BaseResponse data, response status code and response headers
52
- def adjust_order_total_with_http_info(order_id, desired_total, opts = {})
53
- if @api_client.config.debugging
54
- @api_client.config.logger.debug 'Calling API: OrderApi.adjust_order_total ...'
55
- end
56
- # verify the required parameter 'order_id' is set
57
- if @api_client.config.client_side_validation && order_id.nil?
58
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.adjust_order_total"
59
- end
60
- # verify the required parameter 'desired_total' is set
61
- if @api_client.config.client_side_validation && desired_total.nil?
62
- fail ArgumentError, "Missing the required parameter 'desired_total' when calling OrderApi.adjust_order_total"
63
- end
64
- # resource path
65
- local_var_path = '/order/orders/{order_id}/adjust_order_total/{desired_total}'.sub('{' + 'order_id' + '}', order_id.to_s).sub('{' + 'desired_total' + '}', desired_total.to_s)
66
-
67
- # query parameters
68
- query_params = {}
69
-
70
- # header parameters
71
- header_params = {}
72
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
73
- # HTTP header 'Accept' (if needed)
74
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
75
- # HTTP header 'Content-Type'
76
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
77
-
78
- # form parameters
79
- form_params = {}
80
-
81
- # http body (model)
82
- post_body = nil
83
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
84
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
85
- :header_params => header_params,
86
- :query_params => query_params,
87
- :form_params => form_params,
88
- :body => post_body,
89
- :auth_names => auth_names,
90
- :return_type => 'BaseResponse')
91
- if @api_client.config.debugging
92
- @api_client.config.logger.debug "API called: OrderApi#adjust_order_total\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
93
- end
94
- return data, status_code, headers
95
- end
96
- # Set a refund block on an order
97
- # Sets a refund block on an order to prevent a user from performing a refund. Commonly used when a chargeback has been received.
98
- # @param order_id The order id to block a refund on.
99
- # @param [Hash] opts the optional parameters
100
- # @option opts [String] :block_reason Block reason code (optional)
101
- # @return [nil]
102
- def block_refund_on_order(order_id, opts = {})
103
- block_refund_on_order_with_http_info(order_id, opts)
104
- nil
105
- end
106
-
107
- # Set a refund block on an order
108
- # Sets a refund block on an order to prevent a user from performing a refund. Commonly used when a chargeback has been received.
109
- # @param order_id The order id to block a refund on.
110
- # @param [Hash] opts the optional parameters
111
- # @option opts [String] :block_reason Block reason code (optional)
112
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
113
- def block_refund_on_order_with_http_info(order_id, opts = {})
114
- if @api_client.config.debugging
115
- @api_client.config.logger.debug 'Calling API: OrderApi.block_refund_on_order ...'
116
- end
117
- # verify the required parameter 'order_id' is set
118
- if @api_client.config.client_side_validation && order_id.nil?
119
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.block_refund_on_order"
120
- end
121
- # resource path
122
- local_var_path = '/order/orders/{order_id}/refund_block'.sub('{' + 'order_id' + '}', order_id.to_s)
123
-
124
- # query parameters
125
- query_params = {}
126
- query_params[:'block_reason'] = opts[:'block_reason'] if !opts[:'block_reason'].nil?
127
-
128
- # header parameters
129
- header_params = {}
130
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
131
- # HTTP header 'Accept' (if needed)
132
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
133
- # HTTP header 'Content-Type'
134
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
135
-
136
- # form parameters
137
- form_params = {}
138
-
139
- # http body (model)
140
- post_body = nil
141
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
142
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
143
- :header_params => header_params,
144
- :query_params => query_params,
145
- :form_params => form_params,
146
- :body => post_body,
147
- :auth_names => auth_names)
148
- if @api_client.config.debugging
149
- @api_client.config.logger.debug "API called: OrderApi#block_refund_on_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
150
- end
151
- return data, status_code, headers
152
- end
153
- # Cancel an order
154
- # Cancel an order on the UltraCart account. If the success flag is false, then consult the error message for why it failed.
155
- # @param order_id The order id to cancel.
156
- # @param [Hash] opts the optional parameters
157
- # @option opts [BOOLEAN] :lock_self_ship_orders Flag to prevent a order shipping during a refund process
158
- # @option opts [BOOLEAN] :skip_refund_and_hold Skip refund and move order to Held Orders department
159
- # @return [BaseResponse]
160
- def cancel_order(order_id, opts = {})
161
- data, _status_code, _headers = cancel_order_with_http_info(order_id, opts)
162
- data
163
- end
164
-
165
- # Cancel an order
166
- # Cancel an order on the UltraCart account. If the success flag is false, then consult the error message for why it failed.
167
- # @param order_id The order id to cancel.
168
- # @param [Hash] opts the optional parameters
169
- # @option opts [BOOLEAN] :lock_self_ship_orders Flag to prevent a order shipping during a refund process
170
- # @option opts [BOOLEAN] :skip_refund_and_hold Skip refund and move order to Held Orders department
171
- # @return [Array<(BaseResponse, Fixnum, Hash)>] BaseResponse data, response status code and response headers
172
- def cancel_order_with_http_info(order_id, opts = {})
173
- if @api_client.config.debugging
174
- @api_client.config.logger.debug 'Calling API: OrderApi.cancel_order ...'
175
- end
176
- # verify the required parameter 'order_id' is set
177
- if @api_client.config.client_side_validation && order_id.nil?
178
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.cancel_order"
179
- end
180
- # resource path
181
- local_var_path = '/order/orders/{order_id}/cancel'.sub('{' + 'order_id' + '}', order_id.to_s)
182
-
183
- # query parameters
184
- query_params = {}
185
- query_params[:'lock_self_ship_orders'] = opts[:'lock_self_ship_orders'] if !opts[:'lock_self_ship_orders'].nil?
186
- query_params[:'skip_refund_and_hold'] = opts[:'skip_refund_and_hold'] if !opts[:'skip_refund_and_hold'].nil?
187
-
188
- # header parameters
189
- header_params = {}
190
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
191
- # HTTP header 'Accept' (if needed)
192
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
193
- # HTTP header 'Content-Type'
194
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
195
-
196
- # form parameters
197
- form_params = {}
198
-
199
- # http body (model)
200
- post_body = nil
201
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
202
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
203
- :header_params => header_params,
204
- :query_params => query_params,
205
- :form_params => form_params,
206
- :body => post_body,
207
- :auth_names => auth_names,
208
- :return_type => 'BaseResponse')
209
- if @api_client.config.debugging
210
- @api_client.config.logger.debug "API called: OrderApi#cancel_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
211
- end
212
- return data, status_code, headers
213
- end
214
- # Delete an order
215
- # Delete an order on the UltraCart account.
216
- # @param order_id The order id to delete.
217
- # @param [Hash] opts the optional parameters
218
- # @return [nil]
219
- def delete_order(order_id, opts = {})
220
- delete_order_with_http_info(order_id, opts)
221
- nil
222
- end
223
-
224
- # Delete an order
225
- # Delete an order on the UltraCart account.
226
- # @param order_id The order id to delete.
227
- # @param [Hash] opts the optional parameters
228
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
229
- def delete_order_with_http_info(order_id, opts = {})
230
- if @api_client.config.debugging
231
- @api_client.config.logger.debug 'Calling API: OrderApi.delete_order ...'
232
- end
233
- # verify the required parameter 'order_id' is set
234
- if @api_client.config.client_side_validation && order_id.nil?
235
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.delete_order"
236
- end
237
- # resource path
238
- local_var_path = '/order/orders/{order_id}'.sub('{' + 'order_id' + '}', order_id.to_s)
239
-
240
- # query parameters
241
- query_params = {}
242
-
243
- # header parameters
244
- header_params = {}
245
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
246
- # HTTP header 'Accept' (if needed)
247
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
248
- # HTTP header 'Content-Type'
249
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
250
-
251
- # form parameters
252
- form_params = {}
253
-
254
- # http body (model)
255
- post_body = nil
256
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
257
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
258
- :header_params => header_params,
259
- :query_params => query_params,
260
- :form_params => form_params,
261
- :body => post_body,
262
- :auth_names => auth_names)
263
- if @api_client.config.debugging
264
- @api_client.config.logger.debug "API called: OrderApi#delete_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
265
- end
266
- return data, status_code, headers
267
- end
268
- # Duplicate an order
269
- # Perform a duplicate of the specified order_id and return a new order located in Accounts Receivable.
270
- # @param order_id The order id to duplicate.
271
- # @param [Hash] opts the optional parameters
272
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
273
- # @return [OrderResponse]
274
- def duplicate_order(order_id, opts = {})
275
- data, _status_code, _headers = duplicate_order_with_http_info(order_id, opts)
276
- data
277
- end
278
-
279
- # Duplicate an order
280
- # Perform a duplicate of the specified order_id and return a new order located in Accounts Receivable.
281
- # @param order_id The order id to duplicate.
282
- # @param [Hash] opts the optional parameters
283
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
284
- # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
285
- def duplicate_order_with_http_info(order_id, opts = {})
286
- if @api_client.config.debugging
287
- @api_client.config.logger.debug 'Calling API: OrderApi.duplicate_order ...'
288
- end
289
- # verify the required parameter 'order_id' is set
290
- if @api_client.config.client_side_validation && order_id.nil?
291
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.duplicate_order"
292
- end
293
- # resource path
294
- local_var_path = '/order/orders/{order_id}/duplicate'.sub('{' + 'order_id' + '}', order_id.to_s)
295
-
296
- # query parameters
297
- query_params = {}
298
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
299
-
300
- # header parameters
301
- header_params = {}
302
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
303
- # HTTP header 'Accept' (if needed)
304
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
305
- # HTTP header 'Content-Type'
306
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
307
-
308
- # form parameters
309
- form_params = {}
310
-
311
- # http body (model)
312
- post_body = nil
313
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
314
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
315
- :header_params => header_params,
316
- :query_params => query_params,
317
- :form_params => form_params,
318
- :body => post_body,
319
- :auth_names => auth_names,
320
- :return_type => 'OrderResponse')
321
- if @api_client.config.debugging
322
- @api_client.config.logger.debug "API called: OrderApi#duplicate_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
323
- end
324
- return data, status_code, headers
325
- end
326
- # Format order
327
- # Format the order for display at text or html
328
- # @param order_id The order id to format
329
- # @param format_options Format options
330
- # @param [Hash] opts the optional parameters
331
- # @return [OrderFormatResponse]
332
- def format(order_id, format_options, opts = {})
333
- data, _status_code, _headers = format_with_http_info(order_id, format_options, opts)
334
- data
335
- end
336
-
337
- # Format order
338
- # Format the order for display at text or html
339
- # @param order_id The order id to format
340
- # @param format_options Format options
341
- # @param [Hash] opts the optional parameters
342
- # @return [Array<(OrderFormatResponse, Fixnum, Hash)>] OrderFormatResponse data, response status code and response headers
343
- def format_with_http_info(order_id, format_options, opts = {})
344
- if @api_client.config.debugging
345
- @api_client.config.logger.debug 'Calling API: OrderApi.format ...'
346
- end
347
- # verify the required parameter 'order_id' is set
348
- if @api_client.config.client_side_validation && order_id.nil?
349
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.format"
350
- end
351
- # verify the required parameter 'format_options' is set
352
- if @api_client.config.client_side_validation && format_options.nil?
353
- fail ArgumentError, "Missing the required parameter 'format_options' when calling OrderApi.format"
354
- end
355
- # resource path
356
- local_var_path = '/order/orders/{order_id}/format'.sub('{' + 'order_id' + '}', order_id.to_s)
357
-
358
- # query parameters
359
- query_params = {}
360
-
361
- # header parameters
362
- header_params = {}
363
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
364
- # HTTP header 'Accept' (if needed)
365
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
366
- # HTTP header 'Content-Type'
367
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
368
-
369
- # form parameters
370
- form_params = {}
371
-
372
- # http body (model)
373
- post_body = @api_client.object_to_http_body(format_options)
374
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
375
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
376
- :header_params => header_params,
377
- :query_params => query_params,
378
- :form_params => form_params,
379
- :body => post_body,
380
- :auth_names => auth_names,
381
- :return_type => 'OrderFormatResponse')
382
- if @api_client.config.debugging
383
- @api_client.config.logger.debug "API called: OrderApi#format\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
384
- end
385
- return data, status_code, headers
386
- end
387
- # Generate an invoice for this order.
388
- # The invoice PDF that is returned is base 64 encoded
389
- # @param order_id Order ID
390
- # @param [Hash] opts the optional parameters
391
- # @return [OrderInvoiceResponse]
392
- def generate_invoice(order_id, opts = {})
393
- data, _status_code, _headers = generate_invoice_with_http_info(order_id, opts)
394
- data
395
- end
396
-
397
- # Generate an invoice for this order.
398
- # The invoice PDF that is returned is base 64 encoded
399
- # @param order_id Order ID
400
- # @param [Hash] opts the optional parameters
401
- # @return [Array<(OrderInvoiceResponse, Fixnum, Hash)>] OrderInvoiceResponse data, response status code and response headers
402
- def generate_invoice_with_http_info(order_id, opts = {})
403
- if @api_client.config.debugging
404
- @api_client.config.logger.debug 'Calling API: OrderApi.generate_invoice ...'
405
- end
406
- # verify the required parameter 'order_id' is set
407
- if @api_client.config.client_side_validation && order_id.nil?
408
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.generate_invoice"
409
- end
410
- # resource path
411
- local_var_path = '/order/orders/{order_id}/invoice'.sub('{' + 'order_id' + '}', order_id.to_s)
412
-
413
- # query parameters
414
- query_params = {}
415
-
416
- # header parameters
417
- header_params = {}
418
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
419
- # HTTP header 'Accept' (if needed)
420
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
421
- # HTTP header 'Content-Type'
422
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
423
-
424
- # form parameters
425
- form_params = {}
426
-
427
- # http body (model)
428
- post_body = nil
429
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
430
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
431
- :header_params => header_params,
432
- :query_params => query_params,
433
- :form_params => form_params,
434
- :body => post_body,
435
- :auth_names => auth_names,
436
- :return_type => 'OrderInvoiceResponse')
437
- if @api_client.config.debugging
438
- @api_client.config.logger.debug "API called: OrderApi#generate_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
439
- end
440
- return data, status_code, headers
441
- end
442
- # Generate an order token for a given order id
443
- # Retrieves a single order token for a given order id. The token can be used with the getOrderByToken API.
444
- # @param order_id The order id to generate a token for.
445
- # @param [Hash] opts the optional parameters
446
- # @return [OrderTokenResponse]
447
- def generate_order_token(order_id, opts = {})
448
- data, _status_code, _headers = generate_order_token_with_http_info(order_id, opts)
449
- data
450
- end
451
-
452
- # Generate an order token for a given order id
453
- # Retrieves a single order token for a given order id. The token can be used with the getOrderByToken API.
454
- # @param order_id The order id to generate a token for.
455
- # @param [Hash] opts the optional parameters
456
- # @return [Array<(OrderTokenResponse, Fixnum, Hash)>] OrderTokenResponse data, response status code and response headers
457
- def generate_order_token_with_http_info(order_id, opts = {})
458
- if @api_client.config.debugging
459
- @api_client.config.logger.debug 'Calling API: OrderApi.generate_order_token ...'
460
- end
461
- # verify the required parameter 'order_id' is set
462
- if @api_client.config.client_side_validation && order_id.nil?
463
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.generate_order_token"
464
- end
465
- # resource path
466
- local_var_path = '/order/orders/token/{order_id}'.sub('{' + 'order_id' + '}', order_id.to_s)
467
-
468
- # query parameters
469
- query_params = {}
470
-
471
- # header parameters
472
- header_params = {}
473
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
474
- # HTTP header 'Accept' (if needed)
475
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
476
- # HTTP header 'Content-Type'
477
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
478
-
479
- # form parameters
480
- form_params = {}
481
-
482
- # http body (model)
483
- post_body = nil
484
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
485
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
486
- :header_params => header_params,
487
- :query_params => query_params,
488
- :form_params => form_params,
489
- :body => post_body,
490
- :auth_names => auth_names,
491
- :return_type => 'OrderTokenResponse')
492
- if @api_client.config.debugging
493
- @api_client.config.logger.debug "API called: OrderApi#generate_order_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
494
- end
495
- return data, status_code, headers
496
- end
497
- # Generate a packing slip for this order across all distribution centers.
498
- # The packing slip PDF that is returned is base 64 encoded
499
- # @param order_id Order ID
500
- # @param [Hash] opts the optional parameters
501
- # @return [OrderPackingSlipResponse]
502
- def generate_packing_slip_all_dc(order_id, opts = {})
503
- data, _status_code, _headers = generate_packing_slip_all_dc_with_http_info(order_id, opts)
504
- data
505
- end
506
-
507
- # Generate a packing slip for this order across all distribution centers.
508
- # The packing slip PDF that is returned is base 64 encoded
509
- # @param order_id Order ID
510
- # @param [Hash] opts the optional parameters
511
- # @return [Array<(OrderPackingSlipResponse, Fixnum, Hash)>] OrderPackingSlipResponse data, response status code and response headers
512
- def generate_packing_slip_all_dc_with_http_info(order_id, opts = {})
513
- if @api_client.config.debugging
514
- @api_client.config.logger.debug 'Calling API: OrderApi.generate_packing_slip_all_dc ...'
515
- end
516
- # verify the required parameter 'order_id' is set
517
- if @api_client.config.client_side_validation && order_id.nil?
518
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.generate_packing_slip_all_dc"
519
- end
520
- # resource path
521
- local_var_path = '/order/orders/{order_id}/packing_slip'.sub('{' + 'order_id' + '}', order_id.to_s)
522
-
523
- # query parameters
524
- query_params = {}
525
-
526
- # header parameters
527
- header_params = {}
528
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
529
- # HTTP header 'Accept' (if needed)
530
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
531
- # HTTP header 'Content-Type'
532
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
533
-
534
- # form parameters
535
- form_params = {}
536
-
537
- # http body (model)
538
- post_body = nil
539
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
540
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
541
- :header_params => header_params,
542
- :query_params => query_params,
543
- :form_params => form_params,
544
- :body => post_body,
545
- :auth_names => auth_names,
546
- :return_type => 'OrderPackingSlipResponse')
547
- if @api_client.config.debugging
548
- @api_client.config.logger.debug "API called: OrderApi#generate_packing_slip_all_dc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
549
- end
550
- return data, status_code, headers
551
- end
552
- # Generate a packing slip for this order for the given distribution center.
553
- # The packing slip PDF that is returned is base 64 encoded
554
- # @param distribution_center_code Distribution center code
555
- # @param order_id Order ID
556
- # @param [Hash] opts the optional parameters
557
- # @return [OrderPackingSlipResponse]
558
- def generate_packing_slip_specific_dc(distribution_center_code, order_id, opts = {})
559
- data, _status_code, _headers = generate_packing_slip_specific_dc_with_http_info(distribution_center_code, order_id, opts)
560
- data
561
- end
562
-
563
- # Generate a packing slip for this order for the given distribution center.
564
- # The packing slip PDF that is returned is base 64 encoded
565
- # @param distribution_center_code Distribution center code
566
- # @param order_id Order ID
567
- # @param [Hash] opts the optional parameters
568
- # @return [Array<(OrderPackingSlipResponse, Fixnum, Hash)>] OrderPackingSlipResponse data, response status code and response headers
569
- def generate_packing_slip_specific_dc_with_http_info(distribution_center_code, order_id, opts = {})
570
- if @api_client.config.debugging
571
- @api_client.config.logger.debug 'Calling API: OrderApi.generate_packing_slip_specific_dc ...'
572
- end
573
- # verify the required parameter 'distribution_center_code' is set
574
- if @api_client.config.client_side_validation && distribution_center_code.nil?
575
- fail ArgumentError, "Missing the required parameter 'distribution_center_code' when calling OrderApi.generate_packing_slip_specific_dc"
576
- end
577
- # verify the required parameter 'order_id' is set
578
- if @api_client.config.client_side_validation && order_id.nil?
579
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.generate_packing_slip_specific_dc"
580
- end
581
- # resource path
582
- local_var_path = '/order/orders/{order_id}/packing_slip/{distribution_center_code}'.sub('{' + 'distribution_center_code' + '}', distribution_center_code.to_s).sub('{' + 'order_id' + '}', order_id.to_s)
583
-
584
- # query parameters
585
- query_params = {}
586
-
587
- # header parameters
588
- header_params = {}
589
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
590
- # HTTP header 'Accept' (if needed)
591
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
592
- # HTTP header 'Content-Type'
593
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
594
-
595
- # form parameters
596
- form_params = {}
597
-
598
- # http body (model)
599
- post_body = nil
600
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
601
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
602
- :header_params => header_params,
603
- :query_params => query_params,
604
- :form_params => form_params,
605
- :body => post_body,
606
- :auth_names => auth_names,
607
- :return_type => 'OrderPackingSlipResponse')
608
- if @api_client.config.debugging
609
- @api_client.config.logger.debug "API called: OrderApi#generate_packing_slip_specific_dc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
610
- end
611
- return data, status_code, headers
612
- end
613
- # Retrieve A/R Retry Configuration
614
- # Retrieve A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.
615
- # @param [Hash] opts the optional parameters
616
- # @return [AccountsReceivableRetryConfigResponse]
617
- def get_accounts_receivable_retry_config(opts = {})
618
- data, _status_code, _headers = get_accounts_receivable_retry_config_with_http_info(opts)
619
- data
620
- end
621
-
622
- # Retrieve A/R Retry Configuration
623
- # Retrieve A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.
624
- # @param [Hash] opts the optional parameters
625
- # @return [Array<(AccountsReceivableRetryConfigResponse, Fixnum, Hash)>] AccountsReceivableRetryConfigResponse data, response status code and response headers
626
- def get_accounts_receivable_retry_config_with_http_info(opts = {})
627
- if @api_client.config.debugging
628
- @api_client.config.logger.debug 'Calling API: OrderApi.get_accounts_receivable_retry_config ...'
629
- end
630
- # resource path
631
- local_var_path = '/order/accountsReceivableRetryConfig'
632
-
633
- # query parameters
634
- query_params = {}
635
-
636
- # header parameters
637
- header_params = {}
638
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
639
- # HTTP header 'Accept' (if needed)
640
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
641
- # HTTP header 'Content-Type'
642
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
643
-
644
- # form parameters
645
- form_params = {}
646
-
647
- # http body (model)
648
- post_body = nil
649
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
650
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
651
- :header_params => header_params,
652
- :query_params => query_params,
653
- :form_params => form_params,
654
- :body => post_body,
655
- :auth_names => auth_names,
656
- :return_type => 'AccountsReceivableRetryConfigResponse')
657
- if @api_client.config.debugging
658
- @api_client.config.logger.debug "API called: OrderApi#get_accounts_receivable_retry_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
659
- end
660
- return data, status_code, headers
661
- end
662
- # Retrieve A/R Retry Statistics
663
- # Retrieve A/R Retry Statistics. This is primarily an internal API call. It is doubtful you would ever need to use it.
664
- # @param [Hash] opts the optional parameters
665
- # @option opts [String] :from
666
- # @option opts [String] :to
667
- # @return [AccountsReceivableRetryStatsResponse]
668
- def get_accounts_receivable_retry_stats(opts = {})
669
- data, _status_code, _headers = get_accounts_receivable_retry_stats_with_http_info(opts)
670
- data
671
- end
672
-
673
- # Retrieve A/R Retry Statistics
674
- # Retrieve A/R Retry Statistics. This is primarily an internal API call. It is doubtful you would ever need to use it.
675
- # @param [Hash] opts the optional parameters
676
- # @option opts [String] :from
677
- # @option opts [String] :to
678
- # @return [Array<(AccountsReceivableRetryStatsResponse, Fixnum, Hash)>] AccountsReceivableRetryStatsResponse data, response status code and response headers
679
- def get_accounts_receivable_retry_stats_with_http_info(opts = {})
680
- if @api_client.config.debugging
681
- @api_client.config.logger.debug 'Calling API: OrderApi.get_accounts_receivable_retry_stats ...'
682
- end
683
- # resource path
684
- local_var_path = '/order/accountsReceivableRetryConfig/stats'
685
-
686
- # query parameters
687
- query_params = {}
688
- query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
689
- query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
690
-
691
- # header parameters
692
- header_params = {}
693
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
694
- # HTTP header 'Accept' (if needed)
695
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
696
- # HTTP header 'Content-Type'
697
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
698
-
699
- # form parameters
700
- form_params = {}
701
-
702
- # http body (model)
703
- post_body = nil
704
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
705
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
706
- :header_params => header_params,
707
- :query_params => query_params,
708
- :form_params => form_params,
709
- :body => post_body,
710
- :auth_names => auth_names,
711
- :return_type => 'AccountsReceivableRetryStatsResponse')
712
- if @api_client.config.debugging
713
- @api_client.config.logger.debug "API called: OrderApi#get_accounts_receivable_retry_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
714
- end
715
- return data, status_code, headers
716
- end
717
- # Retrieve an order
718
- # Retrieves a single order using the specified order id.
719
- # @param order_id The order id to retrieve.
720
- # @param [Hash] opts the optional parameters
721
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
722
- # @return [OrderResponse]
723
- def get_order(order_id, opts = {})
724
- data, _status_code, _headers = get_order_with_http_info(order_id, opts)
725
- data
726
- end
727
-
728
- # Retrieve an order
729
- # Retrieves a single order using the specified order id.
730
- # @param order_id The order id to retrieve.
731
- # @param [Hash] opts the optional parameters
732
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
733
- # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
734
- def get_order_with_http_info(order_id, opts = {})
735
- if @api_client.config.debugging
736
- @api_client.config.logger.debug 'Calling API: OrderApi.get_order ...'
737
- end
738
- # verify the required parameter 'order_id' is set
739
- if @api_client.config.client_side_validation && order_id.nil?
740
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.get_order"
741
- end
742
- # resource path
743
- local_var_path = '/order/orders/{order_id}'.sub('{' + 'order_id' + '}', order_id.to_s)
744
-
745
- # query parameters
746
- query_params = {}
747
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
748
-
749
- # header parameters
750
- header_params = {}
751
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
752
- # HTTP header 'Accept' (if needed)
753
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
754
- # HTTP header 'Content-Type'
755
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
756
-
757
- # form parameters
758
- form_params = {}
759
-
760
- # http body (model)
761
- post_body = nil
762
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
763
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
764
- :header_params => header_params,
765
- :query_params => query_params,
766
- :form_params => form_params,
767
- :body => post_body,
768
- :auth_names => auth_names,
769
- :return_type => 'OrderResponse')
770
- if @api_client.config.debugging
771
- @api_client.config.logger.debug "API called: OrderApi#get_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
772
- end
773
- return data, status_code, headers
774
- end
775
- # Retrieve an order using a token
776
- # Retrieves a single order using the specified order token.
777
- # @param order_by_token_query Order by token query
778
- # @param [Hash] opts the optional parameters
779
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
780
- # @return [OrderResponse]
781
- def get_order_by_token(order_by_token_query, opts = {})
782
- data, _status_code, _headers = get_order_by_token_with_http_info(order_by_token_query, opts)
783
- data
784
- end
785
-
786
- # Retrieve an order using a token
787
- # Retrieves a single order using the specified order token.
788
- # @param order_by_token_query Order by token query
789
- # @param [Hash] opts the optional parameters
790
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
791
- # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
792
- def get_order_by_token_with_http_info(order_by_token_query, opts = {})
793
- if @api_client.config.debugging
794
- @api_client.config.logger.debug 'Calling API: OrderApi.get_order_by_token ...'
795
- end
796
- # verify the required parameter 'order_by_token_query' is set
797
- if @api_client.config.client_side_validation && order_by_token_query.nil?
798
- fail ArgumentError, "Missing the required parameter 'order_by_token_query' when calling OrderApi.get_order_by_token"
799
- end
800
- # resource path
801
- local_var_path = '/order/orders/token'
802
-
803
- # query parameters
804
- query_params = {}
805
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
806
-
807
- # header parameters
808
- header_params = {}
809
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
810
- # HTTP header 'Accept' (if needed)
811
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
812
- # HTTP header 'Content-Type'
813
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
814
-
815
- # form parameters
816
- form_params = {}
817
-
818
- # http body (model)
819
- post_body = @api_client.object_to_http_body(order_by_token_query)
820
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
821
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
822
- :header_params => header_params,
823
- :query_params => query_params,
824
- :form_params => form_params,
825
- :body => post_body,
826
- :auth_names => auth_names,
827
- :return_type => 'OrderResponse')
828
- if @api_client.config.debugging
829
- @api_client.config.logger.debug "API called: OrderApi#get_order_by_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
830
- end
831
- return data, status_code, headers
832
- end
833
- # Retrieve EDI documents associated with this order.
834
- # Retrieve EDI documents associated with this order.
835
- # @param order_id The order id to retrieve EDI documents for.
836
- # @param [Hash] opts the optional parameters
837
- # @return [OrderEdiDocumentsResponse]
838
- def get_order_edi_documents(order_id, opts = {})
839
- data, _status_code, _headers = get_order_edi_documents_with_http_info(order_id, opts)
840
- data
841
- end
842
-
843
- # Retrieve EDI documents associated with this order.
844
- # Retrieve EDI documents associated with this order.
845
- # @param order_id The order id to retrieve EDI documents for.
846
- # @param [Hash] opts the optional parameters
847
- # @return [Array<(OrderEdiDocumentsResponse, Fixnum, Hash)>] OrderEdiDocumentsResponse data, response status code and response headers
848
- def get_order_edi_documents_with_http_info(order_id, opts = {})
849
- if @api_client.config.debugging
850
- @api_client.config.logger.debug 'Calling API: OrderApi.get_order_edi_documents ...'
851
- end
852
- # verify the required parameter 'order_id' is set
853
- if @api_client.config.client_side_validation && order_id.nil?
854
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.get_order_edi_documents"
855
- end
856
- # resource path
857
- local_var_path = '/order/orders/{order_id}/edi'.sub('{' + 'order_id' + '}', order_id.to_s)
858
-
859
- # query parameters
860
- query_params = {}
861
-
862
- # header parameters
863
- header_params = {}
864
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
865
- # HTTP header 'Accept' (if needed)
866
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
867
- # HTTP header 'Content-Type'
868
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
869
-
870
- # form parameters
871
- form_params = {}
872
-
873
- # http body (model)
874
- post_body = nil
875
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
876
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
877
- :header_params => header_params,
878
- :query_params => query_params,
879
- :form_params => form_params,
880
- :body => post_body,
881
- :auth_names => auth_names,
882
- :return_type => 'OrderEdiDocumentsResponse')
883
- if @api_client.config.debugging
884
- @api_client.config.logger.debug "API called: OrderApi#get_order_edi_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
885
- end
886
- return data, status_code, headers
887
- end
888
- # Retrieve orders
889
- # Retrieves a group of orders from the account. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
890
- # @param [Hash] opts the optional parameters
891
- # @option opts [String] :order_id Order Id
892
- # @option opts [String] :payment_method Payment Method
893
- # @option opts [String] :company Company
894
- # @option opts [String] :first_name First Name
895
- # @option opts [String] :last_name Last Name
896
- # @option opts [String] :city City
897
- # @option opts [String] :state_region State/Region
898
- # @option opts [String] :postal_code Postal Code
899
- # @option opts [String] :country_code Country Code (ISO-3166 two letter)
900
- # @option opts [String] :phone Phone
901
- # @option opts [String] :email Email
902
- # @option opts [String] :cc_email CC Email
903
- # @option opts [Float] :total Total
904
- # @option opts [String] :screen_branding_theme_code Screen Branding Theme Code
905
- # @option opts [String] :storefront_host_name StoreFront Host Name
906
- # @option opts [String] :creation_date_begin Creation Date Begin
907
- # @option opts [String] :creation_date_end Creation Date End
908
- # @option opts [String] :payment_date_begin Payment Date Begin
909
- # @option opts [String] :payment_date_end Payment Date End
910
- # @option opts [String] :shipment_date_begin Shipment Date Begin
911
- # @option opts [String] :shipment_date_end Shipment Date End
912
- # @option opts [String] :rma RMA
913
- # @option opts [String] :purchase_order_number Purchase Order Number
914
- # @option opts [String] :item_id Item Id
915
- # @option opts [String] :current_stage Current Stage
916
- # @option opts [String] :channel_partner_code Channel Partner Code
917
- # @option opts [String] :channel_partner_order_id Channel Partner Order ID
918
- # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200) (default to 100)
919
- # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
920
- # @option opts [String] :_sort The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
921
- # @option opts [String] :_expand The object expansion to perform on the result.
922
- # @return [OrdersResponse]
923
- def get_orders(opts = {})
924
- data, _status_code, _headers = get_orders_with_http_info(opts)
925
- data
926
- end
927
-
928
- # Retrieve orders
929
- # Retrieves a group of orders from the account. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
930
- # @param [Hash] opts the optional parameters
931
- # @option opts [String] :order_id Order Id
932
- # @option opts [String] :payment_method Payment Method
933
- # @option opts [String] :company Company
934
- # @option opts [String] :first_name First Name
935
- # @option opts [String] :last_name Last Name
936
- # @option opts [String] :city City
937
- # @option opts [String] :state_region State/Region
938
- # @option opts [String] :postal_code Postal Code
939
- # @option opts [String] :country_code Country Code (ISO-3166 two letter)
940
- # @option opts [String] :phone Phone
941
- # @option opts [String] :email Email
942
- # @option opts [String] :cc_email CC Email
943
- # @option opts [Float] :total Total
944
- # @option opts [String] :screen_branding_theme_code Screen Branding Theme Code
945
- # @option opts [String] :storefront_host_name StoreFront Host Name
946
- # @option opts [String] :creation_date_begin Creation Date Begin
947
- # @option opts [String] :creation_date_end Creation Date End
948
- # @option opts [String] :payment_date_begin Payment Date Begin
949
- # @option opts [String] :payment_date_end Payment Date End
950
- # @option opts [String] :shipment_date_begin Shipment Date Begin
951
- # @option opts [String] :shipment_date_end Shipment Date End
952
- # @option opts [String] :rma RMA
953
- # @option opts [String] :purchase_order_number Purchase Order Number
954
- # @option opts [String] :item_id Item Id
955
- # @option opts [String] :current_stage Current Stage
956
- # @option opts [String] :channel_partner_code Channel Partner Code
957
- # @option opts [String] :channel_partner_order_id Channel Partner Order ID
958
- # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200)
959
- # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index.
960
- # @option opts [String] :_sort The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
961
- # @option opts [String] :_expand The object expansion to perform on the result.
962
- # @return [Array<(OrdersResponse, Fixnum, Hash)>] OrdersResponse data, response status code and response headers
963
- def get_orders_with_http_info(opts = {})
964
- if @api_client.config.debugging
965
- @api_client.config.logger.debug 'Calling API: OrderApi.get_orders ...'
966
- end
967
- # resource path
968
- local_var_path = '/order/orders'
969
-
970
- # query parameters
971
- query_params = {}
972
- query_params[:'order_id'] = opts[:'order_id'] if !opts[:'order_id'].nil?
973
- query_params[:'payment_method'] = opts[:'payment_method'] if !opts[:'payment_method'].nil?
974
- query_params[:'company'] = opts[:'company'] if !opts[:'company'].nil?
975
- query_params[:'first_name'] = opts[:'first_name'] if !opts[:'first_name'].nil?
976
- query_params[:'last_name'] = opts[:'last_name'] if !opts[:'last_name'].nil?
977
- query_params[:'city'] = opts[:'city'] if !opts[:'city'].nil?
978
- query_params[:'state_region'] = opts[:'state_region'] if !opts[:'state_region'].nil?
979
- query_params[:'postal_code'] = opts[:'postal_code'] if !opts[:'postal_code'].nil?
980
- query_params[:'country_code'] = opts[:'country_code'] if !opts[:'country_code'].nil?
981
- query_params[:'phone'] = opts[:'phone'] if !opts[:'phone'].nil?
982
- query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
983
- query_params[:'cc_email'] = opts[:'cc_email'] if !opts[:'cc_email'].nil?
984
- query_params[:'total'] = opts[:'total'] if !opts[:'total'].nil?
985
- query_params[:'screen_branding_theme_code'] = opts[:'screen_branding_theme_code'] if !opts[:'screen_branding_theme_code'].nil?
986
- query_params[:'storefront_host_name'] = opts[:'storefront_host_name'] if !opts[:'storefront_host_name'].nil?
987
- query_params[:'creation_date_begin'] = opts[:'creation_date_begin'] if !opts[:'creation_date_begin'].nil?
988
- query_params[:'creation_date_end'] = opts[:'creation_date_end'] if !opts[:'creation_date_end'].nil?
989
- query_params[:'payment_date_begin'] = opts[:'payment_date_begin'] if !opts[:'payment_date_begin'].nil?
990
- query_params[:'payment_date_end'] = opts[:'payment_date_end'] if !opts[:'payment_date_end'].nil?
991
- query_params[:'shipment_date_begin'] = opts[:'shipment_date_begin'] if !opts[:'shipment_date_begin'].nil?
992
- query_params[:'shipment_date_end'] = opts[:'shipment_date_end'] if !opts[:'shipment_date_end'].nil?
993
- query_params[:'rma'] = opts[:'rma'] if !opts[:'rma'].nil?
994
- query_params[:'purchase_order_number'] = opts[:'purchase_order_number'] if !opts[:'purchase_order_number'].nil?
995
- query_params[:'item_id'] = opts[:'item_id'] if !opts[:'item_id'].nil?
996
- query_params[:'current_stage'] = opts[:'current_stage'] if !opts[:'current_stage'].nil?
997
- query_params[:'channel_partner_code'] = opts[:'channel_partner_code'] if !opts[:'channel_partner_code'].nil?
998
- query_params[:'channel_partner_order_id'] = opts[:'channel_partner_order_id'] if !opts[:'channel_partner_order_id'].nil?
999
- query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
1000
- query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
1001
- query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
1002
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1003
-
1004
- # header parameters
1005
- header_params = {}
1006
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1007
- # HTTP header 'Accept' (if needed)
1008
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1009
- # HTTP header 'Content-Type'
1010
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1011
-
1012
- # form parameters
1013
- form_params = {}
1014
-
1015
- # http body (model)
1016
- post_body = nil
1017
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1018
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1019
- :header_params => header_params,
1020
- :query_params => query_params,
1021
- :form_params => form_params,
1022
- :body => post_body,
1023
- :auth_names => auth_names,
1024
- :return_type => 'OrdersResponse')
1025
- if @api_client.config.debugging
1026
- @api_client.config.logger.debug "API called: OrderApi#get_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1027
- end
1028
- return data, status_code, headers
1029
- end
1030
- # Retrieve order batch
1031
- # Retrieves a group of orders from the account based on an array of order ids. If more than 500 order ids are specified, the API call will fail with a bad request error.
1032
- # @param order_batch Order batch
1033
- # @param [Hash] opts the optional parameters
1034
- # @option opts [String] :_expand The object expansion to perform on the result.
1035
- # @return [OrdersResponse]
1036
- def get_orders_batch(order_batch, opts = {})
1037
- data, _status_code, _headers = get_orders_batch_with_http_info(order_batch, opts)
1038
- data
1039
- end
1040
-
1041
- # Retrieve order batch
1042
- # Retrieves a group of orders from the account based on an array of order ids. If more than 500 order ids are specified, the API call will fail with a bad request error.
1043
- # @param order_batch Order batch
1044
- # @param [Hash] opts the optional parameters
1045
- # @option opts [String] :_expand The object expansion to perform on the result.
1046
- # @return [Array<(OrdersResponse, Fixnum, Hash)>] OrdersResponse data, response status code and response headers
1047
- def get_orders_batch_with_http_info(order_batch, opts = {})
1048
- if @api_client.config.debugging
1049
- @api_client.config.logger.debug 'Calling API: OrderApi.get_orders_batch ...'
1050
- end
1051
- # verify the required parameter 'order_batch' is set
1052
- if @api_client.config.client_side_validation && order_batch.nil?
1053
- fail ArgumentError, "Missing the required parameter 'order_batch' when calling OrderApi.get_orders_batch"
1054
- end
1055
- # resource path
1056
- local_var_path = '/order/orders/batch'
1057
-
1058
- # query parameters
1059
- query_params = {}
1060
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1061
-
1062
- # header parameters
1063
- header_params = {}
1064
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1065
- # HTTP header 'Accept' (if needed)
1066
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1067
- # HTTP header 'Content-Type'
1068
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1069
-
1070
- # form parameters
1071
- form_params = {}
1072
-
1073
- # http body (model)
1074
- post_body = @api_client.object_to_http_body(order_batch)
1075
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1076
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1077
- :header_params => header_params,
1078
- :query_params => query_params,
1079
- :form_params => form_params,
1080
- :body => post_body,
1081
- :auth_names => auth_names,
1082
- :return_type => 'OrdersResponse')
1083
- if @api_client.config.debugging
1084
- @api_client.config.logger.debug "API called: OrderApi#get_orders_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1085
- end
1086
- return data, status_code, headers
1087
- end
1088
- # Retrieve orders by query
1089
- # Retrieves a group of orders from the account based on a query object. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
1090
- # @param order_query Order query
1091
- # @param [Hash] opts the optional parameters
1092
- # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200) (default to 100)
1093
- # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
1094
- # @option opts [String] :_sort The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
1095
- # @option opts [String] :_expand The object expansion to perform on the result.
1096
- # @return [OrdersResponse]
1097
- def get_orders_by_query(order_query, opts = {})
1098
- data, _status_code, _headers = get_orders_by_query_with_http_info(order_query, opts)
1099
- data
1100
- end
1101
-
1102
- # Retrieve orders by query
1103
- # Retrieves a group of orders from the account based on a query object. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
1104
- # @param order_query Order query
1105
- # @param [Hash] opts the optional parameters
1106
- # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200)
1107
- # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index.
1108
- # @option opts [String] :_sort The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
1109
- # @option opts [String] :_expand The object expansion to perform on the result.
1110
- # @return [Array<(OrdersResponse, Fixnum, Hash)>] OrdersResponse data, response status code and response headers
1111
- def get_orders_by_query_with_http_info(order_query, opts = {})
1112
- if @api_client.config.debugging
1113
- @api_client.config.logger.debug 'Calling API: OrderApi.get_orders_by_query ...'
1114
- end
1115
- # verify the required parameter 'order_query' is set
1116
- if @api_client.config.client_side_validation && order_query.nil?
1117
- fail ArgumentError, "Missing the required parameter 'order_query' when calling OrderApi.get_orders_by_query"
1118
- end
1119
- # resource path
1120
- local_var_path = '/order/orders/query'
1121
-
1122
- # query parameters
1123
- query_params = {}
1124
- query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
1125
- query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
1126
- query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
1127
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1128
-
1129
- # header parameters
1130
- header_params = {}
1131
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1132
- # HTTP header 'Accept' (if needed)
1133
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1134
- # HTTP header 'Content-Type'
1135
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1136
-
1137
- # form parameters
1138
- form_params = {}
1139
-
1140
- # http body (model)
1141
- post_body = @api_client.object_to_http_body(order_query)
1142
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1143
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1144
- :header_params => header_params,
1145
- :query_params => query_params,
1146
- :form_params => form_params,
1147
- :body => post_body,
1148
- :auth_names => auth_names,
1149
- :return_type => 'OrdersResponse')
1150
- if @api_client.config.debugging
1151
- @api_client.config.logger.debug "API called: OrderApi#get_orders_by_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1152
- end
1153
- return data, status_code, headers
1154
- end
1155
- # Insert an order
1156
- # Inserts a new order on the UltraCart account. This is probably NOT the method you want. This is for channel orders. For regular orders the customer is entering, use the CheckoutApi. It has many, many more features, checks, and validations.
1157
- # @param order Order to insert
1158
- # @param [Hash] opts the optional parameters
1159
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1160
- # @return [OrderResponse]
1161
- def insert_order(order, opts = {})
1162
- data, _status_code, _headers = insert_order_with_http_info(order, opts)
1163
- data
1164
- end
1165
-
1166
- # Insert an order
1167
- # Inserts a new order on the UltraCart account. This is probably NOT the method you want. This is for channel orders. For regular orders the customer is entering, use the CheckoutApi. It has many, many more features, checks, and validations.
1168
- # @param order Order to insert
1169
- # @param [Hash] opts the optional parameters
1170
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1171
- # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
1172
- def insert_order_with_http_info(order, opts = {})
1173
- if @api_client.config.debugging
1174
- @api_client.config.logger.debug 'Calling API: OrderApi.insert_order ...'
1175
- end
1176
- # verify the required parameter 'order' is set
1177
- if @api_client.config.client_side_validation && order.nil?
1178
- fail ArgumentError, "Missing the required parameter 'order' when calling OrderApi.insert_order"
1179
- end
1180
- # resource path
1181
- local_var_path = '/order/orders'
1182
-
1183
- # query parameters
1184
- query_params = {}
1185
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1186
-
1187
- # header parameters
1188
- header_params = {}
1189
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1190
- # HTTP header 'Accept' (if needed)
1191
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1192
- # HTTP header 'Content-Type'
1193
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1194
-
1195
- # form parameters
1196
- form_params = {}
1197
-
1198
- # http body (model)
1199
- post_body = @api_client.object_to_http_body(order)
1200
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1201
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1202
- :header_params => header_params,
1203
- :query_params => query_params,
1204
- :form_params => form_params,
1205
- :body => post_body,
1206
- :auth_names => auth_names,
1207
- :return_type => 'OrderResponse')
1208
- if @api_client.config.debugging
1209
- @api_client.config.logger.debug "API called: OrderApi#insert_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1210
- end
1211
- return data, status_code, headers
1212
- end
1213
- # Determine if an order can be refunded
1214
- # Determine if an order can be refunded based upon payment method and age
1215
- # @param order_id The order id to check for refundable order.
1216
- # @param [Hash] opts the optional parameters
1217
- # @return [OrderRefundableResponse]
1218
- def is_refundable_order(order_id, opts = {})
1219
- data, _status_code, _headers = is_refundable_order_with_http_info(order_id, opts)
1220
- data
1221
- end
1222
-
1223
- # Determine if an order can be refunded
1224
- # Determine if an order can be refunded based upon payment method and age
1225
- # @param order_id The order id to check for refundable order.
1226
- # @param [Hash] opts the optional parameters
1227
- # @return [Array<(OrderRefundableResponse, Fixnum, Hash)>] OrderRefundableResponse data, response status code and response headers
1228
- def is_refundable_order_with_http_info(order_id, opts = {})
1229
- if @api_client.config.debugging
1230
- @api_client.config.logger.debug 'Calling API: OrderApi.is_refundable_order ...'
1231
- end
1232
- # verify the required parameter 'order_id' is set
1233
- if @api_client.config.client_side_validation && order_id.nil?
1234
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.is_refundable_order"
1235
- end
1236
- # resource path
1237
- local_var_path = '/order/orders/{order_id}/refundable'.sub('{' + 'order_id' + '}', order_id.to_s)
1238
-
1239
- # query parameters
1240
- query_params = {}
1241
-
1242
- # header parameters
1243
- header_params = {}
1244
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1245
- # HTTP header 'Accept' (if needed)
1246
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1247
- # HTTP header 'Content-Type'
1248
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1249
-
1250
- # form parameters
1251
- form_params = {}
1252
-
1253
- # http body (model)
1254
- post_body = nil
1255
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1256
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1257
- :header_params => header_params,
1258
- :query_params => query_params,
1259
- :form_params => form_params,
1260
- :body => post_body,
1261
- :auth_names => auth_names,
1262
- :return_type => 'OrderRefundableResponse')
1263
- if @api_client.config.debugging
1264
- @api_client.config.logger.debug "API called: OrderApi#is_refundable_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1265
- end
1266
- return data, status_code, headers
1267
- end
1268
- # Process payment
1269
- # Process payment on order
1270
- # @param order_id The order id to process payment on
1271
- # @param process_payment_request Process payment parameters
1272
- # @param [Hash] opts the optional parameters
1273
- # @return [OrderProcessPaymentResponse]
1274
- def process_payment(order_id, process_payment_request, opts = {})
1275
- data, _status_code, _headers = process_payment_with_http_info(order_id, process_payment_request, opts)
1276
- data
1277
- end
1278
-
1279
- # Process payment
1280
- # Process payment on order
1281
- # @param order_id The order id to process payment on
1282
- # @param process_payment_request Process payment parameters
1283
- # @param [Hash] opts the optional parameters
1284
- # @return [Array<(OrderProcessPaymentResponse, Fixnum, Hash)>] OrderProcessPaymentResponse data, response status code and response headers
1285
- def process_payment_with_http_info(order_id, process_payment_request, opts = {})
1286
- if @api_client.config.debugging
1287
- @api_client.config.logger.debug 'Calling API: OrderApi.process_payment ...'
1288
- end
1289
- # verify the required parameter 'order_id' is set
1290
- if @api_client.config.client_side_validation && order_id.nil?
1291
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.process_payment"
1292
- end
1293
- # verify the required parameter 'process_payment_request' is set
1294
- if @api_client.config.client_side_validation && process_payment_request.nil?
1295
- fail ArgumentError, "Missing the required parameter 'process_payment_request' when calling OrderApi.process_payment"
1296
- end
1297
- # resource path
1298
- local_var_path = '/order/orders/{order_id}/process_payment'.sub('{' + 'order_id' + '}', order_id.to_s)
1299
-
1300
- # query parameters
1301
- query_params = {}
1302
-
1303
- # header parameters
1304
- header_params = {}
1305
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1306
- # HTTP header 'Accept' (if needed)
1307
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1308
- # HTTP header 'Content-Type'
1309
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1310
-
1311
- # form parameters
1312
- form_params = {}
1313
-
1314
- # http body (model)
1315
- post_body = @api_client.object_to_http_body(process_payment_request)
1316
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1317
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1318
- :header_params => header_params,
1319
- :query_params => query_params,
1320
- :form_params => form_params,
1321
- :body => post_body,
1322
- :auth_names => auth_names,
1323
- :return_type => 'OrderProcessPaymentResponse')
1324
- if @api_client.config.debugging
1325
- @api_client.config.logger.debug "API called: OrderApi#process_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1326
- end
1327
- return data, status_code, headers
1328
- end
1329
- # Refund an order
1330
- # Perform a refund operation on an order and then update the order if successful. All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded. UltraCart will calculate the actual amount to refund based upon the prior refunds.
1331
- # @param order Order to refund
1332
- # @param order_id The order id to refund.
1333
- # @param [Hash] opts the optional parameters
1334
- # @option opts [BOOLEAN] :reject_after_refund Reject order after refund (default to false)
1335
- # @option opts [BOOLEAN] :skip_customer_notification Skip customer email notification (default to false)
1336
- # @option opts [BOOLEAN] :auto_order_cancel Cancel associated auto orders (default to false)
1337
- # @option opts [BOOLEAN] :manual_refund Consider a manual refund done externally (default to false)
1338
- # @option opts [BOOLEAN] :reverse_affiliate_transactions Reverse affiliate transactions (default to true)
1339
- # @option opts [BOOLEAN] :issue_store_credit Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account (default to false)
1340
- # @option opts [String] :auto_order_cancel_reason Reason for auto orders cancellation
1341
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1342
- # @return [OrderResponse]
1343
- def refund_order(order, order_id, opts = {})
1344
- data, _status_code, _headers = refund_order_with_http_info(order, order_id, opts)
1345
- data
1346
- end
1347
-
1348
- # Refund an order
1349
- # Perform a refund operation on an order and then update the order if successful. All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded. UltraCart will calculate the actual amount to refund based upon the prior refunds.
1350
- # @param order Order to refund
1351
- # @param order_id The order id to refund.
1352
- # @param [Hash] opts the optional parameters
1353
- # @option opts [BOOLEAN] :reject_after_refund Reject order after refund
1354
- # @option opts [BOOLEAN] :skip_customer_notification Skip customer email notification
1355
- # @option opts [BOOLEAN] :auto_order_cancel Cancel associated auto orders
1356
- # @option opts [BOOLEAN] :manual_refund Consider a manual refund done externally
1357
- # @option opts [BOOLEAN] :reverse_affiliate_transactions Reverse affiliate transactions
1358
- # @option opts [BOOLEAN] :issue_store_credit Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
1359
- # @option opts [String] :auto_order_cancel_reason Reason for auto orders cancellation
1360
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1361
- # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
1362
- def refund_order_with_http_info(order, order_id, opts = {})
1363
- if @api_client.config.debugging
1364
- @api_client.config.logger.debug 'Calling API: OrderApi.refund_order ...'
1365
- end
1366
- # verify the required parameter 'order' is set
1367
- if @api_client.config.client_side_validation && order.nil?
1368
- fail ArgumentError, "Missing the required parameter 'order' when calling OrderApi.refund_order"
1369
- end
1370
- # verify the required parameter 'order_id' is set
1371
- if @api_client.config.client_side_validation && order_id.nil?
1372
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.refund_order"
1373
- end
1374
- # resource path
1375
- local_var_path = '/order/orders/{order_id}/refund'.sub('{' + 'order_id' + '}', order_id.to_s)
1376
-
1377
- # query parameters
1378
- query_params = {}
1379
- query_params[:'reject_after_refund'] = opts[:'reject_after_refund'] if !opts[:'reject_after_refund'].nil?
1380
- query_params[:'skip_customer_notification'] = opts[:'skip_customer_notification'] if !opts[:'skip_customer_notification'].nil?
1381
- query_params[:'auto_order_cancel'] = opts[:'auto_order_cancel'] if !opts[:'auto_order_cancel'].nil?
1382
- query_params[:'manual_refund'] = opts[:'manual_refund'] if !opts[:'manual_refund'].nil?
1383
- query_params[:'reverse_affiliate_transactions'] = opts[:'reverse_affiliate_transactions'] if !opts[:'reverse_affiliate_transactions'].nil?
1384
- query_params[:'issue_store_credit'] = opts[:'issue_store_credit'] if !opts[:'issue_store_credit'].nil?
1385
- query_params[:'auto_order_cancel_reason'] = opts[:'auto_order_cancel_reason'] if !opts[:'auto_order_cancel_reason'].nil?
1386
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1387
-
1388
- # header parameters
1389
- header_params = {}
1390
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1391
- # HTTP header 'Accept' (if needed)
1392
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1393
- # HTTP header 'Content-Type'
1394
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1395
-
1396
- # form parameters
1397
- form_params = {}
1398
-
1399
- # http body (model)
1400
- post_body = @api_client.object_to_http_body(order)
1401
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1402
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1403
- :header_params => header_params,
1404
- :query_params => query_params,
1405
- :form_params => form_params,
1406
- :body => post_body,
1407
- :auth_names => auth_names,
1408
- :return_type => 'OrderResponse')
1409
- if @api_client.config.debugging
1410
- @api_client.config.logger.debug "API called: OrderApi#refund_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1411
- end
1412
- return data, status_code, headers
1413
- end
1414
- # Replaces an order item id
1415
- # Replaces a single order item id with another merchant_item_id, leaving all other attributes and properties unchanged. A custom method requested by a merchant to allow for item id updates due to shipping errors. It is doubtful you will ever need this method. The expansion variable affects the returned order object.
1416
- # @param replace_order_item_id_request Replacement Request
1417
- # @param order_id The order id to update.
1418
- # @param [Hash] opts the optional parameters
1419
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1420
- # @return [OrderResponse]
1421
- def replace_order_item_merchant_item_id(replace_order_item_id_request, order_id, opts = {})
1422
- data, _status_code, _headers = replace_order_item_merchant_item_id_with_http_info(replace_order_item_id_request, order_id, opts)
1423
- data
1424
- end
1425
-
1426
- # Replaces an order item id
1427
- # Replaces a single order item id with another merchant_item_id, leaving all other attributes and properties unchanged. A custom method requested by a merchant to allow for item id updates due to shipping errors. It is doubtful you will ever need this method. The expansion variable affects the returned order object.
1428
- # @param replace_order_item_id_request Replacement Request
1429
- # @param order_id The order id to update.
1430
- # @param [Hash] opts the optional parameters
1431
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1432
- # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
1433
- def replace_order_item_merchant_item_id_with_http_info(replace_order_item_id_request, order_id, opts = {})
1434
- if @api_client.config.debugging
1435
- @api_client.config.logger.debug 'Calling API: OrderApi.replace_order_item_merchant_item_id ...'
1436
- end
1437
- # verify the required parameter 'replace_order_item_id_request' is set
1438
- if @api_client.config.client_side_validation && replace_order_item_id_request.nil?
1439
- fail ArgumentError, "Missing the required parameter 'replace_order_item_id_request' when calling OrderApi.replace_order_item_merchant_item_id"
1440
- end
1441
- # verify the required parameter 'order_id' is set
1442
- if @api_client.config.client_side_validation && order_id.nil?
1443
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.replace_order_item_merchant_item_id"
1444
- end
1445
- # resource path
1446
- local_var_path = '/order/orders/{order_id}/replace_item_id'.sub('{' + 'order_id' + '}', order_id.to_s)
1447
-
1448
- # query parameters
1449
- query_params = {}
1450
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1451
-
1452
- # header parameters
1453
- header_params = {}
1454
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1455
- # HTTP header 'Accept' (if needed)
1456
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1457
- # HTTP header 'Content-Type'
1458
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1459
-
1460
- # form parameters
1461
- form_params = {}
1462
-
1463
- # http body (model)
1464
- post_body = @api_client.object_to_http_body(replace_order_item_id_request)
1465
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1466
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1467
- :header_params => header_params,
1468
- :query_params => query_params,
1469
- :form_params => form_params,
1470
- :body => post_body,
1471
- :auth_names => auth_names,
1472
- :return_type => 'OrderResponse')
1473
- if @api_client.config.debugging
1474
- @api_client.config.logger.debug "API called: OrderApi#replace_order_item_merchant_item_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1475
- end
1476
- return data, status_code, headers
1477
- end
1478
- # Replacement order
1479
- # Create a replacement order based upon a previous order
1480
- # @param order_id The order id to generate a replacement for.
1481
- # @param replacement Replacement order details
1482
- # @param [Hash] opts the optional parameters
1483
- # @return [OrderReplacementResponse]
1484
- def replacement(order_id, replacement, opts = {})
1485
- data, _status_code, _headers = replacement_with_http_info(order_id, replacement, opts)
1486
- data
1487
- end
1488
-
1489
- # Replacement order
1490
- # Create a replacement order based upon a previous order
1491
- # @param order_id The order id to generate a replacement for.
1492
- # @param replacement Replacement order details
1493
- # @param [Hash] opts the optional parameters
1494
- # @return [Array<(OrderReplacementResponse, Fixnum, Hash)>] OrderReplacementResponse data, response status code and response headers
1495
- def replacement_with_http_info(order_id, replacement, opts = {})
1496
- if @api_client.config.debugging
1497
- @api_client.config.logger.debug 'Calling API: OrderApi.replacement ...'
1498
- end
1499
- # verify the required parameter 'order_id' is set
1500
- if @api_client.config.client_side_validation && order_id.nil?
1501
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.replacement"
1502
- end
1503
- # verify the required parameter 'replacement' is set
1504
- if @api_client.config.client_side_validation && replacement.nil?
1505
- fail ArgumentError, "Missing the required parameter 'replacement' when calling OrderApi.replacement"
1506
- end
1507
- # resource path
1508
- local_var_path = '/order/orders/{order_id}/replacement'.sub('{' + 'order_id' + '}', order_id.to_s)
1509
-
1510
- # query parameters
1511
- query_params = {}
1512
-
1513
- # header parameters
1514
- header_params = {}
1515
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1516
- # HTTP header 'Accept' (if needed)
1517
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1518
- # HTTP header 'Content-Type'
1519
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1520
-
1521
- # form parameters
1522
- form_params = {}
1523
-
1524
- # http body (model)
1525
- post_body = @api_client.object_to_http_body(replacement)
1526
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1527
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1528
- :header_params => header_params,
1529
- :query_params => query_params,
1530
- :form_params => form_params,
1531
- :body => post_body,
1532
- :auth_names => auth_names,
1533
- :return_type => 'OrderReplacementResponse')
1534
- if @api_client.config.debugging
1535
- @api_client.config.logger.debug "API called: OrderApi#replacement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1536
- end
1537
- return data, status_code, headers
1538
- end
1539
- # Resend receipt
1540
- # Resend the receipt for an order on the UltraCart account.
1541
- # @param order_id The order id to resend the receipt for.
1542
- # @param [Hash] opts the optional parameters
1543
- # @return [BaseResponse]
1544
- def resend_receipt(order_id, opts = {})
1545
- data, _status_code, _headers = resend_receipt_with_http_info(order_id, opts)
1546
- data
1547
- end
1548
-
1549
- # Resend receipt
1550
- # Resend the receipt for an order on the UltraCart account.
1551
- # @param order_id The order id to resend the receipt for.
1552
- # @param [Hash] opts the optional parameters
1553
- # @return [Array<(BaseResponse, Fixnum, Hash)>] BaseResponse data, response status code and response headers
1554
- def resend_receipt_with_http_info(order_id, opts = {})
1555
- if @api_client.config.debugging
1556
- @api_client.config.logger.debug 'Calling API: OrderApi.resend_receipt ...'
1557
- end
1558
- # verify the required parameter 'order_id' is set
1559
- if @api_client.config.client_side_validation && order_id.nil?
1560
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.resend_receipt"
1561
- end
1562
- # resource path
1563
- local_var_path = '/order/orders/{order_id}/resend_receipt'.sub('{' + 'order_id' + '}', order_id.to_s)
1564
-
1565
- # query parameters
1566
- query_params = {}
1567
-
1568
- # header parameters
1569
- header_params = {}
1570
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1571
- # HTTP header 'Accept' (if needed)
1572
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1573
- # HTTP header 'Content-Type'
1574
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1575
-
1576
- # form parameters
1577
- form_params = {}
1578
-
1579
- # http body (model)
1580
- post_body = nil
1581
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1582
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1583
- :header_params => header_params,
1584
- :query_params => query_params,
1585
- :form_params => form_params,
1586
- :body => post_body,
1587
- :auth_names => auth_names,
1588
- :return_type => 'BaseResponse')
1589
- if @api_client.config.debugging
1590
- @api_client.config.logger.debug "API called: OrderApi#resend_receipt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1591
- end
1592
- return data, status_code, headers
1593
- end
1594
- # Resend shipment confirmation
1595
- # Resend shipment confirmation for an order on the UltraCart account.
1596
- # @param order_id The order id to resend the shipment notification for.
1597
- # @param [Hash] opts the optional parameters
1598
- # @return [BaseResponse]
1599
- def resend_shipment_confirmation(order_id, opts = {})
1600
- data, _status_code, _headers = resend_shipment_confirmation_with_http_info(order_id, opts)
1601
- data
1602
- end
1603
-
1604
- # Resend shipment confirmation
1605
- # Resend shipment confirmation for an order on the UltraCart account.
1606
- # @param order_id The order id to resend the shipment notification for.
1607
- # @param [Hash] opts the optional parameters
1608
- # @return [Array<(BaseResponse, Fixnum, Hash)>] BaseResponse data, response status code and response headers
1609
- def resend_shipment_confirmation_with_http_info(order_id, opts = {})
1610
- if @api_client.config.debugging
1611
- @api_client.config.logger.debug 'Calling API: OrderApi.resend_shipment_confirmation ...'
1612
- end
1613
- # verify the required parameter 'order_id' is set
1614
- if @api_client.config.client_side_validation && order_id.nil?
1615
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.resend_shipment_confirmation"
1616
- end
1617
- # resource path
1618
- local_var_path = '/order/orders/{order_id}/resend_shipment_confirmation'.sub('{' + 'order_id' + '}', order_id.to_s)
1619
-
1620
- # query parameters
1621
- query_params = {}
1622
-
1623
- # header parameters
1624
- header_params = {}
1625
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1626
- # HTTP header 'Accept' (if needed)
1627
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1628
- # HTTP header 'Content-Type'
1629
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1630
-
1631
- # form parameters
1632
- form_params = {}
1633
-
1634
- # http body (model)
1635
- post_body = nil
1636
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1637
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1638
- :header_params => header_params,
1639
- :query_params => query_params,
1640
- :form_params => form_params,
1641
- :body => post_body,
1642
- :auth_names => auth_names,
1643
- :return_type => 'BaseResponse')
1644
- if @api_client.config.debugging
1645
- @api_client.config.logger.debug "API called: OrderApi#resend_shipment_confirmation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1646
- end
1647
- return data, status_code, headers
1648
- end
1649
- # Remove a refund block on an order
1650
- # Removes a refund block on an order to prevent a user from performing a refund.
1651
- # @param order_id The order id to unblock a refund on.
1652
- # @param [Hash] opts the optional parameters
1653
- # @return [nil]
1654
- def unblock_refund_on_order(order_id, opts = {})
1655
- unblock_refund_on_order_with_http_info(order_id, opts)
1656
- nil
1657
- end
1658
-
1659
- # Remove a refund block on an order
1660
- # Removes a refund block on an order to prevent a user from performing a refund.
1661
- # @param order_id The order id to unblock a refund on.
1662
- # @param [Hash] opts the optional parameters
1663
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1664
- def unblock_refund_on_order_with_http_info(order_id, opts = {})
1665
- if @api_client.config.debugging
1666
- @api_client.config.logger.debug 'Calling API: OrderApi.unblock_refund_on_order ...'
1667
- end
1668
- # verify the required parameter 'order_id' is set
1669
- if @api_client.config.client_side_validation && order_id.nil?
1670
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.unblock_refund_on_order"
1671
- end
1672
- # resource path
1673
- local_var_path = '/order/orders/{order_id}/refund_unblock'.sub('{' + 'order_id' + '}', order_id.to_s)
1674
-
1675
- # query parameters
1676
- query_params = {}
1677
-
1678
- # header parameters
1679
- header_params = {}
1680
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1681
- # HTTP header 'Accept' (if needed)
1682
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1683
- # HTTP header 'Content-Type'
1684
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1685
-
1686
- # form parameters
1687
- form_params = {}
1688
-
1689
- # http body (model)
1690
- post_body = nil
1691
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1692
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1693
- :header_params => header_params,
1694
- :query_params => query_params,
1695
- :form_params => form_params,
1696
- :body => post_body,
1697
- :auth_names => auth_names)
1698
- if @api_client.config.debugging
1699
- @api_client.config.logger.debug "API called: OrderApi#unblock_refund_on_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1700
- end
1701
- return data, status_code, headers
1702
- end
1703
- # Update A/R Retry Configuration
1704
- # Update A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.
1705
- # @param retry_config AccountsReceivableRetryConfig object
1706
- # @param [Hash] opts the optional parameters
1707
- # @return [BaseResponse]
1708
- def update_accounts_receivable_retry_config(retry_config, opts = {})
1709
- data, _status_code, _headers = update_accounts_receivable_retry_config_with_http_info(retry_config, opts)
1710
- data
1711
- end
1712
-
1713
- # Update A/R Retry Configuration
1714
- # Update A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.
1715
- # @param retry_config AccountsReceivableRetryConfig object
1716
- # @param [Hash] opts the optional parameters
1717
- # @return [Array<(BaseResponse, Fixnum, Hash)>] BaseResponse data, response status code and response headers
1718
- def update_accounts_receivable_retry_config_with_http_info(retry_config, opts = {})
1719
- if @api_client.config.debugging
1720
- @api_client.config.logger.debug 'Calling API: OrderApi.update_accounts_receivable_retry_config ...'
1721
- end
1722
- # verify the required parameter 'retry_config' is set
1723
- if @api_client.config.client_side_validation && retry_config.nil?
1724
- fail ArgumentError, "Missing the required parameter 'retry_config' when calling OrderApi.update_accounts_receivable_retry_config"
1725
- end
1726
- # resource path
1727
- local_var_path = '/order/accountsReceivableRetryConfig'
1728
-
1729
- # query parameters
1730
- query_params = {}
1731
-
1732
- # header parameters
1733
- header_params = {}
1734
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1735
- # HTTP header 'Accept' (if needed)
1736
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1737
- # HTTP header 'Content-Type'
1738
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1739
-
1740
- # form parameters
1741
- form_params = {}
1742
-
1743
- # http body (model)
1744
- post_body = @api_client.object_to_http_body(retry_config)
1745
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1746
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1747
- :header_params => header_params,
1748
- :query_params => query_params,
1749
- :form_params => form_params,
1750
- :body => post_body,
1751
- :auth_names => auth_names,
1752
- :return_type => 'BaseResponse')
1753
- if @api_client.config.debugging
1754
- @api_client.config.logger.debug "API called: OrderApi#update_accounts_receivable_retry_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1755
- end
1756
- return data, status_code, headers
1757
- end
1758
- # Update an order
1759
- # Update a new order on the UltraCart account. This is probably NOT the method you want. It is rare to update a completed order. This will not trigger charges, emails, or any other automation.
1760
- # @param order Order to update
1761
- # @param order_id The order id to update.
1762
- # @param [Hash] opts the optional parameters
1763
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1764
- # @return [OrderResponse]
1765
- def update_order(order, order_id, opts = {})
1766
- data, _status_code, _headers = update_order_with_http_info(order, order_id, opts)
1767
- data
1768
- end
1769
-
1770
- # Update an order
1771
- # Update a new order on the UltraCart account. This is probably NOT the method you want. It is rare to update a completed order. This will not trigger charges, emails, or any other automation.
1772
- # @param order Order to update
1773
- # @param order_id The order id to update.
1774
- # @param [Hash] opts the optional parameters
1775
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1776
- # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
1777
- def update_order_with_http_info(order, order_id, opts = {})
1778
- if @api_client.config.debugging
1779
- @api_client.config.logger.debug 'Calling API: OrderApi.update_order ...'
1780
- end
1781
- # verify the required parameter 'order' is set
1782
- if @api_client.config.client_side_validation && order.nil?
1783
- fail ArgumentError, "Missing the required parameter 'order' when calling OrderApi.update_order"
1784
- end
1785
- # verify the required parameter 'order_id' is set
1786
- if @api_client.config.client_side_validation && order_id.nil?
1787
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.update_order"
1788
- end
1789
- # resource path
1790
- local_var_path = '/order/orders/{order_id}'.sub('{' + 'order_id' + '}', order_id.to_s)
1791
-
1792
- # query parameters
1793
- query_params = {}
1794
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1795
-
1796
- # header parameters
1797
- header_params = {}
1798
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1799
- # HTTP header 'Accept' (if needed)
1800
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1801
- # HTTP header 'Content-Type'
1802
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1803
-
1804
- # form parameters
1805
- form_params = {}
1806
-
1807
- # http body (model)
1808
- post_body = @api_client.object_to_http_body(order)
1809
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1810
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1811
- :header_params => header_params,
1812
- :query_params => query_params,
1813
- :form_params => form_params,
1814
- :body => post_body,
1815
- :auth_names => auth_names,
1816
- :return_type => 'OrderResponse')
1817
- if @api_client.config.debugging
1818
- @api_client.config.logger.debug "API called: OrderApi#update_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1819
- end
1820
- return data, status_code, headers
1821
- end
1822
- # Validate
1823
- # Validate the order for errors. Specific checks can be passed to fine tune what is validated. Read and write permissions are required because the validate method may fix obvious address issues automatically which require update permission.This rest call makes use of the built-in translation of rest objects to UltraCart internal objects which also contains a multitude of validation checks that cannot be trapped. Therefore any time this call is made, you should also trap api exceptions and examine their content because it may contain validation issues. So check the response object and trap any exceptions.
1824
- # @param validation_request Validation request
1825
- # @param [Hash] opts the optional parameters
1826
- # @return [OrderValidationResponse]
1827
- def validate_order(validation_request, opts = {})
1828
- data, _status_code, _headers = validate_order_with_http_info(validation_request, opts)
1829
- data
1830
- end
1831
-
1832
- # Validate
1833
- # Validate the order for errors. Specific checks can be passed to fine tune what is validated. Read and write permissions are required because the validate method may fix obvious address issues automatically which require update permission.This rest call makes use of the built-in translation of rest objects to UltraCart internal objects which also contains a multitude of validation checks that cannot be trapped. Therefore any time this call is made, you should also trap api exceptions and examine their content because it may contain validation issues. So check the response object and trap any exceptions.
1834
- # @param validation_request Validation request
1835
- # @param [Hash] opts the optional parameters
1836
- # @return [Array<(OrderValidationResponse, Fixnum, Hash)>] OrderValidationResponse data, response status code and response headers
1837
- def validate_order_with_http_info(validation_request, opts = {})
1838
- if @api_client.config.debugging
1839
- @api_client.config.logger.debug 'Calling API: OrderApi.validate_order ...'
1840
- end
1841
- # verify the required parameter 'validation_request' is set
1842
- if @api_client.config.client_side_validation && validation_request.nil?
1843
- fail ArgumentError, "Missing the required parameter 'validation_request' when calling OrderApi.validate_order"
1844
- end
1845
- # resource path
1846
- local_var_path = '/order/validate'
1847
-
1848
- # query parameters
1849
- query_params = {}
1850
-
1851
- # header parameters
1852
- header_params = {}
1853
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1854
- # HTTP header 'Accept' (if needed)
1855
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1856
- # HTTP header 'Content-Type'
1857
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1858
-
1859
- # form parameters
1860
- form_params = {}
1861
-
1862
- # http body (model)
1863
- post_body = @api_client.object_to_http_body(validation_request)
1864
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1865
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1866
- :header_params => header_params,
1867
- :query_params => query_params,
1868
- :form_params => form_params,
1869
- :body => post_body,
1870
- :auth_names => auth_names,
1871
- :return_type => 'OrderValidationResponse')
1872
- if @api_client.config.debugging
1873
- @api_client.config.logger.debug "API called: OrderApi#validate_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1874
- end
1875
- return data, status_code, headers
1876
- end
1877
- end
1878
- end
1
+ =begin
2
+ #UltraCart Rest API V2
3
+
4
+ #UltraCart REST API Version 2
5
+
6
+ The version of the OpenAPI document: 2.0.0
7
+ Contact: support@ultracart.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 6.0.1-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module UltracartClient
16
+ class OrderApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+
23
+ def self.new_using_api_key(simple_key, verify_ssl = true, debugging = false)
24
+ api_config = Configuration.new
25
+ api_config.api_key_prefix['x-ultracart-simple-key'] = simple_key
26
+ api_config.api_version = '2017-03-01'
27
+ api_config.verify_ssl = verify_ssl
28
+
29
+ api_client = ApiClient.new(api_config)
30
+ api_client.config.debugging = debugging
31
+
32
+ UltracartClient::OrderApi.new(api_client)
33
+ end
34
+
35
+ # Adjusts an order total
36
+ # Adjusts an order total. Adjusts individual items appropriately and considers taxes. Desired total should be provided in the same currency as the order and must be less than the current total and greater than zero. This call will change the order total. It returns true if the desired total is achieved. If the goal seeking algorithm falls short (usually by pennies), this method returns back false. View the merchant notes for the order for further details.
37
+ # @param order_id [String] The order id to cancel.
38
+ # @param desired_total [String] The desired total with no formatting. example 123.45
39
+ # @param [Hash] opts the optional parameters
40
+ # @return [BaseResponse]
41
+ def adjust_order_total(order_id, desired_total, opts = {})
42
+ data, _status_code, _headers = adjust_order_total_with_http_info(order_id, desired_total, opts)
43
+ data
44
+ end
45
+
46
+ # Adjusts an order total
47
+ # Adjusts an order total. Adjusts individual items appropriately and considers taxes. Desired total should be provided in the same currency as the order and must be less than the current total and greater than zero. This call will change the order total. It returns true if the desired total is achieved. If the goal seeking algorithm falls short (usually by pennies), this method returns back false. View the merchant notes for the order for further details.
48
+ # @param order_id [String] The order id to cancel.
49
+ # @param desired_total [String] The desired total with no formatting. example 123.45
50
+ # @param [Hash] opts the optional parameters
51
+ # @return [Array<(BaseResponse, Integer, Hash)>] BaseResponse data, response status code and response headers
52
+ def adjust_order_total_with_http_info(order_id, desired_total, opts = {})
53
+ if @api_client.config.debugging
54
+ @api_client.config.logger.debug 'Calling API: OrderApi.adjust_order_total ...'
55
+ end
56
+ # verify the required parameter 'order_id' is set
57
+ if @api_client.config.client_side_validation && order_id.nil?
58
+ fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.adjust_order_total"
59
+ end
60
+ # verify the required parameter 'desired_total' is set
61
+ if @api_client.config.client_side_validation && desired_total.nil?
62
+ fail ArgumentError, "Missing the required parameter 'desired_total' when calling OrderApi.adjust_order_total"
63
+ end
64
+ # resource path
65
+ local_var_path = '/order/orders/{order_id}/adjust_order_total/{desired_total}'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s)).sub('{' + 'desired_total' + '}', CGI.escape(desired_total.to_s))
66
+
67
+ # query parameters
68
+ query_params = opts[:query_params] || {}
69
+
70
+ # header parameters
71
+ header_params = opts[:header_params] || {}
72
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
73
+ # HTTP header 'Accept' (if needed)
74
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
75
+
76
+ # form parameters
77
+ form_params = opts[:form_params] || {}
78
+
79
+ # http body (model)
80
+ post_body = opts[:debug_body]
81
+
82
+ # return_type
83
+ return_type = opts[:debug_return_type] || 'BaseResponse'
84
+
85
+ # auth_names
86
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
87
+
88
+ new_options = opts.merge(
89
+ :operation => :"OrderApi.adjust_order_total",
90
+ :header_params => header_params,
91
+ :query_params => query_params,
92
+ :form_params => form_params,
93
+ :body => post_body,
94
+ :auth_names => auth_names,
95
+ :return_type => return_type
96
+ )
97
+
98
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
99
+ if @api_client.config.debugging
100
+ @api_client.config.logger.debug "API called: OrderApi#adjust_order_total\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
101
+ end
102
+ return data, status_code, headers
103
+ end
104
+
105
+ # Cancel an order
106
+ # Cancel an order on the UltraCart account. If the success flag is false, then consult the error message for why it failed.
107
+ # @param order_id [String] The order id to cancel.
108
+ # @param [Hash] opts the optional parameters
109
+ # @return [BaseResponse]
110
+ def cancel_order(order_id, opts = {})
111
+ data, _status_code, _headers = cancel_order_with_http_info(order_id, opts)
112
+ data
113
+ end
114
+
115
+ # Cancel an order
116
+ # Cancel an order on the UltraCart account. If the success flag is false, then consult the error message for why it failed.
117
+ # @param order_id [String] The order id to cancel.
118
+ # @param [Hash] opts the optional parameters
119
+ # @return [Array<(BaseResponse, Integer, Hash)>] BaseResponse data, response status code and response headers
120
+ def cancel_order_with_http_info(order_id, opts = {})
121
+ if @api_client.config.debugging
122
+ @api_client.config.logger.debug 'Calling API: OrderApi.cancel_order ...'
123
+ end
124
+ # verify the required parameter 'order_id' is set
125
+ if @api_client.config.client_side_validation && order_id.nil?
126
+ fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.cancel_order"
127
+ end
128
+ # resource path
129
+ local_var_path = '/order/orders/{order_id}/cancel'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))
130
+
131
+ # query parameters
132
+ query_params = opts[:query_params] || {}
133
+
134
+ # header parameters
135
+ header_params = opts[:header_params] || {}
136
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
137
+ # HTTP header 'Accept' (if needed)
138
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
139
+
140
+ # form parameters
141
+ form_params = opts[:form_params] || {}
142
+
143
+ # http body (model)
144
+ post_body = opts[:debug_body]
145
+
146
+ # return_type
147
+ return_type = opts[:debug_return_type] || 'BaseResponse'
148
+
149
+ # auth_names
150
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
151
+
152
+ new_options = opts.merge(
153
+ :operation => :"OrderApi.cancel_order",
154
+ :header_params => header_params,
155
+ :query_params => query_params,
156
+ :form_params => form_params,
157
+ :body => post_body,
158
+ :auth_names => auth_names,
159
+ :return_type => return_type
160
+ )
161
+
162
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
163
+ if @api_client.config.debugging
164
+ @api_client.config.logger.debug "API called: OrderApi#cancel_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
165
+ end
166
+ return data, status_code, headers
167
+ end
168
+
169
+ # Delete an order
170
+ # Delete an order on the UltraCart account.
171
+ # @param order_id [String] The order id to delete.
172
+ # @param [Hash] opts the optional parameters
173
+ # @return [nil]
174
+ def delete_order(order_id, opts = {})
175
+ delete_order_with_http_info(order_id, opts)
176
+ nil
177
+ end
178
+
179
+ # Delete an order
180
+ # Delete an order on the UltraCart account.
181
+ # @param order_id [String] The order id to delete.
182
+ # @param [Hash] opts the optional parameters
183
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
184
+ def delete_order_with_http_info(order_id, opts = {})
185
+ if @api_client.config.debugging
186
+ @api_client.config.logger.debug 'Calling API: OrderApi.delete_order ...'
187
+ end
188
+ # verify the required parameter 'order_id' is set
189
+ if @api_client.config.client_side_validation && order_id.nil?
190
+ fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.delete_order"
191
+ end
192
+ # resource path
193
+ local_var_path = '/order/orders/{order_id}'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))
194
+
195
+ # query parameters
196
+ query_params = opts[:query_params] || {}
197
+
198
+ # header parameters
199
+ header_params = opts[:header_params] || {}
200
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
201
+ # HTTP header 'Accept' (if needed)
202
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
203
+
204
+ # form parameters
205
+ form_params = opts[:form_params] || {}
206
+
207
+ # http body (model)
208
+ post_body = opts[:debug_body]
209
+
210
+ # return_type
211
+ return_type = opts[:debug_return_type]
212
+
213
+ # auth_names
214
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
215
+
216
+ new_options = opts.merge(
217
+ :operation => :"OrderApi.delete_order",
218
+ :header_params => header_params,
219
+ :query_params => query_params,
220
+ :form_params => form_params,
221
+ :body => post_body,
222
+ :auth_names => auth_names,
223
+ :return_type => return_type
224
+ )
225
+
226
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
227
+ if @api_client.config.debugging
228
+ @api_client.config.logger.debug "API called: OrderApi#delete_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
229
+ end
230
+ return data, status_code, headers
231
+ end
232
+
233
+ # Duplicate an order
234
+ # Perform a duplicate of the specified order_id and return a new order located in Accounts Receivable.
235
+ # @param order_id [String] The order id to duplicate.
236
+ # @param [Hash] opts the optional parameters
237
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
238
+ # @return [OrderResponse]
239
+ def duplicate_order(order_id, opts = {})
240
+ data, _status_code, _headers = duplicate_order_with_http_info(order_id, opts)
241
+ data
242
+ end
243
+
244
+ # Duplicate an order
245
+ # Perform a duplicate of the specified order_id and return a new order located in Accounts Receivable.
246
+ # @param order_id [String] The order id to duplicate.
247
+ # @param [Hash] opts the optional parameters
248
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
249
+ # @return [Array<(OrderResponse, Integer, Hash)>] OrderResponse data, response status code and response headers
250
+ def duplicate_order_with_http_info(order_id, opts = {})
251
+ if @api_client.config.debugging
252
+ @api_client.config.logger.debug 'Calling API: OrderApi.duplicate_order ...'
253
+ end
254
+ # verify the required parameter 'order_id' is set
255
+ if @api_client.config.client_side_validation && order_id.nil?
256
+ fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.duplicate_order"
257
+ end
258
+ # resource path
259
+ local_var_path = '/order/orders/{order_id}/duplicate'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))
260
+
261
+ # query parameters
262
+ query_params = opts[:query_params] || {}
263
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
264
+
265
+ # header parameters
266
+ header_params = opts[:header_params] || {}
267
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
268
+ # HTTP header 'Accept' (if needed)
269
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
270
+
271
+ # form parameters
272
+ form_params = opts[:form_params] || {}
273
+
274
+ # http body (model)
275
+ post_body = opts[:debug_body]
276
+
277
+ # return_type
278
+ return_type = opts[:debug_return_type] || 'OrderResponse'
279
+
280
+ # auth_names
281
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
282
+
283
+ new_options = opts.merge(
284
+ :operation => :"OrderApi.duplicate_order",
285
+ :header_params => header_params,
286
+ :query_params => query_params,
287
+ :form_params => form_params,
288
+ :body => post_body,
289
+ :auth_names => auth_names,
290
+ :return_type => return_type
291
+ )
292
+
293
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
294
+ if @api_client.config.debugging
295
+ @api_client.config.logger.debug "API called: OrderApi#duplicate_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
296
+ end
297
+ return data, status_code, headers
298
+ end
299
+
300
+ # Format order
301
+ # Format the order for display at text or html
302
+ # @param order_id [String] The order id to format
303
+ # @param format_options [OrderFormat] Format options
304
+ # @param [Hash] opts the optional parameters
305
+ # @return [OrderFormatResponse]
306
+ def format(order_id, format_options, opts = {})
307
+ data, _status_code, _headers = format_with_http_info(order_id, format_options, opts)
308
+ data
309
+ end
310
+
311
+ # Format order
312
+ # Format the order for display at text or html
313
+ # @param order_id [String] The order id to format
314
+ # @param format_options [OrderFormat] Format options
315
+ # @param [Hash] opts the optional parameters
316
+ # @return [Array<(OrderFormatResponse, Integer, Hash)>] OrderFormatResponse data, response status code and response headers
317
+ def format_with_http_info(order_id, format_options, opts = {})
318
+ if @api_client.config.debugging
319
+ @api_client.config.logger.debug 'Calling API: OrderApi.format ...'
320
+ end
321
+ # verify the required parameter 'order_id' is set
322
+ if @api_client.config.client_side_validation && order_id.nil?
323
+ fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.format"
324
+ end
325
+ # verify the required parameter 'format_options' is set
326
+ if @api_client.config.client_side_validation && format_options.nil?
327
+ fail ArgumentError, "Missing the required parameter 'format_options' when calling OrderApi.format"
328
+ end
329
+ # resource path
330
+ local_var_path = '/order/orders/{order_id}/format'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))
331
+
332
+ # query parameters
333
+ query_params = opts[:query_params] || {}
334
+
335
+ # header parameters
336
+ header_params = opts[:header_params] || {}
337
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
338
+ # HTTP header 'Accept' (if needed)
339
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
340
+ # HTTP header 'Content-Type'
341
+ content_type = @api_client.select_header_content_type(['application/json'])
342
+ if !content_type.nil?
343
+ header_params['Content-Type'] = content_type
344
+ end
345
+
346
+ # form parameters
347
+ form_params = opts[:form_params] || {}
348
+
349
+ # http body (model)
350
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(format_options)
351
+
352
+ # return_type
353
+ return_type = opts[:debug_return_type] || 'OrderFormatResponse'
354
+
355
+ # auth_names
356
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
357
+
358
+ new_options = opts.merge(
359
+ :operation => :"OrderApi.format",
360
+ :header_params => header_params,
361
+ :query_params => query_params,
362
+ :form_params => form_params,
363
+ :body => post_body,
364
+ :auth_names => auth_names,
365
+ :return_type => return_type
366
+ )
367
+
368
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
369
+ if @api_client.config.debugging
370
+ @api_client.config.logger.debug "API called: OrderApi#format\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
371
+ end
372
+ return data, status_code, headers
373
+ end
374
+
375
+ # Generate an order token for a given order id
376
+ # Retrieves a single order token for a given order id. The token can be used with the getOrderByToken API.
377
+ # @param order_id [String] The order id to generate a token for.
378
+ # @param [Hash] opts the optional parameters
379
+ # @return [OrderTokenResponse]
380
+ def generate_order_token(order_id, opts = {})
381
+ data, _status_code, _headers = generate_order_token_with_http_info(order_id, opts)
382
+ data
383
+ end
384
+
385
+ # Generate an order token for a given order id
386
+ # Retrieves a single order token for a given order id. The token can be used with the getOrderByToken API.
387
+ # @param order_id [String] The order id to generate a token for.
388
+ # @param [Hash] opts the optional parameters
389
+ # @return [Array<(OrderTokenResponse, Integer, Hash)>] OrderTokenResponse data, response status code and response headers
390
+ def generate_order_token_with_http_info(order_id, opts = {})
391
+ if @api_client.config.debugging
392
+ @api_client.config.logger.debug 'Calling API: OrderApi.generate_order_token ...'
393
+ end
394
+ # verify the required parameter 'order_id' is set
395
+ if @api_client.config.client_side_validation && order_id.nil?
396
+ fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.generate_order_token"
397
+ end
398
+ # resource path
399
+ local_var_path = '/order/orders/token/{order_id}'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))
400
+
401
+ # query parameters
402
+ query_params = opts[:query_params] || {}
403
+
404
+ # header parameters
405
+ header_params = opts[:header_params] || {}
406
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
407
+ # HTTP header 'Accept' (if needed)
408
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
409
+
410
+ # form parameters
411
+ form_params = opts[:form_params] || {}
412
+
413
+ # http body (model)
414
+ post_body = opts[:debug_body]
415
+
416
+ # return_type
417
+ return_type = opts[:debug_return_type] || 'OrderTokenResponse'
418
+
419
+ # auth_names
420
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
421
+
422
+ new_options = opts.merge(
423
+ :operation => :"OrderApi.generate_order_token",
424
+ :header_params => header_params,
425
+ :query_params => query_params,
426
+ :form_params => form_params,
427
+ :body => post_body,
428
+ :auth_names => auth_names,
429
+ :return_type => return_type
430
+ )
431
+
432
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
433
+ if @api_client.config.debugging
434
+ @api_client.config.logger.debug "API called: OrderApi#generate_order_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
435
+ end
436
+ return data, status_code, headers
437
+ end
438
+
439
+ # Generate a packing slip for this order across all distribution centers.
440
+ # The packing slip PDF that is returned is base 64 encoded
441
+ # @param order_id [String] Order ID
442
+ # @param [Hash] opts the optional parameters
443
+ # @return [OrderPackingSlipResponse]
444
+ def generate_packing_slip_all_dc(order_id, opts = {})
445
+ data, _status_code, _headers = generate_packing_slip_all_dc_with_http_info(order_id, opts)
446
+ data
447
+ end
448
+
449
+ # Generate a packing slip for this order across all distribution centers.
450
+ # The packing slip PDF that is returned is base 64 encoded
451
+ # @param order_id [String] Order ID
452
+ # @param [Hash] opts the optional parameters
453
+ # @return [Array<(OrderPackingSlipResponse, Integer, Hash)>] OrderPackingSlipResponse data, response status code and response headers
454
+ def generate_packing_slip_all_dc_with_http_info(order_id, opts = {})
455
+ if @api_client.config.debugging
456
+ @api_client.config.logger.debug 'Calling API: OrderApi.generate_packing_slip_all_dc ...'
457
+ end
458
+ # verify the required parameter 'order_id' is set
459
+ if @api_client.config.client_side_validation && order_id.nil?
460
+ fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.generate_packing_slip_all_dc"
461
+ end
462
+ # resource path
463
+ local_var_path = '/order/orders/{order_id}/packing_slip'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))
464
+
465
+ # query parameters
466
+ query_params = opts[:query_params] || {}
467
+
468
+ # header parameters
469
+ header_params = opts[:header_params] || {}
470
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
471
+ # HTTP header 'Accept' (if needed)
472
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
473
+
474
+ # form parameters
475
+ form_params = opts[:form_params] || {}
476
+
477
+ # http body (model)
478
+ post_body = opts[:debug_body]
479
+
480
+ # return_type
481
+ return_type = opts[:debug_return_type] || 'OrderPackingSlipResponse'
482
+
483
+ # auth_names
484
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
485
+
486
+ new_options = opts.merge(
487
+ :operation => :"OrderApi.generate_packing_slip_all_dc",
488
+ :header_params => header_params,
489
+ :query_params => query_params,
490
+ :form_params => form_params,
491
+ :body => post_body,
492
+ :auth_names => auth_names,
493
+ :return_type => return_type
494
+ )
495
+
496
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
497
+ if @api_client.config.debugging
498
+ @api_client.config.logger.debug "API called: OrderApi#generate_packing_slip_all_dc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
499
+ end
500
+ return data, status_code, headers
501
+ end
502
+
503
+ # Generate a packing slip for this order for the given distribution center.
504
+ # The packing slip PDF that is returned is base 64 encoded
505
+ # @param distribution_center_code [String] Distribution center code
506
+ # @param order_id [String] Order ID
507
+ # @param [Hash] opts the optional parameters
508
+ # @return [OrderPackingSlipResponse]
509
+ def generate_packing_slip_specific_dc(distribution_center_code, order_id, opts = {})
510
+ data, _status_code, _headers = generate_packing_slip_specific_dc_with_http_info(distribution_center_code, order_id, opts)
511
+ data
512
+ end
513
+
514
+ # Generate a packing slip for this order for the given distribution center.
515
+ # The packing slip PDF that is returned is base 64 encoded
516
+ # @param distribution_center_code [String] Distribution center code
517
+ # @param order_id [String] Order ID
518
+ # @param [Hash] opts the optional parameters
519
+ # @return [Array<(OrderPackingSlipResponse, Integer, Hash)>] OrderPackingSlipResponse data, response status code and response headers
520
+ def generate_packing_slip_specific_dc_with_http_info(distribution_center_code, order_id, opts = {})
521
+ if @api_client.config.debugging
522
+ @api_client.config.logger.debug 'Calling API: OrderApi.generate_packing_slip_specific_dc ...'
523
+ end
524
+ # verify the required parameter 'distribution_center_code' is set
525
+ if @api_client.config.client_side_validation && distribution_center_code.nil?
526
+ fail ArgumentError, "Missing the required parameter 'distribution_center_code' when calling OrderApi.generate_packing_slip_specific_dc"
527
+ end
528
+ # verify the required parameter 'order_id' is set
529
+ if @api_client.config.client_side_validation && order_id.nil?
530
+ fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.generate_packing_slip_specific_dc"
531
+ end
532
+ # resource path
533
+ local_var_path = '/order/orders/{order_id}/packing_slip/{distribution_center_code}'.sub('{' + 'distribution_center_code' + '}', CGI.escape(distribution_center_code.to_s)).sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))
534
+
535
+ # query parameters
536
+ query_params = opts[:query_params] || {}
537
+
538
+ # header parameters
539
+ header_params = opts[:header_params] || {}
540
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
541
+ # HTTP header 'Accept' (if needed)
542
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
543
+
544
+ # form parameters
545
+ form_params = opts[:form_params] || {}
546
+
547
+ # http body (model)
548
+ post_body = opts[:debug_body]
549
+
550
+ # return_type
551
+ return_type = opts[:debug_return_type] || 'OrderPackingSlipResponse'
552
+
553
+ # auth_names
554
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
555
+
556
+ new_options = opts.merge(
557
+ :operation => :"OrderApi.generate_packing_slip_specific_dc",
558
+ :header_params => header_params,
559
+ :query_params => query_params,
560
+ :form_params => form_params,
561
+ :body => post_body,
562
+ :auth_names => auth_names,
563
+ :return_type => return_type
564
+ )
565
+
566
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
567
+ if @api_client.config.debugging
568
+ @api_client.config.logger.debug "API called: OrderApi#generate_packing_slip_specific_dc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
569
+ end
570
+ return data, status_code, headers
571
+ end
572
+
573
+ # Retrieve A/R Retry Configuration
574
+ # Retrieve A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.
575
+ # @param [Hash] opts the optional parameters
576
+ # @return [AccountsReceivableRetryConfigResponse]
577
+ def get_accounts_receivable_retry_config(opts = {})
578
+ data, _status_code, _headers = get_accounts_receivable_retry_config_with_http_info(opts)
579
+ data
580
+ end
581
+
582
+ # Retrieve A/R Retry Configuration
583
+ # Retrieve A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.
584
+ # @param [Hash] opts the optional parameters
585
+ # @return [Array<(AccountsReceivableRetryConfigResponse, Integer, Hash)>] AccountsReceivableRetryConfigResponse data, response status code and response headers
586
+ def get_accounts_receivable_retry_config_with_http_info(opts = {})
587
+ if @api_client.config.debugging
588
+ @api_client.config.logger.debug 'Calling API: OrderApi.get_accounts_receivable_retry_config ...'
589
+ end
590
+ # resource path
591
+ local_var_path = '/order/accountsReceivableRetryConfig'
592
+
593
+ # query parameters
594
+ query_params = opts[:query_params] || {}
595
+
596
+ # header parameters
597
+ header_params = opts[:header_params] || {}
598
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
599
+ # HTTP header 'Accept' (if needed)
600
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
601
+
602
+ # form parameters
603
+ form_params = opts[:form_params] || {}
604
+
605
+ # http body (model)
606
+ post_body = opts[:debug_body]
607
+
608
+ # return_type
609
+ return_type = opts[:debug_return_type] || 'AccountsReceivableRetryConfigResponse'
610
+
611
+ # auth_names
612
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
613
+
614
+ new_options = opts.merge(
615
+ :operation => :"OrderApi.get_accounts_receivable_retry_config",
616
+ :header_params => header_params,
617
+ :query_params => query_params,
618
+ :form_params => form_params,
619
+ :body => post_body,
620
+ :auth_names => auth_names,
621
+ :return_type => return_type
622
+ )
623
+
624
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
625
+ if @api_client.config.debugging
626
+ @api_client.config.logger.debug "API called: OrderApi#get_accounts_receivable_retry_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
627
+ end
628
+ return data, status_code, headers
629
+ end
630
+
631
+ # Retrieve A/R Retry Statistics
632
+ # Retrieve A/R Retry Statistics. This is primarily an internal API call. It is doubtful you would ever need to use it.
633
+ # @param [Hash] opts the optional parameters
634
+ # @option opts [String] :from
635
+ # @option opts [String] :to
636
+ # @return [AccountsReceivableRetryStatsResponse]
637
+ def get_accounts_receivable_retry_stats(opts = {})
638
+ data, _status_code, _headers = get_accounts_receivable_retry_stats_with_http_info(opts)
639
+ data
640
+ end
641
+
642
+ # Retrieve A/R Retry Statistics
643
+ # Retrieve A/R Retry Statistics. This is primarily an internal API call. It is doubtful you would ever need to use it.
644
+ # @param [Hash] opts the optional parameters
645
+ # @option opts [String] :from
646
+ # @option opts [String] :to
647
+ # @return [Array<(AccountsReceivableRetryStatsResponse, Integer, Hash)>] AccountsReceivableRetryStatsResponse data, response status code and response headers
648
+ def get_accounts_receivable_retry_stats_with_http_info(opts = {})
649
+ if @api_client.config.debugging
650
+ @api_client.config.logger.debug 'Calling API: OrderApi.get_accounts_receivable_retry_stats ...'
651
+ end
652
+ # resource path
653
+ local_var_path = '/order/accountsReceivableRetryConfig/stats'
654
+
655
+ # query parameters
656
+ query_params = opts[:query_params] || {}
657
+ query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
658
+ query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
659
+
660
+ # header parameters
661
+ header_params = opts[:header_params] || {}
662
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
663
+ # HTTP header 'Accept' (if needed)
664
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
665
+
666
+ # form parameters
667
+ form_params = opts[:form_params] || {}
668
+
669
+ # http body (model)
670
+ post_body = opts[:debug_body]
671
+
672
+ # return_type
673
+ return_type = opts[:debug_return_type] || 'AccountsReceivableRetryStatsResponse'
674
+
675
+ # auth_names
676
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
677
+
678
+ new_options = opts.merge(
679
+ :operation => :"OrderApi.get_accounts_receivable_retry_stats",
680
+ :header_params => header_params,
681
+ :query_params => query_params,
682
+ :form_params => form_params,
683
+ :body => post_body,
684
+ :auth_names => auth_names,
685
+ :return_type => return_type
686
+ )
687
+
688
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
689
+ if @api_client.config.debugging
690
+ @api_client.config.logger.debug "API called: OrderApi#get_accounts_receivable_retry_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
691
+ end
692
+ return data, status_code, headers
693
+ end
694
+
695
+ # Retrieve an order
696
+ # Retrieves a single order using the specified order id.
697
+ # @param order_id [String] The order id to retrieve.
698
+ # @param [Hash] opts the optional parameters
699
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
700
+ # @return [OrderResponse]
701
+ def get_order(order_id, opts = {})
702
+ data, _status_code, _headers = get_order_with_http_info(order_id, opts)
703
+ data
704
+ end
705
+
706
+ # Retrieve an order
707
+ # Retrieves a single order using the specified order id.
708
+ # @param order_id [String] The order id to retrieve.
709
+ # @param [Hash] opts the optional parameters
710
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
711
+ # @return [Array<(OrderResponse, Integer, Hash)>] OrderResponse data, response status code and response headers
712
+ def get_order_with_http_info(order_id, opts = {})
713
+ if @api_client.config.debugging
714
+ @api_client.config.logger.debug 'Calling API: OrderApi.get_order ...'
715
+ end
716
+ # verify the required parameter 'order_id' is set
717
+ if @api_client.config.client_side_validation && order_id.nil?
718
+ fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.get_order"
719
+ end
720
+ # resource path
721
+ local_var_path = '/order/orders/{order_id}'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))
722
+
723
+ # query parameters
724
+ query_params = opts[:query_params] || {}
725
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
726
+
727
+ # header parameters
728
+ header_params = opts[:header_params] || {}
729
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
730
+ # HTTP header 'Accept' (if needed)
731
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
732
+
733
+ # form parameters
734
+ form_params = opts[:form_params] || {}
735
+
736
+ # http body (model)
737
+ post_body = opts[:debug_body]
738
+
739
+ # return_type
740
+ return_type = opts[:debug_return_type] || 'OrderResponse'
741
+
742
+ # auth_names
743
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
744
+
745
+ new_options = opts.merge(
746
+ :operation => :"OrderApi.get_order",
747
+ :header_params => header_params,
748
+ :query_params => query_params,
749
+ :form_params => form_params,
750
+ :body => post_body,
751
+ :auth_names => auth_names,
752
+ :return_type => return_type
753
+ )
754
+
755
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
756
+ if @api_client.config.debugging
757
+ @api_client.config.logger.debug "API called: OrderApi#get_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
758
+ end
759
+ return data, status_code, headers
760
+ end
761
+
762
+ # Retrieve an order using a token
763
+ # Retrieves a single order using the specified order token.
764
+ # @param order_by_token_query [OrderByTokenQuery] Order by token query
765
+ # @param [Hash] opts the optional parameters
766
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
767
+ # @return [OrderResponse]
768
+ def get_order_by_token(order_by_token_query, opts = {})
769
+ data, _status_code, _headers = get_order_by_token_with_http_info(order_by_token_query, opts)
770
+ data
771
+ end
772
+
773
+ # Retrieve an order using a token
774
+ # Retrieves a single order using the specified order token.
775
+ # @param order_by_token_query [OrderByTokenQuery] Order by token query
776
+ # @param [Hash] opts the optional parameters
777
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
778
+ # @return [Array<(OrderResponse, Integer, Hash)>] OrderResponse data, response status code and response headers
779
+ def get_order_by_token_with_http_info(order_by_token_query, opts = {})
780
+ if @api_client.config.debugging
781
+ @api_client.config.logger.debug 'Calling API: OrderApi.get_order_by_token ...'
782
+ end
783
+ # verify the required parameter 'order_by_token_query' is set
784
+ if @api_client.config.client_side_validation && order_by_token_query.nil?
785
+ fail ArgumentError, "Missing the required parameter 'order_by_token_query' when calling OrderApi.get_order_by_token"
786
+ end
787
+ # resource path
788
+ local_var_path = '/order/orders/token'
789
+
790
+ # query parameters
791
+ query_params = opts[:query_params] || {}
792
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
793
+
794
+ # header parameters
795
+ header_params = opts[:header_params] || {}
796
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
797
+ # HTTP header 'Accept' (if needed)
798
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
799
+ # HTTP header 'Content-Type'
800
+ content_type = @api_client.select_header_content_type(['application/json'])
801
+ if !content_type.nil?
802
+ header_params['Content-Type'] = content_type
803
+ end
804
+
805
+ # form parameters
806
+ form_params = opts[:form_params] || {}
807
+
808
+ # http body (model)
809
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(order_by_token_query)
810
+
811
+ # return_type
812
+ return_type = opts[:debug_return_type] || 'OrderResponse'
813
+
814
+ # auth_names
815
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
816
+
817
+ new_options = opts.merge(
818
+ :operation => :"OrderApi.get_order_by_token",
819
+ :header_params => header_params,
820
+ :query_params => query_params,
821
+ :form_params => form_params,
822
+ :body => post_body,
823
+ :auth_names => auth_names,
824
+ :return_type => return_type
825
+ )
826
+
827
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
828
+ if @api_client.config.debugging
829
+ @api_client.config.logger.debug "API called: OrderApi#get_order_by_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
830
+ end
831
+ return data, status_code, headers
832
+ end
833
+
834
+ # Retrieve orders
835
+ # Retrieves a group of orders from the account. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
836
+ # @param [Hash] opts the optional parameters
837
+ # @option opts [String] :order_id Order Id
838
+ # @option opts [String] :payment_method Payment Method
839
+ # @option opts [String] :company Company
840
+ # @option opts [String] :first_name First Name
841
+ # @option opts [String] :last_name Last Name
842
+ # @option opts [String] :city City
843
+ # @option opts [String] :state_region State/Region
844
+ # @option opts [String] :postal_code Postal Code
845
+ # @option opts [String] :country_code Country Code (ISO-3166 two letter)
846
+ # @option opts [String] :phone Phone
847
+ # @option opts [String] :email Email
848
+ # @option opts [String] :cc_email CC Email
849
+ # @option opts [Float] :total Total
850
+ # @option opts [String] :screen_branding_theme_code Screen Branding Theme Code
851
+ # @option opts [String] :storefront_host_name StoreFront Host Name
852
+ # @option opts [String] :creation_date_begin Creation Date Begin
853
+ # @option opts [String] :creation_date_end Creation Date End
854
+ # @option opts [String] :payment_date_begin Payment Date Begin
855
+ # @option opts [String] :payment_date_end Payment Date End
856
+ # @option opts [String] :shipment_date_begin Shipment Date Begin
857
+ # @option opts [String] :shipment_date_end Shipment Date End
858
+ # @option opts [String] :rma RMA
859
+ # @option opts [String] :purchase_order_number Purchase Order Number
860
+ # @option opts [String] :item_id Item Id
861
+ # @option opts [String] :current_stage Current Stage
862
+ # @option opts [String] :channel_partner_code Channel Partner Code
863
+ # @option opts [String] :channel_partner_order_id Channel Partner Order ID
864
+ # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200) (default to 100)
865
+ # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
866
+ # @option opts [String] :_sort The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
867
+ # @option opts [String] :_expand The object expansion to perform on the result.
868
+ # @return [OrdersResponse]
869
+ def get_orders(opts = {})
870
+ data, _status_code, _headers = get_orders_with_http_info(opts)
871
+ data
872
+ end
873
+
874
+ # Retrieve orders
875
+ # Retrieves a group of orders from the account. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
876
+ # @param [Hash] opts the optional parameters
877
+ # @option opts [String] :order_id Order Id
878
+ # @option opts [String] :payment_method Payment Method
879
+ # @option opts [String] :company Company
880
+ # @option opts [String] :first_name First Name
881
+ # @option opts [String] :last_name Last Name
882
+ # @option opts [String] :city City
883
+ # @option opts [String] :state_region State/Region
884
+ # @option opts [String] :postal_code Postal Code
885
+ # @option opts [String] :country_code Country Code (ISO-3166 two letter)
886
+ # @option opts [String] :phone Phone
887
+ # @option opts [String] :email Email
888
+ # @option opts [String] :cc_email CC Email
889
+ # @option opts [Float] :total Total
890
+ # @option opts [String] :screen_branding_theme_code Screen Branding Theme Code
891
+ # @option opts [String] :storefront_host_name StoreFront Host Name
892
+ # @option opts [String] :creation_date_begin Creation Date Begin
893
+ # @option opts [String] :creation_date_end Creation Date End
894
+ # @option opts [String] :payment_date_begin Payment Date Begin
895
+ # @option opts [String] :payment_date_end Payment Date End
896
+ # @option opts [String] :shipment_date_begin Shipment Date Begin
897
+ # @option opts [String] :shipment_date_end Shipment Date End
898
+ # @option opts [String] :rma RMA
899
+ # @option opts [String] :purchase_order_number Purchase Order Number
900
+ # @option opts [String] :item_id Item Id
901
+ # @option opts [String] :current_stage Current Stage
902
+ # @option opts [String] :channel_partner_code Channel Partner Code
903
+ # @option opts [String] :channel_partner_order_id Channel Partner Order ID
904
+ # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200) (default to 100)
905
+ # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
906
+ # @option opts [String] :_sort The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
907
+ # @option opts [String] :_expand The object expansion to perform on the result.
908
+ # @return [Array<(OrdersResponse, Integer, Hash)>] OrdersResponse data, response status code and response headers
909
+ def get_orders_with_http_info(opts = {})
910
+ if @api_client.config.debugging
911
+ @api_client.config.logger.debug 'Calling API: OrderApi.get_orders ...'
912
+ end
913
+ # resource path
914
+ local_var_path = '/order/orders'
915
+
916
+ # query parameters
917
+ query_params = opts[:query_params] || {}
918
+ query_params[:'order_id'] = opts[:'order_id'] if !opts[:'order_id'].nil?
919
+ query_params[:'payment_method'] = opts[:'payment_method'] if !opts[:'payment_method'].nil?
920
+ query_params[:'company'] = opts[:'company'] if !opts[:'company'].nil?
921
+ query_params[:'first_name'] = opts[:'first_name'] if !opts[:'first_name'].nil?
922
+ query_params[:'last_name'] = opts[:'last_name'] if !opts[:'last_name'].nil?
923
+ query_params[:'city'] = opts[:'city'] if !opts[:'city'].nil?
924
+ query_params[:'state_region'] = opts[:'state_region'] if !opts[:'state_region'].nil?
925
+ query_params[:'postal_code'] = opts[:'postal_code'] if !opts[:'postal_code'].nil?
926
+ query_params[:'country_code'] = opts[:'country_code'] if !opts[:'country_code'].nil?
927
+ query_params[:'phone'] = opts[:'phone'] if !opts[:'phone'].nil?
928
+ query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
929
+ query_params[:'cc_email'] = opts[:'cc_email'] if !opts[:'cc_email'].nil?
930
+ query_params[:'total'] = opts[:'total'] if !opts[:'total'].nil?
931
+ query_params[:'screen_branding_theme_code'] = opts[:'screen_branding_theme_code'] if !opts[:'screen_branding_theme_code'].nil?
932
+ query_params[:'storefront_host_name'] = opts[:'storefront_host_name'] if !opts[:'storefront_host_name'].nil?
933
+ query_params[:'creation_date_begin'] = opts[:'creation_date_begin'] if !opts[:'creation_date_begin'].nil?
934
+ query_params[:'creation_date_end'] = opts[:'creation_date_end'] if !opts[:'creation_date_end'].nil?
935
+ query_params[:'payment_date_begin'] = opts[:'payment_date_begin'] if !opts[:'payment_date_begin'].nil?
936
+ query_params[:'payment_date_end'] = opts[:'payment_date_end'] if !opts[:'payment_date_end'].nil?
937
+ query_params[:'shipment_date_begin'] = opts[:'shipment_date_begin'] if !opts[:'shipment_date_begin'].nil?
938
+ query_params[:'shipment_date_end'] = opts[:'shipment_date_end'] if !opts[:'shipment_date_end'].nil?
939
+ query_params[:'rma'] = opts[:'rma'] if !opts[:'rma'].nil?
940
+ query_params[:'purchase_order_number'] = opts[:'purchase_order_number'] if !opts[:'purchase_order_number'].nil?
941
+ query_params[:'item_id'] = opts[:'item_id'] if !opts[:'item_id'].nil?
942
+ query_params[:'current_stage'] = opts[:'current_stage'] if !opts[:'current_stage'].nil?
943
+ query_params[:'channel_partner_code'] = opts[:'channel_partner_code'] if !opts[:'channel_partner_code'].nil?
944
+ query_params[:'channel_partner_order_id'] = opts[:'channel_partner_order_id'] if !opts[:'channel_partner_order_id'].nil?
945
+ query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
946
+ query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
947
+ query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
948
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
949
+
950
+ # header parameters
951
+ header_params = opts[:header_params] || {}
952
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
953
+ # HTTP header 'Accept' (if needed)
954
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
955
+
956
+ # form parameters
957
+ form_params = opts[:form_params] || {}
958
+
959
+ # http body (model)
960
+ post_body = opts[:debug_body]
961
+
962
+ # return_type
963
+ return_type = opts[:debug_return_type] || 'OrdersResponse'
964
+
965
+ # auth_names
966
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
967
+
968
+ new_options = opts.merge(
969
+ :operation => :"OrderApi.get_orders",
970
+ :header_params => header_params,
971
+ :query_params => query_params,
972
+ :form_params => form_params,
973
+ :body => post_body,
974
+ :auth_names => auth_names,
975
+ :return_type => return_type
976
+ )
977
+
978
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
979
+ if @api_client.config.debugging
980
+ @api_client.config.logger.debug "API called: OrderApi#get_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
981
+ end
982
+ return data, status_code, headers
983
+ end
984
+
985
+ # Retrieve order batch
986
+ # Retrieves a group of orders from the account based on an array of order ids. If more than 500 order ids are specified, the API call will fail with a bad request error.
987
+ # @param order_batch [OrderQueryBatch] Order batch
988
+ # @param [Hash] opts the optional parameters
989
+ # @option opts [String] :_expand The object expansion to perform on the result.
990
+ # @return [OrdersResponse]
991
+ def get_orders_batch(order_batch, opts = {})
992
+ data, _status_code, _headers = get_orders_batch_with_http_info(order_batch, opts)
993
+ data
994
+ end
995
+
996
+ # Retrieve order batch
997
+ # Retrieves a group of orders from the account based on an array of order ids. If more than 500 order ids are specified, the API call will fail with a bad request error.
998
+ # @param order_batch [OrderQueryBatch] Order batch
999
+ # @param [Hash] opts the optional parameters
1000
+ # @option opts [String] :_expand The object expansion to perform on the result.
1001
+ # @return [Array<(OrdersResponse, Integer, Hash)>] OrdersResponse data, response status code and response headers
1002
+ def get_orders_batch_with_http_info(order_batch, opts = {})
1003
+ if @api_client.config.debugging
1004
+ @api_client.config.logger.debug 'Calling API: OrderApi.get_orders_batch ...'
1005
+ end
1006
+ # verify the required parameter 'order_batch' is set
1007
+ if @api_client.config.client_side_validation && order_batch.nil?
1008
+ fail ArgumentError, "Missing the required parameter 'order_batch' when calling OrderApi.get_orders_batch"
1009
+ end
1010
+ # resource path
1011
+ local_var_path = '/order/orders/batch'
1012
+
1013
+ # query parameters
1014
+ query_params = opts[:query_params] || {}
1015
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1016
+
1017
+ # header parameters
1018
+ header_params = opts[:header_params] || {}
1019
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1020
+ # HTTP header 'Accept' (if needed)
1021
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1022
+ # HTTP header 'Content-Type'
1023
+ content_type = @api_client.select_header_content_type(['application/json'])
1024
+ if !content_type.nil?
1025
+ header_params['Content-Type'] = content_type
1026
+ end
1027
+
1028
+ # form parameters
1029
+ form_params = opts[:form_params] || {}
1030
+
1031
+ # http body (model)
1032
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(order_batch)
1033
+
1034
+ # return_type
1035
+ return_type = opts[:debug_return_type] || 'OrdersResponse'
1036
+
1037
+ # auth_names
1038
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1039
+
1040
+ new_options = opts.merge(
1041
+ :operation => :"OrderApi.get_orders_batch",
1042
+ :header_params => header_params,
1043
+ :query_params => query_params,
1044
+ :form_params => form_params,
1045
+ :body => post_body,
1046
+ :auth_names => auth_names,
1047
+ :return_type => return_type
1048
+ )
1049
+
1050
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1051
+ if @api_client.config.debugging
1052
+ @api_client.config.logger.debug "API called: OrderApi#get_orders_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1053
+ end
1054
+ return data, status_code, headers
1055
+ end
1056
+
1057
+ # Retrieve orders by query
1058
+ # Retrieves a group of orders from the account based on a query object. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
1059
+ # @param order_query [OrderQuery] Order query
1060
+ # @param [Hash] opts the optional parameters
1061
+ # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200) (default to 100)
1062
+ # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
1063
+ # @option opts [String] :_sort The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
1064
+ # @option opts [String] :_expand The object expansion to perform on the result.
1065
+ # @return [OrdersResponse]
1066
+ def get_orders_by_query(order_query, opts = {})
1067
+ data, _status_code, _headers = get_orders_by_query_with_http_info(order_query, opts)
1068
+ data
1069
+ end
1070
+
1071
+ # Retrieve orders by query
1072
+ # Retrieves a group of orders from the account based on a query object. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
1073
+ # @param order_query [OrderQuery] Order query
1074
+ # @param [Hash] opts the optional parameters
1075
+ # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200) (default to 100)
1076
+ # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
1077
+ # @option opts [String] :_sort The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
1078
+ # @option opts [String] :_expand The object expansion to perform on the result.
1079
+ # @return [Array<(OrdersResponse, Integer, Hash)>] OrdersResponse data, response status code and response headers
1080
+ def get_orders_by_query_with_http_info(order_query, opts = {})
1081
+ if @api_client.config.debugging
1082
+ @api_client.config.logger.debug 'Calling API: OrderApi.get_orders_by_query ...'
1083
+ end
1084
+ # verify the required parameter 'order_query' is set
1085
+ if @api_client.config.client_side_validation && order_query.nil?
1086
+ fail ArgumentError, "Missing the required parameter 'order_query' when calling OrderApi.get_orders_by_query"
1087
+ end
1088
+ # resource path
1089
+ local_var_path = '/order/orders/query'
1090
+
1091
+ # query parameters
1092
+ query_params = opts[:query_params] || {}
1093
+ query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
1094
+ query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
1095
+ query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
1096
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1097
+
1098
+ # header parameters
1099
+ header_params = opts[:header_params] || {}
1100
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1101
+ # HTTP header 'Accept' (if needed)
1102
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1103
+ # HTTP header 'Content-Type'
1104
+ content_type = @api_client.select_header_content_type(['application/json'])
1105
+ if !content_type.nil?
1106
+ header_params['Content-Type'] = content_type
1107
+ end
1108
+
1109
+ # form parameters
1110
+ form_params = opts[:form_params] || {}
1111
+
1112
+ # http body (model)
1113
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(order_query)
1114
+
1115
+ # return_type
1116
+ return_type = opts[:debug_return_type] || 'OrdersResponse'
1117
+
1118
+ # auth_names
1119
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1120
+
1121
+ new_options = opts.merge(
1122
+ :operation => :"OrderApi.get_orders_by_query",
1123
+ :header_params => header_params,
1124
+ :query_params => query_params,
1125
+ :form_params => form_params,
1126
+ :body => post_body,
1127
+ :auth_names => auth_names,
1128
+ :return_type => return_type
1129
+ )
1130
+
1131
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1132
+ if @api_client.config.debugging
1133
+ @api_client.config.logger.debug "API called: OrderApi#get_orders_by_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1134
+ end
1135
+ return data, status_code, headers
1136
+ end
1137
+
1138
+ # Insert an order
1139
+ # Inserts a new order on the UltraCart account. This is probably NOT the method you want. This is for channel orders. For regular orders the customer is entering, use the CheckoutApi. It has many, many more features, checks, and validations.
1140
+ # @param order [Order] Order to insert
1141
+ # @param [Hash] opts the optional parameters
1142
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1143
+ # @return [OrderResponse]
1144
+ def insert_order(order, opts = {})
1145
+ data, _status_code, _headers = insert_order_with_http_info(order, opts)
1146
+ data
1147
+ end
1148
+
1149
+ # Insert an order
1150
+ # Inserts a new order on the UltraCart account. This is probably NOT the method you want. This is for channel orders. For regular orders the customer is entering, use the CheckoutApi. It has many, many more features, checks, and validations.
1151
+ # @param order [Order] Order to insert
1152
+ # @param [Hash] opts the optional parameters
1153
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1154
+ # @return [Array<(OrderResponse, Integer, Hash)>] OrderResponse data, response status code and response headers
1155
+ def insert_order_with_http_info(order, opts = {})
1156
+ if @api_client.config.debugging
1157
+ @api_client.config.logger.debug 'Calling API: OrderApi.insert_order ...'
1158
+ end
1159
+ # verify the required parameter 'order' is set
1160
+ if @api_client.config.client_side_validation && order.nil?
1161
+ fail ArgumentError, "Missing the required parameter 'order' when calling OrderApi.insert_order"
1162
+ end
1163
+ # resource path
1164
+ local_var_path = '/order/orders'
1165
+
1166
+ # query parameters
1167
+ query_params = opts[:query_params] || {}
1168
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1169
+
1170
+ # header parameters
1171
+ header_params = opts[:header_params] || {}
1172
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1173
+ # HTTP header 'Accept' (if needed)
1174
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1175
+ # HTTP header 'Content-Type'
1176
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1177
+ if !content_type.nil?
1178
+ header_params['Content-Type'] = content_type
1179
+ end
1180
+
1181
+ # form parameters
1182
+ form_params = opts[:form_params] || {}
1183
+
1184
+ # http body (model)
1185
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(order)
1186
+
1187
+ # return_type
1188
+ return_type = opts[:debug_return_type] || 'OrderResponse'
1189
+
1190
+ # auth_names
1191
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1192
+
1193
+ new_options = opts.merge(
1194
+ :operation => :"OrderApi.insert_order",
1195
+ :header_params => header_params,
1196
+ :query_params => query_params,
1197
+ :form_params => form_params,
1198
+ :body => post_body,
1199
+ :auth_names => auth_names,
1200
+ :return_type => return_type
1201
+ )
1202
+
1203
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1204
+ if @api_client.config.debugging
1205
+ @api_client.config.logger.debug "API called: OrderApi#insert_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1206
+ end
1207
+ return data, status_code, headers
1208
+ end
1209
+
1210
+ # Process payment
1211
+ # Process payment on order
1212
+ # @param order_id [String] The order id to process payment on
1213
+ # @param process_payment_request [OrderProcessPaymentRequest] Process payment parameters
1214
+ # @param [Hash] opts the optional parameters
1215
+ # @return [OrderProcessPaymentResponse]
1216
+ def process_payment(order_id, process_payment_request, opts = {})
1217
+ data, _status_code, _headers = process_payment_with_http_info(order_id, process_payment_request, opts)
1218
+ data
1219
+ end
1220
+
1221
+ # Process payment
1222
+ # Process payment on order
1223
+ # @param order_id [String] The order id to process payment on
1224
+ # @param process_payment_request [OrderProcessPaymentRequest] Process payment parameters
1225
+ # @param [Hash] opts the optional parameters
1226
+ # @return [Array<(OrderProcessPaymentResponse, Integer, Hash)>] OrderProcessPaymentResponse data, response status code and response headers
1227
+ def process_payment_with_http_info(order_id, process_payment_request, opts = {})
1228
+ if @api_client.config.debugging
1229
+ @api_client.config.logger.debug 'Calling API: OrderApi.process_payment ...'
1230
+ end
1231
+ # verify the required parameter 'order_id' is set
1232
+ if @api_client.config.client_side_validation && order_id.nil?
1233
+ fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.process_payment"
1234
+ end
1235
+ # verify the required parameter 'process_payment_request' is set
1236
+ if @api_client.config.client_side_validation && process_payment_request.nil?
1237
+ fail ArgumentError, "Missing the required parameter 'process_payment_request' when calling OrderApi.process_payment"
1238
+ end
1239
+ # resource path
1240
+ local_var_path = '/order/orders/{order_id}/process_payment'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))
1241
+
1242
+ # query parameters
1243
+ query_params = opts[:query_params] || {}
1244
+
1245
+ # header parameters
1246
+ header_params = opts[:header_params] || {}
1247
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1248
+ # HTTP header 'Accept' (if needed)
1249
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1250
+ # HTTP header 'Content-Type'
1251
+ content_type = @api_client.select_header_content_type(['application/json'])
1252
+ if !content_type.nil?
1253
+ header_params['Content-Type'] = content_type
1254
+ end
1255
+
1256
+ # form parameters
1257
+ form_params = opts[:form_params] || {}
1258
+
1259
+ # http body (model)
1260
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(process_payment_request)
1261
+
1262
+ # return_type
1263
+ return_type = opts[:debug_return_type] || 'OrderProcessPaymentResponse'
1264
+
1265
+ # auth_names
1266
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1267
+
1268
+ new_options = opts.merge(
1269
+ :operation => :"OrderApi.process_payment",
1270
+ :header_params => header_params,
1271
+ :query_params => query_params,
1272
+ :form_params => form_params,
1273
+ :body => post_body,
1274
+ :auth_names => auth_names,
1275
+ :return_type => return_type
1276
+ )
1277
+
1278
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1279
+ if @api_client.config.debugging
1280
+ @api_client.config.logger.debug "API called: OrderApi#process_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1281
+ end
1282
+ return data, status_code, headers
1283
+ end
1284
+
1285
+ # Refund an order
1286
+ # Perform a refund operation on an order and then update the order if successful
1287
+ # @param order_id [String] The order id to refund.
1288
+ # @param order [Order] Order to refund
1289
+ # @param [Hash] opts the optional parameters
1290
+ # @option opts [Boolean] :reject_after_refund Reject order after refund (default to false)
1291
+ # @option opts [Boolean] :skip_customer_notification Skip customer email notification (default to false)
1292
+ # @option opts [Boolean] :auto_order_cancel Cancel associated auto orders (default to false)
1293
+ # @option opts [Boolean] :manual_refund Consider a manual refund done externally (default to false)
1294
+ # @option opts [Boolean] :reverse_affiliate_transactions Reverse affiliate transactions (default to true)
1295
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1296
+ # @return [OrderResponse]
1297
+ def refund_order(order_id, order, opts = {})
1298
+ data, _status_code, _headers = refund_order_with_http_info(order_id, order, opts)
1299
+ data
1300
+ end
1301
+
1302
+ # Refund an order
1303
+ # Perform a refund operation on an order and then update the order if successful
1304
+ # @param order_id [String] The order id to refund.
1305
+ # @param order [Order] Order to refund
1306
+ # @param [Hash] opts the optional parameters
1307
+ # @option opts [Boolean] :reject_after_refund Reject order after refund (default to false)
1308
+ # @option opts [Boolean] :skip_customer_notification Skip customer email notification (default to false)
1309
+ # @option opts [Boolean] :auto_order_cancel Cancel associated auto orders (default to false)
1310
+ # @option opts [Boolean] :manual_refund Consider a manual refund done externally (default to false)
1311
+ # @option opts [Boolean] :reverse_affiliate_transactions Reverse affiliate transactions (default to true)
1312
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1313
+ # @return [Array<(OrderResponse, Integer, Hash)>] OrderResponse data, response status code and response headers
1314
+ def refund_order_with_http_info(order_id, order, opts = {})
1315
+ if @api_client.config.debugging
1316
+ @api_client.config.logger.debug 'Calling API: OrderApi.refund_order ...'
1317
+ end
1318
+ # verify the required parameter 'order_id' is set
1319
+ if @api_client.config.client_side_validation && order_id.nil?
1320
+ fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.refund_order"
1321
+ end
1322
+ # verify the required parameter 'order' is set
1323
+ if @api_client.config.client_side_validation && order.nil?
1324
+ fail ArgumentError, "Missing the required parameter 'order' when calling OrderApi.refund_order"
1325
+ end
1326
+ # resource path
1327
+ local_var_path = '/order/orders/{order_id}/refund'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))
1328
+
1329
+ # query parameters
1330
+ query_params = opts[:query_params] || {}
1331
+ query_params[:'reject_after_refund'] = opts[:'reject_after_refund'] if !opts[:'reject_after_refund'].nil?
1332
+ query_params[:'skip_customer_notification'] = opts[:'skip_customer_notification'] if !opts[:'skip_customer_notification'].nil?
1333
+ query_params[:'auto_order_cancel'] = opts[:'auto_order_cancel'] if !opts[:'auto_order_cancel'].nil?
1334
+ query_params[:'manual_refund'] = opts[:'manual_refund'] if !opts[:'manual_refund'].nil?
1335
+ query_params[:'reverse_affiliate_transactions'] = opts[:'reverse_affiliate_transactions'] if !opts[:'reverse_affiliate_transactions'].nil?
1336
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1337
+
1338
+ # header parameters
1339
+ header_params = opts[:header_params] || {}
1340
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1341
+ # HTTP header 'Accept' (if needed)
1342
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1343
+ # HTTP header 'Content-Type'
1344
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1345
+ if !content_type.nil?
1346
+ header_params['Content-Type'] = content_type
1347
+ end
1348
+
1349
+ # form parameters
1350
+ form_params = opts[:form_params] || {}
1351
+
1352
+ # http body (model)
1353
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(order)
1354
+
1355
+ # return_type
1356
+ return_type = opts[:debug_return_type] || 'OrderResponse'
1357
+
1358
+ # auth_names
1359
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1360
+
1361
+ new_options = opts.merge(
1362
+ :operation => :"OrderApi.refund_order",
1363
+ :header_params => header_params,
1364
+ :query_params => query_params,
1365
+ :form_params => form_params,
1366
+ :body => post_body,
1367
+ :auth_names => auth_names,
1368
+ :return_type => return_type
1369
+ )
1370
+
1371
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
1372
+ if @api_client.config.debugging
1373
+ @api_client.config.logger.debug "API called: OrderApi#refund_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1374
+ end
1375
+ return data, status_code, headers
1376
+ end
1377
+
1378
+ # Replacement order
1379
+ # Create a replacement order based upon a previous order
1380
+ # @param order_id [String] The order id to generate a replacement for.
1381
+ # @param replacement [OrderReplacement] Replacement order details
1382
+ # @param [Hash] opts the optional parameters
1383
+ # @return [OrderReplacementResponse]
1384
+ def replacement(order_id, replacement, opts = {})
1385
+ data, _status_code, _headers = replacement_with_http_info(order_id, replacement, opts)
1386
+ data
1387
+ end
1388
+
1389
+ # Replacement order
1390
+ # Create a replacement order based upon a previous order
1391
+ # @param order_id [String] The order id to generate a replacement for.
1392
+ # @param replacement [OrderReplacement] Replacement order details
1393
+ # @param [Hash] opts the optional parameters
1394
+ # @return [Array<(OrderReplacementResponse, Integer, Hash)>] OrderReplacementResponse data, response status code and response headers
1395
+ def replacement_with_http_info(order_id, replacement, opts = {})
1396
+ if @api_client.config.debugging
1397
+ @api_client.config.logger.debug 'Calling API: OrderApi.replacement ...'
1398
+ end
1399
+ # verify the required parameter 'order_id' is set
1400
+ if @api_client.config.client_side_validation && order_id.nil?
1401
+ fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.replacement"
1402
+ end
1403
+ # verify the required parameter 'replacement' is set
1404
+ if @api_client.config.client_side_validation && replacement.nil?
1405
+ fail ArgumentError, "Missing the required parameter 'replacement' when calling OrderApi.replacement"
1406
+ end
1407
+ # resource path
1408
+ local_var_path = '/order/orders/{order_id}/replacement'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))
1409
+
1410
+ # query parameters
1411
+ query_params = opts[:query_params] || {}
1412
+
1413
+ # header parameters
1414
+ header_params = opts[:header_params] || {}
1415
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1416
+ # HTTP header 'Accept' (if needed)
1417
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1418
+ # HTTP header 'Content-Type'
1419
+ content_type = @api_client.select_header_content_type(['application/json'])
1420
+ if !content_type.nil?
1421
+ header_params['Content-Type'] = content_type
1422
+ end
1423
+
1424
+ # form parameters
1425
+ form_params = opts[:form_params] || {}
1426
+
1427
+ # http body (model)
1428
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(replacement)
1429
+
1430
+ # return_type
1431
+ return_type = opts[:debug_return_type] || 'OrderReplacementResponse'
1432
+
1433
+ # auth_names
1434
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1435
+
1436
+ new_options = opts.merge(
1437
+ :operation => :"OrderApi.replacement",
1438
+ :header_params => header_params,
1439
+ :query_params => query_params,
1440
+ :form_params => form_params,
1441
+ :body => post_body,
1442
+ :auth_names => auth_names,
1443
+ :return_type => return_type
1444
+ )
1445
+
1446
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1447
+ if @api_client.config.debugging
1448
+ @api_client.config.logger.debug "API called: OrderApi#replacement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1449
+ end
1450
+ return data, status_code, headers
1451
+ end
1452
+
1453
+ # Resend receipt
1454
+ # Resend the receipt for an order on the UltraCart account.
1455
+ # @param order_id [String] The order id to resend the receipt for.
1456
+ # @param [Hash] opts the optional parameters
1457
+ # @return [BaseResponse]
1458
+ def resend_receipt(order_id, opts = {})
1459
+ data, _status_code, _headers = resend_receipt_with_http_info(order_id, opts)
1460
+ data
1461
+ end
1462
+
1463
+ # Resend receipt
1464
+ # Resend the receipt for an order on the UltraCart account.
1465
+ # @param order_id [String] The order id to resend the receipt for.
1466
+ # @param [Hash] opts the optional parameters
1467
+ # @return [Array<(BaseResponse, Integer, Hash)>] BaseResponse data, response status code and response headers
1468
+ def resend_receipt_with_http_info(order_id, opts = {})
1469
+ if @api_client.config.debugging
1470
+ @api_client.config.logger.debug 'Calling API: OrderApi.resend_receipt ...'
1471
+ end
1472
+ # verify the required parameter 'order_id' is set
1473
+ if @api_client.config.client_side_validation && order_id.nil?
1474
+ fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.resend_receipt"
1475
+ end
1476
+ # resource path
1477
+ local_var_path = '/order/orders/{order_id}/resend_receipt'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))
1478
+
1479
+ # query parameters
1480
+ query_params = opts[:query_params] || {}
1481
+
1482
+ # header parameters
1483
+ header_params = opts[:header_params] || {}
1484
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1485
+ # HTTP header 'Accept' (if needed)
1486
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1487
+
1488
+ # form parameters
1489
+ form_params = opts[:form_params] || {}
1490
+
1491
+ # http body (model)
1492
+ post_body = opts[:debug_body]
1493
+
1494
+ # return_type
1495
+ return_type = opts[:debug_return_type] || 'BaseResponse'
1496
+
1497
+ # auth_names
1498
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1499
+
1500
+ new_options = opts.merge(
1501
+ :operation => :"OrderApi.resend_receipt",
1502
+ :header_params => header_params,
1503
+ :query_params => query_params,
1504
+ :form_params => form_params,
1505
+ :body => post_body,
1506
+ :auth_names => auth_names,
1507
+ :return_type => return_type
1508
+ )
1509
+
1510
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1511
+ if @api_client.config.debugging
1512
+ @api_client.config.logger.debug "API called: OrderApi#resend_receipt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1513
+ end
1514
+ return data, status_code, headers
1515
+ end
1516
+
1517
+ # Resend shipment confirmation
1518
+ # Resend shipment confirmation for an order on the UltraCart account.
1519
+ # @param order_id [String] The order id to resend the shipment notification for.
1520
+ # @param [Hash] opts the optional parameters
1521
+ # @return [BaseResponse]
1522
+ def resend_shipment_confirmation(order_id, opts = {})
1523
+ data, _status_code, _headers = resend_shipment_confirmation_with_http_info(order_id, opts)
1524
+ data
1525
+ end
1526
+
1527
+ # Resend shipment confirmation
1528
+ # Resend shipment confirmation for an order on the UltraCart account.
1529
+ # @param order_id [String] The order id to resend the shipment notification for.
1530
+ # @param [Hash] opts the optional parameters
1531
+ # @return [Array<(BaseResponse, Integer, Hash)>] BaseResponse data, response status code and response headers
1532
+ def resend_shipment_confirmation_with_http_info(order_id, opts = {})
1533
+ if @api_client.config.debugging
1534
+ @api_client.config.logger.debug 'Calling API: OrderApi.resend_shipment_confirmation ...'
1535
+ end
1536
+ # verify the required parameter 'order_id' is set
1537
+ if @api_client.config.client_side_validation && order_id.nil?
1538
+ fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.resend_shipment_confirmation"
1539
+ end
1540
+ # resource path
1541
+ local_var_path = '/order/orders/{order_id}/resend_shipment_confirmation'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))
1542
+
1543
+ # query parameters
1544
+ query_params = opts[:query_params] || {}
1545
+
1546
+ # header parameters
1547
+ header_params = opts[:header_params] || {}
1548
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1549
+ # HTTP header 'Accept' (if needed)
1550
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1551
+
1552
+ # form parameters
1553
+ form_params = opts[:form_params] || {}
1554
+
1555
+ # http body (model)
1556
+ post_body = opts[:debug_body]
1557
+
1558
+ # return_type
1559
+ return_type = opts[:debug_return_type] || 'BaseResponse'
1560
+
1561
+ # auth_names
1562
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1563
+
1564
+ new_options = opts.merge(
1565
+ :operation => :"OrderApi.resend_shipment_confirmation",
1566
+ :header_params => header_params,
1567
+ :query_params => query_params,
1568
+ :form_params => form_params,
1569
+ :body => post_body,
1570
+ :auth_names => auth_names,
1571
+ :return_type => return_type
1572
+ )
1573
+
1574
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1575
+ if @api_client.config.debugging
1576
+ @api_client.config.logger.debug "API called: OrderApi#resend_shipment_confirmation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1577
+ end
1578
+ return data, status_code, headers
1579
+ end
1580
+
1581
+ # Update A/R Retry Configuration
1582
+ # Update A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.
1583
+ # @param retry_config [AccountsReceivableRetryConfig] AccountsReceivableRetryConfig object
1584
+ # @param [Hash] opts the optional parameters
1585
+ # @return [BaseResponse]
1586
+ def update_accounts_receivable_retry_config(retry_config, opts = {})
1587
+ data, _status_code, _headers = update_accounts_receivable_retry_config_with_http_info(retry_config, opts)
1588
+ data
1589
+ end
1590
+
1591
+ # Update A/R Retry Configuration
1592
+ # Update A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.
1593
+ # @param retry_config [AccountsReceivableRetryConfig] AccountsReceivableRetryConfig object
1594
+ # @param [Hash] opts the optional parameters
1595
+ # @return [Array<(BaseResponse, Integer, Hash)>] BaseResponse data, response status code and response headers
1596
+ def update_accounts_receivable_retry_config_with_http_info(retry_config, opts = {})
1597
+ if @api_client.config.debugging
1598
+ @api_client.config.logger.debug 'Calling API: OrderApi.update_accounts_receivable_retry_config ...'
1599
+ end
1600
+ # verify the required parameter 'retry_config' is set
1601
+ if @api_client.config.client_side_validation && retry_config.nil?
1602
+ fail ArgumentError, "Missing the required parameter 'retry_config' when calling OrderApi.update_accounts_receivable_retry_config"
1603
+ end
1604
+ # resource path
1605
+ local_var_path = '/order/accountsReceivableRetryConfig'
1606
+
1607
+ # query parameters
1608
+ query_params = opts[:query_params] || {}
1609
+
1610
+ # header parameters
1611
+ header_params = opts[:header_params] || {}
1612
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1613
+ # HTTP header 'Accept' (if needed)
1614
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1615
+ # HTTP header 'Content-Type'
1616
+ content_type = @api_client.select_header_content_type(['application/json'])
1617
+ if !content_type.nil?
1618
+ header_params['Content-Type'] = content_type
1619
+ end
1620
+
1621
+ # form parameters
1622
+ form_params = opts[:form_params] || {}
1623
+
1624
+ # http body (model)
1625
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(retry_config)
1626
+
1627
+ # return_type
1628
+ return_type = opts[:debug_return_type] || 'BaseResponse'
1629
+
1630
+ # auth_names
1631
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1632
+
1633
+ new_options = opts.merge(
1634
+ :operation => :"OrderApi.update_accounts_receivable_retry_config",
1635
+ :header_params => header_params,
1636
+ :query_params => query_params,
1637
+ :form_params => form_params,
1638
+ :body => post_body,
1639
+ :auth_names => auth_names,
1640
+ :return_type => return_type
1641
+ )
1642
+
1643
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1644
+ if @api_client.config.debugging
1645
+ @api_client.config.logger.debug "API called: OrderApi#update_accounts_receivable_retry_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1646
+ end
1647
+ return data, status_code, headers
1648
+ end
1649
+
1650
+ # Update an order
1651
+ # Update a new order on the UltraCart account. This is probably NOT the method you want. It is rare to update a completed order. This will not trigger charges, emails, or any other automation.
1652
+ # @param order_id [String] The order id to update.
1653
+ # @param order [Order] Order to update
1654
+ # @param [Hash] opts the optional parameters
1655
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1656
+ # @return [OrderResponse]
1657
+ def update_order(order_id, order, opts = {})
1658
+ data, _status_code, _headers = update_order_with_http_info(order_id, order, opts)
1659
+ data
1660
+ end
1661
+
1662
+ # Update an order
1663
+ # Update a new order on the UltraCart account. This is probably NOT the method you want. It is rare to update a completed order. This will not trigger charges, emails, or any other automation.
1664
+ # @param order_id [String] The order id to update.
1665
+ # @param order [Order] Order to update
1666
+ # @param [Hash] opts the optional parameters
1667
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1668
+ # @return [Array<(OrderResponse, Integer, Hash)>] OrderResponse data, response status code and response headers
1669
+ def update_order_with_http_info(order_id, order, opts = {})
1670
+ if @api_client.config.debugging
1671
+ @api_client.config.logger.debug 'Calling API: OrderApi.update_order ...'
1672
+ end
1673
+ # verify the required parameter 'order_id' is set
1674
+ if @api_client.config.client_side_validation && order_id.nil?
1675
+ fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.update_order"
1676
+ end
1677
+ # verify the required parameter 'order' is set
1678
+ if @api_client.config.client_side_validation && order.nil?
1679
+ fail ArgumentError, "Missing the required parameter 'order' when calling OrderApi.update_order"
1680
+ end
1681
+ # resource path
1682
+ local_var_path = '/order/orders/{order_id}'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))
1683
+
1684
+ # query parameters
1685
+ query_params = opts[:query_params] || {}
1686
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1687
+
1688
+ # header parameters
1689
+ header_params = opts[:header_params] || {}
1690
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1691
+ # HTTP header 'Accept' (if needed)
1692
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1693
+ # HTTP header 'Content-Type'
1694
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1695
+ if !content_type.nil?
1696
+ header_params['Content-Type'] = content_type
1697
+ end
1698
+
1699
+ # form parameters
1700
+ form_params = opts[:form_params] || {}
1701
+
1702
+ # http body (model)
1703
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(order)
1704
+
1705
+ # return_type
1706
+ return_type = opts[:debug_return_type] || 'OrderResponse'
1707
+
1708
+ # auth_names
1709
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1710
+
1711
+ new_options = opts.merge(
1712
+ :operation => :"OrderApi.update_order",
1713
+ :header_params => header_params,
1714
+ :query_params => query_params,
1715
+ :form_params => form_params,
1716
+ :body => post_body,
1717
+ :auth_names => auth_names,
1718
+ :return_type => return_type
1719
+ )
1720
+
1721
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
1722
+ if @api_client.config.debugging
1723
+ @api_client.config.logger.debug "API called: OrderApi#update_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1724
+ end
1725
+ return data, status_code, headers
1726
+ end
1727
+ end
1728
+ end