ultracart_api 3.10.14 → 4.0.32.rc

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