ultracart_api 3.11.35 → 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 (1871) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +9 -7
  3. data/README.md +1166 -1846
  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 -13
  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 -72
  193. data/docs/CustomerActivity.md +24 -15
  194. data/docs/CustomerAffiliate.md +24 -11
  195. data/docs/CustomerApi.md +1380 -1412
  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 -17
  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 -38
  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 -44
  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 -57
  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 -23
  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 -1742
  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 -1595
  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 -1942
  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_audio_usage_response.rb → chargeback_dispute_response.rb} +256 -245
  785. data/lib/ultracart_api/models/{conversation_pbx_customer_snapshot_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 -245
  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 -1019
  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 -278
  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 -810
  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 -534
  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 -698
  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 -369
  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/{custom_reports_execution_response.rb → webhook_sample_request.rb} +252 -234
  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 -963
  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 -725
  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 -22
  1334. data/docs/ConversationAgentProfileResponse.md +0 -12
  1335. data/docs/ConversationAgentProfilesResponse.md +0 -12
  1336. data/docs/ConversationApi.md +0 -4975
  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/ConversationDeleteKnowledgeBaseDocumentResponse.md +0 -12
  1345. data/docs/ConversationDepartment.md +0 -12
  1346. data/docs/ConversationDepartmentMember.md +0 -10
  1347. data/docs/ConversationDepartmentMembersResponse.md +0 -12
  1348. data/docs/ConversationDepartmentResponse.md +0 -12
  1349. data/docs/ConversationDepartmentSettings.md +0 -7
  1350. data/docs/ConversationDepartmentsResponse.md +0 -12
  1351. data/docs/ConversationEngagement.md +0 -16
  1352. data/docs/ConversationEngagementEquation.md +0 -8
  1353. data/docs/ConversationEngagementEquationFunction.md +0 -21
  1354. data/docs/ConversationEngagementEquationGroup.md +0 -8
  1355. data/docs/ConversationEngagementResponse.md +0 -12
  1356. data/docs/ConversationEngagementsResponse.md +0 -12
  1357. data/docs/ConversationEventAddCoupon.md +0 -10
  1358. data/docs/ConversationEventAddItem.md +0 -10
  1359. data/docs/ConversationEventQueuePosition.md +0 -9
  1360. data/docs/ConversationEventRRWeb.md +0 -14
  1361. data/docs/ConversationEventReadMessage.md +0 -10
  1362. data/docs/ConversationEventTyping.md +0 -10
  1363. data/docs/ConversationEventWebchatContext.md +0 -10
  1364. data/docs/ConversationInsertKnowledgeBaseDocumentRequest.md +0 -9
  1365. data/docs/ConversationInsertKnowledgeBaseDocumentResponse.md +0 -14
  1366. data/docs/ConversationJoinRequest.md +0 -8
  1367. data/docs/ConversationKnowledgeBaseDocument.md +0 -15
  1368. data/docs/ConversationKnowledgeBaseDocumentUploadUrl.md +0 -9
  1369. data/docs/ConversationKnowledgeBaseDocumentUploadUrlResponse.md +0 -12
  1370. data/docs/ConversationKnowledgeBaseDocumentsResponse.md +0 -12
  1371. data/docs/ConversationLocationCountry.md +0 -10
  1372. data/docs/ConversationLocationStateProvince.md +0 -9
  1373. data/docs/ConversationLocationsResponse.md +0 -12
  1374. data/docs/ConversationMcpServer.md +0 -15
  1375. data/docs/ConversationMcpServerResponse.md +0 -12
  1376. data/docs/ConversationMcpServerToolsResponse.md +0 -12
  1377. data/docs/ConversationMcpServersResponse.md +0 -12
  1378. data/docs/ConversationMessage.md +0 -23
  1379. data/docs/ConversationMessageTranslation.md +0 -9
  1380. data/docs/ConversationMessageTransportStatus.md +0 -9
  1381. data/docs/ConversationMessagesResponse.md +0 -12
  1382. data/docs/ConversationMultimediaUploadUrl.md +0 -9
  1383. data/docs/ConversationMultimediaUploadUrlResponse.md +0 -12
  1384. data/docs/ConversationParticipant.md +0 -20
  1385. data/docs/ConversationPbxAgent.md +0 -23
  1386. data/docs/ConversationPbxAgentResponse.md +0 -12
  1387. data/docs/ConversationPbxAgentsResponse.md +0 -12
  1388. data/docs/ConversationPbxAudio.md +0 -17
  1389. data/docs/ConversationPbxAudioResponse.md +0 -12
  1390. data/docs/ConversationPbxAudioUploadUrl.md +0 -9
  1391. data/docs/ConversationPbxAudioUploadUrlResponse.md +0 -12
  1392. data/docs/ConversationPbxAudioUsageResponse.md +0 -14
  1393. data/docs/ConversationPbxAudiosResponse.md +0 -12
  1394. data/docs/ConversationPbxCustomerSnapshotRequest.md +0 -15
  1395. data/docs/ConversationPbxCustomerSnapshotResponse.md +0 -14
  1396. data/docs/ConversationPbxMenu.md +0 -18
  1397. data/docs/ConversationPbxMenuMapping.md +0 -11
  1398. data/docs/ConversationPbxMenuResponse.md +0 -12
  1399. data/docs/ConversationPbxMenusResponse.md +0 -12
  1400. data/docs/ConversationPbxPhoneNumber.md +0 -12
  1401. data/docs/ConversationPbxPhoneNumberResponse.md +0 -12
  1402. data/docs/ConversationPbxPhoneNumbersResponse.md +0 -12
  1403. data/docs/ConversationPbxQueue.md +0 -28
  1404. data/docs/ConversationPbxQueueMembers.md +0 -9
  1405. data/docs/ConversationPbxQueueResponse.md +0 -12
  1406. data/docs/ConversationPbxQueuesResponse.md +0 -12
  1407. data/docs/ConversationPbxTimeBased.md +0 -11
  1408. data/docs/ConversationPbxTimeBasedMapping.md +0 -11
  1409. data/docs/ConversationPbxTimeBasedMappingConfig.md +0 -9
  1410. data/docs/ConversationPbxTimeBasedResponse.md +0 -12
  1411. data/docs/ConversationPbxTimeBasedsResponse.md +0 -12
  1412. data/docs/ConversationPbxTimeRange.md +0 -12
  1413. data/docs/ConversationPbxTimeRangeConfig.md +0 -13
  1414. data/docs/ConversationPbxTimeRangeResponse.md +0 -12
  1415. data/docs/ConversationPbxTimeRangesResponse.md +0 -12
  1416. data/docs/ConversationPbxVoicemailMailbox.md +0 -19
  1417. data/docs/ConversationPbxVoicemailMailboxResponse.md +0 -12
  1418. data/docs/ConversationPbxVoicemailMailboxesResponse.md +0 -12
  1419. data/docs/ConversationPbxVoicemailMessage.md +0 -20
  1420. data/docs/ConversationPbxVoicemailMessageResponse.md +0 -12
  1421. data/docs/ConversationPbxVoicemailMessageSummariesResponse.md +0 -12
  1422. data/docs/ConversationPbxVoicemailMessageSummary.md +0 -17
  1423. data/docs/ConversationPermissions.md +0 -8
  1424. data/docs/ConversationPermissionsResponse.md +0 -12
  1425. data/docs/ConversationResponse.md +0 -12
  1426. data/docs/ConversationSearchRequest.md +0 -19
  1427. data/docs/ConversationSearchResponse.md +0 -11
  1428. data/docs/ConversationSentiment.md +0 -13
  1429. data/docs/ConversationStartRequest.md +0 -10
  1430. data/docs/ConversationStartResponse.md +0 -8
  1431. data/docs/ConversationSummary.md +0 -24
  1432. data/docs/ConversationTwilioAccount.md +0 -9
  1433. data/docs/ConversationVirtualAgentBudget.md +0 -11
  1434. data/docs/ConversationVirtualAgentBudgetResponse.md +0 -12
  1435. data/docs/ConversationVirtualAgentCapabilities.md +0 -23
  1436. data/docs/ConversationVirtualAgentCapabilitiesResponse.md +0 -12
  1437. data/docs/ConversationVirtualAgentCapabilityZohoDeskDepartment.md +0 -9
  1438. data/docs/ConversationWebchatContext.md +0 -15
  1439. data/docs/ConversationWebchatQueueStatus.md +0 -22
  1440. data/docs/ConversationWebchatQueueStatusAgent.md +0 -13
  1441. data/docs/ConversationWebchatQueueStatusQueueEntry.md +0 -15
  1442. data/docs/ConversationWebchatQueueStatusUpdateRequest.md +0 -8
  1443. data/docs/ConversationWebchatQueueStatusesResponse.md +0 -12
  1444. data/docs/ConversationWebsocketMessage.md +0 -31
  1445. data/docs/ConversationsResponse.md +0 -12
  1446. data/docs/CouponFreeItemWithItemPurchaseAndFreeShipping.md +0 -12
  1447. data/docs/CouponMoreLoyaltyCashback.md +0 -8
  1448. data/docs/CouponMoreLoyaltyPoints.md +0 -8
  1449. data/docs/CouponNoDiscount.md +0 -8
  1450. data/docs/CouponPercentMoreLoyaltyCashback.md +0 -8
  1451. data/docs/CouponPercentMoreLoyaltyPoints.md +0 -8
  1452. data/docs/CouponTieredPercentOffSubtotalBasedOnMSRP.md +0 -9
  1453. data/docs/CustomDashboard.md +0 -12
  1454. data/docs/CustomDashboardExecutionParameter.md +0 -11
  1455. data/docs/CustomDashboardPage.md +0 -10
  1456. data/docs/CustomDashboardPageReport.md +0 -12
  1457. data/docs/CustomDashboardResponse.md +0 -12
  1458. data/docs/CustomDashboardSchedule.md +0 -12
  1459. data/docs/CustomDashboardScheduleResponse.md +0 -12
  1460. data/docs/CustomDashboardSchedulesResponse.md +0 -12
  1461. data/docs/CustomDashboardsResponse.md +0 -12
  1462. data/docs/CustomReport.md +0 -18
  1463. data/docs/CustomReportAccountConfig.md +0 -18
  1464. data/docs/CustomReportAccountConfigResponse.md +0 -12
  1465. data/docs/CustomReportAnalysisRequest.md +0 -9
  1466. data/docs/CustomReportAnalysisResponse.md +0 -12
  1467. data/docs/CustomReportChartPngUploadResponse.md +0 -13
  1468. data/docs/CustomReportExecutionParameter.md +0 -11
  1469. data/docs/CustomReportExecutionRequest.md +0 -8
  1470. data/docs/CustomReportExecutionResponse.md +0 -15
  1471. data/docs/CustomReportParameter.md +0 -13
  1472. data/docs/CustomReportParameterOption.md +0 -9
  1473. data/docs/CustomReportQuery.md +0 -13
  1474. data/docs/CustomReportResponse.md +0 -12
  1475. data/docs/CustomReportTooltip.md +0 -9
  1476. data/docs/CustomReportUsageBreakdown.md +0 -9
  1477. data/docs/CustomReportsExecutionReportData.md +0 -10
  1478. data/docs/CustomReportsExecutionRequest.md +0 -9
  1479. data/docs/CustomReportsExecutionResponse.md +0 -13
  1480. data/docs/CustomReportsResponse.md +0 -12
  1481. data/docs/CustomerEDI.md +0 -10
  1482. data/docs/CustomerMagicLinkResponse.md +0 -12
  1483. data/docs/CustomerMergeRequest.md +0 -9
  1484. data/docs/CustomerProperty.md +0 -11
  1485. data/docs/CustomerWishListItem.md +0 -14
  1486. data/docs/CustomerWishListItemResponse.md +0 -12
  1487. data/docs/CustomerWishListItemsResponse.md +0 -12
  1488. data/docs/DatawarehouseApi.md +0 -1538
  1489. data/docs/EmailCommseqSequenceTestRequest.md +0 -22
  1490. data/docs/EmailCommseqSequenceTestResponse.md +0 -11
  1491. data/docs/EmailCommseqSmsSendTestRequest.md +0 -10
  1492. data/docs/EmailCommseqSmsSendTestResponse.md +0 -13
  1493. data/docs/EmailEditorValuesResponse.md +0 -12
  1494. data/docs/EmailPostcardTracking.md +0 -32
  1495. data/docs/EmailPostcardTrackingResponse.md +0 -12
  1496. data/docs/EmailRateLimiter.md +0 -10
  1497. data/docs/EmailRateLimitersResponse.md +0 -12
  1498. data/docs/EmailSmsOrder.md +0 -11
  1499. data/docs/EmailSmsOrdersResponse.md +0 -12
  1500. data/docs/EmailSmsStat.md +0 -37
  1501. data/docs/EmailStatSmsSummaryRequest.md +0 -9
  1502. data/docs/EmailStatSmsSummaryResponse.md +0 -12
  1503. data/docs/FileManagerDirectory.md +0 -20
  1504. data/docs/FileManagerFile.md +0 -29
  1505. data/docs/FileManagerPage.md +0 -15
  1506. data/docs/FileManagerPageResponse.md +0 -12
  1507. data/docs/FileManagerUploadRequest.md +0 -10
  1508. data/docs/FileManagerUploadUrlResponse.md +0 -13
  1509. data/docs/HitPageView.md +0 -18
  1510. data/docs/HitPageViewMetaData.md +0 -9
  1511. data/docs/HitSessionStart.md +0 -24
  1512. data/docs/HitSessionUtm.md +0 -22
  1513. data/docs/ItemDigitalItemPdfMeta.md +0 -18
  1514. data/docs/ItemDigitalItemResponse.md +0 -12
  1515. data/docs/ItemDigitalItemsResponse.md +0 -12
  1516. data/docs/ItemInventorySnapshot.md +0 -13
  1517. data/docs/ItemInventorySnapshotDistributionCenter.md +0 -12
  1518. data/docs/ItemInventorySnapshotResponse.md +0 -12
  1519. data/docs/ItemReview.md +0 -45
  1520. data/docs/ItemReviewResponse.md +0 -12
  1521. data/docs/ItemReviewsResponse.md +0 -12
  1522. data/docs/OrderAssignToAffiliateRequest.md +0 -10
  1523. data/docs/OrderCurrentStageHistory.md +0 -10
  1524. data/docs/OrderEdiDocument.md +0 -21
  1525. data/docs/OrderEdiDocumentsResponse.md +0 -12
  1526. data/docs/OrderInvoiceResponse.md +0 -12
  1527. data/docs/OrderPaymentCreditCardDualVaulted.md +0 -10
  1528. data/docs/OrderPaymentCreditCardDualVaultedProperty.md +0 -9
  1529. data/docs/OrderPaymentHealthBenefitCard.md +0 -13
  1530. data/docs/OrderPaymentPayPal.md +0 -9
  1531. data/docs/OrderPointOfSale.md +0 -10
  1532. data/docs/OrderReason.md +0 -10
  1533. data/docs/OrderRefundableResponse.md +0 -20
  1534. data/docs/OrderTransactionalMerchantNote.md +0 -11
  1535. data/docs/OrderUtm.md +0 -39
  1536. data/docs/OrderValidationRequest.md +0 -9
  1537. data/docs/OrderValidationResponse.md +0 -10
  1538. data/docs/PointOfSaleLocation.md +0 -17
  1539. data/docs/PointOfSaleReader.md +0 -16
  1540. data/docs/PointOfSaleRegister.md +0 -11
  1541. data/docs/ReplaceOrderItemIdRequest.md +0 -11
  1542. data/docs/Report.md +0 -18
  1543. data/docs/ReportAuth.md +0 -11
  1544. data/docs/ReportAuthResponse.md +0 -12
  1545. data/docs/ReportDataSet.md +0 -24
  1546. data/docs/ReportDataSetColumn.md +0 -13
  1547. data/docs/ReportDataSetPage.md +0 -17
  1548. data/docs/ReportDataSetPageResponse.md +0 -12
  1549. data/docs/ReportDataSetQuery.md +0 -20
  1550. data/docs/ReportDataSetQueryOrderByColumn.md +0 -9
  1551. data/docs/ReportDataSetResponse.md +0 -12
  1552. data/docs/ReportDataSetRow.md +0 -8
  1553. data/docs/ReportDataSetSchema.md +0 -10
  1554. data/docs/ReportDataSource.md +0 -14
  1555. data/docs/ReportDataSourceSchema.md +0 -11
  1556. data/docs/ReportDryRunQueriesRequest.md +0 -13
  1557. data/docs/ReportDryRunQueriesResponse.md +0 -8
  1558. data/docs/ReportDryRunQueryResult.md +0 -9
  1559. data/docs/ReportExecuteQueriesRequest.md +0 -15
  1560. data/docs/ReportFilter.md +0 -13
  1561. data/docs/ReportFilterConnection.md +0 -10
  1562. data/docs/ReportPage.md +0 -13
  1563. data/docs/ReportPageFilter.md +0 -11
  1564. data/docs/ReportPageVisualization.md +0 -17
  1565. data/docs/ReportPageVisualizationDimension.md +0 -14
  1566. data/docs/ReportPageVisualizationMetric.md +0 -11
  1567. data/docs/ReportResponse.md +0 -12
  1568. data/docs/ReportWebsocketEvent.md +0 -9
  1569. data/docs/ReportsResponse.md +0 -12
  1570. data/docs/RulerValidationRequest.md +0 -8
  1571. data/docs/RulerValidationResponse.md +0 -9
  1572. data/docs/StoreFront.md +0 -18
  1573. data/docs/StoreFrontPageContentAttribute.md +0 -11
  1574. data/docs/StoreFrontsResponse.md +0 -12
  1575. data/docs/WebhookReflow.md +0 -9
  1576. data/docs/WebhookReflowResponse.md +0 -12
  1577. data/docs/WorkflowAgentAuth.md +0 -10
  1578. data/docs/WorkflowAgentAuthResponse.md +0 -12
  1579. data/docs/WorkflowApi.md +0 -620
  1580. data/docs/WorkflowAttachment.md +0 -12
  1581. data/docs/WorkflowAttachmentUploadUrl.md +0 -9
  1582. data/docs/WorkflowAttachmentUploadUrlResponse.md +0 -12
  1583. data/docs/WorkflowGroup.md +0 -9
  1584. data/docs/WorkflowGroupsResponse.md +0 -12
  1585. data/docs/WorkflowNote.md +0 -13
  1586. data/docs/WorkflowTask.md +0 -39
  1587. data/docs/WorkflowTaskHistory.md +0 -11
  1588. data/docs/WorkflowTaskOpenCountResponse.md +0 -12
  1589. data/docs/WorkflowTaskResponse.md +0 -12
  1590. data/docs/WorkflowTaskTagsResponse.md +0 -12
  1591. data/docs/WorkflowTasksRequest.md +0 -27
  1592. data/docs/WorkflowTasksResponse.md +0 -13
  1593. data/docs/WorkflowUser.md +0 -10
  1594. data/docs/WorkflowUserResponse.md +0 -12
  1595. data/docs/WorkflowUsersResponse.md +0 -13
  1596. data/lib/ultracart_api/api/conversation_api.rb +0 -5443
  1597. data/lib/ultracart_api/api/datawarehouse_api.rb +0 -1711
  1598. data/lib/ultracart_api/api/workflow_api.rb +0 -693
  1599. data/lib/ultracart_api/models/accounts_receivable_retry_transaction_reject.rb +0 -195
  1600. data/lib/ultracart_api/models/auto_order_addon_item.rb +0 -232
  1601. data/lib/ultracart_api/models/auto_order_addon_item_option.rb +0 -225
  1602. data/lib/ultracart_api/models/auto_order_consolidate.rb +0 -186
  1603. data/lib/ultracart_api/models/auto_order_management.rb +0 -185
  1604. data/lib/ultracart_api/models/cart_item_property.rb +0 -245
  1605. data/lib/ultracart_api/models/cart_payment_health_benefit_card.rb +0 -235
  1606. data/lib/ultracart_api/models/chanel_partner_reason_codes_response.rb +0 -290
  1607. data/lib/ultracart_api/models/channel_partner.rb +0 -255
  1608. data/lib/ultracart_api/models/channel_partner_order_item_property.rb +0 -245
  1609. data/lib/ultracart_api/models/channel_partner_ship_to_preference.rb +0 -262
  1610. data/lib/ultracart_api/models/channel_partner_ship_to_preference_response.rb +0 -221
  1611. data/lib/ultracart_api/models/channel_partner_ship_to_preferences_response.rb +0 -224
  1612. data/lib/ultracart_api/models/channel_partners_response.rb +0 -224
  1613. data/lib/ultracart_api/models/conversation.rb +0 -410
  1614. data/lib/ultracart_api/models/conversation_agent_auth.rb +0 -316
  1615. data/lib/ultracart_api/models/conversation_agent_auth_response.rb +0 -221
  1616. data/lib/ultracart_api/models/conversation_agent_profile.rb +0 -363
  1617. data/lib/ultracart_api/models/conversation_agent_profile_response.rb +0 -221
  1618. data/lib/ultracart_api/models/conversation_agent_profiles_response.rb +0 -223
  1619. data/lib/ultracart_api/models/conversation_autocomplete_request.rb +0 -193
  1620. data/lib/ultracart_api/models/conversation_autocomplete_response.rb +0 -241
  1621. data/lib/ultracart_api/models/conversation_autocomplete_value.rb +0 -193
  1622. data/lib/ultracart_api/models/conversation_canned_message.rb +0 -213
  1623. data/lib/ultracart_api/models/conversation_canned_message_response.rb +0 -221
  1624. data/lib/ultracart_api/models/conversation_canned_messages_response.rb +0 -223
  1625. data/lib/ultracart_api/models/conversation_canned_messages_search.rb +0 -193
  1626. data/lib/ultracart_api/models/conversation_delete_knowledge_base_document_response.rb +0 -221
  1627. data/lib/ultracart_api/models/conversation_department.rb +0 -222
  1628. data/lib/ultracart_api/models/conversation_department_member.rb +0 -202
  1629. data/lib/ultracart_api/models/conversation_department_members_response.rb +0 -223
  1630. data/lib/ultracart_api/models/conversation_department_response.rb +0 -221
  1631. data/lib/ultracart_api/models/conversation_department_settings.rb +0 -175
  1632. data/lib/ultracart_api/models/conversation_departments_response.rb +0 -223
  1633. data/lib/ultracart_api/models/conversation_engagement.rb +0 -293
  1634. data/lib/ultracart_api/models/conversation_engagement_equation.rb +0 -186
  1635. data/lib/ultracart_api/models/conversation_engagement_equation_function.rb +0 -414
  1636. data/lib/ultracart_api/models/conversation_engagement_equation_group.rb +0 -186
  1637. data/lib/ultracart_api/models/conversation_engagement_response.rb +0 -221
  1638. data/lib/ultracart_api/models/conversation_engagements_response.rb +0 -223
  1639. data/lib/ultracart_api/models/conversation_event_add_coupon.rb +0 -202
  1640. data/lib/ultracart_api/models/conversation_event_add_item.rb +0 -204
  1641. data/lib/ultracart_api/models/conversation_event_queue_position.rb +0 -195
  1642. data/lib/ultracart_api/models/conversation_event_read_message.rb +0 -203
  1643. data/lib/ultracart_api/models/conversation_event_rr_web.rb +0 -273
  1644. data/lib/ultracart_api/models/conversation_event_typing.rb +0 -202
  1645. data/lib/ultracart_api/models/conversation_event_webchat_context.rb +0 -202
  1646. data/lib/ultracart_api/models/conversation_insert_knowledge_base_document_request.rb +0 -193
  1647. data/lib/ultracart_api/models/conversation_insert_knowledge_base_document_response.rb +0 -241
  1648. data/lib/ultracart_api/models/conversation_join_request.rb +0 -184
  1649. data/lib/ultracart_api/models/conversation_knowledge_base_document.rb +0 -248
  1650. data/lib/ultracart_api/models/conversation_knowledge_base_document_upload_url.rb +0 -193
  1651. data/lib/ultracart_api/models/conversation_knowledge_base_document_upload_url_response.rb +0 -221
  1652. data/lib/ultracart_api/models/conversation_knowledge_base_documents_response.rb +0 -224
  1653. data/lib/ultracart_api/models/conversation_location_country.rb +0 -204
  1654. data/lib/ultracart_api/models/conversation_location_state_province.rb +0 -193
  1655. data/lib/ultracart_api/models/conversation_locations_response.rb +0 -223
  1656. data/lib/ultracart_api/models/conversation_mcp_server.rb +0 -289
  1657. data/lib/ultracart_api/models/conversation_mcp_server_response.rb +0 -221
  1658. data/lib/ultracart_api/models/conversation_mcp_server_tools_response.rb +0 -221
  1659. data/lib/ultracart_api/models/conversation_mcp_servers_response.rb +0 -223
  1660. data/lib/ultracart_api/models/conversation_message.rb +0 -365
  1661. data/lib/ultracart_api/models/conversation_message_translation.rb +0 -193
  1662. data/lib/ultracart_api/models/conversation_message_transport_status.rb +0 -228
  1663. data/lib/ultracart_api/models/conversation_messages_response.rb +0 -223
  1664. data/lib/ultracart_api/models/conversation_multimedia_upload_url.rb +0 -193
  1665. data/lib/ultracart_api/models/conversation_multimedia_upload_url_response.rb +0 -221
  1666. data/lib/ultracart_api/models/conversation_participant.rb +0 -295
  1667. data/lib/ultracart_api/models/conversation_pbx_agent.rb +0 -440
  1668. data/lib/ultracart_api/models/conversation_pbx_agent_response.rb +0 -221
  1669. data/lib/ultracart_api/models/conversation_pbx_agents_response.rb +0 -223
  1670. data/lib/ultracart_api/models/conversation_pbx_audio.rb +0 -365
  1671. data/lib/ultracart_api/models/conversation_pbx_audio_response.rb +0 -221
  1672. data/lib/ultracart_api/models/conversation_pbx_audio_upload_url.rb +0 -193
  1673. data/lib/ultracart_api/models/conversation_pbx_audio_upload_url_response.rb +0 -221
  1674. data/lib/ultracart_api/models/conversation_pbx_audios_response.rb +0 -223
  1675. data/lib/ultracart_api/models/conversation_pbx_customer_snapshot_request.rb +0 -248
  1676. data/lib/ultracart_api/models/conversation_pbx_menu.rb +0 -416
  1677. data/lib/ultracart_api/models/conversation_pbx_menu_mapping.rb +0 -269
  1678. data/lib/ultracart_api/models/conversation_pbx_menu_response.rb +0 -221
  1679. data/lib/ultracart_api/models/conversation_pbx_menus_response.rb +0 -223
  1680. data/lib/ultracart_api/models/conversation_pbx_phone_number.rb +0 -324
  1681. data/lib/ultracart_api/models/conversation_pbx_phone_number_response.rb +0 -221
  1682. data/lib/ultracart_api/models/conversation_pbx_phone_numbers_response.rb +0 -223
  1683. data/lib/ultracart_api/models/conversation_pbx_queue.rb +0 -534
  1684. data/lib/ultracart_api/models/conversation_pbx_queue_members.rb +0 -197
  1685. data/lib/ultracart_api/models/conversation_pbx_queue_response.rb +0 -221
  1686. data/lib/ultracart_api/models/conversation_pbx_queues_response.rb +0 -223
  1687. data/lib/ultracart_api/models/conversation_pbx_time_based.rb +0 -211
  1688. data/lib/ultracart_api/models/conversation_pbx_time_based_mapping.rb +0 -299
  1689. data/lib/ultracart_api/models/conversation_pbx_time_based_mapping_config.rb +0 -196
  1690. data/lib/ultracart_api/models/conversation_pbx_time_based_response.rb +0 -221
  1691. data/lib/ultracart_api/models/conversation_pbx_time_baseds_response.rb +0 -223
  1692. data/lib/ultracart_api/models/conversation_pbx_time_range.rb +0 -287
  1693. data/lib/ultracart_api/models/conversation_pbx_time_range_config.rb +0 -235
  1694. data/lib/ultracart_api/models/conversation_pbx_time_range_response.rb +0 -221
  1695. data/lib/ultracart_api/models/conversation_pbx_time_ranges_response.rb +0 -223
  1696. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb +0 -458
  1697. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox_response.rb +0 -221
  1698. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailboxes_response.rb +0 -223
  1699. data/lib/ultracart_api/models/conversation_pbx_voicemail_message.rb +0 -339
  1700. data/lib/ultracart_api/models/conversation_pbx_voicemail_message_response.rb +0 -221
  1701. data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summaries_response.rb +0 -223
  1702. data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summary.rb +0 -309
  1703. data/lib/ultracart_api/models/conversation_permissions.rb +0 -184
  1704. data/lib/ultracart_api/models/conversation_permissions_response.rb +0 -221
  1705. data/lib/ultracart_api/models/conversation_response.rb +0 -221
  1706. data/lib/ultracart_api/models/conversation_search_request.rb +0 -285
  1707. data/lib/ultracart_api/models/conversation_search_response.rb +0 -213
  1708. data/lib/ultracart_api/models/conversation_sentiment.rb +0 -269
  1709. data/lib/ultracart_api/models/conversation_start_request.rb +0 -204
  1710. data/lib/ultracart_api/models/conversation_start_response.rb +0 -184
  1711. data/lib/ultracart_api/models/conversation_summary.rb +0 -369
  1712. data/lib/ultracart_api/models/conversation_twilio_account.rb +0 -195
  1713. data/lib/ultracart_api/models/conversation_virtual_agent_budget.rb +0 -211
  1714. data/lib/ultracart_api/models/conversation_virtual_agent_budget_response.rb +0 -221
  1715. data/lib/ultracart_api/models/conversation_virtual_agent_capabilities.rb +0 -362
  1716. data/lib/ultracart_api/models/conversation_virtual_agent_capabilities_response.rb +0 -221
  1717. data/lib/ultracart_api/models/conversation_virtual_agent_capability_zoho_desk_department.rb +0 -193
  1718. data/lib/ultracart_api/models/conversation_webchat_context.rb +0 -254
  1719. data/lib/ultracart_api/models/conversation_webchat_queue_status.rb +0 -315
  1720. data/lib/ultracart_api/models/conversation_webchat_queue_status_agent.rb +0 -266
  1721. data/lib/ultracart_api/models/conversation_webchat_queue_status_queue_entry.rb +0 -248
  1722. data/lib/ultracart_api/models/conversation_webchat_queue_status_update_request.rb +0 -219
  1723. data/lib/ultracart_api/models/conversation_webchat_queue_statuses_response.rb +0 -223
  1724. data/lib/ultracart_api/models/conversation_websocket_message.rb +0 -441
  1725. data/lib/ultracart_api/models/conversations_response.rb +0 -223
  1726. data/lib/ultracart_api/models/coupon_free_item_with_item_purchase_and_free_shipping.rb +0 -231
  1727. data/lib/ultracart_api/models/coupon_more_loyalty_cashback.rb +0 -185
  1728. data/lib/ultracart_api/models/coupon_more_loyalty_points.rb +0 -185
  1729. data/lib/ultracart_api/models/coupon_no_discount.rb +0 -185
  1730. data/lib/ultracart_api/models/coupon_percent_more_loyalty_cashback.rb +0 -185
  1731. data/lib/ultracart_api/models/coupon_percent_more_loyalty_points.rb +0 -185
  1732. data/lib/ultracart_api/models/coupon_tiered_percent_off_subtotal_based_on_msrp.rb +0 -199
  1733. data/lib/ultracart_api/models/custom_dashboard.rb +0 -224
  1734. data/lib/ultracart_api/models/custom_dashboard_execution_parameter.rb +0 -211
  1735. data/lib/ultracart_api/models/custom_dashboard_page.rb +0 -204
  1736. data/lib/ultracart_api/models/custom_dashboard_page_report.rb +0 -220
  1737. data/lib/ultracart_api/models/custom_dashboard_response.rb +0 -221
  1738. data/lib/ultracart_api/models/custom_dashboard_schedule.rb +0 -223
  1739. data/lib/ultracart_api/models/custom_dashboard_schedule_response.rb +0 -221
  1740. data/lib/ultracart_api/models/custom_dashboard_schedules_response.rb +0 -224
  1741. data/lib/ultracart_api/models/custom_dashboards_response.rb +0 -224
  1742. data/lib/ultracart_api/models/custom_report.rb +0 -280
  1743. data/lib/ultracart_api/models/custom_report_account_config.rb +0 -281
  1744. data/lib/ultracart_api/models/custom_report_account_config_response.rb +0 -221
  1745. data/lib/ultracart_api/models/custom_report_analysis_request.rb +0 -193
  1746. data/lib/ultracart_api/models/custom_report_analysis_response.rb +0 -221
  1747. data/lib/ultracart_api/models/custom_report_chart_png_upload_response.rb +0 -230
  1748. data/lib/ultracart_api/models/custom_report_execution_parameter.rb +0 -211
  1749. data/lib/ultracart_api/models/custom_report_execution_request.rb +0 -186
  1750. data/lib/ultracart_api/models/custom_report_execution_response.rb +0 -250
  1751. data/lib/ultracart_api/models/custom_report_parameter.rb +0 -231
  1752. data/lib/ultracart_api/models/custom_report_parameter_option.rb +0 -193
  1753. data/lib/ultracart_api/models/custom_report_query.rb +0 -231
  1754. data/lib/ultracart_api/models/custom_report_response.rb +0 -221
  1755. data/lib/ultracart_api/models/custom_report_tooltip.rb +0 -193
  1756. data/lib/ultracart_api/models/custom_report_usage_breakdown.rb +0 -194
  1757. data/lib/ultracart_api/models/custom_reports_execution_report_data.rb +0 -202
  1758. data/lib/ultracart_api/models/custom_reports_execution_request.rb +0 -197
  1759. data/lib/ultracart_api/models/custom_reports_response.rb +0 -224
  1760. data/lib/ultracart_api/models/customer_edi.rb +0 -205
  1761. data/lib/ultracart_api/models/customer_magic_link_response.rb +0 -222
  1762. data/lib/ultracart_api/models/customer_merge_request.rb +0 -195
  1763. data/lib/ultracart_api/models/customer_property.rb +0 -245
  1764. data/lib/ultracart_api/models/customer_wish_list_item.rb +0 -260
  1765. data/lib/ultracart_api/models/customer_wish_list_item_response.rb +0 -221
  1766. data/lib/ultracart_api/models/email_commseq_sequence_test_request.rb +0 -312
  1767. data/lib/ultracart_api/models/email_commseq_sequence_test_response.rb +0 -212
  1768. data/lib/ultracart_api/models/email_commseq_sms_send_test_request.rb +0 -202
  1769. data/lib/ultracart_api/models/email_commseq_sms_send_test_response.rb +0 -232
  1770. data/lib/ultracart_api/models/email_editor_values_response.rb +0 -223
  1771. data/lib/ultracart_api/models/email_postcard_tracking.rb +0 -404
  1772. data/lib/ultracart_api/models/email_postcard_tracking_response.rb +0 -221
  1773. data/lib/ultracart_api/models/email_rate_limiter.rb +0 -202
  1774. data/lib/ultracart_api/models/email_rate_limiters_response.rb +0 -223
  1775. data/lib/ultracart_api/models/email_sms_order.rb +0 -214
  1776. data/lib/ultracart_api/models/email_sms_orders_response.rb +0 -223
  1777. data/lib/ultracart_api/models/email_sms_stat.rb +0 -476
  1778. data/lib/ultracart_api/models/email_stat_sms_summary_request.rb +0 -195
  1779. data/lib/ultracart_api/models/email_stat_sms_summary_response.rb +0 -223
  1780. data/lib/ultracart_api/models/file_manager_directory.rb +0 -292
  1781. data/lib/ultracart_api/models/file_manager_file.rb +0 -376
  1782. data/lib/ultracart_api/models/file_manager_page.rb +0 -253
  1783. data/lib/ultracart_api/models/file_manager_page_response.rb +0 -221
  1784. data/lib/ultracart_api/models/file_manager_upload_request.rb +0 -202
  1785. data/lib/ultracart_api/models/file_manager_upload_url_response.rb +0 -230
  1786. data/lib/ultracart_api/models/hit_page_view.rb +0 -276
  1787. data/lib/ultracart_api/models/hit_page_view_meta_data.rb +0 -193
  1788. data/lib/ultracart_api/models/hit_session_start.rb +0 -328
  1789. data/lib/ultracart_api/models/hit_session_utm.rb +0 -310
  1790. data/lib/ultracart_api/models/item_digital_item_pdf_meta.rb +0 -315
  1791. data/lib/ultracart_api/models/item_digital_item_response.rb +0 -221
  1792. data/lib/ultracart_api/models/item_digital_items_response.rb +0 -224
  1793. data/lib/ultracart_api/models/item_inventory_snapshot.rb +0 -231
  1794. data/lib/ultracart_api/models/item_inventory_snapshot_distribution_center.rb +0 -220
  1795. data/lib/ultracart_api/models/item_inventory_snapshot_response.rb +0 -224
  1796. data/lib/ultracart_api/models/item_review.rb +0 -826
  1797. data/lib/ultracart_api/models/item_review_response.rb +0 -221
  1798. data/lib/ultracart_api/models/item_reviews_response.rb +0 -224
  1799. data/lib/ultracart_api/models/order_assign_to_affiliate_request.rb +0 -220
  1800. data/lib/ultracart_api/models/order_current_stage_history.rb +0 -251
  1801. data/lib/ultracart_api/models/order_edi_document.rb +0 -337
  1802. data/lib/ultracart_api/models/order_edi_documents_response.rb +0 -224
  1803. data/lib/ultracart_api/models/order_invoice_response.rb +0 -222
  1804. data/lib/ultracart_api/models/order_payment_credit_card_dual_vaulted.rb +0 -204
  1805. data/lib/ultracart_api/models/order_payment_credit_card_dual_vaulted_property.rb +0 -193
  1806. data/lib/ultracart_api/models/order_payment_health_benefit_card.rb +0 -235
  1807. data/lib/ultracart_api/models/order_payment_pay_pal.rb +0 -195
  1808. data/lib/ultracart_api/models/order_point_of_sale.rb +0 -202
  1809. data/lib/ultracart_api/models/order_reason.rb +0 -205
  1810. data/lib/ultracart_api/models/order_refundable_response.rb +0 -310
  1811. data/lib/ultracart_api/models/order_transactional_merchant_note.rb +0 -215
  1812. data/lib/ultracart_api/models/order_utm.rb +0 -464
  1813. data/lib/ultracart_api/models/order_validation_request.rb +0 -196
  1814. data/lib/ultracart_api/models/order_validation_response.rb +0 -209
  1815. data/lib/ultracart_api/models/point_of_sale_location.rb +0 -290
  1816. data/lib/ultracart_api/models/point_of_sale_reader.rb +0 -299
  1817. data/lib/ultracart_api/models/point_of_sale_register.rb +0 -215
  1818. data/lib/ultracart_api/models/replace_order_item_id_request.rb +0 -245
  1819. data/lib/ultracart_api/models/report.rb +0 -317
  1820. data/lib/ultracart_api/models/report_auth.rb +0 -212
  1821. data/lib/ultracart_api/models/report_auth_response.rb +0 -221
  1822. data/lib/ultracart_api/models/report_data_set.rb +0 -381
  1823. data/lib/ultracart_api/models/report_data_set_column.rb +0 -229
  1824. data/lib/ultracart_api/models/report_data_set_page.rb +0 -273
  1825. data/lib/ultracart_api/models/report_data_set_page_response.rb +0 -221
  1826. data/lib/ultracart_api/models/report_data_set_query.rb +0 -342
  1827. data/lib/ultracart_api/models/report_data_set_query_order_by_column.rb +0 -193
  1828. data/lib/ultracart_api/models/report_data_set_response.rb +0 -221
  1829. data/lib/ultracart_api/models/report_data_set_row.rb +0 -186
  1830. data/lib/ultracart_api/models/report_data_set_schema.rb +0 -238
  1831. data/lib/ultracart_api/models/report_data_source.rb +0 -242
  1832. data/lib/ultracart_api/models/report_data_source_schema.rb +0 -248
  1833. data/lib/ultracart_api/models/report_dry_run_queries_request.rb +0 -231
  1834. data/lib/ultracart_api/models/report_dry_run_queries_response.rb +0 -186
  1835. data/lib/ultracart_api/models/report_dry_run_query_result.rb +0 -193
  1836. data/lib/ultracart_api/models/report_execute_queries_request.rb +0 -288
  1837. data/lib/ultracart_api/models/report_filter.rb +0 -272
  1838. data/lib/ultracart_api/models/report_filter_connection.rb +0 -203
  1839. data/lib/ultracart_api/models/report_page.rb +0 -237
  1840. data/lib/ultracart_api/models/report_page_filter.rb +0 -214
  1841. data/lib/ultracart_api/models/report_page_visualization.rb +0 -309
  1842. data/lib/ultracart_api/models/report_page_visualization_dimension.rb +0 -244
  1843. data/lib/ultracart_api/models/report_page_visualization_metric.rb +0 -248
  1844. data/lib/ultracart_api/models/report_response.rb +0 -221
  1845. data/lib/ultracart_api/models/report_websocket_event.rb +0 -228
  1846. data/lib/ultracart_api/models/reports_response.rb +0 -223
  1847. data/lib/ultracart_api/models/ruler_validation_request.rb +0 -184
  1848. data/lib/ultracart_api/models/ruler_validation_response.rb +0 -193
  1849. data/lib/ultracart_api/models/store_front.rb +0 -274
  1850. data/lib/ultracart_api/models/store_front_page_content_attribute.rb +0 -245
  1851. data/lib/ultracart_api/models/store_fronts_response.rb +0 -223
  1852. data/lib/ultracart_api/models/webhook_reflow.rb +0 -193
  1853. data/lib/ultracart_api/models/webhook_reflow_response.rb +0 -221
  1854. data/lib/ultracart_api/models/workflow_agent_auth.rb +0 -202
  1855. data/lib/ultracart_api/models/workflow_agent_auth_response.rb +0 -221
  1856. data/lib/ultracart_api/models/workflow_attachment.rb +0 -225
  1857. data/lib/ultracart_api/models/workflow_attachment_upload_url.rb +0 -193
  1858. data/lib/ultracart_api/models/workflow_attachment_upload_url_response.rb +0 -221
  1859. data/lib/ultracart_api/models/workflow_group.rb +0 -195
  1860. data/lib/ultracart_api/models/workflow_groups_response.rb +0 -224
  1861. data/lib/ultracart_api/models/workflow_note.rb +0 -236
  1862. data/lib/ultracart_api/models/workflow_task.rb +0 -574
  1863. data/lib/ultracart_api/models/workflow_task_history.rb +0 -214
  1864. data/lib/ultracart_api/models/workflow_task_open_count_response.rb +0 -222
  1865. data/lib/ultracart_api/models/workflow_task_response.rb +0 -221
  1866. data/lib/ultracart_api/models/workflow_task_tags_response.rb +0 -224
  1867. data/lib/ultracart_api/models/workflow_tasks_request.rb +0 -434
  1868. data/lib/ultracart_api/models/workflow_tasks_response.rb +0 -234
  1869. data/lib/ultracart_api/models/workflow_user.rb +0 -205
  1870. data/lib/ultracart_api/models/workflow_user_response.rb +0 -221
  1871. data/lib/ultracart_api/models/workflow_users_response.rb +0 -234
@@ -1,1942 +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
- # Assigns an order to an affiliate
97
- # Assigns an order to an affiliate.
98
- # @param order_id The order id to assign to the affiliate.
99
- # @param assign_to_affiliate_request Assign to affiliate request
100
- # @param [Hash] opts the optional parameters
101
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
102
- # @return [OrderResponse]
103
- def assign_to_affiliate(order_id, assign_to_affiliate_request, opts = {})
104
- data, _status_code, _headers = assign_to_affiliate_with_http_info(order_id, assign_to_affiliate_request, opts)
105
- data
106
- end
107
-
108
- # Assigns an order to an affiliate
109
- # Assigns an order to an affiliate.
110
- # @param order_id The order id to assign to the affiliate.
111
- # @param assign_to_affiliate_request Assign to affiliate request
112
- # @param [Hash] opts the optional parameters
113
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
114
- # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
115
- def assign_to_affiliate_with_http_info(order_id, assign_to_affiliate_request, opts = {})
116
- if @api_client.config.debugging
117
- @api_client.config.logger.debug 'Calling API: OrderApi.assign_to_affiliate ...'
118
- end
119
- # verify the required parameter 'order_id' is set
120
- if @api_client.config.client_side_validation && order_id.nil?
121
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.assign_to_affiliate"
122
- end
123
- # verify the required parameter 'assign_to_affiliate_request' is set
124
- if @api_client.config.client_side_validation && assign_to_affiliate_request.nil?
125
- fail ArgumentError, "Missing the required parameter 'assign_to_affiliate_request' when calling OrderApi.assign_to_affiliate"
126
- end
127
- # resource path
128
- local_var_path = '/order/orders/{order_id}/assignToAffiliate'.sub('{' + 'order_id' + '}', order_id.to_s)
129
-
130
- # query parameters
131
- query_params = {}
132
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
133
-
134
- # header parameters
135
- 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
- # HTTP header 'Content-Type'
140
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
141
-
142
- # form parameters
143
- form_params = {}
144
-
145
- # http body (model)
146
- post_body = @api_client.object_to_http_body(assign_to_affiliate_request)
147
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
148
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
149
- :header_params => header_params,
150
- :query_params => query_params,
151
- :form_params => form_params,
152
- :body => post_body,
153
- :auth_names => auth_names,
154
- :return_type => 'OrderResponse')
155
- if @api_client.config.debugging
156
- @api_client.config.logger.debug "API called: OrderApi#assign_to_affiliate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
157
- end
158
- return data, status_code, headers
159
- end
160
- # Set a refund block on an order
161
- # Sets a refund block on an order to prevent a user from performing a refund. Commonly used when a chargeback has been received.
162
- # @param order_id The order id to block a refund on.
163
- # @param [Hash] opts the optional parameters
164
- # @option opts [String] :block_reason Block reason code (optional)
165
- # @return [nil]
166
- def block_refund_on_order(order_id, opts = {})
167
- block_refund_on_order_with_http_info(order_id, opts)
168
- nil
169
- end
170
-
171
- # Set a refund block on an order
172
- # Sets a refund block on an order to prevent a user from performing a refund. Commonly used when a chargeback has been received.
173
- # @param order_id The order id to block a refund on.
174
- # @param [Hash] opts the optional parameters
175
- # @option opts [String] :block_reason Block reason code (optional)
176
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
177
- def block_refund_on_order_with_http_info(order_id, opts = {})
178
- if @api_client.config.debugging
179
- @api_client.config.logger.debug 'Calling API: OrderApi.block_refund_on_order ...'
180
- end
181
- # verify the required parameter 'order_id' is set
182
- if @api_client.config.client_side_validation && order_id.nil?
183
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.block_refund_on_order"
184
- end
185
- # resource path
186
- local_var_path = '/order/orders/{order_id}/refund_block'.sub('{' + 'order_id' + '}', order_id.to_s)
187
-
188
- # query parameters
189
- query_params = {}
190
- query_params[:'block_reason'] = opts[:'block_reason'] if !opts[:'block_reason'].nil?
191
-
192
- # header parameters
193
- header_params = {}
194
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
195
- # HTTP header 'Accept' (if needed)
196
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
197
- # HTTP header 'Content-Type'
198
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
199
-
200
- # form parameters
201
- form_params = {}
202
-
203
- # http body (model)
204
- post_body = nil
205
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
206
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
207
- :header_params => header_params,
208
- :query_params => query_params,
209
- :form_params => form_params,
210
- :body => post_body,
211
- :auth_names => auth_names)
212
- if @api_client.config.debugging
213
- @api_client.config.logger.debug "API called: OrderApi#block_refund_on_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
214
- end
215
- return data, status_code, headers
216
- end
217
- # Cancel an order
218
- # Cancel an order on the UltraCart account. If the success flag is false, then consult the error message for why it failed.
219
- # @param order_id The order id to cancel.
220
- # @param [Hash] opts the optional parameters
221
- # @option opts [BOOLEAN] :lock_self_ship_orders Flag to prevent a order shipping during a refund process
222
- # @option opts [BOOLEAN] :skip_refund_and_hold Skip refund and move order to Held Orders department
223
- # @return [BaseResponse]
224
- def cancel_order(order_id, opts = {})
225
- data, _status_code, _headers = cancel_order_with_http_info(order_id, opts)
226
- data
227
- end
228
-
229
- # Cancel an order
230
- # Cancel an order on the UltraCart account. If the success flag is false, then consult the error message for why it failed.
231
- # @param order_id The order id to cancel.
232
- # @param [Hash] opts the optional parameters
233
- # @option opts [BOOLEAN] :lock_self_ship_orders Flag to prevent a order shipping during a refund process
234
- # @option opts [BOOLEAN] :skip_refund_and_hold Skip refund and move order to Held Orders department
235
- # @return [Array<(BaseResponse, Fixnum, Hash)>] BaseResponse data, response status code and response headers
236
- def cancel_order_with_http_info(order_id, opts = {})
237
- if @api_client.config.debugging
238
- @api_client.config.logger.debug 'Calling API: OrderApi.cancel_order ...'
239
- end
240
- # verify the required parameter 'order_id' is set
241
- if @api_client.config.client_side_validation && order_id.nil?
242
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.cancel_order"
243
- end
244
- # resource path
245
- local_var_path = '/order/orders/{order_id}/cancel'.sub('{' + 'order_id' + '}', order_id.to_s)
246
-
247
- # query parameters
248
- query_params = {}
249
- query_params[:'lock_self_ship_orders'] = opts[:'lock_self_ship_orders'] if !opts[:'lock_self_ship_orders'].nil?
250
- query_params[:'skip_refund_and_hold'] = opts[:'skip_refund_and_hold'] if !opts[:'skip_refund_and_hold'].nil?
251
-
252
- # header parameters
253
- header_params = {}
254
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
255
- # HTTP header 'Accept' (if needed)
256
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
257
- # HTTP header 'Content-Type'
258
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
259
-
260
- # form parameters
261
- form_params = {}
262
-
263
- # http body (model)
264
- post_body = nil
265
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
266
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
267
- :header_params => header_params,
268
- :query_params => query_params,
269
- :form_params => form_params,
270
- :body => post_body,
271
- :auth_names => auth_names,
272
- :return_type => 'BaseResponse')
273
- if @api_client.config.debugging
274
- @api_client.config.logger.debug "API called: OrderApi#cancel_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
275
- end
276
- return data, status_code, headers
277
- end
278
- # Delete an order
279
- # Delete an order on the UltraCart account.
280
- # @param order_id The order id to delete.
281
- # @param [Hash] opts the optional parameters
282
- # @return [nil]
283
- def delete_order(order_id, opts = {})
284
- delete_order_with_http_info(order_id, opts)
285
- nil
286
- end
287
-
288
- # Delete an order
289
- # Delete an order on the UltraCart account.
290
- # @param order_id The order id to delete.
291
- # @param [Hash] opts the optional parameters
292
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
293
- def delete_order_with_http_info(order_id, opts = {})
294
- if @api_client.config.debugging
295
- @api_client.config.logger.debug 'Calling API: OrderApi.delete_order ...'
296
- end
297
- # verify the required parameter 'order_id' is set
298
- if @api_client.config.client_side_validation && order_id.nil?
299
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.delete_order"
300
- end
301
- # resource path
302
- local_var_path = '/order/orders/{order_id}'.sub('{' + 'order_id' + '}', order_id.to_s)
303
-
304
- # query parameters
305
- query_params = {}
306
-
307
- # header parameters
308
- header_params = {}
309
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
310
- # HTTP header 'Accept' (if needed)
311
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
312
- # HTTP header 'Content-Type'
313
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
314
-
315
- # form parameters
316
- form_params = {}
317
-
318
- # http body (model)
319
- post_body = nil
320
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
321
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
322
- :header_params => header_params,
323
- :query_params => query_params,
324
- :form_params => form_params,
325
- :body => post_body,
326
- :auth_names => auth_names)
327
- if @api_client.config.debugging
328
- @api_client.config.logger.debug "API called: OrderApi#delete_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
329
- end
330
- return data, status_code, headers
331
- end
332
- # Duplicate an order
333
- # Perform a duplicate of the specified order_id and return a new order located in Accounts Receivable.
334
- # @param order_id The order id to duplicate.
335
- # @param [Hash] opts the optional parameters
336
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
337
- # @return [OrderResponse]
338
- def duplicate_order(order_id, opts = {})
339
- data, _status_code, _headers = duplicate_order_with_http_info(order_id, opts)
340
- data
341
- end
342
-
343
- # Duplicate an order
344
- # Perform a duplicate of the specified order_id and return a new order located in Accounts Receivable.
345
- # @param order_id The order id to duplicate.
346
- # @param [Hash] opts the optional parameters
347
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
348
- # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
349
- def duplicate_order_with_http_info(order_id, opts = {})
350
- if @api_client.config.debugging
351
- @api_client.config.logger.debug 'Calling API: OrderApi.duplicate_order ...'
352
- end
353
- # verify the required parameter 'order_id' is set
354
- if @api_client.config.client_side_validation && order_id.nil?
355
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.duplicate_order"
356
- end
357
- # resource path
358
- local_var_path = '/order/orders/{order_id}/duplicate'.sub('{' + 'order_id' + '}', order_id.to_s)
359
-
360
- # query parameters
361
- query_params = {}
362
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
363
-
364
- # header parameters
365
- header_params = {}
366
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
367
- # HTTP header 'Accept' (if needed)
368
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
369
- # HTTP header 'Content-Type'
370
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
371
-
372
- # form parameters
373
- form_params = {}
374
-
375
- # http body (model)
376
- post_body = nil
377
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
378
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
379
- :header_params => header_params,
380
- :query_params => query_params,
381
- :form_params => form_params,
382
- :body => post_body,
383
- :auth_names => auth_names,
384
- :return_type => 'OrderResponse')
385
- if @api_client.config.debugging
386
- @api_client.config.logger.debug "API called: OrderApi#duplicate_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
387
- end
388
- return data, status_code, headers
389
- end
390
- # Format order
391
- # Format the order for display at text or html
392
- # @param order_id The order id to format
393
- # @param format_options Format options
394
- # @param [Hash] opts the optional parameters
395
- # @return [OrderFormatResponse]
396
- def format(order_id, format_options, opts = {})
397
- data, _status_code, _headers = format_with_http_info(order_id, format_options, opts)
398
- data
399
- end
400
-
401
- # Format order
402
- # Format the order for display at text or html
403
- # @param order_id The order id to format
404
- # @param format_options Format options
405
- # @param [Hash] opts the optional parameters
406
- # @return [Array<(OrderFormatResponse, Fixnum, Hash)>] OrderFormatResponse data, response status code and response headers
407
- def format_with_http_info(order_id, format_options, opts = {})
408
- if @api_client.config.debugging
409
- @api_client.config.logger.debug 'Calling API: OrderApi.format ...'
410
- end
411
- # verify the required parameter 'order_id' is set
412
- if @api_client.config.client_side_validation && order_id.nil?
413
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.format"
414
- end
415
- # verify the required parameter 'format_options' is set
416
- if @api_client.config.client_side_validation && format_options.nil?
417
- fail ArgumentError, "Missing the required parameter 'format_options' when calling OrderApi.format"
418
- end
419
- # resource path
420
- local_var_path = '/order/orders/{order_id}/format'.sub('{' + 'order_id' + '}', order_id.to_s)
421
-
422
- # query parameters
423
- query_params = {}
424
-
425
- # header parameters
426
- header_params = {}
427
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
428
- # HTTP header 'Accept' (if needed)
429
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
430
- # HTTP header 'Content-Type'
431
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
432
-
433
- # form parameters
434
- form_params = {}
435
-
436
- # http body (model)
437
- post_body = @api_client.object_to_http_body(format_options)
438
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
439
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
440
- :header_params => header_params,
441
- :query_params => query_params,
442
- :form_params => form_params,
443
- :body => post_body,
444
- :auth_names => auth_names,
445
- :return_type => 'OrderFormatResponse')
446
- if @api_client.config.debugging
447
- @api_client.config.logger.debug "API called: OrderApi#format\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
448
- end
449
- return data, status_code, headers
450
- end
451
- # Generate an invoice for this order.
452
- # The invoice PDF that is returned is base 64 encoded
453
- # @param order_id Order ID
454
- # @param [Hash] opts the optional parameters
455
- # @return [OrderInvoiceResponse]
456
- def generate_invoice(order_id, opts = {})
457
- data, _status_code, _headers = generate_invoice_with_http_info(order_id, opts)
458
- data
459
- end
460
-
461
- # Generate an invoice for this order.
462
- # The invoice PDF that is returned is base 64 encoded
463
- # @param order_id Order ID
464
- # @param [Hash] opts the optional parameters
465
- # @return [Array<(OrderInvoiceResponse, Fixnum, Hash)>] OrderInvoiceResponse data, response status code and response headers
466
- def generate_invoice_with_http_info(order_id, opts = {})
467
- if @api_client.config.debugging
468
- @api_client.config.logger.debug 'Calling API: OrderApi.generate_invoice ...'
469
- end
470
- # verify the required parameter 'order_id' is set
471
- if @api_client.config.client_side_validation && order_id.nil?
472
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.generate_invoice"
473
- end
474
- # resource path
475
- local_var_path = '/order/orders/{order_id}/invoice'.sub('{' + 'order_id' + '}', order_id.to_s)
476
-
477
- # query parameters
478
- query_params = {}
479
-
480
- # header parameters
481
- header_params = {}
482
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
483
- # HTTP header 'Accept' (if needed)
484
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
485
- # HTTP header 'Content-Type'
486
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
487
-
488
- # form parameters
489
- form_params = {}
490
-
491
- # http body (model)
492
- post_body = nil
493
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
494
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
495
- :header_params => header_params,
496
- :query_params => query_params,
497
- :form_params => form_params,
498
- :body => post_body,
499
- :auth_names => auth_names,
500
- :return_type => 'OrderInvoiceResponse')
501
- if @api_client.config.debugging
502
- @api_client.config.logger.debug "API called: OrderApi#generate_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
503
- end
504
- return data, status_code, headers
505
- end
506
- # Generate an order token for a given order id
507
- # Retrieves a single order token for a given order id. The token can be used with the getOrderByToken API.
508
- # @param order_id The order id to generate a token for.
509
- # @param [Hash] opts the optional parameters
510
- # @return [OrderTokenResponse]
511
- def generate_order_token(order_id, opts = {})
512
- data, _status_code, _headers = generate_order_token_with_http_info(order_id, opts)
513
- data
514
- end
515
-
516
- # Generate an order token for a given order id
517
- # Retrieves a single order token for a given order id. The token can be used with the getOrderByToken API.
518
- # @param order_id The order id to generate a token for.
519
- # @param [Hash] opts the optional parameters
520
- # @return [Array<(OrderTokenResponse, Fixnum, Hash)>] OrderTokenResponse data, response status code and response headers
521
- def generate_order_token_with_http_info(order_id, opts = {})
522
- if @api_client.config.debugging
523
- @api_client.config.logger.debug 'Calling API: OrderApi.generate_order_token ...'
524
- end
525
- # verify the required parameter 'order_id' is set
526
- if @api_client.config.client_side_validation && order_id.nil?
527
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.generate_order_token"
528
- end
529
- # resource path
530
- local_var_path = '/order/orders/token/{order_id}'.sub('{' + 'order_id' + '}', order_id.to_s)
531
-
532
- # query parameters
533
- query_params = {}
534
-
535
- # header parameters
536
- header_params = {}
537
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
538
- # HTTP header 'Accept' (if needed)
539
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
540
- # HTTP header 'Content-Type'
541
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
542
-
543
- # form parameters
544
- form_params = {}
545
-
546
- # http body (model)
547
- post_body = nil
548
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
549
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
550
- :header_params => header_params,
551
- :query_params => query_params,
552
- :form_params => form_params,
553
- :body => post_body,
554
- :auth_names => auth_names,
555
- :return_type => 'OrderTokenResponse')
556
- if @api_client.config.debugging
557
- @api_client.config.logger.debug "API called: OrderApi#generate_order_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
558
- end
559
- return data, status_code, headers
560
- end
561
- # Generate a packing slip for this order across all distribution centers.
562
- # The packing slip PDF that is returned is base 64 encoded
563
- # @param order_id Order ID
564
- # @param [Hash] opts the optional parameters
565
- # @return [OrderPackingSlipResponse]
566
- def generate_packing_slip_all_dc(order_id, opts = {})
567
- data, _status_code, _headers = generate_packing_slip_all_dc_with_http_info(order_id, opts)
568
- data
569
- end
570
-
571
- # Generate a packing slip for this order across all distribution centers.
572
- # The packing slip PDF that is returned is base 64 encoded
573
- # @param order_id Order ID
574
- # @param [Hash] opts the optional parameters
575
- # @return [Array<(OrderPackingSlipResponse, Fixnum, Hash)>] OrderPackingSlipResponse data, response status code and response headers
576
- def generate_packing_slip_all_dc_with_http_info(order_id, opts = {})
577
- if @api_client.config.debugging
578
- @api_client.config.logger.debug 'Calling API: OrderApi.generate_packing_slip_all_dc ...'
579
- end
580
- # verify the required parameter 'order_id' is set
581
- if @api_client.config.client_side_validation && order_id.nil?
582
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.generate_packing_slip_all_dc"
583
- end
584
- # resource path
585
- local_var_path = '/order/orders/{order_id}/packing_slip'.sub('{' + 'order_id' + '}', order_id.to_s)
586
-
587
- # query parameters
588
- query_params = {}
589
-
590
- # header parameters
591
- header_params = {}
592
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
593
- # HTTP header 'Accept' (if needed)
594
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
595
- # HTTP header 'Content-Type'
596
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
597
-
598
- # form parameters
599
- form_params = {}
600
-
601
- # http body (model)
602
- post_body = nil
603
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
604
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
605
- :header_params => header_params,
606
- :query_params => query_params,
607
- :form_params => form_params,
608
- :body => post_body,
609
- :auth_names => auth_names,
610
- :return_type => 'OrderPackingSlipResponse')
611
- if @api_client.config.debugging
612
- @api_client.config.logger.debug "API called: OrderApi#generate_packing_slip_all_dc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
613
- end
614
- return data, status_code, headers
615
- end
616
- # Generate a packing slip for this order for the given distribution center.
617
- # The packing slip PDF that is returned is base 64 encoded
618
- # @param distribution_center_code Distribution center code
619
- # @param order_id Order ID
620
- # @param [Hash] opts the optional parameters
621
- # @return [OrderPackingSlipResponse]
622
- def generate_packing_slip_specific_dc(distribution_center_code, order_id, opts = {})
623
- data, _status_code, _headers = generate_packing_slip_specific_dc_with_http_info(distribution_center_code, order_id, opts)
624
- data
625
- end
626
-
627
- # Generate a packing slip for this order for the given distribution center.
628
- # The packing slip PDF that is returned is base 64 encoded
629
- # @param distribution_center_code Distribution center code
630
- # @param order_id Order ID
631
- # @param [Hash] opts the optional parameters
632
- # @return [Array<(OrderPackingSlipResponse, Fixnum, Hash)>] OrderPackingSlipResponse data, response status code and response headers
633
- def generate_packing_slip_specific_dc_with_http_info(distribution_center_code, order_id, opts = {})
634
- if @api_client.config.debugging
635
- @api_client.config.logger.debug 'Calling API: OrderApi.generate_packing_slip_specific_dc ...'
636
- end
637
- # verify the required parameter 'distribution_center_code' is set
638
- if @api_client.config.client_side_validation && distribution_center_code.nil?
639
- fail ArgumentError, "Missing the required parameter 'distribution_center_code' when calling OrderApi.generate_packing_slip_specific_dc"
640
- end
641
- # verify the required parameter 'order_id' is set
642
- if @api_client.config.client_side_validation && order_id.nil?
643
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.generate_packing_slip_specific_dc"
644
- end
645
- # resource path
646
- 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)
647
-
648
- # query parameters
649
- query_params = {}
650
-
651
- # header parameters
652
- header_params = {}
653
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
654
- # HTTP header 'Accept' (if needed)
655
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
656
- # HTTP header 'Content-Type'
657
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
658
-
659
- # form parameters
660
- form_params = {}
661
-
662
- # http body (model)
663
- post_body = nil
664
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
665
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
666
- :header_params => header_params,
667
- :query_params => query_params,
668
- :form_params => form_params,
669
- :body => post_body,
670
- :auth_names => auth_names,
671
- :return_type => 'OrderPackingSlipResponse')
672
- if @api_client.config.debugging
673
- @api_client.config.logger.debug "API called: OrderApi#generate_packing_slip_specific_dc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
674
- end
675
- return data, status_code, headers
676
- end
677
- # Retrieve A/R Retry Configuration
678
- # Retrieve A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.
679
- # @param [Hash] opts the optional parameters
680
- # @return [AccountsReceivableRetryConfigResponse]
681
- def get_accounts_receivable_retry_config(opts = {})
682
- data, _status_code, _headers = get_accounts_receivable_retry_config_with_http_info(opts)
683
- data
684
- end
685
-
686
- # Retrieve A/R Retry Configuration
687
- # Retrieve A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.
688
- # @param [Hash] opts the optional parameters
689
- # @return [Array<(AccountsReceivableRetryConfigResponse, Fixnum, Hash)>] AccountsReceivableRetryConfigResponse data, response status code and response headers
690
- def get_accounts_receivable_retry_config_with_http_info(opts = {})
691
- if @api_client.config.debugging
692
- @api_client.config.logger.debug 'Calling API: OrderApi.get_accounts_receivable_retry_config ...'
693
- end
694
- # resource path
695
- local_var_path = '/order/accountsReceivableRetryConfig'
696
-
697
- # query parameters
698
- query_params = {}
699
-
700
- # header parameters
701
- header_params = {}
702
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
703
- # HTTP header 'Accept' (if needed)
704
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
705
- # HTTP header 'Content-Type'
706
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
707
-
708
- # form parameters
709
- form_params = {}
710
-
711
- # http body (model)
712
- post_body = nil
713
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
714
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
715
- :header_params => header_params,
716
- :query_params => query_params,
717
- :form_params => form_params,
718
- :body => post_body,
719
- :auth_names => auth_names,
720
- :return_type => 'AccountsReceivableRetryConfigResponse')
721
- if @api_client.config.debugging
722
- @api_client.config.logger.debug "API called: OrderApi#get_accounts_receivable_retry_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
723
- end
724
- return data, status_code, headers
725
- end
726
- # Retrieve A/R Retry Statistics
727
- # Retrieve A/R Retry Statistics. This is primarily an internal API call. It is doubtful you would ever need to use it.
728
- # @param [Hash] opts the optional parameters
729
- # @option opts [String] :from
730
- # @option opts [String] :to
731
- # @return [AccountsReceivableRetryStatsResponse]
732
- def get_accounts_receivable_retry_stats(opts = {})
733
- data, _status_code, _headers = get_accounts_receivable_retry_stats_with_http_info(opts)
734
- data
735
- end
736
-
737
- # Retrieve A/R Retry Statistics
738
- # Retrieve A/R Retry Statistics. This is primarily an internal API call. It is doubtful you would ever need to use it.
739
- # @param [Hash] opts the optional parameters
740
- # @option opts [String] :from
741
- # @option opts [String] :to
742
- # @return [Array<(AccountsReceivableRetryStatsResponse, Fixnum, Hash)>] AccountsReceivableRetryStatsResponse data, response status code and response headers
743
- def get_accounts_receivable_retry_stats_with_http_info(opts = {})
744
- if @api_client.config.debugging
745
- @api_client.config.logger.debug 'Calling API: OrderApi.get_accounts_receivable_retry_stats ...'
746
- end
747
- # resource path
748
- local_var_path = '/order/accountsReceivableRetryConfig/stats'
749
-
750
- # query parameters
751
- query_params = {}
752
- query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
753
- query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
754
-
755
- # header parameters
756
- header_params = {}
757
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
758
- # HTTP header 'Accept' (if needed)
759
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
760
- # HTTP header 'Content-Type'
761
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
762
-
763
- # form parameters
764
- form_params = {}
765
-
766
- # http body (model)
767
- post_body = nil
768
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
769
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
770
- :header_params => header_params,
771
- :query_params => query_params,
772
- :form_params => form_params,
773
- :body => post_body,
774
- :auth_names => auth_names,
775
- :return_type => 'AccountsReceivableRetryStatsResponse')
776
- if @api_client.config.debugging
777
- @api_client.config.logger.debug "API called: OrderApi#get_accounts_receivable_retry_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
778
- end
779
- return data, status_code, headers
780
- end
781
- # Retrieve an order
782
- # Retrieves a single order using the specified order id.
783
- # @param order_id The order id to retrieve.
784
- # @param [Hash] opts the optional parameters
785
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
786
- # @return [OrderResponse]
787
- def get_order(order_id, opts = {})
788
- data, _status_code, _headers = get_order_with_http_info(order_id, opts)
789
- data
790
- end
791
-
792
- # Retrieve an order
793
- # Retrieves a single order using the specified order id.
794
- # @param order_id The order id to retrieve.
795
- # @param [Hash] opts the optional parameters
796
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
797
- # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
798
- def get_order_with_http_info(order_id, opts = {})
799
- if @api_client.config.debugging
800
- @api_client.config.logger.debug 'Calling API: OrderApi.get_order ...'
801
- end
802
- # verify the required parameter 'order_id' is set
803
- if @api_client.config.client_side_validation && order_id.nil?
804
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.get_order"
805
- end
806
- # resource path
807
- local_var_path = '/order/orders/{order_id}'.sub('{' + 'order_id' + '}', order_id.to_s)
808
-
809
- # query parameters
810
- query_params = {}
811
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
812
-
813
- # header parameters
814
- header_params = {}
815
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
816
- # HTTP header 'Accept' (if needed)
817
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
818
- # HTTP header 'Content-Type'
819
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
820
-
821
- # form parameters
822
- form_params = {}
823
-
824
- # http body (model)
825
- post_body = nil
826
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
827
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
828
- :header_params => header_params,
829
- :query_params => query_params,
830
- :form_params => form_params,
831
- :body => post_body,
832
- :auth_names => auth_names,
833
- :return_type => 'OrderResponse')
834
- if @api_client.config.debugging
835
- @api_client.config.logger.debug "API called: OrderApi#get_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
836
- end
837
- return data, status_code, headers
838
- end
839
- # Retrieve an order using a token
840
- # Retrieves a single order using the specified order token.
841
- # @param order_by_token_query Order by token query
842
- # @param [Hash] opts the optional parameters
843
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
844
- # @return [OrderResponse]
845
- def get_order_by_token(order_by_token_query, opts = {})
846
- data, _status_code, _headers = get_order_by_token_with_http_info(order_by_token_query, opts)
847
- data
848
- end
849
-
850
- # Retrieve an order using a token
851
- # Retrieves a single order using the specified order token.
852
- # @param order_by_token_query Order by token query
853
- # @param [Hash] opts the optional parameters
854
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
855
- # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
856
- def get_order_by_token_with_http_info(order_by_token_query, opts = {})
857
- if @api_client.config.debugging
858
- @api_client.config.logger.debug 'Calling API: OrderApi.get_order_by_token ...'
859
- end
860
- # verify the required parameter 'order_by_token_query' is set
861
- if @api_client.config.client_side_validation && order_by_token_query.nil?
862
- fail ArgumentError, "Missing the required parameter 'order_by_token_query' when calling OrderApi.get_order_by_token"
863
- end
864
- # resource path
865
- local_var_path = '/order/orders/token'
866
-
867
- # query parameters
868
- query_params = {}
869
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
870
-
871
- # header parameters
872
- header_params = {}
873
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
874
- # HTTP header 'Accept' (if needed)
875
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
876
- # HTTP header 'Content-Type'
877
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
878
-
879
- # form parameters
880
- form_params = {}
881
-
882
- # http body (model)
883
- post_body = @api_client.object_to_http_body(order_by_token_query)
884
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
885
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
886
- :header_params => header_params,
887
- :query_params => query_params,
888
- :form_params => form_params,
889
- :body => post_body,
890
- :auth_names => auth_names,
891
- :return_type => 'OrderResponse')
892
- if @api_client.config.debugging
893
- @api_client.config.logger.debug "API called: OrderApi#get_order_by_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
894
- end
895
- return data, status_code, headers
896
- end
897
- # Retrieve EDI documents associated with this order.
898
- # Retrieve EDI documents associated with this order.
899
- # @param order_id The order id to retrieve EDI documents for.
900
- # @param [Hash] opts the optional parameters
901
- # @return [OrderEdiDocumentsResponse]
902
- def get_order_edi_documents(order_id, opts = {})
903
- data, _status_code, _headers = get_order_edi_documents_with_http_info(order_id, opts)
904
- data
905
- end
906
-
907
- # Retrieve EDI documents associated with this order.
908
- # Retrieve EDI documents associated with this order.
909
- # @param order_id The order id to retrieve EDI documents for.
910
- # @param [Hash] opts the optional parameters
911
- # @return [Array<(OrderEdiDocumentsResponse, Fixnum, Hash)>] OrderEdiDocumentsResponse data, response status code and response headers
912
- def get_order_edi_documents_with_http_info(order_id, opts = {})
913
- if @api_client.config.debugging
914
- @api_client.config.logger.debug 'Calling API: OrderApi.get_order_edi_documents ...'
915
- end
916
- # verify the required parameter 'order_id' is set
917
- if @api_client.config.client_side_validation && order_id.nil?
918
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.get_order_edi_documents"
919
- end
920
- # resource path
921
- local_var_path = '/order/orders/{order_id}/edi'.sub('{' + 'order_id' + '}', order_id.to_s)
922
-
923
- # query parameters
924
- query_params = {}
925
-
926
- # header parameters
927
- header_params = {}
928
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
929
- # HTTP header 'Accept' (if needed)
930
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
931
- # HTTP header 'Content-Type'
932
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
933
-
934
- # form parameters
935
- form_params = {}
936
-
937
- # http body (model)
938
- post_body = nil
939
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
940
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
941
- :header_params => header_params,
942
- :query_params => query_params,
943
- :form_params => form_params,
944
- :body => post_body,
945
- :auth_names => auth_names,
946
- :return_type => 'OrderEdiDocumentsResponse')
947
- if @api_client.config.debugging
948
- @api_client.config.logger.debug "API called: OrderApi#get_order_edi_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
949
- end
950
- return data, status_code, headers
951
- end
952
- # Retrieve orders
953
- # 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.
954
- # @param [Hash] opts the optional parameters
955
- # @option opts [String] :order_id Order Id
956
- # @option opts [String] :payment_method Payment Method
957
- # @option opts [String] :company Company
958
- # @option opts [String] :first_name First Name
959
- # @option opts [String] :last_name Last Name
960
- # @option opts [String] :city City
961
- # @option opts [String] :state_region State/Region
962
- # @option opts [String] :postal_code Postal Code
963
- # @option opts [String] :country_code Country Code (ISO-3166 two letter)
964
- # @option opts [String] :phone Phone
965
- # @option opts [String] :email Email
966
- # @option opts [String] :cc_email CC Email
967
- # @option opts [Float] :total Total
968
- # @option opts [String] :screen_branding_theme_code Screen Branding Theme Code
969
- # @option opts [String] :storefront_host_name StoreFront Host Name
970
- # @option opts [String] :creation_date_begin Creation Date Begin
971
- # @option opts [String] :creation_date_end Creation Date End
972
- # @option opts [String] :payment_date_begin Payment Date Begin
973
- # @option opts [String] :payment_date_end Payment Date End
974
- # @option opts [String] :shipment_date_begin Shipment Date Begin
975
- # @option opts [String] :shipment_date_end Shipment Date End
976
- # @option opts [String] :rma RMA
977
- # @option opts [String] :purchase_order_number Purchase Order Number
978
- # @option opts [String] :item_id Item Id
979
- # @option opts [String] :current_stage Current Stage
980
- # @option opts [String] :channel_partner_code Channel Partner Code
981
- # @option opts [String] :channel_partner_order_id Channel Partner Order ID
982
- # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200) (default to 100)
983
- # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
984
- # @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.
985
- # @option opts [String] :_expand The object expansion to perform on the result.
986
- # @return [OrdersResponse]
987
- def get_orders(opts = {})
988
- data, _status_code, _headers = get_orders_with_http_info(opts)
989
- data
990
- end
991
-
992
- # Retrieve orders
993
- # 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.
994
- # @param [Hash] opts the optional parameters
995
- # @option opts [String] :order_id Order Id
996
- # @option opts [String] :payment_method Payment Method
997
- # @option opts [String] :company Company
998
- # @option opts [String] :first_name First Name
999
- # @option opts [String] :last_name Last Name
1000
- # @option opts [String] :city City
1001
- # @option opts [String] :state_region State/Region
1002
- # @option opts [String] :postal_code Postal Code
1003
- # @option opts [String] :country_code Country Code (ISO-3166 two letter)
1004
- # @option opts [String] :phone Phone
1005
- # @option opts [String] :email Email
1006
- # @option opts [String] :cc_email CC Email
1007
- # @option opts [Float] :total Total
1008
- # @option opts [String] :screen_branding_theme_code Screen Branding Theme Code
1009
- # @option opts [String] :storefront_host_name StoreFront Host Name
1010
- # @option opts [String] :creation_date_begin Creation Date Begin
1011
- # @option opts [String] :creation_date_end Creation Date End
1012
- # @option opts [String] :payment_date_begin Payment Date Begin
1013
- # @option opts [String] :payment_date_end Payment Date End
1014
- # @option opts [String] :shipment_date_begin Shipment Date Begin
1015
- # @option opts [String] :shipment_date_end Shipment Date End
1016
- # @option opts [String] :rma RMA
1017
- # @option opts [String] :purchase_order_number Purchase Order Number
1018
- # @option opts [String] :item_id Item Id
1019
- # @option opts [String] :current_stage Current Stage
1020
- # @option opts [String] :channel_partner_code Channel Partner Code
1021
- # @option opts [String] :channel_partner_order_id Channel Partner Order ID
1022
- # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200)
1023
- # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index.
1024
- # @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.
1025
- # @option opts [String] :_expand The object expansion to perform on the result.
1026
- # @return [Array<(OrdersResponse, Fixnum, Hash)>] OrdersResponse data, response status code and response headers
1027
- def get_orders_with_http_info(opts = {})
1028
- if @api_client.config.debugging
1029
- @api_client.config.logger.debug 'Calling API: OrderApi.get_orders ...'
1030
- end
1031
- # resource path
1032
- local_var_path = '/order/orders'
1033
-
1034
- # query parameters
1035
- query_params = {}
1036
- query_params[:'order_id'] = opts[:'order_id'] if !opts[:'order_id'].nil?
1037
- query_params[:'payment_method'] = opts[:'payment_method'] if !opts[:'payment_method'].nil?
1038
- query_params[:'company'] = opts[:'company'] if !opts[:'company'].nil?
1039
- query_params[:'first_name'] = opts[:'first_name'] if !opts[:'first_name'].nil?
1040
- query_params[:'last_name'] = opts[:'last_name'] if !opts[:'last_name'].nil?
1041
- query_params[:'city'] = opts[:'city'] if !opts[:'city'].nil?
1042
- query_params[:'state_region'] = opts[:'state_region'] if !opts[:'state_region'].nil?
1043
- query_params[:'postal_code'] = opts[:'postal_code'] if !opts[:'postal_code'].nil?
1044
- query_params[:'country_code'] = opts[:'country_code'] if !opts[:'country_code'].nil?
1045
- query_params[:'phone'] = opts[:'phone'] if !opts[:'phone'].nil?
1046
- query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
1047
- query_params[:'cc_email'] = opts[:'cc_email'] if !opts[:'cc_email'].nil?
1048
- query_params[:'total'] = opts[:'total'] if !opts[:'total'].nil?
1049
- query_params[:'screen_branding_theme_code'] = opts[:'screen_branding_theme_code'] if !opts[:'screen_branding_theme_code'].nil?
1050
- query_params[:'storefront_host_name'] = opts[:'storefront_host_name'] if !opts[:'storefront_host_name'].nil?
1051
- query_params[:'creation_date_begin'] = opts[:'creation_date_begin'] if !opts[:'creation_date_begin'].nil?
1052
- query_params[:'creation_date_end'] = opts[:'creation_date_end'] if !opts[:'creation_date_end'].nil?
1053
- query_params[:'payment_date_begin'] = opts[:'payment_date_begin'] if !opts[:'payment_date_begin'].nil?
1054
- query_params[:'payment_date_end'] = opts[:'payment_date_end'] if !opts[:'payment_date_end'].nil?
1055
- query_params[:'shipment_date_begin'] = opts[:'shipment_date_begin'] if !opts[:'shipment_date_begin'].nil?
1056
- query_params[:'shipment_date_end'] = opts[:'shipment_date_end'] if !opts[:'shipment_date_end'].nil?
1057
- query_params[:'rma'] = opts[:'rma'] if !opts[:'rma'].nil?
1058
- query_params[:'purchase_order_number'] = opts[:'purchase_order_number'] if !opts[:'purchase_order_number'].nil?
1059
- query_params[:'item_id'] = opts[:'item_id'] if !opts[:'item_id'].nil?
1060
- query_params[:'current_stage'] = opts[:'current_stage'] if !opts[:'current_stage'].nil?
1061
- query_params[:'channel_partner_code'] = opts[:'channel_partner_code'] if !opts[:'channel_partner_code'].nil?
1062
- query_params[:'channel_partner_order_id'] = opts[:'channel_partner_order_id'] if !opts[:'channel_partner_order_id'].nil?
1063
- query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
1064
- query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
1065
- query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
1066
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1067
-
1068
- # header parameters
1069
- header_params = {}
1070
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1071
- # HTTP header 'Accept' (if needed)
1072
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1073
- # HTTP header 'Content-Type'
1074
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1075
-
1076
- # form parameters
1077
- form_params = {}
1078
-
1079
- # http body (model)
1080
- post_body = nil
1081
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1082
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1083
- :header_params => header_params,
1084
- :query_params => query_params,
1085
- :form_params => form_params,
1086
- :body => post_body,
1087
- :auth_names => auth_names,
1088
- :return_type => 'OrdersResponse')
1089
- if @api_client.config.debugging
1090
- @api_client.config.logger.debug "API called: OrderApi#get_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1091
- end
1092
- return data, status_code, headers
1093
- end
1094
- # Retrieve order batch
1095
- # 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.
1096
- # @param order_batch Order batch
1097
- # @param [Hash] opts the optional parameters
1098
- # @option opts [String] :_expand The object expansion to perform on the result.
1099
- # @return [OrdersResponse]
1100
- def get_orders_batch(order_batch, opts = {})
1101
- data, _status_code, _headers = get_orders_batch_with_http_info(order_batch, opts)
1102
- data
1103
- end
1104
-
1105
- # Retrieve order batch
1106
- # 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.
1107
- # @param order_batch Order batch
1108
- # @param [Hash] opts the optional parameters
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_batch_with_http_info(order_batch, opts = {})
1112
- if @api_client.config.debugging
1113
- @api_client.config.logger.debug 'Calling API: OrderApi.get_orders_batch ...'
1114
- end
1115
- # verify the required parameter 'order_batch' is set
1116
- if @api_client.config.client_side_validation && order_batch.nil?
1117
- fail ArgumentError, "Missing the required parameter 'order_batch' when calling OrderApi.get_orders_batch"
1118
- end
1119
- # resource path
1120
- local_var_path = '/order/orders/batch'
1121
-
1122
- # query parameters
1123
- query_params = {}
1124
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1125
-
1126
- # header parameters
1127
- header_params = {}
1128
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1129
- # HTTP header 'Accept' (if needed)
1130
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1131
- # HTTP header 'Content-Type'
1132
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1133
-
1134
- # form parameters
1135
- form_params = {}
1136
-
1137
- # http body (model)
1138
- post_body = @api_client.object_to_http_body(order_batch)
1139
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1140
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1141
- :header_params => header_params,
1142
- :query_params => query_params,
1143
- :form_params => form_params,
1144
- :body => post_body,
1145
- :auth_names => auth_names,
1146
- :return_type => 'OrdersResponse')
1147
- if @api_client.config.debugging
1148
- @api_client.config.logger.debug "API called: OrderApi#get_orders_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1149
- end
1150
- return data, status_code, headers
1151
- end
1152
- # Retrieve orders by query
1153
- # 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.
1154
- # @param order_query Order query
1155
- # @param [Hash] opts the optional parameters
1156
- # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200) (default to 100)
1157
- # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
1158
- # @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.
1159
- # @option opts [String] :_expand The object expansion to perform on the result.
1160
- # @return [OrdersResponse]
1161
- def get_orders_by_query(order_query, opts = {})
1162
- data, _status_code, _headers = get_orders_by_query_with_http_info(order_query, opts)
1163
- data
1164
- end
1165
-
1166
- # Retrieve orders by query
1167
- # 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.
1168
- # @param order_query Order query
1169
- # @param [Hash] opts the optional parameters
1170
- # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200)
1171
- # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index.
1172
- # @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.
1173
- # @option opts [String] :_expand The object expansion to perform on the result.
1174
- # @return [Array<(OrdersResponse, Fixnum, Hash)>] OrdersResponse data, response status code and response headers
1175
- def get_orders_by_query_with_http_info(order_query, opts = {})
1176
- if @api_client.config.debugging
1177
- @api_client.config.logger.debug 'Calling API: OrderApi.get_orders_by_query ...'
1178
- end
1179
- # verify the required parameter 'order_query' is set
1180
- if @api_client.config.client_side_validation && order_query.nil?
1181
- fail ArgumentError, "Missing the required parameter 'order_query' when calling OrderApi.get_orders_by_query"
1182
- end
1183
- # resource path
1184
- local_var_path = '/order/orders/query'
1185
-
1186
- # query parameters
1187
- query_params = {}
1188
- query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
1189
- query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
1190
- query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
1191
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1192
-
1193
- # header parameters
1194
- header_params = {}
1195
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1196
- # HTTP header 'Accept' (if needed)
1197
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1198
- # HTTP header 'Content-Type'
1199
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1200
-
1201
- # form parameters
1202
- form_params = {}
1203
-
1204
- # http body (model)
1205
- post_body = @api_client.object_to_http_body(order_query)
1206
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1207
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1208
- :header_params => header_params,
1209
- :query_params => query_params,
1210
- :form_params => form_params,
1211
- :body => post_body,
1212
- :auth_names => auth_names,
1213
- :return_type => 'OrdersResponse')
1214
- if @api_client.config.debugging
1215
- @api_client.config.logger.debug "API called: OrderApi#get_orders_by_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1216
- end
1217
- return data, status_code, headers
1218
- end
1219
- # Insert an order
1220
- # 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.
1221
- # @param order Order to insert
1222
- # @param [Hash] opts the optional parameters
1223
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1224
- # @return [OrderResponse]
1225
- def insert_order(order, opts = {})
1226
- data, _status_code, _headers = insert_order_with_http_info(order, opts)
1227
- data
1228
- end
1229
-
1230
- # Insert an order
1231
- # 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.
1232
- # @param order Order to insert
1233
- # @param [Hash] opts the optional parameters
1234
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1235
- # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
1236
- def insert_order_with_http_info(order, opts = {})
1237
- if @api_client.config.debugging
1238
- @api_client.config.logger.debug 'Calling API: OrderApi.insert_order ...'
1239
- end
1240
- # verify the required parameter 'order' is set
1241
- if @api_client.config.client_side_validation && order.nil?
1242
- fail ArgumentError, "Missing the required parameter 'order' when calling OrderApi.insert_order"
1243
- end
1244
- # resource path
1245
- local_var_path = '/order/orders'
1246
-
1247
- # query parameters
1248
- query_params = {}
1249
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1250
-
1251
- # header parameters
1252
- header_params = {}
1253
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1254
- # HTTP header 'Accept' (if needed)
1255
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1256
- # HTTP header 'Content-Type'
1257
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1258
-
1259
- # form parameters
1260
- form_params = {}
1261
-
1262
- # http body (model)
1263
- post_body = @api_client.object_to_http_body(order)
1264
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1265
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1266
- :header_params => header_params,
1267
- :query_params => query_params,
1268
- :form_params => form_params,
1269
- :body => post_body,
1270
- :auth_names => auth_names,
1271
- :return_type => 'OrderResponse')
1272
- if @api_client.config.debugging
1273
- @api_client.config.logger.debug "API called: OrderApi#insert_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1274
- end
1275
- return data, status_code, headers
1276
- end
1277
- # Determine if an order can be refunded
1278
- # Determine if an order can be refunded based upon payment method and age
1279
- # @param order_id The order id to check for refundable order.
1280
- # @param [Hash] opts the optional parameters
1281
- # @return [OrderRefundableResponse]
1282
- def is_refundable_order(order_id, opts = {})
1283
- data, _status_code, _headers = is_refundable_order_with_http_info(order_id, opts)
1284
- data
1285
- end
1286
-
1287
- # Determine if an order can be refunded
1288
- # Determine if an order can be refunded based upon payment method and age
1289
- # @param order_id The order id to check for refundable order.
1290
- # @param [Hash] opts the optional parameters
1291
- # @return [Array<(OrderRefundableResponse, Fixnum, Hash)>] OrderRefundableResponse data, response status code and response headers
1292
- def is_refundable_order_with_http_info(order_id, opts = {})
1293
- if @api_client.config.debugging
1294
- @api_client.config.logger.debug 'Calling API: OrderApi.is_refundable_order ...'
1295
- end
1296
- # verify the required parameter 'order_id' is set
1297
- if @api_client.config.client_side_validation && order_id.nil?
1298
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.is_refundable_order"
1299
- end
1300
- # resource path
1301
- local_var_path = '/order/orders/{order_id}/refundable'.sub('{' + 'order_id' + '}', order_id.to_s)
1302
-
1303
- # query parameters
1304
- query_params = {}
1305
-
1306
- # header parameters
1307
- header_params = {}
1308
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1309
- # HTTP header 'Accept' (if needed)
1310
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1311
- # HTTP header 'Content-Type'
1312
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1313
-
1314
- # form parameters
1315
- form_params = {}
1316
-
1317
- # http body (model)
1318
- post_body = nil
1319
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1320
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1321
- :header_params => header_params,
1322
- :query_params => query_params,
1323
- :form_params => form_params,
1324
- :body => post_body,
1325
- :auth_names => auth_names,
1326
- :return_type => 'OrderRefundableResponse')
1327
- if @api_client.config.debugging
1328
- @api_client.config.logger.debug "API called: OrderApi#is_refundable_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1329
- end
1330
- return data, status_code, headers
1331
- end
1332
- # Process payment
1333
- # Process payment on order
1334
- # @param order_id The order id to process payment on
1335
- # @param process_payment_request Process payment parameters
1336
- # @param [Hash] opts the optional parameters
1337
- # @return [OrderProcessPaymentResponse]
1338
- def process_payment(order_id, process_payment_request, opts = {})
1339
- data, _status_code, _headers = process_payment_with_http_info(order_id, process_payment_request, opts)
1340
- data
1341
- end
1342
-
1343
- # Process payment
1344
- # Process payment on order
1345
- # @param order_id The order id to process payment on
1346
- # @param process_payment_request Process payment parameters
1347
- # @param [Hash] opts the optional parameters
1348
- # @return [Array<(OrderProcessPaymentResponse, Fixnum, Hash)>] OrderProcessPaymentResponse data, response status code and response headers
1349
- def process_payment_with_http_info(order_id, process_payment_request, opts = {})
1350
- if @api_client.config.debugging
1351
- @api_client.config.logger.debug 'Calling API: OrderApi.process_payment ...'
1352
- end
1353
- # verify the required parameter 'order_id' is set
1354
- if @api_client.config.client_side_validation && order_id.nil?
1355
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.process_payment"
1356
- end
1357
- # verify the required parameter 'process_payment_request' is set
1358
- if @api_client.config.client_side_validation && process_payment_request.nil?
1359
- fail ArgumentError, "Missing the required parameter 'process_payment_request' when calling OrderApi.process_payment"
1360
- end
1361
- # resource path
1362
- local_var_path = '/order/orders/{order_id}/process_payment'.sub('{' + 'order_id' + '}', order_id.to_s)
1363
-
1364
- # query parameters
1365
- query_params = {}
1366
-
1367
- # header parameters
1368
- header_params = {}
1369
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1370
- # HTTP header 'Accept' (if needed)
1371
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1372
- # HTTP header 'Content-Type'
1373
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1374
-
1375
- # form parameters
1376
- form_params = {}
1377
-
1378
- # http body (model)
1379
- post_body = @api_client.object_to_http_body(process_payment_request)
1380
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1381
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1382
- :header_params => header_params,
1383
- :query_params => query_params,
1384
- :form_params => form_params,
1385
- :body => post_body,
1386
- :auth_names => auth_names,
1387
- :return_type => 'OrderProcessPaymentResponse')
1388
- if @api_client.config.debugging
1389
- @api_client.config.logger.debug "API called: OrderApi#process_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1390
- end
1391
- return data, status_code, headers
1392
- end
1393
- # Refund an order
1394
- # 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.
1395
- # @param order Order to refund
1396
- # @param order_id The order id to refund.
1397
- # @param [Hash] opts the optional parameters
1398
- # @option opts [BOOLEAN] :reject_after_refund Reject order after refund (default to false)
1399
- # @option opts [BOOLEAN] :skip_customer_notification Skip customer email notification (default to false)
1400
- # @option opts [BOOLEAN] :auto_order_cancel Cancel associated auto orders (default to false)
1401
- # @option opts [BOOLEAN] :manual_refund Consider a manual refund done externally (default to false)
1402
- # @option opts [BOOLEAN] :reverse_affiliate_transactions Reverse affiliate transactions (default to true)
1403
- # @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)
1404
- # @option opts [String] :auto_order_cancel_reason Reason for auto orders cancellation
1405
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1406
- # @return [OrderResponse]
1407
- def refund_order(order, order_id, opts = {})
1408
- data, _status_code, _headers = refund_order_with_http_info(order, order_id, opts)
1409
- data
1410
- end
1411
-
1412
- # Refund an order
1413
- # 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.
1414
- # @param order Order to refund
1415
- # @param order_id The order id to refund.
1416
- # @param [Hash] opts the optional parameters
1417
- # @option opts [BOOLEAN] :reject_after_refund Reject order after refund
1418
- # @option opts [BOOLEAN] :skip_customer_notification Skip customer email notification
1419
- # @option opts [BOOLEAN] :auto_order_cancel Cancel associated auto orders
1420
- # @option opts [BOOLEAN] :manual_refund Consider a manual refund done externally
1421
- # @option opts [BOOLEAN] :reverse_affiliate_transactions Reverse affiliate transactions
1422
- # @option opts [BOOLEAN] :issue_store_credit Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
1423
- # @option opts [String] :auto_order_cancel_reason Reason for auto orders cancellation
1424
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1425
- # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
1426
- def refund_order_with_http_info(order, order_id, opts = {})
1427
- if @api_client.config.debugging
1428
- @api_client.config.logger.debug 'Calling API: OrderApi.refund_order ...'
1429
- end
1430
- # verify the required parameter 'order' is set
1431
- if @api_client.config.client_side_validation && order.nil?
1432
- fail ArgumentError, "Missing the required parameter 'order' when calling OrderApi.refund_order"
1433
- end
1434
- # verify the required parameter 'order_id' is set
1435
- if @api_client.config.client_side_validation && order_id.nil?
1436
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.refund_order"
1437
- end
1438
- # resource path
1439
- local_var_path = '/order/orders/{order_id}/refund'.sub('{' + 'order_id' + '}', order_id.to_s)
1440
-
1441
- # query parameters
1442
- query_params = {}
1443
- query_params[:'reject_after_refund'] = opts[:'reject_after_refund'] if !opts[:'reject_after_refund'].nil?
1444
- query_params[:'skip_customer_notification'] = opts[:'skip_customer_notification'] if !opts[:'skip_customer_notification'].nil?
1445
- query_params[:'auto_order_cancel'] = opts[:'auto_order_cancel'] if !opts[:'auto_order_cancel'].nil?
1446
- query_params[:'manual_refund'] = opts[:'manual_refund'] if !opts[:'manual_refund'].nil?
1447
- query_params[:'reverse_affiliate_transactions'] = opts[:'reverse_affiliate_transactions'] if !opts[:'reverse_affiliate_transactions'].nil?
1448
- query_params[:'issue_store_credit'] = opts[:'issue_store_credit'] if !opts[:'issue_store_credit'].nil?
1449
- query_params[:'auto_order_cancel_reason'] = opts[:'auto_order_cancel_reason'] if !opts[:'auto_order_cancel_reason'].nil?
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(order)
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#refund_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1475
- end
1476
- return data, status_code, headers
1477
- end
1478
- # Replaces an order item id
1479
- # 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.
1480
- # @param replace_order_item_id_request Replacement Request
1481
- # @param order_id The order id to update.
1482
- # @param [Hash] opts the optional parameters
1483
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1484
- # @return [OrderResponse]
1485
- def replace_order_item_merchant_item_id(replace_order_item_id_request, order_id, opts = {})
1486
- data, _status_code, _headers = replace_order_item_merchant_item_id_with_http_info(replace_order_item_id_request, order_id, opts)
1487
- data
1488
- end
1489
-
1490
- # Replaces an order item id
1491
- # 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.
1492
- # @param replace_order_item_id_request Replacement Request
1493
- # @param order_id The order id to update.
1494
- # @param [Hash] opts the optional parameters
1495
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1496
- # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
1497
- def replace_order_item_merchant_item_id_with_http_info(replace_order_item_id_request, order_id, opts = {})
1498
- if @api_client.config.debugging
1499
- @api_client.config.logger.debug 'Calling API: OrderApi.replace_order_item_merchant_item_id ...'
1500
- end
1501
- # verify the required parameter 'replace_order_item_id_request' is set
1502
- if @api_client.config.client_side_validation && replace_order_item_id_request.nil?
1503
- fail ArgumentError, "Missing the required parameter 'replace_order_item_id_request' when calling OrderApi.replace_order_item_merchant_item_id"
1504
- end
1505
- # verify the required parameter 'order_id' is set
1506
- if @api_client.config.client_side_validation && order_id.nil?
1507
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.replace_order_item_merchant_item_id"
1508
- end
1509
- # resource path
1510
- local_var_path = '/order/orders/{order_id}/replace_item_id'.sub('{' + 'order_id' + '}', order_id.to_s)
1511
-
1512
- # query parameters
1513
- query_params = {}
1514
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1515
-
1516
- # header parameters
1517
- header_params = {}
1518
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1519
- # HTTP header 'Accept' (if needed)
1520
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1521
- # HTTP header 'Content-Type'
1522
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1523
-
1524
- # form parameters
1525
- form_params = {}
1526
-
1527
- # http body (model)
1528
- post_body = @api_client.object_to_http_body(replace_order_item_id_request)
1529
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1530
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1531
- :header_params => header_params,
1532
- :query_params => query_params,
1533
- :form_params => form_params,
1534
- :body => post_body,
1535
- :auth_names => auth_names,
1536
- :return_type => 'OrderResponse')
1537
- if @api_client.config.debugging
1538
- @api_client.config.logger.debug "API called: OrderApi#replace_order_item_merchant_item_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1539
- end
1540
- return data, status_code, headers
1541
- end
1542
- # Replacement order
1543
- # Create a replacement order based upon a previous order
1544
- # @param order_id The order id to generate a replacement for.
1545
- # @param replacement Replacement order details
1546
- # @param [Hash] opts the optional parameters
1547
- # @return [OrderReplacementResponse]
1548
- def replacement(order_id, replacement, opts = {})
1549
- data, _status_code, _headers = replacement_with_http_info(order_id, replacement, opts)
1550
- data
1551
- end
1552
-
1553
- # Replacement order
1554
- # Create a replacement order based upon a previous order
1555
- # @param order_id The order id to generate a replacement for.
1556
- # @param replacement Replacement order details
1557
- # @param [Hash] opts the optional parameters
1558
- # @return [Array<(OrderReplacementResponse, Fixnum, Hash)>] OrderReplacementResponse data, response status code and response headers
1559
- def replacement_with_http_info(order_id, replacement, opts = {})
1560
- if @api_client.config.debugging
1561
- @api_client.config.logger.debug 'Calling API: OrderApi.replacement ...'
1562
- end
1563
- # verify the required parameter 'order_id' is set
1564
- if @api_client.config.client_side_validation && order_id.nil?
1565
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.replacement"
1566
- end
1567
- # verify the required parameter 'replacement' is set
1568
- if @api_client.config.client_side_validation && replacement.nil?
1569
- fail ArgumentError, "Missing the required parameter 'replacement' when calling OrderApi.replacement"
1570
- end
1571
- # resource path
1572
- local_var_path = '/order/orders/{order_id}/replacement'.sub('{' + 'order_id' + '}', order_id.to_s)
1573
-
1574
- # query parameters
1575
- query_params = {}
1576
-
1577
- # header parameters
1578
- header_params = {}
1579
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1580
- # HTTP header 'Accept' (if needed)
1581
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1582
- # HTTP header 'Content-Type'
1583
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1584
-
1585
- # form parameters
1586
- form_params = {}
1587
-
1588
- # http body (model)
1589
- post_body = @api_client.object_to_http_body(replacement)
1590
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1591
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1592
- :header_params => header_params,
1593
- :query_params => query_params,
1594
- :form_params => form_params,
1595
- :body => post_body,
1596
- :auth_names => auth_names,
1597
- :return_type => 'OrderReplacementResponse')
1598
- if @api_client.config.debugging
1599
- @api_client.config.logger.debug "API called: OrderApi#replacement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1600
- end
1601
- return data, status_code, headers
1602
- end
1603
- # Resend receipt
1604
- # Resend the receipt for an order on the UltraCart account.
1605
- # @param order_id The order id to resend the receipt for.
1606
- # @param [Hash] opts the optional parameters
1607
- # @return [BaseResponse]
1608
- def resend_receipt(order_id, opts = {})
1609
- data, _status_code, _headers = resend_receipt_with_http_info(order_id, opts)
1610
- data
1611
- end
1612
-
1613
- # Resend receipt
1614
- # Resend the receipt for an order on the UltraCart account.
1615
- # @param order_id The order id to resend the receipt for.
1616
- # @param [Hash] opts the optional parameters
1617
- # @return [Array<(BaseResponse, Fixnum, Hash)>] BaseResponse data, response status code and response headers
1618
- def resend_receipt_with_http_info(order_id, opts = {})
1619
- if @api_client.config.debugging
1620
- @api_client.config.logger.debug 'Calling API: OrderApi.resend_receipt ...'
1621
- end
1622
- # verify the required parameter 'order_id' is set
1623
- if @api_client.config.client_side_validation && order_id.nil?
1624
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.resend_receipt"
1625
- end
1626
- # resource path
1627
- local_var_path = '/order/orders/{order_id}/resend_receipt'.sub('{' + 'order_id' + '}', order_id.to_s)
1628
-
1629
- # query parameters
1630
- query_params = {}
1631
-
1632
- # header parameters
1633
- header_params = {}
1634
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1635
- # HTTP header 'Accept' (if needed)
1636
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1637
- # HTTP header 'Content-Type'
1638
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1639
-
1640
- # form parameters
1641
- form_params = {}
1642
-
1643
- # http body (model)
1644
- post_body = nil
1645
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1646
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1647
- :header_params => header_params,
1648
- :query_params => query_params,
1649
- :form_params => form_params,
1650
- :body => post_body,
1651
- :auth_names => auth_names,
1652
- :return_type => 'BaseResponse')
1653
- if @api_client.config.debugging
1654
- @api_client.config.logger.debug "API called: OrderApi#resend_receipt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1655
- end
1656
- return data, status_code, headers
1657
- end
1658
- # Resend shipment confirmation
1659
- # Resend shipment confirmation for an order on the UltraCart account.
1660
- # @param order_id The order id to resend the shipment notification for.
1661
- # @param [Hash] opts the optional parameters
1662
- # @return [BaseResponse]
1663
- def resend_shipment_confirmation(order_id, opts = {})
1664
- data, _status_code, _headers = resend_shipment_confirmation_with_http_info(order_id, opts)
1665
- data
1666
- end
1667
-
1668
- # Resend shipment confirmation
1669
- # Resend shipment confirmation for an order on the UltraCart account.
1670
- # @param order_id The order id to resend the shipment notification for.
1671
- # @param [Hash] opts the optional parameters
1672
- # @return [Array<(BaseResponse, Fixnum, Hash)>] BaseResponse data, response status code and response headers
1673
- def resend_shipment_confirmation_with_http_info(order_id, opts = {})
1674
- if @api_client.config.debugging
1675
- @api_client.config.logger.debug 'Calling API: OrderApi.resend_shipment_confirmation ...'
1676
- end
1677
- # verify the required parameter 'order_id' is set
1678
- if @api_client.config.client_side_validation && order_id.nil?
1679
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.resend_shipment_confirmation"
1680
- end
1681
- # resource path
1682
- local_var_path = '/order/orders/{order_id}/resend_shipment_confirmation'.sub('{' + 'order_id' + '}', order_id.to_s)
1683
-
1684
- # query parameters
1685
- query_params = {}
1686
-
1687
- # header parameters
1688
- header_params = {}
1689
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1690
- # HTTP header 'Accept' (if needed)
1691
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1692
- # HTTP header 'Content-Type'
1693
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1694
-
1695
- # form parameters
1696
- form_params = {}
1697
-
1698
- # http body (model)
1699
- post_body = nil
1700
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1701
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1702
- :header_params => header_params,
1703
- :query_params => query_params,
1704
- :form_params => form_params,
1705
- :body => post_body,
1706
- :auth_names => auth_names,
1707
- :return_type => 'BaseResponse')
1708
- if @api_client.config.debugging
1709
- @api_client.config.logger.debug "API called: OrderApi#resend_shipment_confirmation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1710
- end
1711
- return data, status_code, headers
1712
- end
1713
- # Remove a refund block on an order
1714
- # Removes a refund block on an order to prevent a user from performing a refund.
1715
- # @param order_id The order id to unblock a refund on.
1716
- # @param [Hash] opts the optional parameters
1717
- # @return [nil]
1718
- def unblock_refund_on_order(order_id, opts = {})
1719
- unblock_refund_on_order_with_http_info(order_id, opts)
1720
- nil
1721
- end
1722
-
1723
- # Remove a refund block on an order
1724
- # Removes a refund block on an order to prevent a user from performing a refund.
1725
- # @param order_id The order id to unblock a refund on.
1726
- # @param [Hash] opts the optional parameters
1727
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1728
- def unblock_refund_on_order_with_http_info(order_id, opts = {})
1729
- if @api_client.config.debugging
1730
- @api_client.config.logger.debug 'Calling API: OrderApi.unblock_refund_on_order ...'
1731
- end
1732
- # verify the required parameter 'order_id' is set
1733
- if @api_client.config.client_side_validation && order_id.nil?
1734
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.unblock_refund_on_order"
1735
- end
1736
- # resource path
1737
- local_var_path = '/order/orders/{order_id}/refund_unblock'.sub('{' + 'order_id' + '}', order_id.to_s)
1738
-
1739
- # query parameters
1740
- query_params = {}
1741
-
1742
- # header parameters
1743
- header_params = {}
1744
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1745
- # HTTP header 'Accept' (if needed)
1746
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1747
- # HTTP header 'Content-Type'
1748
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1749
-
1750
- # form parameters
1751
- form_params = {}
1752
-
1753
- # http body (model)
1754
- post_body = nil
1755
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1756
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1757
- :header_params => header_params,
1758
- :query_params => query_params,
1759
- :form_params => form_params,
1760
- :body => post_body,
1761
- :auth_names => auth_names)
1762
- if @api_client.config.debugging
1763
- @api_client.config.logger.debug "API called: OrderApi#unblock_refund_on_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1764
- end
1765
- return data, status_code, headers
1766
- end
1767
- # Update A/R Retry Configuration
1768
- # Update A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.
1769
- # @param retry_config AccountsReceivableRetryConfig object
1770
- # @param [Hash] opts the optional parameters
1771
- # @return [BaseResponse]
1772
- def update_accounts_receivable_retry_config(retry_config, opts = {})
1773
- data, _status_code, _headers = update_accounts_receivable_retry_config_with_http_info(retry_config, opts)
1774
- data
1775
- end
1776
-
1777
- # Update A/R Retry Configuration
1778
- # Update A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.
1779
- # @param retry_config AccountsReceivableRetryConfig object
1780
- # @param [Hash] opts the optional parameters
1781
- # @return [Array<(BaseResponse, Fixnum, Hash)>] BaseResponse data, response status code and response headers
1782
- def update_accounts_receivable_retry_config_with_http_info(retry_config, opts = {})
1783
- if @api_client.config.debugging
1784
- @api_client.config.logger.debug 'Calling API: OrderApi.update_accounts_receivable_retry_config ...'
1785
- end
1786
- # verify the required parameter 'retry_config' is set
1787
- if @api_client.config.client_side_validation && retry_config.nil?
1788
- fail ArgumentError, "Missing the required parameter 'retry_config' when calling OrderApi.update_accounts_receivable_retry_config"
1789
- end
1790
- # resource path
1791
- local_var_path = '/order/accountsReceivableRetryConfig'
1792
-
1793
- # query parameters
1794
- query_params = {}
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'])
1803
-
1804
- # form parameters
1805
- form_params = {}
1806
-
1807
- # http body (model)
1808
- post_body = @api_client.object_to_http_body(retry_config)
1809
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1810
- data, status_code, headers = @api_client.call_api(:POST, 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 => 'BaseResponse')
1817
- if @api_client.config.debugging
1818
- @api_client.config.logger.debug "API called: OrderApi#update_accounts_receivable_retry_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1819
- end
1820
- return data, status_code, headers
1821
- end
1822
- # Update an order
1823
- # 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.
1824
- # @param order Order to update
1825
- # @param order_id The order id to update.
1826
- # @param [Hash] opts the optional parameters
1827
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1828
- # @return [OrderResponse]
1829
- def update_order(order, order_id, opts = {})
1830
- data, _status_code, _headers = update_order_with_http_info(order, order_id, opts)
1831
- data
1832
- end
1833
-
1834
- # Update an order
1835
- # 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.
1836
- # @param order Order to update
1837
- # @param order_id The order id to update.
1838
- # @param [Hash] opts the optional parameters
1839
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1840
- # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
1841
- def update_order_with_http_info(order, order_id, opts = {})
1842
- if @api_client.config.debugging
1843
- @api_client.config.logger.debug 'Calling API: OrderApi.update_order ...'
1844
- end
1845
- # verify the required parameter 'order' is set
1846
- if @api_client.config.client_side_validation && order.nil?
1847
- fail ArgumentError, "Missing the required parameter 'order' when calling OrderApi.update_order"
1848
- end
1849
- # verify the required parameter 'order_id' is set
1850
- if @api_client.config.client_side_validation && order_id.nil?
1851
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.update_order"
1852
- end
1853
- # resource path
1854
- local_var_path = '/order/orders/{order_id}'.sub('{' + 'order_id' + '}', order_id.to_s)
1855
-
1856
- # query parameters
1857
- query_params = {}
1858
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1859
-
1860
- # header parameters
1861
- header_params = {}
1862
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1863
- # HTTP header 'Accept' (if needed)
1864
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1865
- # HTTP header 'Content-Type'
1866
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1867
-
1868
- # form parameters
1869
- form_params = {}
1870
-
1871
- # http body (model)
1872
- post_body = @api_client.object_to_http_body(order)
1873
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1874
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1875
- :header_params => header_params,
1876
- :query_params => query_params,
1877
- :form_params => form_params,
1878
- :body => post_body,
1879
- :auth_names => auth_names,
1880
- :return_type => 'OrderResponse')
1881
- if @api_client.config.debugging
1882
- @api_client.config.logger.debug "API called: OrderApi#update_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1883
- end
1884
- return data, status_code, headers
1885
- end
1886
- # Validate
1887
- # 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.
1888
- # @param validation_request Validation request
1889
- # @param [Hash] opts the optional parameters
1890
- # @return [OrderValidationResponse]
1891
- def validate_order(validation_request, opts = {})
1892
- data, _status_code, _headers = validate_order_with_http_info(validation_request, opts)
1893
- data
1894
- end
1895
-
1896
- # Validate
1897
- # 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.
1898
- # @param validation_request Validation request
1899
- # @param [Hash] opts the optional parameters
1900
- # @return [Array<(OrderValidationResponse, Fixnum, Hash)>] OrderValidationResponse data, response status code and response headers
1901
- def validate_order_with_http_info(validation_request, opts = {})
1902
- if @api_client.config.debugging
1903
- @api_client.config.logger.debug 'Calling API: OrderApi.validate_order ...'
1904
- end
1905
- # verify the required parameter 'validation_request' is set
1906
- if @api_client.config.client_side_validation && validation_request.nil?
1907
- fail ArgumentError, "Missing the required parameter 'validation_request' when calling OrderApi.validate_order"
1908
- end
1909
- # resource path
1910
- local_var_path = '/order/validate'
1911
-
1912
- # query parameters
1913
- query_params = {}
1914
-
1915
- # header parameters
1916
- header_params = {}
1917
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1918
- # HTTP header 'Accept' (if needed)
1919
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1920
- # HTTP header 'Content-Type'
1921
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1922
-
1923
- # form parameters
1924
- form_params = {}
1925
-
1926
- # http body (model)
1927
- post_body = @api_client.object_to_http_body(validation_request)
1928
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1929
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1930
- :header_params => header_params,
1931
- :query_params => query_params,
1932
- :form_params => form_params,
1933
- :body => post_body,
1934
- :auth_names => auth_names,
1935
- :return_type => 'OrderValidationResponse')
1936
- if @api_client.config.debugging
1937
- @api_client.config.logger.debug "API called: OrderApi#validate_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1938
- end
1939
- return data, status_code, headers
1940
- end
1941
- end
1942
- 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