ultracart_api 3.10.19 → 4.0.34.rc

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1319) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +9 -7
  3. data/README.md +1170 -1133
  4. data/Rakefile +10 -8
  5. data/docs/AccountsReceivableRetryConfig.md +46 -22
  6. data/docs/AccountsReceivableRetryConfigResponse.md +32 -15
  7. data/docs/AccountsReceivableRetryDayActivity.md +22 -10
  8. data/docs/AccountsReceivableRetryStatAccount.md +24 -11
  9. data/docs/AccountsReceivableRetryStatMetrics.md +38 -18
  10. data/docs/AccountsReceivableRetryStatRevenue.md +20 -9
  11. data/docs/AccountsReceivableRetryStatsResponse.md +28 -13
  12. data/docs/Activity.md +28 -13
  13. data/docs/AddLibraryItemRequest.md +38 -18
  14. data/docs/AdjustInternalCertificateRequest.md +28 -13
  15. data/docs/AdjustInternalCertificateResponse.md +28 -13
  16. data/docs/AffiliateApi.md +167 -126
  17. data/docs/AffiliateClick.md +38 -18
  18. data/docs/AffiliateClickQuery.md +28 -13
  19. data/docs/AffiliateClicksResponse.md +26 -12
  20. data/docs/AffiliateLedger.md +54 -26
  21. data/docs/AffiliateLedgerQuery.md +28 -13
  22. data/docs/AffiliateLedgersResponse.md +26 -12
  23. data/docs/AffiliateLink.md +44 -21
  24. data/docs/ApiUserApplicationProfile.md +26 -12
  25. data/docs/ApplyLibraryItemRequest.md +24 -11
  26. data/docs/ApplyLibraryItemResponse.md +38 -18
  27. data/docs/AutoOrder.md +60 -29
  28. data/docs/AutoOrderApi.md +669 -502
  29. data/docs/AutoOrderItem.md +64 -31
  30. data/docs/AutoOrderItemFutureSchedule.md +24 -11
  31. data/docs/AutoOrderItemOption.md +20 -9
  32. data/docs/AutoOrderItemSimpleSchedule.md +22 -10
  33. data/docs/AutoOrderLog.md +20 -9
  34. data/docs/AutoOrderQuery.md +58 -28
  35. data/docs/AutoOrderQueryBatch.md +18 -8
  36. data/docs/AutoOrderResponse.md +26 -12
  37. data/docs/AutoOrdersRequest.md +18 -8
  38. data/docs/AutoOrdersResponse.md +26 -12
  39. data/docs/AvalaraConfig.md +42 -20
  40. data/docs/BaseResponse.md +24 -11
  41. data/docs/Browser.md +22 -10
  42. data/docs/BrowserDevice.md +18 -8
  43. data/docs/BrowserOS.md +26 -12
  44. data/docs/BrowserUserAgent.md +24 -11
  45. data/docs/Cart.md +68 -33
  46. data/docs/CartAffiliate.md +20 -9
  47. data/docs/CartAffirmCheckoutResponse.md +20 -9
  48. data/docs/CartBilling.md +46 -22
  49. data/docs/CartBuysafe.md +28 -13
  50. data/docs/CartCheckout.md +44 -21
  51. data/docs/CartCoupon.md +18 -8
  52. data/docs/CartCurrencyConversion.md +20 -9
  53. data/docs/CartCustomerProfile.md +60 -29
  54. data/docs/CartCustomerProfileAddress.md +44 -21
  55. data/docs/CartCustomerProfileCreditCard.md +28 -13
  56. data/docs/CartFinalizeOrderRequest.md +20 -9
  57. data/docs/CartFinalizeOrderRequestOptions.md +42 -20
  58. data/docs/CartFinalizeOrderResponse.md +26 -12
  59. data/docs/CartGift.md +28 -13
  60. data/docs/CartGiftCertificate.md +22 -10
  61. data/docs/CartItem.md +74 -36
  62. data/docs/CartItemAttribute.md +22 -10
  63. data/docs/CartItemMultimedia.md +34 -16
  64. data/docs/CartItemMultimediaThumbnail.md +26 -12
  65. data/docs/CartItemOption.md +40 -19
  66. data/docs/CartItemOptionValue.md +26 -12
  67. data/docs/CartItemPhysical.md +24 -11
  68. data/docs/CartItemVariationSelection.md +20 -9
  69. data/docs/CartKitComponentOption.md +44 -21
  70. data/docs/CartMarketing.md +20 -9
  71. data/docs/CartPayment.md +30 -14
  72. data/docs/CartPaymentAffirm.md +18 -8
  73. data/docs/CartPaymentAmazon.md +18 -8
  74. data/docs/CartPaymentCheck.md +18 -8
  75. data/docs/CartPaymentCreditCard.md +34 -16
  76. data/docs/CartPaymentPurchaseOrder.md +18 -8
  77. data/docs/CartProfileLoginRequest.md +22 -10
  78. data/docs/CartProfileLoginResponse.md +20 -9
  79. data/docs/CartProfileRegisterRequest.md +20 -9
  80. data/docs/CartProfileRegisterResponse.md +20 -9
  81. data/docs/CartProperty.md +24 -11
  82. data/docs/CartResponse.md +20 -9
  83. data/docs/CartSettings.md +28 -13
  84. data/docs/CartSettingsBilling.md +18 -8
  85. data/docs/CartSettingsGift.md +24 -11
  86. data/docs/CartSettingsGiftWrap.md +22 -10
  87. data/docs/CartSettingsPayment.md +42 -20
  88. data/docs/CartSettingsPaymentAmazon.md +22 -10
  89. data/docs/CartSettingsPaymentCreditCard.md +22 -10
  90. data/docs/CartSettingsPaymentPayPal.md +26 -12
  91. data/docs/CartSettingsProvince.md +20 -9
  92. data/docs/CartSettingsShipping.md +26 -12
  93. data/docs/CartSettingsShippingCalendar.md +26 -12
  94. data/docs/CartSettingsShippingEstimate.md +44 -21
  95. data/docs/CartSettingsTaxes.md +18 -8
  96. data/docs/CartSettingsTerms.md +20 -9
  97. data/docs/CartShipping.md +54 -26
  98. data/docs/CartSummary.md +48 -23
  99. data/docs/CartTaxes.md +22 -10
  100. data/docs/CartUpsellAfter.md +22 -10
  101. data/docs/CartValidationRequest.md +20 -9
  102. data/docs/CartValidationResponse.md +20 -9
  103. data/docs/ChannelPartnerApi.md +367 -263
  104. data/docs/ChannelPartnerCancelResponse.md +26 -12
  105. data/docs/ChannelPartnerEstimateShippingResponse.md +26 -12
  106. data/docs/ChannelPartnerEstimateTaxResponse.md +26 -12
  107. data/docs/ChannelPartnerImportResponse.md +30 -14
  108. data/docs/ChannelPartnerOrder.md +176 -87
  109. data/docs/ChannelPartnerOrderItem.md +30 -14
  110. data/docs/ChannelPartnerOrderItemOption.md +20 -9
  111. data/docs/ChannelPartnerOrderTransaction.md +20 -9
  112. data/docs/ChannelPartnerOrderTransactionDetail.md +20 -9
  113. data/docs/ChannelPartnerShippingEstimate.md +20 -9
  114. data/docs/ChargebackApi.md +405 -301
  115. data/docs/ChargebackDispute.md +62 -30
  116. data/docs/ChargebackDisputeResponse.md +26 -12
  117. data/docs/ChargebackDisputesResponse.md +26 -12
  118. data/docs/CheckoutAllowedCountriesResponse.md +18 -8
  119. data/docs/CheckoutApi.md +1424 -1023
  120. data/docs/CheckoutHandoffRequest.md +32 -15
  121. data/docs/CheckoutHandoffResponse.md +22 -10
  122. data/docs/CheckoutSetupBrowserKeyRequest.md +18 -8
  123. data/docs/CheckoutSetupBrowserKeyResponse.md +18 -8
  124. data/docs/CheckoutStateProvinceResponse.md +18 -8
  125. data/docs/CityStateZip.md +26 -12
  126. data/docs/CountriesResponse.md +18 -8
  127. data/docs/Country.md +20 -9
  128. data/docs/Coupon.md +136 -67
  129. data/docs/CouponAmountOffItems.md +24 -11
  130. data/docs/CouponAmountOffShipping.md +22 -10
  131. data/docs/CouponAmountOffShippingWithItemsPurchase.md +24 -11
  132. data/docs/CouponAmountOffSubtotal.md +20 -9
  133. data/docs/CouponAmountOffSubtotalAndShipping.md +20 -9
  134. data/docs/CouponAmountOffSubtotalFreeShippingWithPurchase.md +24 -11
  135. data/docs/CouponAmountOffSubtotalWithBlockPurchase.md +24 -11
  136. data/docs/CouponAmountOffSubtotalWithItemsPurchase.md +24 -11
  137. data/docs/CouponAmountOffSubtotalWithPurchase.md +22 -10
  138. data/docs/CouponAmountShippingWithSubtotal.md +24 -11
  139. data/docs/CouponApi.md +1443 -1043
  140. data/docs/CouponAutoApplyCondition.md +22 -10
  141. data/docs/CouponAutoApplyConditions.md +28 -13
  142. data/docs/CouponAutomaticallyApplyCouponCodes.md +18 -8
  143. data/docs/CouponBuyOneGetOneLimit.md +20 -9
  144. data/docs/CouponCodesRequest.md +30 -14
  145. data/docs/CouponCodesResponse.md +28 -13
  146. data/docs/CouponDeletesRequest.md +20 -9
  147. data/docs/CouponDiscountItemWithItemPurchase.md +26 -12
  148. data/docs/CouponDiscountItems.md +24 -11
  149. data/docs/CouponEditorValues.md +36 -17
  150. data/docs/CouponExistsResponse.md +28 -13
  151. data/docs/CouponFreeItemAndShippingWithSubtotal.md +26 -12
  152. data/docs/CouponFreeItemWithItemPurchase.md +24 -11
  153. data/docs/CouponFreeItemWithSubtotal.md +24 -11
  154. data/docs/CouponFreeItemsWithItemPurchase.md +26 -12
  155. data/docs/CouponFreeItemsWithMixMatchPurchase.md +26 -12
  156. data/docs/CouponFreeShipping.md +18 -8
  157. data/docs/CouponFreeShippingSpecificItems.md +18 -8
  158. data/docs/CouponFreeShippingWithItemsPurchase.md +20 -9
  159. data/docs/CouponFreeShippingWithSubtotal.md +22 -10
  160. data/docs/CouponItemSearchResult.md +32 -15
  161. data/docs/CouponItemSearchResultsResponse.md +26 -12
  162. data/docs/CouponMultipleAmountsOffItems.md +20 -9
  163. data/docs/CouponPercentOffItemWithItemsQuantityPurchase.md +26 -12
  164. data/docs/CouponPercentOffItems.md +24 -11
  165. data/docs/CouponPercentOffItemsAndFreeShipping.md +22 -10
  166. data/docs/CouponPercentOffItemsWithItemsPurchase.md +24 -11
  167. data/docs/CouponPercentOffMsrpItems.md +24 -11
  168. data/docs/CouponPercentOffRetailPriceItems.md +24 -11
  169. data/docs/CouponPercentOffShipping.md +20 -9
  170. data/docs/CouponPercentOffSubtotal.md +18 -8
  171. data/docs/CouponPercentOffSubtotalAndFreeShipping.md +20 -9
  172. data/docs/CouponPercentOffSubtotalLimit.md +22 -10
  173. data/docs/CouponPercentOffSubtotalWithItemsPurchase.md +20 -9
  174. data/docs/CouponPercentOffSubtotalWithSubtotal.md +22 -10
  175. data/docs/CouponQuery.md +36 -17
  176. data/docs/CouponResponse.md +28 -13
  177. data/docs/CouponRestriction.md +24 -11
  178. data/docs/CouponTierAmount.md +22 -10
  179. data/docs/CouponTierItemDiscount.md +20 -9
  180. data/docs/CouponTierPercent.md +22 -10
  181. data/docs/CouponTierQuantityAmount.md +22 -10
  182. data/docs/CouponTierQuantityPercent.md +22 -10
  183. data/docs/CouponTieredAmountOffItems.md +22 -10
  184. data/docs/CouponTieredAmountOffSubtotal.md +20 -9
  185. data/docs/CouponTieredPercentOffItems.md +22 -10
  186. data/docs/CouponTieredPercentOffShipping.md +22 -10
  187. data/docs/CouponTieredPercentOffSubtotal.md +20 -9
  188. data/docs/CouponType.md +20 -9
  189. data/docs/CouponsRequest.md +18 -8
  190. data/docs/CouponsResponse.md +26 -12
  191. data/docs/Currency.md +26 -12
  192. data/docs/Customer.md +134 -66
  193. data/docs/CustomerActivity.md +32 -15
  194. data/docs/CustomerAffiliate.md +24 -11
  195. data/docs/CustomerApi.md +1401 -1023
  196. data/docs/CustomerAttachment.md +26 -12
  197. data/docs/CustomerBilling.md +50 -24
  198. data/docs/CustomerCard.md +32 -15
  199. data/docs/CustomerEditorValues.md +36 -17
  200. data/docs/CustomerEmail.md +28 -13
  201. data/docs/CustomerEmailListChanges.md +20 -9
  202. data/docs/CustomerLoyalty.md +30 -14
  203. data/docs/CustomerLoyaltyLedger.md +46 -22
  204. data/docs/CustomerLoyaltyRedemption.md +42 -20
  205. data/docs/CustomerMergeRequest.md +20 -9
  206. data/docs/CustomerOrdersSummary.md +24 -11
  207. data/docs/CustomerPricingTier.md +20 -9
  208. data/docs/CustomerPrivacy.md +24 -11
  209. data/docs/CustomerQuery.md +74 -36
  210. data/docs/CustomerQuotesSummary.md +24 -11
  211. data/docs/CustomerResponse.md +26 -12
  212. data/docs/CustomerReviewer.md +36 -17
  213. data/docs/CustomerShipping.md +50 -24
  214. data/docs/CustomerSoftwareEntitlement.md +32 -15
  215. data/docs/CustomerStoreCredit.md +28 -13
  216. data/docs/CustomerStoreCreditAddRequest.md +24 -11
  217. data/docs/CustomerStoreCreditLedgerEntry.md +30 -14
  218. data/docs/CustomerStoreCreditResponse.md +26 -12
  219. data/docs/CustomerTag.md +18 -8
  220. data/docs/CustomerTaxCodes.md +26 -12
  221. data/docs/CustomersResponse.md +26 -12
  222. data/docs/DataTablesServerSideResponse.md +24 -11
  223. data/docs/Distance.md +20 -9
  224. data/docs/DistributionCenter.md +86 -42
  225. data/docs/DistributionCentersResponse.md +26 -12
  226. data/docs/EmailBaseTemplateListResponse.md +18 -8
  227. data/docs/EmailCampaign.md +64 -31
  228. data/docs/EmailCampaignFolder.md +26 -12
  229. data/docs/EmailCampaignFolderResponse.md +26 -12
  230. data/docs/EmailCampaignFoldersResponse.md +26 -12
  231. data/docs/EmailCampaignResponse.md +26 -12
  232. data/docs/EmailCampaignsResponse.md +26 -12
  233. data/docs/EmailClick.md +20 -9
  234. data/docs/EmailClicksResponse.md +26 -12
  235. data/docs/EmailCommseq.md +24 -11
  236. data/docs/EmailCommseqEmail.md +68 -33
  237. data/docs/EmailCommseqEmailResponse.md +26 -12
  238. data/docs/EmailCommseqEmailSendTestRequest.md +36 -17
  239. data/docs/EmailCommseqEmailSendTestResponse.md +24 -11
  240. data/docs/EmailCommseqEmailsRequest.md +26 -12
  241. data/docs/EmailCommseqEmailsResponse.md +26 -12
  242. data/docs/EmailCommseqPostcard.md +42 -20
  243. data/docs/EmailCommseqPostcardResponse.md +26 -12
  244. data/docs/EmailCommseqPostcardSendTestRequest.md +42 -20
  245. data/docs/EmailCommseqPostcardSendTestResponse.md +30 -14
  246. data/docs/EmailCommseqPostcardsRequest.md +18 -8
  247. data/docs/EmailCommseqPostcardsResponse.md +26 -12
  248. data/docs/EmailCommseqResponse.md +26 -12
  249. data/docs/EmailCommseqStat.md +90 -44
  250. data/docs/EmailCommseqStatResponse.md +26 -12
  251. data/docs/EmailCommseqStep.md +36 -17
  252. data/docs/EmailCommseqStepLog.md +22 -10
  253. data/docs/EmailCommseqStepLogsResponse.md +26 -12
  254. data/docs/EmailCommseqWebhookSendTestRequest.md +30 -14
  255. data/docs/EmailCommseqWebhookSendTestResponse.md +30 -14
  256. data/docs/EmailCommseqsResponse.md +26 -12
  257. data/docs/EmailCustomer.md +32 -15
  258. data/docs/EmailCustomerEditorUrlResponse.md +26 -12
  259. data/docs/EmailCustomersResponse.md +26 -12
  260. data/docs/EmailDashboardActivity.md +30 -14
  261. data/docs/EmailDashboardActivityResponse.md +26 -12
  262. data/docs/EmailDashboardStatsResponse.md +26 -12
  263. data/docs/EmailDomain.md +42 -20
  264. data/docs/EmailEditorTokenResponse.md +26 -12
  265. data/docs/EmailFlow.md +72 -35
  266. data/docs/EmailFlowBackPopulateRequest.md +20 -9
  267. data/docs/EmailFlowBackPopulateResponse.md +24 -11
  268. data/docs/EmailFlowFolder.md +26 -12
  269. data/docs/EmailFlowFolderResponse.md +26 -12
  270. data/docs/EmailFlowFoldersResponse.md +26 -12
  271. data/docs/EmailFlowResponse.md +26 -12
  272. data/docs/EmailFlowsResponse.md +26 -12
  273. data/docs/EmailGlobalSettings.md +18 -8
  274. data/docs/EmailGlobalSettingsResponse.md +26 -12
  275. data/docs/EmailGlobalUnsubscribeRequest.md +18 -8
  276. data/docs/EmailGlobalUnsubscribeResponse.md +18 -8
  277. data/docs/EmailHistogramPropertyNamesResponse.md +18 -8
  278. data/docs/EmailHistogramPropertyValuesResponse.md +18 -8
  279. data/docs/EmailList.md +40 -19
  280. data/docs/EmailListArchiveResponse.md +26 -12
  281. data/docs/EmailListCustomer.md +24 -11
  282. data/docs/EmailListCustomersResponse.md +26 -12
  283. data/docs/EmailListResponse.md +26 -12
  284. data/docs/EmailListSegmentFolder.md +26 -12
  285. data/docs/EmailListSegmentFolderResponse.md +26 -12
  286. data/docs/EmailListSegmentFoldersResponse.md +26 -12
  287. data/docs/EmailListSegmentMembership.md +24 -11
  288. data/docs/EmailListSegmentUsedBy.md +22 -10
  289. data/docs/EmailListSubscribeResponse.md +20 -9
  290. data/docs/EmailListsResponse.md +26 -12
  291. data/docs/EmailOrder.md +24 -11
  292. data/docs/EmailOrdersResponse.md +26 -12
  293. data/docs/EmailPerformance.md +62 -30
  294. data/docs/EmailPerformanceCustomerHistogram.md +18 -8
  295. data/docs/EmailPerformanceCustomerHistogramPeriod.md +26 -12
  296. data/docs/EmailPerformanceDaily.md +30 -14
  297. data/docs/EmailPerformanceResponse.md +26 -12
  298. data/docs/EmailPlan.md +50 -24
  299. data/docs/EmailPlanAdditional.md +34 -16
  300. data/docs/EmailPlanResponse.md +26 -12
  301. data/docs/EmailPostcardStat.md +80 -39
  302. data/docs/EmailSegment.md +58 -28
  303. data/docs/EmailSegmentArchiveResponse.md +26 -12
  304. data/docs/EmailSegmentCustomer.md +24 -11
  305. data/docs/EmailSegmentCustomersResponse.md +26 -12
  306. data/docs/EmailSegmentDownloadPrepareResponse.md +32 -15
  307. data/docs/EmailSegmentResponse.md +26 -12
  308. data/docs/EmailSegmentsResponse.md +26 -12
  309. data/docs/EmailSendingDomainResponse.md +26 -12
  310. data/docs/EmailSendingDomainsResponse.md +26 -12
  311. data/docs/EmailSettings.md +40 -19
  312. data/docs/EmailSettingsResponse.md +26 -12
  313. data/docs/EmailStat.md +92 -45
  314. data/docs/EmailStatPostcardSummaryRequest.md +20 -9
  315. data/docs/EmailStatPostcardSummaryResponse.md +26 -12
  316. data/docs/EmailStatSummaryRequest.md +22 -10
  317. data/docs/EmailStatSummaryResponse.md +26 -12
  318. data/docs/EmailStepStat.md +56 -27
  319. data/docs/EmailStepStatRequest.md +20 -9
  320. data/docs/EmailStepStatResponse.md +26 -12
  321. data/docs/EmailStepWaitingRequest.md +18 -8
  322. data/docs/EmailStepWaitingResponse.md +18 -8
  323. data/docs/EmailTemplate.md +38 -18
  324. data/docs/EmailTemplatesResponse.md +26 -12
  325. data/docs/EmailThirdPartyList.md +20 -9
  326. data/docs/EmailThirdPartyListImportRequest.md +18 -8
  327. data/docs/EmailThirdPartyProvider.md +38 -18
  328. data/docs/EmailThirdPartyProvidersResponse.md +26 -12
  329. data/docs/EmailThirdPartyTag.md +20 -9
  330. data/docs/EmailVerifyTokenRequest.md +20 -9
  331. data/docs/EmailVerifyTokenResponse.md +26 -12
  332. data/docs/EmailVerifyTokenValidateRequest.md +18 -8
  333. data/docs/EmailVerifyTokenValidateResponse.md +24 -11
  334. data/docs/EmailWebhookEditorValuesResponse.md +30 -14
  335. data/docs/Error.md +26 -12
  336. data/docs/ErrorResponse.md +24 -11
  337. data/docs/Experiment.md +52 -25
  338. data/docs/ExperimentResponse.md +26 -12
  339. data/docs/ExperimentVariation.md +60 -29
  340. data/docs/ExperimentVariationStat.md +38 -18
  341. data/docs/ExperimentsResponse.md +26 -12
  342. data/docs/FulfillmentApi.md +441 -318
  343. data/docs/FulfillmentInventory.md +20 -9
  344. data/docs/FulfillmentShipment.md +26 -12
  345. data/docs/GeoPoint.md +20 -9
  346. data/docs/GeocodeRequest.md +26 -12
  347. data/docs/GeocodeResponse.md +28 -13
  348. data/docs/GiftCertificate.md +44 -21
  349. data/docs/GiftCertificateApi.md +598 -433
  350. data/docs/GiftCertificateCreateRequest.md +26 -12
  351. data/docs/GiftCertificateLedgerEntry.md +28 -13
  352. data/docs/GiftCertificateQuery.md +34 -16
  353. data/docs/GiftCertificateResponse.md +26 -12
  354. data/docs/GiftCertificatesResponse.md +26 -12
  355. data/docs/Group.md +26 -12
  356. data/docs/GroupResponse.md +26 -12
  357. data/docs/GroupUserMembership.md +26 -12
  358. data/docs/GroupsResponse.md +26 -12
  359. data/docs/HTTPHeader.md +20 -9
  360. data/docs/IntegrationLog.md +52 -25
  361. data/docs/IntegrationLogApi.md +385 -286
  362. data/docs/IntegrationLogFile.md +24 -11
  363. data/docs/IntegrationLogLog.md +20 -9
  364. data/docs/IntegrationLogQueryFilterValues.md +40 -19
  365. data/docs/IntegrationLogQueryRequest.md +42 -20
  366. data/docs/IntegrationLogQueryResponse.md +28 -13
  367. data/docs/IntegrationLogResponse.md +26 -12
  368. data/docs/IntegrationLogSummary.md +34 -16
  369. data/docs/IntegrationLogSummaryQueryRequest.md +20 -9
  370. data/docs/IntegrationLogSummaryQueryResponse.md +26 -12
  371. data/docs/Item.md +118 -58
  372. data/docs/ItemAccounting.md +20 -9
  373. data/docs/ItemAmember.md +20 -9
  374. data/docs/ItemApi.md +706 -517
  375. data/docs/ItemAutoOrder.md +50 -24
  376. data/docs/ItemAutoOrderStep.md +46 -22
  377. data/docs/ItemAutoOrderStepArbitraryUnitCostSchedule.md +20 -9
  378. data/docs/ItemAutoOrderStepGrandfatherPricing.md +20 -9
  379. data/docs/ItemCCBill.md +28 -13
  380. data/docs/ItemChannelPartnerMapping.md +54 -26
  381. data/docs/ItemChargeback.md +20 -9
  382. data/docs/ItemChargebackAddendum.md +24 -11
  383. data/docs/ItemChargebackAdjustmentRequest.md +22 -10
  384. data/docs/ItemCheckout.md +24 -11
  385. data/docs/ItemContent.md +42 -20
  386. data/docs/ItemContentAssignment.md +28 -13
  387. data/docs/ItemContentAttribute.md +24 -11
  388. data/docs/ItemContentMultimedia.md +46 -22
  389. data/docs/ItemContentMultimediaThumbnail.md +28 -13
  390. data/docs/ItemDigitalDelivery.md +28 -13
  391. data/docs/ItemDigitalItem.md +26 -12
  392. data/docs/ItemEbay.md +154 -76
  393. data/docs/ItemEbayCategorySpecific.md +20 -9
  394. data/docs/ItemEbayMarketListing.md +26 -12
  395. data/docs/ItemEbayMarketPlaceAnalysis.md +36 -17
  396. data/docs/ItemEmailNotifications.md +20 -9
  397. data/docs/ItemEnrollment123.md +18 -8
  398. data/docs/ItemFulfillmentAddon.md +24 -11
  399. data/docs/ItemGiftCertificate.md +20 -9
  400. data/docs/ItemGoogleProductSearch.md +112 -55
  401. data/docs/ItemIdentifiers.md +24 -11
  402. data/docs/ItemInstantPaymentNotification.md +22 -10
  403. data/docs/ItemInstantPaymentNotifications.md +18 -8
  404. data/docs/ItemInternal.md +18 -8
  405. data/docs/ItemKitComponent.md +26 -12
  406. data/docs/ItemKitDefinition.md +18 -8
  407. data/docs/ItemOption.md +44 -21
  408. data/docs/ItemOptionValue.md +46 -22
  409. data/docs/ItemOptionValueAdditionalItem.md +20 -9
  410. data/docs/ItemOptionValueDigitalItem.md +20 -9
  411. data/docs/ItemPaymentProcessing.md +26 -12
  412. data/docs/ItemPhysical.md +24 -11
  413. data/docs/ItemPricing.md +52 -25
  414. data/docs/ItemPricingTier.md +26 -12
  415. data/docs/ItemPricingTierDiscount.md +20 -9
  416. data/docs/ItemPricingTierLimit.md +22 -10
  417. data/docs/ItemProperty.md +22 -10
  418. data/docs/ItemRealtimePricing.md +22 -10
  419. data/docs/ItemRelated.md +22 -10
  420. data/docs/ItemRelatedItem.md +22 -10
  421. data/docs/ItemReporting.md +20 -9
  422. data/docs/ItemResponse.md +26 -12
  423. data/docs/ItemRestriction.md +32 -15
  424. data/docs/ItemRestrictionItem.md +22 -10
  425. data/docs/ItemRevguard.md +30 -14
  426. data/docs/ItemReviews.md +34 -16
  427. data/docs/ItemSalesforce.md +20 -9
  428. data/docs/ItemShipping.md +112 -55
  429. data/docs/ItemShippingCase.md +24 -11
  430. data/docs/ItemShippingDestinationMarkup.md +28 -13
  431. data/docs/ItemShippingDestinationRestriction.md +22 -10
  432. data/docs/ItemShippingDistributionCenter.md +44 -21
  433. data/docs/ItemShippingMethod.md +46 -22
  434. data/docs/ItemShippingPackageRequirement.md +20 -9
  435. data/docs/ItemTag.md +20 -9
  436. data/docs/ItemTags.md +18 -8
  437. data/docs/ItemTax.md +24 -11
  438. data/docs/ItemTaxExemption.md +26 -12
  439. data/docs/ItemThirdPartyEmailMarketing.md +26 -12
  440. data/docs/ItemVariantItem.md +28 -13
  441. data/docs/ItemVariation.md +26 -12
  442. data/docs/ItemVariationOption.md +24 -11
  443. data/docs/ItemWishlistMember.md +22 -10
  444. data/docs/ItemsRequest.md +18 -8
  445. data/docs/ItemsResponse.md +26 -12
  446. data/docs/KeyValue.md +22 -10
  447. data/docs/LibraryFilterValues.md +24 -11
  448. data/docs/LibraryFilterValuesResponse.md +26 -12
  449. data/docs/LibraryItem.md +96 -47
  450. data/docs/LibraryItemAccount.md +22 -10
  451. data/docs/LibraryItemAsset.md +20 -9
  452. data/docs/LibraryItemAttribute.md +20 -9
  453. data/docs/LibraryItemEmail.md +22 -10
  454. data/docs/LibraryItemPublishedMeta.md +32 -15
  455. data/docs/LibraryItemPurchasedMeta.md +22 -10
  456. data/docs/LibraryItemQuery.md +40 -19
  457. data/docs/LibraryItemResponse.md +26 -12
  458. data/docs/LibraryItemScreenshot.md +20 -9
  459. data/docs/LibraryItemsResponse.md +26 -12
  460. data/docs/LinkedAccount.md +22 -10
  461. data/docs/ListSegmentMembership.md +22 -10
  462. data/docs/LookupRequest.md +26 -12
  463. data/docs/LookupResponse.md +26 -12
  464. data/docs/Mailgun.md +18 -8
  465. data/docs/Metric.md +32 -15
  466. data/docs/Notification.md +38 -18
  467. data/docs/OauthApi.md +163 -124
  468. data/docs/OauthRevokeSuccessResponse.md +20 -9
  469. data/docs/OauthTokenResponse.md +32 -15
  470. data/docs/Order.md +84 -41
  471. data/docs/OrderAffiliate.md +22 -10
  472. data/docs/OrderAffiliateLedger.md +34 -16
  473. data/docs/OrderApi.md +1787 -1308
  474. data/docs/OrderAutoOrder.md +56 -27
  475. data/docs/OrderBilling.md +48 -23
  476. data/docs/OrderBuysafe.md +28 -13
  477. data/docs/OrderByTokenQuery.md +18 -8
  478. data/docs/OrderChannelPartner.md +38 -18
  479. data/docs/OrderCheckout.md +44 -21
  480. data/docs/OrderCoupon.md +26 -12
  481. data/docs/OrderDigitalItem.md +32 -15
  482. data/docs/OrderDigitalOrder.md +26 -12
  483. data/docs/OrderEdi.md +24 -11
  484. data/docs/OrderFormat.md +48 -23
  485. data/docs/OrderFormatResponse.md +20 -9
  486. data/docs/OrderFraudScore.md +56 -27
  487. data/docs/OrderGift.md +36 -17
  488. data/docs/OrderGiftCertificate.md +22 -10
  489. data/docs/OrderInternal.md +26 -12
  490. data/docs/OrderItem.md +128 -63
  491. data/docs/OrderItemEdi.md +20 -9
  492. data/docs/OrderItemEdiIdentification.md +20 -9
  493. data/docs/OrderItemEdiLot.md +22 -10
  494. data/docs/OrderItemOption.md +38 -18
  495. data/docs/OrderItemOptionFileAttachment.md +24 -11
  496. data/docs/OrderItemProperty.md +24 -11
  497. data/docs/OrderItemTag.md +18 -8
  498. data/docs/OrderLinkedShipment.md +26 -12
  499. data/docs/OrderMarketing.md +22 -10
  500. data/docs/OrderPackingSlipResponse.md +26 -12
  501. data/docs/OrderPayment.md +52 -25
  502. data/docs/OrderPaymentCheck.md +18 -8
  503. data/docs/OrderPaymentCreditCard.md +38 -18
  504. data/docs/OrderPaymentECheck.md +36 -17
  505. data/docs/OrderPaymentInsurance.md +24 -11
  506. data/docs/OrderPaymentPurchaseOrder.md +18 -8
  507. data/docs/OrderPaymentTransaction.md +24 -11
  508. data/docs/OrderPaymentTransactionDetail.md +22 -10
  509. data/docs/OrderProcessPaymentRequest.md +20 -9
  510. data/docs/OrderProcessPaymentResponse.md +26 -12
  511. data/docs/OrderProperty.md +24 -11
  512. data/docs/OrderQuery.md +94 -46
  513. data/docs/OrderQueryBatch.md +18 -8
  514. data/docs/OrderQuote.md +22 -10
  515. data/docs/OrderReplacement.md +46 -22
  516. data/docs/OrderReplacementItem.md +22 -10
  517. data/docs/OrderReplacementResponse.md +28 -13
  518. data/docs/OrderResponse.md +26 -12
  519. data/docs/OrderSalesforce.md +18 -8
  520. data/docs/OrderShipping.md +76 -37
  521. data/docs/OrderSummary.md +56 -27
  522. data/docs/OrderTag.md +18 -8
  523. data/docs/OrderTaxes.md +50 -24
  524. data/docs/OrderTokenResponse.md +26 -12
  525. data/docs/OrderTrackingNumberDetail.md +40 -19
  526. data/docs/OrderTrackingNumberDetails.md +52 -25
  527. data/docs/OrdersResponse.md +26 -12
  528. data/docs/Permission.md +22 -10
  529. data/docs/PricingTier.md +78 -38
  530. data/docs/PricingTierNotification.md +22 -10
  531. data/docs/PricingTiersResponse.md +26 -12
  532. data/docs/Property.md +20 -9
  533. data/docs/PublishLibraryItemRequest.md +18 -8
  534. data/docs/RegisterAffiliateClickRequest.md +28 -13
  535. data/docs/RegisterAffiliateClickResponse.md +24 -11
  536. data/docs/ResponseMetadata.md +20 -9
  537. data/docs/ResultSet.md +28 -13
  538. data/docs/ScreenRecording.md +116 -57
  539. data/docs/ScreenRecordingAdPlatform.md +30 -14
  540. data/docs/ScreenRecordingFilter.md +136 -67
  541. data/docs/ScreenRecordingFilterGeoDistance.md +26 -12
  542. data/docs/ScreenRecordingFilterIpSearch.md +24 -11
  543. data/docs/ScreenRecordingFilterPageView.md +50 -24
  544. data/docs/ScreenRecordingFilterPageViewEvent.md +20 -9
  545. data/docs/ScreenRecordingFilterPageViewEventParam.md +26 -12
  546. data/docs/ScreenRecordingFilterPageViewParam.md +20 -9
  547. data/docs/ScreenRecordingFilterPageViewReferrerParam.md +20 -9
  548. data/docs/ScreenRecordingFilterRangeBigDecimal.md +26 -12
  549. data/docs/ScreenRecordingFilterRangeDate.md +20 -9
  550. data/docs/ScreenRecordingFilterRangeInteger.md +26 -12
  551. data/docs/ScreenRecordingFilterStringSearch.md +26 -12
  552. data/docs/ScreenRecordingFilterValues.md +58 -28
  553. data/docs/ScreenRecordingFilterValuesEvent.md +20 -9
  554. data/docs/ScreenRecordingFilterValuesEventParams.md +26 -12
  555. data/docs/ScreenRecordingFilterValuesPageParam.md +20 -9
  556. data/docs/ScreenRecordingFilterValuesPageView.md +28 -13
  557. data/docs/ScreenRecordingHeatmap.md +64 -31
  558. data/docs/ScreenRecordingHeatmapIndexRequest.md +18 -8
  559. data/docs/ScreenRecordingHeatmapIndexResponse.md +26 -12
  560. data/docs/ScreenRecordingHeatmapRequest.md +22 -10
  561. data/docs/ScreenRecordingHeatmapReset.md +18 -8
  562. data/docs/ScreenRecordingHeatmapResponse.md +26 -12
  563. data/docs/ScreenRecordingHeatmapUrl.md +28 -13
  564. data/docs/ScreenRecordingMerchantNotesRequest.md +18 -8
  565. data/docs/ScreenRecordingMultifield.md +26 -12
  566. data/docs/ScreenRecordingPageView.md +54 -26
  567. data/docs/ScreenRecordingPageViewDataResponse.md +26 -12
  568. data/docs/ScreenRecordingPageViewEvent.md +28 -13
  569. data/docs/ScreenRecordingPageViewEventParameter.md +20 -9
  570. data/docs/ScreenRecordingPageViewParameter.md +20 -9
  571. data/docs/ScreenRecordingQueryRequest.md +18 -8
  572. data/docs/ScreenRecordingQueryResponse.md +38 -18
  573. data/docs/ScreenRecordingResponse.md +28 -13
  574. data/docs/ScreenRecordingSegment.md +36 -17
  575. data/docs/ScreenRecordingSegmentResponse.md +26 -12
  576. data/docs/ScreenRecordingSegmentsResponse.md +26 -12
  577. data/docs/ScreenRecordingSettings.md +32 -15
  578. data/docs/ScreenRecordingSettingsResponse.md +26 -12
  579. data/docs/ScreenRecordingStoreFront.md +20 -9
  580. data/docs/ScreenRecordingTagsRequest.md +18 -8
  581. data/docs/ScreenRecordingTagsResponse.md +26 -12
  582. data/docs/ScreenRecordingUserAgent.md +26 -12
  583. data/docs/ScreenRecordingUserAgentDevice.md +18 -8
  584. data/docs/ScreenRecordingUserAgentOS.md +22 -10
  585. data/docs/ScreenRecordingUserProperty.md +20 -9
  586. data/docs/ScreenshotsResponse.md +26 -12
  587. data/docs/SelfConfig.md +18 -8
  588. data/docs/SimpleValue.md +20 -9
  589. data/docs/SingleSignOnAuthorizeRequest.md +20 -9
  590. data/docs/SingleSignOnAuthorizeResponse.md +20 -9
  591. data/docs/SingleSignOnTokenRequest.md +20 -9
  592. data/docs/SingleSignOnTokenResponse.md +22 -10
  593. data/docs/SovosConfig.md +30 -14
  594. data/docs/SsoApi.md +288 -201
  595. data/docs/StateProvince.md +20 -9
  596. data/docs/StepWaiting.md +20 -9
  597. data/docs/StorefrontApi.md +11794 -8525
  598. data/docs/TaxApi.md +2017 -1421
  599. data/docs/TaxCity.md +34 -16
  600. data/docs/TaxCountry.md +34 -16
  601. data/docs/TaxCountryCode.md +26 -12
  602. data/docs/TaxCounty.md +36 -17
  603. data/docs/TaxJarConfig.md +30 -14
  604. data/docs/TaxPostalCode.md +30 -14
  605. data/docs/TaxProviderActivateResult.md +20 -9
  606. data/docs/TaxProviderAvalara.md +24 -11
  607. data/docs/TaxProviderAvalaraCompaniesResult.md +18 -8
  608. data/docs/TaxProviderAvalaraCompany.md +26 -12
  609. data/docs/TaxProviderSelf.md +26 -12
  610. data/docs/TaxProviderSelfCountriesResponse.md +18 -8
  611. data/docs/TaxProviderSelfRegionsResponse.md +18 -8
  612. data/docs/TaxProviderSovos.md +24 -11
  613. data/docs/TaxProviderTaxJar.md +24 -11
  614. data/docs/TaxProviderTestResult.md +20 -9
  615. data/docs/TaxProviderUltraCart.md +26 -12
  616. data/docs/TaxProviderUltraCartState.md +36 -17
  617. data/docs/TaxProvidersResponse.md +34 -16
  618. data/docs/TaxState.md +52 -25
  619. data/docs/TaxStateCode.md +26 -12
  620. data/docs/TempMultimedia.md +30 -14
  621. data/docs/TempMultimediaResponse.md +26 -12
  622. data/docs/ThumbnailParametersRequest.md +26 -12
  623. data/docs/ThumbnailParametersResponse.md +26 -12
  624. data/docs/TransactionEmail.md +56 -27
  625. data/docs/TransactionEmailListResponse.md +26 -12
  626. data/docs/TransactionEmailOption.md +32 -15
  627. data/docs/TransactionEmailResponse.md +26 -12
  628. data/docs/Twilio.md +24 -11
  629. data/docs/TwilioResponse.md +28 -13
  630. data/docs/TwiliosResponse.md +26 -12
  631. data/docs/UltraCartConfig.md +18 -8
  632. data/docs/UploadCouponCodesRequest.md +26 -12
  633. data/docs/UploadCouponCodesResponse.md +30 -14
  634. data/docs/User.md +44 -21
  635. data/docs/UserApi.md +790 -558
  636. data/docs/UserGroupMembership.md +22 -10
  637. data/docs/UserLogin.md +24 -11
  638. data/docs/UserLoginsResponse.md +26 -12
  639. data/docs/UserResponse.md +26 -12
  640. data/docs/UsersResponse.md +26 -12
  641. data/docs/VerificationRecord.md +22 -10
  642. data/docs/Warning.md +20 -9
  643. data/docs/Webhook.md +52 -25
  644. data/docs/WebhookApi.md +612 -447
  645. data/docs/WebhookEventCategory.md +26 -12
  646. data/docs/WebhookEventSubscription.md +34 -16
  647. data/docs/WebhookLog.md +38 -18
  648. data/docs/WebhookLogResponse.md +26 -12
  649. data/docs/WebhookLogSummariesResponse.md +26 -12
  650. data/docs/WebhookLogSummary.md +22 -10
  651. data/docs/WebhookResponse.md +26 -12
  652. data/docs/WebhookSampleRequest.md +24 -11
  653. data/docs/WebhookSampleRequestResponse.md +26 -12
  654. data/docs/WebhooksResponse.md +26 -12
  655. data/docs/Weight.md +20 -9
  656. data/git_push.sh +57 -55
  657. data/lib/ultracart_api/api/affiliate_api.rb +191 -164
  658. data/lib/ultracart_api/api/auto_order_api.rb +672 -581
  659. data/lib/ultracart_api/api/channel_partner_api.rb +370 -311
  660. data/lib/ultracart_api/api/chargeback_api.rb +410 -356
  661. data/lib/ultracart_api/api/checkout_api.rb +1341 -1111
  662. data/lib/ultracart_api/api/coupon_api.rb +1390 -1161
  663. data/lib/ultracart_api/api/customer_api.rb +1370 -1157
  664. data/lib/ultracart_api/api/fulfillment_api.rb +452 -381
  665. data/lib/ultracart_api/api/gift_certificate_api.rb +594 -502
  666. data/lib/ultracart_api/api/integration_log_api.rb +404 -350
  667. data/lib/ultracart_api/api/item_api.rb +686 -585
  668. data/lib/ultracart_api/api/oauth_api.rb +198 -171
  669. data/lib/ultracart_api/api/order_api.rb +1728 -1471
  670. data/lib/ultracart_api/api/sso_api.rb +289 -243
  671. data/lib/ultracart_api/api/storefront_api.rb +11407 -9617
  672. data/lib/ultracart_api/api/tax_api.rb +1916 -1580
  673. data/lib/ultracart_api/api/user_api.rb +755 -634
  674. data/lib/ultracart_api/api/webhook_api.rb +601 -514
  675. data/lib/ultracart_api/api_client.rb +399 -400
  676. data/lib/ultracart_api/api_error.rb +57 -38
  677. data/lib/ultracart_api/configuration.rb +302 -229
  678. data/lib/ultracart_api/models/accounts_receivable_retry_config.rb +364 -329
  679. data/lib/ultracart_api/models/accounts_receivable_retry_config_response.rb +287 -252
  680. data/lib/ultracart_api/models/accounts_receivable_retry_day_activity.rb +240 -205
  681. data/lib/ultracart_api/models/accounts_receivable_retry_stat_account.rb +250 -215
  682. data/lib/ultracart_api/models/accounts_receivable_retry_stat_metrics.rb +309 -274
  683. data/lib/ultracart_api/models/accounts_receivable_retry_stat_revenue.rb +228 -193
  684. data/lib/ultracart_api/models/accounts_receivable_retry_stats_response.rb +267 -232
  685. data/lib/ultracart_api/models/activity.rb +264 -229
  686. data/lib/ultracart_api/models/add_library_item_request.rb +324 -289
  687. data/lib/ultracart_api/models/adjust_internal_certificate_request.rb +270 -235
  688. data/lib/ultracart_api/models/adjust_internal_certificate_response.rb +267 -232
  689. data/lib/ultracart_api/models/affiliate_click.rb +319 -284
  690. data/lib/ultracart_api/models/affiliate_click_query.rb +270 -235
  691. data/lib/ultracart_api/models/affiliate_clicks_response.rb +259 -224
  692. data/lib/ultracart_api/models/affiliate_ledger.rb +431 -396
  693. data/lib/ultracart_api/models/affiliate_ledger_query.rb +270 -235
  694. data/lib/ultracart_api/models/affiliate_ledgers_response.rb +259 -224
  695. data/lib/ultracart_api/models/affiliate_link.rb +408 -373
  696. data/lib/ultracart_api/models/api_user_application_profile.rb +260 -225
  697. data/lib/ultracart_api/models/apply_library_item_request.rb +250 -215
  698. data/lib/ultracart_api/models/apply_library_item_response.rb +319 -284
  699. data/lib/ultracart_api/models/auto_order.rb +469 -434
  700. data/lib/ultracart_api/models/auto_order_item.rb +487 -452
  701. data/lib/ultracart_api/models/auto_order_item_future_schedule.rb +250 -215
  702. data/lib/ultracart_api/models/auto_order_item_option.rb +260 -225
  703. data/lib/ultracart_api/models/auto_order_item_simple_schedule.rb +274 -239
  704. data/lib/ultracart_api/models/auto_order_log.rb +230 -195
  705. data/lib/ultracart_api/models/auto_order_query.rb +480 -445
  706. data/lib/ultracart_api/models/auto_order_query_batch.rb +222 -187
  707. data/lib/ultracart_api/models/auto_order_response.rb +256 -221
  708. data/lib/ultracart_api/models/auto_orders_request.rb +222 -187
  709. data/lib/ultracart_api/models/auto_orders_response.rb +258 -223
  710. data/lib/ultracart_api/models/avalara_config.rb +340 -305
  711. data/lib/ultracart_api/models/base_response.rb +247 -212
  712. data/lib/ultracart_api/models/browser.rb +237 -202
  713. data/lib/ultracart_api/models/browser_device.rb +219 -184
  714. data/lib/ultracart_api/models/browser_os.rb +255 -220
  715. data/lib/ultracart_api/models/browser_user_agent.rb +246 -211
  716. data/lib/ultracart_api/models/cart.rb +506 -471
  717. data/lib/ultracart_api/models/cart_affiliate.rb +245 -210
  718. data/lib/ultracart_api/models/cart_affirm_checkout_response.rb +232 -197
  719. data/lib/ultracart_api/models/cart_billing.rb +572 -537
  720. data/lib/ultracart_api/models/cart_buysafe.rb +269 -234
  721. data/lib/ultracart_api/models/cart_checkout.rb +500 -465
  722. data/lib/ultracart_api/models/cart_coupon.rb +220 -185
  723. data/lib/ultracart_api/models/cart_currency_conversion.rb +232 -197
  724. data/lib/ultracart_api/models/cart_customer_profile.rb +438 -403
  725. data/lib/ultracart_api/models/cart_customer_profile_address.rb +350 -315
  726. data/lib/ultracart_api/models/cart_customer_profile_credit_card.rb +304 -269
  727. data/lib/ultracart_api/models/cart_finalize_order_request.rb +228 -193
  728. data/lib/ultracart_api/models/cart_finalize_order_request_options.rb +355 -320
  729. data/lib/ultracart_api/models/cart_finalize_order_response.rb +260 -225
  730. data/lib/ultracart_api/models/cart_gift.rb +313 -278
  731. data/lib/ultracart_api/models/cart_gift_certificate.rb +238 -203
  732. data/lib/ultracart_api/models/cart_item.rb +504 -469
  733. data/lib/ultracart_api/models/cart_item_attribute.rb +240 -205
  734. data/lib/ultracart_api/models/cart_item_multimedia.rb +336 -301
  735. data/lib/ultracart_api/models/cart_item_multimedia_thumbnail.rb +260 -225
  736. data/lib/ultracart_api/models/cart_item_option.rb +378 -343
  737. data/lib/ultracart_api/models/cart_item_option_value.rb +258 -223
  738. data/lib/ultracart_api/models/cart_item_physical.rb +246 -211
  739. data/lib/ultracart_api/models/cart_item_variation_selection.rb +230 -195
  740. data/lib/ultracart_api/models/cart_kit_component_option.rb +398 -363
  741. data/lib/ultracart_api/models/cart_marketing.rb +230 -195
  742. data/lib/ultracart_api/models/cart_payment.rb +275 -240
  743. data/lib/ultracart_api/models/cart_payment_affirm.rb +220 -185
  744. data/lib/ultracart_api/models/cart_payment_amazon.rb +220 -185
  745. data/lib/ultracart_api/models/cart_payment_check.rb +220 -185
  746. data/lib/ultracart_api/models/cart_payment_credit_card.rb +300 -265
  747. data/lib/ultracart_api/models/cart_payment_purchase_order.rb +220 -185
  748. data/lib/ultracart_api/models/cart_profile_login_request.rb +239 -204
  749. data/lib/ultracart_api/models/cart_profile_login_response.rb +231 -196
  750. data/lib/ultracart_api/models/cart_profile_register_request.rb +229 -194
  751. data/lib/ultracart_api/models/cart_profile_register_response.rb +231 -196
  752. data/lib/ultracart_api/models/cart_property.rb +280 -245
  753. data/lib/ultracart_api/models/cart_response.rb +231 -196
  754. data/lib/ultracart_api/models/cart_settings.rb +264 -229
  755. data/lib/ultracart_api/models/cart_settings_billing.rb +222 -187
  756. data/lib/ultracart_api/models/cart_settings_gift.rb +251 -216
  757. data/lib/ultracart_api/models/cart_settings_gift_wrap.rb +239 -204
  758. data/lib/ultracart_api/models/cart_settings_payment.rb +337 -302
  759. data/lib/ultracart_api/models/cart_settings_payment_amazon.rb +240 -205
  760. data/lib/ultracart_api/models/cart_settings_payment_credit_card.rb +242 -207
  761. data/lib/ultracart_api/models/cart_settings_payment_pay_pal.rb +260 -225
  762. data/lib/ultracart_api/models/cart_settings_province.rb +228 -193
  763. data/lib/ultracart_api/models/cart_settings_shipping.rb +262 -227
  764. data/lib/ultracart_api/models/cart_settings_shipping_calendar.rb +264 -229
  765. data/lib/ultracart_api/models/cart_settings_shipping_estimate.rb +345 -310
  766. data/lib/ultracart_api/models/cart_settings_taxes.rb +221 -186
  767. data/lib/ultracart_api/models/cart_settings_terms.rb +230 -195
  768. data/lib/ultracart_api/models/cart_shipping.rb +625 -590
  769. data/lib/ultracart_api/models/cart_summary.rb +354 -319
  770. data/lib/ultracart_api/models/cart_taxes.rb +255 -220
  771. data/lib/ultracart_api/models/cart_upsell_after.rb +255 -220
  772. data/lib/ultracart_api/models/cart_validation_request.rb +231 -196
  773. data/lib/ultracart_api/models/cart_validation_response.rb +231 -196
  774. data/lib/ultracart_api/models/channel_partner_cancel_response.rb +259 -224
  775. data/lib/ultracart_api/models/channel_partner_estimate_shipping_response.rb +259 -224
  776. data/lib/ultracart_api/models/channel_partner_estimate_tax_response.rb +256 -221
  777. data/lib/ultracart_api/models/channel_partner_import_response.rb +281 -246
  778. data/lib/ultracart_api/models/channel_partner_order.rb +1604 -1569
  779. data/lib/ultracart_api/models/channel_partner_order_item.rb +331 -296
  780. data/lib/ultracart_api/models/channel_partner_order_item_option.rb +230 -195
  781. data/lib/ultracart_api/models/channel_partner_order_transaction.rb +232 -197
  782. data/lib/ultracart_api/models/channel_partner_order_transaction_detail.rb +230 -195
  783. data/lib/ultracart_api/models/channel_partner_shipping_estimate.rb +230 -195
  784. data/lib/ultracart_api/models/chargeback_dispute.rb +649 -614
  785. data/lib/ultracart_api/models/chargeback_dispute_response.rb +256 -221
  786. data/lib/ultracart_api/models/chargeback_disputes_response.rb +258 -223
  787. data/lib/ultracart_api/models/checkout_allowed_countries_response.rb +221 -186
  788. data/lib/ultracart_api/models/checkout_handoff_request.rb +323 -288
  789. data/lib/ultracart_api/models/checkout_handoff_response.rb +241 -206
  790. data/lib/ultracart_api/models/checkout_setup_browser_key_request.rb +222 -187
  791. data/lib/ultracart_api/models/checkout_setup_browser_key_response.rb +220 -185
  792. data/lib/ultracart_api/models/checkout_state_province_response.rb +221 -186
  793. data/lib/ultracart_api/models/city_state_zip.rb +255 -220
  794. data/lib/ultracart_api/models/countries_response.rb +221 -186
  795. data/lib/ultracart_api/models/country.rb +260 -225
  796. data/lib/ultracart_api/models/coupon.rb +864 -829
  797. data/lib/ultracart_api/models/coupon_amount_off_items.rb +267 -232
  798. data/lib/ultracart_api/models/coupon_amount_off_shipping.rb +257 -222
  799. data/lib/ultracart_api/models/coupon_amount_off_shipping_with_items_purchase.rb +269 -234
  800. data/lib/ultracart_api/models/coupon_amount_off_subtotal.rb +245 -210
  801. data/lib/ultracart_api/models/coupon_amount_off_subtotal_and_shipping.rb +245 -210
  802. data/lib/ultracart_api/models/coupon_amount_off_subtotal_free_shipping_with_purchase.rb +267 -232
  803. data/lib/ultracart_api/models/coupon_amount_off_subtotal_with_block_purchase.rb +265 -230
  804. data/lib/ultracart_api/models/coupon_amount_off_subtotal_with_items_purchase.rb +267 -232
  805. data/lib/ultracart_api/models/coupon_amount_off_subtotal_with_purchase.rb +255 -220
  806. data/lib/ultracart_api/models/coupon_amount_shipping_with_subtotal.rb +267 -232
  807. data/lib/ultracart_api/models/coupon_auto_apply_condition.rb +239 -204
  808. data/lib/ultracart_api/models/coupon_auto_apply_conditions.rb +269 -234
  809. data/lib/ultracart_api/models/coupon_automatically_apply_coupon_codes.rb +222 -187
  810. data/lib/ultracart_api/models/coupon_buy_one_get_one_limit.rb +232 -197
  811. data/lib/ultracart_api/models/coupon_codes_request.rb +277 -242
  812. data/lib/ultracart_api/models/coupon_codes_response.rb +269 -234
  813. data/lib/ultracart_api/models/coupon_deletes_request.rb +234 -199
  814. data/lib/ultracart_api/models/coupon_discount_item_with_item_purchase.rb +275 -240
  815. data/lib/ultracart_api/models/coupon_discount_items.rb +267 -232
  816. data/lib/ultracart_api/models/coupon_editor_values.rb +330 -295
  817. data/lib/ultracart_api/models/coupon_exists_response.rb +267 -232
  818. data/lib/ultracart_api/models/coupon_free_item_and_shipping_with_subtotal.rb +279 -244
  819. data/lib/ultracart_api/models/coupon_free_item_with_item_purchase.rb +254 -219
  820. data/lib/ultracart_api/models/coupon_free_item_with_subtotal.rb +267 -232
  821. data/lib/ultracart_api/models/coupon_free_items_with_item_purchase.rb +260 -225
  822. data/lib/ultracart_api/models/coupon_free_items_with_mix_match_purchase.rb +260 -225
  823. data/lib/ultracart_api/models/coupon_free_shipping.rb +222 -187
  824. data/lib/ultracart_api/models/coupon_free_shipping_specific_items.rb +222 -187
  825. data/lib/ultracart_api/models/coupon_free_shipping_with_items_purchase.rb +234 -199
  826. data/lib/ultracart_api/models/coupon_free_shipping_with_subtotal.rb +257 -222
  827. data/lib/ultracart_api/models/coupon_item_search_result.rb +290 -255
  828. data/lib/ultracart_api/models/coupon_item_search_results_response.rb +259 -224
  829. data/lib/ultracart_api/models/coupon_multiple_amounts_off_items.rb +232 -197
  830. data/lib/ultracart_api/models/coupon_percent_off_item_with_items_quantity_purchase.rb +264 -229
  831. data/lib/ultracart_api/models/coupon_percent_off_items.rb +254 -219
  832. data/lib/ultracart_api/models/coupon_percent_off_items_and_free_shipping.rb +244 -209
  833. data/lib/ultracart_api/models/coupon_percent_off_items_with_items_purchase.rb +254 -219
  834. data/lib/ultracart_api/models/coupon_percent_off_msrp_items.rb +254 -219
  835. data/lib/ultracart_api/models/coupon_percent_off_retail_price_items.rb +254 -219
  836. data/lib/ultracart_api/models/coupon_percent_off_shipping.rb +232 -197
  837. data/lib/ultracart_api/models/coupon_percent_off_subtotal.rb +220 -185
  838. data/lib/ultracart_api/models/coupon_percent_off_subtotal_and_free_shipping.rb +232 -197
  839. data/lib/ultracart_api/models/coupon_percent_off_subtotal_limit.rb +255 -220
  840. data/lib/ultracart_api/models/coupon_percent_off_subtotal_with_items_purchase.rb +232 -197
  841. data/lib/ultracart_api/models/coupon_percent_off_subtotal_with_subtotal.rb +255 -220
  842. data/lib/ultracart_api/models/coupon_query.rb +310 -275
  843. data/lib/ultracart_api/models/coupon_response.rb +268 -233
  844. data/lib/ultracart_api/models/coupon_restriction.rb +246 -211
  845. data/lib/ultracart_api/models/coupon_tier_amount.rb +255 -220
  846. data/lib/ultracart_api/models/coupon_tier_item_discount.rb +232 -197
  847. data/lib/ultracart_api/models/coupon_tier_percent.rb +255 -220
  848. data/lib/ultracart_api/models/coupon_tier_quantity_amount.rb +255 -220
  849. data/lib/ultracart_api/models/coupon_tier_quantity_percent.rb +255 -220
  850. data/lib/ultracart_api/models/coupon_tiered_amount_off_items.rb +244 -209
  851. data/lib/ultracart_api/models/coupon_tiered_amount_off_subtotal.rb +234 -199
  852. data/lib/ultracart_api/models/coupon_tiered_percent_off_items.rb +244 -209
  853. data/lib/ultracart_api/models/coupon_tiered_percent_off_shipping.rb +259 -224
  854. data/lib/ultracart_api/models/coupon_tiered_percent_off_subtotal.rb +234 -199
  855. data/lib/ultracart_api/models/coupon_type.rb +230 -195
  856. data/lib/ultracart_api/models/coupons_request.rb +222 -187
  857. data/lib/ultracart_api/models/coupons_response.rb +258 -223
  858. data/lib/ultracart_api/models/currency.rb +260 -225
  859. data/lib/ultracart_api/models/customer.rb +978 -943
  860. data/lib/ultracart_api/models/customer_activity.rb +290 -255
  861. data/lib/ultracart_api/models/customer_affiliate.rb +250 -215
  862. data/lib/ultracart_api/models/customer_attachment.rb +260 -225
  863. data/lib/ultracart_api/models/customer_billing.rb +575 -540
  864. data/lib/ultracart_api/models/customer_card.rb +290 -255
  865. data/lib/ultracart_api/models/customer_editor_values.rb +328 -293
  866. data/lib/ultracart_api/models/customer_email.rb +300 -265
  867. data/lib/ultracart_api/models/customer_email_list_changes.rb +234 -199
  868. data/lib/ultracart_api/models/customer_loyalty.rb +283 -248
  869. data/lib/ultracart_api/models/customer_loyalty_ledger.rb +360 -325
  870. data/lib/ultracart_api/models/customer_loyalty_redemption.rb +340 -305
  871. data/lib/ultracart_api/models/customer_merge_request.rb +230 -195
  872. data/lib/ultracart_api/models/customer_orders_summary.rb +250 -215
  873. data/lib/ultracart_api/models/customer_pricing_tier.rb +245 -210
  874. data/lib/ultracart_api/models/customer_privacy.rb +250 -215
  875. data/lib/ultracart_api/models/customer_query.rb +789 -754
  876. data/lib/ultracart_api/models/customer_quotes_summary.rb +250 -215
  877. data/lib/ultracart_api/models/customer_response.rb +256 -221
  878. data/lib/ultracart_api/models/customer_reviewer.rb +310 -275
  879. data/lib/ultracart_api/models/customer_shipping.rb +575 -540
  880. data/lib/ultracart_api/models/customer_software_entitlement.rb +365 -330
  881. data/lib/ultracart_api/models/customer_store_credit.rb +274 -239
  882. data/lib/ultracart_api/models/customer_store_credit_add_request.rb +250 -215
  883. data/lib/ultracart_api/models/customer_store_credit_ledger_entry.rb +295 -260
  884. data/lib/ultracart_api/models/customer_store_credit_response.rb +256 -221
  885. data/lib/ultracart_api/models/customer_tag.rb +235 -200
  886. data/lib/ultracart_api/models/customer_tax_codes.rb +260 -225
  887. data/lib/ultracart_api/models/customers_response.rb +258 -223
  888. data/lib/ultracart_api/models/data_tables_server_side_response.rb +248 -213
  889. data/lib/ultracart_api/models/distance.rb +264 -229
  890. data/lib/ultracart_api/models/distribution_center.rb +559 -524
  891. data/lib/ultracart_api/models/distribution_centers_response.rb +258 -223
  892. data/lib/ultracart_api/models/email_base_template_list_response.rb +221 -186
  893. data/lib/ultracart_api/models/email_campaign.rb +467 -432
  894. data/lib/ultracart_api/models/email_campaign_folder.rb +275 -240
  895. data/lib/ultracart_api/models/email_campaign_folder_response.rb +256 -221
  896. data/lib/ultracart_api/models/email_campaign_folders_response.rb +258 -223
  897. data/lib/ultracart_api/models/email_campaign_response.rb +256 -221
  898. data/lib/ultracart_api/models/email_campaigns_response.rb +258 -223
  899. data/lib/ultracart_api/models/email_click.rb +230 -195
  900. data/lib/ultracart_api/models/email_clicks_response.rb +258 -223
  901. data/lib/ultracart_api/models/email_commseq.rb +252 -217
  902. data/lib/ultracart_api/models/email_commseq_email.rb +470 -435
  903. data/lib/ultracart_api/models/email_commseq_email_response.rb +256 -221
  904. data/lib/ultracart_api/models/email_commseq_email_send_test_request.rb +304 -269
  905. data/lib/ultracart_api/models/email_commseq_email_send_test_response.rb +247 -212
  906. data/lib/ultracart_api/models/email_commseq_emails_request.rb +258 -223
  907. data/lib/ultracart_api/models/email_commseq_emails_response.rb +258 -223
  908. data/lib/ultracart_api/models/email_commseq_postcard.rb +340 -305
  909. data/lib/ultracart_api/models/email_commseq_postcard_response.rb +256 -221
  910. data/lib/ultracart_api/models/email_commseq_postcard_send_test_request.rb +329 -294
  911. data/lib/ultracart_api/models/email_commseq_postcard_send_test_response.rb +274 -239
  912. data/lib/ultracart_api/models/email_commseq_postcards_request.rb +221 -186
  913. data/lib/ultracart_api/models/email_commseq_postcards_response.rb +258 -223
  914. data/lib/ultracart_api/models/email_commseq_response.rb +256 -221
  915. data/lib/ultracart_api/models/email_commseq_stat.rb +580 -545
  916. data/lib/ultracart_api/models/email_commseq_stat_response.rb +256 -221
  917. data/lib/ultracart_api/models/email_commseq_step.rb +348 -313
  918. data/lib/ultracart_api/models/email_commseq_step_log.rb +240 -205
  919. data/lib/ultracart_api/models/email_commseq_step_logs_response.rb +258 -223
  920. data/lib/ultracart_api/models/email_commseq_webhook_send_test_request.rb +275 -240
  921. data/lib/ultracart_api/models/email_commseq_webhook_send_test_response.rb +277 -242
  922. data/lib/ultracart_api/models/email_commseqs_response.rb +258 -223
  923. data/lib/ultracart_api/models/email_customer.rb +292 -257
  924. data/lib/ultracart_api/models/email_customer_editor_url_response.rb +256 -221
  925. data/lib/ultracart_api/models/email_customers_response.rb +262 -227
  926. data/lib/ultracart_api/models/email_dashboard_activity.rb +280 -245
  927. data/lib/ultracart_api/models/email_dashboard_activity_response.rb +258 -223
  928. data/lib/ultracart_api/models/email_dashboard_stats_response.rb +258 -223
  929. data/lib/ultracart_api/models/email_domain.rb +329 -294
  930. data/lib/ultracart_api/models/email_editor_token_response.rb +256 -221
  931. data/lib/ultracart_api/models/email_flow.rb +505 -470
  932. data/lib/ultracart_api/models/email_flow_back_populate_request.rb +230 -195
  933. data/lib/ultracart_api/models/email_flow_back_populate_response.rb +247 -212
  934. data/lib/ultracart_api/models/email_flow_folder.rb +275 -240
  935. data/lib/ultracart_api/models/email_flow_folder_response.rb +256 -221
  936. data/lib/ultracart_api/models/email_flow_folders_response.rb +258 -223
  937. data/lib/ultracart_api/models/email_flow_response.rb +256 -221
  938. data/lib/ultracart_api/models/email_flows_response.rb +258 -223
  939. data/lib/ultracart_api/models/email_global_settings.rb +219 -184
  940. data/lib/ultracart_api/models/email_global_settings_response.rb +256 -221
  941. data/lib/ultracart_api/models/email_global_unsubscribe_request.rb +219 -184
  942. data/lib/ultracart_api/models/email_global_unsubscribe_response.rb +219 -184
  943. data/lib/ultracart_api/models/email_histogram_property_names_response.rb +221 -186
  944. data/lib/ultracart_api/models/email_histogram_property_values_response.rb +221 -186
  945. data/lib/ultracart_api/models/email_list.rb +347 -312
  946. data/lib/ultracart_api/models/email_list_archive_response.rb +256 -221
  947. data/lib/ultracart_api/models/email_list_customer.rb +250 -215
  948. data/lib/ultracart_api/models/email_list_customers_response.rb +262 -227
  949. data/lib/ultracart_api/models/email_list_response.rb +256 -221
  950. data/lib/ultracart_api/models/email_list_segment_folder.rb +275 -240
  951. data/lib/ultracart_api/models/email_list_segment_folder_response.rb +256 -221
  952. data/lib/ultracart_api/models/email_list_segment_folders_response.rb +258 -223
  953. data/lib/ultracart_api/models/email_list_segment_membership.rb +250 -215
  954. data/lib/ultracart_api/models/email_list_segment_used_by.rb +240 -205
  955. data/lib/ultracart_api/models/email_list_subscribe_response.rb +228 -193
  956. data/lib/ultracart_api/models/email_lists_response.rb +258 -223
  957. data/lib/ultracart_api/models/email_order.rb +249 -214
  958. data/lib/ultracart_api/models/email_orders_response.rb +258 -223
  959. data/lib/ultracart_api/models/email_performance.rb +475 -440
  960. data/lib/ultracart_api/models/email_performance_customer_histogram.rb +222 -187
  961. data/lib/ultracart_api/models/email_performance_customer_histogram_period.rb +260 -225
  962. data/lib/ultracart_api/models/email_performance_daily.rb +280 -245
  963. data/lib/ultracart_api/models/email_performance_response.rb +256 -221
  964. data/lib/ultracart_api/models/email_plan.rb +365 -330
  965. data/lib/ultracart_api/models/email_plan_additional.rb +291 -256
  966. data/lib/ultracart_api/models/email_plan_response.rb +256 -221
  967. data/lib/ultracart_api/models/email_postcard_stat.rb +531 -496
  968. data/lib/ultracart_api/models/email_segment.rb +445 -410
  969. data/lib/ultracart_api/models/email_segment_archive_response.rb +256 -221
  970. data/lib/ultracart_api/models/email_segment_customer.rb +250 -215
  971. data/lib/ultracart_api/models/email_segment_customers_response.rb +262 -227
  972. data/lib/ultracart_api/models/email_segment_download_prepare_response.rb +283 -248
  973. data/lib/ultracart_api/models/email_segment_response.rb +256 -221
  974. data/lib/ultracart_api/models/email_segments_response.rb +258 -223
  975. data/lib/ultracart_api/models/email_sending_domain_response.rb +256 -221
  976. data/lib/ultracart_api/models/email_sending_domains_response.rb +258 -223
  977. data/lib/ultracart_api/models/email_settings.rb +318 -283
  978. data/lib/ultracart_api/models/email_settings_response.rb +256 -221
  979. data/lib/ultracart_api/models/email_stat.rb +591 -556
  980. data/lib/ultracart_api/models/email_stat_postcard_summary_request.rb +230 -195
  981. data/lib/ultracart_api/models/email_stat_postcard_summary_response.rb +258 -223
  982. data/lib/ultracart_api/models/email_stat_summary_request.rb +241 -206
  983. data/lib/ultracart_api/models/email_stat_summary_response.rb +258 -223
  984. data/lib/ultracart_api/models/email_step_stat.rb +410 -375
  985. data/lib/ultracart_api/models/email_step_stat_request.rb +230 -195
  986. data/lib/ultracart_api/models/email_step_stat_response.rb +258 -223
  987. data/lib/ultracart_api/models/email_step_waiting_request.rb +221 -186
  988. data/lib/ultracart_api/models/email_step_waiting_response.rb +221 -186
  989. data/lib/ultracart_api/models/email_template.rb +365 -330
  990. data/lib/ultracart_api/models/email_templates_response.rb +258 -223
  991. data/lib/ultracart_api/models/email_third_party_list.rb +230 -195
  992. data/lib/ultracart_api/models/email_third_party_list_import_request.rb +222 -187
  993. data/lib/ultracart_api/models/email_third_party_provider.rb +324 -289
  994. data/lib/ultracart_api/models/email_third_party_providers_response.rb +258 -223
  995. data/lib/ultracart_api/models/email_third_party_tag.rb +230 -195
  996. data/lib/ultracart_api/models/email_verify_token_request.rb +230 -195
  997. data/lib/ultracart_api/models/email_verify_token_response.rb +257 -222
  998. data/lib/ultracart_api/models/email_verify_token_validate_request.rb +220 -185
  999. data/lib/ultracart_api/models/email_verify_token_validate_response.rb +247 -212
  1000. data/lib/ultracart_api/models/email_webhook_editor_values_response.rb +278 -243
  1001. data/lib/ultracart_api/models/error.rb +260 -225
  1002. data/lib/ultracart_api/models/error_response.rb +247 -212
  1003. data/lib/ultracart_api/models/experiment.rb +426 -391
  1004. data/lib/ultracart_api/models/experiment_response.rb +256 -221
  1005. data/lib/ultracart_api/models/experiment_variation.rb +432 -397
  1006. data/lib/ultracart_api/models/experiment_variation_stat.rb +320 -285
  1007. data/lib/ultracart_api/models/experiments_response.rb +258 -223
  1008. data/lib/ultracart_api/models/fulfillment_inventory.rb +228 -193
  1009. data/lib/ultracart_api/models/fulfillment_shipment.rb +262 -227
  1010. data/lib/ultracart_api/models/geo_point.rb +228 -193
  1011. data/lib/ultracart_api/models/geocode_request.rb +260 -225
  1012. data/lib/ultracart_api/models/geocode_response.rb +265 -230
  1013. data/lib/ultracart_api/models/gift_certificate.rb +367 -332
  1014. data/lib/ultracart_api/models/gift_certificate_create_request.rb +260 -225
  1015. data/lib/ultracart_api/models/gift_certificate_ledger_entry.rb +285 -250
  1016. data/lib/ultracart_api/models/gift_certificate_query.rb +300 -265
  1017. data/lib/ultracart_api/models/gift_certificate_response.rb +256 -221
  1018. data/lib/ultracart_api/models/gift_certificates_response.rb +258 -223
  1019. data/lib/ultracart_api/models/group.rb +266 -231
  1020. data/lib/ultracart_api/models/group_response.rb +256 -221
  1021. data/lib/ultracart_api/models/group_user_membership.rb +260 -225
  1022. data/lib/ultracart_api/models/groups_response.rb +258 -223
  1023. data/lib/ultracart_api/models/http_header.rb +230 -195
  1024. data/lib/ultracart_api/models/integration_log.rb +379 -344
  1025. data/lib/ultracart_api/models/integration_log_file.rb +246 -211
  1026. data/lib/ultracart_api/models/integration_log_log.rb +228 -193
  1027. data/lib/ultracart_api/models/integration_log_query_filter_values.rb +340 -305
  1028. data/lib/ultracart_api/models/integration_log_query_request.rb +333 -298
  1029. data/lib/ultracart_api/models/integration_log_query_response.rb +267 -232
  1030. data/lib/ultracart_api/models/integration_log_response.rb +256 -221
  1031. data/lib/ultracart_api/models/integration_log_summary.rb +291 -256
  1032. data/lib/ultracart_api/models/integration_log_summary_query_request.rb +230 -195
  1033. data/lib/ultracart_api/models/integration_log_summary_query_response.rb +258 -223
  1034. data/lib/ultracart_api/models/item.rb +748 -713
  1035. data/lib/ultracart_api/models/item_accounting.rb +260 -225
  1036. data/lib/ultracart_api/models/item_amember.rb +245 -210
  1037. data/lib/ultracart_api/models/item_auto_order.rb +403 -368
  1038. data/lib/ultracart_api/models/item_auto_order_step.rb +413 -378
  1039. data/lib/ultracart_api/models/item_auto_order_step_arbitrary_unit_cost_schedule.rb +230 -195
  1040. data/lib/ultracart_api/models/item_auto_order_step_grandfather_pricing.rb +230 -195
  1041. data/lib/ultracart_api/models/item_cc_bill.rb +270 -235
  1042. data/lib/ultracart_api/models/item_channel_partner_mapping.rb +445 -410
  1043. data/lib/ultracart_api/models/item_chargeback.rb +234 -199
  1044. data/lib/ultracart_api/models/item_chargeback_addendum.rb +250 -215
  1045. data/lib/ultracart_api/models/item_chargeback_adjustment_request.rb +240 -205
  1046. data/lib/ultracart_api/models/item_checkout.rb +265 -230
  1047. data/lib/ultracart_api/models/item_content.rb +361 -326
  1048. data/lib/ultracart_api/models/item_content_assignment.rb +285 -250
  1049. data/lib/ultracart_api/models/item_content_attribute.rb +280 -245
  1050. data/lib/ultracart_api/models/item_content_multimedia.rb +441 -406
  1051. data/lib/ultracart_api/models/item_content_multimedia_thumbnail.rb +270 -235
  1052. data/lib/ultracart_api/models/item_digital_delivery.rb +317 -282
  1053. data/lib/ultracart_api/models/item_digital_item.rb +305 -270
  1054. data/lib/ultracart_api/models/item_ebay.rb +901 -866
  1055. data/lib/ultracart_api/models/item_ebay_category_specific.rb +230 -195
  1056. data/lib/ultracart_api/models/item_ebay_market_listing.rb +260 -225
  1057. data/lib/ultracart_api/models/item_ebay_market_place_analysis.rb +311 -276
  1058. data/lib/ultracart_api/models/item_email_notifications.rb +230 -195
  1059. data/lib/ultracart_api/models/item_enrollment123.rb +220 -185
  1060. data/lib/ultracart_api/models/item_fulfillment_addon.rb +250 -215
  1061. data/lib/ultracart_api/models/item_gift_certificate.rb +230 -195
  1062. data/lib/ultracart_api/models/item_google_product_search.rb +1289 -1254
  1063. data/lib/ultracart_api/models/item_identifiers.rb +310 -275
  1064. data/lib/ultracart_api/models/item_instant_payment_notification.rb +270 -235
  1065. data/lib/ultracart_api/models/item_instant_payment_notifications.rb +222 -187
  1066. data/lib/ultracart_api/models/item_internal.rb +235 -200
  1067. data/lib/ultracart_api/models/item_kit_component.rb +260 -225
  1068. data/lib/ultracart_api/models/item_kit_definition.rb +222 -187
  1069. data/lib/ultracart_api/models/item_option.rb +416 -381
  1070. data/lib/ultracart_api/models/item_option_value.rb +409 -374
  1071. data/lib/ultracart_api/models/item_option_value_additional_item.rb +230 -195
  1072. data/lib/ultracart_api/models/item_option_value_digital_item.rb +230 -195
  1073. data/lib/ultracart_api/models/item_payment_processing.rb +264 -229
  1074. data/lib/ultracart_api/models/item_physical.rb +246 -211
  1075. data/lib/ultracart_api/models/item_pricing.rb +422 -387
  1076. data/lib/ultracart_api/models/item_pricing_tier.rb +261 -226
  1077. data/lib/ultracart_api/models/item_pricing_tier_discount.rb +230 -195
  1078. data/lib/ultracart_api/models/item_pricing_tier_limit.rb +240 -205
  1079. data/lib/ultracart_api/models/item_property.rb +270 -235
  1080. data/lib/ultracart_api/models/item_realtime_pricing.rb +240 -205
  1081. data/lib/ultracart_api/models/item_related.rb +242 -207
  1082. data/lib/ultracart_api/models/item_related_item.rb +274 -239
  1083. data/lib/ultracart_api/models/item_reporting.rb +232 -197
  1084. data/lib/ultracart_api/models/item_response.rb +256 -221
  1085. data/lib/ultracart_api/models/item_restriction.rb +292 -257
  1086. data/lib/ultracart_api/models/item_restriction_item.rb +274 -239
  1087. data/lib/ultracart_api/models/item_revguard.rb +280 -245
  1088. data/lib/ultracart_api/models/item_reviews.rb +300 -265
  1089. data/lib/ultracart_api/models/item_salesforce.rb +230 -195
  1090. data/lib/ultracart_api/models/item_shipping.rb +713 -678
  1091. data/lib/ultracart_api/models/item_shipping_case.rb +265 -230
  1092. data/lib/ultracart_api/models/item_shipping_destination_markup.rb +315 -280
  1093. data/lib/ultracart_api/models/item_shipping_destination_restriction.rb +304 -269
  1094. data/lib/ultracart_api/models/item_shipping_distribution_center.rb +380 -345
  1095. data/lib/ultracart_api/models/item_shipping_method.rb +394 -359
  1096. data/lib/ultracart_api/models/item_shipping_package_requirement.rb +230 -195
  1097. data/lib/ultracart_api/models/item_tag.rb +279 -244
  1098. data/lib/ultracart_api/models/item_tags.rb +222 -187
  1099. data/lib/ultracart_api/models/item_tax.rb +286 -251
  1100. data/lib/ultracart_api/models/item_tax_exemption.rb +335 -300
  1101. data/lib/ultracart_api/models/item_third_party_email_marketing.rb +302 -267
  1102. data/lib/ultracart_api/models/item_variant_item.rb +289 -254
  1103. data/lib/ultracart_api/models/item_variation.rb +292 -257
  1104. data/lib/ultracart_api/models/item_variation_option.rb +265 -230
  1105. data/lib/ultracart_api/models/item_wishlist_member.rb +255 -220
  1106. data/lib/ultracart_api/models/items_request.rb +222 -187
  1107. data/lib/ultracart_api/models/items_response.rb +259 -224
  1108. data/lib/ultracart_api/models/key_value.rb +240 -205
  1109. data/lib/ultracart_api/models/library_filter_values.rb +254 -219
  1110. data/lib/ultracart_api/models/library_filter_values_response.rb +256 -221
  1111. data/lib/ultracart_api/models/library_item.rb +606 -571
  1112. data/lib/ultracart_api/models/library_item_account.rb +237 -202
  1113. data/lib/ultracart_api/models/library_item_asset.rb +228 -193
  1114. data/lib/ultracart_api/models/library_item_attribute.rb +228 -193
  1115. data/lib/ultracart_api/models/library_item_email.rb +237 -202
  1116. data/lib/ultracart_api/models/library_item_published_meta.rb +290 -255
  1117. data/lib/ultracart_api/models/library_item_purchased_meta.rb +240 -205
  1118. data/lib/ultracart_api/models/library_item_query.rb +330 -295
  1119. data/lib/ultracart_api/models/library_item_response.rb +256 -221
  1120. data/lib/ultracart_api/models/library_item_screenshot.rb +228 -193
  1121. data/lib/ultracart_api/models/library_items_response.rb +259 -224
  1122. data/lib/ultracart_api/models/linked_account.rb +240 -205
  1123. data/lib/ultracart_api/models/list_segment_membership.rb +237 -202
  1124. data/lib/ultracart_api/models/lookup_request.rb +255 -220
  1125. data/lib/ultracart_api/models/lookup_response.rb +258 -223
  1126. data/lib/ultracart_api/models/mailgun.rb +219 -184
  1127. data/lib/ultracart_api/models/metric.rb +282 -247
  1128. data/lib/ultracart_api/models/notification.rb +322 -287
  1129. data/lib/ultracart_api/models/oauth_revoke_success_response.rb +230 -195
  1130. data/lib/ultracart_api/models/oauth_token_response.rb +321 -286
  1131. data/lib/ultracart_api/models/order.rb +604 -569
  1132. data/lib/ultracart_api/models/order_affiliate.rb +242 -207
  1133. data/lib/ultracart_api/models/order_affiliate_ledger.rb +334 -299
  1134. data/lib/ultracart_api/models/order_auto_order.rb +448 -413
  1135. data/lib/ultracart_api/models/order_billing.rb +597 -562
  1136. data/lib/ultracart_api/models/order_buysafe.rb +268 -233
  1137. data/lib/ultracart_api/models/order_by_token_query.rb +220 -185
  1138. data/lib/ultracart_api/models/order_channel_partner.rb +335 -300
  1139. data/lib/ultracart_api/models/order_checkout.rb +469 -434
  1140. data/lib/ultracart_api/models/order_coupon.rb +290 -255
  1141. data/lib/ultracart_api/models/order_digital_item.rb +290 -255
  1142. data/lib/ultracart_api/models/order_digital_order.rb +262 -227
  1143. data/lib/ultracart_api/models/order_edi.rb +265 -230
  1144. data/lib/ultracart_api/models/order_format.rb +404 -369
  1145. data/lib/ultracart_api/models/order_format_response.rb +232 -197
  1146. data/lib/ultracart_api/models/order_fraud_score.rb +444 -409
  1147. data/lib/ultracart_api/models/order_gift.rb +351 -316
  1148. data/lib/ultracart_api/models/order_gift_certificate.rb +239 -204
  1149. data/lib/ultracart_api/models/order_internal.rb +275 -240
  1150. data/lib/ultracart_api/models/order_item.rb +889 -854
  1151. data/lib/ultracart_api/models/order_item_edi.rb +234 -199
  1152. data/lib/ultracart_api/models/order_item_edi_identification.rb +230 -195
  1153. data/lib/ultracart_api/models/order_item_edi_lot.rb +240 -205
  1154. data/lib/ultracart_api/models/order_item_option.rb +378 -343
  1155. data/lib/ultracart_api/models/order_item_option_file_attachment.rb +250 -215
  1156. data/lib/ultracart_api/models/order_item_property.rb +280 -245
  1157. data/lib/ultracart_api/models/order_item_tag.rb +235 -200
  1158. data/lib/ultracart_api/models/order_linked_shipment.rb +264 -229
  1159. data/lib/ultracart_api/models/order_marketing.rb +270 -235
  1160. data/lib/ultracart_api/models/order_packing_slip_response.rb +257 -222
  1161. data/lib/ultracart_api/models/order_payment.rb +432 -397
  1162. data/lib/ultracart_api/models/order_payment_check.rb +220 -185
  1163. data/lib/ultracart_api/models/order_payment_credit_card.rb +354 -319
  1164. data/lib/ultracart_api/models/order_payment_e_check.rb +476 -441
  1165. data/lib/ultracart_api/models/order_payment_insurance.rb +250 -215
  1166. data/lib/ultracart_api/models/order_payment_purchase_order.rb +220 -185
  1167. data/lib/ultracart_api/models/order_payment_transaction.rb +252 -217
  1168. data/lib/ultracart_api/models/order_payment_transaction_detail.rb +240 -205
  1169. data/lib/ultracart_api/models/order_process_payment_request.rb +230 -195
  1170. data/lib/ultracart_api/models/order_process_payment_response.rb +256 -221
  1171. data/lib/ultracart_api/models/order_property.rb +280 -245
  1172. data/lib/ultracart_api/models/order_query.rb +826 -791
  1173. data/lib/ultracart_api/models/order_query_batch.rb +222 -187
  1174. data/lib/ultracart_api/models/order_quote.rb +240 -205
  1175. data/lib/ultracart_api/models/order_replacement.rb +467 -432
  1176. data/lib/ultracart_api/models/order_replacement_item.rb +255 -220
  1177. data/lib/ultracart_api/models/order_replacement_response.rb +264 -229
  1178. data/lib/ultracart_api/models/order_response.rb +256 -221
  1179. data/lib/ultracart_api/models/order_salesforce.rb +220 -185
  1180. data/lib/ultracart_api/models/order_shipping.rb +770 -735
  1181. data/lib/ultracart_api/models/order_summary.rb +390 -355
  1182. data/lib/ultracart_api/models/order_tag.rb +235 -200
  1183. data/lib/ultracart_api/models/order_taxes.rb +395 -360
  1184. data/lib/ultracart_api/models/order_token_response.rb +257 -222
  1185. data/lib/ultracart_api/models/order_tracking_number_detail.rb +320 -285
  1186. data/lib/ultracart_api/models/order_tracking_number_details.rb +374 -339
  1187. data/lib/ultracart_api/models/orders_response.rb +259 -224
  1188. data/lib/ultracart_api/models/permission.rb +240 -205
  1189. data/lib/ultracart_api/models/pricing_tier.rb +533 -498
  1190. data/lib/ultracart_api/models/pricing_tier_notification.rb +270 -235
  1191. data/lib/ultracart_api/models/pricing_tiers_response.rb +259 -224
  1192. data/lib/ultracart_api/models/property.rb +228 -193
  1193. data/lib/ultracart_api/models/publish_library_item_request.rb +220 -185
  1194. data/lib/ultracart_api/models/register_affiliate_click_request.rb +270 -235
  1195. data/lib/ultracart_api/models/register_affiliate_click_response.rb +254 -219
  1196. data/lib/ultracart_api/models/response_metadata.rb +229 -194
  1197. data/lib/ultracart_api/models/result_set.rb +270 -235
  1198. data/lib/ultracart_api/models/screen_recording.rb +688 -653
  1199. data/lib/ultracart_api/models/screen_recording_ad_platform.rb +280 -245
  1200. data/lib/ultracart_api/models/screen_recording_filter.rb +758 -723
  1201. data/lib/ultracart_api/models/screen_recording_filter_geo_distance.rb +255 -220
  1202. data/lib/ultracart_api/models/screen_recording_filter_ip_search.rb +246 -211
  1203. data/lib/ultracart_api/models/screen_recording_filter_page_view.rb +369 -334
  1204. data/lib/ultracart_api/models/screen_recording_filter_page_view_event.rb +230 -195
  1205. data/lib/ultracart_api/models/screen_recording_filter_page_view_event_param.rb +255 -220
  1206. data/lib/ultracart_api/models/screen_recording_filter_page_view_param.rb +228 -193
  1207. data/lib/ultracart_api/models/screen_recording_filter_page_view_referrer_param.rb +228 -193
  1208. data/lib/ultracart_api/models/screen_recording_filter_range_big_decimal.rb +255 -220
  1209. data/lib/ultracart_api/models/screen_recording_filter_range_date.rb +230 -195
  1210. data/lib/ultracart_api/models/screen_recording_filter_range_integer.rb +255 -220
  1211. data/lib/ultracart_api/models/screen_recording_filter_string_search.rb +255 -220
  1212. data/lib/ultracart_api/models/screen_recording_filter_values.rb +435 -400
  1213. data/lib/ultracart_api/models/screen_recording_filter_values_event.rb +230 -195
  1214. data/lib/ultracart_api/models/screen_recording_filter_values_event_params.rb +263 -228
  1215. data/lib/ultracart_api/models/screen_recording_filter_values_page_param.rb +230 -195
  1216. data/lib/ultracart_api/models/screen_recording_filter_values_page_view.rb +272 -237
  1217. data/lib/ultracart_api/models/screen_recording_heatmap.rb +426 -391
  1218. data/lib/ultracart_api/models/screen_recording_heatmap_index_request.rb +219 -184
  1219. data/lib/ultracart_api/models/screen_recording_heatmap_index_response.rb +258 -223
  1220. data/lib/ultracart_api/models/screen_recording_heatmap_request.rb +239 -204
  1221. data/lib/ultracart_api/models/screen_recording_heatmap_reset.rb +219 -184
  1222. data/lib/ultracart_api/models/screen_recording_heatmap_response.rb +256 -221
  1223. data/lib/ultracart_api/models/screen_recording_heatmap_url.rb +266 -231
  1224. data/lib/ultracart_api/models/screen_recording_merchant_notes_request.rb +219 -184
  1225. data/lib/ultracart_api/models/screen_recording_multifield.rb +255 -220
  1226. data/lib/ultracart_api/models/screen_recording_page_view.rb +391 -356
  1227. data/lib/ultracart_api/models/screen_recording_page_view_data_response.rb +256 -221
  1228. data/lib/ultracart_api/models/screen_recording_page_view_event.rb +267 -232
  1229. data/lib/ultracart_api/models/screen_recording_page_view_event_parameter.rb +228 -193
  1230. data/lib/ultracart_api/models/screen_recording_page_view_parameter.rb +228 -193
  1231. data/lib/ultracart_api/models/screen_recording_query_request.rb +219 -184
  1232. data/lib/ultracart_api/models/screen_recording_query_response.rb +314 -279
  1233. data/lib/ultracart_api/models/screen_recording_response.rb +265 -230
  1234. data/lib/ultracart_api/models/screen_recording_segment.rb +302 -267
  1235. data/lib/ultracart_api/models/screen_recording_segment_response.rb +256 -221
  1236. data/lib/ultracart_api/models/screen_recording_segments_response.rb +258 -223
  1237. data/lib/ultracart_api/models/screen_recording_settings.rb +284 -249
  1238. data/lib/ultracart_api/models/screen_recording_settings_response.rb +256 -221
  1239. data/lib/ultracart_api/models/screen_recording_store_front.rb +228 -193
  1240. data/lib/ultracart_api/models/screen_recording_tags_request.rb +221 -186
  1241. data/lib/ultracart_api/models/screen_recording_tags_response.rb +258 -223
  1242. data/lib/ultracart_api/models/screen_recording_user_agent.rb +255 -220
  1243. data/lib/ultracart_api/models/screen_recording_user_agent_device.rb +219 -184
  1244. data/lib/ultracart_api/models/screen_recording_user_agent_os.rb +237 -202
  1245. data/lib/ultracart_api/models/screen_recording_user_property.rb +228 -193
  1246. data/lib/ultracart_api/models/screenshots_response.rb +259 -224
  1247. data/lib/ultracart_api/models/self_config.rb +220 -185
  1248. data/lib/ultracart_api/models/simple_value.rb +230 -195
  1249. data/lib/ultracart_api/models/single_sign_on_authorize_request.rb +230 -195
  1250. data/lib/ultracart_api/models/single_sign_on_authorize_response.rb +230 -195
  1251. data/lib/ultracart_api/models/single_sign_on_token_request.rb +230 -195
  1252. data/lib/ultracart_api/models/single_sign_on_token_response.rb +240 -205
  1253. data/lib/ultracart_api/models/sovos_config.rb +280 -245
  1254. data/lib/ultracart_api/models/state_province.rb +245 -210
  1255. data/lib/ultracart_api/models/step_waiting.rb +228 -193
  1256. data/lib/ultracart_api/models/tax_city.rb +302 -267
  1257. data/lib/ultracart_api/models/tax_country.rb +302 -267
  1258. data/lib/ultracart_api/models/tax_country_code.rb +260 -225
  1259. data/lib/ultracart_api/models/tax_county.rb +312 -277
  1260. data/lib/ultracart_api/models/tax_jar_config.rb +280 -245
  1261. data/lib/ultracart_api/models/tax_postal_code.rb +280 -245
  1262. data/lib/ultracart_api/models/tax_provider_activate_result.rb +229 -194
  1263. data/lib/ultracart_api/models/tax_provider_avalara.rb +249 -214
  1264. data/lib/ultracart_api/models/tax_provider_avalara_companies_result.rb +222 -187
  1265. data/lib/ultracart_api/models/tax_provider_avalara_company.rb +260 -225
  1266. data/lib/ultracart_api/models/tax_provider_self.rb +261 -226
  1267. data/lib/ultracart_api/models/tax_provider_self_countries_response.rb +222 -187
  1268. data/lib/ultracart_api/models/tax_provider_self_regions_response.rb +222 -187
  1269. data/lib/ultracart_api/models/tax_provider_sovos.rb +249 -214
  1270. data/lib/ultracart_api/models/tax_provider_tax_jar.rb +249 -214
  1271. data/lib/ultracart_api/models/tax_provider_test_result.rb +229 -194
  1272. data/lib/ultracart_api/models/tax_provider_ultra_cart.rb +261 -226
  1273. data/lib/ultracart_api/models/tax_provider_ultra_cart_state.rb +310 -275
  1274. data/lib/ultracart_api/models/tax_providers_response.rb +292 -257
  1275. data/lib/ultracart_api/models/tax_state.rb +392 -357
  1276. data/lib/ultracart_api/models/tax_state_code.rb +260 -225
  1277. data/lib/ultracart_api/models/temp_multimedia.rb +329 -294
  1278. data/lib/ultracart_api/models/temp_multimedia_response.rb +256 -221
  1279. data/lib/ultracart_api/models/thumbnail_parameters_request.rb +255 -220
  1280. data/lib/ultracart_api/models/thumbnail_parameters_response.rb +257 -222
  1281. data/lib/ultracart_api/models/transaction_email.rb +414 -379
  1282. data/lib/ultracart_api/models/transaction_email_list_response.rb +258 -223
  1283. data/lib/ultracart_api/models/transaction_email_option.rb +282 -247
  1284. data/lib/ultracart_api/models/transaction_email_response.rb +256 -221
  1285. data/lib/ultracart_api/models/twilio.rb +248 -213
  1286. data/lib/ultracart_api/models/twilio_response.rb +265 -230
  1287. data/lib/ultracart_api/models/twilios_response.rb +258 -223
  1288. data/lib/ultracart_api/models/ultra_cart_config.rb +220 -185
  1289. data/lib/ultracart_api/models/upload_coupon_codes_request.rb +259 -224
  1290. data/lib/ultracart_api/models/upload_coupon_codes_response.rb +283 -248
  1291. data/lib/ultracart_api/models/user.rb +377 -342
  1292. data/lib/ultracart_api/models/user_group_membership.rb +240 -205
  1293. data/lib/ultracart_api/models/user_login.rb +250 -215
  1294. data/lib/ultracart_api/models/user_logins_response.rb +259 -224
  1295. data/lib/ultracart_api/models/user_response.rb +256 -221
  1296. data/lib/ultracart_api/models/users_response.rb +258 -223
  1297. data/lib/ultracart_api/models/verification_record.rb +237 -202
  1298. data/lib/ultracart_api/models/warning.rb +230 -195
  1299. data/lib/ultracart_api/models/webhook.rb +437 -402
  1300. data/lib/ultracart_api/models/webhook_event_category.rb +264 -229
  1301. data/lib/ultracart_api/models/webhook_event_subscription.rb +300 -265
  1302. data/lib/ultracart_api/models/webhook_log.rb +324 -289
  1303. data/lib/ultracart_api/models/webhook_log_response.rb +256 -221
  1304. data/lib/ultracart_api/models/webhook_log_summaries_response.rb +259 -224
  1305. data/lib/ultracart_api/models/webhook_log_summary.rb +240 -205
  1306. data/lib/ultracart_api/models/webhook_response.rb +256 -221
  1307. data/lib/ultracart_api/models/webhook_sample_request.rb +252 -217
  1308. data/lib/ultracart_api/models/webhook_sample_request_response.rb +256 -221
  1309. data/lib/ultracart_api/models/webhooks_response.rb +258 -223
  1310. data/lib/ultracart_api/models/weight.rb +264 -229
  1311. data/lib/ultracart_api/version.rb +15 -15
  1312. data/lib/ultracart_api.rb +690 -691
  1313. data/spec/api_client_spec.rb +226 -243
  1314. data/spec/configuration_spec.rb +42 -42
  1315. data/spec/spec_helper.rb +111 -111
  1316. data/ultracart_api.gemspec +38 -46
  1317. metadata +4 -166
  1318. data/docs/CouponNoDiscount.md +0 -7
  1319. data/lib/ultracart_api/models/coupon_no_discount.rb +0 -175
@@ -1,1471 +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
- # @return [BaseResponse]
101
- def cancel_order(order_id, opts = {})
102
- data, _status_code, _headers = cancel_order_with_http_info(order_id, opts)
103
- data
104
- end
105
-
106
- # Cancel an order
107
- # Cancel an order on the UltraCart account. If the success flag is false, then consult the error message for why it failed.
108
- # @param order_id The order id to cancel.
109
- # @param [Hash] opts the optional parameters
110
- # @return [Array<(BaseResponse, Fixnum, Hash)>] BaseResponse data, response status code and response headers
111
- def cancel_order_with_http_info(order_id, opts = {})
112
- if @api_client.config.debugging
113
- @api_client.config.logger.debug 'Calling API: OrderApi.cancel_order ...'
114
- end
115
- # verify the required parameter 'order_id' is set
116
- if @api_client.config.client_side_validation && order_id.nil?
117
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.cancel_order"
118
- end
119
- # resource path
120
- local_var_path = '/order/orders/{order_id}/cancel'.sub('{' + 'order_id' + '}', order_id.to_s)
121
-
122
- # query parameters
123
- query_params = {}
124
-
125
- # header parameters
126
- header_params = {}
127
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
128
- # HTTP header 'Accept' (if needed)
129
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
130
- # HTTP header 'Content-Type'
131
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
132
-
133
- # form parameters
134
- form_params = {}
135
-
136
- # http body (model)
137
- post_body = nil
138
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
139
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
140
- :header_params => header_params,
141
- :query_params => query_params,
142
- :form_params => form_params,
143
- :body => post_body,
144
- :auth_names => auth_names,
145
- :return_type => 'BaseResponse')
146
- if @api_client.config.debugging
147
- @api_client.config.logger.debug "API called: OrderApi#cancel_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
148
- end
149
- return data, status_code, headers
150
- end
151
- # Delete an order
152
- # Delete an order on the UltraCart account.
153
- # @param order_id The order id to delete.
154
- # @param [Hash] opts the optional parameters
155
- # @return [nil]
156
- def delete_order(order_id, opts = {})
157
- delete_order_with_http_info(order_id, opts)
158
- nil
159
- end
160
-
161
- # Delete an order
162
- # Delete an order on the UltraCart account.
163
- # @param order_id The order id to delete.
164
- # @param [Hash] opts the optional parameters
165
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
166
- def delete_order_with_http_info(order_id, opts = {})
167
- if @api_client.config.debugging
168
- @api_client.config.logger.debug 'Calling API: OrderApi.delete_order ...'
169
- end
170
- # verify the required parameter 'order_id' is set
171
- if @api_client.config.client_side_validation && order_id.nil?
172
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.delete_order"
173
- end
174
- # resource path
175
- local_var_path = '/order/orders/{order_id}'.sub('{' + 'order_id' + '}', order_id.to_s)
176
-
177
- # query parameters
178
- query_params = {}
179
-
180
- # header parameters
181
- header_params = {}
182
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
183
- # HTTP header 'Accept' (if needed)
184
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
185
- # HTTP header 'Content-Type'
186
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
187
-
188
- # form parameters
189
- form_params = {}
190
-
191
- # http body (model)
192
- post_body = nil
193
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
194
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
195
- :header_params => header_params,
196
- :query_params => query_params,
197
- :form_params => form_params,
198
- :body => post_body,
199
- :auth_names => auth_names)
200
- if @api_client.config.debugging
201
- @api_client.config.logger.debug "API called: OrderApi#delete_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
202
- end
203
- return data, status_code, headers
204
- end
205
- # Duplicate an order
206
- # Perform a duplicate of the specified order_id and return a new order located in Accounts Receivable.
207
- # @param order_id The order id to duplicate.
208
- # @param [Hash] opts the optional parameters
209
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
210
- # @return [OrderResponse]
211
- def duplicate_order(order_id, opts = {})
212
- data, _status_code, _headers = duplicate_order_with_http_info(order_id, opts)
213
- data
214
- end
215
-
216
- # Duplicate an order
217
- # Perform a duplicate of the specified order_id and return a new order located in Accounts Receivable.
218
- # @param order_id The order id to duplicate.
219
- # @param [Hash] opts the optional parameters
220
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
221
- # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
222
- def duplicate_order_with_http_info(order_id, opts = {})
223
- if @api_client.config.debugging
224
- @api_client.config.logger.debug 'Calling API: OrderApi.duplicate_order ...'
225
- end
226
- # verify the required parameter 'order_id' is set
227
- if @api_client.config.client_side_validation && order_id.nil?
228
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.duplicate_order"
229
- end
230
- # resource path
231
- local_var_path = '/order/orders/{order_id}/duplicate'.sub('{' + 'order_id' + '}', order_id.to_s)
232
-
233
- # query parameters
234
- query_params = {}
235
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
236
-
237
- # header parameters
238
- header_params = {}
239
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
240
- # HTTP header 'Accept' (if needed)
241
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
242
- # HTTP header 'Content-Type'
243
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
244
-
245
- # form parameters
246
- form_params = {}
247
-
248
- # http body (model)
249
- post_body = nil
250
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
251
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
252
- :header_params => header_params,
253
- :query_params => query_params,
254
- :form_params => form_params,
255
- :body => post_body,
256
- :auth_names => auth_names,
257
- :return_type => 'OrderResponse')
258
- if @api_client.config.debugging
259
- @api_client.config.logger.debug "API called: OrderApi#duplicate_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
260
- end
261
- return data, status_code, headers
262
- end
263
- # Format order
264
- # Format the order for display at text or html
265
- # @param order_id The order id to format
266
- # @param format_options Format options
267
- # @param [Hash] opts the optional parameters
268
- # @return [OrderFormatResponse]
269
- def format(order_id, format_options, opts = {})
270
- data, _status_code, _headers = format_with_http_info(order_id, format_options, opts)
271
- data
272
- end
273
-
274
- # Format order
275
- # Format the order for display at text or html
276
- # @param order_id The order id to format
277
- # @param format_options Format options
278
- # @param [Hash] opts the optional parameters
279
- # @return [Array<(OrderFormatResponse, Fixnum, Hash)>] OrderFormatResponse data, response status code and response headers
280
- def format_with_http_info(order_id, format_options, opts = {})
281
- if @api_client.config.debugging
282
- @api_client.config.logger.debug 'Calling API: OrderApi.format ...'
283
- end
284
- # verify the required parameter 'order_id' is set
285
- if @api_client.config.client_side_validation && order_id.nil?
286
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.format"
287
- end
288
- # verify the required parameter 'format_options' is set
289
- if @api_client.config.client_side_validation && format_options.nil?
290
- fail ArgumentError, "Missing the required parameter 'format_options' when calling OrderApi.format"
291
- end
292
- # resource path
293
- local_var_path = '/order/orders/{order_id}/format'.sub('{' + 'order_id' + '}', order_id.to_s)
294
-
295
- # query parameters
296
- query_params = {}
297
-
298
- # header parameters
299
- header_params = {}
300
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
301
- # HTTP header 'Accept' (if needed)
302
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
303
- # HTTP header 'Content-Type'
304
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
305
-
306
- # form parameters
307
- form_params = {}
308
-
309
- # http body (model)
310
- post_body = @api_client.object_to_http_body(format_options)
311
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
312
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
313
- :header_params => header_params,
314
- :query_params => query_params,
315
- :form_params => form_params,
316
- :body => post_body,
317
- :auth_names => auth_names,
318
- :return_type => 'OrderFormatResponse')
319
- if @api_client.config.debugging
320
- @api_client.config.logger.debug "API called: OrderApi#format\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
321
- end
322
- return data, status_code, headers
323
- end
324
- # Generate an order token for a given order id
325
- # Retrieves a single order token for a given order id. The token can be used with the getOrderByToken API.
326
- # @param order_id The order id to generate a token for.
327
- # @param [Hash] opts the optional parameters
328
- # @return [OrderTokenResponse]
329
- def generate_order_token(order_id, opts = {})
330
- data, _status_code, _headers = generate_order_token_with_http_info(order_id, opts)
331
- data
332
- end
333
-
334
- # Generate an order token for a given order id
335
- # Retrieves a single order token for a given order id. The token can be used with the getOrderByToken API.
336
- # @param order_id The order id to generate a token for.
337
- # @param [Hash] opts the optional parameters
338
- # @return [Array<(OrderTokenResponse, Fixnum, Hash)>] OrderTokenResponse data, response status code and response headers
339
- def generate_order_token_with_http_info(order_id, opts = {})
340
- if @api_client.config.debugging
341
- @api_client.config.logger.debug 'Calling API: OrderApi.generate_order_token ...'
342
- end
343
- # verify the required parameter 'order_id' is set
344
- if @api_client.config.client_side_validation && order_id.nil?
345
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.generate_order_token"
346
- end
347
- # resource path
348
- local_var_path = '/order/orders/token/{order_id}'.sub('{' + 'order_id' + '}', order_id.to_s)
349
-
350
- # query parameters
351
- query_params = {}
352
-
353
- # header parameters
354
- header_params = {}
355
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
356
- # HTTP header 'Accept' (if needed)
357
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
358
- # HTTP header 'Content-Type'
359
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
360
-
361
- # form parameters
362
- form_params = {}
363
-
364
- # http body (model)
365
- post_body = nil
366
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
367
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
368
- :header_params => header_params,
369
- :query_params => query_params,
370
- :form_params => form_params,
371
- :body => post_body,
372
- :auth_names => auth_names,
373
- :return_type => 'OrderTokenResponse')
374
- if @api_client.config.debugging
375
- @api_client.config.logger.debug "API called: OrderApi#generate_order_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
376
- end
377
- return data, status_code, headers
378
- end
379
- # Generate a packing slip for this order across all distribution centers.
380
- # The packing slip PDF that is returned is base 64 encoded
381
- # @param order_id Order ID
382
- # @param [Hash] opts the optional parameters
383
- # @return [OrderPackingSlipResponse]
384
- def generate_packing_slip_all_dc(order_id, opts = {})
385
- data, _status_code, _headers = generate_packing_slip_all_dc_with_http_info(order_id, opts)
386
- data
387
- end
388
-
389
- # Generate a packing slip for this order across all distribution centers.
390
- # The packing slip PDF that is returned is base 64 encoded
391
- # @param order_id Order ID
392
- # @param [Hash] opts the optional parameters
393
- # @return [Array<(OrderPackingSlipResponse, Fixnum, Hash)>] OrderPackingSlipResponse data, response status code and response headers
394
- def generate_packing_slip_all_dc_with_http_info(order_id, opts = {})
395
- if @api_client.config.debugging
396
- @api_client.config.logger.debug 'Calling API: OrderApi.generate_packing_slip_all_dc ...'
397
- end
398
- # verify the required parameter 'order_id' is set
399
- if @api_client.config.client_side_validation && order_id.nil?
400
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.generate_packing_slip_all_dc"
401
- end
402
- # resource path
403
- local_var_path = '/order/orders/{order_id}/packing_slip'.sub('{' + 'order_id' + '}', order_id.to_s)
404
-
405
- # query parameters
406
- query_params = {}
407
-
408
- # header parameters
409
- header_params = {}
410
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
411
- # HTTP header 'Accept' (if needed)
412
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
413
- # HTTP header 'Content-Type'
414
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
415
-
416
- # form parameters
417
- form_params = {}
418
-
419
- # http body (model)
420
- post_body = nil
421
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
422
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
423
- :header_params => header_params,
424
- :query_params => query_params,
425
- :form_params => form_params,
426
- :body => post_body,
427
- :auth_names => auth_names,
428
- :return_type => 'OrderPackingSlipResponse')
429
- if @api_client.config.debugging
430
- @api_client.config.logger.debug "API called: OrderApi#generate_packing_slip_all_dc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
431
- end
432
- return data, status_code, headers
433
- end
434
- # Generate a packing slip for this order for the given distribution center.
435
- # The packing slip PDF that is returned is base 64 encoded
436
- # @param distribution_center_code Distribution center code
437
- # @param order_id Order ID
438
- # @param [Hash] opts the optional parameters
439
- # @return [OrderPackingSlipResponse]
440
- def generate_packing_slip_specific_dc(distribution_center_code, order_id, opts = {})
441
- data, _status_code, _headers = generate_packing_slip_specific_dc_with_http_info(distribution_center_code, order_id, opts)
442
- data
443
- end
444
-
445
- # Generate a packing slip for this order for the given distribution center.
446
- # The packing slip PDF that is returned is base 64 encoded
447
- # @param distribution_center_code Distribution center code
448
- # @param order_id Order ID
449
- # @param [Hash] opts the optional parameters
450
- # @return [Array<(OrderPackingSlipResponse, Fixnum, Hash)>] OrderPackingSlipResponse data, response status code and response headers
451
- def generate_packing_slip_specific_dc_with_http_info(distribution_center_code, order_id, opts = {})
452
- if @api_client.config.debugging
453
- @api_client.config.logger.debug 'Calling API: OrderApi.generate_packing_slip_specific_dc ...'
454
- end
455
- # verify the required parameter 'distribution_center_code' is set
456
- if @api_client.config.client_side_validation && distribution_center_code.nil?
457
- fail ArgumentError, "Missing the required parameter 'distribution_center_code' when calling OrderApi.generate_packing_slip_specific_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_specific_dc"
462
- end
463
- # resource path
464
- 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)
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_specific_dc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
492
- end
493
- return data, status_code, headers
494
- end
495
- # Retrieve A/R Retry Configuration
496
- # Retrieve A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.
497
- # @param [Hash] opts the optional parameters
498
- # @return [AccountsReceivableRetryConfigResponse]
499
- def get_accounts_receivable_retry_config(opts = {})
500
- data, _status_code, _headers = get_accounts_receivable_retry_config_with_http_info(opts)
501
- data
502
- end
503
-
504
- # Retrieve A/R Retry Configuration
505
- # Retrieve A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.
506
- # @param [Hash] opts the optional parameters
507
- # @return [Array<(AccountsReceivableRetryConfigResponse, Fixnum, Hash)>] AccountsReceivableRetryConfigResponse data, response status code and response headers
508
- def get_accounts_receivable_retry_config_with_http_info(opts = {})
509
- if @api_client.config.debugging
510
- @api_client.config.logger.debug 'Calling API: OrderApi.get_accounts_receivable_retry_config ...'
511
- end
512
- # resource path
513
- local_var_path = '/order/accountsReceivableRetryConfig'
514
-
515
- # query parameters
516
- query_params = {}
517
-
518
- # header parameters
519
- header_params = {}
520
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
521
- # HTTP header 'Accept' (if needed)
522
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
523
- # HTTP header 'Content-Type'
524
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
525
-
526
- # form parameters
527
- form_params = {}
528
-
529
- # http body (model)
530
- post_body = nil
531
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
532
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
533
- :header_params => header_params,
534
- :query_params => query_params,
535
- :form_params => form_params,
536
- :body => post_body,
537
- :auth_names => auth_names,
538
- :return_type => 'AccountsReceivableRetryConfigResponse')
539
- if @api_client.config.debugging
540
- @api_client.config.logger.debug "API called: OrderApi#get_accounts_receivable_retry_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
541
- end
542
- return data, status_code, headers
543
- end
544
- # Retrieve A/R Retry Statistics
545
- # Retrieve A/R Retry Statistics. This is primarily an internal API call. It is doubtful you would ever need to use it.
546
- # @param [Hash] opts the optional parameters
547
- # @option opts [String] :from
548
- # @option opts [String] :to
549
- # @return [AccountsReceivableRetryStatsResponse]
550
- def get_accounts_receivable_retry_stats(opts = {})
551
- data, _status_code, _headers = get_accounts_receivable_retry_stats_with_http_info(opts)
552
- data
553
- end
554
-
555
- # Retrieve A/R Retry Statistics
556
- # Retrieve A/R Retry Statistics. This is primarily an internal API call. It is doubtful you would ever need to use it.
557
- # @param [Hash] opts the optional parameters
558
- # @option opts [String] :from
559
- # @option opts [String] :to
560
- # @return [Array<(AccountsReceivableRetryStatsResponse, Fixnum, Hash)>] AccountsReceivableRetryStatsResponse data, response status code and response headers
561
- def get_accounts_receivable_retry_stats_with_http_info(opts = {})
562
- if @api_client.config.debugging
563
- @api_client.config.logger.debug 'Calling API: OrderApi.get_accounts_receivable_retry_stats ...'
564
- end
565
- # resource path
566
- local_var_path = '/order/accountsReceivableRetryConfig/stats'
567
-
568
- # query parameters
569
- query_params = {}
570
- query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
571
- query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
572
-
573
- # header parameters
574
- header_params = {}
575
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
576
- # HTTP header 'Accept' (if needed)
577
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
578
- # HTTP header 'Content-Type'
579
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
580
-
581
- # form parameters
582
- form_params = {}
583
-
584
- # http body (model)
585
- post_body = nil
586
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
587
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
588
- :header_params => header_params,
589
- :query_params => query_params,
590
- :form_params => form_params,
591
- :body => post_body,
592
- :auth_names => auth_names,
593
- :return_type => 'AccountsReceivableRetryStatsResponse')
594
- if @api_client.config.debugging
595
- @api_client.config.logger.debug "API called: OrderApi#get_accounts_receivable_retry_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
596
- end
597
- return data, status_code, headers
598
- end
599
- # Retrieve an order
600
- # Retrieves a single order using the specified order id.
601
- # @param order_id The order id to retrieve.
602
- # @param [Hash] opts the optional parameters
603
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
604
- # @return [OrderResponse]
605
- def get_order(order_id, opts = {})
606
- data, _status_code, _headers = get_order_with_http_info(order_id, opts)
607
- data
608
- end
609
-
610
- # Retrieve an order
611
- # Retrieves a single order using the specified order id.
612
- # @param order_id The order id to retrieve.
613
- # @param [Hash] opts the optional parameters
614
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
615
- # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
616
- def get_order_with_http_info(order_id, opts = {})
617
- if @api_client.config.debugging
618
- @api_client.config.logger.debug 'Calling API: OrderApi.get_order ...'
619
- end
620
- # verify the required parameter 'order_id' is set
621
- if @api_client.config.client_side_validation && order_id.nil?
622
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.get_order"
623
- end
624
- # resource path
625
- local_var_path = '/order/orders/{order_id}'.sub('{' + 'order_id' + '}', order_id.to_s)
626
-
627
- # query parameters
628
- query_params = {}
629
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
630
-
631
- # header parameters
632
- header_params = {}
633
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
634
- # HTTP header 'Accept' (if needed)
635
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
636
- # HTTP header 'Content-Type'
637
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
638
-
639
- # form parameters
640
- form_params = {}
641
-
642
- # http body (model)
643
- post_body = nil
644
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
645
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
646
- :header_params => header_params,
647
- :query_params => query_params,
648
- :form_params => form_params,
649
- :body => post_body,
650
- :auth_names => auth_names,
651
- :return_type => 'OrderResponse')
652
- if @api_client.config.debugging
653
- @api_client.config.logger.debug "API called: OrderApi#get_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
654
- end
655
- return data, status_code, headers
656
- end
657
- # Retrieve an order using a token
658
- # Retrieves a single order using the specified order token.
659
- # @param order_by_token_query Order by token query
660
- # @param [Hash] opts the optional parameters
661
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
662
- # @return [OrderResponse]
663
- def get_order_by_token(order_by_token_query, opts = {})
664
- data, _status_code, _headers = get_order_by_token_with_http_info(order_by_token_query, opts)
665
- data
666
- end
667
-
668
- # Retrieve an order using a token
669
- # Retrieves a single order using the specified order token.
670
- # @param order_by_token_query Order by token query
671
- # @param [Hash] opts the optional parameters
672
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
673
- # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
674
- def get_order_by_token_with_http_info(order_by_token_query, opts = {})
675
- if @api_client.config.debugging
676
- @api_client.config.logger.debug 'Calling API: OrderApi.get_order_by_token ...'
677
- end
678
- # verify the required parameter 'order_by_token_query' is set
679
- if @api_client.config.client_side_validation && order_by_token_query.nil?
680
- fail ArgumentError, "Missing the required parameter 'order_by_token_query' when calling OrderApi.get_order_by_token"
681
- end
682
- # resource path
683
- local_var_path = '/order/orders/token'
684
-
685
- # query parameters
686
- query_params = {}
687
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
688
-
689
- # header parameters
690
- header_params = {}
691
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
692
- # HTTP header 'Accept' (if needed)
693
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
694
- # HTTP header 'Content-Type'
695
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
696
-
697
- # form parameters
698
- form_params = {}
699
-
700
- # http body (model)
701
- post_body = @api_client.object_to_http_body(order_by_token_query)
702
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
703
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
704
- :header_params => header_params,
705
- :query_params => query_params,
706
- :form_params => form_params,
707
- :body => post_body,
708
- :auth_names => auth_names,
709
- :return_type => 'OrderResponse')
710
- if @api_client.config.debugging
711
- @api_client.config.logger.debug "API called: OrderApi#get_order_by_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
712
- end
713
- return data, status_code, headers
714
- end
715
- # Retrieve orders
716
- # 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.
717
- # @param [Hash] opts the optional parameters
718
- # @option opts [String] :order_id Order Id
719
- # @option opts [String] :payment_method Payment Method
720
- # @option opts [String] :company Company
721
- # @option opts [String] :first_name First Name
722
- # @option opts [String] :last_name Last Name
723
- # @option opts [String] :city City
724
- # @option opts [String] :state_region State/Region
725
- # @option opts [String] :postal_code Postal Code
726
- # @option opts [String] :country_code Country Code (ISO-3166 two letter)
727
- # @option opts [String] :phone Phone
728
- # @option opts [String] :email Email
729
- # @option opts [String] :cc_email CC Email
730
- # @option opts [Float] :total Total
731
- # @option opts [String] :screen_branding_theme_code Screen Branding Theme Code
732
- # @option opts [String] :storefront_host_name StoreFront Host Name
733
- # @option opts [String] :creation_date_begin Creation Date Begin
734
- # @option opts [String] :creation_date_end Creation Date End
735
- # @option opts [String] :payment_date_begin Payment Date Begin
736
- # @option opts [String] :payment_date_end Payment Date End
737
- # @option opts [String] :shipment_date_begin Shipment Date Begin
738
- # @option opts [String] :shipment_date_end Shipment Date End
739
- # @option opts [String] :rma RMA
740
- # @option opts [String] :purchase_order_number Purchase Order Number
741
- # @option opts [String] :item_id Item Id
742
- # @option opts [String] :current_stage Current Stage
743
- # @option opts [String] :channel_partner_code Channel Partner Code
744
- # @option opts [String] :channel_partner_order_id Channel Partner Order ID
745
- # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200) (default to 100)
746
- # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
747
- # @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.
748
- # @option opts [String] :_expand The object expansion to perform on the result.
749
- # @return [OrdersResponse]
750
- def get_orders(opts = {})
751
- data, _status_code, _headers = get_orders_with_http_info(opts)
752
- data
753
- end
754
-
755
- # Retrieve orders
756
- # 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.
757
- # @param [Hash] opts the optional parameters
758
- # @option opts [String] :order_id Order Id
759
- # @option opts [String] :payment_method Payment Method
760
- # @option opts [String] :company Company
761
- # @option opts [String] :first_name First Name
762
- # @option opts [String] :last_name Last Name
763
- # @option opts [String] :city City
764
- # @option opts [String] :state_region State/Region
765
- # @option opts [String] :postal_code Postal Code
766
- # @option opts [String] :country_code Country Code (ISO-3166 two letter)
767
- # @option opts [String] :phone Phone
768
- # @option opts [String] :email Email
769
- # @option opts [String] :cc_email CC Email
770
- # @option opts [Float] :total Total
771
- # @option opts [String] :screen_branding_theme_code Screen Branding Theme Code
772
- # @option opts [String] :storefront_host_name StoreFront Host Name
773
- # @option opts [String] :creation_date_begin Creation Date Begin
774
- # @option opts [String] :creation_date_end Creation Date End
775
- # @option opts [String] :payment_date_begin Payment Date Begin
776
- # @option opts [String] :payment_date_end Payment Date End
777
- # @option opts [String] :shipment_date_begin Shipment Date Begin
778
- # @option opts [String] :shipment_date_end Shipment Date End
779
- # @option opts [String] :rma RMA
780
- # @option opts [String] :purchase_order_number Purchase Order Number
781
- # @option opts [String] :item_id Item Id
782
- # @option opts [String] :current_stage Current Stage
783
- # @option opts [String] :channel_partner_code Channel Partner Code
784
- # @option opts [String] :channel_partner_order_id Channel Partner Order ID
785
- # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200)
786
- # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index.
787
- # @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.
788
- # @option opts [String] :_expand The object expansion to perform on the result.
789
- # @return [Array<(OrdersResponse, Fixnum, Hash)>] OrdersResponse data, response status code and response headers
790
- def get_orders_with_http_info(opts = {})
791
- if @api_client.config.debugging
792
- @api_client.config.logger.debug 'Calling API: OrderApi.get_orders ...'
793
- end
794
- # resource path
795
- local_var_path = '/order/orders'
796
-
797
- # query parameters
798
- query_params = {}
799
- query_params[:'order_id'] = opts[:'order_id'] if !opts[:'order_id'].nil?
800
- query_params[:'payment_method'] = opts[:'payment_method'] if !opts[:'payment_method'].nil?
801
- query_params[:'company'] = opts[:'company'] if !opts[:'company'].nil?
802
- query_params[:'first_name'] = opts[:'first_name'] if !opts[:'first_name'].nil?
803
- query_params[:'last_name'] = opts[:'last_name'] if !opts[:'last_name'].nil?
804
- query_params[:'city'] = opts[:'city'] if !opts[:'city'].nil?
805
- query_params[:'state_region'] = opts[:'state_region'] if !opts[:'state_region'].nil?
806
- query_params[:'postal_code'] = opts[:'postal_code'] if !opts[:'postal_code'].nil?
807
- query_params[:'country_code'] = opts[:'country_code'] if !opts[:'country_code'].nil?
808
- query_params[:'phone'] = opts[:'phone'] if !opts[:'phone'].nil?
809
- query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
810
- query_params[:'cc_email'] = opts[:'cc_email'] if !opts[:'cc_email'].nil?
811
- query_params[:'total'] = opts[:'total'] if !opts[:'total'].nil?
812
- query_params[:'screen_branding_theme_code'] = opts[:'screen_branding_theme_code'] if !opts[:'screen_branding_theme_code'].nil?
813
- query_params[:'storefront_host_name'] = opts[:'storefront_host_name'] if !opts[:'storefront_host_name'].nil?
814
- query_params[:'creation_date_begin'] = opts[:'creation_date_begin'] if !opts[:'creation_date_begin'].nil?
815
- query_params[:'creation_date_end'] = opts[:'creation_date_end'] if !opts[:'creation_date_end'].nil?
816
- query_params[:'payment_date_begin'] = opts[:'payment_date_begin'] if !opts[:'payment_date_begin'].nil?
817
- query_params[:'payment_date_end'] = opts[:'payment_date_end'] if !opts[:'payment_date_end'].nil?
818
- query_params[:'shipment_date_begin'] = opts[:'shipment_date_begin'] if !opts[:'shipment_date_begin'].nil?
819
- query_params[:'shipment_date_end'] = opts[:'shipment_date_end'] if !opts[:'shipment_date_end'].nil?
820
- query_params[:'rma'] = opts[:'rma'] if !opts[:'rma'].nil?
821
- query_params[:'purchase_order_number'] = opts[:'purchase_order_number'] if !opts[:'purchase_order_number'].nil?
822
- query_params[:'item_id'] = opts[:'item_id'] if !opts[:'item_id'].nil?
823
- query_params[:'current_stage'] = opts[:'current_stage'] if !opts[:'current_stage'].nil?
824
- query_params[:'channel_partner_code'] = opts[:'channel_partner_code'] if !opts[:'channel_partner_code'].nil?
825
- query_params[:'channel_partner_order_id'] = opts[:'channel_partner_order_id'] if !opts[:'channel_partner_order_id'].nil?
826
- query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
827
- query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
828
- query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
829
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
830
-
831
- # header parameters
832
- header_params = {}
833
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
834
- # HTTP header 'Accept' (if needed)
835
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
836
- # HTTP header 'Content-Type'
837
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
838
-
839
- # form parameters
840
- form_params = {}
841
-
842
- # http body (model)
843
- post_body = nil
844
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
845
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
846
- :header_params => header_params,
847
- :query_params => query_params,
848
- :form_params => form_params,
849
- :body => post_body,
850
- :auth_names => auth_names,
851
- :return_type => 'OrdersResponse')
852
- if @api_client.config.debugging
853
- @api_client.config.logger.debug "API called: OrderApi#get_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
854
- end
855
- return data, status_code, headers
856
- end
857
- # Retrieve order batch
858
- # 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.
859
- # @param order_batch Order batch
860
- # @param [Hash] opts the optional parameters
861
- # @option opts [String] :_expand The object expansion to perform on the result.
862
- # @return [OrdersResponse]
863
- def get_orders_batch(order_batch, opts = {})
864
- data, _status_code, _headers = get_orders_batch_with_http_info(order_batch, opts)
865
- data
866
- end
867
-
868
- # Retrieve order batch
869
- # 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.
870
- # @param order_batch Order batch
871
- # @param [Hash] opts the optional parameters
872
- # @option opts [String] :_expand The object expansion to perform on the result.
873
- # @return [Array<(OrdersResponse, Fixnum, Hash)>] OrdersResponse data, response status code and response headers
874
- def get_orders_batch_with_http_info(order_batch, opts = {})
875
- if @api_client.config.debugging
876
- @api_client.config.logger.debug 'Calling API: OrderApi.get_orders_batch ...'
877
- end
878
- # verify the required parameter 'order_batch' is set
879
- if @api_client.config.client_side_validation && order_batch.nil?
880
- fail ArgumentError, "Missing the required parameter 'order_batch' when calling OrderApi.get_orders_batch"
881
- end
882
- # resource path
883
- local_var_path = '/order/orders/batch'
884
-
885
- # query parameters
886
- query_params = {}
887
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
888
-
889
- # header parameters
890
- header_params = {}
891
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
892
- # HTTP header 'Accept' (if needed)
893
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
894
- # HTTP header 'Content-Type'
895
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
896
-
897
- # form parameters
898
- form_params = {}
899
-
900
- # http body (model)
901
- post_body = @api_client.object_to_http_body(order_batch)
902
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
903
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
904
- :header_params => header_params,
905
- :query_params => query_params,
906
- :form_params => form_params,
907
- :body => post_body,
908
- :auth_names => auth_names,
909
- :return_type => 'OrdersResponse')
910
- if @api_client.config.debugging
911
- @api_client.config.logger.debug "API called: OrderApi#get_orders_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
912
- end
913
- return data, status_code, headers
914
- end
915
- # Retrieve orders by query
916
- # 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.
917
- # @param order_query Order query
918
- # @param [Hash] opts the optional parameters
919
- # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200) (default to 100)
920
- # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
921
- # @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.
922
- # @option opts [String] :_expand The object expansion to perform on the result.
923
- # @return [OrdersResponse]
924
- def get_orders_by_query(order_query, opts = {})
925
- data, _status_code, _headers = get_orders_by_query_with_http_info(order_query, opts)
926
- data
927
- end
928
-
929
- # Retrieve orders by query
930
- # 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.
931
- # @param order_query Order query
932
- # @param [Hash] opts the optional parameters
933
- # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200)
934
- # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index.
935
- # @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.
936
- # @option opts [String] :_expand The object expansion to perform on the result.
937
- # @return [Array<(OrdersResponse, Fixnum, Hash)>] OrdersResponse data, response status code and response headers
938
- def get_orders_by_query_with_http_info(order_query, opts = {})
939
- if @api_client.config.debugging
940
- @api_client.config.logger.debug 'Calling API: OrderApi.get_orders_by_query ...'
941
- end
942
- # verify the required parameter 'order_query' is set
943
- if @api_client.config.client_side_validation && order_query.nil?
944
- fail ArgumentError, "Missing the required parameter 'order_query' when calling OrderApi.get_orders_by_query"
945
- end
946
- # resource path
947
- local_var_path = '/order/orders/query'
948
-
949
- # query parameters
950
- query_params = {}
951
- query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
952
- query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
953
- query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
954
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
955
-
956
- # header parameters
957
- header_params = {}
958
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
959
- # HTTP header 'Accept' (if needed)
960
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
961
- # HTTP header 'Content-Type'
962
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
963
-
964
- # form parameters
965
- form_params = {}
966
-
967
- # http body (model)
968
- post_body = @api_client.object_to_http_body(order_query)
969
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
970
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
971
- :header_params => header_params,
972
- :query_params => query_params,
973
- :form_params => form_params,
974
- :body => post_body,
975
- :auth_names => auth_names,
976
- :return_type => 'OrdersResponse')
977
- if @api_client.config.debugging
978
- @api_client.config.logger.debug "API called: OrderApi#get_orders_by_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
979
- end
980
- return data, status_code, headers
981
- end
982
- # Insert an order
983
- # 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.
984
- # @param order Order to insert
985
- # @param [Hash] opts the optional parameters
986
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
987
- # @return [OrderResponse]
988
- def insert_order(order, opts = {})
989
- data, _status_code, _headers = insert_order_with_http_info(order, opts)
990
- data
991
- end
992
-
993
- # Insert an order
994
- # 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.
995
- # @param order Order to insert
996
- # @param [Hash] opts the optional parameters
997
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
998
- # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
999
- def insert_order_with_http_info(order, opts = {})
1000
- if @api_client.config.debugging
1001
- @api_client.config.logger.debug 'Calling API: OrderApi.insert_order ...'
1002
- end
1003
- # verify the required parameter 'order' is set
1004
- if @api_client.config.client_side_validation && order.nil?
1005
- fail ArgumentError, "Missing the required parameter 'order' when calling OrderApi.insert_order"
1006
- end
1007
- # resource path
1008
- local_var_path = '/order/orders'
1009
-
1010
- # query parameters
1011
- query_params = {}
1012
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1013
-
1014
- # header parameters
1015
- header_params = {}
1016
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1017
- # HTTP header 'Accept' (if needed)
1018
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1019
- # HTTP header 'Content-Type'
1020
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1021
-
1022
- # form parameters
1023
- form_params = {}
1024
-
1025
- # http body (model)
1026
- post_body = @api_client.object_to_http_body(order)
1027
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1028
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1029
- :header_params => header_params,
1030
- :query_params => query_params,
1031
- :form_params => form_params,
1032
- :body => post_body,
1033
- :auth_names => auth_names,
1034
- :return_type => 'OrderResponse')
1035
- if @api_client.config.debugging
1036
- @api_client.config.logger.debug "API called: OrderApi#insert_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1037
- end
1038
- return data, status_code, headers
1039
- end
1040
- # Process payment
1041
- # Process payment on order
1042
- # @param order_id The order id to process payment on
1043
- # @param process_payment_request Process payment parameters
1044
- # @param [Hash] opts the optional parameters
1045
- # @return [OrderProcessPaymentResponse]
1046
- def process_payment(order_id, process_payment_request, opts = {})
1047
- data, _status_code, _headers = process_payment_with_http_info(order_id, process_payment_request, opts)
1048
- data
1049
- end
1050
-
1051
- # Process payment
1052
- # Process payment on order
1053
- # @param order_id The order id to process payment on
1054
- # @param process_payment_request Process payment parameters
1055
- # @param [Hash] opts the optional parameters
1056
- # @return [Array<(OrderProcessPaymentResponse, Fixnum, Hash)>] OrderProcessPaymentResponse data, response status code and response headers
1057
- def process_payment_with_http_info(order_id, process_payment_request, opts = {})
1058
- if @api_client.config.debugging
1059
- @api_client.config.logger.debug 'Calling API: OrderApi.process_payment ...'
1060
- end
1061
- # verify the required parameter 'order_id' is set
1062
- if @api_client.config.client_side_validation && order_id.nil?
1063
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.process_payment"
1064
- end
1065
- # verify the required parameter 'process_payment_request' is set
1066
- if @api_client.config.client_side_validation && process_payment_request.nil?
1067
- fail ArgumentError, "Missing the required parameter 'process_payment_request' when calling OrderApi.process_payment"
1068
- end
1069
- # resource path
1070
- local_var_path = '/order/orders/{order_id}/process_payment'.sub('{' + 'order_id' + '}', order_id.to_s)
1071
-
1072
- # query parameters
1073
- query_params = {}
1074
-
1075
- # header parameters
1076
- header_params = {}
1077
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1078
- # HTTP header 'Accept' (if needed)
1079
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1080
- # HTTP header 'Content-Type'
1081
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1082
-
1083
- # form parameters
1084
- form_params = {}
1085
-
1086
- # http body (model)
1087
- post_body = @api_client.object_to_http_body(process_payment_request)
1088
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1089
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1090
- :header_params => header_params,
1091
- :query_params => query_params,
1092
- :form_params => form_params,
1093
- :body => post_body,
1094
- :auth_names => auth_names,
1095
- :return_type => 'OrderProcessPaymentResponse')
1096
- if @api_client.config.debugging
1097
- @api_client.config.logger.debug "API called: OrderApi#process_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1098
- end
1099
- return data, status_code, headers
1100
- end
1101
- # Refund an order
1102
- # Perform a refund operation on an order and then update the order if successful
1103
- # @param order Order to refund
1104
- # @param order_id The order id to refund.
1105
- # @param [Hash] opts the optional parameters
1106
- # @option opts [BOOLEAN] :reject_after_refund Reject order after refund (default to false)
1107
- # @option opts [BOOLEAN] :skip_customer_notification Skip customer email notification (default to false)
1108
- # @option opts [BOOLEAN] :auto_order_cancel Cancel associated auto orders (default to false)
1109
- # @option opts [BOOLEAN] :manual_refund Consider a manual refund done externally (default to false)
1110
- # @option opts [BOOLEAN] :reverse_affiliate_transactions Reverse affiliate transactions (default to true)
1111
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1112
- # @return [OrderResponse]
1113
- def refund_order(order, order_id, opts = {})
1114
- data, _status_code, _headers = refund_order_with_http_info(order, order_id, opts)
1115
- data
1116
- end
1117
-
1118
- # Refund an order
1119
- # Perform a refund operation on an order and then update the order if successful
1120
- # @param order Order to refund
1121
- # @param order_id The order id to refund.
1122
- # @param [Hash] opts the optional parameters
1123
- # @option opts [BOOLEAN] :reject_after_refund Reject order after refund
1124
- # @option opts [BOOLEAN] :skip_customer_notification Skip customer email notification
1125
- # @option opts [BOOLEAN] :auto_order_cancel Cancel associated auto orders
1126
- # @option opts [BOOLEAN] :manual_refund Consider a manual refund done externally
1127
- # @option opts [BOOLEAN] :reverse_affiliate_transactions Reverse affiliate transactions
1128
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1129
- # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
1130
- def refund_order_with_http_info(order, order_id, opts = {})
1131
- if @api_client.config.debugging
1132
- @api_client.config.logger.debug 'Calling API: OrderApi.refund_order ...'
1133
- end
1134
- # verify the required parameter 'order' is set
1135
- if @api_client.config.client_side_validation && order.nil?
1136
- fail ArgumentError, "Missing the required parameter 'order' when calling OrderApi.refund_order"
1137
- end
1138
- # verify the required parameter 'order_id' is set
1139
- if @api_client.config.client_side_validation && order_id.nil?
1140
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.refund_order"
1141
- end
1142
- # resource path
1143
- local_var_path = '/order/orders/{order_id}/refund'.sub('{' + 'order_id' + '}', order_id.to_s)
1144
-
1145
- # query parameters
1146
- query_params = {}
1147
- query_params[:'reject_after_refund'] = opts[:'reject_after_refund'] if !opts[:'reject_after_refund'].nil?
1148
- query_params[:'skip_customer_notification'] = opts[:'skip_customer_notification'] if !opts[:'skip_customer_notification'].nil?
1149
- query_params[:'auto_order_cancel'] = opts[:'auto_order_cancel'] if !opts[:'auto_order_cancel'].nil?
1150
- query_params[:'manual_refund'] = opts[:'manual_refund'] if !opts[:'manual_refund'].nil?
1151
- query_params[:'reverse_affiliate_transactions'] = opts[:'reverse_affiliate_transactions'] if !opts[:'reverse_affiliate_transactions'].nil?
1152
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1153
-
1154
- # header parameters
1155
- header_params = {}
1156
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1157
- # HTTP header 'Accept' (if needed)
1158
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1159
- # HTTP header 'Content-Type'
1160
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1161
-
1162
- # form parameters
1163
- form_params = {}
1164
-
1165
- # http body (model)
1166
- post_body = @api_client.object_to_http_body(order)
1167
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1168
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1169
- :header_params => header_params,
1170
- :query_params => query_params,
1171
- :form_params => form_params,
1172
- :body => post_body,
1173
- :auth_names => auth_names,
1174
- :return_type => 'OrderResponse')
1175
- if @api_client.config.debugging
1176
- @api_client.config.logger.debug "API called: OrderApi#refund_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1177
- end
1178
- return data, status_code, headers
1179
- end
1180
- # Replacement order
1181
- # Create a replacement order based upon a previous order
1182
- # @param order_id The order id to generate a replacement for.
1183
- # @param replacement Replacement order details
1184
- # @param [Hash] opts the optional parameters
1185
- # @return [OrderReplacementResponse]
1186
- def replacement(order_id, replacement, opts = {})
1187
- data, _status_code, _headers = replacement_with_http_info(order_id, replacement, opts)
1188
- data
1189
- end
1190
-
1191
- # Replacement order
1192
- # Create a replacement order based upon a previous order
1193
- # @param order_id The order id to generate a replacement for.
1194
- # @param replacement Replacement order details
1195
- # @param [Hash] opts the optional parameters
1196
- # @return [Array<(OrderReplacementResponse, Fixnum, Hash)>] OrderReplacementResponse data, response status code and response headers
1197
- def replacement_with_http_info(order_id, replacement, opts = {})
1198
- if @api_client.config.debugging
1199
- @api_client.config.logger.debug 'Calling API: OrderApi.replacement ...'
1200
- end
1201
- # verify the required parameter 'order_id' is set
1202
- if @api_client.config.client_side_validation && order_id.nil?
1203
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.replacement"
1204
- end
1205
- # verify the required parameter 'replacement' is set
1206
- if @api_client.config.client_side_validation && replacement.nil?
1207
- fail ArgumentError, "Missing the required parameter 'replacement' when calling OrderApi.replacement"
1208
- end
1209
- # resource path
1210
- local_var_path = '/order/orders/{order_id}/replacement'.sub('{' + 'order_id' + '}', order_id.to_s)
1211
-
1212
- # query parameters
1213
- query_params = {}
1214
-
1215
- # header parameters
1216
- header_params = {}
1217
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1218
- # HTTP header 'Accept' (if needed)
1219
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1220
- # HTTP header 'Content-Type'
1221
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1222
-
1223
- # form parameters
1224
- form_params = {}
1225
-
1226
- # http body (model)
1227
- post_body = @api_client.object_to_http_body(replacement)
1228
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1229
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1230
- :header_params => header_params,
1231
- :query_params => query_params,
1232
- :form_params => form_params,
1233
- :body => post_body,
1234
- :auth_names => auth_names,
1235
- :return_type => 'OrderReplacementResponse')
1236
- if @api_client.config.debugging
1237
- @api_client.config.logger.debug "API called: OrderApi#replacement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1238
- end
1239
- return data, status_code, headers
1240
- end
1241
- # Resend receipt
1242
- # Resend the receipt for an order on the UltraCart account.
1243
- # @param order_id The order id to resend the receipt for.
1244
- # @param [Hash] opts the optional parameters
1245
- # @return [BaseResponse]
1246
- def resend_receipt(order_id, opts = {})
1247
- data, _status_code, _headers = resend_receipt_with_http_info(order_id, opts)
1248
- data
1249
- end
1250
-
1251
- # Resend receipt
1252
- # Resend the receipt for an order on the UltraCart account.
1253
- # @param order_id The order id to resend the receipt for.
1254
- # @param [Hash] opts the optional parameters
1255
- # @return [Array<(BaseResponse, Fixnum, Hash)>] BaseResponse data, response status code and response headers
1256
- def resend_receipt_with_http_info(order_id, opts = {})
1257
- if @api_client.config.debugging
1258
- @api_client.config.logger.debug 'Calling API: OrderApi.resend_receipt ...'
1259
- end
1260
- # verify the required parameter 'order_id' is set
1261
- if @api_client.config.client_side_validation && order_id.nil?
1262
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.resend_receipt"
1263
- end
1264
- # resource path
1265
- local_var_path = '/order/orders/{order_id}/resend_receipt'.sub('{' + 'order_id' + '}', order_id.to_s)
1266
-
1267
- # query parameters
1268
- query_params = {}
1269
-
1270
- # header parameters
1271
- header_params = {}
1272
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1273
- # HTTP header 'Accept' (if needed)
1274
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1275
- # HTTP header 'Content-Type'
1276
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1277
-
1278
- # form parameters
1279
- form_params = {}
1280
-
1281
- # http body (model)
1282
- post_body = nil
1283
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1284
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1285
- :header_params => header_params,
1286
- :query_params => query_params,
1287
- :form_params => form_params,
1288
- :body => post_body,
1289
- :auth_names => auth_names,
1290
- :return_type => 'BaseResponse')
1291
- if @api_client.config.debugging
1292
- @api_client.config.logger.debug "API called: OrderApi#resend_receipt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1293
- end
1294
- return data, status_code, headers
1295
- end
1296
- # Resend shipment confirmation
1297
- # Resend shipment confirmation for an order on the UltraCart account.
1298
- # @param order_id The order id to resend the shipment notification for.
1299
- # @param [Hash] opts the optional parameters
1300
- # @return [BaseResponse]
1301
- def resend_shipment_confirmation(order_id, opts = {})
1302
- data, _status_code, _headers = resend_shipment_confirmation_with_http_info(order_id, opts)
1303
- data
1304
- end
1305
-
1306
- # Resend shipment confirmation
1307
- # Resend shipment confirmation for an order on the UltraCart account.
1308
- # @param order_id The order id to resend the shipment notification for.
1309
- # @param [Hash] opts the optional parameters
1310
- # @return [Array<(BaseResponse, Fixnum, Hash)>] BaseResponse data, response status code and response headers
1311
- def resend_shipment_confirmation_with_http_info(order_id, opts = {})
1312
- if @api_client.config.debugging
1313
- @api_client.config.logger.debug 'Calling API: OrderApi.resend_shipment_confirmation ...'
1314
- end
1315
- # verify the required parameter 'order_id' is set
1316
- if @api_client.config.client_side_validation && order_id.nil?
1317
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.resend_shipment_confirmation"
1318
- end
1319
- # resource path
1320
- local_var_path = '/order/orders/{order_id}/resend_shipment_confirmation'.sub('{' + 'order_id' + '}', order_id.to_s)
1321
-
1322
- # query parameters
1323
- query_params = {}
1324
-
1325
- # header parameters
1326
- header_params = {}
1327
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1328
- # HTTP header 'Accept' (if needed)
1329
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1330
- # HTTP header 'Content-Type'
1331
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1332
-
1333
- # form parameters
1334
- form_params = {}
1335
-
1336
- # http body (model)
1337
- post_body = nil
1338
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1339
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1340
- :header_params => header_params,
1341
- :query_params => query_params,
1342
- :form_params => form_params,
1343
- :body => post_body,
1344
- :auth_names => auth_names,
1345
- :return_type => 'BaseResponse')
1346
- if @api_client.config.debugging
1347
- @api_client.config.logger.debug "API called: OrderApi#resend_shipment_confirmation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1348
- end
1349
- return data, status_code, headers
1350
- end
1351
- # Update A/R Retry Configuration
1352
- # Update A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.
1353
- # @param retry_config AccountsReceivableRetryConfig object
1354
- # @param [Hash] opts the optional parameters
1355
- # @return [BaseResponse]
1356
- def update_accounts_receivable_retry_config(retry_config, opts = {})
1357
- data, _status_code, _headers = update_accounts_receivable_retry_config_with_http_info(retry_config, opts)
1358
- data
1359
- end
1360
-
1361
- # Update A/R Retry Configuration
1362
- # Update A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.
1363
- # @param retry_config AccountsReceivableRetryConfig object
1364
- # @param [Hash] opts the optional parameters
1365
- # @return [Array<(BaseResponse, Fixnum, Hash)>] BaseResponse data, response status code and response headers
1366
- def update_accounts_receivable_retry_config_with_http_info(retry_config, opts = {})
1367
- if @api_client.config.debugging
1368
- @api_client.config.logger.debug 'Calling API: OrderApi.update_accounts_receivable_retry_config ...'
1369
- end
1370
- # verify the required parameter 'retry_config' is set
1371
- if @api_client.config.client_side_validation && retry_config.nil?
1372
- fail ArgumentError, "Missing the required parameter 'retry_config' when calling OrderApi.update_accounts_receivable_retry_config"
1373
- end
1374
- # resource path
1375
- local_var_path = '/order/accountsReceivableRetryConfig'
1376
-
1377
- # query parameters
1378
- query_params = {}
1379
-
1380
- # header parameters
1381
- header_params = {}
1382
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1383
- # HTTP header 'Accept' (if needed)
1384
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1385
- # HTTP header 'Content-Type'
1386
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1387
-
1388
- # form parameters
1389
- form_params = {}
1390
-
1391
- # http body (model)
1392
- post_body = @api_client.object_to_http_body(retry_config)
1393
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1394
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1395
- :header_params => header_params,
1396
- :query_params => query_params,
1397
- :form_params => form_params,
1398
- :body => post_body,
1399
- :auth_names => auth_names,
1400
- :return_type => 'BaseResponse')
1401
- if @api_client.config.debugging
1402
- @api_client.config.logger.debug "API called: OrderApi#update_accounts_receivable_retry_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1403
- end
1404
- return data, status_code, headers
1405
- end
1406
- # Update an order
1407
- # 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.
1408
- # @param order Order to update
1409
- # @param order_id The order id to update.
1410
- # @param [Hash] opts the optional parameters
1411
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1412
- # @return [OrderResponse]
1413
- def update_order(order, order_id, opts = {})
1414
- data, _status_code, _headers = update_order_with_http_info(order, order_id, opts)
1415
- data
1416
- end
1417
-
1418
- # Update an order
1419
- # 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.
1420
- # @param order Order to update
1421
- # @param order_id The order id to update.
1422
- # @param [Hash] opts the optional parameters
1423
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1424
- # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
1425
- def update_order_with_http_info(order, order_id, opts = {})
1426
- if @api_client.config.debugging
1427
- @api_client.config.logger.debug 'Calling API: OrderApi.update_order ...'
1428
- end
1429
- # verify the required parameter 'order' is set
1430
- if @api_client.config.client_side_validation && order.nil?
1431
- fail ArgumentError, "Missing the required parameter 'order' when calling OrderApi.update_order"
1432
- end
1433
- # verify the required parameter 'order_id' is set
1434
- if @api_client.config.client_side_validation && order_id.nil?
1435
- fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.update_order"
1436
- end
1437
- # resource path
1438
- local_var_path = '/order/orders/{order_id}'.sub('{' + 'order_id' + '}', order_id.to_s)
1439
-
1440
- # query parameters
1441
- query_params = {}
1442
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
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; charset=UTF-8'])
1451
-
1452
- # form parameters
1453
- form_params = {}
1454
-
1455
- # http body (model)
1456
- post_body = @api_client.object_to_http_body(order)
1457
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1458
- data, status_code, headers = @api_client.call_api(:PUT, 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 => 'OrderResponse')
1465
- if @api_client.config.debugging
1466
- @api_client.config.logger.debug "API called: OrderApi#update_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1467
- end
1468
- return data, status_code, headers
1469
- end
1470
- end
1471
- 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