ultracart_api 3.10.162 → 4.0.32.rc

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1619) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +9 -7
  3. data/README.md +1166 -1505
  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 -31
  28. data/docs/AutoOrderApi.md +693 -559
  29. data/docs/AutoOrderItem.md +64 -33
  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 -24
  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 -14
  72. data/docs/CartPaymentAffirm.md +18 -8
  73. data/docs/CartPaymentAmazon.md +18 -8
  74. data/docs/CartPaymentCheck.md +18 -8
  75. data/docs/CartPaymentCreditCard.md +34 -16
  76. data/docs/CartPaymentPurchaseOrder.md +18 -8
  77. data/docs/CartProfileLoginRequest.md +22 -10
  78. data/docs/CartProfileLoginResponse.md +20 -9
  79. data/docs/CartProfileRegisterRequest.md +20 -9
  80. data/docs/CartProfileRegisterResponse.md +20 -9
  81. data/docs/CartProperty.md +24 -11
  82. data/docs/CartResponse.md +20 -9
  83. data/docs/CartSettings.md +28 -13
  84. data/docs/CartSettingsBilling.md +18 -8
  85. data/docs/CartSettingsGift.md +24 -11
  86. data/docs/CartSettingsGiftWrap.md +22 -10
  87. data/docs/CartSettingsPayment.md +42 -20
  88. data/docs/CartSettingsPaymentAmazon.md +22 -10
  89. data/docs/CartSettingsPaymentCreditCard.md +22 -10
  90. data/docs/CartSettingsPaymentPayPal.md +26 -12
  91. data/docs/CartSettingsProvince.md +20 -9
  92. data/docs/CartSettingsShipping.md +26 -12
  93. data/docs/CartSettingsShippingCalendar.md +26 -12
  94. data/docs/CartSettingsShippingEstimate.md +44 -21
  95. data/docs/CartSettingsTaxes.md +18 -8
  96. data/docs/CartSettingsTerms.md +20 -9
  97. data/docs/CartShipping.md +54 -26
  98. data/docs/CartSummary.md +48 -23
  99. data/docs/CartTaxes.md +22 -10
  100. data/docs/CartUpsellAfter.md +22 -10
  101. data/docs/CartValidationRequest.md +20 -9
  102. data/docs/CartValidationResponse.md +20 -9
  103. data/docs/ChannelPartnerApi.md +382 -578
  104. data/docs/ChannelPartnerCancelResponse.md +26 -12
  105. data/docs/ChannelPartnerEstimateShippingResponse.md +26 -12
  106. data/docs/ChannelPartnerEstimateTaxResponse.md +26 -12
  107. data/docs/ChannelPartnerImportResponse.md +30 -14
  108. data/docs/ChannelPartnerOrder.md +176 -87
  109. data/docs/ChannelPartnerOrderItem.md +30 -14
  110. data/docs/ChannelPartnerOrderItemOption.md +20 -9
  111. data/docs/ChannelPartnerOrderTransaction.md +20 -9
  112. data/docs/ChannelPartnerOrderTransactionDetail.md +20 -9
  113. data/docs/ChannelPartnerShippingEstimate.md +20 -9
  114. data/docs/ChargebackApi.md +420 -301
  115. data/docs/ChargebackDispute.md +62 -30
  116. data/docs/ChargebackDisputeResponse.md +26 -12
  117. data/docs/ChargebackDisputesResponse.md +26 -12
  118. data/docs/CheckoutAllowedCountriesResponse.md +18 -8
  119. data/docs/CheckoutApi.md +1566 -1023
  120. data/docs/CheckoutHandoffRequest.md +32 -15
  121. data/docs/CheckoutHandoffResponse.md +22 -10
  122. data/docs/CheckoutSetupBrowserKeyRequest.md +18 -8
  123. data/docs/CheckoutSetupBrowserKeyResponse.md +18 -8
  124. data/docs/CheckoutStateProvinceResponse.md +18 -8
  125. data/docs/CityStateZip.md +26 -12
  126. data/docs/CountriesResponse.md +18 -8
  127. data/docs/Country.md +20 -9
  128. data/docs/Coupon.md +136 -74
  129. data/docs/CouponAmountOffItems.md +24 -11
  130. data/docs/CouponAmountOffShipping.md +22 -10
  131. data/docs/CouponAmountOffShippingWithItemsPurchase.md +24 -11
  132. data/docs/CouponAmountOffSubtotal.md +20 -9
  133. data/docs/CouponAmountOffSubtotalAndShipping.md +20 -9
  134. data/docs/CouponAmountOffSubtotalFreeShippingWithPurchase.md +24 -11
  135. data/docs/CouponAmountOffSubtotalWithBlockPurchase.md +24 -11
  136. data/docs/CouponAmountOffSubtotalWithItemsPurchase.md +24 -11
  137. data/docs/CouponAmountOffSubtotalWithPurchase.md +22 -10
  138. data/docs/CouponAmountShippingWithSubtotal.md +24 -11
  139. data/docs/CouponApi.md +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 -9
  144. data/docs/CouponCodesRequest.md +30 -14
  145. data/docs/CouponCodesResponse.md +28 -13
  146. data/docs/CouponDeletesRequest.md +20 -9
  147. data/docs/CouponDiscountItemWithItemPurchase.md +26 -12
  148. data/docs/CouponDiscountItems.md +24 -11
  149. data/docs/CouponEditorValues.md +36 -17
  150. data/docs/CouponExistsResponse.md +28 -13
  151. data/docs/CouponFreeItemAndShippingWithSubtotal.md +26 -12
  152. data/docs/CouponFreeItemWithItemPurchase.md +24 -11
  153. data/docs/CouponFreeItemWithSubtotal.md +24 -11
  154. data/docs/CouponFreeItemsWithItemPurchase.md +26 -12
  155. data/docs/CouponFreeItemsWithMixMatchPurchase.md +26 -12
  156. data/docs/CouponFreeShipping.md +18 -8
  157. data/docs/CouponFreeShippingSpecificItems.md +18 -8
  158. data/docs/CouponFreeShippingWithItemsPurchase.md +20 -9
  159. data/docs/CouponFreeShippingWithSubtotal.md +22 -10
  160. data/docs/CouponItemSearchResult.md +32 -15
  161. data/docs/CouponItemSearchResultsResponse.md +26 -12
  162. data/docs/CouponMultipleAmountsOffItems.md +20 -9
  163. data/docs/CouponPercentOffItemWithItemsQuantityPurchase.md +26 -12
  164. data/docs/CouponPercentOffItems.md +24 -11
  165. data/docs/CouponPercentOffItemsAndFreeShipping.md +22 -10
  166. data/docs/CouponPercentOffItemsWithItemsPurchase.md +24 -11
  167. data/docs/CouponPercentOffMsrpItems.md +24 -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 -10
  184. data/docs/CouponTieredAmountOffSubtotal.md +20 -9
  185. data/docs/CouponTieredPercentOffItems.md +22 -10
  186. data/docs/CouponTieredPercentOffShipping.md +22 -10
  187. data/docs/CouponTieredPercentOffSubtotal.md +20 -9
  188. data/docs/CouponType.md +20 -9
  189. data/docs/CouponsRequest.md +18 -8
  190. data/docs/CouponsResponse.md +26 -12
  191. data/docs/Currency.md +26 -12
  192. data/docs/Customer.md +134 -70
  193. data/docs/CustomerActivity.md +24 -15
  194. data/docs/CustomerAffiliate.md +24 -11
  195. data/docs/CustomerApi.md +1380 -1077
  196. data/docs/CustomerAttachment.md +26 -12
  197. data/docs/CustomerBilling.md +50 -24
  198. data/docs/CustomerCard.md +32 -15
  199. data/docs/CustomerEditorValues.md +36 -19
  200. data/docs/CustomerEmail.md +28 -13
  201. data/docs/CustomerEmailListChanges.md +20 -9
  202. data/docs/CustomerLoyalty.md +30 -14
  203. data/docs/CustomerLoyaltyLedger.md +46 -22
  204. data/docs/CustomerLoyaltyRedemption.md +42 -20
  205. data/docs/CustomerOrdersSummary.md +24 -11
  206. data/docs/CustomerPricingTier.md +20 -9
  207. data/docs/CustomerPrivacy.md +24 -11
  208. data/docs/CustomerQuery.md +74 -36
  209. data/docs/CustomerQuotesSummary.md +24 -11
  210. data/docs/CustomerResponse.md +26 -12
  211. data/docs/CustomerReviewer.md +36 -17
  212. data/docs/CustomerShipping.md +50 -24
  213. data/docs/CustomerSoftwareEntitlement.md +32 -15
  214. data/docs/CustomerStoreCredit.md +28 -13
  215. data/docs/CustomerStoreCreditAddRequest.md +24 -11
  216. data/docs/CustomerStoreCreditLedgerEntry.md +30 -14
  217. data/docs/CustomerStoreCreditResponse.md +26 -12
  218. data/docs/CustomerTag.md +18 -8
  219. data/docs/CustomerTaxCodes.md +26 -12
  220. data/docs/CustomersResponse.md +26 -12
  221. data/docs/DataTablesServerSideResponse.md +24 -11
  222. data/docs/Distance.md +20 -9
  223. data/docs/DistributionCenter.md +86 -57
  224. data/docs/DistributionCentersResponse.md +26 -12
  225. data/docs/EmailBaseTemplateListResponse.md +18 -8
  226. data/docs/EmailCampaign.md +64 -33
  227. data/docs/EmailCampaignFolder.md +26 -12
  228. data/docs/EmailCampaignFolderResponse.md +26 -12
  229. data/docs/EmailCampaignFoldersResponse.md +26 -12
  230. data/docs/EmailCampaignResponse.md +26 -12
  231. data/docs/EmailCampaignsResponse.md +26 -12
  232. data/docs/EmailClick.md +20 -9
  233. data/docs/EmailClicksResponse.md +26 -12
  234. data/docs/EmailCommseq.md +24 -11
  235. data/docs/EmailCommseqEmail.md +68 -33
  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 -1167
  374. data/docs/ItemAutoOrder.md +50 -29
  375. data/docs/ItemAutoOrderStep.md +46 -22
  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 -20
  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 -12
  411. data/docs/ItemPhysical.md +24 -11
  412. data/docs/ItemPricing.md +52 -25
  413. data/docs/ItemPricingTier.md +26 -12
  414. data/docs/ItemPricingTierDiscount.md +20 -9
  415. data/docs/ItemPricingTierLimit.md +22 -12
  416. data/docs/ItemProperty.md +22 -10
  417. data/docs/ItemRealtimePricing.md +22 -10
  418. data/docs/ItemRelated.md +22 -10
  419. data/docs/ItemRelatedItem.md +22 -10
  420. data/docs/ItemReporting.md +20 -9
  421. data/docs/ItemResponse.md +26 -12
  422. data/docs/ItemRestriction.md +32 -15
  423. data/docs/ItemRestrictionItem.md +22 -10
  424. data/docs/ItemRevguard.md +30 -14
  425. data/docs/ItemReviews.md +34 -17
  426. data/docs/ItemSalesforce.md +20 -9
  427. data/docs/ItemShipping.md +112 -55
  428. data/docs/ItemShippingCase.md +24 -11
  429. data/docs/ItemShippingDestinationMarkup.md +28 -13
  430. data/docs/ItemShippingDestinationRestriction.md +22 -10
  431. data/docs/ItemShippingDistributionCenter.md +44 -21
  432. data/docs/ItemShippingMethod.md +46 -22
  433. data/docs/ItemShippingPackageRequirement.md +20 -9
  434. data/docs/ItemTag.md +20 -9
  435. data/docs/ItemTags.md +18 -8
  436. data/docs/ItemTax.md +24 -11
  437. data/docs/ItemTaxExemption.md +26 -12
  438. data/docs/ItemThirdPartyEmailMarketing.md +26 -12
  439. data/docs/ItemVariantItem.md +28 -13
  440. data/docs/ItemVariation.md +26 -12
  441. data/docs/ItemVariationOption.md +24 -11
  442. data/docs/ItemWishlistMember.md +22 -10
  443. data/docs/ItemsRequest.md +18 -8
  444. data/docs/ItemsResponse.md +26 -12
  445. data/docs/KeyValue.md +22 -10
  446. data/docs/LibraryFilterValues.md +24 -11
  447. data/docs/LibraryFilterValuesResponse.md +26 -12
  448. data/docs/LibraryItem.md +96 -47
  449. data/docs/LibraryItemAccount.md +22 -10
  450. data/docs/LibraryItemAsset.md +20 -9
  451. data/docs/LibraryItemAttribute.md +20 -9
  452. data/docs/LibraryItemEmail.md +22 -10
  453. data/docs/LibraryItemPublishedMeta.md +32 -15
  454. data/docs/LibraryItemPurchasedMeta.md +22 -10
  455. data/docs/LibraryItemQuery.md +40 -19
  456. data/docs/LibraryItemResponse.md +26 -12
  457. data/docs/LibraryItemScreenshot.md +20 -9
  458. data/docs/LibraryItemsResponse.md +26 -12
  459. data/docs/LinkedAccount.md +22 -10
  460. data/docs/ListSegmentMembership.md +22 -10
  461. data/docs/LookupRequest.md +26 -13
  462. data/docs/LookupResponse.md +26 -12
  463. data/docs/Mailgun.md +18 -8
  464. data/docs/Metric.md +32 -15
  465. data/docs/Notification.md +38 -18
  466. data/docs/OauthApi.md +179 -124
  467. data/docs/OauthRevokeSuccessResponse.md +20 -9
  468. data/docs/OauthTokenResponse.md +32 -15
  469. data/docs/Order.md +84 -45
  470. data/docs/OrderAffiliate.md +22 -10
  471. data/docs/OrderAffiliateLedger.md +34 -16
  472. data/docs/OrderApi.md +1856 -1520
  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 -72
  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 -25
  501. data/docs/OrderPaymentCheck.md +18 -8
  502. data/docs/OrderPaymentCreditCard.md +38 -19
  503. data/docs/OrderPaymentECheck.md +36 -17
  504. data/docs/OrderPaymentInsurance.md +24 -11
  505. data/docs/OrderPaymentPurchaseOrder.md +18 -8
  506. data/docs/OrderPaymentTransaction.md +24 -12
  507. data/docs/OrderPaymentTransactionDetail.md +22 -10
  508. data/docs/OrderProcessPaymentRequest.md +20 -9
  509. data/docs/OrderProcessPaymentResponse.md +26 -12
  510. data/docs/OrderProperty.md +24 -11
  511. data/docs/OrderQuery.md +94 -46
  512. data/docs/OrderQueryBatch.md +18 -8
  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 -27
  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 -40
  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 -8
  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 -9053
  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 -11
  628. data/docs/TwilioResponse.md +28 -13
  629. data/docs/TwiliosResponse.md +26 -12
  630. data/docs/UltraCartConfig.md +18 -8
  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 -16
  646. data/docs/WebhookLog.md +38 -18
  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 -11
  652. data/docs/WebhookSampleRequestResponse.md +26 -12
  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 -642
  658. data/lib/ultracart_api/api/channel_partner_api.rb +370 -664
  659. data/lib/ultracart_api/api/chargeback_api.rb +410 -356
  660. data/lib/ultracart_api/api/checkout_api.rb +1341 -1111
  661. data/lib/ultracart_api/api/coupon_api.rb +1390 -1161
  662. data/lib/ultracart_api/api/customer_api.rb +1292 -1218
  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 -1303
  667. data/lib/ultracart_api/api/oauth_api.rb +198 -171
  668. data/lib/ultracart_api/api/order_api.rb +1728 -1700
  669. data/lib/ultracart_api/api/sso_api.rb +289 -243
  670. data/lib/ultracart_api/api/storefront_api.rb +11407 -10209
  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 -455
  699. data/lib/ultracart_api/models/auto_order_item.rb +487 -472
  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 -540
  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 -240
  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 -207
  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 -319
  769. data/lib/ultracart_api/models/cart_taxes.rb +255 -220
  770. data/lib/ultracart_api/models/cart_upsell_after.rb +255 -220
  771. data/lib/ultracart_api/models/cart_validation_request.rb +231 -196
  772. data/lib/ultracart_api/models/cart_validation_response.rb +231 -196
  773. data/lib/ultracart_api/models/channel_partner_cancel_response.rb +259 -224
  774. data/lib/ultracart_api/models/channel_partner_estimate_shipping_response.rb +259 -224
  775. data/lib/ultracart_api/models/channel_partner_estimate_tax_response.rb +256 -221
  776. data/lib/ultracart_api/models/channel_partner_import_response.rb +281 -246
  777. data/lib/ultracart_api/models/channel_partner_order.rb +1604 -1569
  778. data/lib/ultracart_api/models/channel_partner_order_item.rb +331 -296
  779. data/lib/ultracart_api/models/channel_partner_order_item_option.rb +230 -195
  780. data/lib/ultracart_api/models/channel_partner_order_transaction.rb +232 -197
  781. data/lib/ultracart_api/models/channel_partner_order_transaction_detail.rb +230 -195
  782. data/lib/ultracart_api/models/channel_partner_shipping_estimate.rb +230 -195
  783. data/lib/ultracart_api/models/chargeback_dispute.rb +649 -614
  784. data/lib/ultracart_api/models/chargeback_dispute_response.rb +256 -221
  785. data/lib/ultracart_api/models/chargeback_disputes_response.rb +258 -223
  786. data/lib/ultracart_api/models/checkout_allowed_countries_response.rb +221 -186
  787. data/lib/ultracart_api/models/checkout_handoff_request.rb +323 -288
  788. data/lib/ultracart_api/models/checkout_handoff_response.rb +241 -206
  789. data/lib/ultracart_api/models/checkout_setup_browser_key_request.rb +222 -187
  790. data/lib/ultracart_api/models/checkout_setup_browser_key_response.rb +220 -185
  791. data/lib/ultracart_api/models/checkout_state_province_response.rb +221 -186
  792. data/lib/ultracart_api/models/city_state_zip.rb +255 -220
  793. data/lib/ultracart_api/models/countries_response.rb +221 -186
  794. data/lib/ultracart_api/models/country.rb +260 -225
  795. data/lib/ultracart_api/models/coupon.rb +864 -917
  796. data/lib/ultracart_api/models/coupon_amount_off_items.rb +267 -232
  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 -197
  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 -240
  814. data/lib/ultracart_api/models/coupon_discount_items.rb +267 -232
  815. data/lib/ultracart_api/models/coupon_editor_values.rb +330 -295
  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 -219
  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 -229
  830. data/lib/ultracart_api/models/coupon_percent_off_items.rb +254 -219
  831. data/lib/ultracart_api/models/coupon_percent_off_items_and_free_shipping.rb +244 -209
  832. data/lib/ultracart_api/models/coupon_percent_off_items_with_items_purchase.rb +254 -219
  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 -209
  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 -209
  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 -984
  859. data/lib/ultracart_api/models/customer_activity.rb +254 -255
  860. data/lib/ultracart_api/models/customer_affiliate.rb +250 -215
  861. data/lib/ultracart_api/models/customer_attachment.rb +260 -225
  862. data/lib/ultracart_api/models/customer_billing.rb +575 -540
  863. data/lib/ultracart_api/models/customer_card.rb +290 -255
  864. data/lib/ultracart_api/models/customer_editor_values.rb +328 -317
  865. data/lib/ultracart_api/models/customer_email.rb +300 -265
  866. data/lib/ultracart_api/models/customer_email_list_changes.rb +234 -199
  867. data/lib/ultracart_api/models/customer_loyalty.rb +283 -248
  868. data/lib/ultracart_api/models/customer_loyalty_ledger.rb +360 -325
  869. data/lib/ultracart_api/models/customer_loyalty_redemption.rb +340 -305
  870. data/lib/ultracart_api/models/customer_orders_summary.rb +250 -215
  871. data/lib/ultracart_api/models/customer_pricing_tier.rb +245 -210
  872. data/lib/ultracart_api/models/customer_privacy.rb +250 -215
  873. data/lib/ultracart_api/models/customer_query.rb +789 -754
  874. data/lib/ultracart_api/models/customer_quotes_summary.rb +250 -215
  875. data/lib/ultracart_api/models/customer_response.rb +256 -221
  876. data/lib/ultracart_api/models/customer_reviewer.rb +310 -275
  877. data/lib/ultracart_api/models/customer_shipping.rb +575 -540
  878. data/lib/ultracart_api/models/customer_software_entitlement.rb +365 -330
  879. data/lib/ultracart_api/models/customer_store_credit.rb +274 -239
  880. data/lib/ultracart_api/models/customer_store_credit_add_request.rb +250 -215
  881. data/lib/ultracart_api/models/customer_store_credit_ledger_entry.rb +295 -260
  882. data/lib/ultracart_api/models/customer_store_credit_response.rb +256 -221
  883. data/lib/ultracart_api/models/customer_tag.rb +235 -200
  884. data/lib/ultracart_api/models/customer_tax_codes.rb +260 -225
  885. data/lib/ultracart_api/models/customers_response.rb +258 -223
  886. data/lib/ultracart_api/models/data_tables_server_side_response.rb +248 -213
  887. data/lib/ultracart_api/models/distance.rb +264 -229
  888. data/lib/ultracart_api/models/distribution_center.rb +559 -674
  889. data/lib/ultracart_api/models/distribution_centers_response.rb +258 -223
  890. data/lib/ultracart_api/models/email_base_template_list_response.rb +221 -186
  891. data/lib/ultracart_api/models/email_campaign.rb +467 -452
  892. data/lib/ultracart_api/models/email_campaign_folder.rb +275 -240
  893. data/lib/ultracart_api/models/email_campaign_folder_response.rb +256 -221
  894. data/lib/ultracart_api/models/email_campaign_folders_response.rb +258 -223
  895. data/lib/ultracart_api/models/email_campaign_response.rb +256 -221
  896. data/lib/ultracart_api/models/email_campaigns_response.rb +258 -223
  897. data/lib/ultracart_api/models/email_click.rb +230 -195
  898. data/lib/ultracart_api/models/email_clicks_response.rb +258 -223
  899. data/lib/ultracart_api/models/email_commseq.rb +252 -217
  900. data/lib/ultracart_api/models/email_commseq_email.rb +470 -435
  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 -378
  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 -326
  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 -229
  1072. data/lib/ultracart_api/models/item_physical.rb +246 -211
  1073. data/lib/ultracart_api/models/item_pricing.rb +422 -387
  1074. data/lib/ultracart_api/models/item_pricing_tier.rb +261 -226
  1075. data/lib/ultracart_api/models/item_pricing_tier_discount.rb +230 -195
  1076. data/lib/ultracart_api/models/item_pricing_tier_limit.rb +240 -227
  1077. data/lib/ultracart_api/models/item_property.rb +270 -235
  1078. data/lib/ultracart_api/models/item_realtime_pricing.rb +240 -205
  1079. data/lib/ultracart_api/models/item_related.rb +242 -207
  1080. data/lib/ultracart_api/models/item_related_item.rb +274 -239
  1081. data/lib/ultracart_api/models/item_reporting.rb +232 -197
  1082. data/lib/ultracart_api/models/item_response.rb +256 -221
  1083. data/lib/ultracart_api/models/item_restriction.rb +292 -257
  1084. data/lib/ultracart_api/models/item_restriction_item.rb +274 -239
  1085. data/lib/ultracart_api/models/item_revguard.rb +280 -245
  1086. data/lib/ultracart_api/models/item_reviews.rb +300 -276
  1087. data/lib/ultracart_api/models/item_salesforce.rb +230 -195
  1088. data/lib/ultracart_api/models/item_shipping.rb +713 -678
  1089. data/lib/ultracart_api/models/item_shipping_case.rb +265 -230
  1090. data/lib/ultracart_api/models/item_shipping_destination_markup.rb +315 -280
  1091. data/lib/ultracart_api/models/item_shipping_destination_restriction.rb +304 -269
  1092. data/lib/ultracart_api/models/item_shipping_distribution_center.rb +380 -345
  1093. data/lib/ultracart_api/models/item_shipping_method.rb +394 -359
  1094. data/lib/ultracart_api/models/item_shipping_package_requirement.rb +230 -195
  1095. data/lib/ultracart_api/models/item_tag.rb +279 -244
  1096. data/lib/ultracart_api/models/item_tags.rb +222 -187
  1097. data/lib/ultracart_api/models/item_tax.rb +286 -251
  1098. data/lib/ultracart_api/models/item_tax_exemption.rb +335 -300
  1099. data/lib/ultracart_api/models/item_third_party_email_marketing.rb +302 -267
  1100. data/lib/ultracart_api/models/item_variant_item.rb +289 -254
  1101. data/lib/ultracart_api/models/item_variation.rb +292 -257
  1102. data/lib/ultracart_api/models/item_variation_option.rb +265 -230
  1103. data/lib/ultracart_api/models/item_wishlist_member.rb +255 -220
  1104. data/lib/ultracart_api/models/items_request.rb +222 -187
  1105. data/lib/ultracart_api/models/items_response.rb +259 -224
  1106. data/lib/ultracart_api/models/key_value.rb +240 -205
  1107. data/lib/ultracart_api/models/library_filter_values.rb +254 -219
  1108. data/lib/ultracart_api/models/library_filter_values_response.rb +256 -221
  1109. data/lib/ultracart_api/models/library_item.rb +606 -571
  1110. data/lib/ultracart_api/models/library_item_account.rb +237 -202
  1111. data/lib/ultracart_api/models/library_item_asset.rb +228 -193
  1112. data/lib/ultracart_api/models/library_item_attribute.rb +228 -193
  1113. data/lib/ultracart_api/models/library_item_email.rb +237 -202
  1114. data/lib/ultracart_api/models/library_item_published_meta.rb +290 -255
  1115. data/lib/ultracart_api/models/library_item_purchased_meta.rb +240 -205
  1116. data/lib/ultracart_api/models/library_item_query.rb +330 -295
  1117. data/lib/ultracart_api/models/library_item_response.rb +256 -221
  1118. data/lib/ultracart_api/models/library_item_screenshot.rb +228 -193
  1119. data/lib/ultracart_api/models/library_items_response.rb +259 -224
  1120. data/lib/ultracart_api/models/linked_account.rb +240 -205
  1121. data/lib/ultracart_api/models/list_segment_membership.rb +237 -202
  1122. data/lib/ultracart_api/models/lookup_request.rb +255 -229
  1123. data/lib/ultracart_api/models/lookup_response.rb +258 -223
  1124. data/lib/ultracart_api/models/mailgun.rb +219 -184
  1125. data/lib/ultracart_api/models/metric.rb +282 -247
  1126. data/lib/ultracart_api/models/notification.rb +322 -287
  1127. data/lib/ultracart_api/models/oauth_revoke_success_response.rb +230 -195
  1128. data/lib/ultracart_api/models/oauth_token_response.rb +321 -286
  1129. data/lib/ultracart_api/models/order.rb +604 -610
  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 -1019
  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 -397
  1160. data/lib/ultracart_api/models/order_payment_check.rb +220 -185
  1161. data/lib/ultracart_api/models/order_payment_credit_card.rb +354 -328
  1162. data/lib/ultracart_api/models/order_payment_e_check.rb +476 -441
  1163. data/lib/ultracart_api/models/order_payment_insurance.rb +250 -215
  1164. data/lib/ultracart_api/models/order_payment_purchase_order.rb +220 -185
  1165. data/lib/ultracart_api/models/order_payment_transaction.rb +252 -227
  1166. data/lib/ultracart_api/models/order_payment_transaction_detail.rb +240 -205
  1167. data/lib/ultracart_api/models/order_process_payment_request.rb +230 -195
  1168. data/lib/ultracart_api/models/order_process_payment_response.rb +256 -221
  1169. data/lib/ultracart_api/models/order_property.rb +280 -245
  1170. data/lib/ultracart_api/models/order_query.rb +826 -791
  1171. data/lib/ultracart_api/models/order_query_batch.rb +222 -187
  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 -355
  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 -518
  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 -185
  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 -213
  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 -185
  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 -265
  1300. data/lib/ultracart_api/models/webhook_log.rb +324 -289
  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/webhook_sample_request.rb +252 -217
  1306. data/lib/ultracart_api/models/webhook_sample_request_response.rb +256 -221
  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 -841
  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 +5 -469
  1316. data/docs/AccountsReceivableRetryTransactionReject.md +0 -9
  1317. data/docs/AutoOrderAddonItem.md +0 -13
  1318. data/docs/AutoOrderAddonItemOption.md +0 -9
  1319. data/docs/AutoOrderManagement.md +0 -8
  1320. data/docs/CartItemProperty.md +0 -11
  1321. data/docs/ChannelPartner.md +0 -15
  1322. data/docs/ChannelPartnerShipToPreference.md +0 -14
  1323. data/docs/ChannelPartnerShipToPreferenceResponse.md +0 -12
  1324. data/docs/ChannelPartnerShipToPreferencesResponse.md +0 -12
  1325. data/docs/ChannelPartnersResponse.md +0 -12
  1326. data/docs/Conversation.md +0 -26
  1327. data/docs/ConversationAgentAuth.md +0 -13
  1328. data/docs/ConversationAgentAuthResponse.md +0 -12
  1329. data/docs/ConversationAgentProfile.md +0 -14
  1330. data/docs/ConversationAgentProfileResponse.md +0 -12
  1331. data/docs/ConversationApi.md +0 -1768
  1332. data/docs/ConversationAutocompleteRequest.md +0 -9
  1333. data/docs/ConversationAutocompleteResponse.md +0 -14
  1334. data/docs/ConversationAutocompleteValue.md +0 -9
  1335. data/docs/ConversationCannedMessage.md +0 -11
  1336. data/docs/ConversationCannedMessageResponse.md +0 -12
  1337. data/docs/ConversationCannedMessagesResponse.md +0 -12
  1338. data/docs/ConversationCannedMessagesSearch.md +0 -9
  1339. data/docs/ConversationDepartment.md +0 -12
  1340. data/docs/ConversationDepartmentMember.md +0 -10
  1341. data/docs/ConversationDepartmentMembersResponse.md +0 -12
  1342. data/docs/ConversationDepartmentResponse.md +0 -12
  1343. data/docs/ConversationDepartmentSettings.md +0 -7
  1344. data/docs/ConversationDepartmentsResponse.md +0 -12
  1345. data/docs/ConversationEngagement.md +0 -16
  1346. data/docs/ConversationEngagementEquation.md +0 -8
  1347. data/docs/ConversationEngagementEquationFunction.md +0 -21
  1348. data/docs/ConversationEngagementEquationGroup.md +0 -8
  1349. data/docs/ConversationEngagementResponse.md +0 -12
  1350. data/docs/ConversationEngagementsResponse.md +0 -12
  1351. data/docs/ConversationEventAddCoupon.md +0 -10
  1352. data/docs/ConversationEventAddItem.md +0 -10
  1353. data/docs/ConversationEventQueuePosition.md +0 -9
  1354. data/docs/ConversationEventRRWeb.md +0 -14
  1355. data/docs/ConversationEventReadMessage.md +0 -10
  1356. data/docs/ConversationEventTyping.md +0 -10
  1357. data/docs/ConversationEventWebchatContext.md +0 -10
  1358. data/docs/ConversationJoinRequest.md +0 -8
  1359. data/docs/ConversationLocationCountry.md +0 -10
  1360. data/docs/ConversationLocationStateProvince.md +0 -9
  1361. data/docs/ConversationLocationsResponse.md +0 -12
  1362. data/docs/ConversationMessage.md +0 -22
  1363. data/docs/ConversationMessageTranslation.md +0 -9
  1364. data/docs/ConversationMessageTransportStatus.md +0 -9
  1365. data/docs/ConversationMessagesResponse.md +0 -12
  1366. data/docs/ConversationMultimediaUploadUrl.md +0 -9
  1367. data/docs/ConversationMultimediaUploadUrlResponse.md +0 -12
  1368. data/docs/ConversationParticipant.md +0 -20
  1369. data/docs/ConversationPermissions.md +0 -8
  1370. data/docs/ConversationPermissionsResponse.md +0 -12
  1371. data/docs/ConversationResponse.md +0 -12
  1372. data/docs/ConversationSearchRequest.md +0 -19
  1373. data/docs/ConversationSearchResponse.md +0 -11
  1374. data/docs/ConversationSentiment.md +0 -13
  1375. data/docs/ConversationStartRequest.md +0 -10
  1376. data/docs/ConversationStartResponse.md +0 -8
  1377. data/docs/ConversationSummary.md +0 -24
  1378. data/docs/ConversationTwilioAccount.md +0 -9
  1379. data/docs/ConversationWebchatContext.md +0 -15
  1380. data/docs/ConversationWebchatQueueStatus.md +0 -22
  1381. data/docs/ConversationWebchatQueueStatusAgent.md +0 -13
  1382. data/docs/ConversationWebchatQueueStatusQueueEntry.md +0 -15
  1383. data/docs/ConversationWebchatQueueStatusUpdateRequest.md +0 -8
  1384. data/docs/ConversationWebchatQueueStatusesResponse.md +0 -12
  1385. data/docs/ConversationWebsocketMessage.md +0 -31
  1386. data/docs/ConversationsResponse.md +0 -12
  1387. data/docs/CouponFreeItemWithItemPurchaseAndFreeShipping.md +0 -11
  1388. data/docs/CouponMoreLoyaltyCashback.md +0 -8
  1389. data/docs/CouponMoreLoyaltyPoints.md +0 -8
  1390. data/docs/CouponNoDiscount.md +0 -8
  1391. data/docs/CouponPercentMoreLoyaltyCashback.md +0 -8
  1392. data/docs/CouponPercentMoreLoyaltyPoints.md +0 -8
  1393. data/docs/CouponTieredPercentOffSubtotalBasedOnMSRP.md +0 -9
  1394. data/docs/CustomerEDI.md +0 -10
  1395. data/docs/CustomerMagicLinkResponse.md +0 -12
  1396. data/docs/CustomerMergeRequest.md +0 -9
  1397. data/docs/CustomerProperty.md +0 -11
  1398. data/docs/DatawarehouseApi.md +0 -512
  1399. data/docs/EmailCommseqSequenceTestRequest.md +0 -22
  1400. data/docs/EmailCommseqSequenceTestResponse.md +0 -11
  1401. data/docs/EmailCommseqSmsSendTestRequest.md +0 -10
  1402. data/docs/EmailCommseqSmsSendTestResponse.md +0 -13
  1403. data/docs/EmailPostcardTracking.md +0 -32
  1404. data/docs/EmailPostcardTrackingResponse.md +0 -12
  1405. data/docs/FileManagerDirectory.md +0 -20
  1406. data/docs/FileManagerFile.md +0 -29
  1407. data/docs/FileManagerPage.md +0 -15
  1408. data/docs/FileManagerPageResponse.md +0 -12
  1409. data/docs/FileManagerUploadRequest.md +0 -10
  1410. data/docs/FileManagerUploadUrlResponse.md +0 -13
  1411. data/docs/HitPageView.md +0 -18
  1412. data/docs/HitPageViewMetaData.md +0 -9
  1413. data/docs/HitSessionStart.md +0 -24
  1414. data/docs/HitSessionUtm.md +0 -22
  1415. data/docs/ItemDigitalItemPdfMeta.md +0 -18
  1416. data/docs/ItemDigitalItemResponse.md +0 -12
  1417. data/docs/ItemDigitalItemsResponse.md +0 -12
  1418. data/docs/ItemReview.md +0 -44
  1419. data/docs/ItemReviewResponse.md +0 -12
  1420. data/docs/ItemReviewsResponse.md +0 -12
  1421. data/docs/OrderEdiDocument.md +0 -21
  1422. data/docs/OrderEdiDocumentsResponse.md +0 -12
  1423. data/docs/OrderInvoiceResponse.md +0 -12
  1424. data/docs/OrderPaymentCreditCardDualVaulted.md +0 -10
  1425. data/docs/OrderPaymentCreditCardDualVaultedProperty.md +0 -9
  1426. data/docs/OrderPointOfSale.md +0 -10
  1427. data/docs/OrderReason.md +0 -10
  1428. data/docs/OrderRefundableResponse.md +0 -19
  1429. data/docs/OrderTransactionalMerchantNote.md +0 -11
  1430. data/docs/OrderUtm.md +0 -31
  1431. data/docs/OrderValidationRequest.md +0 -9
  1432. data/docs/OrderValidationResponse.md +0 -10
  1433. data/docs/PointOfSaleLocation.md +0 -17
  1434. data/docs/PointOfSaleReader.md +0 -16
  1435. data/docs/PointOfSaleRegister.md +0 -11
  1436. data/docs/Report.md +0 -18
  1437. data/docs/ReportAuth.md +0 -11
  1438. data/docs/ReportAuthResponse.md +0 -12
  1439. data/docs/ReportDataSet.md +0 -24
  1440. data/docs/ReportDataSetColumn.md +0 -13
  1441. data/docs/ReportDataSetPage.md +0 -17
  1442. data/docs/ReportDataSetPageResponse.md +0 -12
  1443. data/docs/ReportDataSetQuery.md +0 -20
  1444. data/docs/ReportDataSetQueryOrderByColumn.md +0 -9
  1445. data/docs/ReportDataSetResponse.md +0 -12
  1446. data/docs/ReportDataSetRow.md +0 -8
  1447. data/docs/ReportDataSetSchema.md +0 -10
  1448. data/docs/ReportDataSource.md +0 -14
  1449. data/docs/ReportDataSourceSchema.md +0 -11
  1450. data/docs/ReportDryRunQueriesRequest.md +0 -13
  1451. data/docs/ReportDryRunQueriesResponse.md +0 -8
  1452. data/docs/ReportDryRunQueryResult.md +0 -9
  1453. data/docs/ReportExecuteQueriesRequest.md +0 -15
  1454. data/docs/ReportFilter.md +0 -13
  1455. data/docs/ReportFilterConnection.md +0 -10
  1456. data/docs/ReportPage.md +0 -13
  1457. data/docs/ReportPageFilter.md +0 -11
  1458. data/docs/ReportPageVisualization.md +0 -17
  1459. data/docs/ReportPageVisualizationDimension.md +0 -14
  1460. data/docs/ReportPageVisualizationMetric.md +0 -11
  1461. data/docs/ReportResponse.md +0 -12
  1462. data/docs/ReportWebsocketEvent.md +0 -9
  1463. data/docs/ReportsResponse.md +0 -12
  1464. data/docs/RulerValidationRequest.md +0 -8
  1465. data/docs/RulerValidationResponse.md +0 -9
  1466. data/docs/StoreFront.md +0 -18
  1467. data/docs/StoreFrontsResponse.md +0 -12
  1468. data/lib/ultracart_api/api/conversation_api.rb +0 -1936
  1469. data/lib/ultracart_api/api/datawarehouse_api.rb +0 -584
  1470. data/lib/ultracart_api/models/accounts_receivable_retry_transaction_reject.rb +0 -195
  1471. data/lib/ultracart_api/models/auto_order_addon_item.rb +0 -232
  1472. data/lib/ultracart_api/models/auto_order_addon_item_option.rb +0 -225
  1473. data/lib/ultracart_api/models/auto_order_management.rb +0 -185
  1474. data/lib/ultracart_api/models/cart_item_property.rb +0 -245
  1475. data/lib/ultracart_api/models/channel_partner.rb +0 -255
  1476. data/lib/ultracart_api/models/channel_partner_ship_to_preference.rb +0 -262
  1477. data/lib/ultracart_api/models/channel_partner_ship_to_preference_response.rb +0 -221
  1478. data/lib/ultracart_api/models/channel_partner_ship_to_preferences_response.rb +0 -224
  1479. data/lib/ultracart_api/models/channel_partners_response.rb +0 -224
  1480. data/lib/ultracart_api/models/conversation.rb +0 -390
  1481. data/lib/ultracart_api/models/conversation_agent_auth.rb +0 -231
  1482. data/lib/ultracart_api/models/conversation_agent_auth_response.rb +0 -221
  1483. data/lib/ultracart_api/models/conversation_agent_profile.rb +0 -279
  1484. data/lib/ultracart_api/models/conversation_agent_profile_response.rb +0 -221
  1485. data/lib/ultracart_api/models/conversation_autocomplete_request.rb +0 -193
  1486. data/lib/ultracart_api/models/conversation_autocomplete_response.rb +0 -241
  1487. data/lib/ultracart_api/models/conversation_autocomplete_value.rb +0 -193
  1488. data/lib/ultracart_api/models/conversation_canned_message.rb +0 -213
  1489. data/lib/ultracart_api/models/conversation_canned_message_response.rb +0 -221
  1490. data/lib/ultracart_api/models/conversation_canned_messages_response.rb +0 -223
  1491. data/lib/ultracart_api/models/conversation_canned_messages_search.rb +0 -193
  1492. data/lib/ultracart_api/models/conversation_department.rb +0 -222
  1493. data/lib/ultracart_api/models/conversation_department_member.rb +0 -202
  1494. data/lib/ultracart_api/models/conversation_department_members_response.rb +0 -223
  1495. data/lib/ultracart_api/models/conversation_department_response.rb +0 -221
  1496. data/lib/ultracart_api/models/conversation_department_settings.rb +0 -175
  1497. data/lib/ultracart_api/models/conversation_departments_response.rb +0 -223
  1498. data/lib/ultracart_api/models/conversation_engagement.rb +0 -293
  1499. data/lib/ultracart_api/models/conversation_engagement_equation.rb +0 -186
  1500. data/lib/ultracart_api/models/conversation_engagement_equation_function.rb +0 -414
  1501. data/lib/ultracart_api/models/conversation_engagement_equation_group.rb +0 -186
  1502. data/lib/ultracart_api/models/conversation_engagement_response.rb +0 -221
  1503. data/lib/ultracart_api/models/conversation_engagements_response.rb +0 -223
  1504. data/lib/ultracart_api/models/conversation_event_add_coupon.rb +0 -202
  1505. data/lib/ultracart_api/models/conversation_event_add_item.rb +0 -204
  1506. data/lib/ultracart_api/models/conversation_event_queue_position.rb +0 -195
  1507. data/lib/ultracart_api/models/conversation_event_read_message.rb +0 -203
  1508. data/lib/ultracart_api/models/conversation_event_rr_web.rb +0 -273
  1509. data/lib/ultracart_api/models/conversation_event_typing.rb +0 -202
  1510. data/lib/ultracart_api/models/conversation_event_webchat_context.rb +0 -202
  1511. data/lib/ultracart_api/models/conversation_join_request.rb +0 -184
  1512. data/lib/ultracart_api/models/conversation_location_country.rb +0 -204
  1513. data/lib/ultracart_api/models/conversation_location_state_province.rb +0 -193
  1514. data/lib/ultracart_api/models/conversation_locations_response.rb +0 -223
  1515. data/lib/ultracart_api/models/conversation_message.rb +0 -356
  1516. data/lib/ultracart_api/models/conversation_message_translation.rb +0 -193
  1517. data/lib/ultracart_api/models/conversation_message_transport_status.rb +0 -228
  1518. data/lib/ultracart_api/models/conversation_messages_response.rb +0 -223
  1519. data/lib/ultracart_api/models/conversation_multimedia_upload_url.rb +0 -193
  1520. data/lib/ultracart_api/models/conversation_multimedia_upload_url_response.rb +0 -221
  1521. data/lib/ultracart_api/models/conversation_participant.rb +0 -295
  1522. data/lib/ultracart_api/models/conversation_permissions.rb +0 -184
  1523. data/lib/ultracart_api/models/conversation_permissions_response.rb +0 -221
  1524. data/lib/ultracart_api/models/conversation_response.rb +0 -221
  1525. data/lib/ultracart_api/models/conversation_search_request.rb +0 -285
  1526. data/lib/ultracart_api/models/conversation_search_response.rb +0 -213
  1527. data/lib/ultracart_api/models/conversation_sentiment.rb +0 -269
  1528. data/lib/ultracart_api/models/conversation_start_request.rb +0 -204
  1529. data/lib/ultracart_api/models/conversation_start_response.rb +0 -184
  1530. data/lib/ultracart_api/models/conversation_summary.rb +0 -369
  1531. data/lib/ultracart_api/models/conversation_twilio_account.rb +0 -195
  1532. data/lib/ultracart_api/models/conversation_webchat_context.rb +0 -254
  1533. data/lib/ultracart_api/models/conversation_webchat_queue_status.rb +0 -315
  1534. data/lib/ultracart_api/models/conversation_webchat_queue_status_agent.rb +0 -266
  1535. data/lib/ultracart_api/models/conversation_webchat_queue_status_queue_entry.rb +0 -248
  1536. data/lib/ultracart_api/models/conversation_webchat_queue_status_update_request.rb +0 -219
  1537. data/lib/ultracart_api/models/conversation_webchat_queue_statuses_response.rb +0 -223
  1538. data/lib/ultracart_api/models/conversation_websocket_message.rb +0 -441
  1539. data/lib/ultracart_api/models/conversations_response.rb +0 -223
  1540. data/lib/ultracart_api/models/coupon_free_item_with_item_purchase_and_free_shipping.rb +0 -219
  1541. data/lib/ultracart_api/models/coupon_more_loyalty_cashback.rb +0 -185
  1542. data/lib/ultracart_api/models/coupon_more_loyalty_points.rb +0 -185
  1543. data/lib/ultracart_api/models/coupon_no_discount.rb +0 -185
  1544. data/lib/ultracart_api/models/coupon_percent_more_loyalty_cashback.rb +0 -185
  1545. data/lib/ultracart_api/models/coupon_percent_more_loyalty_points.rb +0 -185
  1546. data/lib/ultracart_api/models/coupon_tiered_percent_off_subtotal_based_on_msrp.rb +0 -199
  1547. data/lib/ultracart_api/models/customer_edi.rb +0 -205
  1548. data/lib/ultracart_api/models/customer_magic_link_response.rb +0 -222
  1549. data/lib/ultracart_api/models/customer_merge_request.rb +0 -195
  1550. data/lib/ultracart_api/models/customer_property.rb +0 -245
  1551. data/lib/ultracart_api/models/email_commseq_sequence_test_request.rb +0 -312
  1552. data/lib/ultracart_api/models/email_commseq_sequence_test_response.rb +0 -212
  1553. data/lib/ultracart_api/models/email_commseq_sms_send_test_request.rb +0 -202
  1554. data/lib/ultracart_api/models/email_commseq_sms_send_test_response.rb +0 -232
  1555. data/lib/ultracart_api/models/email_postcard_tracking.rb +0 -404
  1556. data/lib/ultracart_api/models/email_postcard_tracking_response.rb +0 -221
  1557. data/lib/ultracart_api/models/file_manager_directory.rb +0 -292
  1558. data/lib/ultracart_api/models/file_manager_file.rb +0 -376
  1559. data/lib/ultracart_api/models/file_manager_page.rb +0 -253
  1560. data/lib/ultracart_api/models/file_manager_page_response.rb +0 -221
  1561. data/lib/ultracart_api/models/file_manager_upload_request.rb +0 -202
  1562. data/lib/ultracart_api/models/file_manager_upload_url_response.rb +0 -230
  1563. data/lib/ultracart_api/models/hit_page_view.rb +0 -276
  1564. data/lib/ultracart_api/models/hit_page_view_meta_data.rb +0 -193
  1565. data/lib/ultracart_api/models/hit_session_start.rb +0 -328
  1566. data/lib/ultracart_api/models/hit_session_utm.rb +0 -310
  1567. data/lib/ultracart_api/models/item_digital_item_pdf_meta.rb +0 -315
  1568. data/lib/ultracart_api/models/item_digital_item_response.rb +0 -221
  1569. data/lib/ultracart_api/models/item_digital_items_response.rb +0 -224
  1570. data/lib/ultracart_api/models/item_review.rb +0 -801
  1571. data/lib/ultracart_api/models/item_review_response.rb +0 -221
  1572. data/lib/ultracart_api/models/item_reviews_response.rb +0 -224
  1573. data/lib/ultracart_api/models/order_edi_document.rb +0 -337
  1574. data/lib/ultracart_api/models/order_edi_documents_response.rb +0 -224
  1575. data/lib/ultracart_api/models/order_invoice_response.rb +0 -222
  1576. data/lib/ultracart_api/models/order_payment_credit_card_dual_vaulted.rb +0 -204
  1577. data/lib/ultracart_api/models/order_payment_credit_card_dual_vaulted_property.rb +0 -193
  1578. data/lib/ultracart_api/models/order_point_of_sale.rb +0 -202
  1579. data/lib/ultracart_api/models/order_reason.rb +0 -205
  1580. data/lib/ultracart_api/models/order_refundable_response.rb +0 -300
  1581. data/lib/ultracart_api/models/order_transactional_merchant_note.rb +0 -215
  1582. data/lib/ultracart_api/models/order_utm.rb +0 -392
  1583. data/lib/ultracart_api/models/order_validation_request.rb +0 -196
  1584. data/lib/ultracart_api/models/order_validation_response.rb +0 -209
  1585. data/lib/ultracart_api/models/point_of_sale_location.rb +0 -290
  1586. data/lib/ultracart_api/models/point_of_sale_reader.rb +0 -299
  1587. data/lib/ultracart_api/models/point_of_sale_register.rb +0 -215
  1588. data/lib/ultracart_api/models/report.rb +0 -317
  1589. data/lib/ultracart_api/models/report_auth.rb +0 -212
  1590. data/lib/ultracart_api/models/report_auth_response.rb +0 -221
  1591. data/lib/ultracart_api/models/report_data_set.rb +0 -381
  1592. data/lib/ultracart_api/models/report_data_set_column.rb +0 -229
  1593. data/lib/ultracart_api/models/report_data_set_page.rb +0 -273
  1594. data/lib/ultracart_api/models/report_data_set_page_response.rb +0 -221
  1595. data/lib/ultracart_api/models/report_data_set_query.rb +0 -342
  1596. data/lib/ultracart_api/models/report_data_set_query_order_by_column.rb +0 -193
  1597. data/lib/ultracart_api/models/report_data_set_response.rb +0 -221
  1598. data/lib/ultracart_api/models/report_data_set_row.rb +0 -186
  1599. data/lib/ultracart_api/models/report_data_set_schema.rb +0 -238
  1600. data/lib/ultracart_api/models/report_data_source.rb +0 -242
  1601. data/lib/ultracart_api/models/report_data_source_schema.rb +0 -248
  1602. data/lib/ultracart_api/models/report_dry_run_queries_request.rb +0 -231
  1603. data/lib/ultracart_api/models/report_dry_run_queries_response.rb +0 -186
  1604. data/lib/ultracart_api/models/report_dry_run_query_result.rb +0 -193
  1605. data/lib/ultracart_api/models/report_execute_queries_request.rb +0 -288
  1606. data/lib/ultracart_api/models/report_filter.rb +0 -272
  1607. data/lib/ultracart_api/models/report_filter_connection.rb +0 -203
  1608. data/lib/ultracart_api/models/report_page.rb +0 -237
  1609. data/lib/ultracart_api/models/report_page_filter.rb +0 -214
  1610. data/lib/ultracart_api/models/report_page_visualization.rb +0 -309
  1611. data/lib/ultracart_api/models/report_page_visualization_dimension.rb +0 -244
  1612. data/lib/ultracart_api/models/report_page_visualization_metric.rb +0 -248
  1613. data/lib/ultracart_api/models/report_response.rb +0 -221
  1614. data/lib/ultracart_api/models/report_websocket_event.rb +0 -228
  1615. data/lib/ultracart_api/models/reports_response.rb +0 -223
  1616. data/lib/ultracart_api/models/ruler_validation_request.rb +0 -184
  1617. data/lib/ultracart_api/models/ruler_validation_response.rb +0 -193
  1618. data/lib/ultracart_api/models/store_front.rb +0 -274
  1619. data/lib/ultracart_api/models/store_fronts_response.rb +0 -223
@@ -1,1700 +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
- # Cancel an order
97
- # Cancel an order on the UltraCart account. If the success flag is false, then consult the error message for why it failed.
98
- # @param order_id The order id to cancel.
99
- # @param [Hash] opts the optional parameters
100
- # @option opts [BOOLEAN] :lock_self_ship_orders Flag to prevent a order shipping during a refund process
101
- # @option opts [BOOLEAN] :skip_refund_and_hold Skip refund and move order to Held Orders department
102
- # @return [BaseResponse]
103
- def cancel_order(order_id, opts = {})
104
- data, _status_code, _headers = cancel_order_with_http_info(order_id, opts)
105
- data
106
- end
107
-
108
- # Cancel an order
109
- # Cancel an order on the UltraCart account. If the success flag is false, then consult the error message for why it failed.
110
- # @param order_id The order id to cancel.
111
- # @param [Hash] opts the optional parameters
112
- # @option opts [BOOLEAN] :lock_self_ship_orders Flag to prevent a order shipping during a refund process
113
- # @option opts [BOOLEAN] :skip_refund_and_hold Skip refund and move order to Held Orders department
114
- # @return [Array<(BaseResponse, Fixnum, Hash)>] BaseResponse data, response status code and response headers
115
- def cancel_order_with_http_info(order_id, opts = {})
116
- if @api_client.config.debugging
117
- @api_client.config.logger.debug 'Calling API: OrderApi.cancel_order ...'
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.cancel_order"
122
- end
123
- # resource path
124
- local_var_path = '/order/orders/{order_id}/cancel'.sub('{' + 'order_id' + '}', order_id.to_s)
125
-
126
- # query parameters
127
- query_params = {}
128
- query_params[:'lock_self_ship_orders'] = opts[:'lock_self_ship_orders'] if !opts[:'lock_self_ship_orders'].nil?
129
- query_params[:'skip_refund_and_hold'] = opts[:'skip_refund_and_hold'] if !opts[:'skip_refund_and_hold'].nil?
130
-
131
- # header parameters
132
- header_params = {}
133
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
134
- # HTTP header 'Accept' (if needed)
135
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
136
- # HTTP header 'Content-Type'
137
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
138
-
139
- # form parameters
140
- form_params = {}
141
-
142
- # http body (model)
143
- post_body = nil
144
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
145
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
146
- :header_params => header_params,
147
- :query_params => query_params,
148
- :form_params => form_params,
149
- :body => post_body,
150
- :auth_names => auth_names,
151
- :return_type => 'BaseResponse')
152
- if @api_client.config.debugging
153
- @api_client.config.logger.debug "API called: OrderApi#cancel_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
154
- end
155
- return data, status_code, headers
156
- end
157
- # Delete an order
158
- # Delete an order on the UltraCart account.
159
- # @param order_id The order id to delete.
160
- # @param [Hash] opts the optional parameters
161
- # @return [nil]
162
- def delete_order(order_id, opts = {})
163
- delete_order_with_http_info(order_id, opts)
164
- nil
165
- end
166
-
167
- # Delete an order
168
- # Delete an order on the UltraCart account.
169
- # @param order_id The order id to delete.
170
- # @param [Hash] opts the optional parameters
171
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
172
- def delete_order_with_http_info(order_id, opts = {})
173
- if @api_client.config.debugging
174
- @api_client.config.logger.debug 'Calling API: OrderApi.delete_order ...'
175
- end
176
- # verify the required parameter 'order_id' is set
177
- if @api_client.config.client_side_validation && order_id.nil?
178
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.delete_order"
179
- end
180
- # resource path
181
- local_var_path = '/order/orders/{order_id}'.sub('{' + 'order_id' + '}', order_id.to_s)
182
-
183
- # query parameters
184
- query_params = {}
185
-
186
- # header parameters
187
- header_params = {}
188
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
189
- # HTTP header 'Accept' (if needed)
190
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
191
- # HTTP header 'Content-Type'
192
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
193
-
194
- # form parameters
195
- form_params = {}
196
-
197
- # http body (model)
198
- post_body = nil
199
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
200
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
201
- :header_params => header_params,
202
- :query_params => query_params,
203
- :form_params => form_params,
204
- :body => post_body,
205
- :auth_names => auth_names)
206
- if @api_client.config.debugging
207
- @api_client.config.logger.debug "API called: OrderApi#delete_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
208
- end
209
- return data, status_code, headers
210
- end
211
- # Duplicate an order
212
- # Perform a duplicate of the specified order_id and return a new order located in Accounts Receivable.
213
- # @param order_id The order id to duplicate.
214
- # @param [Hash] opts the optional parameters
215
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
216
- # @return [OrderResponse]
217
- def duplicate_order(order_id, opts = {})
218
- data, _status_code, _headers = duplicate_order_with_http_info(order_id, opts)
219
- data
220
- end
221
-
222
- # Duplicate an order
223
- # Perform a duplicate of the specified order_id and return a new order located in Accounts Receivable.
224
- # @param order_id The order id to duplicate.
225
- # @param [Hash] opts the optional parameters
226
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
227
- # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
228
- def duplicate_order_with_http_info(order_id, opts = {})
229
- if @api_client.config.debugging
230
- @api_client.config.logger.debug 'Calling API: OrderApi.duplicate_order ...'
231
- end
232
- # verify the required parameter 'order_id' is set
233
- if @api_client.config.client_side_validation && order_id.nil?
234
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.duplicate_order"
235
- end
236
- # resource path
237
- local_var_path = '/order/orders/{order_id}/duplicate'.sub('{' + 'order_id' + '}', order_id.to_s)
238
-
239
- # query parameters
240
- query_params = {}
241
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
242
-
243
- # header parameters
244
- header_params = {}
245
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
246
- # HTTP header 'Accept' (if needed)
247
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
248
- # HTTP header 'Content-Type'
249
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
250
-
251
- # form parameters
252
- form_params = {}
253
-
254
- # http body (model)
255
- post_body = nil
256
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
257
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
258
- :header_params => header_params,
259
- :query_params => query_params,
260
- :form_params => form_params,
261
- :body => post_body,
262
- :auth_names => auth_names,
263
- :return_type => 'OrderResponse')
264
- if @api_client.config.debugging
265
- @api_client.config.logger.debug "API called: OrderApi#duplicate_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
266
- end
267
- return data, status_code, headers
268
- end
269
- # Format order
270
- # Format the order for display at text or html
271
- # @param order_id The order id to format
272
- # @param format_options Format options
273
- # @param [Hash] opts the optional parameters
274
- # @return [OrderFormatResponse]
275
- def format(order_id, format_options, opts = {})
276
- data, _status_code, _headers = format_with_http_info(order_id, format_options, opts)
277
- data
278
- end
279
-
280
- # Format order
281
- # Format the order for display at text or html
282
- # @param order_id The order id to format
283
- # @param format_options Format options
284
- # @param [Hash] opts the optional parameters
285
- # @return [Array<(OrderFormatResponse, Fixnum, Hash)>] OrderFormatResponse data, response status code and response headers
286
- def format_with_http_info(order_id, format_options, opts = {})
287
- if @api_client.config.debugging
288
- @api_client.config.logger.debug 'Calling API: OrderApi.format ...'
289
- end
290
- # verify the required parameter 'order_id' is set
291
- if @api_client.config.client_side_validation && order_id.nil?
292
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.format"
293
- end
294
- # verify the required parameter 'format_options' is set
295
- if @api_client.config.client_side_validation && format_options.nil?
296
- fail ArgumentError, "Missing the required parameter 'format_options' when calling OrderApi.format"
297
- end
298
- # resource path
299
- local_var_path = '/order/orders/{order_id}/format'.sub('{' + 'order_id' + '}', order_id.to_s)
300
-
301
- # query parameters
302
- query_params = {}
303
-
304
- # header parameters
305
- header_params = {}
306
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
307
- # HTTP header 'Accept' (if needed)
308
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
309
- # HTTP header 'Content-Type'
310
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
311
-
312
- # form parameters
313
- form_params = {}
314
-
315
- # http body (model)
316
- post_body = @api_client.object_to_http_body(format_options)
317
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
318
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
319
- :header_params => header_params,
320
- :query_params => query_params,
321
- :form_params => form_params,
322
- :body => post_body,
323
- :auth_names => auth_names,
324
- :return_type => 'OrderFormatResponse')
325
- if @api_client.config.debugging
326
- @api_client.config.logger.debug "API called: OrderApi#format\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
327
- end
328
- return data, status_code, headers
329
- end
330
- # Generate an invoice for this order.
331
- # The invoice PDF that is returned is base 64 encoded
332
- # @param order_id Order ID
333
- # @param [Hash] opts the optional parameters
334
- # @return [OrderInvoiceResponse]
335
- def generate_invoice(order_id, opts = {})
336
- data, _status_code, _headers = generate_invoice_with_http_info(order_id, opts)
337
- data
338
- end
339
-
340
- # Generate an invoice for this order.
341
- # The invoice PDF that is returned is base 64 encoded
342
- # @param order_id Order ID
343
- # @param [Hash] opts the optional parameters
344
- # @return [Array<(OrderInvoiceResponse, Fixnum, Hash)>] OrderInvoiceResponse data, response status code and response headers
345
- def generate_invoice_with_http_info(order_id, opts = {})
346
- if @api_client.config.debugging
347
- @api_client.config.logger.debug 'Calling API: OrderApi.generate_invoice ...'
348
- end
349
- # verify the required parameter 'order_id' is set
350
- if @api_client.config.client_side_validation && order_id.nil?
351
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.generate_invoice"
352
- end
353
- # resource path
354
- local_var_path = '/order/orders/{order_id}/invoice'.sub('{' + 'order_id' + '}', order_id.to_s)
355
-
356
- # query parameters
357
- query_params = {}
358
-
359
- # header parameters
360
- header_params = {}
361
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
362
- # HTTP header 'Accept' (if needed)
363
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
364
- # HTTP header 'Content-Type'
365
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
366
-
367
- # form parameters
368
- form_params = {}
369
-
370
- # http body (model)
371
- post_body = nil
372
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
373
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
374
- :header_params => header_params,
375
- :query_params => query_params,
376
- :form_params => form_params,
377
- :body => post_body,
378
- :auth_names => auth_names,
379
- :return_type => 'OrderInvoiceResponse')
380
- if @api_client.config.debugging
381
- @api_client.config.logger.debug "API called: OrderApi#generate_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
382
- end
383
- return data, status_code, headers
384
- end
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 The order id to generate a token for.
388
- # @param [Hash] opts the optional parameters
389
- # @return [OrderTokenResponse]
390
- def generate_order_token(order_id, opts = {})
391
- data, _status_code, _headers = generate_order_token_with_http_info(order_id, opts)
392
- data
393
- end
394
-
395
- # Generate an order token for a given order id
396
- # Retrieves a single order token for a given order id. The token can be used with the getOrderByToken API.
397
- # @param order_id The order id to generate a token for.
398
- # @param [Hash] opts the optional parameters
399
- # @return [Array<(OrderTokenResponse, Fixnum, Hash)>] OrderTokenResponse data, response status code and response headers
400
- def generate_order_token_with_http_info(order_id, opts = {})
401
- if @api_client.config.debugging
402
- @api_client.config.logger.debug 'Calling API: OrderApi.generate_order_token ...'
403
- end
404
- # verify the required parameter 'order_id' is set
405
- if @api_client.config.client_side_validation && order_id.nil?
406
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.generate_order_token"
407
- end
408
- # resource path
409
- local_var_path = '/order/orders/token/{order_id}'.sub('{' + 'order_id' + '}', order_id.to_s)
410
-
411
- # query parameters
412
- query_params = {}
413
-
414
- # header parameters
415
- header_params = {}
416
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
417
- # HTTP header 'Accept' (if needed)
418
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
419
- # HTTP header 'Content-Type'
420
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
421
-
422
- # form parameters
423
- form_params = {}
424
-
425
- # http body (model)
426
- post_body = nil
427
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
428
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
429
- :header_params => header_params,
430
- :query_params => query_params,
431
- :form_params => form_params,
432
- :body => post_body,
433
- :auth_names => auth_names,
434
- :return_type => 'OrderTokenResponse')
435
- if @api_client.config.debugging
436
- @api_client.config.logger.debug "API called: OrderApi#generate_order_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
437
- end
438
- return data, status_code, headers
439
- end
440
- # Generate a packing slip for this order across all distribution centers.
441
- # The packing slip PDF that is returned is base 64 encoded
442
- # @param order_id Order ID
443
- # @param [Hash] opts the optional parameters
444
- # @return [OrderPackingSlipResponse]
445
- def generate_packing_slip_all_dc(order_id, opts = {})
446
- data, _status_code, _headers = generate_packing_slip_all_dc_with_http_info(order_id, opts)
447
- data
448
- end
449
-
450
- # Generate a packing slip for this order across all distribution centers.
451
- # The packing slip PDF that is returned is base 64 encoded
452
- # @param order_id Order ID
453
- # @param [Hash] opts the optional parameters
454
- # @return [Array<(OrderPackingSlipResponse, Fixnum, Hash)>] OrderPackingSlipResponse data, response status code and response headers
455
- def generate_packing_slip_all_dc_with_http_info(order_id, opts = {})
456
- if @api_client.config.debugging
457
- @api_client.config.logger.debug 'Calling API: OrderApi.generate_packing_slip_all_dc ...'
458
- end
459
- # verify the required parameter 'order_id' is set
460
- if @api_client.config.client_side_validation && order_id.nil?
461
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.generate_packing_slip_all_dc"
462
- end
463
- # resource path
464
- local_var_path = '/order/orders/{order_id}/packing_slip'.sub('{' + 'order_id' + '}', order_id.to_s)
465
-
466
- # query parameters
467
- query_params = {}
468
-
469
- # header parameters
470
- header_params = {}
471
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
472
- # HTTP header 'Accept' (if needed)
473
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
474
- # HTTP header 'Content-Type'
475
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
476
-
477
- # form parameters
478
- form_params = {}
479
-
480
- # http body (model)
481
- post_body = nil
482
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
483
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
484
- :header_params => header_params,
485
- :query_params => query_params,
486
- :form_params => form_params,
487
- :body => post_body,
488
- :auth_names => auth_names,
489
- :return_type => 'OrderPackingSlipResponse')
490
- if @api_client.config.debugging
491
- @api_client.config.logger.debug "API called: OrderApi#generate_packing_slip_all_dc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
492
- end
493
- return data, status_code, headers
494
- end
495
- # Generate a packing slip for this order for the given distribution center.
496
- # The packing slip PDF that is returned is base 64 encoded
497
- # @param distribution_center_code Distribution center code
498
- # @param order_id Order ID
499
- # @param [Hash] opts the optional parameters
500
- # @return [OrderPackingSlipResponse]
501
- def generate_packing_slip_specific_dc(distribution_center_code, order_id, opts = {})
502
- data, _status_code, _headers = generate_packing_slip_specific_dc_with_http_info(distribution_center_code, order_id, opts)
503
- data
504
- end
505
-
506
- # Generate a packing slip for this order for the given distribution center.
507
- # The packing slip PDF that is returned is base 64 encoded
508
- # @param distribution_center_code Distribution center code
509
- # @param order_id Order ID
510
- # @param [Hash] opts the optional parameters
511
- # @return [Array<(OrderPackingSlipResponse, Fixnum, Hash)>] OrderPackingSlipResponse data, response status code and response headers
512
- def generate_packing_slip_specific_dc_with_http_info(distribution_center_code, order_id, opts = {})
513
- if @api_client.config.debugging
514
- @api_client.config.logger.debug 'Calling API: OrderApi.generate_packing_slip_specific_dc ...'
515
- end
516
- # verify the required parameter 'distribution_center_code' is set
517
- if @api_client.config.client_side_validation && distribution_center_code.nil?
518
- fail ArgumentError, "Missing the required parameter 'distribution_center_code' when calling OrderApi.generate_packing_slip_specific_dc"
519
- end
520
- # verify the required parameter 'order_id' is set
521
- if @api_client.config.client_side_validation && order_id.nil?
522
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.generate_packing_slip_specific_dc"
523
- end
524
- # resource path
525
- 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)
526
-
527
- # query parameters
528
- query_params = {}
529
-
530
- # header parameters
531
- header_params = {}
532
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
533
- # HTTP header 'Accept' (if needed)
534
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
535
- # HTTP header 'Content-Type'
536
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
537
-
538
- # form parameters
539
- form_params = {}
540
-
541
- # http body (model)
542
- post_body = nil
543
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
544
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
545
- :header_params => header_params,
546
- :query_params => query_params,
547
- :form_params => form_params,
548
- :body => post_body,
549
- :auth_names => auth_names,
550
- :return_type => 'OrderPackingSlipResponse')
551
- if @api_client.config.debugging
552
- @api_client.config.logger.debug "API called: OrderApi#generate_packing_slip_specific_dc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
553
- end
554
- return data, status_code, headers
555
- end
556
- # Retrieve A/R Retry Configuration
557
- # Retrieve A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.
558
- # @param [Hash] opts the optional parameters
559
- # @return [AccountsReceivableRetryConfigResponse]
560
- def get_accounts_receivable_retry_config(opts = {})
561
- data, _status_code, _headers = get_accounts_receivable_retry_config_with_http_info(opts)
562
- data
563
- end
564
-
565
- # Retrieve A/R Retry Configuration
566
- # Retrieve A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.
567
- # @param [Hash] opts the optional parameters
568
- # @return [Array<(AccountsReceivableRetryConfigResponse, Fixnum, Hash)>] AccountsReceivableRetryConfigResponse data, response status code and response headers
569
- def get_accounts_receivable_retry_config_with_http_info(opts = {})
570
- if @api_client.config.debugging
571
- @api_client.config.logger.debug 'Calling API: OrderApi.get_accounts_receivable_retry_config ...'
572
- end
573
- # resource path
574
- local_var_path = '/order/accountsReceivableRetryConfig'
575
-
576
- # query parameters
577
- query_params = {}
578
-
579
- # header parameters
580
- header_params = {}
581
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
582
- # HTTP header 'Accept' (if needed)
583
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
584
- # HTTP header 'Content-Type'
585
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
586
-
587
- # form parameters
588
- form_params = {}
589
-
590
- # http body (model)
591
- post_body = nil
592
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
593
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
594
- :header_params => header_params,
595
- :query_params => query_params,
596
- :form_params => form_params,
597
- :body => post_body,
598
- :auth_names => auth_names,
599
- :return_type => 'AccountsReceivableRetryConfigResponse')
600
- if @api_client.config.debugging
601
- @api_client.config.logger.debug "API called: OrderApi#get_accounts_receivable_retry_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
602
- end
603
- return data, status_code, headers
604
- end
605
- # Retrieve A/R Retry Statistics
606
- # Retrieve A/R Retry Statistics. This is primarily an internal API call. It is doubtful you would ever need to use it.
607
- # @param [Hash] opts the optional parameters
608
- # @option opts [String] :from
609
- # @option opts [String] :to
610
- # @return [AccountsReceivableRetryStatsResponse]
611
- def get_accounts_receivable_retry_stats(opts = {})
612
- data, _status_code, _headers = get_accounts_receivable_retry_stats_with_http_info(opts)
613
- data
614
- end
615
-
616
- # Retrieve A/R Retry Statistics
617
- # Retrieve A/R Retry Statistics. This is primarily an internal API call. It is doubtful you would ever need to use it.
618
- # @param [Hash] opts the optional parameters
619
- # @option opts [String] :from
620
- # @option opts [String] :to
621
- # @return [Array<(AccountsReceivableRetryStatsResponse, Fixnum, Hash)>] AccountsReceivableRetryStatsResponse data, response status code and response headers
622
- def get_accounts_receivable_retry_stats_with_http_info(opts = {})
623
- if @api_client.config.debugging
624
- @api_client.config.logger.debug 'Calling API: OrderApi.get_accounts_receivable_retry_stats ...'
625
- end
626
- # resource path
627
- local_var_path = '/order/accountsReceivableRetryConfig/stats'
628
-
629
- # query parameters
630
- query_params = {}
631
- query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
632
- query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
633
-
634
- # header parameters
635
- header_params = {}
636
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
637
- # HTTP header 'Accept' (if needed)
638
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
639
- # HTTP header 'Content-Type'
640
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
641
-
642
- # form parameters
643
- form_params = {}
644
-
645
- # http body (model)
646
- post_body = nil
647
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
648
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
649
- :header_params => header_params,
650
- :query_params => query_params,
651
- :form_params => form_params,
652
- :body => post_body,
653
- :auth_names => auth_names,
654
- :return_type => 'AccountsReceivableRetryStatsResponse')
655
- if @api_client.config.debugging
656
- @api_client.config.logger.debug "API called: OrderApi#get_accounts_receivable_retry_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
657
- end
658
- return data, status_code, headers
659
- end
660
- # Retrieve an order
661
- # Retrieves a single order using the specified order id.
662
- # @param order_id The order id to retrieve.
663
- # @param [Hash] opts the optional parameters
664
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
665
- # @return [OrderResponse]
666
- def get_order(order_id, opts = {})
667
- data, _status_code, _headers = get_order_with_http_info(order_id, opts)
668
- data
669
- end
670
-
671
- # Retrieve an order
672
- # Retrieves a single order using the specified order id.
673
- # @param order_id The order id to retrieve.
674
- # @param [Hash] opts the optional parameters
675
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
676
- # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
677
- def get_order_with_http_info(order_id, opts = {})
678
- if @api_client.config.debugging
679
- @api_client.config.logger.debug 'Calling API: OrderApi.get_order ...'
680
- end
681
- # verify the required parameter 'order_id' is set
682
- if @api_client.config.client_side_validation && order_id.nil?
683
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.get_order"
684
- end
685
- # resource path
686
- local_var_path = '/order/orders/{order_id}'.sub('{' + 'order_id' + '}', order_id.to_s)
687
-
688
- # query parameters
689
- query_params = {}
690
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
691
-
692
- # header parameters
693
- header_params = {}
694
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
695
- # HTTP header 'Accept' (if needed)
696
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
697
- # HTTP header 'Content-Type'
698
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
699
-
700
- # form parameters
701
- form_params = {}
702
-
703
- # http body (model)
704
- post_body = nil
705
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
706
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
707
- :header_params => header_params,
708
- :query_params => query_params,
709
- :form_params => form_params,
710
- :body => post_body,
711
- :auth_names => auth_names,
712
- :return_type => 'OrderResponse')
713
- if @api_client.config.debugging
714
- @api_client.config.logger.debug "API called: OrderApi#get_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
715
- end
716
- return data, status_code, headers
717
- end
718
- # Retrieve an order using a token
719
- # Retrieves a single order using the specified order token.
720
- # @param order_by_token_query Order by token query
721
- # @param [Hash] opts the optional parameters
722
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
723
- # @return [OrderResponse]
724
- def get_order_by_token(order_by_token_query, opts = {})
725
- data, _status_code, _headers = get_order_by_token_with_http_info(order_by_token_query, opts)
726
- data
727
- end
728
-
729
- # Retrieve an order using a token
730
- # Retrieves a single order using the specified order token.
731
- # @param order_by_token_query Order by token query
732
- # @param [Hash] opts the optional parameters
733
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
734
- # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
735
- def get_order_by_token_with_http_info(order_by_token_query, opts = {})
736
- if @api_client.config.debugging
737
- @api_client.config.logger.debug 'Calling API: OrderApi.get_order_by_token ...'
738
- end
739
- # verify the required parameter 'order_by_token_query' is set
740
- if @api_client.config.client_side_validation && order_by_token_query.nil?
741
- fail ArgumentError, "Missing the required parameter 'order_by_token_query' when calling OrderApi.get_order_by_token"
742
- end
743
- # resource path
744
- local_var_path = '/order/orders/token'
745
-
746
- # query parameters
747
- query_params = {}
748
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
749
-
750
- # header parameters
751
- header_params = {}
752
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
753
- # HTTP header 'Accept' (if needed)
754
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
755
- # HTTP header 'Content-Type'
756
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
757
-
758
- # form parameters
759
- form_params = {}
760
-
761
- # http body (model)
762
- post_body = @api_client.object_to_http_body(order_by_token_query)
763
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
764
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
765
- :header_params => header_params,
766
- :query_params => query_params,
767
- :form_params => form_params,
768
- :body => post_body,
769
- :auth_names => auth_names,
770
- :return_type => 'OrderResponse')
771
- if @api_client.config.debugging
772
- @api_client.config.logger.debug "API called: OrderApi#get_order_by_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
773
- end
774
- return data, status_code, headers
775
- end
776
- # Retrieve EDI documents associated with this order.
777
- # Retrieve EDI documents associated with this order.
778
- # @param order_id The order id to retrieve EDI documents for.
779
- # @param [Hash] opts the optional parameters
780
- # @return [OrderEdiDocumentsResponse]
781
- def get_order_edi_documents(order_id, opts = {})
782
- data, _status_code, _headers = get_order_edi_documents_with_http_info(order_id, opts)
783
- data
784
- end
785
-
786
- # Retrieve EDI documents associated with this order.
787
- # Retrieve EDI documents associated with this order.
788
- # @param order_id The order id to retrieve EDI documents for.
789
- # @param [Hash] opts the optional parameters
790
- # @return [Array<(OrderEdiDocumentsResponse, Fixnum, Hash)>] OrderEdiDocumentsResponse data, response status code and response headers
791
- def get_order_edi_documents_with_http_info(order_id, opts = {})
792
- if @api_client.config.debugging
793
- @api_client.config.logger.debug 'Calling API: OrderApi.get_order_edi_documents ...'
794
- end
795
- # verify the required parameter 'order_id' is set
796
- if @api_client.config.client_side_validation && order_id.nil?
797
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.get_order_edi_documents"
798
- end
799
- # resource path
800
- local_var_path = '/order/orders/{order_id}/edi'.sub('{' + 'order_id' + '}', order_id.to_s)
801
-
802
- # query parameters
803
- query_params = {}
804
-
805
- # header parameters
806
- header_params = {}
807
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
808
- # HTTP header 'Accept' (if needed)
809
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
810
- # HTTP header 'Content-Type'
811
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
812
-
813
- # form parameters
814
- form_params = {}
815
-
816
- # http body (model)
817
- post_body = nil
818
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
819
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
820
- :header_params => header_params,
821
- :query_params => query_params,
822
- :form_params => form_params,
823
- :body => post_body,
824
- :auth_names => auth_names,
825
- :return_type => 'OrderEdiDocumentsResponse')
826
- if @api_client.config.debugging
827
- @api_client.config.logger.debug "API called: OrderApi#get_order_edi_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
828
- end
829
- return data, status_code, headers
830
- end
831
- # Retrieve orders
832
- # 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.
833
- # @param [Hash] opts the optional parameters
834
- # @option opts [String] :order_id Order Id
835
- # @option opts [String] :payment_method Payment Method
836
- # @option opts [String] :company Company
837
- # @option opts [String] :first_name First Name
838
- # @option opts [String] :last_name Last Name
839
- # @option opts [String] :city City
840
- # @option opts [String] :state_region State/Region
841
- # @option opts [String] :postal_code Postal Code
842
- # @option opts [String] :country_code Country Code (ISO-3166 two letter)
843
- # @option opts [String] :phone Phone
844
- # @option opts [String] :email Email
845
- # @option opts [String] :cc_email CC Email
846
- # @option opts [Float] :total Total
847
- # @option opts [String] :screen_branding_theme_code Screen Branding Theme Code
848
- # @option opts [String] :storefront_host_name StoreFront Host Name
849
- # @option opts [String] :creation_date_begin Creation Date Begin
850
- # @option opts [String] :creation_date_end Creation Date End
851
- # @option opts [String] :payment_date_begin Payment Date Begin
852
- # @option opts [String] :payment_date_end Payment Date End
853
- # @option opts [String] :shipment_date_begin Shipment Date Begin
854
- # @option opts [String] :shipment_date_end Shipment Date End
855
- # @option opts [String] :rma RMA
856
- # @option opts [String] :purchase_order_number Purchase Order Number
857
- # @option opts [String] :item_id Item Id
858
- # @option opts [String] :current_stage Current Stage
859
- # @option opts [String] :channel_partner_code Channel Partner Code
860
- # @option opts [String] :channel_partner_order_id Channel Partner Order ID
861
- # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200) (default to 100)
862
- # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
863
- # @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.
864
- # @option opts [String] :_expand The object expansion to perform on the result.
865
- # @return [OrdersResponse]
866
- def get_orders(opts = {})
867
- data, _status_code, _headers = get_orders_with_http_info(opts)
868
- data
869
- end
870
-
871
- # Retrieve orders
872
- # 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.
873
- # @param [Hash] opts the optional parameters
874
- # @option opts [String] :order_id Order Id
875
- # @option opts [String] :payment_method Payment Method
876
- # @option opts [String] :company Company
877
- # @option opts [String] :first_name First Name
878
- # @option opts [String] :last_name Last Name
879
- # @option opts [String] :city City
880
- # @option opts [String] :state_region State/Region
881
- # @option opts [String] :postal_code Postal Code
882
- # @option opts [String] :country_code Country Code (ISO-3166 two letter)
883
- # @option opts [String] :phone Phone
884
- # @option opts [String] :email Email
885
- # @option opts [String] :cc_email CC Email
886
- # @option opts [Float] :total Total
887
- # @option opts [String] :screen_branding_theme_code Screen Branding Theme Code
888
- # @option opts [String] :storefront_host_name StoreFront Host Name
889
- # @option opts [String] :creation_date_begin Creation Date Begin
890
- # @option opts [String] :creation_date_end Creation Date End
891
- # @option opts [String] :payment_date_begin Payment Date Begin
892
- # @option opts [String] :payment_date_end Payment Date End
893
- # @option opts [String] :shipment_date_begin Shipment Date Begin
894
- # @option opts [String] :shipment_date_end Shipment Date End
895
- # @option opts [String] :rma RMA
896
- # @option opts [String] :purchase_order_number Purchase Order Number
897
- # @option opts [String] :item_id Item Id
898
- # @option opts [String] :current_stage Current Stage
899
- # @option opts [String] :channel_partner_code Channel Partner Code
900
- # @option opts [String] :channel_partner_order_id Channel Partner Order ID
901
- # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200)
902
- # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index.
903
- # @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.
904
- # @option opts [String] :_expand The object expansion to perform on the result.
905
- # @return [Array<(OrdersResponse, Fixnum, Hash)>] OrdersResponse data, response status code and response headers
906
- def get_orders_with_http_info(opts = {})
907
- if @api_client.config.debugging
908
- @api_client.config.logger.debug 'Calling API: OrderApi.get_orders ...'
909
- end
910
- # resource path
911
- local_var_path = '/order/orders'
912
-
913
- # query parameters
914
- query_params = {}
915
- query_params[:'order_id'] = opts[:'order_id'] if !opts[:'order_id'].nil?
916
- query_params[:'payment_method'] = opts[:'payment_method'] if !opts[:'payment_method'].nil?
917
- query_params[:'company'] = opts[:'company'] if !opts[:'company'].nil?
918
- query_params[:'first_name'] = opts[:'first_name'] if !opts[:'first_name'].nil?
919
- query_params[:'last_name'] = opts[:'last_name'] if !opts[:'last_name'].nil?
920
- query_params[:'city'] = opts[:'city'] if !opts[:'city'].nil?
921
- query_params[:'state_region'] = opts[:'state_region'] if !opts[:'state_region'].nil?
922
- query_params[:'postal_code'] = opts[:'postal_code'] if !opts[:'postal_code'].nil?
923
- query_params[:'country_code'] = opts[:'country_code'] if !opts[:'country_code'].nil?
924
- query_params[:'phone'] = opts[:'phone'] if !opts[:'phone'].nil?
925
- query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
926
- query_params[:'cc_email'] = opts[:'cc_email'] if !opts[:'cc_email'].nil?
927
- query_params[:'total'] = opts[:'total'] if !opts[:'total'].nil?
928
- query_params[:'screen_branding_theme_code'] = opts[:'screen_branding_theme_code'] if !opts[:'screen_branding_theme_code'].nil?
929
- query_params[:'storefront_host_name'] = opts[:'storefront_host_name'] if !opts[:'storefront_host_name'].nil?
930
- query_params[:'creation_date_begin'] = opts[:'creation_date_begin'] if !opts[:'creation_date_begin'].nil?
931
- query_params[:'creation_date_end'] = opts[:'creation_date_end'] if !opts[:'creation_date_end'].nil?
932
- query_params[:'payment_date_begin'] = opts[:'payment_date_begin'] if !opts[:'payment_date_begin'].nil?
933
- query_params[:'payment_date_end'] = opts[:'payment_date_end'] if !opts[:'payment_date_end'].nil?
934
- query_params[:'shipment_date_begin'] = opts[:'shipment_date_begin'] if !opts[:'shipment_date_begin'].nil?
935
- query_params[:'shipment_date_end'] = opts[:'shipment_date_end'] if !opts[:'shipment_date_end'].nil?
936
- query_params[:'rma'] = opts[:'rma'] if !opts[:'rma'].nil?
937
- query_params[:'purchase_order_number'] = opts[:'purchase_order_number'] if !opts[:'purchase_order_number'].nil?
938
- query_params[:'item_id'] = opts[:'item_id'] if !opts[:'item_id'].nil?
939
- query_params[:'current_stage'] = opts[:'current_stage'] if !opts[:'current_stage'].nil?
940
- query_params[:'channel_partner_code'] = opts[:'channel_partner_code'] if !opts[:'channel_partner_code'].nil?
941
- query_params[:'channel_partner_order_id'] = opts[:'channel_partner_order_id'] if !opts[:'channel_partner_order_id'].nil?
942
- query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
943
- query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
944
- query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
945
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
946
-
947
- # header parameters
948
- header_params = {}
949
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
950
- # HTTP header 'Accept' (if needed)
951
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
952
- # HTTP header 'Content-Type'
953
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
954
-
955
- # form parameters
956
- form_params = {}
957
-
958
- # http body (model)
959
- post_body = nil
960
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
961
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
962
- :header_params => header_params,
963
- :query_params => query_params,
964
- :form_params => form_params,
965
- :body => post_body,
966
- :auth_names => auth_names,
967
- :return_type => 'OrdersResponse')
968
- if @api_client.config.debugging
969
- @api_client.config.logger.debug "API called: OrderApi#get_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
970
- end
971
- return data, status_code, headers
972
- end
973
- # Retrieve order batch
974
- # 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.
975
- # @param order_batch Order batch
976
- # @param [Hash] opts the optional parameters
977
- # @option opts [String] :_expand The object expansion to perform on the result.
978
- # @return [OrdersResponse]
979
- def get_orders_batch(order_batch, opts = {})
980
- data, _status_code, _headers = get_orders_batch_with_http_info(order_batch, opts)
981
- data
982
- end
983
-
984
- # Retrieve order batch
985
- # 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.
986
- # @param order_batch Order batch
987
- # @param [Hash] opts the optional parameters
988
- # @option opts [String] :_expand The object expansion to perform on the result.
989
- # @return [Array<(OrdersResponse, Fixnum, Hash)>] OrdersResponse data, response status code and response headers
990
- def get_orders_batch_with_http_info(order_batch, opts = {})
991
- if @api_client.config.debugging
992
- @api_client.config.logger.debug 'Calling API: OrderApi.get_orders_batch ...'
993
- end
994
- # verify the required parameter 'order_batch' is set
995
- if @api_client.config.client_side_validation && order_batch.nil?
996
- fail ArgumentError, "Missing the required parameter 'order_batch' when calling OrderApi.get_orders_batch"
997
- end
998
- # resource path
999
- local_var_path = '/order/orders/batch'
1000
-
1001
- # query parameters
1002
- query_params = {}
1003
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1004
-
1005
- # header parameters
1006
- header_params = {}
1007
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1008
- # HTTP header 'Accept' (if needed)
1009
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1010
- # HTTP header 'Content-Type'
1011
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1012
-
1013
- # form parameters
1014
- form_params = {}
1015
-
1016
- # http body (model)
1017
- post_body = @api_client.object_to_http_body(order_batch)
1018
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1019
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1020
- :header_params => header_params,
1021
- :query_params => query_params,
1022
- :form_params => form_params,
1023
- :body => post_body,
1024
- :auth_names => auth_names,
1025
- :return_type => 'OrdersResponse')
1026
- if @api_client.config.debugging
1027
- @api_client.config.logger.debug "API called: OrderApi#get_orders_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1028
- end
1029
- return data, status_code, headers
1030
- end
1031
- # Retrieve orders by query
1032
- # 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.
1033
- # @param order_query Order query
1034
- # @param [Hash] opts the optional parameters
1035
- # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200) (default to 100)
1036
- # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
1037
- # @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.
1038
- # @option opts [String] :_expand The object expansion to perform on the result.
1039
- # @return [OrdersResponse]
1040
- def get_orders_by_query(order_query, opts = {})
1041
- data, _status_code, _headers = get_orders_by_query_with_http_info(order_query, opts)
1042
- data
1043
- end
1044
-
1045
- # Retrieve orders by query
1046
- # 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.
1047
- # @param order_query Order query
1048
- # @param [Hash] opts the optional parameters
1049
- # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200)
1050
- # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index.
1051
- # @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.
1052
- # @option opts [String] :_expand The object expansion to perform on the result.
1053
- # @return [Array<(OrdersResponse, Fixnum, Hash)>] OrdersResponse data, response status code and response headers
1054
- def get_orders_by_query_with_http_info(order_query, opts = {})
1055
- if @api_client.config.debugging
1056
- @api_client.config.logger.debug 'Calling API: OrderApi.get_orders_by_query ...'
1057
- end
1058
- # verify the required parameter 'order_query' is set
1059
- if @api_client.config.client_side_validation && order_query.nil?
1060
- fail ArgumentError, "Missing the required parameter 'order_query' when calling OrderApi.get_orders_by_query"
1061
- end
1062
- # resource path
1063
- local_var_path = '/order/orders/query'
1064
-
1065
- # query parameters
1066
- query_params = {}
1067
- query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
1068
- query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
1069
- query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
1070
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1071
-
1072
- # header parameters
1073
- header_params = {}
1074
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1075
- # HTTP header 'Accept' (if needed)
1076
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1077
- # HTTP header 'Content-Type'
1078
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1079
-
1080
- # form parameters
1081
- form_params = {}
1082
-
1083
- # http body (model)
1084
- post_body = @api_client.object_to_http_body(order_query)
1085
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1086
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1087
- :header_params => header_params,
1088
- :query_params => query_params,
1089
- :form_params => form_params,
1090
- :body => post_body,
1091
- :auth_names => auth_names,
1092
- :return_type => 'OrdersResponse')
1093
- if @api_client.config.debugging
1094
- @api_client.config.logger.debug "API called: OrderApi#get_orders_by_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1095
- end
1096
- return data, status_code, headers
1097
- end
1098
- # Insert an order
1099
- # 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.
1100
- # @param order Order to insert
1101
- # @param [Hash] opts the optional parameters
1102
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1103
- # @return [OrderResponse]
1104
- def insert_order(order, opts = {})
1105
- data, _status_code, _headers = insert_order_with_http_info(order, opts)
1106
- data
1107
- end
1108
-
1109
- # Insert an order
1110
- # 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.
1111
- # @param order Order to insert
1112
- # @param [Hash] opts the optional parameters
1113
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1114
- # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
1115
- def insert_order_with_http_info(order, opts = {})
1116
- if @api_client.config.debugging
1117
- @api_client.config.logger.debug 'Calling API: OrderApi.insert_order ...'
1118
- end
1119
- # verify the required parameter 'order' is set
1120
- if @api_client.config.client_side_validation && order.nil?
1121
- fail ArgumentError, "Missing the required parameter 'order' when calling OrderApi.insert_order"
1122
- end
1123
- # resource path
1124
- local_var_path = '/order/orders'
1125
-
1126
- # query parameters
1127
- query_params = {}
1128
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1129
-
1130
- # header parameters
1131
- header_params = {}
1132
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1133
- # HTTP header 'Accept' (if needed)
1134
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1135
- # HTTP header 'Content-Type'
1136
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1137
-
1138
- # form parameters
1139
- form_params = {}
1140
-
1141
- # http body (model)
1142
- post_body = @api_client.object_to_http_body(order)
1143
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1144
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1145
- :header_params => header_params,
1146
- :query_params => query_params,
1147
- :form_params => form_params,
1148
- :body => post_body,
1149
- :auth_names => auth_names,
1150
- :return_type => 'OrderResponse')
1151
- if @api_client.config.debugging
1152
- @api_client.config.logger.debug "API called: OrderApi#insert_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1153
- end
1154
- return data, status_code, headers
1155
- end
1156
- # Determine if an order can be refunded
1157
- # Determine if an order can be refunded based upon payment method and age
1158
- # @param order_id The order id to check for refundable order.
1159
- # @param [Hash] opts the optional parameters
1160
- # @return [OrderRefundableResponse]
1161
- def is_refundable_order(order_id, opts = {})
1162
- data, _status_code, _headers = is_refundable_order_with_http_info(order_id, opts)
1163
- data
1164
- end
1165
-
1166
- # Determine if an order can be refunded
1167
- # Determine if an order can be refunded based upon payment method and age
1168
- # @param order_id The order id to check for refundable order.
1169
- # @param [Hash] opts the optional parameters
1170
- # @return [Array<(OrderRefundableResponse, Fixnum, Hash)>] OrderRefundableResponse data, response status code and response headers
1171
- def is_refundable_order_with_http_info(order_id, opts = {})
1172
- if @api_client.config.debugging
1173
- @api_client.config.logger.debug 'Calling API: OrderApi.is_refundable_order ...'
1174
- end
1175
- # verify the required parameter 'order_id' is set
1176
- if @api_client.config.client_side_validation && order_id.nil?
1177
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.is_refundable_order"
1178
- end
1179
- # resource path
1180
- local_var_path = '/order/orders/{order_id}/refundable'.sub('{' + 'order_id' + '}', order_id.to_s)
1181
-
1182
- # query parameters
1183
- query_params = {}
1184
-
1185
- # header parameters
1186
- header_params = {}
1187
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1188
- # HTTP header 'Accept' (if needed)
1189
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1190
- # HTTP header 'Content-Type'
1191
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1192
-
1193
- # form parameters
1194
- form_params = {}
1195
-
1196
- # http body (model)
1197
- post_body = nil
1198
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1199
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1200
- :header_params => header_params,
1201
- :query_params => query_params,
1202
- :form_params => form_params,
1203
- :body => post_body,
1204
- :auth_names => auth_names,
1205
- :return_type => 'OrderRefundableResponse')
1206
- if @api_client.config.debugging
1207
- @api_client.config.logger.debug "API called: OrderApi#is_refundable_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1208
- end
1209
- return data, status_code, headers
1210
- end
1211
- # Process payment
1212
- # Process payment on order
1213
- # @param order_id The order id to process payment on
1214
- # @param process_payment_request Process payment parameters
1215
- # @param [Hash] opts the optional parameters
1216
- # @return [OrderProcessPaymentResponse]
1217
- def process_payment(order_id, process_payment_request, opts = {})
1218
- data, _status_code, _headers = process_payment_with_http_info(order_id, process_payment_request, opts)
1219
- data
1220
- end
1221
-
1222
- # Process payment
1223
- # Process payment on order
1224
- # @param order_id The order id to process payment on
1225
- # @param process_payment_request Process payment parameters
1226
- # @param [Hash] opts the optional parameters
1227
- # @return [Array<(OrderProcessPaymentResponse, Fixnum, Hash)>] OrderProcessPaymentResponse data, response status code and response headers
1228
- def process_payment_with_http_info(order_id, process_payment_request, opts = {})
1229
- if @api_client.config.debugging
1230
- @api_client.config.logger.debug 'Calling API: OrderApi.process_payment ...'
1231
- end
1232
- # verify the required parameter 'order_id' is set
1233
- if @api_client.config.client_side_validation && order_id.nil?
1234
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.process_payment"
1235
- end
1236
- # verify the required parameter 'process_payment_request' is set
1237
- if @api_client.config.client_side_validation && process_payment_request.nil?
1238
- fail ArgumentError, "Missing the required parameter 'process_payment_request' when calling OrderApi.process_payment"
1239
- end
1240
- # resource path
1241
- local_var_path = '/order/orders/{order_id}/process_payment'.sub('{' + 'order_id' + '}', order_id.to_s)
1242
-
1243
- # query parameters
1244
- query_params = {}
1245
-
1246
- # header parameters
1247
- header_params = {}
1248
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1249
- # HTTP header 'Accept' (if needed)
1250
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1251
- # HTTP header 'Content-Type'
1252
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1253
-
1254
- # form parameters
1255
- form_params = {}
1256
-
1257
- # http body (model)
1258
- post_body = @api_client.object_to_http_body(process_payment_request)
1259
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1260
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1261
- :header_params => header_params,
1262
- :query_params => query_params,
1263
- :form_params => form_params,
1264
- :body => post_body,
1265
- :auth_names => auth_names,
1266
- :return_type => 'OrderProcessPaymentResponse')
1267
- if @api_client.config.debugging
1268
- @api_client.config.logger.debug "API called: OrderApi#process_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1269
- end
1270
- return data, status_code, headers
1271
- end
1272
- # Refund an order
1273
- # Perform a refund operation on an order and then update the order if successful
1274
- # @param order Order to refund
1275
- # @param order_id The order id to refund.
1276
- # @param [Hash] opts the optional parameters
1277
- # @option opts [BOOLEAN] :reject_after_refund Reject order after refund (default to false)
1278
- # @option opts [BOOLEAN] :skip_customer_notification Skip customer email notification (default to false)
1279
- # @option opts [BOOLEAN] :auto_order_cancel Cancel associated auto orders (default to false)
1280
- # @option opts [BOOLEAN] :manual_refund Consider a manual refund done externally (default to false)
1281
- # @option opts [BOOLEAN] :reverse_affiliate_transactions Reverse affiliate transactions (default to true)
1282
- # @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)
1283
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1284
- # @return [OrderResponse]
1285
- def refund_order(order, order_id, opts = {})
1286
- data, _status_code, _headers = refund_order_with_http_info(order, order_id, opts)
1287
- data
1288
- end
1289
-
1290
- # Refund an order
1291
- # Perform a refund operation on an order and then update the order if successful
1292
- # @param order Order to refund
1293
- # @param order_id The order id to refund.
1294
- # @param [Hash] opts the optional parameters
1295
- # @option opts [BOOLEAN] :reject_after_refund Reject order after refund
1296
- # @option opts [BOOLEAN] :skip_customer_notification Skip customer email notification
1297
- # @option opts [BOOLEAN] :auto_order_cancel Cancel associated auto orders
1298
- # @option opts [BOOLEAN] :manual_refund Consider a manual refund done externally
1299
- # @option opts [BOOLEAN] :reverse_affiliate_transactions Reverse affiliate transactions
1300
- # @option opts [BOOLEAN] :issue_store_credit Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
1301
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1302
- # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
1303
- def refund_order_with_http_info(order, order_id, opts = {})
1304
- if @api_client.config.debugging
1305
- @api_client.config.logger.debug 'Calling API: OrderApi.refund_order ...'
1306
- end
1307
- # verify the required parameter 'order' is set
1308
- if @api_client.config.client_side_validation && order.nil?
1309
- fail ArgumentError, "Missing the required parameter 'order' when calling OrderApi.refund_order"
1310
- end
1311
- # verify the required parameter 'order_id' is set
1312
- if @api_client.config.client_side_validation && order_id.nil?
1313
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.refund_order"
1314
- end
1315
- # resource path
1316
- local_var_path = '/order/orders/{order_id}/refund'.sub('{' + 'order_id' + '}', order_id.to_s)
1317
-
1318
- # query parameters
1319
- query_params = {}
1320
- query_params[:'reject_after_refund'] = opts[:'reject_after_refund'] if !opts[:'reject_after_refund'].nil?
1321
- query_params[:'skip_customer_notification'] = opts[:'skip_customer_notification'] if !opts[:'skip_customer_notification'].nil?
1322
- query_params[:'auto_order_cancel'] = opts[:'auto_order_cancel'] if !opts[:'auto_order_cancel'].nil?
1323
- query_params[:'manual_refund'] = opts[:'manual_refund'] if !opts[:'manual_refund'].nil?
1324
- query_params[:'reverse_affiliate_transactions'] = opts[:'reverse_affiliate_transactions'] if !opts[:'reverse_affiliate_transactions'].nil?
1325
- query_params[:'issue_store_credit'] = opts[:'issue_store_credit'] if !opts[:'issue_store_credit'].nil?
1326
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1327
-
1328
- # header parameters
1329
- header_params = {}
1330
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1331
- # HTTP header 'Accept' (if needed)
1332
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1333
- # HTTP header 'Content-Type'
1334
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1335
-
1336
- # form parameters
1337
- form_params = {}
1338
-
1339
- # http body (model)
1340
- post_body = @api_client.object_to_http_body(order)
1341
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1342
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1343
- :header_params => header_params,
1344
- :query_params => query_params,
1345
- :form_params => form_params,
1346
- :body => post_body,
1347
- :auth_names => auth_names,
1348
- :return_type => 'OrderResponse')
1349
- if @api_client.config.debugging
1350
- @api_client.config.logger.debug "API called: OrderApi#refund_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1351
- end
1352
- return data, status_code, headers
1353
- end
1354
- # Replacement order
1355
- # Create a replacement order based upon a previous order
1356
- # @param order_id The order id to generate a replacement for.
1357
- # @param replacement Replacement order details
1358
- # @param [Hash] opts the optional parameters
1359
- # @return [OrderReplacementResponse]
1360
- def replacement(order_id, replacement, opts = {})
1361
- data, _status_code, _headers = replacement_with_http_info(order_id, replacement, opts)
1362
- data
1363
- end
1364
-
1365
- # Replacement order
1366
- # Create a replacement order based upon a previous order
1367
- # @param order_id The order id to generate a replacement for.
1368
- # @param replacement Replacement order details
1369
- # @param [Hash] opts the optional parameters
1370
- # @return [Array<(OrderReplacementResponse, Fixnum, Hash)>] OrderReplacementResponse data, response status code and response headers
1371
- def replacement_with_http_info(order_id, replacement, opts = {})
1372
- if @api_client.config.debugging
1373
- @api_client.config.logger.debug 'Calling API: OrderApi.replacement ...'
1374
- end
1375
- # verify the required parameter 'order_id' is set
1376
- if @api_client.config.client_side_validation && order_id.nil?
1377
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.replacement"
1378
- end
1379
- # verify the required parameter 'replacement' is set
1380
- if @api_client.config.client_side_validation && replacement.nil?
1381
- fail ArgumentError, "Missing the required parameter 'replacement' when calling OrderApi.replacement"
1382
- end
1383
- # resource path
1384
- local_var_path = '/order/orders/{order_id}/replacement'.sub('{' + 'order_id' + '}', order_id.to_s)
1385
-
1386
- # query parameters
1387
- query_params = {}
1388
-
1389
- # header parameters
1390
- header_params = {}
1391
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1392
- # HTTP header 'Accept' (if needed)
1393
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1394
- # HTTP header 'Content-Type'
1395
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1396
-
1397
- # form parameters
1398
- form_params = {}
1399
-
1400
- # http body (model)
1401
- post_body = @api_client.object_to_http_body(replacement)
1402
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1403
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1404
- :header_params => header_params,
1405
- :query_params => query_params,
1406
- :form_params => form_params,
1407
- :body => post_body,
1408
- :auth_names => auth_names,
1409
- :return_type => 'OrderReplacementResponse')
1410
- if @api_client.config.debugging
1411
- @api_client.config.logger.debug "API called: OrderApi#replacement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1412
- end
1413
- return data, status_code, headers
1414
- end
1415
- # Resend receipt
1416
- # Resend the receipt for an order on the UltraCart account.
1417
- # @param order_id The order id to resend the receipt for.
1418
- # @param [Hash] opts the optional parameters
1419
- # @return [BaseResponse]
1420
- def resend_receipt(order_id, opts = {})
1421
- data, _status_code, _headers = resend_receipt_with_http_info(order_id, opts)
1422
- data
1423
- end
1424
-
1425
- # Resend receipt
1426
- # Resend the receipt for an order on the UltraCart account.
1427
- # @param order_id The order id to resend the receipt for.
1428
- # @param [Hash] opts the optional parameters
1429
- # @return [Array<(BaseResponse, Fixnum, Hash)>] BaseResponse data, response status code and response headers
1430
- def resend_receipt_with_http_info(order_id, opts = {})
1431
- if @api_client.config.debugging
1432
- @api_client.config.logger.debug 'Calling API: OrderApi.resend_receipt ...'
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.resend_receipt"
1437
- end
1438
- # resource path
1439
- local_var_path = '/order/orders/{order_id}/resend_receipt'.sub('{' + 'order_id' + '}', order_id.to_s)
1440
-
1441
- # query parameters
1442
- query_params = {}
1443
-
1444
- # header parameters
1445
- header_params = {}
1446
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1447
- # HTTP header 'Accept' (if needed)
1448
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1449
- # HTTP header 'Content-Type'
1450
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1451
-
1452
- # form parameters
1453
- form_params = {}
1454
-
1455
- # http body (model)
1456
- post_body = nil
1457
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1458
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1459
- :header_params => header_params,
1460
- :query_params => query_params,
1461
- :form_params => form_params,
1462
- :body => post_body,
1463
- :auth_names => auth_names,
1464
- :return_type => 'BaseResponse')
1465
- if @api_client.config.debugging
1466
- @api_client.config.logger.debug "API called: OrderApi#resend_receipt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1467
- end
1468
- return data, status_code, headers
1469
- end
1470
- # Resend shipment confirmation
1471
- # Resend shipment confirmation for an order on the UltraCart account.
1472
- # @param order_id The order id to resend the shipment notification for.
1473
- # @param [Hash] opts the optional parameters
1474
- # @return [BaseResponse]
1475
- def resend_shipment_confirmation(order_id, opts = {})
1476
- data, _status_code, _headers = resend_shipment_confirmation_with_http_info(order_id, opts)
1477
- data
1478
- end
1479
-
1480
- # Resend shipment confirmation
1481
- # Resend shipment confirmation for an order on the UltraCart account.
1482
- # @param order_id The order id to resend the shipment notification for.
1483
- # @param [Hash] opts the optional parameters
1484
- # @return [Array<(BaseResponse, Fixnum, Hash)>] BaseResponse data, response status code and response headers
1485
- def resend_shipment_confirmation_with_http_info(order_id, opts = {})
1486
- if @api_client.config.debugging
1487
- @api_client.config.logger.debug 'Calling API: OrderApi.resend_shipment_confirmation ...'
1488
- end
1489
- # verify the required parameter 'order_id' is set
1490
- if @api_client.config.client_side_validation && order_id.nil?
1491
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.resend_shipment_confirmation"
1492
- end
1493
- # resource path
1494
- local_var_path = '/order/orders/{order_id}/resend_shipment_confirmation'.sub('{' + 'order_id' + '}', order_id.to_s)
1495
-
1496
- # query parameters
1497
- query_params = {}
1498
-
1499
- # header parameters
1500
- header_params = {}
1501
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1502
- # HTTP header 'Accept' (if needed)
1503
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1504
- # HTTP header 'Content-Type'
1505
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1506
-
1507
- # form parameters
1508
- form_params = {}
1509
-
1510
- # http body (model)
1511
- post_body = nil
1512
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1513
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1514
- :header_params => header_params,
1515
- :query_params => query_params,
1516
- :form_params => form_params,
1517
- :body => post_body,
1518
- :auth_names => auth_names,
1519
- :return_type => 'BaseResponse')
1520
- if @api_client.config.debugging
1521
- @api_client.config.logger.debug "API called: OrderApi#resend_shipment_confirmation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1522
- end
1523
- return data, status_code, headers
1524
- end
1525
- # Update A/R Retry Configuration
1526
- # Update A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.
1527
- # @param retry_config AccountsReceivableRetryConfig object
1528
- # @param [Hash] opts the optional parameters
1529
- # @return [BaseResponse]
1530
- def update_accounts_receivable_retry_config(retry_config, opts = {})
1531
- data, _status_code, _headers = update_accounts_receivable_retry_config_with_http_info(retry_config, opts)
1532
- data
1533
- end
1534
-
1535
- # Update A/R Retry Configuration
1536
- # Update A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.
1537
- # @param retry_config AccountsReceivableRetryConfig object
1538
- # @param [Hash] opts the optional parameters
1539
- # @return [Array<(BaseResponse, Fixnum, Hash)>] BaseResponse data, response status code and response headers
1540
- def update_accounts_receivable_retry_config_with_http_info(retry_config, opts = {})
1541
- if @api_client.config.debugging
1542
- @api_client.config.logger.debug 'Calling API: OrderApi.update_accounts_receivable_retry_config ...'
1543
- end
1544
- # verify the required parameter 'retry_config' is set
1545
- if @api_client.config.client_side_validation && retry_config.nil?
1546
- fail ArgumentError, "Missing the required parameter 'retry_config' when calling OrderApi.update_accounts_receivable_retry_config"
1547
- end
1548
- # resource path
1549
- local_var_path = '/order/accountsReceivableRetryConfig'
1550
-
1551
- # query parameters
1552
- query_params = {}
1553
-
1554
- # header parameters
1555
- header_params = {}
1556
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1557
- # HTTP header 'Accept' (if needed)
1558
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1559
- # HTTP header 'Content-Type'
1560
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1561
-
1562
- # form parameters
1563
- form_params = {}
1564
-
1565
- # http body (model)
1566
- post_body = @api_client.object_to_http_body(retry_config)
1567
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1568
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1569
- :header_params => header_params,
1570
- :query_params => query_params,
1571
- :form_params => form_params,
1572
- :body => post_body,
1573
- :auth_names => auth_names,
1574
- :return_type => 'BaseResponse')
1575
- if @api_client.config.debugging
1576
- @api_client.config.logger.debug "API called: OrderApi#update_accounts_receivable_retry_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1577
- end
1578
- return data, status_code, headers
1579
- end
1580
- # Update an order
1581
- # 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.
1582
- # @param order Order to update
1583
- # @param order_id The order id to update.
1584
- # @param [Hash] opts the optional parameters
1585
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1586
- # @return [OrderResponse]
1587
- def update_order(order, order_id, opts = {})
1588
- data, _status_code, _headers = update_order_with_http_info(order, order_id, opts)
1589
- data
1590
- end
1591
-
1592
- # Update an order
1593
- # 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.
1594
- # @param order Order to update
1595
- # @param order_id The order id to update.
1596
- # @param [Hash] opts the optional parameters
1597
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1598
- # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
1599
- def update_order_with_http_info(order, order_id, opts = {})
1600
- if @api_client.config.debugging
1601
- @api_client.config.logger.debug 'Calling API: OrderApi.update_order ...'
1602
- end
1603
- # verify the required parameter 'order' is set
1604
- if @api_client.config.client_side_validation && order.nil?
1605
- fail ArgumentError, "Missing the required parameter 'order' when calling OrderApi.update_order"
1606
- end
1607
- # verify the required parameter 'order_id' is set
1608
- if @api_client.config.client_side_validation && order_id.nil?
1609
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.update_order"
1610
- end
1611
- # resource path
1612
- local_var_path = '/order/orders/{order_id}'.sub('{' + 'order_id' + '}', order_id.to_s)
1613
-
1614
- # query parameters
1615
- query_params = {}
1616
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1617
-
1618
- # header parameters
1619
- header_params = {}
1620
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1621
- # HTTP header 'Accept' (if needed)
1622
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1623
- # HTTP header 'Content-Type'
1624
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1625
-
1626
- # form parameters
1627
- form_params = {}
1628
-
1629
- # http body (model)
1630
- post_body = @api_client.object_to_http_body(order)
1631
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1632
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1633
- :header_params => header_params,
1634
- :query_params => query_params,
1635
- :form_params => form_params,
1636
- :body => post_body,
1637
- :auth_names => auth_names,
1638
- :return_type => 'OrderResponse')
1639
- if @api_client.config.debugging
1640
- @api_client.config.logger.debug "API called: OrderApi#update_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1641
- end
1642
- return data, status_code, headers
1643
- end
1644
- # Validate
1645
- # 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.
1646
- # @param validation_request Validation request
1647
- # @param [Hash] opts the optional parameters
1648
- # @return [OrderValidationResponse]
1649
- def validate_order(validation_request, opts = {})
1650
- data, _status_code, _headers = validate_order_with_http_info(validation_request, opts)
1651
- data
1652
- end
1653
-
1654
- # Validate
1655
- # 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.
1656
- # @param validation_request Validation request
1657
- # @param [Hash] opts the optional parameters
1658
- # @return [Array<(OrderValidationResponse, Fixnum, Hash)>] OrderValidationResponse data, response status code and response headers
1659
- def validate_order_with_http_info(validation_request, opts = {})
1660
- if @api_client.config.debugging
1661
- @api_client.config.logger.debug 'Calling API: OrderApi.validate_order ...'
1662
- end
1663
- # verify the required parameter 'validation_request' is set
1664
- if @api_client.config.client_side_validation && validation_request.nil?
1665
- fail ArgumentError, "Missing the required parameter 'validation_request' when calling OrderApi.validate_order"
1666
- end
1667
- # resource path
1668
- local_var_path = '/order/validate'
1669
-
1670
- # query parameters
1671
- query_params = {}
1672
-
1673
- # header parameters
1674
- header_params = {}
1675
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1676
- # HTTP header 'Accept' (if needed)
1677
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1678
- # HTTP header 'Content-Type'
1679
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1680
-
1681
- # form parameters
1682
- form_params = {}
1683
-
1684
- # http body (model)
1685
- post_body = @api_client.object_to_http_body(validation_request)
1686
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1687
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1688
- :header_params => header_params,
1689
- :query_params => query_params,
1690
- :form_params => form_params,
1691
- :body => post_body,
1692
- :auth_names => auth_names,
1693
- :return_type => 'OrderValidationResponse')
1694
- if @api_client.config.debugging
1695
- @api_client.config.logger.debug "API called: OrderApi#validate_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1696
- end
1697
- return data, status_code, headers
1698
- end
1699
- end
1700
- 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