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,1111 +1,1341 @@
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 CheckoutApi
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::CheckoutApi.new(api_client)
33
- end
34
-
35
- # City/State for Zip
36
- # Look up the city and state for the shipping zip code. Useful for building an auto complete for parts of the shipping address
37
- # @param cart Cart
38
- # @param [Hash] opts the optional parameters
39
- # @return [CityStateZip]
40
- def city_state(cart, opts = {})
41
- data, _status_code, _headers = city_state_with_http_info(cart, opts)
42
- data
43
- end
44
-
45
- # City/State for Zip
46
- # Look up the city and state for the shipping zip code. Useful for building an auto complete for parts of the shipping address
47
- # @param cart Cart
48
- # @param [Hash] opts the optional parameters
49
- # @return [Array<(CityStateZip, Fixnum, Hash)>] CityStateZip data, response status code and response headers
50
- def city_state_with_http_info(cart, opts = {})
51
- if @api_client.config.debugging
52
- @api_client.config.logger.debug 'Calling API: CheckoutApi.city_state ...'
53
- end
54
- # verify the required parameter 'cart' is set
55
- if @api_client.config.client_side_validation && cart.nil?
56
- fail ArgumentError, "Missing the required parameter 'cart' when calling CheckoutApi.city_state"
57
- end
58
- # resource path
59
- local_var_path = '/checkout/city_state'
60
-
61
- # query parameters
62
- query_params = {}
63
-
64
- # header parameters
65
- header_params = {}
66
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
67
- # HTTP header 'Accept' (if needed)
68
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
69
- # HTTP header 'Content-Type'
70
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
71
-
72
- # form parameters
73
- form_params = {}
74
-
75
- # http body (model)
76
- post_body = @api_client.object_to_http_body(cart)
77
- auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
78
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
79
- :header_params => header_params,
80
- :query_params => query_params,
81
- :form_params => form_params,
82
- :body => post_body,
83
- :auth_names => auth_names,
84
- :return_type => 'CityStateZip')
85
- if @api_client.config.debugging
86
- @api_client.config.logger.debug "API called: CheckoutApi#city_state\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
87
- end
88
- return data, status_code, headers
89
- end
90
- # Finalize Order
91
- # Finalize the cart into an order. This method can not be called with browser key authentication. It is ONLY meant for server side code to call.
92
- # @param finalize_request Finalize request
93
- # @param [Hash] opts the optional parameters
94
- # @return [CartFinalizeOrderResponse]
95
- def finalize_order(finalize_request, opts = {})
96
- data, _status_code, _headers = finalize_order_with_http_info(finalize_request, opts)
97
- data
98
- end
99
-
100
- # Finalize Order
101
- # Finalize the cart into an order. This method can not be called with browser key authentication. It is ONLY meant for server side code to call.
102
- # @param finalize_request Finalize request
103
- # @param [Hash] opts the optional parameters
104
- # @return [Array<(CartFinalizeOrderResponse, Fixnum, Hash)>] CartFinalizeOrderResponse data, response status code and response headers
105
- def finalize_order_with_http_info(finalize_request, opts = {})
106
- if @api_client.config.debugging
107
- @api_client.config.logger.debug 'Calling API: CheckoutApi.finalize_order ...'
108
- end
109
- # verify the required parameter 'finalize_request' is set
110
- if @api_client.config.client_side_validation && finalize_request.nil?
111
- fail ArgumentError, "Missing the required parameter 'finalize_request' when calling CheckoutApi.finalize_order"
112
- end
113
- # resource path
114
- local_var_path = '/checkout/cart/finalizeOrder'
115
-
116
- # query parameters
117
- query_params = {}
118
-
119
- # header parameters
120
- header_params = {}
121
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
122
- # HTTP header 'Accept' (if needed)
123
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
124
- # HTTP header 'Content-Type'
125
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
126
-
127
- # form parameters
128
- form_params = {}
129
-
130
- # http body (model)
131
- post_body = @api_client.object_to_http_body(finalize_request)
132
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
133
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
134
- :header_params => header_params,
135
- :query_params => query_params,
136
- :form_params => form_params,
137
- :body => post_body,
138
- :auth_names => auth_names,
139
- :return_type => 'CartFinalizeOrderResponse')
140
- if @api_client.config.debugging
141
- @api_client.config.logger.debug "API called: CheckoutApi#finalize_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
142
- end
143
- return data, status_code, headers
144
- end
145
- # Get affirm checkout (by cart id)
146
- # Get a Affirm checkout object for the specified cart_id parameter.
147
- # @param cart_id Cart ID to retrieve
148
- # @param [Hash] opts the optional parameters
149
- # @return [CartAffirmCheckoutResponse]
150
- def get_affirm_checkout(cart_id, opts = {})
151
- data, _status_code, _headers = get_affirm_checkout_with_http_info(cart_id, opts)
152
- data
153
- end
154
-
155
- # Get affirm checkout (by cart id)
156
- # Get a Affirm checkout object for the specified cart_id parameter.
157
- # @param cart_id Cart ID to retrieve
158
- # @param [Hash] opts the optional parameters
159
- # @return [Array<(CartAffirmCheckoutResponse, Fixnum, Hash)>] CartAffirmCheckoutResponse data, response status code and response headers
160
- def get_affirm_checkout_with_http_info(cart_id, opts = {})
161
- if @api_client.config.debugging
162
- @api_client.config.logger.debug 'Calling API: CheckoutApi.get_affirm_checkout ...'
163
- end
164
- # verify the required parameter 'cart_id' is set
165
- if @api_client.config.client_side_validation && cart_id.nil?
166
- fail ArgumentError, "Missing the required parameter 'cart_id' when calling CheckoutApi.get_affirm_checkout"
167
- end
168
- # resource path
169
- local_var_path = '/checkout/cart/{cart_id}/affirmCheckout'.sub('{' + 'cart_id' + '}', cart_id.to_s)
170
-
171
- # query parameters
172
- query_params = {}
173
-
174
- # header parameters
175
- header_params = {}
176
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
177
- # HTTP header 'Accept' (if needed)
178
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
179
- # HTTP header 'Content-Type'
180
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
181
-
182
- # form parameters
183
- form_params = {}
184
-
185
- # http body (model)
186
- post_body = nil
187
- auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
188
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
189
- :header_params => header_params,
190
- :query_params => query_params,
191
- :form_params => form_params,
192
- :body => post_body,
193
- :auth_names => auth_names,
194
- :return_type => 'CartAffirmCheckoutResponse')
195
- if @api_client.config.debugging
196
- @api_client.config.logger.debug "API called: CheckoutApi#get_affirm_checkout\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
197
- end
198
- return data, status_code, headers
199
- end
200
- # Allowed countries
201
- # Lookup the allowed countries for this merchant id
202
- # @param [Hash] opts the optional parameters
203
- # @return [CheckoutAllowedCountriesResponse]
204
- def get_allowed_countries(opts = {})
205
- data, _status_code, _headers = get_allowed_countries_with_http_info(opts)
206
- data
207
- end
208
-
209
- # Allowed countries
210
- # Lookup the allowed countries for this merchant id
211
- # @param [Hash] opts the optional parameters
212
- # @return [Array<(CheckoutAllowedCountriesResponse, Fixnum, Hash)>] CheckoutAllowedCountriesResponse data, response status code and response headers
213
- def get_allowed_countries_with_http_info(opts = {})
214
- if @api_client.config.debugging
215
- @api_client.config.logger.debug 'Calling API: CheckoutApi.get_allowed_countries ...'
216
- end
217
- # resource path
218
- local_var_path = '/checkout/allowedCountries'
219
-
220
- # query parameters
221
- query_params = {}
222
-
223
- # header parameters
224
- header_params = {}
225
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
226
- # HTTP header 'Accept' (if needed)
227
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
228
- # HTTP header 'Content-Type'
229
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
230
-
231
- # form parameters
232
- form_params = {}
233
-
234
- # http body (model)
235
- post_body = nil
236
- auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
237
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
238
- :header_params => header_params,
239
- :query_params => query_params,
240
- :form_params => form_params,
241
- :body => post_body,
242
- :auth_names => auth_names,
243
- :return_type => 'CheckoutAllowedCountriesResponse')
244
- if @api_client.config.debugging
245
- @api_client.config.logger.debug "API called: CheckoutApi#get_allowed_countries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
246
- end
247
- return data, status_code, headers
248
- end
249
- # Get cart
250
- # If the cookie is set on the browser making the request then it will return their active cart. Otherwise it will create a new cart.
251
- # @param [Hash] opts the optional parameters
252
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
253
- # @return [CartResponse]
254
- def get_cart(opts = {})
255
- data, _status_code, _headers = get_cart_with_http_info(opts)
256
- data
257
- end
258
-
259
- # Get cart
260
- # If the cookie is set on the browser making the request then it will return their active cart. Otherwise it will create a new cart.
261
- # @param [Hash] opts the optional parameters
262
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
263
- # @return [Array<(CartResponse, Fixnum, Hash)>] CartResponse data, response status code and response headers
264
- def get_cart_with_http_info(opts = {})
265
- if @api_client.config.debugging
266
- @api_client.config.logger.debug 'Calling API: CheckoutApi.get_cart ...'
267
- end
268
- # resource path
269
- local_var_path = '/checkout/cart'
270
-
271
- # query parameters
272
- query_params = {}
273
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
274
-
275
- # header parameters
276
- header_params = {}
277
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
278
- # HTTP header 'Accept' (if needed)
279
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
280
- # HTTP header 'Content-Type'
281
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
282
-
283
- # form parameters
284
- form_params = {}
285
-
286
- # http body (model)
287
- post_body = nil
288
- auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
289
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
290
- :header_params => header_params,
291
- :query_params => query_params,
292
- :form_params => form_params,
293
- :body => post_body,
294
- :auth_names => auth_names,
295
- :return_type => 'CartResponse')
296
- if @api_client.config.debugging
297
- @api_client.config.logger.debug "API called: CheckoutApi#get_cart\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
298
- end
299
- return data, status_code, headers
300
- end
301
- # Get cart (by cart id)
302
- # Get a cart specified by the cart_id parameter.
303
- # @param cart_id Cart ID to retrieve
304
- # @param [Hash] opts the optional parameters
305
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
306
- # @return [CartResponse]
307
- def get_cart_by_cart_id(cart_id, opts = {})
308
- data, _status_code, _headers = get_cart_by_cart_id_with_http_info(cart_id, opts)
309
- data
310
- end
311
-
312
- # Get cart (by cart id)
313
- # Get a cart specified by the cart_id parameter.
314
- # @param cart_id Cart ID to retrieve
315
- # @param [Hash] opts the optional parameters
316
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
317
- # @return [Array<(CartResponse, Fixnum, Hash)>] CartResponse data, response status code and response headers
318
- def get_cart_by_cart_id_with_http_info(cart_id, opts = {})
319
- if @api_client.config.debugging
320
- @api_client.config.logger.debug 'Calling API: CheckoutApi.get_cart_by_cart_id ...'
321
- end
322
- # verify the required parameter 'cart_id' is set
323
- if @api_client.config.client_side_validation && cart_id.nil?
324
- fail ArgumentError, "Missing the required parameter 'cart_id' when calling CheckoutApi.get_cart_by_cart_id"
325
- end
326
- # resource path
327
- local_var_path = '/checkout/cart/{cart_id}'.sub('{' + 'cart_id' + '}', cart_id.to_s)
328
-
329
- # query parameters
330
- query_params = {}
331
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
332
-
333
- # header parameters
334
- header_params = {}
335
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
336
- # HTTP header 'Accept' (if needed)
337
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
338
- # HTTP header 'Content-Type'
339
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
340
-
341
- # form parameters
342
- form_params = {}
343
-
344
- # http body (model)
345
- post_body = nil
346
- auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
347
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
348
- :header_params => header_params,
349
- :query_params => query_params,
350
- :form_params => form_params,
351
- :body => post_body,
352
- :auth_names => auth_names,
353
- :return_type => 'CartResponse')
354
- if @api_client.config.debugging
355
- @api_client.config.logger.debug "API called: CheckoutApi#get_cart_by_cart_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
356
- end
357
- return data, status_code, headers
358
- end
359
- # Get cart (by return code)
360
- # Get a cart specified by the return code parameter.
361
- # @param return_code Return code to lookup cart ID by
362
- # @param [Hash] opts the optional parameters
363
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
364
- # @return [CartResponse]
365
- def get_cart_by_return_code(return_code, opts = {})
366
- data, _status_code, _headers = get_cart_by_return_code_with_http_info(return_code, opts)
367
- data
368
- end
369
-
370
- # Get cart (by return code)
371
- # Get a cart specified by the return code parameter.
372
- # @param return_code Return code to lookup cart ID by
373
- # @param [Hash] opts the optional parameters
374
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
375
- # @return [Array<(CartResponse, Fixnum, Hash)>] CartResponse data, response status code and response headers
376
- def get_cart_by_return_code_with_http_info(return_code, opts = {})
377
- if @api_client.config.debugging
378
- @api_client.config.logger.debug 'Calling API: CheckoutApi.get_cart_by_return_code ...'
379
- end
380
- # verify the required parameter 'return_code' is set
381
- if @api_client.config.client_side_validation && return_code.nil?
382
- fail ArgumentError, "Missing the required parameter 'return_code' when calling CheckoutApi.get_cart_by_return_code"
383
- end
384
- # resource path
385
- local_var_path = '/checkout/return/{return_code}'.sub('{' + 'return_code' + '}', return_code.to_s)
386
-
387
- # query parameters
388
- query_params = {}
389
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
390
-
391
- # header parameters
392
- header_params = {}
393
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
394
- # HTTP header 'Accept' (if needed)
395
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
396
- # HTTP header 'Content-Type'
397
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
398
-
399
- # form parameters
400
- form_params = {}
401
-
402
- # http body (model)
403
- post_body = nil
404
- auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
405
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
406
- :header_params => header_params,
407
- :query_params => query_params,
408
- :form_params => form_params,
409
- :body => post_body,
410
- :auth_names => auth_names,
411
- :return_type => 'CartResponse')
412
- if @api_client.config.debugging
413
- @api_client.config.logger.debug "API called: CheckoutApi#get_cart_by_return_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
414
- end
415
- return data, status_code, headers
416
- end
417
- # Get cart (by return token)
418
- # Get a cart specified by the encrypted return token parameter.
419
- # @param [Hash] opts the optional parameters
420
- # @option opts [String] :return_token Return token provided by StoreFront Communications
421
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
422
- # @return [CartResponse]
423
- def get_cart_by_return_token(opts = {})
424
- data, _status_code, _headers = get_cart_by_return_token_with_http_info(opts)
425
- data
426
- end
427
-
428
- # Get cart (by return token)
429
- # Get a cart specified by the encrypted return token parameter.
430
- # @param [Hash] opts the optional parameters
431
- # @option opts [String] :return_token Return token provided by StoreFront Communications
432
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
433
- # @return [Array<(CartResponse, Fixnum, Hash)>] CartResponse data, response status code and response headers
434
- def get_cart_by_return_token_with_http_info(opts = {})
435
- if @api_client.config.debugging
436
- @api_client.config.logger.debug 'Calling API: CheckoutApi.get_cart_by_return_token ...'
437
- end
438
- # resource path
439
- local_var_path = '/checkout/return_token'
440
-
441
- # query parameters
442
- query_params = {}
443
- query_params[:'return_token'] = opts[:'return_token'] if !opts[:'return_token'].nil?
444
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
445
-
446
- # header parameters
447
- header_params = {}
448
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
449
- # HTTP header 'Accept' (if needed)
450
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
451
- # HTTP header 'Content-Type'
452
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
453
-
454
- # form parameters
455
- form_params = {}
456
-
457
- # http body (model)
458
- post_body = nil
459
- auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
460
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
461
- :header_params => header_params,
462
- :query_params => query_params,
463
- :form_params => form_params,
464
- :body => post_body,
465
- :auth_names => auth_names,
466
- :return_type => 'CartResponse')
467
- if @api_client.config.debugging
468
- @api_client.config.logger.debug "API called: CheckoutApi#get_cart_by_return_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
469
- end
470
- return data, status_code, headers
471
- end
472
- # Get state/province list for a country code
473
- # Lookup a state/province list for a given country code
474
- # @param country_code Two letter ISO country code
475
- # @param [Hash] opts the optional parameters
476
- # @return [CheckoutStateProvinceResponse]
477
- def get_state_provinces_for_country(country_code, opts = {})
478
- data, _status_code, _headers = get_state_provinces_for_country_with_http_info(country_code, opts)
479
- data
480
- end
481
-
482
- # Get state/province list for a country code
483
- # Lookup a state/province list for a given country code
484
- # @param country_code Two letter ISO country code
485
- # @param [Hash] opts the optional parameters
486
- # @return [Array<(CheckoutStateProvinceResponse, Fixnum, Hash)>] CheckoutStateProvinceResponse data, response status code and response headers
487
- def get_state_provinces_for_country_with_http_info(country_code, opts = {})
488
- if @api_client.config.debugging
489
- @api_client.config.logger.debug 'Calling API: CheckoutApi.get_state_provinces_for_country ...'
490
- end
491
- # verify the required parameter 'country_code' is set
492
- if @api_client.config.client_side_validation && country_code.nil?
493
- fail ArgumentError, "Missing the required parameter 'country_code' when calling CheckoutApi.get_state_provinces_for_country"
494
- end
495
- # resource path
496
- local_var_path = '/checkout/stateProvincesForCountry/{country_code}'.sub('{' + 'country_code' + '}', country_code.to_s)
497
-
498
- # query parameters
499
- query_params = {}
500
-
501
- # header parameters
502
- header_params = {}
503
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
504
- # HTTP header 'Accept' (if needed)
505
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
506
- # HTTP header 'Content-Type'
507
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
508
-
509
- # form parameters
510
- form_params = {}
511
-
512
- # http body (model)
513
- post_body = nil
514
- auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
515
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
516
- :header_params => header_params,
517
- :query_params => query_params,
518
- :form_params => form_params,
519
- :body => post_body,
520
- :auth_names => auth_names,
521
- :return_type => 'CheckoutStateProvinceResponse')
522
- if @api_client.config.debugging
523
- @api_client.config.logger.debug "API called: CheckoutApi#get_state_provinces_for_country\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
524
- end
525
- return data, status_code, headers
526
- end
527
- # Handoff cart
528
- # Handoff the browser to UltraCart for view cart on StoreFront, transfer to PayPal, transfer to Affirm, transfer to Sezzle or finalization of the order (including upsell processing).
529
- # @param handoff_request Handoff request
530
- # @param [Hash] opts the optional parameters
531
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
532
- # @return [CheckoutHandoffResponse]
533
- def handoff_cart(handoff_request, opts = {})
534
- data, _status_code, _headers = handoff_cart_with_http_info(handoff_request, opts)
535
- data
536
- end
537
-
538
- # Handoff cart
539
- # Handoff the browser to UltraCart for view cart on StoreFront, transfer to PayPal, transfer to Affirm, transfer to Sezzle or finalization of the order (including upsell processing).
540
- # @param handoff_request Handoff request
541
- # @param [Hash] opts the optional parameters
542
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
543
- # @return [Array<(CheckoutHandoffResponse, Fixnum, Hash)>] CheckoutHandoffResponse data, response status code and response headers
544
- def handoff_cart_with_http_info(handoff_request, opts = {})
545
- if @api_client.config.debugging
546
- @api_client.config.logger.debug 'Calling API: CheckoutApi.handoff_cart ...'
547
- end
548
- # verify the required parameter 'handoff_request' is set
549
- if @api_client.config.client_side_validation && handoff_request.nil?
550
- fail ArgumentError, "Missing the required parameter 'handoff_request' when calling CheckoutApi.handoff_cart"
551
- end
552
- # resource path
553
- local_var_path = '/checkout/cart/handoff'
554
-
555
- # query parameters
556
- query_params = {}
557
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
558
-
559
- # header parameters
560
- header_params = {}
561
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
562
- # HTTP header 'Accept' (if needed)
563
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
564
- # HTTP header 'Content-Type'
565
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
566
-
567
- # form parameters
568
- form_params = {}
569
-
570
- # http body (model)
571
- post_body = @api_client.object_to_http_body(handoff_request)
572
- auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
573
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
574
- :header_params => header_params,
575
- :query_params => query_params,
576
- :form_params => form_params,
577
- :body => post_body,
578
- :auth_names => auth_names,
579
- :return_type => 'CheckoutHandoffResponse')
580
- if @api_client.config.debugging
581
- @api_client.config.logger.debug "API called: CheckoutApi#handoff_cart\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
582
- end
583
- return data, status_code, headers
584
- end
585
- # Profile login
586
- # Login in to the customer profile specified by cart.billing.email and password
587
- # @param login_request Login request
588
- # @param [Hash] opts the optional parameters
589
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
590
- # @return [CartProfileLoginResponse]
591
- def login(login_request, opts = {})
592
- data, _status_code, _headers = login_with_http_info(login_request, opts)
593
- data
594
- end
595
-
596
- # Profile login
597
- # Login in to the customer profile specified by cart.billing.email and password
598
- # @param login_request Login request
599
- # @param [Hash] opts the optional parameters
600
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
601
- # @return [Array<(CartProfileLoginResponse, Fixnum, Hash)>] CartProfileLoginResponse data, response status code and response headers
602
- def login_with_http_info(login_request, opts = {})
603
- if @api_client.config.debugging
604
- @api_client.config.logger.debug 'Calling API: CheckoutApi.login ...'
605
- end
606
- # verify the required parameter 'login_request' is set
607
- if @api_client.config.client_side_validation && login_request.nil?
608
- fail ArgumentError, "Missing the required parameter 'login_request' when calling CheckoutApi.login"
609
- end
610
- # resource path
611
- local_var_path = '/checkout/cart/profile/login'
612
-
613
- # query parameters
614
- query_params = {}
615
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
616
-
617
- # header parameters
618
- header_params = {}
619
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
620
- # HTTP header 'Accept' (if needed)
621
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
622
- # HTTP header 'Content-Type'
623
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
624
-
625
- # form parameters
626
- form_params = {}
627
-
628
- # http body (model)
629
- post_body = @api_client.object_to_http_body(login_request)
630
- auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
631
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
632
- :header_params => header_params,
633
- :query_params => query_params,
634
- :form_params => form_params,
635
- :body => post_body,
636
- :auth_names => auth_names,
637
- :return_type => 'CartProfileLoginResponse')
638
- if @api_client.config.debugging
639
- @api_client.config.logger.debug "API called: CheckoutApi#login\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
640
- end
641
- return data, status_code, headers
642
- end
643
- # Profile logout
644
- # Log the cart out of the current profile. No error will occur if they are not logged in.
645
- # @param cart Cart
646
- # @param [Hash] opts the optional parameters
647
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
648
- # @return [CartResponse]
649
- def logout(cart, opts = {})
650
- data, _status_code, _headers = logout_with_http_info(cart, opts)
651
- data
652
- end
653
-
654
- # Profile logout
655
- # Log the cart out of the current profile. No error will occur if they are not logged in.
656
- # @param cart Cart
657
- # @param [Hash] opts the optional parameters
658
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
659
- # @return [Array<(CartResponse, Fixnum, Hash)>] CartResponse data, response status code and response headers
660
- def logout_with_http_info(cart, opts = {})
661
- if @api_client.config.debugging
662
- @api_client.config.logger.debug 'Calling API: CheckoutApi.logout ...'
663
- end
664
- # verify the required parameter 'cart' is set
665
- if @api_client.config.client_side_validation && cart.nil?
666
- fail ArgumentError, "Missing the required parameter 'cart' when calling CheckoutApi.logout"
667
- end
668
- # resource path
669
- local_var_path = '/checkout/cart/profile/logout'
670
-
671
- # query parameters
672
- query_params = {}
673
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
674
-
675
- # header parameters
676
- header_params = {}
677
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
678
- # HTTP header 'Accept' (if needed)
679
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
680
- # HTTP header 'Content-Type'
681
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
682
-
683
- # form parameters
684
- form_params = {}
685
-
686
- # http body (model)
687
- post_body = @api_client.object_to_http_body(cart)
688
- auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
689
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
690
- :header_params => header_params,
691
- :query_params => query_params,
692
- :form_params => form_params,
693
- :body => post_body,
694
- :auth_names => auth_names,
695
- :return_type => 'CartResponse')
696
- if @api_client.config.debugging
697
- @api_client.config.logger.debug "API called: CheckoutApi#logout\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
698
- end
699
- return data, status_code, headers
700
- end
701
- # Profile registration
702
- # Register a new customer profile. Requires the cart.billing object to be populated along with the password.
703
- # @param register_request Register request
704
- # @param [Hash] opts the optional parameters
705
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
706
- # @return [CartProfileRegisterResponse]
707
- def register(register_request, opts = {})
708
- data, _status_code, _headers = register_with_http_info(register_request, opts)
709
- data
710
- end
711
-
712
- # Profile registration
713
- # Register a new customer profile. Requires the cart.billing object to be populated along with the password.
714
- # @param register_request Register request
715
- # @param [Hash] opts the optional parameters
716
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
717
- # @return [Array<(CartProfileRegisterResponse, Fixnum, Hash)>] CartProfileRegisterResponse data, response status code and response headers
718
- def register_with_http_info(register_request, opts = {})
719
- if @api_client.config.debugging
720
- @api_client.config.logger.debug 'Calling API: CheckoutApi.register ...'
721
- end
722
- # verify the required parameter 'register_request' is set
723
- if @api_client.config.client_side_validation && register_request.nil?
724
- fail ArgumentError, "Missing the required parameter 'register_request' when calling CheckoutApi.register"
725
- end
726
- # resource path
727
- local_var_path = '/checkout/cart/profile/register'
728
-
729
- # query parameters
730
- query_params = {}
731
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
732
-
733
- # header parameters
734
- header_params = {}
735
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
736
- # HTTP header 'Accept' (if needed)
737
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
738
- # HTTP header 'Content-Type'
739
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
740
-
741
- # form parameters
742
- form_params = {}
743
-
744
- # http body (model)
745
- post_body = @api_client.object_to_http_body(register_request)
746
- auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
747
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
748
- :header_params => header_params,
749
- :query_params => query_params,
750
- :form_params => form_params,
751
- :body => post_body,
752
- :auth_names => auth_names,
753
- :return_type => 'CartProfileRegisterResponse')
754
- if @api_client.config.debugging
755
- @api_client.config.logger.debug "API called: CheckoutApi#register\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
756
- end
757
- return data, status_code, headers
758
- end
759
- # Register affiliate click
760
- # Register an affiliate click. Used by custom checkouts that are completely API based and do not perform checkout handoff.
761
- # @param register_affiliate_click_request Register affiliate click request
762
- # @param [Hash] opts the optional parameters
763
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
764
- # @return [RegisterAffiliateClickResponse]
765
- def register_affiliate_click(register_affiliate_click_request, opts = {})
766
- data, _status_code, _headers = register_affiliate_click_with_http_info(register_affiliate_click_request, opts)
767
- data
768
- end
769
-
770
- # Register affiliate click
771
- # Register an affiliate click. Used by custom checkouts that are completely API based and do not perform checkout handoff.
772
- # @param register_affiliate_click_request Register affiliate click request
773
- # @param [Hash] opts the optional parameters
774
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
775
- # @return [Array<(RegisterAffiliateClickResponse, Fixnum, Hash)>] RegisterAffiliateClickResponse data, response status code and response headers
776
- def register_affiliate_click_with_http_info(register_affiliate_click_request, opts = {})
777
- if @api_client.config.debugging
778
- @api_client.config.logger.debug 'Calling API: CheckoutApi.register_affiliate_click ...'
779
- end
780
- # verify the required parameter 'register_affiliate_click_request' is set
781
- if @api_client.config.client_side_validation && register_affiliate_click_request.nil?
782
- fail ArgumentError, "Missing the required parameter 'register_affiliate_click_request' when calling CheckoutApi.register_affiliate_click"
783
- end
784
- # resource path
785
- local_var_path = '/checkout/affiliateClick/register'
786
-
787
- # query parameters
788
- query_params = {}
789
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
790
-
791
- # header parameters
792
- header_params = {}
793
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
794
- # HTTP header 'Accept' (if needed)
795
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
796
- # HTTP header 'Content-Type'
797
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
798
-
799
- # form parameters
800
- form_params = {}
801
-
802
- # http body (model)
803
- post_body = @api_client.object_to_http_body(register_affiliate_click_request)
804
- auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
805
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
806
- :header_params => header_params,
807
- :query_params => query_params,
808
- :form_params => form_params,
809
- :body => post_body,
810
- :auth_names => auth_names,
811
- :return_type => 'RegisterAffiliateClickResponse')
812
- if @api_client.config.debugging
813
- @api_client.config.logger.debug "API called: CheckoutApi#register_affiliate_click\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
814
- end
815
- return data, status_code, headers
816
- end
817
- # Related items
818
- # Retrieve all the related items for the cart contents. Expansion is limited to content, content.assignments, content.attributes, content.multimedia, content.multimedia.thumbnails, options, pricing, and pricing.tiers.
819
- # @param cart Cart
820
- # @param [Hash] opts the optional parameters
821
- # @option opts [String] :_expand The object expansion to perform on the result. See item resource documentation for examples
822
- # @return [ItemsResponse]
823
- def related_items_for_cart(cart, opts = {})
824
- data, _status_code, _headers = related_items_for_cart_with_http_info(cart, opts)
825
- data
826
- end
827
-
828
- # Related items
829
- # Retrieve all the related items for the cart contents. Expansion is limited to content, content.assignments, content.attributes, content.multimedia, content.multimedia.thumbnails, options, pricing, and pricing.tiers.
830
- # @param cart Cart
831
- # @param [Hash] opts the optional parameters
832
- # @option opts [String] :_expand The object expansion to perform on the result. See item resource documentation for examples
833
- # @return [Array<(ItemsResponse, Fixnum, Hash)>] ItemsResponse data, response status code and response headers
834
- def related_items_for_cart_with_http_info(cart, opts = {})
835
- if @api_client.config.debugging
836
- @api_client.config.logger.debug 'Calling API: CheckoutApi.related_items_for_cart ...'
837
- end
838
- # verify the required parameter 'cart' is set
839
- if @api_client.config.client_side_validation && cart.nil?
840
- fail ArgumentError, "Missing the required parameter 'cart' when calling CheckoutApi.related_items_for_cart"
841
- end
842
- # resource path
843
- local_var_path = '/checkout/related_items'
844
-
845
- # query parameters
846
- query_params = {}
847
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
848
-
849
- # header parameters
850
- header_params = {}
851
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
852
- # HTTP header 'Accept' (if needed)
853
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
854
- # HTTP header 'Content-Type'
855
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
856
-
857
- # form parameters
858
- form_params = {}
859
-
860
- # http body (model)
861
- post_body = @api_client.object_to_http_body(cart)
862
- auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
863
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
864
- :header_params => header_params,
865
- :query_params => query_params,
866
- :form_params => form_params,
867
- :body => post_body,
868
- :auth_names => auth_names,
869
- :return_type => 'ItemsResponse')
870
- if @api_client.config.debugging
871
- @api_client.config.logger.debug "API called: CheckoutApi#related_items_for_cart\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
872
- end
873
- return data, status_code, headers
874
- end
875
- # Related items (specific item)
876
- # Retrieve all the related items for the cart contents. Expansion is limited to content, content.assignments, content.attributes, content.multimedia, content.multimedia.thumbnails, options, pricing, and pricing.tiers.
877
- # @param item_id Item ID to retrieve related items for
878
- # @param cart Cart
879
- # @param [Hash] opts the optional parameters
880
- # @option opts [String] :_expand The object expansion to perform on the result. See item resource documentation for examples
881
- # @return [ItemsResponse]
882
- def related_items_for_item(item_id, cart, opts = {})
883
- data, _status_code, _headers = related_items_for_item_with_http_info(item_id, cart, opts)
884
- data
885
- end
886
-
887
- # Related items (specific item)
888
- # Retrieve all the related items for the cart contents. Expansion is limited to content, content.assignments, content.attributes, content.multimedia, content.multimedia.thumbnails, options, pricing, and pricing.tiers.
889
- # @param item_id Item ID to retrieve related items for
890
- # @param cart Cart
891
- # @param [Hash] opts the optional parameters
892
- # @option opts [String] :_expand The object expansion to perform on the result. See item resource documentation for examples
893
- # @return [Array<(ItemsResponse, Fixnum, Hash)>] ItemsResponse data, response status code and response headers
894
- def related_items_for_item_with_http_info(item_id, cart, opts = {})
895
- if @api_client.config.debugging
896
- @api_client.config.logger.debug 'Calling API: CheckoutApi.related_items_for_item ...'
897
- end
898
- # verify the required parameter 'item_id' is set
899
- if @api_client.config.client_side_validation && item_id.nil?
900
- fail ArgumentError, "Missing the required parameter 'item_id' when calling CheckoutApi.related_items_for_item"
901
- end
902
- # verify the required parameter 'cart' is set
903
- if @api_client.config.client_side_validation && cart.nil?
904
- fail ArgumentError, "Missing the required parameter 'cart' when calling CheckoutApi.related_items_for_item"
905
- end
906
- # resource path
907
- local_var_path = '/checkout/relatedItems/{item_id}'.sub('{' + 'item_id' + '}', item_id.to_s)
908
-
909
- # query parameters
910
- query_params = {}
911
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
912
-
913
- # header parameters
914
- header_params = {}
915
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
916
- # HTTP header 'Accept' (if needed)
917
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
918
- # HTTP header 'Content-Type'
919
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
920
-
921
- # form parameters
922
- form_params = {}
923
-
924
- # http body (model)
925
- post_body = @api_client.object_to_http_body(cart)
926
- auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
927
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
928
- :header_params => header_params,
929
- :query_params => query_params,
930
- :form_params => form_params,
931
- :body => post_body,
932
- :auth_names => auth_names,
933
- :return_type => 'ItemsResponse')
934
- if @api_client.config.debugging
935
- @api_client.config.logger.debug "API called: CheckoutApi#related_items_for_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
936
- end
937
- return data, status_code, headers
938
- end
939
- # Setup Browser Application
940
- # Setup a browser key authenticated application with checkout permissions. This REST call must be made with an authentication scheme that is not browser key. The new application will be linked to the application that makes this call. If this application is disabled / deleted, then so will the application setup by this call. The purpose of this call is to allow an OAuth application, such as the Wordpress plugin, to setup the proper browser based authentication for the REST checkout API to use.
941
- # @param browser_key_request Setup browser key request
942
- # @param [Hash] opts the optional parameters
943
- # @return [CheckoutSetupBrowserKeyResponse]
944
- def setup_browser_key(browser_key_request, opts = {})
945
- data, _status_code, _headers = setup_browser_key_with_http_info(browser_key_request, opts)
946
- data
947
- end
948
-
949
- # Setup Browser Application
950
- # Setup a browser key authenticated application with checkout permissions. This REST call must be made with an authentication scheme that is not browser key. The new application will be linked to the application that makes this call. If this application is disabled / deleted, then so will the application setup by this call. The purpose of this call is to allow an OAuth application, such as the Wordpress plugin, to setup the proper browser based authentication for the REST checkout API to use.
951
- # @param browser_key_request Setup browser key request
952
- # @param [Hash] opts the optional parameters
953
- # @return [Array<(CheckoutSetupBrowserKeyResponse, Fixnum, Hash)>] CheckoutSetupBrowserKeyResponse data, response status code and response headers
954
- def setup_browser_key_with_http_info(browser_key_request, opts = {})
955
- if @api_client.config.debugging
956
- @api_client.config.logger.debug 'Calling API: CheckoutApi.setup_browser_key ...'
957
- end
958
- # verify the required parameter 'browser_key_request' is set
959
- if @api_client.config.client_side_validation && browser_key_request.nil?
960
- fail ArgumentError, "Missing the required parameter 'browser_key_request' when calling CheckoutApi.setup_browser_key"
961
- end
962
- # resource path
963
- local_var_path = '/checkout/browser_key'
964
-
965
- # query parameters
966
- query_params = {}
967
-
968
- # header parameters
969
- header_params = {}
970
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
971
- # HTTP header 'Accept' (if needed)
972
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
973
- # HTTP header 'Content-Type'
974
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
975
-
976
- # form parameters
977
- form_params = {}
978
-
979
- # http body (model)
980
- post_body = @api_client.object_to_http_body(browser_key_request)
981
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
982
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
983
- :header_params => header_params,
984
- :query_params => query_params,
985
- :form_params => form_params,
986
- :body => post_body,
987
- :auth_names => auth_names,
988
- :return_type => 'CheckoutSetupBrowserKeyResponse')
989
- if @api_client.config.debugging
990
- @api_client.config.logger.debug "API called: CheckoutApi#setup_browser_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
991
- end
992
- return data, status_code, headers
993
- end
994
- # Update cart
995
- # Update the cart.
996
- # @param cart Cart
997
- # @param [Hash] opts the optional parameters
998
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
999
- # @return [CartResponse]
1000
- def update_cart(cart, opts = {})
1001
- data, _status_code, _headers = update_cart_with_http_info(cart, opts)
1002
- data
1003
- end
1004
-
1005
- # Update cart
1006
- # Update the cart.
1007
- # @param cart Cart
1008
- # @param [Hash] opts the optional parameters
1009
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1010
- # @return [Array<(CartResponse, Fixnum, Hash)>] CartResponse data, response status code and response headers
1011
- def update_cart_with_http_info(cart, opts = {})
1012
- if @api_client.config.debugging
1013
- @api_client.config.logger.debug 'Calling API: CheckoutApi.update_cart ...'
1014
- end
1015
- # verify the required parameter 'cart' is set
1016
- if @api_client.config.client_side_validation && cart.nil?
1017
- fail ArgumentError, "Missing the required parameter 'cart' when calling CheckoutApi.update_cart"
1018
- end
1019
- # resource path
1020
- local_var_path = '/checkout/cart'
1021
-
1022
- # query parameters
1023
- query_params = {}
1024
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1025
-
1026
- # header parameters
1027
- header_params = {}
1028
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1029
- # HTTP header 'Accept' (if needed)
1030
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1031
- # HTTP header 'Content-Type'
1032
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1033
-
1034
- # form parameters
1035
- form_params = {}
1036
-
1037
- # http body (model)
1038
- post_body = @api_client.object_to_http_body(cart)
1039
- auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
1040
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1041
- :header_params => header_params,
1042
- :query_params => query_params,
1043
- :form_params => form_params,
1044
- :body => post_body,
1045
- :auth_names => auth_names,
1046
- :return_type => 'CartResponse')
1047
- if @api_client.config.debugging
1048
- @api_client.config.logger.debug "API called: CheckoutApi#update_cart\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1049
- end
1050
- return data, status_code, headers
1051
- end
1052
- # Validate
1053
- # Validate the cart for errors. Specific checks can be passed and multiple validations can occur throughout your checkout flow.
1054
- # @param validation_request Validation request
1055
- # @param [Hash] opts the optional parameters
1056
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1057
- # @return [CartValidationResponse]
1058
- def validate_cart(validation_request, opts = {})
1059
- data, _status_code, _headers = validate_cart_with_http_info(validation_request, opts)
1060
- data
1061
- end
1062
-
1063
- # Validate
1064
- # Validate the cart for errors. Specific checks can be passed and multiple validations can occur throughout your checkout flow.
1065
- # @param validation_request Validation request
1066
- # @param [Hash] opts the optional parameters
1067
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1068
- # @return [Array<(CartValidationResponse, Fixnum, Hash)>] CartValidationResponse data, response status code and response headers
1069
- def validate_cart_with_http_info(validation_request, opts = {})
1070
- if @api_client.config.debugging
1071
- @api_client.config.logger.debug 'Calling API: CheckoutApi.validate_cart ...'
1072
- end
1073
- # verify the required parameter 'validation_request' is set
1074
- if @api_client.config.client_side_validation && validation_request.nil?
1075
- fail ArgumentError, "Missing the required parameter 'validation_request' when calling CheckoutApi.validate_cart"
1076
- end
1077
- # resource path
1078
- local_var_path = '/checkout/cart/validate'
1079
-
1080
- # query parameters
1081
- query_params = {}
1082
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1083
-
1084
- # header parameters
1085
- header_params = {}
1086
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1087
- # HTTP header 'Accept' (if needed)
1088
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1089
- # HTTP header 'Content-Type'
1090
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1091
-
1092
- # form parameters
1093
- form_params = {}
1094
-
1095
- # http body (model)
1096
- post_body = @api_client.object_to_http_body(validation_request)
1097
- auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
1098
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1099
- :header_params => header_params,
1100
- :query_params => query_params,
1101
- :form_params => form_params,
1102
- :body => post_body,
1103
- :auth_names => auth_names,
1104
- :return_type => 'CartValidationResponse')
1105
- if @api_client.config.debugging
1106
- @api_client.config.logger.debug "API called: CheckoutApi#validate_cart\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1107
- end
1108
- return data, status_code, headers
1109
- end
1110
- end
1111
- 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 CheckoutApi
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::CheckoutApi.new(api_client)
33
+ end
34
+
35
+ # City/State for Zip
36
+ # Look up the city and state for the shipping zip code. Useful for building an auto complete for parts of the shipping address
37
+ # @param cart [Cart] Cart
38
+ # @param [Hash] opts the optional parameters
39
+ # @return [CityStateZip]
40
+ def city_state(cart, opts = {})
41
+ data, _status_code, _headers = city_state_with_http_info(cart, opts)
42
+ data
43
+ end
44
+
45
+ # City/State for Zip
46
+ # Look up the city and state for the shipping zip code. Useful for building an auto complete for parts of the shipping address
47
+ # @param cart [Cart] Cart
48
+ # @param [Hash] opts the optional parameters
49
+ # @return [Array<(CityStateZip, Integer, Hash)>] CityStateZip data, response status code and response headers
50
+ def city_state_with_http_info(cart, opts = {})
51
+ if @api_client.config.debugging
52
+ @api_client.config.logger.debug 'Calling API: CheckoutApi.city_state ...'
53
+ end
54
+ # verify the required parameter 'cart' is set
55
+ if @api_client.config.client_side_validation && cart.nil?
56
+ fail ArgumentError, "Missing the required parameter 'cart' when calling CheckoutApi.city_state"
57
+ end
58
+ # resource path
59
+ local_var_path = '/checkout/city_state'
60
+
61
+ # query parameters
62
+ query_params = opts[:query_params] || {}
63
+
64
+ # header parameters
65
+ header_params = opts[:header_params] || {}
66
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
67
+ # HTTP header 'Accept' (if needed)
68
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
69
+ # HTTP header 'Content-Type'
70
+ content_type = @api_client.select_header_content_type(['application/json'])
71
+ if !content_type.nil?
72
+ header_params['Content-Type'] = content_type
73
+ end
74
+
75
+ # form parameters
76
+ form_params = opts[:form_params] || {}
77
+
78
+ # http body (model)
79
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(cart)
80
+
81
+ # return_type
82
+ return_type = opts[:debug_return_type] || 'CityStateZip'
83
+
84
+ # auth_names
85
+ auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
86
+
87
+ new_options = opts.merge(
88
+ :operation => :"CheckoutApi.city_state",
89
+ :header_params => header_params,
90
+ :query_params => query_params,
91
+ :form_params => form_params,
92
+ :body => post_body,
93
+ :auth_names => auth_names,
94
+ :return_type => return_type
95
+ )
96
+
97
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
98
+ if @api_client.config.debugging
99
+ @api_client.config.logger.debug "API called: CheckoutApi#city_state\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
100
+ end
101
+ return data, status_code, headers
102
+ end
103
+
104
+ # Finalize Order
105
+ # Finalize the cart into an order. This method can not be called with browser key authentication. It is ONLY meant for server side code to call.
106
+ # @param finalize_request [CartFinalizeOrderRequest] Finalize request
107
+ # @param [Hash] opts the optional parameters
108
+ # @return [CartFinalizeOrderResponse]
109
+ def finalize_order(finalize_request, opts = {})
110
+ data, _status_code, _headers = finalize_order_with_http_info(finalize_request, opts)
111
+ data
112
+ end
113
+
114
+ # Finalize Order
115
+ # Finalize the cart into an order. This method can not be called with browser key authentication. It is ONLY meant for server side code to call.
116
+ # @param finalize_request [CartFinalizeOrderRequest] Finalize request
117
+ # @param [Hash] opts the optional parameters
118
+ # @return [Array<(CartFinalizeOrderResponse, Integer, Hash)>] CartFinalizeOrderResponse data, response status code and response headers
119
+ def finalize_order_with_http_info(finalize_request, opts = {})
120
+ if @api_client.config.debugging
121
+ @api_client.config.logger.debug 'Calling API: CheckoutApi.finalize_order ...'
122
+ end
123
+ # verify the required parameter 'finalize_request' is set
124
+ if @api_client.config.client_side_validation && finalize_request.nil?
125
+ fail ArgumentError, "Missing the required parameter 'finalize_request' when calling CheckoutApi.finalize_order"
126
+ end
127
+ # resource path
128
+ local_var_path = '/checkout/cart/finalizeOrder'
129
+
130
+ # query parameters
131
+ query_params = opts[:query_params] || {}
132
+
133
+ # header parameters
134
+ header_params = opts[:header_params] || {}
135
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
136
+ # HTTP header 'Accept' (if needed)
137
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
138
+ # HTTP header 'Content-Type'
139
+ content_type = @api_client.select_header_content_type(['application/json'])
140
+ if !content_type.nil?
141
+ header_params['Content-Type'] = content_type
142
+ end
143
+
144
+ # form parameters
145
+ form_params = opts[:form_params] || {}
146
+
147
+ # http body (model)
148
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(finalize_request)
149
+
150
+ # return_type
151
+ return_type = opts[:debug_return_type] || 'CartFinalizeOrderResponse'
152
+
153
+ # auth_names
154
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
155
+
156
+ new_options = opts.merge(
157
+ :operation => :"CheckoutApi.finalize_order",
158
+ :header_params => header_params,
159
+ :query_params => query_params,
160
+ :form_params => form_params,
161
+ :body => post_body,
162
+ :auth_names => auth_names,
163
+ :return_type => return_type
164
+ )
165
+
166
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
167
+ if @api_client.config.debugging
168
+ @api_client.config.logger.debug "API called: CheckoutApi#finalize_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
169
+ end
170
+ return data, status_code, headers
171
+ end
172
+
173
+ # Get affirm checkout (by cart id)
174
+ # Get a Affirm checkout object for the specified cart_id parameter.
175
+ # @param cart_id [String] Cart ID to retrieve
176
+ # @param [Hash] opts the optional parameters
177
+ # @return [CartAffirmCheckoutResponse]
178
+ def get_affirm_checkout(cart_id, opts = {})
179
+ data, _status_code, _headers = get_affirm_checkout_with_http_info(cart_id, opts)
180
+ data
181
+ end
182
+
183
+ # Get affirm checkout (by cart id)
184
+ # Get a Affirm checkout object for the specified cart_id parameter.
185
+ # @param cart_id [String] Cart ID to retrieve
186
+ # @param [Hash] opts the optional parameters
187
+ # @return [Array<(CartAffirmCheckoutResponse, Integer, Hash)>] CartAffirmCheckoutResponse data, response status code and response headers
188
+ def get_affirm_checkout_with_http_info(cart_id, opts = {})
189
+ if @api_client.config.debugging
190
+ @api_client.config.logger.debug 'Calling API: CheckoutApi.get_affirm_checkout ...'
191
+ end
192
+ # verify the required parameter 'cart_id' is set
193
+ if @api_client.config.client_side_validation && cart_id.nil?
194
+ fail ArgumentError, "Missing the required parameter 'cart_id' when calling CheckoutApi.get_affirm_checkout"
195
+ end
196
+ # resource path
197
+ local_var_path = '/checkout/cart/{cart_id}/affirmCheckout'.sub('{' + 'cart_id' + '}', CGI.escape(cart_id.to_s))
198
+
199
+ # query parameters
200
+ query_params = opts[:query_params] || {}
201
+
202
+ # header parameters
203
+ header_params = opts[:header_params] || {}
204
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
205
+ # HTTP header 'Accept' (if needed)
206
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
207
+
208
+ # form parameters
209
+ form_params = opts[:form_params] || {}
210
+
211
+ # http body (model)
212
+ post_body = opts[:debug_body]
213
+
214
+ # return_type
215
+ return_type = opts[:debug_return_type] || 'CartAffirmCheckoutResponse'
216
+
217
+ # auth_names
218
+ auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
219
+
220
+ new_options = opts.merge(
221
+ :operation => :"CheckoutApi.get_affirm_checkout",
222
+ :header_params => header_params,
223
+ :query_params => query_params,
224
+ :form_params => form_params,
225
+ :body => post_body,
226
+ :auth_names => auth_names,
227
+ :return_type => return_type
228
+ )
229
+
230
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
231
+ if @api_client.config.debugging
232
+ @api_client.config.logger.debug "API called: CheckoutApi#get_affirm_checkout\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
233
+ end
234
+ return data, status_code, headers
235
+ end
236
+
237
+ # Allowed countries
238
+ # Lookup the allowed countries for this merchant id
239
+ # @param [Hash] opts the optional parameters
240
+ # @return [CheckoutAllowedCountriesResponse]
241
+ def get_allowed_countries(opts = {})
242
+ data, _status_code, _headers = get_allowed_countries_with_http_info(opts)
243
+ data
244
+ end
245
+
246
+ # Allowed countries
247
+ # Lookup the allowed countries for this merchant id
248
+ # @param [Hash] opts the optional parameters
249
+ # @return [Array<(CheckoutAllowedCountriesResponse, Integer, Hash)>] CheckoutAllowedCountriesResponse data, response status code and response headers
250
+ def get_allowed_countries_with_http_info(opts = {})
251
+ if @api_client.config.debugging
252
+ @api_client.config.logger.debug 'Calling API: CheckoutApi.get_allowed_countries ...'
253
+ end
254
+ # resource path
255
+ local_var_path = '/checkout/allowedCountries'
256
+
257
+ # query parameters
258
+ query_params = opts[:query_params] || {}
259
+
260
+ # header parameters
261
+ header_params = opts[:header_params] || {}
262
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
263
+ # HTTP header 'Accept' (if needed)
264
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
265
+
266
+ # form parameters
267
+ form_params = opts[:form_params] || {}
268
+
269
+ # http body (model)
270
+ post_body = opts[:debug_body]
271
+
272
+ # return_type
273
+ return_type = opts[:debug_return_type] || 'CheckoutAllowedCountriesResponse'
274
+
275
+ # auth_names
276
+ auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
277
+
278
+ new_options = opts.merge(
279
+ :operation => :"CheckoutApi.get_allowed_countries",
280
+ :header_params => header_params,
281
+ :query_params => query_params,
282
+ :form_params => form_params,
283
+ :body => post_body,
284
+ :auth_names => auth_names,
285
+ :return_type => return_type
286
+ )
287
+
288
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
289
+ if @api_client.config.debugging
290
+ @api_client.config.logger.debug "API called: CheckoutApi#get_allowed_countries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
291
+ end
292
+ return data, status_code, headers
293
+ end
294
+
295
+ # Get cart
296
+ # If the cookie is set on the browser making the request then it will return their active cart. Otherwise it will create a new cart.
297
+ # @param [Hash] opts the optional parameters
298
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
299
+ # @return [CartResponse]
300
+ def get_cart(opts = {})
301
+ data, _status_code, _headers = get_cart_with_http_info(opts)
302
+ data
303
+ end
304
+
305
+ # Get cart
306
+ # If the cookie is set on the browser making the request then it will return their active cart. Otherwise it will create a new cart.
307
+ # @param [Hash] opts the optional parameters
308
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
309
+ # @return [Array<(CartResponse, Integer, Hash)>] CartResponse data, response status code and response headers
310
+ def get_cart_with_http_info(opts = {})
311
+ if @api_client.config.debugging
312
+ @api_client.config.logger.debug 'Calling API: CheckoutApi.get_cart ...'
313
+ end
314
+ # resource path
315
+ local_var_path = '/checkout/cart'
316
+
317
+ # query parameters
318
+ query_params = opts[:query_params] || {}
319
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
320
+
321
+ # header parameters
322
+ header_params = opts[:header_params] || {}
323
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
324
+ # HTTP header 'Accept' (if needed)
325
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
326
+
327
+ # form parameters
328
+ form_params = opts[:form_params] || {}
329
+
330
+ # http body (model)
331
+ post_body = opts[:debug_body]
332
+
333
+ # return_type
334
+ return_type = opts[:debug_return_type] || 'CartResponse'
335
+
336
+ # auth_names
337
+ auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
338
+
339
+ new_options = opts.merge(
340
+ :operation => :"CheckoutApi.get_cart",
341
+ :header_params => header_params,
342
+ :query_params => query_params,
343
+ :form_params => form_params,
344
+ :body => post_body,
345
+ :auth_names => auth_names,
346
+ :return_type => return_type
347
+ )
348
+
349
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
350
+ if @api_client.config.debugging
351
+ @api_client.config.logger.debug "API called: CheckoutApi#get_cart\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
352
+ end
353
+ return data, status_code, headers
354
+ end
355
+
356
+ # Get cart (by cart id)
357
+ # Get a cart specified by the cart_id parameter.
358
+ # @param cart_id [String] Cart ID to retrieve
359
+ # @param [Hash] opts the optional parameters
360
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
361
+ # @return [CartResponse]
362
+ def get_cart_by_cart_id(cart_id, opts = {})
363
+ data, _status_code, _headers = get_cart_by_cart_id_with_http_info(cart_id, opts)
364
+ data
365
+ end
366
+
367
+ # Get cart (by cart id)
368
+ # Get a cart specified by the cart_id parameter.
369
+ # @param cart_id [String] Cart ID to retrieve
370
+ # @param [Hash] opts the optional parameters
371
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
372
+ # @return [Array<(CartResponse, Integer, Hash)>] CartResponse data, response status code and response headers
373
+ def get_cart_by_cart_id_with_http_info(cart_id, opts = {})
374
+ if @api_client.config.debugging
375
+ @api_client.config.logger.debug 'Calling API: CheckoutApi.get_cart_by_cart_id ...'
376
+ end
377
+ # verify the required parameter 'cart_id' is set
378
+ if @api_client.config.client_side_validation && cart_id.nil?
379
+ fail ArgumentError, "Missing the required parameter 'cart_id' when calling CheckoutApi.get_cart_by_cart_id"
380
+ end
381
+ # resource path
382
+ local_var_path = '/checkout/cart/{cart_id}'.sub('{' + 'cart_id' + '}', CGI.escape(cart_id.to_s))
383
+
384
+ # query parameters
385
+ query_params = opts[:query_params] || {}
386
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
387
+
388
+ # header parameters
389
+ header_params = opts[:header_params] || {}
390
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
391
+ # HTTP header 'Accept' (if needed)
392
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
393
+
394
+ # form parameters
395
+ form_params = opts[:form_params] || {}
396
+
397
+ # http body (model)
398
+ post_body = opts[:debug_body]
399
+
400
+ # return_type
401
+ return_type = opts[:debug_return_type] || 'CartResponse'
402
+
403
+ # auth_names
404
+ auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
405
+
406
+ new_options = opts.merge(
407
+ :operation => :"CheckoutApi.get_cart_by_cart_id",
408
+ :header_params => header_params,
409
+ :query_params => query_params,
410
+ :form_params => form_params,
411
+ :body => post_body,
412
+ :auth_names => auth_names,
413
+ :return_type => return_type
414
+ )
415
+
416
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
417
+ if @api_client.config.debugging
418
+ @api_client.config.logger.debug "API called: CheckoutApi#get_cart_by_cart_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
419
+ end
420
+ return data, status_code, headers
421
+ end
422
+
423
+ # Get cart (by return code)
424
+ # Get a cart specified by the return code parameter.
425
+ # @param return_code [String] Return code to lookup cart ID by
426
+ # @param [Hash] opts the optional parameters
427
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
428
+ # @return [CartResponse]
429
+ def get_cart_by_return_code(return_code, opts = {})
430
+ data, _status_code, _headers = get_cart_by_return_code_with_http_info(return_code, opts)
431
+ data
432
+ end
433
+
434
+ # Get cart (by return code)
435
+ # Get a cart specified by the return code parameter.
436
+ # @param return_code [String] Return code to lookup cart ID by
437
+ # @param [Hash] opts the optional parameters
438
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
439
+ # @return [Array<(CartResponse, Integer, Hash)>] CartResponse data, response status code and response headers
440
+ def get_cart_by_return_code_with_http_info(return_code, opts = {})
441
+ if @api_client.config.debugging
442
+ @api_client.config.logger.debug 'Calling API: CheckoutApi.get_cart_by_return_code ...'
443
+ end
444
+ # verify the required parameter 'return_code' is set
445
+ if @api_client.config.client_side_validation && return_code.nil?
446
+ fail ArgumentError, "Missing the required parameter 'return_code' when calling CheckoutApi.get_cart_by_return_code"
447
+ end
448
+ # resource path
449
+ local_var_path = '/checkout/return/{return_code}'.sub('{' + 'return_code' + '}', CGI.escape(return_code.to_s))
450
+
451
+ # query parameters
452
+ query_params = opts[:query_params] || {}
453
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
454
+
455
+ # header parameters
456
+ header_params = opts[:header_params] || {}
457
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
458
+ # HTTP header 'Accept' (if needed)
459
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
460
+
461
+ # form parameters
462
+ form_params = opts[:form_params] || {}
463
+
464
+ # http body (model)
465
+ post_body = opts[:debug_body]
466
+
467
+ # return_type
468
+ return_type = opts[:debug_return_type] || 'CartResponse'
469
+
470
+ # auth_names
471
+ auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
472
+
473
+ new_options = opts.merge(
474
+ :operation => :"CheckoutApi.get_cart_by_return_code",
475
+ :header_params => header_params,
476
+ :query_params => query_params,
477
+ :form_params => form_params,
478
+ :body => post_body,
479
+ :auth_names => auth_names,
480
+ :return_type => return_type
481
+ )
482
+
483
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
484
+ if @api_client.config.debugging
485
+ @api_client.config.logger.debug "API called: CheckoutApi#get_cart_by_return_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
486
+ end
487
+ return data, status_code, headers
488
+ end
489
+
490
+ # Get cart (by return token)
491
+ # Get a cart specified by the encrypted return token parameter.
492
+ # @param [Hash] opts the optional parameters
493
+ # @option opts [String] :return_token Return token provided by StoreFront Communications
494
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
495
+ # @return [CartResponse]
496
+ def get_cart_by_return_token(opts = {})
497
+ data, _status_code, _headers = get_cart_by_return_token_with_http_info(opts)
498
+ data
499
+ end
500
+
501
+ # Get cart (by return token)
502
+ # Get a cart specified by the encrypted return token parameter.
503
+ # @param [Hash] opts the optional parameters
504
+ # @option opts [String] :return_token Return token provided by StoreFront Communications
505
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
506
+ # @return [Array<(CartResponse, Integer, Hash)>] CartResponse data, response status code and response headers
507
+ def get_cart_by_return_token_with_http_info(opts = {})
508
+ if @api_client.config.debugging
509
+ @api_client.config.logger.debug 'Calling API: CheckoutApi.get_cart_by_return_token ...'
510
+ end
511
+ # resource path
512
+ local_var_path = '/checkout/return_token'
513
+
514
+ # query parameters
515
+ query_params = opts[:query_params] || {}
516
+ query_params[:'return_token'] = opts[:'return_token'] if !opts[:'return_token'].nil?
517
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
518
+
519
+ # header parameters
520
+ header_params = opts[:header_params] || {}
521
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
522
+ # HTTP header 'Accept' (if needed)
523
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
524
+
525
+ # form parameters
526
+ form_params = opts[:form_params] || {}
527
+
528
+ # http body (model)
529
+ post_body = opts[:debug_body]
530
+
531
+ # return_type
532
+ return_type = opts[:debug_return_type] || 'CartResponse'
533
+
534
+ # auth_names
535
+ auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
536
+
537
+ new_options = opts.merge(
538
+ :operation => :"CheckoutApi.get_cart_by_return_token",
539
+ :header_params => header_params,
540
+ :query_params => query_params,
541
+ :form_params => form_params,
542
+ :body => post_body,
543
+ :auth_names => auth_names,
544
+ :return_type => return_type
545
+ )
546
+
547
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
548
+ if @api_client.config.debugging
549
+ @api_client.config.logger.debug "API called: CheckoutApi#get_cart_by_return_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
550
+ end
551
+ return data, status_code, headers
552
+ end
553
+
554
+ # Get state/province list for a country code
555
+ # Lookup a state/province list for a given country code
556
+ # @param country_code [String] Two letter ISO country code
557
+ # @param [Hash] opts the optional parameters
558
+ # @return [CheckoutStateProvinceResponse]
559
+ def get_state_provinces_for_country(country_code, opts = {})
560
+ data, _status_code, _headers = get_state_provinces_for_country_with_http_info(country_code, opts)
561
+ data
562
+ end
563
+
564
+ # Get state/province list for a country code
565
+ # Lookup a state/province list for a given country code
566
+ # @param country_code [String] Two letter ISO country code
567
+ # @param [Hash] opts the optional parameters
568
+ # @return [Array<(CheckoutStateProvinceResponse, Integer, Hash)>] CheckoutStateProvinceResponse data, response status code and response headers
569
+ def get_state_provinces_for_country_with_http_info(country_code, opts = {})
570
+ if @api_client.config.debugging
571
+ @api_client.config.logger.debug 'Calling API: CheckoutApi.get_state_provinces_for_country ...'
572
+ end
573
+ # verify the required parameter 'country_code' is set
574
+ if @api_client.config.client_side_validation && country_code.nil?
575
+ fail ArgumentError, "Missing the required parameter 'country_code' when calling CheckoutApi.get_state_provinces_for_country"
576
+ end
577
+ # resource path
578
+ local_var_path = '/checkout/stateProvincesForCountry/{country_code}'.sub('{' + 'country_code' + '}', CGI.escape(country_code.to_s))
579
+
580
+ # query parameters
581
+ query_params = opts[:query_params] || {}
582
+
583
+ # header parameters
584
+ header_params = opts[:header_params] || {}
585
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
586
+ # HTTP header 'Accept' (if needed)
587
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
588
+
589
+ # form parameters
590
+ form_params = opts[:form_params] || {}
591
+
592
+ # http body (model)
593
+ post_body = opts[:debug_body]
594
+
595
+ # return_type
596
+ return_type = opts[:debug_return_type] || 'CheckoutStateProvinceResponse'
597
+
598
+ # auth_names
599
+ auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
600
+
601
+ new_options = opts.merge(
602
+ :operation => :"CheckoutApi.get_state_provinces_for_country",
603
+ :header_params => header_params,
604
+ :query_params => query_params,
605
+ :form_params => form_params,
606
+ :body => post_body,
607
+ :auth_names => auth_names,
608
+ :return_type => return_type
609
+ )
610
+
611
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
612
+ if @api_client.config.debugging
613
+ @api_client.config.logger.debug "API called: CheckoutApi#get_state_provinces_for_country\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
614
+ end
615
+ return data, status_code, headers
616
+ end
617
+
618
+ # Handoff cart
619
+ # Handoff the browser to UltraCart for view cart on StoreFront, transfer to PayPal, transfer to Affirm, transfer to Sezzle or finalization of the order (including upsell processing).
620
+ # @param handoff_request [CheckoutHandoffRequest] Handoff request
621
+ # @param [Hash] opts the optional parameters
622
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
623
+ # @return [CheckoutHandoffResponse]
624
+ def handoff_cart(handoff_request, opts = {})
625
+ data, _status_code, _headers = handoff_cart_with_http_info(handoff_request, opts)
626
+ data
627
+ end
628
+
629
+ # Handoff cart
630
+ # Handoff the browser to UltraCart for view cart on StoreFront, transfer to PayPal, transfer to Affirm, transfer to Sezzle or finalization of the order (including upsell processing).
631
+ # @param handoff_request [CheckoutHandoffRequest] Handoff request
632
+ # @param [Hash] opts the optional parameters
633
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
634
+ # @return [Array<(CheckoutHandoffResponse, Integer, Hash)>] CheckoutHandoffResponse data, response status code and response headers
635
+ def handoff_cart_with_http_info(handoff_request, opts = {})
636
+ if @api_client.config.debugging
637
+ @api_client.config.logger.debug 'Calling API: CheckoutApi.handoff_cart ...'
638
+ end
639
+ # verify the required parameter 'handoff_request' is set
640
+ if @api_client.config.client_side_validation && handoff_request.nil?
641
+ fail ArgumentError, "Missing the required parameter 'handoff_request' when calling CheckoutApi.handoff_cart"
642
+ end
643
+ # resource path
644
+ local_var_path = '/checkout/cart/handoff'
645
+
646
+ # query parameters
647
+ query_params = opts[:query_params] || {}
648
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
649
+
650
+ # header parameters
651
+ header_params = opts[:header_params] || {}
652
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
653
+ # HTTP header 'Accept' (if needed)
654
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
655
+ # HTTP header 'Content-Type'
656
+ content_type = @api_client.select_header_content_type(['application/json'])
657
+ if !content_type.nil?
658
+ header_params['Content-Type'] = content_type
659
+ end
660
+
661
+ # form parameters
662
+ form_params = opts[:form_params] || {}
663
+
664
+ # http body (model)
665
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(handoff_request)
666
+
667
+ # return_type
668
+ return_type = opts[:debug_return_type] || 'CheckoutHandoffResponse'
669
+
670
+ # auth_names
671
+ auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
672
+
673
+ new_options = opts.merge(
674
+ :operation => :"CheckoutApi.handoff_cart",
675
+ :header_params => header_params,
676
+ :query_params => query_params,
677
+ :form_params => form_params,
678
+ :body => post_body,
679
+ :auth_names => auth_names,
680
+ :return_type => return_type
681
+ )
682
+
683
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
684
+ if @api_client.config.debugging
685
+ @api_client.config.logger.debug "API called: CheckoutApi#handoff_cart\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
686
+ end
687
+ return data, status_code, headers
688
+ end
689
+
690
+ # Profile login
691
+ # Login in to the customer profile specified by cart.billing.email and password
692
+ # @param login_request [CartProfileLoginRequest] Login request
693
+ # @param [Hash] opts the optional parameters
694
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
695
+ # @return [CartProfileLoginResponse]
696
+ def login(login_request, opts = {})
697
+ data, _status_code, _headers = login_with_http_info(login_request, opts)
698
+ data
699
+ end
700
+
701
+ # Profile login
702
+ # Login in to the customer profile specified by cart.billing.email and password
703
+ # @param login_request [CartProfileLoginRequest] Login request
704
+ # @param [Hash] opts the optional parameters
705
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
706
+ # @return [Array<(CartProfileLoginResponse, Integer, Hash)>] CartProfileLoginResponse data, response status code and response headers
707
+ def login_with_http_info(login_request, opts = {})
708
+ if @api_client.config.debugging
709
+ @api_client.config.logger.debug 'Calling API: CheckoutApi.login ...'
710
+ end
711
+ # verify the required parameter 'login_request' is set
712
+ if @api_client.config.client_side_validation && login_request.nil?
713
+ fail ArgumentError, "Missing the required parameter 'login_request' when calling CheckoutApi.login"
714
+ end
715
+ # resource path
716
+ local_var_path = '/checkout/cart/profile/login'
717
+
718
+ # query parameters
719
+ query_params = opts[:query_params] || {}
720
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
721
+
722
+ # header parameters
723
+ header_params = opts[:header_params] || {}
724
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
725
+ # HTTP header 'Accept' (if needed)
726
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
727
+ # HTTP header 'Content-Type'
728
+ content_type = @api_client.select_header_content_type(['application/json'])
729
+ if !content_type.nil?
730
+ header_params['Content-Type'] = content_type
731
+ end
732
+
733
+ # form parameters
734
+ form_params = opts[:form_params] || {}
735
+
736
+ # http body (model)
737
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(login_request)
738
+
739
+ # return_type
740
+ return_type = opts[:debug_return_type] || 'CartProfileLoginResponse'
741
+
742
+ # auth_names
743
+ auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
744
+
745
+ new_options = opts.merge(
746
+ :operation => :"CheckoutApi.login",
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(:POST, local_var_path, new_options)
756
+ if @api_client.config.debugging
757
+ @api_client.config.logger.debug "API called: CheckoutApi#login\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
758
+ end
759
+ return data, status_code, headers
760
+ end
761
+
762
+ # Profile logout
763
+ # Log the cart out of the current profile. No error will occur if they are not logged in.
764
+ # @param cart [Cart] Cart
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 [CartResponse]
768
+ def logout(cart, opts = {})
769
+ data, _status_code, _headers = logout_with_http_info(cart, opts)
770
+ data
771
+ end
772
+
773
+ # Profile logout
774
+ # Log the cart out of the current profile. No error will occur if they are not logged in.
775
+ # @param cart [Cart] Cart
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<(CartResponse, Integer, Hash)>] CartResponse data, response status code and response headers
779
+ def logout_with_http_info(cart, opts = {})
780
+ if @api_client.config.debugging
781
+ @api_client.config.logger.debug 'Calling API: CheckoutApi.logout ...'
782
+ end
783
+ # verify the required parameter 'cart' is set
784
+ if @api_client.config.client_side_validation && cart.nil?
785
+ fail ArgumentError, "Missing the required parameter 'cart' when calling CheckoutApi.logout"
786
+ end
787
+ # resource path
788
+ local_var_path = '/checkout/cart/profile/logout'
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(cart)
810
+
811
+ # return_type
812
+ return_type = opts[:debug_return_type] || 'CartResponse'
813
+
814
+ # auth_names
815
+ auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
816
+
817
+ new_options = opts.merge(
818
+ :operation => :"CheckoutApi.logout",
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: CheckoutApi#logout\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
830
+ end
831
+ return data, status_code, headers
832
+ end
833
+
834
+ # Profile registration
835
+ # Register a new customer profile. Requires the cart.billing object to be populated along with the password.
836
+ # @param register_request [CartProfileRegisterRequest] Register request
837
+ # @param [Hash] opts the optional parameters
838
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
839
+ # @return [CartProfileRegisterResponse]
840
+ def register(register_request, opts = {})
841
+ data, _status_code, _headers = register_with_http_info(register_request, opts)
842
+ data
843
+ end
844
+
845
+ # Profile registration
846
+ # Register a new customer profile. Requires the cart.billing object to be populated along with the password.
847
+ # @param register_request [CartProfileRegisterRequest] Register request
848
+ # @param [Hash] opts the optional parameters
849
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
850
+ # @return [Array<(CartProfileRegisterResponse, Integer, Hash)>] CartProfileRegisterResponse data, response status code and response headers
851
+ def register_with_http_info(register_request, opts = {})
852
+ if @api_client.config.debugging
853
+ @api_client.config.logger.debug 'Calling API: CheckoutApi.register ...'
854
+ end
855
+ # verify the required parameter 'register_request' is set
856
+ if @api_client.config.client_side_validation && register_request.nil?
857
+ fail ArgumentError, "Missing the required parameter 'register_request' when calling CheckoutApi.register"
858
+ end
859
+ # resource path
860
+ local_var_path = '/checkout/cart/profile/register'
861
+
862
+ # query parameters
863
+ query_params = opts[:query_params] || {}
864
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
865
+
866
+ # header parameters
867
+ header_params = opts[:header_params] || {}
868
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
869
+ # HTTP header 'Accept' (if needed)
870
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
871
+ # HTTP header 'Content-Type'
872
+ content_type = @api_client.select_header_content_type(['application/json'])
873
+ if !content_type.nil?
874
+ header_params['Content-Type'] = content_type
875
+ end
876
+
877
+ # form parameters
878
+ form_params = opts[:form_params] || {}
879
+
880
+ # http body (model)
881
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(register_request)
882
+
883
+ # return_type
884
+ return_type = opts[:debug_return_type] || 'CartProfileRegisterResponse'
885
+
886
+ # auth_names
887
+ auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
888
+
889
+ new_options = opts.merge(
890
+ :operation => :"CheckoutApi.register",
891
+ :header_params => header_params,
892
+ :query_params => query_params,
893
+ :form_params => form_params,
894
+ :body => post_body,
895
+ :auth_names => auth_names,
896
+ :return_type => return_type
897
+ )
898
+
899
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
900
+ if @api_client.config.debugging
901
+ @api_client.config.logger.debug "API called: CheckoutApi#register\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
902
+ end
903
+ return data, status_code, headers
904
+ end
905
+
906
+ # Register affiliate click
907
+ # Register an affiliate click. Used by custom checkouts that are completely API based and do not perform checkout handoff.
908
+ # @param register_affiliate_click_request [RegisterAffiliateClickRequest] Register affiliate click request
909
+ # @param [Hash] opts the optional parameters
910
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
911
+ # @return [RegisterAffiliateClickResponse]
912
+ def register_affiliate_click(register_affiliate_click_request, opts = {})
913
+ data, _status_code, _headers = register_affiliate_click_with_http_info(register_affiliate_click_request, opts)
914
+ data
915
+ end
916
+
917
+ # Register affiliate click
918
+ # Register an affiliate click. Used by custom checkouts that are completely API based and do not perform checkout handoff.
919
+ # @param register_affiliate_click_request [RegisterAffiliateClickRequest] Register affiliate click request
920
+ # @param [Hash] opts the optional parameters
921
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
922
+ # @return [Array<(RegisterAffiliateClickResponse, Integer, Hash)>] RegisterAffiliateClickResponse data, response status code and response headers
923
+ def register_affiliate_click_with_http_info(register_affiliate_click_request, opts = {})
924
+ if @api_client.config.debugging
925
+ @api_client.config.logger.debug 'Calling API: CheckoutApi.register_affiliate_click ...'
926
+ end
927
+ # verify the required parameter 'register_affiliate_click_request' is set
928
+ if @api_client.config.client_side_validation && register_affiliate_click_request.nil?
929
+ fail ArgumentError, "Missing the required parameter 'register_affiliate_click_request' when calling CheckoutApi.register_affiliate_click"
930
+ end
931
+ # resource path
932
+ local_var_path = '/checkout/affiliateClick/register'
933
+
934
+ # query parameters
935
+ query_params = opts[:query_params] || {}
936
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
937
+
938
+ # header parameters
939
+ header_params = opts[:header_params] || {}
940
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
941
+ # HTTP header 'Accept' (if needed)
942
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
943
+ # HTTP header 'Content-Type'
944
+ content_type = @api_client.select_header_content_type(['application/json'])
945
+ if !content_type.nil?
946
+ header_params['Content-Type'] = content_type
947
+ end
948
+
949
+ # form parameters
950
+ form_params = opts[:form_params] || {}
951
+
952
+ # http body (model)
953
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(register_affiliate_click_request)
954
+
955
+ # return_type
956
+ return_type = opts[:debug_return_type] || 'RegisterAffiliateClickResponse'
957
+
958
+ # auth_names
959
+ auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
960
+
961
+ new_options = opts.merge(
962
+ :operation => :"CheckoutApi.register_affiliate_click",
963
+ :header_params => header_params,
964
+ :query_params => query_params,
965
+ :form_params => form_params,
966
+ :body => post_body,
967
+ :auth_names => auth_names,
968
+ :return_type => return_type
969
+ )
970
+
971
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
972
+ if @api_client.config.debugging
973
+ @api_client.config.logger.debug "API called: CheckoutApi#register_affiliate_click\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
974
+ end
975
+ return data, status_code, headers
976
+ end
977
+
978
+ # Related items
979
+ # Retrieve all the related items for the cart contents. Expansion is limited to content, content.assignments, content.attributes, content.multimedia, content.multimedia.thumbnails, options, pricing, and pricing.tiers.
980
+ # @param cart [Cart] Cart
981
+ # @param [Hash] opts the optional parameters
982
+ # @option opts [String] :_expand The object expansion to perform on the result. See item resource documentation for examples
983
+ # @return [ItemsResponse]
984
+ def related_items_for_cart(cart, opts = {})
985
+ data, _status_code, _headers = related_items_for_cart_with_http_info(cart, opts)
986
+ data
987
+ end
988
+
989
+ # Related items
990
+ # Retrieve all the related items for the cart contents. Expansion is limited to content, content.assignments, content.attributes, content.multimedia, content.multimedia.thumbnails, options, pricing, and pricing.tiers.
991
+ # @param cart [Cart] Cart
992
+ # @param [Hash] opts the optional parameters
993
+ # @option opts [String] :_expand The object expansion to perform on the result. See item resource documentation for examples
994
+ # @return [Array<(ItemsResponse, Integer, Hash)>] ItemsResponse data, response status code and response headers
995
+ def related_items_for_cart_with_http_info(cart, opts = {})
996
+ if @api_client.config.debugging
997
+ @api_client.config.logger.debug 'Calling API: CheckoutApi.related_items_for_cart ...'
998
+ end
999
+ # verify the required parameter 'cart' is set
1000
+ if @api_client.config.client_side_validation && cart.nil?
1001
+ fail ArgumentError, "Missing the required parameter 'cart' when calling CheckoutApi.related_items_for_cart"
1002
+ end
1003
+ # resource path
1004
+ local_var_path = '/checkout/related_items'
1005
+
1006
+ # query parameters
1007
+ query_params = opts[:query_params] || {}
1008
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1009
+
1010
+ # header parameters
1011
+ header_params = opts[:header_params] || {}
1012
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1013
+ # HTTP header 'Accept' (if needed)
1014
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1015
+ # HTTP header 'Content-Type'
1016
+ content_type = @api_client.select_header_content_type(['application/json'])
1017
+ if !content_type.nil?
1018
+ header_params['Content-Type'] = content_type
1019
+ end
1020
+
1021
+ # form parameters
1022
+ form_params = opts[:form_params] || {}
1023
+
1024
+ # http body (model)
1025
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(cart)
1026
+
1027
+ # return_type
1028
+ return_type = opts[:debug_return_type] || 'ItemsResponse'
1029
+
1030
+ # auth_names
1031
+ auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
1032
+
1033
+ new_options = opts.merge(
1034
+ :operation => :"CheckoutApi.related_items_for_cart",
1035
+ :header_params => header_params,
1036
+ :query_params => query_params,
1037
+ :form_params => form_params,
1038
+ :body => post_body,
1039
+ :auth_names => auth_names,
1040
+ :return_type => return_type
1041
+ )
1042
+
1043
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1044
+ if @api_client.config.debugging
1045
+ @api_client.config.logger.debug "API called: CheckoutApi#related_items_for_cart\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1046
+ end
1047
+ return data, status_code, headers
1048
+ end
1049
+
1050
+ # Related items (specific item)
1051
+ # Retrieve all the related items for the cart contents. Expansion is limited to content, content.assignments, content.attributes, content.multimedia, content.multimedia.thumbnails, options, pricing, and pricing.tiers.
1052
+ # @param item_id [String] Item ID to retrieve related items for
1053
+ # @param cart [Cart] Cart
1054
+ # @param [Hash] opts the optional parameters
1055
+ # @option opts [String] :_expand The object expansion to perform on the result. See item resource documentation for examples
1056
+ # @return [ItemsResponse]
1057
+ def related_items_for_item(item_id, cart, opts = {})
1058
+ data, _status_code, _headers = related_items_for_item_with_http_info(item_id, cart, opts)
1059
+ data
1060
+ end
1061
+
1062
+ # Related items (specific item)
1063
+ # Retrieve all the related items for the cart contents. Expansion is limited to content, content.assignments, content.attributes, content.multimedia, content.multimedia.thumbnails, options, pricing, and pricing.tiers.
1064
+ # @param item_id [String] Item ID to retrieve related items for
1065
+ # @param cart [Cart] Cart
1066
+ # @param [Hash] opts the optional parameters
1067
+ # @option opts [String] :_expand The object expansion to perform on the result. See item resource documentation for examples
1068
+ # @return [Array<(ItemsResponse, Integer, Hash)>] ItemsResponse data, response status code and response headers
1069
+ def related_items_for_item_with_http_info(item_id, cart, opts = {})
1070
+ if @api_client.config.debugging
1071
+ @api_client.config.logger.debug 'Calling API: CheckoutApi.related_items_for_item ...'
1072
+ end
1073
+ # verify the required parameter 'item_id' is set
1074
+ if @api_client.config.client_side_validation && item_id.nil?
1075
+ fail ArgumentError, "Missing the required parameter 'item_id' when calling CheckoutApi.related_items_for_item"
1076
+ end
1077
+ # verify the required parameter 'cart' is set
1078
+ if @api_client.config.client_side_validation && cart.nil?
1079
+ fail ArgumentError, "Missing the required parameter 'cart' when calling CheckoutApi.related_items_for_item"
1080
+ end
1081
+ # resource path
1082
+ local_var_path = '/checkout/relatedItems/{item_id}'.sub('{' + 'item_id' + '}', CGI.escape(item_id.to_s))
1083
+
1084
+ # query parameters
1085
+ query_params = opts[:query_params] || {}
1086
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1087
+
1088
+ # header parameters
1089
+ header_params = opts[:header_params] || {}
1090
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1091
+ # HTTP header 'Accept' (if needed)
1092
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1093
+ # HTTP header 'Content-Type'
1094
+ content_type = @api_client.select_header_content_type(['application/json'])
1095
+ if !content_type.nil?
1096
+ header_params['Content-Type'] = content_type
1097
+ end
1098
+
1099
+ # form parameters
1100
+ form_params = opts[:form_params] || {}
1101
+
1102
+ # http body (model)
1103
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(cart)
1104
+
1105
+ # return_type
1106
+ return_type = opts[:debug_return_type] || 'ItemsResponse'
1107
+
1108
+ # auth_names
1109
+ auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
1110
+
1111
+ new_options = opts.merge(
1112
+ :operation => :"CheckoutApi.related_items_for_item",
1113
+ :header_params => header_params,
1114
+ :query_params => query_params,
1115
+ :form_params => form_params,
1116
+ :body => post_body,
1117
+ :auth_names => auth_names,
1118
+ :return_type => return_type
1119
+ )
1120
+
1121
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1122
+ if @api_client.config.debugging
1123
+ @api_client.config.logger.debug "API called: CheckoutApi#related_items_for_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1124
+ end
1125
+ return data, status_code, headers
1126
+ end
1127
+
1128
+ # Setup Browser Application
1129
+ # Setup a browser key authenticated application with checkout permissions. This REST call must be made with an authentication scheme that is not browser key. The new application will be linked to the application that makes this call. If this application is disabled / deleted, then so will the application setup by this call. The purpose of this call is to allow an OAuth application, such as the Wordpress plugin, to setup the proper browser based authentication for the REST checkout API to use.
1130
+ # @param browser_key_request [CheckoutSetupBrowserKeyRequest] Setup browser key request
1131
+ # @param [Hash] opts the optional parameters
1132
+ # @return [CheckoutSetupBrowserKeyResponse]
1133
+ def setup_browser_key(browser_key_request, opts = {})
1134
+ data, _status_code, _headers = setup_browser_key_with_http_info(browser_key_request, opts)
1135
+ data
1136
+ end
1137
+
1138
+ # Setup Browser Application
1139
+ # Setup a browser key authenticated application with checkout permissions. This REST call must be made with an authentication scheme that is not browser key. The new application will be linked to the application that makes this call. If this application is disabled / deleted, then so will the application setup by this call. The purpose of this call is to allow an OAuth application, such as the Wordpress plugin, to setup the proper browser based authentication for the REST checkout API to use.
1140
+ # @param browser_key_request [CheckoutSetupBrowserKeyRequest] Setup browser key request
1141
+ # @param [Hash] opts the optional parameters
1142
+ # @return [Array<(CheckoutSetupBrowserKeyResponse, Integer, Hash)>] CheckoutSetupBrowserKeyResponse data, response status code and response headers
1143
+ def setup_browser_key_with_http_info(browser_key_request, opts = {})
1144
+ if @api_client.config.debugging
1145
+ @api_client.config.logger.debug 'Calling API: CheckoutApi.setup_browser_key ...'
1146
+ end
1147
+ # verify the required parameter 'browser_key_request' is set
1148
+ if @api_client.config.client_side_validation && browser_key_request.nil?
1149
+ fail ArgumentError, "Missing the required parameter 'browser_key_request' when calling CheckoutApi.setup_browser_key"
1150
+ end
1151
+ # resource path
1152
+ local_var_path = '/checkout/browser_key'
1153
+
1154
+ # query parameters
1155
+ query_params = opts[:query_params] || {}
1156
+
1157
+ # header parameters
1158
+ header_params = opts[:header_params] || {}
1159
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1160
+ # HTTP header 'Accept' (if needed)
1161
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1162
+ # HTTP header 'Content-Type'
1163
+ content_type = @api_client.select_header_content_type(['application/json'])
1164
+ if !content_type.nil?
1165
+ header_params['Content-Type'] = content_type
1166
+ end
1167
+
1168
+ # form parameters
1169
+ form_params = opts[:form_params] || {}
1170
+
1171
+ # http body (model)
1172
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(browser_key_request)
1173
+
1174
+ # return_type
1175
+ return_type = opts[:debug_return_type] || 'CheckoutSetupBrowserKeyResponse'
1176
+
1177
+ # auth_names
1178
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1179
+
1180
+ new_options = opts.merge(
1181
+ :operation => :"CheckoutApi.setup_browser_key",
1182
+ :header_params => header_params,
1183
+ :query_params => query_params,
1184
+ :form_params => form_params,
1185
+ :body => post_body,
1186
+ :auth_names => auth_names,
1187
+ :return_type => return_type
1188
+ )
1189
+
1190
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
1191
+ if @api_client.config.debugging
1192
+ @api_client.config.logger.debug "API called: CheckoutApi#setup_browser_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1193
+ end
1194
+ return data, status_code, headers
1195
+ end
1196
+
1197
+ # Update cart
1198
+ # Update the cart.
1199
+ # @param cart [Cart] Cart
1200
+ # @param [Hash] opts the optional parameters
1201
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1202
+ # @return [CartResponse]
1203
+ def update_cart(cart, opts = {})
1204
+ data, _status_code, _headers = update_cart_with_http_info(cart, opts)
1205
+ data
1206
+ end
1207
+
1208
+ # Update cart
1209
+ # Update the cart.
1210
+ # @param cart [Cart] Cart
1211
+ # @param [Hash] opts the optional parameters
1212
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1213
+ # @return [Array<(CartResponse, Integer, Hash)>] CartResponse data, response status code and response headers
1214
+ def update_cart_with_http_info(cart, opts = {})
1215
+ if @api_client.config.debugging
1216
+ @api_client.config.logger.debug 'Calling API: CheckoutApi.update_cart ...'
1217
+ end
1218
+ # verify the required parameter 'cart' is set
1219
+ if @api_client.config.client_side_validation && cart.nil?
1220
+ fail ArgumentError, "Missing the required parameter 'cart' when calling CheckoutApi.update_cart"
1221
+ end
1222
+ # resource path
1223
+ local_var_path = '/checkout/cart'
1224
+
1225
+ # query parameters
1226
+ query_params = opts[:query_params] || {}
1227
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1228
+
1229
+ # header parameters
1230
+ header_params = opts[:header_params] || {}
1231
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1232
+ # HTTP header 'Accept' (if needed)
1233
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1234
+ # HTTP header 'Content-Type'
1235
+ content_type = @api_client.select_header_content_type(['application/json'])
1236
+ if !content_type.nil?
1237
+ header_params['Content-Type'] = content_type
1238
+ end
1239
+
1240
+ # form parameters
1241
+ form_params = opts[:form_params] || {}
1242
+
1243
+ # http body (model)
1244
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(cart)
1245
+
1246
+ # return_type
1247
+ return_type = opts[:debug_return_type] || 'CartResponse'
1248
+
1249
+ # auth_names
1250
+ auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
1251
+
1252
+ new_options = opts.merge(
1253
+ :operation => :"CheckoutApi.update_cart",
1254
+ :header_params => header_params,
1255
+ :query_params => query_params,
1256
+ :form_params => form_params,
1257
+ :body => post_body,
1258
+ :auth_names => auth_names,
1259
+ :return_type => return_type
1260
+ )
1261
+
1262
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
1263
+ if @api_client.config.debugging
1264
+ @api_client.config.logger.debug "API called: CheckoutApi#update_cart\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1265
+ end
1266
+ return data, status_code, headers
1267
+ end
1268
+
1269
+ # Validate
1270
+ # Validate the cart for errors. Specific checks can be passed and multiple validations can occur throughout your checkout flow.
1271
+ # @param validation_request [CartValidationRequest] Validation request
1272
+ # @param [Hash] opts the optional parameters
1273
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1274
+ # @return [CartValidationResponse]
1275
+ def validate_cart(validation_request, opts = {})
1276
+ data, _status_code, _headers = validate_cart_with_http_info(validation_request, opts)
1277
+ data
1278
+ end
1279
+
1280
+ # Validate
1281
+ # Validate the cart for errors. Specific checks can be passed and multiple validations can occur throughout your checkout flow.
1282
+ # @param validation_request [CartValidationRequest] Validation request
1283
+ # @param [Hash] opts the optional parameters
1284
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1285
+ # @return [Array<(CartValidationResponse, Integer, Hash)>] CartValidationResponse data, response status code and response headers
1286
+ def validate_cart_with_http_info(validation_request, opts = {})
1287
+ if @api_client.config.debugging
1288
+ @api_client.config.logger.debug 'Calling API: CheckoutApi.validate_cart ...'
1289
+ end
1290
+ # verify the required parameter 'validation_request' is set
1291
+ if @api_client.config.client_side_validation && validation_request.nil?
1292
+ fail ArgumentError, "Missing the required parameter 'validation_request' when calling CheckoutApi.validate_cart"
1293
+ end
1294
+ # resource path
1295
+ local_var_path = '/checkout/cart/validate'
1296
+
1297
+ # query parameters
1298
+ query_params = opts[:query_params] || {}
1299
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1300
+
1301
+ # header parameters
1302
+ header_params = opts[:header_params] || {}
1303
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1304
+ # HTTP header 'Accept' (if needed)
1305
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1306
+ # HTTP header 'Content-Type'
1307
+ content_type = @api_client.select_header_content_type(['application/json'])
1308
+ if !content_type.nil?
1309
+ header_params['Content-Type'] = content_type
1310
+ end
1311
+
1312
+ # form parameters
1313
+ form_params = opts[:form_params] || {}
1314
+
1315
+ # http body (model)
1316
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(validation_request)
1317
+
1318
+ # return_type
1319
+ return_type = opts[:debug_return_type] || 'CartValidationResponse'
1320
+
1321
+ # auth_names
1322
+ auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
1323
+
1324
+ new_options = opts.merge(
1325
+ :operation => :"CheckoutApi.validate_cart",
1326
+ :header_params => header_params,
1327
+ :query_params => query_params,
1328
+ :form_params => form_params,
1329
+ :body => post_body,
1330
+ :auth_names => auth_names,
1331
+ :return_type => return_type
1332
+ )
1333
+
1334
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1335
+ if @api_client.config.debugging
1336
+ @api_client.config.logger.debug "API called: CheckoutApi#validate_cart\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1337
+ end
1338
+ return data, status_code, headers
1339
+ end
1340
+ end
1341
+ end