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,1161 +1,1390 @@
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 CouponApi
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::CouponApi.new(api_client)
33
- end
34
-
35
- # Delete a coupon
36
- # Delete a coupon on the UltraCart account.
37
- # @param coupon_oid The coupon_oid to delete.
38
- # @param [Hash] opts the optional parameters
39
- # @return [nil]
40
- def delete_coupon(coupon_oid, opts = {})
41
- delete_coupon_with_http_info(coupon_oid, opts)
42
- nil
43
- end
44
-
45
- # Delete a coupon
46
- # Delete a coupon on the UltraCart account.
47
- # @param coupon_oid The coupon_oid to delete.
48
- # @param [Hash] opts the optional parameters
49
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
50
- def delete_coupon_with_http_info(coupon_oid, opts = {})
51
- if @api_client.config.debugging
52
- @api_client.config.logger.debug 'Calling API: CouponApi.delete_coupon ...'
53
- end
54
- # verify the required parameter 'coupon_oid' is set
55
- if @api_client.config.client_side_validation && coupon_oid.nil?
56
- fail ArgumentError, "Missing the required parameter 'coupon_oid' when calling CouponApi.delete_coupon"
57
- end
58
- # resource path
59
- local_var_path = '/coupon/coupons/{coupon_oid}'.sub('{' + 'coupon_oid' + '}', coupon_oid.to_s)
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 = nil
77
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
78
- data, status_code, headers = @api_client.call_api(:DELETE, 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
- if @api_client.config.debugging
85
- @api_client.config.logger.debug "API called: CouponApi#delete_coupon\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
86
- end
87
- return data, status_code, headers
88
- end
89
- # Deletes multiple coupons
90
- # Delete coupons on the UltraCart account.
91
- # @param coupon_delete_request Coupon oids to delete
92
- # @param [Hash] opts the optional parameters
93
- # @return [nil]
94
- def delete_coupons_by_code(coupon_delete_request, opts = {})
95
- delete_coupons_by_code_with_http_info(coupon_delete_request, opts)
96
- nil
97
- end
98
-
99
- # Deletes multiple coupons
100
- # Delete coupons on the UltraCart account.
101
- # @param coupon_delete_request Coupon oids to delete
102
- # @param [Hash] opts the optional parameters
103
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
104
- def delete_coupons_by_code_with_http_info(coupon_delete_request, opts = {})
105
- if @api_client.config.debugging
106
- @api_client.config.logger.debug 'Calling API: CouponApi.delete_coupons_by_code ...'
107
- end
108
- # verify the required parameter 'coupon_delete_request' is set
109
- if @api_client.config.client_side_validation && coupon_delete_request.nil?
110
- fail ArgumentError, "Missing the required parameter 'coupon_delete_request' when calling CouponApi.delete_coupons_by_code"
111
- end
112
- # resource path
113
- local_var_path = '/coupon/coupons/by_code'
114
-
115
- # query parameters
116
- query_params = {}
117
-
118
- # header parameters
119
- header_params = {}
120
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
121
- # HTTP header 'Accept' (if needed)
122
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
123
- # HTTP header 'Content-Type'
124
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
125
-
126
- # form parameters
127
- form_params = {}
128
-
129
- # http body (model)
130
- post_body = @api_client.object_to_http_body(coupon_delete_request)
131
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
132
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
133
- :header_params => header_params,
134
- :query_params => query_params,
135
- :form_params => form_params,
136
- :body => post_body,
137
- :auth_names => auth_names)
138
- if @api_client.config.debugging
139
- @api_client.config.logger.debug "API called: CouponApi#delete_coupons_by_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
140
- end
141
- return data, status_code, headers
142
- end
143
- # Deletes multiple coupons
144
- # Delete coupons on the UltraCart account.
145
- # @param coupon_delete_request Coupon oids to delete
146
- # @param [Hash] opts the optional parameters
147
- # @return [nil]
148
- def delete_coupons_by_oid(coupon_delete_request, opts = {})
149
- delete_coupons_by_oid_with_http_info(coupon_delete_request, opts)
150
- nil
151
- end
152
-
153
- # Deletes multiple coupons
154
- # Delete coupons on the UltraCart account.
155
- # @param coupon_delete_request Coupon oids to delete
156
- # @param [Hash] opts the optional parameters
157
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
158
- def delete_coupons_by_oid_with_http_info(coupon_delete_request, opts = {})
159
- if @api_client.config.debugging
160
- @api_client.config.logger.debug 'Calling API: CouponApi.delete_coupons_by_oid ...'
161
- end
162
- # verify the required parameter 'coupon_delete_request' is set
163
- if @api_client.config.client_side_validation && coupon_delete_request.nil?
164
- fail ArgumentError, "Missing the required parameter 'coupon_delete_request' when calling CouponApi.delete_coupons_by_oid"
165
- end
166
- # resource path
167
- local_var_path = '/coupon/coupons/by_oid'
168
-
169
- # query parameters
170
- query_params = {}
171
-
172
- # header parameters
173
- header_params = {}
174
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
175
- # HTTP header 'Accept' (if needed)
176
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
177
- # HTTP header 'Content-Type'
178
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
179
-
180
- # form parameters
181
- form_params = {}
182
-
183
- # http body (model)
184
- post_body = @api_client.object_to_http_body(coupon_delete_request)
185
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
186
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
187
- :header_params => header_params,
188
- :query_params => query_params,
189
- :form_params => form_params,
190
- :body => post_body,
191
- :auth_names => auth_names)
192
- if @api_client.config.debugging
193
- @api_client.config.logger.debug "API called: CouponApi#delete_coupons_by_oid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
194
- end
195
- return data, status_code, headers
196
- end
197
- # Determines if a coupon merchant code already exists
198
- # Determines if a coupon merchant code already exists.
199
- # @param merchant_code The coupon merchant code to examine.
200
- # @param [Hash] opts the optional parameters
201
- # @return [CouponExistsResponse]
202
- def does_coupon_code_exist(merchant_code, opts = {})
203
- data, _status_code, _headers = does_coupon_code_exist_with_http_info(merchant_code, opts)
204
- data
205
- end
206
-
207
- # Determines if a coupon merchant code already exists
208
- # Determines if a coupon merchant code already exists.
209
- # @param merchant_code The coupon merchant code to examine.
210
- # @param [Hash] opts the optional parameters
211
- # @return [Array<(CouponExistsResponse, Fixnum, Hash)>] CouponExistsResponse data, response status code and response headers
212
- def does_coupon_code_exist_with_http_info(merchant_code, opts = {})
213
- if @api_client.config.debugging
214
- @api_client.config.logger.debug 'Calling API: CouponApi.does_coupon_code_exist ...'
215
- end
216
- # verify the required parameter 'merchant_code' is set
217
- if @api_client.config.client_side_validation && merchant_code.nil?
218
- fail ArgumentError, "Missing the required parameter 'merchant_code' when calling CouponApi.does_coupon_code_exist"
219
- end
220
- # resource path
221
- local_var_path = '/coupon/coupons/merchant_code/{merchant_code}/exists'.sub('{' + 'merchant_code' + '}', merchant_code.to_s)
222
-
223
- # query parameters
224
- query_params = {}
225
-
226
- # header parameters
227
- header_params = {}
228
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
229
- # HTTP header 'Accept' (if needed)
230
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
231
- # HTTP header 'Content-Type'
232
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
233
-
234
- # form parameters
235
- form_params = {}
236
-
237
- # http body (model)
238
- post_body = nil
239
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
240
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
241
- :header_params => header_params,
242
- :query_params => query_params,
243
- :form_params => form_params,
244
- :body => post_body,
245
- :auth_names => auth_names,
246
- :return_type => 'CouponExistsResponse')
247
- if @api_client.config.debugging
248
- @api_client.config.logger.debug "API called: CouponApi#does_coupon_code_exist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
249
- end
250
- return data, status_code, headers
251
- end
252
- # Generates one time codes for a coupon
253
- # Generate one time codes for a coupon
254
- # @param coupon_oid The coupon oid to generate codes.
255
- # @param coupon_codes_request Coupon code generation parameters
256
- # @param [Hash] opts the optional parameters
257
- # @return [CouponCodesResponse]
258
- def generate_coupon_codes(coupon_oid, coupon_codes_request, opts = {})
259
- data, _status_code, _headers = generate_coupon_codes_with_http_info(coupon_oid, coupon_codes_request, opts)
260
- data
261
- end
262
-
263
- # Generates one time codes for a coupon
264
- # Generate one time codes for a coupon
265
- # @param coupon_oid The coupon oid to generate codes.
266
- # @param coupon_codes_request Coupon code generation parameters
267
- # @param [Hash] opts the optional parameters
268
- # @return [Array<(CouponCodesResponse, Fixnum, Hash)>] CouponCodesResponse data, response status code and response headers
269
- def generate_coupon_codes_with_http_info(coupon_oid, coupon_codes_request, opts = {})
270
- if @api_client.config.debugging
271
- @api_client.config.logger.debug 'Calling API: CouponApi.generate_coupon_codes ...'
272
- end
273
- # verify the required parameter 'coupon_oid' is set
274
- if @api_client.config.client_side_validation && coupon_oid.nil?
275
- fail ArgumentError, "Missing the required parameter 'coupon_oid' when calling CouponApi.generate_coupon_codes"
276
- end
277
- # verify the required parameter 'coupon_codes_request' is set
278
- if @api_client.config.client_side_validation && coupon_codes_request.nil?
279
- fail ArgumentError, "Missing the required parameter 'coupon_codes_request' when calling CouponApi.generate_coupon_codes"
280
- end
281
- # resource path
282
- local_var_path = '/coupon/coupons/{coupon_oid}/generate_codes'.sub('{' + 'coupon_oid' + '}', coupon_oid.to_s)
283
-
284
- # query parameters
285
- query_params = {}
286
-
287
- # header parameters
288
- header_params = {}
289
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
290
- # HTTP header 'Accept' (if needed)
291
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
292
- # HTTP header 'Content-Type'
293
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
294
-
295
- # form parameters
296
- form_params = {}
297
-
298
- # http body (model)
299
- post_body = @api_client.object_to_http_body(coupon_codes_request)
300
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
301
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
302
- :header_params => header_params,
303
- :query_params => query_params,
304
- :form_params => form_params,
305
- :body => post_body,
306
- :auth_names => auth_names,
307
- :return_type => 'CouponCodesResponse')
308
- if @api_client.config.debugging
309
- @api_client.config.logger.debug "API called: CouponApi#generate_coupon_codes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
310
- end
311
- return data, status_code, headers
312
- end
313
- # Generates one time codes by merchant code
314
- # Generate one time codes by merchant code
315
- # @param merchant_code The merchant code to generate one time codes.
316
- # @param coupon_codes_request Coupon code generation parameters
317
- # @param [Hash] opts the optional parameters
318
- # @return [CouponCodesResponse]
319
- def generate_one_time_codes_by_merchant_code(merchant_code, coupon_codes_request, opts = {})
320
- data, _status_code, _headers = generate_one_time_codes_by_merchant_code_with_http_info(merchant_code, coupon_codes_request, opts)
321
- data
322
- end
323
-
324
- # Generates one time codes by merchant code
325
- # Generate one time codes by merchant code
326
- # @param merchant_code The merchant code to generate one time codes.
327
- # @param coupon_codes_request Coupon code generation parameters
328
- # @param [Hash] opts the optional parameters
329
- # @return [Array<(CouponCodesResponse, Fixnum, Hash)>] CouponCodesResponse data, response status code and response headers
330
- def generate_one_time_codes_by_merchant_code_with_http_info(merchant_code, coupon_codes_request, opts = {})
331
- if @api_client.config.debugging
332
- @api_client.config.logger.debug 'Calling API: CouponApi.generate_one_time_codes_by_merchant_code ...'
333
- end
334
- # verify the required parameter 'merchant_code' is set
335
- if @api_client.config.client_side_validation && merchant_code.nil?
336
- fail ArgumentError, "Missing the required parameter 'merchant_code' when calling CouponApi.generate_one_time_codes_by_merchant_code"
337
- end
338
- # verify the required parameter 'coupon_codes_request' is set
339
- if @api_client.config.client_side_validation && coupon_codes_request.nil?
340
- fail ArgumentError, "Missing the required parameter 'coupon_codes_request' when calling CouponApi.generate_one_time_codes_by_merchant_code"
341
- end
342
- # resource path
343
- local_var_path = '/coupon/coupons/merchant_code/{merchant_code}/generate_codes'.sub('{' + 'merchant_code' + '}', merchant_code.to_s)
344
-
345
- # query parameters
346
- query_params = {}
347
-
348
- # header parameters
349
- header_params = {}
350
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
351
- # HTTP header 'Accept' (if needed)
352
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
353
- # HTTP header 'Content-Type'
354
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
355
-
356
- # form parameters
357
- form_params = {}
358
-
359
- # http body (model)
360
- post_body = @api_client.object_to_http_body(coupon_codes_request)
361
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
362
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
363
- :header_params => header_params,
364
- :query_params => query_params,
365
- :form_params => form_params,
366
- :body => post_body,
367
- :auth_names => auth_names,
368
- :return_type => 'CouponCodesResponse')
369
- if @api_client.config.debugging
370
- @api_client.config.logger.debug "API called: CouponApi#generate_one_time_codes_by_merchant_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
371
- end
372
- return data, status_code, headers
373
- end
374
- # Retrieve auto apply rules and conditions
375
- # Retrieve auto apply rules and conditions
376
- # @param [Hash] opts the optional parameters
377
- # @return [CouponAutoApplyConditions]
378
- def get_auto_apply(opts = {})
379
- data, _status_code, _headers = get_auto_apply_with_http_info(opts)
380
- data
381
- end
382
-
383
- # Retrieve auto apply rules and conditions
384
- # Retrieve auto apply rules and conditions
385
- # @param [Hash] opts the optional parameters
386
- # @return [Array<(CouponAutoApplyConditions, Fixnum, Hash)>] CouponAutoApplyConditions data, response status code and response headers
387
- def get_auto_apply_with_http_info(opts = {})
388
- if @api_client.config.debugging
389
- @api_client.config.logger.debug 'Calling API: CouponApi.get_auto_apply ...'
390
- end
391
- # resource path
392
- local_var_path = '/coupon/auto_apply'
393
-
394
- # query parameters
395
- query_params = {}
396
-
397
- # header parameters
398
- header_params = {}
399
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
400
- # HTTP header 'Accept' (if needed)
401
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
402
- # HTTP header 'Content-Type'
403
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
404
-
405
- # form parameters
406
- form_params = {}
407
-
408
- # http body (model)
409
- post_body = nil
410
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
411
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
412
- :header_params => header_params,
413
- :query_params => query_params,
414
- :form_params => form_params,
415
- :body => post_body,
416
- :auth_names => auth_names,
417
- :return_type => 'CouponAutoApplyConditions')
418
- if @api_client.config.debugging
419
- @api_client.config.logger.debug "API called: CouponApi#get_auto_apply\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
420
- end
421
- return data, status_code, headers
422
- end
423
- # Retrieve a coupon
424
- # Retrieves a single coupon using the specified coupon profile oid.
425
- # @param coupon_oid The coupon oid to retrieve.
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 [CouponResponse]
429
- def get_coupon(coupon_oid, opts = {})
430
- data, _status_code, _headers = get_coupon_with_http_info(coupon_oid, opts)
431
- data
432
- end
433
-
434
- # Retrieve a coupon
435
- # Retrieves a single coupon using the specified coupon profile oid.
436
- # @param coupon_oid The coupon oid to retrieve.
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<(CouponResponse, Fixnum, Hash)>] CouponResponse data, response status code and response headers
440
- def get_coupon_with_http_info(coupon_oid, opts = {})
441
- if @api_client.config.debugging
442
- @api_client.config.logger.debug 'Calling API: CouponApi.get_coupon ...'
443
- end
444
- # verify the required parameter 'coupon_oid' is set
445
- if @api_client.config.client_side_validation && coupon_oid.nil?
446
- fail ArgumentError, "Missing the required parameter 'coupon_oid' when calling CouponApi.get_coupon"
447
- end
448
- # resource path
449
- local_var_path = '/coupon/coupons/{coupon_oid}'.sub('{' + 'coupon_oid' + '}', coupon_oid.to_s)
450
-
451
- # query parameters
452
- query_params = {}
453
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
454
-
455
- # header parameters
456
- 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
- # HTTP header 'Content-Type'
461
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
462
-
463
- # form parameters
464
- form_params = {}
465
-
466
- # http body (model)
467
- post_body = nil
468
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
469
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
470
- :header_params => header_params,
471
- :query_params => query_params,
472
- :form_params => form_params,
473
- :body => post_body,
474
- :auth_names => auth_names,
475
- :return_type => 'CouponResponse')
476
- if @api_client.config.debugging
477
- @api_client.config.logger.debug "API called: CouponApi#get_coupon\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
478
- end
479
- return data, status_code, headers
480
- end
481
- # Retrieve a coupon by merchant code
482
- # Retrieves a single coupon using the specified merchant code.
483
- # @param merchant_code The coupon merchant code to retrieve.
484
- # @param [Hash] opts the optional parameters
485
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
486
- # @return [CouponResponse]
487
- def get_coupon_by_merchant_code(merchant_code, opts = {})
488
- data, _status_code, _headers = get_coupon_by_merchant_code_with_http_info(merchant_code, opts)
489
- data
490
- end
491
-
492
- # Retrieve a coupon by merchant code
493
- # Retrieves a single coupon using the specified merchant code.
494
- # @param merchant_code The coupon merchant code to retrieve.
495
- # @param [Hash] opts the optional parameters
496
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
497
- # @return [Array<(CouponResponse, Fixnum, Hash)>] CouponResponse data, response status code and response headers
498
- def get_coupon_by_merchant_code_with_http_info(merchant_code, opts = {})
499
- if @api_client.config.debugging
500
- @api_client.config.logger.debug 'Calling API: CouponApi.get_coupon_by_merchant_code ...'
501
- end
502
- # verify the required parameter 'merchant_code' is set
503
- if @api_client.config.client_side_validation && merchant_code.nil?
504
- fail ArgumentError, "Missing the required parameter 'merchant_code' when calling CouponApi.get_coupon_by_merchant_code"
505
- end
506
- # resource path
507
- local_var_path = '/coupon/coupons/merchant_code/{merchant_code}'.sub('{' + 'merchant_code' + '}', merchant_code.to_s)
508
-
509
- # query parameters
510
- query_params = {}
511
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
512
-
513
- # header parameters
514
- header_params = {}
515
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
516
- # HTTP header 'Accept' (if needed)
517
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
518
- # HTTP header 'Content-Type'
519
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
520
-
521
- # form parameters
522
- form_params = {}
523
-
524
- # http body (model)
525
- post_body = nil
526
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
527
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
528
- :header_params => header_params,
529
- :query_params => query_params,
530
- :form_params => form_params,
531
- :body => post_body,
532
- :auth_names => auth_names,
533
- :return_type => 'CouponResponse')
534
- if @api_client.config.debugging
535
- @api_client.config.logger.debug "API called: CouponApi#get_coupon_by_merchant_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
536
- end
537
- return data, status_code, headers
538
- end
539
- # Retrieve coupons
540
- # Retrieves coupons for this account. If no parameters are specified, all coupons will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
541
- # @param [Hash] opts the optional parameters
542
- # @option opts [String] :merchant_code Merchant code
543
- # @option opts [String] :description Description
544
- # @option opts [String] :coupon_type Coupon type
545
- # @option opts [String] :start_date_begin Start date begin
546
- # @option opts [String] :start_date_end Start date end
547
- # @option opts [String] :expiration_date_begin Expiration date begin
548
- # @option opts [String] :expiration_date_end Expiration date end
549
- # @option opts [Integer] :affiliate_oid Affiliate oid
550
- # @option opts [BOOLEAN] :exclude_expired Exclude expired
551
- # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Max 200) (default to 100)
552
- # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
553
- # @option opts [String] :_sort The sort order of the coupons. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
554
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
555
- # @return [CouponsResponse]
556
- def get_coupons(opts = {})
557
- data, _status_code, _headers = get_coupons_with_http_info(opts)
558
- data
559
- end
560
-
561
- # Retrieve coupons
562
- # Retrieves coupons for this account. If no parameters are specified, all coupons will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
563
- # @param [Hash] opts the optional parameters
564
- # @option opts [String] :merchant_code Merchant code
565
- # @option opts [String] :description Description
566
- # @option opts [String] :coupon_type Coupon type
567
- # @option opts [String] :start_date_begin Start date begin
568
- # @option opts [String] :start_date_end Start date end
569
- # @option opts [String] :expiration_date_begin Expiration date begin
570
- # @option opts [String] :expiration_date_end Expiration date end
571
- # @option opts [Integer] :affiliate_oid Affiliate oid
572
- # @option opts [BOOLEAN] :exclude_expired Exclude expired
573
- # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Max 200)
574
- # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index.
575
- # @option opts [String] :_sort The sort order of the coupons. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
576
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
577
- # @return [Array<(CouponsResponse, Fixnum, Hash)>] CouponsResponse data, response status code and response headers
578
- def get_coupons_with_http_info(opts = {})
579
- if @api_client.config.debugging
580
- @api_client.config.logger.debug 'Calling API: CouponApi.get_coupons ...'
581
- end
582
- # resource path
583
- local_var_path = '/coupon/coupons'
584
-
585
- # query parameters
586
- query_params = {}
587
- query_params[:'merchant_code'] = opts[:'merchant_code'] if !opts[:'merchant_code'].nil?
588
- query_params[:'description'] = opts[:'description'] if !opts[:'description'].nil?
589
- query_params[:'coupon_type'] = opts[:'coupon_type'] if !opts[:'coupon_type'].nil?
590
- query_params[:'start_date_begin'] = opts[:'start_date_begin'] if !opts[:'start_date_begin'].nil?
591
- query_params[:'start_date_end'] = opts[:'start_date_end'] if !opts[:'start_date_end'].nil?
592
- query_params[:'expiration_date_begin'] = opts[:'expiration_date_begin'] if !opts[:'expiration_date_begin'].nil?
593
- query_params[:'expiration_date_end'] = opts[:'expiration_date_end'] if !opts[:'expiration_date_end'].nil?
594
- query_params[:'affiliate_oid'] = opts[:'affiliate_oid'] if !opts[:'affiliate_oid'].nil?
595
- query_params[:'exclude_expired'] = opts[:'exclude_expired'] if !opts[:'exclude_expired'].nil?
596
- query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
597
- query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
598
- query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
599
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
600
-
601
- # header parameters
602
- header_params = {}
603
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
604
- # HTTP header 'Accept' (if needed)
605
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
606
- # HTTP header 'Content-Type'
607
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
608
-
609
- # form parameters
610
- form_params = {}
611
-
612
- # http body (model)
613
- post_body = nil
614
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
615
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
616
- :header_params => header_params,
617
- :query_params => query_params,
618
- :form_params => form_params,
619
- :body => post_body,
620
- :auth_names => auth_names,
621
- :return_type => 'CouponsResponse')
622
- if @api_client.config.debugging
623
- @api_client.config.logger.debug "API called: CouponApi#get_coupons\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
624
- end
625
- return data, status_code, headers
626
- end
627
- # Retrieve coupons by query
628
- # Retrieves coupons from the account. If no parameters are specified, all coupons will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
629
- # @param coupon_query Coupon query
630
- # @param [Hash] opts the optional parameters
631
- # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Max 200) (default to 100)
632
- # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
633
- # @option opts [String] :_sort The sort order of the coupons. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
634
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
635
- # @return [CouponsResponse]
636
- def get_coupons_by_query(coupon_query, opts = {})
637
- data, _status_code, _headers = get_coupons_by_query_with_http_info(coupon_query, opts)
638
- data
639
- end
640
-
641
- # Retrieve coupons by query
642
- # Retrieves coupons from the account. If no parameters are specified, all coupons will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
643
- # @param coupon_query Coupon query
644
- # @param [Hash] opts the optional parameters
645
- # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Max 200)
646
- # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index.
647
- # @option opts [String] :_sort The sort order of the coupons. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
648
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
649
- # @return [Array<(CouponsResponse, Fixnum, Hash)>] CouponsResponse data, response status code and response headers
650
- def get_coupons_by_query_with_http_info(coupon_query, opts = {})
651
- if @api_client.config.debugging
652
- @api_client.config.logger.debug 'Calling API: CouponApi.get_coupons_by_query ...'
653
- end
654
- # verify the required parameter 'coupon_query' is set
655
- if @api_client.config.client_side_validation && coupon_query.nil?
656
- fail ArgumentError, "Missing the required parameter 'coupon_query' when calling CouponApi.get_coupons_by_query"
657
- end
658
- # resource path
659
- local_var_path = '/coupon/coupons/query'
660
-
661
- # query parameters
662
- query_params = {}
663
- query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
664
- query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
665
- query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
666
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
667
-
668
- # header parameters
669
- header_params = {}
670
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
671
- # HTTP header 'Accept' (if needed)
672
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
673
- # HTTP header 'Content-Type'
674
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
675
-
676
- # form parameters
677
- form_params = {}
678
-
679
- # http body (model)
680
- post_body = @api_client.object_to_http_body(coupon_query)
681
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
682
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
683
- :header_params => header_params,
684
- :query_params => query_params,
685
- :form_params => form_params,
686
- :body => post_body,
687
- :auth_names => auth_names,
688
- :return_type => 'CouponsResponse')
689
- if @api_client.config.debugging
690
- @api_client.config.logger.debug "API called: CouponApi#get_coupons_by_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
691
- end
692
- return data, status_code, headers
693
- end
694
- # Retrieve values needed for a coupon editor
695
- # Retrieve values needed for a coupon editor
696
- # @param [Hash] opts the optional parameters
697
- # @return [CouponEditorValues]
698
- def get_editor_values(opts = {})
699
- data, _status_code, _headers = get_editor_values_with_http_info(opts)
700
- data
701
- end
702
-
703
- # Retrieve values needed for a coupon editor
704
- # Retrieve values needed for a coupon editor
705
- # @param [Hash] opts the optional parameters
706
- # @return [Array<(CouponEditorValues, Fixnum, Hash)>] CouponEditorValues data, response status code and response headers
707
- def get_editor_values_with_http_info(opts = {})
708
- if @api_client.config.debugging
709
- @api_client.config.logger.debug 'Calling API: CouponApi.get_editor_values ...'
710
- end
711
- # resource path
712
- local_var_path = '/coupon/editor_values'
713
-
714
- # query parameters
715
- query_params = {}
716
-
717
- # header parameters
718
- header_params = {}
719
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
720
- # HTTP header 'Accept' (if needed)
721
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
722
- # HTTP header 'Content-Type'
723
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
724
-
725
- # form parameters
726
- form_params = {}
727
-
728
- # http body (model)
729
- post_body = nil
730
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
731
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
732
- :header_params => header_params,
733
- :query_params => query_params,
734
- :form_params => form_params,
735
- :body => post_body,
736
- :auth_names => auth_names,
737
- :return_type => 'CouponEditorValues')
738
- if @api_client.config.debugging
739
- @api_client.config.logger.debug "API called: CouponApi#get_editor_values\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
740
- end
741
- return data, status_code, headers
742
- end
743
- # Insert a coupon
744
- # Insert a coupon on the UltraCart account.
745
- # @param coupon Coupon to insert
746
- # @param [Hash] opts the optional parameters
747
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
748
- # @return [CouponResponse]
749
- def insert_coupon(coupon, opts = {})
750
- data, _status_code, _headers = insert_coupon_with_http_info(coupon, opts)
751
- data
752
- end
753
-
754
- # Insert a coupon
755
- # Insert a coupon on the UltraCart account.
756
- # @param coupon Coupon to insert
757
- # @param [Hash] opts the optional parameters
758
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
759
- # @return [Array<(CouponResponse, Fixnum, Hash)>] CouponResponse data, response status code and response headers
760
- def insert_coupon_with_http_info(coupon, opts = {})
761
- if @api_client.config.debugging
762
- @api_client.config.logger.debug 'Calling API: CouponApi.insert_coupon ...'
763
- end
764
- # verify the required parameter 'coupon' is set
765
- if @api_client.config.client_side_validation && coupon.nil?
766
- fail ArgumentError, "Missing the required parameter 'coupon' when calling CouponApi.insert_coupon"
767
- end
768
- # resource path
769
- local_var_path = '/coupon/coupons'
770
-
771
- # query parameters
772
- query_params = {}
773
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
774
-
775
- # header parameters
776
- header_params = {}
777
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
778
- # HTTP header 'Accept' (if needed)
779
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
780
- # HTTP header 'Content-Type'
781
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
782
-
783
- # form parameters
784
- form_params = {}
785
-
786
- # http body (model)
787
- post_body = @api_client.object_to_http_body(coupon)
788
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
789
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
790
- :header_params => header_params,
791
- :query_params => query_params,
792
- :form_params => form_params,
793
- :body => post_body,
794
- :auth_names => auth_names,
795
- :return_type => 'CouponResponse')
796
- if @api_client.config.debugging
797
- @api_client.config.logger.debug "API called: CouponApi#insert_coupon\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
798
- end
799
- return data, status_code, headers
800
- end
801
- # Insert multiple coupons
802
- # Insert multiple coupon on the UltraCart account.
803
- # @param coupons_request Coupons to insert (maximum 50)
804
- # @param [Hash] opts the optional parameters
805
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
806
- # @option opts [BOOLEAN] :_placeholders Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
807
- # @return [CouponsResponse]
808
- def insert_coupons(coupons_request, opts = {})
809
- data, _status_code, _headers = insert_coupons_with_http_info(coupons_request, opts)
810
- data
811
- end
812
-
813
- # Insert multiple coupons
814
- # Insert multiple coupon on the UltraCart account.
815
- # @param coupons_request Coupons to insert (maximum 50)
816
- # @param [Hash] opts the optional parameters
817
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
818
- # @option opts [BOOLEAN] :_placeholders Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
819
- # @return [Array<(CouponsResponse, Fixnum, Hash)>] CouponsResponse data, response status code and response headers
820
- def insert_coupons_with_http_info(coupons_request, opts = {})
821
- if @api_client.config.debugging
822
- @api_client.config.logger.debug 'Calling API: CouponApi.insert_coupons ...'
823
- end
824
- # verify the required parameter 'coupons_request' is set
825
- if @api_client.config.client_side_validation && coupons_request.nil?
826
- fail ArgumentError, "Missing the required parameter 'coupons_request' when calling CouponApi.insert_coupons"
827
- end
828
- # resource path
829
- local_var_path = '/coupon/coupons/batch'
830
-
831
- # query parameters
832
- query_params = {}
833
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
834
- query_params[:'_placeholders'] = opts[:'_placeholders'] if !opts[:'_placeholders'].nil?
835
-
836
- # header parameters
837
- header_params = {}
838
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
839
- # HTTP header 'Accept' (if needed)
840
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
841
- # HTTP header 'Content-Type'
842
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
843
-
844
- # form parameters
845
- form_params = {}
846
-
847
- # http body (model)
848
- post_body = @api_client.object_to_http_body(coupons_request)
849
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
850
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
851
- :header_params => header_params,
852
- :query_params => query_params,
853
- :form_params => form_params,
854
- :body => post_body,
855
- :auth_names => auth_names,
856
- :return_type => 'CouponsResponse')
857
- if @api_client.config.debugging
858
- @api_client.config.logger.debug "API called: CouponApi#insert_coupons\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
859
- end
860
- return data, status_code, headers
861
- end
862
- # Searches for items to display within a coupon editor and assign to coupons
863
- # Searches for items to display within a coupon editor and assign to coupons
864
- # @param [Hash] opts the optional parameters
865
- # @option opts [String] :s
866
- # @option opts [Integer] :m
867
- # @return [CouponItemSearchResultsResponse]
868
- def search_items(opts = {})
869
- data, _status_code, _headers = search_items_with_http_info(opts)
870
- data
871
- end
872
-
873
- # Searches for items to display within a coupon editor and assign to coupons
874
- # Searches for items to display within a coupon editor and assign to coupons
875
- # @param [Hash] opts the optional parameters
876
- # @option opts [String] :s
877
- # @option opts [Integer] :m
878
- # @return [Array<(CouponItemSearchResultsResponse, Fixnum, Hash)>] CouponItemSearchResultsResponse data, response status code and response headers
879
- def search_items_with_http_info(opts = {})
880
- if @api_client.config.debugging
881
- @api_client.config.logger.debug 'Calling API: CouponApi.search_items ...'
882
- end
883
- # resource path
884
- local_var_path = '/coupon/searchItems'
885
-
886
- # query parameters
887
- query_params = {}
888
- query_params[:'s'] = opts[:'s'] if !opts[:'s'].nil?
889
- query_params[:'m'] = opts[:'m'] if !opts[:'m'].nil?
890
-
891
- # header parameters
892
- header_params = {}
893
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
894
- # HTTP header 'Accept' (if needed)
895
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
896
- # HTTP header 'Content-Type'
897
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
898
-
899
- # form parameters
900
- form_params = {}
901
-
902
- # http body (model)
903
- post_body = nil
904
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
905
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
906
- :header_params => header_params,
907
- :query_params => query_params,
908
- :form_params => form_params,
909
- :body => post_body,
910
- :auth_names => auth_names,
911
- :return_type => 'CouponItemSearchResultsResponse')
912
- if @api_client.config.debugging
913
- @api_client.config.logger.debug "API called: CouponApi#search_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
914
- end
915
- return data, status_code, headers
916
- end
917
- # Update auto apply rules and conditions
918
- # Update auto apply rules and conditions
919
- # @param conditions Conditions
920
- # @param [Hash] opts the optional parameters
921
- # @return [nil]
922
- def update_auto_apply(conditions, opts = {})
923
- update_auto_apply_with_http_info(conditions, opts)
924
- nil
925
- end
926
-
927
- # Update auto apply rules and conditions
928
- # Update auto apply rules and conditions
929
- # @param conditions Conditions
930
- # @param [Hash] opts the optional parameters
931
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
932
- def update_auto_apply_with_http_info(conditions, opts = {})
933
- if @api_client.config.debugging
934
- @api_client.config.logger.debug 'Calling API: CouponApi.update_auto_apply ...'
935
- end
936
- # verify the required parameter 'conditions' is set
937
- if @api_client.config.client_side_validation && conditions.nil?
938
- fail ArgumentError, "Missing the required parameter 'conditions' when calling CouponApi.update_auto_apply"
939
- end
940
- # resource path
941
- local_var_path = '/coupon/auto_apply'
942
-
943
- # query parameters
944
- query_params = {}
945
-
946
- # header parameters
947
- header_params = {}
948
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
949
- # HTTP header 'Accept' (if needed)
950
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
951
- # HTTP header 'Content-Type'
952
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
953
-
954
- # form parameters
955
- form_params = {}
956
-
957
- # http body (model)
958
- post_body = @api_client.object_to_http_body(conditions)
959
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
960
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
961
- :header_params => header_params,
962
- :query_params => query_params,
963
- :form_params => form_params,
964
- :body => post_body,
965
- :auth_names => auth_names)
966
- if @api_client.config.debugging
967
- @api_client.config.logger.debug "API called: CouponApi#update_auto_apply\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
968
- end
969
- return data, status_code, headers
970
- end
971
- # Update a coupon
972
- # Update a coupon on the UltraCart account.
973
- # @param coupon Coupon to update
974
- # @param coupon_oid The coupon_oid to update.
975
- # @param [Hash] opts the optional parameters
976
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
977
- # @return [CouponResponse]
978
- def update_coupon(coupon, coupon_oid, opts = {})
979
- data, _status_code, _headers = update_coupon_with_http_info(coupon, coupon_oid, opts)
980
- data
981
- end
982
-
983
- # Update a coupon
984
- # Update a coupon on the UltraCart account.
985
- # @param coupon Coupon to update
986
- # @param coupon_oid The coupon_oid to update.
987
- # @param [Hash] opts the optional parameters
988
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
989
- # @return [Array<(CouponResponse, Fixnum, Hash)>] CouponResponse data, response status code and response headers
990
- def update_coupon_with_http_info(coupon, coupon_oid, opts = {})
991
- if @api_client.config.debugging
992
- @api_client.config.logger.debug 'Calling API: CouponApi.update_coupon ...'
993
- end
994
- # verify the required parameter 'coupon' is set
995
- if @api_client.config.client_side_validation && coupon.nil?
996
- fail ArgumentError, "Missing the required parameter 'coupon' when calling CouponApi.update_coupon"
997
- end
998
- # verify the required parameter 'coupon_oid' is set
999
- if @api_client.config.client_side_validation && coupon_oid.nil?
1000
- fail ArgumentError, "Missing the required parameter 'coupon_oid' when calling CouponApi.update_coupon"
1001
- end
1002
- # resource path
1003
- local_var_path = '/coupon/coupons/{coupon_oid}'.sub('{' + 'coupon_oid' + '}', coupon_oid.to_s)
1004
-
1005
- # query parameters
1006
- query_params = {}
1007
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1008
-
1009
- # header parameters
1010
- header_params = {}
1011
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1012
- # HTTP header 'Accept' (if needed)
1013
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1014
- # HTTP header 'Content-Type'
1015
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1016
-
1017
- # form parameters
1018
- form_params = {}
1019
-
1020
- # http body (model)
1021
- post_body = @api_client.object_to_http_body(coupon)
1022
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1023
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1024
- :header_params => header_params,
1025
- :query_params => query_params,
1026
- :form_params => form_params,
1027
- :body => post_body,
1028
- :auth_names => auth_names,
1029
- :return_type => 'CouponResponse')
1030
- if @api_client.config.debugging
1031
- @api_client.config.logger.debug "API called: CouponApi#update_coupon\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1032
- end
1033
- return data, status_code, headers
1034
- end
1035
- # Update multiple coupons
1036
- # Update multiple coupon on the UltraCart account.
1037
- # @param coupons_request Coupons to update (synchronous maximum 50 / asynchronous maximum 100)
1038
- # @param [Hash] opts the optional parameters
1039
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1040
- # @option opts [BOOLEAN] :_placeholders Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
1041
- # @option opts [BOOLEAN] :_async True if the operation should be run async. No result returned
1042
- # @return [CouponsResponse]
1043
- def update_coupons(coupons_request, opts = {})
1044
- data, _status_code, _headers = update_coupons_with_http_info(coupons_request, opts)
1045
- data
1046
- end
1047
-
1048
- # Update multiple coupons
1049
- # Update multiple coupon on the UltraCart account.
1050
- # @param coupons_request Coupons to update (synchronous maximum 50 / asynchronous maximum 100)
1051
- # @param [Hash] opts the optional parameters
1052
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1053
- # @option opts [BOOLEAN] :_placeholders Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
1054
- # @option opts [BOOLEAN] :_async True if the operation should be run async. No result returned
1055
- # @return [Array<(CouponsResponse, Fixnum, Hash)>] CouponsResponse data, response status code and response headers
1056
- def update_coupons_with_http_info(coupons_request, opts = {})
1057
- if @api_client.config.debugging
1058
- @api_client.config.logger.debug 'Calling API: CouponApi.update_coupons ...'
1059
- end
1060
- # verify the required parameter 'coupons_request' is set
1061
- if @api_client.config.client_side_validation && coupons_request.nil?
1062
- fail ArgumentError, "Missing the required parameter 'coupons_request' when calling CouponApi.update_coupons"
1063
- end
1064
- # resource path
1065
- local_var_path = '/coupon/coupons/batch'
1066
-
1067
- # query parameters
1068
- query_params = {}
1069
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1070
- query_params[:'_placeholders'] = opts[:'_placeholders'] if !opts[:'_placeholders'].nil?
1071
- query_params[:'_async'] = opts[:'_async'] if !opts[:'_async'].nil?
1072
-
1073
- # header parameters
1074
- header_params = {}
1075
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1076
- # HTTP header 'Accept' (if needed)
1077
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1078
- # HTTP header 'Content-Type'
1079
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1080
-
1081
- # form parameters
1082
- form_params = {}
1083
-
1084
- # http body (model)
1085
- post_body = @api_client.object_to_http_body(coupons_request)
1086
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1087
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1088
- :header_params => header_params,
1089
- :query_params => query_params,
1090
- :form_params => form_params,
1091
- :body => post_body,
1092
- :auth_names => auth_names,
1093
- :return_type => 'CouponsResponse')
1094
- if @api_client.config.debugging
1095
- @api_client.config.logger.debug "API called: CouponApi#update_coupons\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1096
- end
1097
- return data, status_code, headers
1098
- end
1099
- # Upload one-time codes for a coupon
1100
- # Upload one-time codes for a coupon
1101
- # @param coupon_oid The coupon oid to associate with the provided one-time codes.
1102
- # @param upload_coupon_codes_request One-time coupon codes
1103
- # @param [Hash] opts the optional parameters
1104
- # @return [UploadCouponCodesResponse]
1105
- def upload_coupon_codes(coupon_oid, upload_coupon_codes_request, opts = {})
1106
- data, _status_code, _headers = upload_coupon_codes_with_http_info(coupon_oid, upload_coupon_codes_request, opts)
1107
- data
1108
- end
1109
-
1110
- # Upload one-time codes for a coupon
1111
- # Upload one-time codes for a coupon
1112
- # @param coupon_oid The coupon oid to associate with the provided one-time codes.
1113
- # @param upload_coupon_codes_request One-time coupon codes
1114
- # @param [Hash] opts the optional parameters
1115
- # @return [Array<(UploadCouponCodesResponse, Fixnum, Hash)>] UploadCouponCodesResponse data, response status code and response headers
1116
- def upload_coupon_codes_with_http_info(coupon_oid, upload_coupon_codes_request, opts = {})
1117
- if @api_client.config.debugging
1118
- @api_client.config.logger.debug 'Calling API: CouponApi.upload_coupon_codes ...'
1119
- end
1120
- # verify the required parameter 'coupon_oid' is set
1121
- if @api_client.config.client_side_validation && coupon_oid.nil?
1122
- fail ArgumentError, "Missing the required parameter 'coupon_oid' when calling CouponApi.upload_coupon_codes"
1123
- end
1124
- # verify the required parameter 'upload_coupon_codes_request' is set
1125
- if @api_client.config.client_side_validation && upload_coupon_codes_request.nil?
1126
- fail ArgumentError, "Missing the required parameter 'upload_coupon_codes_request' when calling CouponApi.upload_coupon_codes"
1127
- end
1128
- # resource path
1129
- local_var_path = '/coupon/coupons/{coupon_oid}/upload_codes'.sub('{' + 'coupon_oid' + '}', coupon_oid.to_s)
1130
-
1131
- # query parameters
1132
- query_params = {}
1133
-
1134
- # header parameters
1135
- header_params = {}
1136
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1137
- # HTTP header 'Accept' (if needed)
1138
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1139
- # HTTP header 'Content-Type'
1140
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1141
-
1142
- # form parameters
1143
- form_params = {}
1144
-
1145
- # http body (model)
1146
- post_body = @api_client.object_to_http_body(upload_coupon_codes_request)
1147
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1148
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1149
- :header_params => header_params,
1150
- :query_params => query_params,
1151
- :form_params => form_params,
1152
- :body => post_body,
1153
- :auth_names => auth_names,
1154
- :return_type => 'UploadCouponCodesResponse')
1155
- if @api_client.config.debugging
1156
- @api_client.config.logger.debug "API called: CouponApi#upload_coupon_codes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1157
- end
1158
- return data, status_code, headers
1159
- end
1160
- end
1161
- 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 CouponApi
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::CouponApi.new(api_client)
33
+ end
34
+
35
+ # Delete a coupon
36
+ # Delete a coupon on the UltraCart account.
37
+ # @param coupon_oid [Integer] The coupon_oid to delete.
38
+ # @param [Hash] opts the optional parameters
39
+ # @return [nil]
40
+ def delete_coupon(coupon_oid, opts = {})
41
+ delete_coupon_with_http_info(coupon_oid, opts)
42
+ nil
43
+ end
44
+
45
+ # Delete a coupon
46
+ # Delete a coupon on the UltraCart account.
47
+ # @param coupon_oid [Integer] The coupon_oid to delete.
48
+ # @param [Hash] opts the optional parameters
49
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
50
+ def delete_coupon_with_http_info(coupon_oid, opts = {})
51
+ if @api_client.config.debugging
52
+ @api_client.config.logger.debug 'Calling API: CouponApi.delete_coupon ...'
53
+ end
54
+ # verify the required parameter 'coupon_oid' is set
55
+ if @api_client.config.client_side_validation && coupon_oid.nil?
56
+ fail ArgumentError, "Missing the required parameter 'coupon_oid' when calling CouponApi.delete_coupon"
57
+ end
58
+ # resource path
59
+ local_var_path = '/coupon/coupons/{coupon_oid}'.sub('{' + 'coupon_oid' + '}', CGI.escape(coupon_oid.to_s))
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
+
70
+ # form parameters
71
+ form_params = opts[:form_params] || {}
72
+
73
+ # http body (model)
74
+ post_body = opts[:debug_body]
75
+
76
+ # return_type
77
+ return_type = opts[:debug_return_type]
78
+
79
+ # auth_names
80
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
81
+
82
+ new_options = opts.merge(
83
+ :operation => :"CouponApi.delete_coupon",
84
+ :header_params => header_params,
85
+ :query_params => query_params,
86
+ :form_params => form_params,
87
+ :body => post_body,
88
+ :auth_names => auth_names,
89
+ :return_type => return_type
90
+ )
91
+
92
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
93
+ if @api_client.config.debugging
94
+ @api_client.config.logger.debug "API called: CouponApi#delete_coupon\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
95
+ end
96
+ return data, status_code, headers
97
+ end
98
+
99
+ # Deletes multiple coupons
100
+ # Delete coupons on the UltraCart account.
101
+ # @param coupon_delete_request [CouponDeletesRequest] Coupon oids to delete
102
+ # @param [Hash] opts the optional parameters
103
+ # @return [nil]
104
+ def delete_coupons_by_code(coupon_delete_request, opts = {})
105
+ delete_coupons_by_code_with_http_info(coupon_delete_request, opts)
106
+ nil
107
+ end
108
+
109
+ # Deletes multiple coupons
110
+ # Delete coupons on the UltraCart account.
111
+ # @param coupon_delete_request [CouponDeletesRequest] Coupon oids to delete
112
+ # @param [Hash] opts the optional parameters
113
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
114
+ def delete_coupons_by_code_with_http_info(coupon_delete_request, opts = {})
115
+ if @api_client.config.debugging
116
+ @api_client.config.logger.debug 'Calling API: CouponApi.delete_coupons_by_code ...'
117
+ end
118
+ # verify the required parameter 'coupon_delete_request' is set
119
+ if @api_client.config.client_side_validation && coupon_delete_request.nil?
120
+ fail ArgumentError, "Missing the required parameter 'coupon_delete_request' when calling CouponApi.delete_coupons_by_code"
121
+ end
122
+ # resource path
123
+ local_var_path = '/coupon/coupons/by_code'
124
+
125
+ # query parameters
126
+ query_params = opts[:query_params] || {}
127
+
128
+ # header parameters
129
+ header_params = opts[:header_params] || {}
130
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
131
+ # HTTP header 'Accept' (if needed)
132
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
133
+ # HTTP header 'Content-Type'
134
+ content_type = @api_client.select_header_content_type(['application/json'])
135
+ if !content_type.nil?
136
+ header_params['Content-Type'] = content_type
137
+ end
138
+
139
+ # form parameters
140
+ form_params = opts[:form_params] || {}
141
+
142
+ # http body (model)
143
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(coupon_delete_request)
144
+
145
+ # return_type
146
+ return_type = opts[:debug_return_type]
147
+
148
+ # auth_names
149
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
150
+
151
+ new_options = opts.merge(
152
+ :operation => :"CouponApi.delete_coupons_by_code",
153
+ :header_params => header_params,
154
+ :query_params => query_params,
155
+ :form_params => form_params,
156
+ :body => post_body,
157
+ :auth_names => auth_names,
158
+ :return_type => return_type
159
+ )
160
+
161
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
162
+ if @api_client.config.debugging
163
+ @api_client.config.logger.debug "API called: CouponApi#delete_coupons_by_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
164
+ end
165
+ return data, status_code, headers
166
+ end
167
+
168
+ # Deletes multiple coupons
169
+ # Delete coupons on the UltraCart account.
170
+ # @param coupon_delete_request [CouponDeletesRequest] Coupon oids to delete
171
+ # @param [Hash] opts the optional parameters
172
+ # @return [nil]
173
+ def delete_coupons_by_oid(coupon_delete_request, opts = {})
174
+ delete_coupons_by_oid_with_http_info(coupon_delete_request, opts)
175
+ nil
176
+ end
177
+
178
+ # Deletes multiple coupons
179
+ # Delete coupons on the UltraCart account.
180
+ # @param coupon_delete_request [CouponDeletesRequest] Coupon oids to delete
181
+ # @param [Hash] opts the optional parameters
182
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
183
+ def delete_coupons_by_oid_with_http_info(coupon_delete_request, opts = {})
184
+ if @api_client.config.debugging
185
+ @api_client.config.logger.debug 'Calling API: CouponApi.delete_coupons_by_oid ...'
186
+ end
187
+ # verify the required parameter 'coupon_delete_request' is set
188
+ if @api_client.config.client_side_validation && coupon_delete_request.nil?
189
+ fail ArgumentError, "Missing the required parameter 'coupon_delete_request' when calling CouponApi.delete_coupons_by_oid"
190
+ end
191
+ # resource path
192
+ local_var_path = '/coupon/coupons/by_oid'
193
+
194
+ # query parameters
195
+ query_params = opts[:query_params] || {}
196
+
197
+ # header parameters
198
+ header_params = opts[:header_params] || {}
199
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
200
+ # HTTP header 'Accept' (if needed)
201
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
202
+ # HTTP header 'Content-Type'
203
+ content_type = @api_client.select_header_content_type(['application/json'])
204
+ if !content_type.nil?
205
+ header_params['Content-Type'] = content_type
206
+ end
207
+
208
+ # form parameters
209
+ form_params = opts[:form_params] || {}
210
+
211
+ # http body (model)
212
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(coupon_delete_request)
213
+
214
+ # return_type
215
+ return_type = opts[:debug_return_type]
216
+
217
+ # auth_names
218
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
219
+
220
+ new_options = opts.merge(
221
+ :operation => :"CouponApi.delete_coupons_by_oid",
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(:DELETE, local_var_path, new_options)
231
+ if @api_client.config.debugging
232
+ @api_client.config.logger.debug "API called: CouponApi#delete_coupons_by_oid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
233
+ end
234
+ return data, status_code, headers
235
+ end
236
+
237
+ # Determines if a coupon merchant code already exists
238
+ # Determines if a coupon merchant code already exists.
239
+ # @param merchant_code [String] The coupon merchant code to examine.
240
+ # @param [Hash] opts the optional parameters
241
+ # @return [CouponExistsResponse]
242
+ def does_coupon_code_exist(merchant_code, opts = {})
243
+ data, _status_code, _headers = does_coupon_code_exist_with_http_info(merchant_code, opts)
244
+ data
245
+ end
246
+
247
+ # Determines if a coupon merchant code already exists
248
+ # Determines if a coupon merchant code already exists.
249
+ # @param merchant_code [String] The coupon merchant code to examine.
250
+ # @param [Hash] opts the optional parameters
251
+ # @return [Array<(CouponExistsResponse, Integer, Hash)>] CouponExistsResponse data, response status code and response headers
252
+ def does_coupon_code_exist_with_http_info(merchant_code, opts = {})
253
+ if @api_client.config.debugging
254
+ @api_client.config.logger.debug 'Calling API: CouponApi.does_coupon_code_exist ...'
255
+ end
256
+ # verify the required parameter 'merchant_code' is set
257
+ if @api_client.config.client_side_validation && merchant_code.nil?
258
+ fail ArgumentError, "Missing the required parameter 'merchant_code' when calling CouponApi.does_coupon_code_exist"
259
+ end
260
+ # resource path
261
+ local_var_path = '/coupon/coupons/merchant_code/{merchant_code}/exists'.sub('{' + 'merchant_code' + '}', CGI.escape(merchant_code.to_s))
262
+
263
+ # query parameters
264
+ query_params = opts[:query_params] || {}
265
+
266
+ # header parameters
267
+ header_params = opts[:header_params] || {}
268
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
269
+ # HTTP header 'Accept' (if needed)
270
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
271
+
272
+ # form parameters
273
+ form_params = opts[:form_params] || {}
274
+
275
+ # http body (model)
276
+ post_body = opts[:debug_body]
277
+
278
+ # return_type
279
+ return_type = opts[:debug_return_type] || 'CouponExistsResponse'
280
+
281
+ # auth_names
282
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
283
+
284
+ new_options = opts.merge(
285
+ :operation => :"CouponApi.does_coupon_code_exist",
286
+ :header_params => header_params,
287
+ :query_params => query_params,
288
+ :form_params => form_params,
289
+ :body => post_body,
290
+ :auth_names => auth_names,
291
+ :return_type => return_type
292
+ )
293
+
294
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
295
+ if @api_client.config.debugging
296
+ @api_client.config.logger.debug "API called: CouponApi#does_coupon_code_exist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
297
+ end
298
+ return data, status_code, headers
299
+ end
300
+
301
+ # Generates one time codes for a coupon
302
+ # Generate one time codes for a coupon
303
+ # @param coupon_oid [Integer] The coupon oid to generate codes.
304
+ # @param coupon_codes_request [CouponCodesRequest] Coupon code generation parameters
305
+ # @param [Hash] opts the optional parameters
306
+ # @return [CouponCodesResponse]
307
+ def generate_coupon_codes(coupon_oid, coupon_codes_request, opts = {})
308
+ data, _status_code, _headers = generate_coupon_codes_with_http_info(coupon_oid, coupon_codes_request, opts)
309
+ data
310
+ end
311
+
312
+ # Generates one time codes for a coupon
313
+ # Generate one time codes for a coupon
314
+ # @param coupon_oid [Integer] The coupon oid to generate codes.
315
+ # @param coupon_codes_request [CouponCodesRequest] Coupon code generation parameters
316
+ # @param [Hash] opts the optional parameters
317
+ # @return [Array<(CouponCodesResponse, Integer, Hash)>] CouponCodesResponse data, response status code and response headers
318
+ def generate_coupon_codes_with_http_info(coupon_oid, coupon_codes_request, opts = {})
319
+ if @api_client.config.debugging
320
+ @api_client.config.logger.debug 'Calling API: CouponApi.generate_coupon_codes ...'
321
+ end
322
+ # verify the required parameter 'coupon_oid' is set
323
+ if @api_client.config.client_side_validation && coupon_oid.nil?
324
+ fail ArgumentError, "Missing the required parameter 'coupon_oid' when calling CouponApi.generate_coupon_codes"
325
+ end
326
+ # verify the required parameter 'coupon_codes_request' is set
327
+ if @api_client.config.client_side_validation && coupon_codes_request.nil?
328
+ fail ArgumentError, "Missing the required parameter 'coupon_codes_request' when calling CouponApi.generate_coupon_codes"
329
+ end
330
+ # resource path
331
+ local_var_path = '/coupon/coupons/{coupon_oid}/generate_codes'.sub('{' + 'coupon_oid' + '}', CGI.escape(coupon_oid.to_s))
332
+
333
+ # query parameters
334
+ query_params = opts[:query_params] || {}
335
+
336
+ # header parameters
337
+ header_params = opts[:header_params] || {}
338
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
339
+ # HTTP header 'Accept' (if needed)
340
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
341
+ # HTTP header 'Content-Type'
342
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
343
+ if !content_type.nil?
344
+ header_params['Content-Type'] = content_type
345
+ end
346
+
347
+ # form parameters
348
+ form_params = opts[:form_params] || {}
349
+
350
+ # http body (model)
351
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(coupon_codes_request)
352
+
353
+ # return_type
354
+ return_type = opts[:debug_return_type] || 'CouponCodesResponse'
355
+
356
+ # auth_names
357
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
358
+
359
+ new_options = opts.merge(
360
+ :operation => :"CouponApi.generate_coupon_codes",
361
+ :header_params => header_params,
362
+ :query_params => query_params,
363
+ :form_params => form_params,
364
+ :body => post_body,
365
+ :auth_names => auth_names,
366
+ :return_type => return_type
367
+ )
368
+
369
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
370
+ if @api_client.config.debugging
371
+ @api_client.config.logger.debug "API called: CouponApi#generate_coupon_codes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
372
+ end
373
+ return data, status_code, headers
374
+ end
375
+
376
+ # Generates one time codes by merchant code
377
+ # Generate one time codes by merchant code
378
+ # @param merchant_code [String] The merchant code to generate one time codes.
379
+ # @param coupon_codes_request [CouponCodesRequest] Coupon code generation parameters
380
+ # @param [Hash] opts the optional parameters
381
+ # @return [CouponCodesResponse]
382
+ def generate_one_time_codes_by_merchant_code(merchant_code, coupon_codes_request, opts = {})
383
+ data, _status_code, _headers = generate_one_time_codes_by_merchant_code_with_http_info(merchant_code, coupon_codes_request, opts)
384
+ data
385
+ end
386
+
387
+ # Generates one time codes by merchant code
388
+ # Generate one time codes by merchant code
389
+ # @param merchant_code [String] The merchant code to generate one time codes.
390
+ # @param coupon_codes_request [CouponCodesRequest] Coupon code generation parameters
391
+ # @param [Hash] opts the optional parameters
392
+ # @return [Array<(CouponCodesResponse, Integer, Hash)>] CouponCodesResponse data, response status code and response headers
393
+ def generate_one_time_codes_by_merchant_code_with_http_info(merchant_code, coupon_codes_request, opts = {})
394
+ if @api_client.config.debugging
395
+ @api_client.config.logger.debug 'Calling API: CouponApi.generate_one_time_codes_by_merchant_code ...'
396
+ end
397
+ # verify the required parameter 'merchant_code' is set
398
+ if @api_client.config.client_side_validation && merchant_code.nil?
399
+ fail ArgumentError, "Missing the required parameter 'merchant_code' when calling CouponApi.generate_one_time_codes_by_merchant_code"
400
+ end
401
+ # verify the required parameter 'coupon_codes_request' is set
402
+ if @api_client.config.client_side_validation && coupon_codes_request.nil?
403
+ fail ArgumentError, "Missing the required parameter 'coupon_codes_request' when calling CouponApi.generate_one_time_codes_by_merchant_code"
404
+ end
405
+ # resource path
406
+ local_var_path = '/coupon/coupons/merchant_code/{merchant_code}/generate_codes'.sub('{' + 'merchant_code' + '}', CGI.escape(merchant_code.to_s))
407
+
408
+ # query parameters
409
+ query_params = opts[:query_params] || {}
410
+
411
+ # header parameters
412
+ header_params = opts[:header_params] || {}
413
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
414
+ # HTTP header 'Accept' (if needed)
415
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
416
+ # HTTP header 'Content-Type'
417
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
418
+ if !content_type.nil?
419
+ header_params['Content-Type'] = content_type
420
+ end
421
+
422
+ # form parameters
423
+ form_params = opts[:form_params] || {}
424
+
425
+ # http body (model)
426
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(coupon_codes_request)
427
+
428
+ # return_type
429
+ return_type = opts[:debug_return_type] || 'CouponCodesResponse'
430
+
431
+ # auth_names
432
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
433
+
434
+ new_options = opts.merge(
435
+ :operation => :"CouponApi.generate_one_time_codes_by_merchant_code",
436
+ :header_params => header_params,
437
+ :query_params => query_params,
438
+ :form_params => form_params,
439
+ :body => post_body,
440
+ :auth_names => auth_names,
441
+ :return_type => return_type
442
+ )
443
+
444
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
445
+ if @api_client.config.debugging
446
+ @api_client.config.logger.debug "API called: CouponApi#generate_one_time_codes_by_merchant_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
447
+ end
448
+ return data, status_code, headers
449
+ end
450
+
451
+ # Retrieve auto apply rules and conditions
452
+ # Retrieve auto apply rules and conditions
453
+ # @param [Hash] opts the optional parameters
454
+ # @return [CouponAutoApplyConditions]
455
+ def get_auto_apply(opts = {})
456
+ data, _status_code, _headers = get_auto_apply_with_http_info(opts)
457
+ data
458
+ end
459
+
460
+ # Retrieve auto apply rules and conditions
461
+ # Retrieve auto apply rules and conditions
462
+ # @param [Hash] opts the optional parameters
463
+ # @return [Array<(CouponAutoApplyConditions, Integer, Hash)>] CouponAutoApplyConditions data, response status code and response headers
464
+ def get_auto_apply_with_http_info(opts = {})
465
+ if @api_client.config.debugging
466
+ @api_client.config.logger.debug 'Calling API: CouponApi.get_auto_apply ...'
467
+ end
468
+ # resource path
469
+ local_var_path = '/coupon/auto_apply'
470
+
471
+ # query parameters
472
+ query_params = opts[:query_params] || {}
473
+
474
+ # header parameters
475
+ header_params = opts[:header_params] || {}
476
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
477
+ # HTTP header 'Accept' (if needed)
478
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
479
+
480
+ # form parameters
481
+ form_params = opts[:form_params] || {}
482
+
483
+ # http body (model)
484
+ post_body = opts[:debug_body]
485
+
486
+ # return_type
487
+ return_type = opts[:debug_return_type] || 'CouponAutoApplyConditions'
488
+
489
+ # auth_names
490
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
491
+
492
+ new_options = opts.merge(
493
+ :operation => :"CouponApi.get_auto_apply",
494
+ :header_params => header_params,
495
+ :query_params => query_params,
496
+ :form_params => form_params,
497
+ :body => post_body,
498
+ :auth_names => auth_names,
499
+ :return_type => return_type
500
+ )
501
+
502
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
503
+ if @api_client.config.debugging
504
+ @api_client.config.logger.debug "API called: CouponApi#get_auto_apply\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
505
+ end
506
+ return data, status_code, headers
507
+ end
508
+
509
+ # Retrieve a coupon
510
+ # Retrieves a single coupon using the specified coupon profile oid.
511
+ # @param coupon_oid [Integer] The coupon oid to retrieve.
512
+ # @param [Hash] opts the optional parameters
513
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
514
+ # @return [CouponResponse]
515
+ def get_coupon(coupon_oid, opts = {})
516
+ data, _status_code, _headers = get_coupon_with_http_info(coupon_oid, opts)
517
+ data
518
+ end
519
+
520
+ # Retrieve a coupon
521
+ # Retrieves a single coupon using the specified coupon profile oid.
522
+ # @param coupon_oid [Integer] The coupon oid to retrieve.
523
+ # @param [Hash] opts the optional parameters
524
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
525
+ # @return [Array<(CouponResponse, Integer, Hash)>] CouponResponse data, response status code and response headers
526
+ def get_coupon_with_http_info(coupon_oid, opts = {})
527
+ if @api_client.config.debugging
528
+ @api_client.config.logger.debug 'Calling API: CouponApi.get_coupon ...'
529
+ end
530
+ # verify the required parameter 'coupon_oid' is set
531
+ if @api_client.config.client_side_validation && coupon_oid.nil?
532
+ fail ArgumentError, "Missing the required parameter 'coupon_oid' when calling CouponApi.get_coupon"
533
+ end
534
+ # resource path
535
+ local_var_path = '/coupon/coupons/{coupon_oid}'.sub('{' + 'coupon_oid' + '}', CGI.escape(coupon_oid.to_s))
536
+
537
+ # query parameters
538
+ query_params = opts[:query_params] || {}
539
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
540
+
541
+ # header parameters
542
+ header_params = opts[:header_params] || {}
543
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
544
+ # HTTP header 'Accept' (if needed)
545
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
546
+
547
+ # form parameters
548
+ form_params = opts[:form_params] || {}
549
+
550
+ # http body (model)
551
+ post_body = opts[:debug_body]
552
+
553
+ # return_type
554
+ return_type = opts[:debug_return_type] || 'CouponResponse'
555
+
556
+ # auth_names
557
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
558
+
559
+ new_options = opts.merge(
560
+ :operation => :"CouponApi.get_coupon",
561
+ :header_params => header_params,
562
+ :query_params => query_params,
563
+ :form_params => form_params,
564
+ :body => post_body,
565
+ :auth_names => auth_names,
566
+ :return_type => return_type
567
+ )
568
+
569
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
570
+ if @api_client.config.debugging
571
+ @api_client.config.logger.debug "API called: CouponApi#get_coupon\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
572
+ end
573
+ return data, status_code, headers
574
+ end
575
+
576
+ # Retrieve a coupon by merchant code
577
+ # Retrieves a single coupon using the specified merchant code.
578
+ # @param merchant_code [String] The coupon merchant code to retrieve.
579
+ # @param [Hash] opts the optional parameters
580
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
581
+ # @return [CouponResponse]
582
+ def get_coupon_by_merchant_code(merchant_code, opts = {})
583
+ data, _status_code, _headers = get_coupon_by_merchant_code_with_http_info(merchant_code, opts)
584
+ data
585
+ end
586
+
587
+ # Retrieve a coupon by merchant code
588
+ # Retrieves a single coupon using the specified merchant code.
589
+ # @param merchant_code [String] The coupon merchant code to retrieve.
590
+ # @param [Hash] opts the optional parameters
591
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
592
+ # @return [Array<(CouponResponse, Integer, Hash)>] CouponResponse data, response status code and response headers
593
+ def get_coupon_by_merchant_code_with_http_info(merchant_code, opts = {})
594
+ if @api_client.config.debugging
595
+ @api_client.config.logger.debug 'Calling API: CouponApi.get_coupon_by_merchant_code ...'
596
+ end
597
+ # verify the required parameter 'merchant_code' is set
598
+ if @api_client.config.client_side_validation && merchant_code.nil?
599
+ fail ArgumentError, "Missing the required parameter 'merchant_code' when calling CouponApi.get_coupon_by_merchant_code"
600
+ end
601
+ # resource path
602
+ local_var_path = '/coupon/coupons/merchant_code/{merchant_code}'.sub('{' + 'merchant_code' + '}', CGI.escape(merchant_code.to_s))
603
+
604
+ # query parameters
605
+ query_params = opts[:query_params] || {}
606
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
607
+
608
+ # header parameters
609
+ header_params = opts[:header_params] || {}
610
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
611
+ # HTTP header 'Accept' (if needed)
612
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
613
+
614
+ # form parameters
615
+ form_params = opts[:form_params] || {}
616
+
617
+ # http body (model)
618
+ post_body = opts[:debug_body]
619
+
620
+ # return_type
621
+ return_type = opts[:debug_return_type] || 'CouponResponse'
622
+
623
+ # auth_names
624
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
625
+
626
+ new_options = opts.merge(
627
+ :operation => :"CouponApi.get_coupon_by_merchant_code",
628
+ :header_params => header_params,
629
+ :query_params => query_params,
630
+ :form_params => form_params,
631
+ :body => post_body,
632
+ :auth_names => auth_names,
633
+ :return_type => return_type
634
+ )
635
+
636
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
637
+ if @api_client.config.debugging
638
+ @api_client.config.logger.debug "API called: CouponApi#get_coupon_by_merchant_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
639
+ end
640
+ return data, status_code, headers
641
+ end
642
+
643
+ # Retrieve coupons
644
+ # Retrieves coupons for this account. If no parameters are specified, all coupons will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
645
+ # @param [Hash] opts the optional parameters
646
+ # @option opts [String] :merchant_code Merchant code
647
+ # @option opts [String] :description Description
648
+ # @option opts [String] :coupon_type Coupon type
649
+ # @option opts [String] :start_date_begin Start date begin
650
+ # @option opts [String] :start_date_end Start date end
651
+ # @option opts [String] :expiration_date_begin Expiration date begin
652
+ # @option opts [String] :expiration_date_end Expiration date end
653
+ # @option opts [Integer] :affiliate_oid Affiliate oid
654
+ # @option opts [Boolean] :exclude_expired Exclude expired
655
+ # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Max 200) (default to 100)
656
+ # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
657
+ # @option opts [String] :_sort The sort order of the coupons. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
658
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
659
+ # @return [CouponsResponse]
660
+ def get_coupons(opts = {})
661
+ data, _status_code, _headers = get_coupons_with_http_info(opts)
662
+ data
663
+ end
664
+
665
+ # Retrieve coupons
666
+ # Retrieves coupons for this account. If no parameters are specified, all coupons will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
667
+ # @param [Hash] opts the optional parameters
668
+ # @option opts [String] :merchant_code Merchant code
669
+ # @option opts [String] :description Description
670
+ # @option opts [String] :coupon_type Coupon type
671
+ # @option opts [String] :start_date_begin Start date begin
672
+ # @option opts [String] :start_date_end Start date end
673
+ # @option opts [String] :expiration_date_begin Expiration date begin
674
+ # @option opts [String] :expiration_date_end Expiration date end
675
+ # @option opts [Integer] :affiliate_oid Affiliate oid
676
+ # @option opts [Boolean] :exclude_expired Exclude expired
677
+ # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Max 200) (default to 100)
678
+ # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
679
+ # @option opts [String] :_sort The sort order of the coupons. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
680
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
681
+ # @return [Array<(CouponsResponse, Integer, Hash)>] CouponsResponse data, response status code and response headers
682
+ def get_coupons_with_http_info(opts = {})
683
+ if @api_client.config.debugging
684
+ @api_client.config.logger.debug 'Calling API: CouponApi.get_coupons ...'
685
+ end
686
+ # resource path
687
+ local_var_path = '/coupon/coupons'
688
+
689
+ # query parameters
690
+ query_params = opts[:query_params] || {}
691
+ query_params[:'merchant_code'] = opts[:'merchant_code'] if !opts[:'merchant_code'].nil?
692
+ query_params[:'description'] = opts[:'description'] if !opts[:'description'].nil?
693
+ query_params[:'coupon_type'] = opts[:'coupon_type'] if !opts[:'coupon_type'].nil?
694
+ query_params[:'start_date_begin'] = opts[:'start_date_begin'] if !opts[:'start_date_begin'].nil?
695
+ query_params[:'start_date_end'] = opts[:'start_date_end'] if !opts[:'start_date_end'].nil?
696
+ query_params[:'expiration_date_begin'] = opts[:'expiration_date_begin'] if !opts[:'expiration_date_begin'].nil?
697
+ query_params[:'expiration_date_end'] = opts[:'expiration_date_end'] if !opts[:'expiration_date_end'].nil?
698
+ query_params[:'affiliate_oid'] = opts[:'affiliate_oid'] if !opts[:'affiliate_oid'].nil?
699
+ query_params[:'exclude_expired'] = opts[:'exclude_expired'] if !opts[:'exclude_expired'].nil?
700
+ query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
701
+ query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
702
+ query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
703
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
704
+
705
+ # header parameters
706
+ header_params = opts[:header_params] || {}
707
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
708
+ # HTTP header 'Accept' (if needed)
709
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
710
+
711
+ # form parameters
712
+ form_params = opts[:form_params] || {}
713
+
714
+ # http body (model)
715
+ post_body = opts[:debug_body]
716
+
717
+ # return_type
718
+ return_type = opts[:debug_return_type] || 'CouponsResponse'
719
+
720
+ # auth_names
721
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
722
+
723
+ new_options = opts.merge(
724
+ :operation => :"CouponApi.get_coupons",
725
+ :header_params => header_params,
726
+ :query_params => query_params,
727
+ :form_params => form_params,
728
+ :body => post_body,
729
+ :auth_names => auth_names,
730
+ :return_type => return_type
731
+ )
732
+
733
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
734
+ if @api_client.config.debugging
735
+ @api_client.config.logger.debug "API called: CouponApi#get_coupons\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
736
+ end
737
+ return data, status_code, headers
738
+ end
739
+
740
+ # Retrieve coupons by query
741
+ # Retrieves coupons from the account. If no parameters are specified, all coupons will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
742
+ # @param coupon_query [CouponQuery] Coupon query
743
+ # @param [Hash] opts the optional parameters
744
+ # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Max 200) (default to 100)
745
+ # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
746
+ # @option opts [String] :_sort The sort order of the coupons. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
747
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
748
+ # @return [CouponsResponse]
749
+ def get_coupons_by_query(coupon_query, opts = {})
750
+ data, _status_code, _headers = get_coupons_by_query_with_http_info(coupon_query, opts)
751
+ data
752
+ end
753
+
754
+ # Retrieve coupons by query
755
+ # Retrieves coupons from the account. If no parameters are specified, all coupons will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
756
+ # @param coupon_query [CouponQuery] Coupon query
757
+ # @param [Hash] opts the optional parameters
758
+ # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Max 200) (default to 100)
759
+ # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
760
+ # @option opts [String] :_sort The sort order of the coupons. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
761
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
762
+ # @return [Array<(CouponsResponse, Integer, Hash)>] CouponsResponse data, response status code and response headers
763
+ def get_coupons_by_query_with_http_info(coupon_query, opts = {})
764
+ if @api_client.config.debugging
765
+ @api_client.config.logger.debug 'Calling API: CouponApi.get_coupons_by_query ...'
766
+ end
767
+ # verify the required parameter 'coupon_query' is set
768
+ if @api_client.config.client_side_validation && coupon_query.nil?
769
+ fail ArgumentError, "Missing the required parameter 'coupon_query' when calling CouponApi.get_coupons_by_query"
770
+ end
771
+ # resource path
772
+ local_var_path = '/coupon/coupons/query'
773
+
774
+ # query parameters
775
+ query_params = opts[:query_params] || {}
776
+ query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
777
+ query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
778
+ query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
779
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
780
+
781
+ # header parameters
782
+ header_params = opts[:header_params] || {}
783
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
784
+ # HTTP header 'Accept' (if needed)
785
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
786
+ # HTTP header 'Content-Type'
787
+ content_type = @api_client.select_header_content_type(['application/json'])
788
+ if !content_type.nil?
789
+ header_params['Content-Type'] = content_type
790
+ end
791
+
792
+ # form parameters
793
+ form_params = opts[:form_params] || {}
794
+
795
+ # http body (model)
796
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(coupon_query)
797
+
798
+ # return_type
799
+ return_type = opts[:debug_return_type] || 'CouponsResponse'
800
+
801
+ # auth_names
802
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
803
+
804
+ new_options = opts.merge(
805
+ :operation => :"CouponApi.get_coupons_by_query",
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 => return_type
812
+ )
813
+
814
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
815
+ if @api_client.config.debugging
816
+ @api_client.config.logger.debug "API called: CouponApi#get_coupons_by_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
817
+ end
818
+ return data, status_code, headers
819
+ end
820
+
821
+ # Retrieve values needed for a coupon editor
822
+ # Retrieve values needed for a coupon editor
823
+ # @param [Hash] opts the optional parameters
824
+ # @return [CouponEditorValues]
825
+ def get_editor_values(opts = {})
826
+ data, _status_code, _headers = get_editor_values_with_http_info(opts)
827
+ data
828
+ end
829
+
830
+ # Retrieve values needed for a coupon editor
831
+ # Retrieve values needed for a coupon editor
832
+ # @param [Hash] opts the optional parameters
833
+ # @return [Array<(CouponEditorValues, Integer, Hash)>] CouponEditorValues data, response status code and response headers
834
+ def get_editor_values_with_http_info(opts = {})
835
+ if @api_client.config.debugging
836
+ @api_client.config.logger.debug 'Calling API: CouponApi.get_editor_values ...'
837
+ end
838
+ # resource path
839
+ local_var_path = '/coupon/editor_values'
840
+
841
+ # query parameters
842
+ query_params = opts[:query_params] || {}
843
+
844
+ # header parameters
845
+ header_params = opts[:header_params] || {}
846
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
847
+ # HTTP header 'Accept' (if needed)
848
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
849
+
850
+ # form parameters
851
+ form_params = opts[:form_params] || {}
852
+
853
+ # http body (model)
854
+ post_body = opts[:debug_body]
855
+
856
+ # return_type
857
+ return_type = opts[:debug_return_type] || 'CouponEditorValues'
858
+
859
+ # auth_names
860
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
861
+
862
+ new_options = opts.merge(
863
+ :operation => :"CouponApi.get_editor_values",
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 => return_type
870
+ )
871
+
872
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
873
+ if @api_client.config.debugging
874
+ @api_client.config.logger.debug "API called: CouponApi#get_editor_values\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
875
+ end
876
+ return data, status_code, headers
877
+ end
878
+
879
+ # Insert a coupon
880
+ # Insert a coupon on the UltraCart account.
881
+ # @param coupon [Coupon] Coupon to insert
882
+ # @param [Hash] opts the optional parameters
883
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
884
+ # @return [CouponResponse]
885
+ def insert_coupon(coupon, opts = {})
886
+ data, _status_code, _headers = insert_coupon_with_http_info(coupon, opts)
887
+ data
888
+ end
889
+
890
+ # Insert a coupon
891
+ # Insert a coupon on the UltraCart account.
892
+ # @param coupon [Coupon] Coupon to insert
893
+ # @param [Hash] opts the optional parameters
894
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
895
+ # @return [Array<(CouponResponse, Integer, Hash)>] CouponResponse data, response status code and response headers
896
+ def insert_coupon_with_http_info(coupon, opts = {})
897
+ if @api_client.config.debugging
898
+ @api_client.config.logger.debug 'Calling API: CouponApi.insert_coupon ...'
899
+ end
900
+ # verify the required parameter 'coupon' is set
901
+ if @api_client.config.client_side_validation && coupon.nil?
902
+ fail ArgumentError, "Missing the required parameter 'coupon' when calling CouponApi.insert_coupon"
903
+ end
904
+ # resource path
905
+ local_var_path = '/coupon/coupons'
906
+
907
+ # query parameters
908
+ query_params = opts[:query_params] || {}
909
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
910
+
911
+ # header parameters
912
+ header_params = opts[:header_params] || {}
913
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
914
+ # HTTP header 'Accept' (if needed)
915
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
916
+ # HTTP header 'Content-Type'
917
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
918
+ if !content_type.nil?
919
+ header_params['Content-Type'] = content_type
920
+ end
921
+
922
+ # form parameters
923
+ form_params = opts[:form_params] || {}
924
+
925
+ # http body (model)
926
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(coupon)
927
+
928
+ # return_type
929
+ return_type = opts[:debug_return_type] || 'CouponResponse'
930
+
931
+ # auth_names
932
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
933
+
934
+ new_options = opts.merge(
935
+ :operation => :"CouponApi.insert_coupon",
936
+ :header_params => header_params,
937
+ :query_params => query_params,
938
+ :form_params => form_params,
939
+ :body => post_body,
940
+ :auth_names => auth_names,
941
+ :return_type => return_type
942
+ )
943
+
944
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
945
+ if @api_client.config.debugging
946
+ @api_client.config.logger.debug "API called: CouponApi#insert_coupon\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
947
+ end
948
+ return data, status_code, headers
949
+ end
950
+
951
+ # Insert multiple coupons
952
+ # Insert multiple coupon on the UltraCart account.
953
+ # @param coupons_request [CouponsRequest] Coupons to insert (maximum 50)
954
+ # @param [Hash] opts the optional parameters
955
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
956
+ # @option opts [Boolean] :_placeholders Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
957
+ # @return [CouponsResponse]
958
+ def insert_coupons(coupons_request, opts = {})
959
+ data, _status_code, _headers = insert_coupons_with_http_info(coupons_request, opts)
960
+ data
961
+ end
962
+
963
+ # Insert multiple coupons
964
+ # Insert multiple coupon on the UltraCart account.
965
+ # @param coupons_request [CouponsRequest] Coupons to insert (maximum 50)
966
+ # @param [Hash] opts the optional parameters
967
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
968
+ # @option opts [Boolean] :_placeholders Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
969
+ # @return [Array<(CouponsResponse, Integer, Hash)>] CouponsResponse data, response status code and response headers
970
+ def insert_coupons_with_http_info(coupons_request, opts = {})
971
+ if @api_client.config.debugging
972
+ @api_client.config.logger.debug 'Calling API: CouponApi.insert_coupons ...'
973
+ end
974
+ # verify the required parameter 'coupons_request' is set
975
+ if @api_client.config.client_side_validation && coupons_request.nil?
976
+ fail ArgumentError, "Missing the required parameter 'coupons_request' when calling CouponApi.insert_coupons"
977
+ end
978
+ # resource path
979
+ local_var_path = '/coupon/coupons/batch'
980
+
981
+ # query parameters
982
+ query_params = opts[:query_params] || {}
983
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
984
+ query_params[:'_placeholders'] = opts[:'_placeholders'] if !opts[:'_placeholders'].nil?
985
+
986
+ # header parameters
987
+ header_params = opts[:header_params] || {}
988
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
989
+ # HTTP header 'Accept' (if needed)
990
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
991
+ # HTTP header 'Content-Type'
992
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
993
+ if !content_type.nil?
994
+ header_params['Content-Type'] = content_type
995
+ end
996
+
997
+ # form parameters
998
+ form_params = opts[:form_params] || {}
999
+
1000
+ # http body (model)
1001
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(coupons_request)
1002
+
1003
+ # return_type
1004
+ return_type = opts[:debug_return_type] || 'CouponsResponse'
1005
+
1006
+ # auth_names
1007
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1008
+
1009
+ new_options = opts.merge(
1010
+ :operation => :"CouponApi.insert_coupons",
1011
+ :header_params => header_params,
1012
+ :query_params => query_params,
1013
+ :form_params => form_params,
1014
+ :body => post_body,
1015
+ :auth_names => auth_names,
1016
+ :return_type => return_type
1017
+ )
1018
+
1019
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1020
+ if @api_client.config.debugging
1021
+ @api_client.config.logger.debug "API called: CouponApi#insert_coupons\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1022
+ end
1023
+ return data, status_code, headers
1024
+ end
1025
+
1026
+ # Searches for items to display within a coupon editor and assign to coupons
1027
+ # Searches for items to display within a coupon editor and assign to coupons
1028
+ # @param [Hash] opts the optional parameters
1029
+ # @option opts [String] :s
1030
+ # @option opts [Integer] :m
1031
+ # @return [CouponItemSearchResultsResponse]
1032
+ def search_items(opts = {})
1033
+ data, _status_code, _headers = search_items_with_http_info(opts)
1034
+ data
1035
+ end
1036
+
1037
+ # Searches for items to display within a coupon editor and assign to coupons
1038
+ # Searches for items to display within a coupon editor and assign to coupons
1039
+ # @param [Hash] opts the optional parameters
1040
+ # @option opts [String] :s
1041
+ # @option opts [Integer] :m
1042
+ # @return [Array<(CouponItemSearchResultsResponse, Integer, Hash)>] CouponItemSearchResultsResponse data, response status code and response headers
1043
+ def search_items_with_http_info(opts = {})
1044
+ if @api_client.config.debugging
1045
+ @api_client.config.logger.debug 'Calling API: CouponApi.search_items ...'
1046
+ end
1047
+ # resource path
1048
+ local_var_path = '/coupon/searchItems'
1049
+
1050
+ # query parameters
1051
+ query_params = opts[:query_params] || {}
1052
+ query_params[:'s'] = opts[:'s'] if !opts[:'s'].nil?
1053
+ query_params[:'m'] = opts[:'m'] if !opts[:'m'].nil?
1054
+
1055
+ # header parameters
1056
+ header_params = opts[:header_params] || {}
1057
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1058
+ # HTTP header 'Accept' (if needed)
1059
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1060
+
1061
+ # form parameters
1062
+ form_params = opts[:form_params] || {}
1063
+
1064
+ # http body (model)
1065
+ post_body = opts[:debug_body]
1066
+
1067
+ # return_type
1068
+ return_type = opts[:debug_return_type] || 'CouponItemSearchResultsResponse'
1069
+
1070
+ # auth_names
1071
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1072
+
1073
+ new_options = opts.merge(
1074
+ :operation => :"CouponApi.search_items",
1075
+ :header_params => header_params,
1076
+ :query_params => query_params,
1077
+ :form_params => form_params,
1078
+ :body => post_body,
1079
+ :auth_names => auth_names,
1080
+ :return_type => return_type
1081
+ )
1082
+
1083
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1084
+ if @api_client.config.debugging
1085
+ @api_client.config.logger.debug "API called: CouponApi#search_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1086
+ end
1087
+ return data, status_code, headers
1088
+ end
1089
+
1090
+ # Update auto apply rules and conditions
1091
+ # Update auto apply rules and conditions
1092
+ # @param conditions [CouponAutoApplyConditions] Conditions
1093
+ # @param [Hash] opts the optional parameters
1094
+ # @return [nil]
1095
+ def update_auto_apply(conditions, opts = {})
1096
+ update_auto_apply_with_http_info(conditions, opts)
1097
+ nil
1098
+ end
1099
+
1100
+ # Update auto apply rules and conditions
1101
+ # Update auto apply rules and conditions
1102
+ # @param conditions [CouponAutoApplyConditions] Conditions
1103
+ # @param [Hash] opts the optional parameters
1104
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1105
+ def update_auto_apply_with_http_info(conditions, opts = {})
1106
+ if @api_client.config.debugging
1107
+ @api_client.config.logger.debug 'Calling API: CouponApi.update_auto_apply ...'
1108
+ end
1109
+ # verify the required parameter 'conditions' is set
1110
+ if @api_client.config.client_side_validation && conditions.nil?
1111
+ fail ArgumentError, "Missing the required parameter 'conditions' when calling CouponApi.update_auto_apply"
1112
+ end
1113
+ # resource path
1114
+ local_var_path = '/coupon/auto_apply'
1115
+
1116
+ # query parameters
1117
+ query_params = opts[:query_params] || {}
1118
+
1119
+ # header parameters
1120
+ header_params = opts[:header_params] || {}
1121
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1122
+ # HTTP header 'Accept' (if needed)
1123
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1124
+ # HTTP header 'Content-Type'
1125
+ content_type = @api_client.select_header_content_type(['application/json'])
1126
+ if !content_type.nil?
1127
+ header_params['Content-Type'] = content_type
1128
+ end
1129
+
1130
+ # form parameters
1131
+ form_params = opts[:form_params] || {}
1132
+
1133
+ # http body (model)
1134
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(conditions)
1135
+
1136
+ # return_type
1137
+ return_type = opts[:debug_return_type]
1138
+
1139
+ # auth_names
1140
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1141
+
1142
+ new_options = opts.merge(
1143
+ :operation => :"CouponApi.update_auto_apply",
1144
+ :header_params => header_params,
1145
+ :query_params => query_params,
1146
+ :form_params => form_params,
1147
+ :body => post_body,
1148
+ :auth_names => auth_names,
1149
+ :return_type => return_type
1150
+ )
1151
+
1152
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1153
+ if @api_client.config.debugging
1154
+ @api_client.config.logger.debug "API called: CouponApi#update_auto_apply\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1155
+ end
1156
+ return data, status_code, headers
1157
+ end
1158
+
1159
+ # Update a coupon
1160
+ # Update a coupon on the UltraCart account.
1161
+ # @param coupon_oid [Integer] The coupon_oid to update.
1162
+ # @param coupon [Coupon] Coupon to update
1163
+ # @param [Hash] opts the optional parameters
1164
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1165
+ # @return [CouponResponse]
1166
+ def update_coupon(coupon_oid, coupon, opts = {})
1167
+ data, _status_code, _headers = update_coupon_with_http_info(coupon_oid, coupon, opts)
1168
+ data
1169
+ end
1170
+
1171
+ # Update a coupon
1172
+ # Update a coupon on the UltraCart account.
1173
+ # @param coupon_oid [Integer] The coupon_oid to update.
1174
+ # @param coupon [Coupon] Coupon to update
1175
+ # @param [Hash] opts the optional parameters
1176
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1177
+ # @return [Array<(CouponResponse, Integer, Hash)>] CouponResponse data, response status code and response headers
1178
+ def update_coupon_with_http_info(coupon_oid, coupon, opts = {})
1179
+ if @api_client.config.debugging
1180
+ @api_client.config.logger.debug 'Calling API: CouponApi.update_coupon ...'
1181
+ end
1182
+ # verify the required parameter 'coupon_oid' is set
1183
+ if @api_client.config.client_side_validation && coupon_oid.nil?
1184
+ fail ArgumentError, "Missing the required parameter 'coupon_oid' when calling CouponApi.update_coupon"
1185
+ end
1186
+ # verify the required parameter 'coupon' is set
1187
+ if @api_client.config.client_side_validation && coupon.nil?
1188
+ fail ArgumentError, "Missing the required parameter 'coupon' when calling CouponApi.update_coupon"
1189
+ end
1190
+ # resource path
1191
+ local_var_path = '/coupon/coupons/{coupon_oid}'.sub('{' + 'coupon_oid' + '}', CGI.escape(coupon_oid.to_s))
1192
+
1193
+ # query parameters
1194
+ query_params = opts[:query_params] || {}
1195
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1196
+
1197
+ # header parameters
1198
+ header_params = opts[:header_params] || {}
1199
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1200
+ # HTTP header 'Accept' (if needed)
1201
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1202
+ # HTTP header 'Content-Type'
1203
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1204
+ if !content_type.nil?
1205
+ header_params['Content-Type'] = content_type
1206
+ end
1207
+
1208
+ # form parameters
1209
+ form_params = opts[:form_params] || {}
1210
+
1211
+ # http body (model)
1212
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(coupon)
1213
+
1214
+ # return_type
1215
+ return_type = opts[:debug_return_type] || 'CouponResponse'
1216
+
1217
+ # auth_names
1218
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1219
+
1220
+ new_options = opts.merge(
1221
+ :operation => :"CouponApi.update_coupon",
1222
+ :header_params => header_params,
1223
+ :query_params => query_params,
1224
+ :form_params => form_params,
1225
+ :body => post_body,
1226
+ :auth_names => auth_names,
1227
+ :return_type => return_type
1228
+ )
1229
+
1230
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
1231
+ if @api_client.config.debugging
1232
+ @api_client.config.logger.debug "API called: CouponApi#update_coupon\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1233
+ end
1234
+ return data, status_code, headers
1235
+ end
1236
+
1237
+ # Update multiple coupons
1238
+ # Update multiple coupon on the UltraCart account.
1239
+ # @param coupons_request [CouponsRequest] Coupons to update (synchronous maximum 50 / asynchronous maximum 100)
1240
+ # @param [Hash] opts the optional parameters
1241
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1242
+ # @option opts [Boolean] :_placeholders Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
1243
+ # @option opts [Boolean] :_async True if the operation should be run async. No result returned
1244
+ # @return [CouponsResponse]
1245
+ def update_coupons(coupons_request, opts = {})
1246
+ data, _status_code, _headers = update_coupons_with_http_info(coupons_request, opts)
1247
+ data
1248
+ end
1249
+
1250
+ # Update multiple coupons
1251
+ # Update multiple coupon on the UltraCart account.
1252
+ # @param coupons_request [CouponsRequest] Coupons to update (synchronous maximum 50 / asynchronous maximum 100)
1253
+ # @param [Hash] opts the optional parameters
1254
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1255
+ # @option opts [Boolean] :_placeholders Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
1256
+ # @option opts [Boolean] :_async True if the operation should be run async. No result returned
1257
+ # @return [Array<(CouponsResponse, Integer, Hash)>] CouponsResponse data, response status code and response headers
1258
+ def update_coupons_with_http_info(coupons_request, opts = {})
1259
+ if @api_client.config.debugging
1260
+ @api_client.config.logger.debug 'Calling API: CouponApi.update_coupons ...'
1261
+ end
1262
+ # verify the required parameter 'coupons_request' is set
1263
+ if @api_client.config.client_side_validation && coupons_request.nil?
1264
+ fail ArgumentError, "Missing the required parameter 'coupons_request' when calling CouponApi.update_coupons"
1265
+ end
1266
+ # resource path
1267
+ local_var_path = '/coupon/coupons/batch'
1268
+
1269
+ # query parameters
1270
+ query_params = opts[:query_params] || {}
1271
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1272
+ query_params[:'_placeholders'] = opts[:'_placeholders'] if !opts[:'_placeholders'].nil?
1273
+ query_params[:'_async'] = opts[:'_async'] if !opts[:'_async'].nil?
1274
+
1275
+ # header parameters
1276
+ header_params = opts[:header_params] || {}
1277
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1278
+ # HTTP header 'Accept' (if needed)
1279
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1280
+ # HTTP header 'Content-Type'
1281
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1282
+ if !content_type.nil?
1283
+ header_params['Content-Type'] = content_type
1284
+ end
1285
+
1286
+ # form parameters
1287
+ form_params = opts[:form_params] || {}
1288
+
1289
+ # http body (model)
1290
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(coupons_request)
1291
+
1292
+ # return_type
1293
+ return_type = opts[:debug_return_type] || 'CouponsResponse'
1294
+
1295
+ # auth_names
1296
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1297
+
1298
+ new_options = opts.merge(
1299
+ :operation => :"CouponApi.update_coupons",
1300
+ :header_params => header_params,
1301
+ :query_params => query_params,
1302
+ :form_params => form_params,
1303
+ :body => post_body,
1304
+ :auth_names => auth_names,
1305
+ :return_type => return_type
1306
+ )
1307
+
1308
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
1309
+ if @api_client.config.debugging
1310
+ @api_client.config.logger.debug "API called: CouponApi#update_coupons\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1311
+ end
1312
+ return data, status_code, headers
1313
+ end
1314
+
1315
+ # Upload one-time codes for a coupon
1316
+ # Upload one-time codes for a coupon
1317
+ # @param coupon_oid [Integer] The coupon oid to associate with the provided one-time codes.
1318
+ # @param upload_coupon_codes_request [UploadCouponCodesRequest] One-time coupon codes
1319
+ # @param [Hash] opts the optional parameters
1320
+ # @return [UploadCouponCodesResponse]
1321
+ def upload_coupon_codes(coupon_oid, upload_coupon_codes_request, opts = {})
1322
+ data, _status_code, _headers = upload_coupon_codes_with_http_info(coupon_oid, upload_coupon_codes_request, opts)
1323
+ data
1324
+ end
1325
+
1326
+ # Upload one-time codes for a coupon
1327
+ # Upload one-time codes for a coupon
1328
+ # @param coupon_oid [Integer] The coupon oid to associate with the provided one-time codes.
1329
+ # @param upload_coupon_codes_request [UploadCouponCodesRequest] One-time coupon codes
1330
+ # @param [Hash] opts the optional parameters
1331
+ # @return [Array<(UploadCouponCodesResponse, Integer, Hash)>] UploadCouponCodesResponse data, response status code and response headers
1332
+ def upload_coupon_codes_with_http_info(coupon_oid, upload_coupon_codes_request, opts = {})
1333
+ if @api_client.config.debugging
1334
+ @api_client.config.logger.debug 'Calling API: CouponApi.upload_coupon_codes ...'
1335
+ end
1336
+ # verify the required parameter 'coupon_oid' is set
1337
+ if @api_client.config.client_side_validation && coupon_oid.nil?
1338
+ fail ArgumentError, "Missing the required parameter 'coupon_oid' when calling CouponApi.upload_coupon_codes"
1339
+ end
1340
+ # verify the required parameter 'upload_coupon_codes_request' is set
1341
+ if @api_client.config.client_side_validation && upload_coupon_codes_request.nil?
1342
+ fail ArgumentError, "Missing the required parameter 'upload_coupon_codes_request' when calling CouponApi.upload_coupon_codes"
1343
+ end
1344
+ # resource path
1345
+ local_var_path = '/coupon/coupons/{coupon_oid}/upload_codes'.sub('{' + 'coupon_oid' + '}', CGI.escape(coupon_oid.to_s))
1346
+
1347
+ # query parameters
1348
+ query_params = opts[:query_params] || {}
1349
+
1350
+ # header parameters
1351
+ header_params = opts[:header_params] || {}
1352
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1353
+ # HTTP header 'Accept' (if needed)
1354
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1355
+ # HTTP header 'Content-Type'
1356
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1357
+ if !content_type.nil?
1358
+ header_params['Content-Type'] = content_type
1359
+ end
1360
+
1361
+ # form parameters
1362
+ form_params = opts[:form_params] || {}
1363
+
1364
+ # http body (model)
1365
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(upload_coupon_codes_request)
1366
+
1367
+ # return_type
1368
+ return_type = opts[:debug_return_type] || 'UploadCouponCodesResponse'
1369
+
1370
+ # auth_names
1371
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1372
+
1373
+ new_options = opts.merge(
1374
+ :operation => :"CouponApi.upload_coupon_codes",
1375
+ :header_params => header_params,
1376
+ :query_params => query_params,
1377
+ :form_params => form_params,
1378
+ :body => post_body,
1379
+ :auth_names => auth_names,
1380
+ :return_type => return_type
1381
+ )
1382
+
1383
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1384
+ if @api_client.config.debugging
1385
+ @api_client.config.logger.debug "API called: CouponApi#upload_coupon_codes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1386
+ end
1387
+ return data, status_code, headers
1388
+ end
1389
+ end
1390
+ end