ultracart_api 3.11.35 → 4.0.32.rc

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (1871) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +9 -7
  3. data/README.md +1166 -1846
  4. data/Rakefile +10 -8
  5. data/docs/AccountsReceivableRetryConfig.md +46 -23
  6. data/docs/AccountsReceivableRetryConfigResponse.md +32 -15
  7. data/docs/AccountsReceivableRetryDayActivity.md +22 -10
  8. data/docs/AccountsReceivableRetryStatAccount.md +24 -11
  9. data/docs/AccountsReceivableRetryStatMetrics.md +38 -18
  10. data/docs/AccountsReceivableRetryStatRevenue.md +20 -9
  11. data/docs/AccountsReceivableRetryStatsResponse.md +28 -13
  12. data/docs/Activity.md +28 -15
  13. data/docs/AddLibraryItemRequest.md +38 -18
  14. data/docs/AdjustInternalCertificateRequest.md +28 -13
  15. data/docs/AdjustInternalCertificateResponse.md +28 -13
  16. data/docs/AffiliateApi.md +173 -126
  17. data/docs/AffiliateClick.md +38 -20
  18. data/docs/AffiliateClickQuery.md +28 -13
  19. data/docs/AffiliateClicksResponse.md +26 -12
  20. data/docs/AffiliateLedger.md +54 -26
  21. data/docs/AffiliateLedgerQuery.md +28 -13
  22. data/docs/AffiliateLedgersResponse.md +26 -12
  23. data/docs/AffiliateLink.md +44 -21
  24. data/docs/ApiUserApplicationProfile.md +26 -12
  25. data/docs/ApplyLibraryItemRequest.md +24 -11
  26. data/docs/ApplyLibraryItemResponse.md +38 -18
  27. data/docs/AutoOrder.md +60 -34
  28. data/docs/AutoOrderApi.md +693 -675
  29. data/docs/AutoOrderItem.md +64 -35
  30. data/docs/AutoOrderItemFutureSchedule.md +24 -11
  31. data/docs/AutoOrderItemOption.md +20 -9
  32. data/docs/AutoOrderItemSimpleSchedule.md +22 -10
  33. data/docs/AutoOrderLog.md +20 -9
  34. data/docs/AutoOrderQuery.md +58 -28
  35. data/docs/AutoOrderQueryBatch.md +18 -8
  36. data/docs/AutoOrderResponse.md +26 -12
  37. data/docs/AutoOrdersRequest.md +18 -8
  38. data/docs/AutoOrdersResponse.md +26 -12
  39. data/docs/AvalaraConfig.md +42 -20
  40. data/docs/BaseResponse.md +24 -11
  41. data/docs/Browser.md +22 -10
  42. data/docs/BrowserDevice.md +18 -8
  43. data/docs/BrowserOS.md +26 -12
  44. data/docs/BrowserUserAgent.md +24 -11
  45. data/docs/Cart.md +68 -33
  46. data/docs/CartAffiliate.md +20 -9
  47. data/docs/CartAffirmCheckoutResponse.md +20 -9
  48. data/docs/CartBilling.md +46 -24
  49. data/docs/CartBuysafe.md +28 -13
  50. data/docs/CartCheckout.md +44 -25
  51. data/docs/CartCoupon.md +18 -8
  52. data/docs/CartCurrencyConversion.md +20 -9
  53. data/docs/CartCustomerProfile.md +60 -30
  54. data/docs/CartCustomerProfileAddress.md +44 -21
  55. data/docs/CartCustomerProfileCreditCard.md +28 -13
  56. data/docs/CartFinalizeOrderRequest.md +20 -9
  57. data/docs/CartFinalizeOrderRequestOptions.md +42 -20
  58. data/docs/CartFinalizeOrderResponse.md +26 -12
  59. data/docs/CartGift.md +28 -13
  60. data/docs/CartGiftCertificate.md +22 -10
  61. data/docs/CartItem.md +74 -37
  62. data/docs/CartItemAttribute.md +22 -10
  63. data/docs/CartItemMultimedia.md +34 -16
  64. data/docs/CartItemMultimediaThumbnail.md +26 -12
  65. data/docs/CartItemOption.md +40 -19
  66. data/docs/CartItemOptionValue.md +26 -12
  67. data/docs/CartItemPhysical.md +24 -11
  68. data/docs/CartItemVariationSelection.md +20 -9
  69. data/docs/CartKitComponentOption.md +44 -21
  70. data/docs/CartMarketing.md +20 -10
  71. data/docs/CartPayment.md +30 -15
  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 -11
  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 -27
  99. data/docs/CartTaxes.md +22 -10
  100. data/docs/CartUpsellAfter.md +22 -12
  101. data/docs/CartValidationRequest.md +20 -9
  102. data/docs/CartValidationResponse.md +20 -9
  103. data/docs/ChannelPartnerApi.md +382 -811
  104. data/docs/ChannelPartnerCancelResponse.md +26 -12
  105. data/docs/ChannelPartnerEstimateShippingResponse.md +26 -12
  106. data/docs/ChannelPartnerEstimateTaxResponse.md +26 -12
  107. data/docs/ChannelPartnerImportResponse.md +30 -14
  108. data/docs/ChannelPartnerOrder.md +176 -100
  109. data/docs/ChannelPartnerOrderItem.md +30 -15
  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 -0
  115. data/docs/ChargebackDispute.md +62 -0
  116. data/docs/ChargebackDisputeResponse.md +26 -0
  117. data/docs/ChargebackDisputesResponse.md +26 -0
  118. data/docs/CheckoutAllowedCountriesResponse.md +18 -8
  119. data/docs/CheckoutApi.md +1566 -1023
  120. data/docs/CheckoutHandoffRequest.md +32 -15
  121. data/docs/CheckoutHandoffResponse.md +22 -10
  122. data/docs/CheckoutSetupBrowserKeyRequest.md +18 -8
  123. data/docs/CheckoutSetupBrowserKeyResponse.md +18 -8
  124. data/docs/CheckoutStateProvinceResponse.md +18 -8
  125. data/docs/CityStateZip.md +26 -12
  126. data/docs/CountriesResponse.md +18 -8
  127. data/docs/Country.md +20 -9
  128. data/docs/Coupon.md +136 -74
  129. data/docs/CouponAmountOffItems.md +24 -12
  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 -10
  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 -14
  148. data/docs/CouponDiscountItems.md +24 -11
  149. data/docs/CouponEditorValues.md +36 -18
  150. data/docs/CouponExistsResponse.md +28 -13
  151. data/docs/CouponFreeItemAndShippingWithSubtotal.md +26 -12
  152. data/docs/CouponFreeItemWithItemPurchase.md +24 -13
  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 -14
  164. data/docs/CouponPercentOffItems.md +24 -13
  165. data/docs/CouponPercentOffItemsAndFreeShipping.md +22 -13
  166. data/docs/CouponPercentOffItemsWithItemsPurchase.md +24 -13
  167. data/docs/CouponPercentOffMsrpItems.md +24 -13
  168. data/docs/CouponPercentOffRetailPriceItems.md +24 -11
  169. data/docs/CouponPercentOffShipping.md +20 -9
  170. data/docs/CouponPercentOffSubtotal.md +18 -8
  171. data/docs/CouponPercentOffSubtotalAndFreeShipping.md +20 -9
  172. data/docs/CouponPercentOffSubtotalLimit.md +22 -10
  173. data/docs/CouponPercentOffSubtotalWithItemsPurchase.md +20 -9
  174. data/docs/CouponPercentOffSubtotalWithSubtotal.md +22 -10
  175. data/docs/CouponQuery.md +36 -17
  176. data/docs/CouponResponse.md +28 -13
  177. data/docs/CouponRestriction.md +24 -11
  178. data/docs/CouponTierAmount.md +22 -10
  179. data/docs/CouponTierItemDiscount.md +20 -9
  180. data/docs/CouponTierPercent.md +22 -10
  181. data/docs/CouponTierQuantityAmount.md +22 -10
  182. data/docs/CouponTierQuantityPercent.md +22 -10
  183. data/docs/CouponTieredAmountOffItems.md +22 -11
  184. data/docs/CouponTieredAmountOffSubtotal.md +20 -9
  185. data/docs/CouponTieredPercentOffItems.md +22 -11
  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 -72
  193. data/docs/CustomerActivity.md +24 -15
  194. data/docs/CustomerAffiliate.md +24 -11
  195. data/docs/CustomerApi.md +1380 -1412
  196. data/docs/CustomerAttachment.md +26 -12
  197. data/docs/CustomerBilling.md +50 -24
  198. data/docs/CustomerCard.md +32 -15
  199. data/docs/CustomerEditorValues.md +36 -19
  200. data/docs/CustomerEmail.md +28 -13
  201. data/docs/CustomerEmailListChanges.md +20 -9
  202. data/docs/CustomerLoyalty.md +30 -17
  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 -38
  209. data/docs/CustomerQuotesSummary.md +24 -11
  210. data/docs/CustomerResponse.md +26 -12
  211. data/docs/CustomerReviewer.md +36 -17
  212. data/docs/CustomerShipping.md +50 -24
  213. data/docs/CustomerSoftwareEntitlement.md +32 -15
  214. data/docs/CustomerStoreCredit.md +28 -13
  215. data/docs/CustomerStoreCreditAddRequest.md +24 -11
  216. data/docs/CustomerStoreCreditLedgerEntry.md +30 -14
  217. data/docs/CustomerStoreCreditResponse.md +26 -12
  218. data/docs/CustomerTag.md +18 -8
  219. data/docs/CustomerTaxCodes.md +26 -12
  220. data/docs/CustomersResponse.md +26 -12
  221. data/docs/DataTablesServerSideResponse.md +24 -11
  222. data/docs/Distance.md +20 -9
  223. data/docs/DistributionCenter.md +86 -57
  224. data/docs/DistributionCentersResponse.md +26 -12
  225. data/docs/EmailBaseTemplateListResponse.md +18 -8
  226. data/docs/EmailCampaign.md +64 -35
  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 -44
  236. data/docs/EmailCommseqEmailResponse.md +26 -12
  237. data/docs/EmailCommseqEmailSendTestRequest.md +36 -17
  238. data/docs/EmailCommseqEmailSendTestResponse.md +24 -11
  239. data/docs/EmailCommseqEmailsRequest.md +26 -12
  240. data/docs/EmailCommseqEmailsResponse.md +26 -12
  241. data/docs/EmailCommseqPostcard.md +42 -20
  242. data/docs/EmailCommseqPostcardResponse.md +26 -12
  243. data/docs/EmailCommseqPostcardSendTestRequest.md +42 -20
  244. data/docs/EmailCommseqPostcardSendTestResponse.md +30 -14
  245. data/docs/EmailCommseqPostcardsRequest.md +18 -8
  246. data/docs/EmailCommseqPostcardsResponse.md +26 -12
  247. data/docs/EmailCommseqResponse.md +26 -12
  248. data/docs/EmailCommseqStat.md +90 -44
  249. data/docs/EmailCommseqStatResponse.md +26 -12
  250. data/docs/EmailCommseqStep.md +36 -17
  251. data/docs/EmailCommseqStepLog.md +22 -10
  252. data/docs/EmailCommseqStepLogsResponse.md +26 -12
  253. data/docs/EmailCommseqWebhookSendTestRequest.md +30 -14
  254. data/docs/EmailCommseqWebhookSendTestResponse.md +30 -14
  255. data/docs/EmailCommseqsResponse.md +26 -12
  256. data/docs/EmailCustomer.md +32 -15
  257. data/docs/EmailCustomerEditorUrlResponse.md +26 -12
  258. data/docs/EmailCustomersResponse.md +26 -12
  259. data/docs/EmailDashboardActivity.md +30 -14
  260. data/docs/EmailDashboardActivityResponse.md +26 -12
  261. data/docs/EmailDashboardStatsResponse.md +26 -12
  262. data/docs/EmailDomain.md +42 -20
  263. data/docs/EmailEditorTokenResponse.md +26 -12
  264. data/docs/EmailFlow.md +72 -38
  265. data/docs/EmailFlowBackPopulateRequest.md +20 -9
  266. data/docs/EmailFlowBackPopulateResponse.md +24 -11
  267. data/docs/EmailFlowFolder.md +26 -12
  268. data/docs/EmailFlowFolderResponse.md +26 -12
  269. data/docs/EmailFlowFoldersResponse.md +26 -12
  270. data/docs/EmailFlowResponse.md +26 -12
  271. data/docs/EmailFlowsResponse.md +26 -12
  272. data/docs/EmailGlobalSettings.md +18 -8
  273. data/docs/EmailGlobalSettingsResponse.md +26 -12
  274. data/docs/EmailGlobalUnsubscribeRequest.md +18 -8
  275. data/docs/EmailGlobalUnsubscribeResponse.md +18 -8
  276. data/docs/EmailHistogramPropertyNamesResponse.md +18 -8
  277. data/docs/EmailHistogramPropertyValuesResponse.md +18 -8
  278. data/docs/EmailList.md +40 -19
  279. data/docs/EmailListArchiveResponse.md +26 -12
  280. data/docs/EmailListCustomer.md +24 -11
  281. data/docs/EmailListCustomersResponse.md +26 -12
  282. data/docs/EmailListResponse.md +26 -12
  283. data/docs/EmailListSegmentFolder.md +26 -12
  284. data/docs/EmailListSegmentFolderResponse.md +26 -12
  285. data/docs/EmailListSegmentFoldersResponse.md +26 -12
  286. data/docs/EmailListSegmentMembership.md +24 -11
  287. data/docs/EmailListSegmentUsedBy.md +22 -10
  288. data/docs/EmailListSubscribeResponse.md +20 -9
  289. data/docs/EmailListsResponse.md +26 -12
  290. data/docs/EmailOrder.md +24 -11
  291. data/docs/EmailOrdersResponse.md +26 -12
  292. data/docs/EmailPerformance.md +62 -30
  293. data/docs/EmailPerformanceCustomerHistogram.md +18 -8
  294. data/docs/EmailPerformanceCustomerHistogramPeriod.md +26 -12
  295. data/docs/EmailPerformanceDaily.md +30 -14
  296. data/docs/EmailPerformanceResponse.md +26 -12
  297. data/docs/EmailPlan.md +50 -24
  298. data/docs/EmailPlanAdditional.md +34 -16
  299. data/docs/EmailPlanResponse.md +26 -12
  300. data/docs/EmailPostcardStat.md +80 -39
  301. data/docs/EmailSegment.md +58 -29
  302. data/docs/EmailSegmentArchiveResponse.md +26 -12
  303. data/docs/EmailSegmentCustomer.md +24 -11
  304. data/docs/EmailSegmentCustomersResponse.md +26 -12
  305. data/docs/EmailSegmentDownloadPrepareResponse.md +32 -15
  306. data/docs/EmailSegmentResponse.md +26 -12
  307. data/docs/EmailSegmentsResponse.md +26 -12
  308. data/docs/EmailSendingDomainResponse.md +26 -12
  309. data/docs/EmailSendingDomainsResponse.md +26 -12
  310. data/docs/EmailSettings.md +40 -26
  311. data/docs/EmailSettingsResponse.md +26 -12
  312. data/docs/EmailStat.md +92 -45
  313. data/docs/EmailStatPostcardSummaryRequest.md +20 -9
  314. data/docs/EmailStatPostcardSummaryResponse.md +26 -12
  315. data/docs/EmailStatSummaryRequest.md +22 -10
  316. data/docs/EmailStatSummaryResponse.md +26 -12
  317. data/docs/EmailStepStat.md +56 -37
  318. data/docs/EmailStepStatRequest.md +20 -9
  319. data/docs/EmailStepStatResponse.md +26 -12
  320. data/docs/EmailStepWaitingRequest.md +18 -8
  321. data/docs/EmailStepWaitingResponse.md +18 -8
  322. data/docs/EmailTemplate.md +38 -18
  323. data/docs/EmailTemplatesResponse.md +26 -12
  324. data/docs/EmailThirdPartyList.md +20 -9
  325. data/docs/EmailThirdPartyListImportRequest.md +18 -8
  326. data/docs/EmailThirdPartyProvider.md +38 -18
  327. data/docs/EmailThirdPartyProvidersResponse.md +26 -12
  328. data/docs/EmailThirdPartyTag.md +20 -9
  329. data/docs/EmailVerifyTokenRequest.md +20 -9
  330. data/docs/EmailVerifyTokenResponse.md +26 -12
  331. data/docs/EmailVerifyTokenValidateRequest.md +18 -8
  332. data/docs/EmailVerifyTokenValidateResponse.md +24 -11
  333. data/docs/EmailWebhookEditorValuesResponse.md +30 -14
  334. data/docs/Error.md +26 -12
  335. data/docs/ErrorResponse.md +24 -11
  336. data/docs/Experiment.md +52 -31
  337. data/docs/ExperimentResponse.md +26 -12
  338. data/docs/ExperimentVariation.md +60 -30
  339. data/docs/ExperimentVariationStat.md +38 -20
  340. data/docs/ExperimentsResponse.md +26 -12
  341. data/docs/FulfillmentApi.md +459 -318
  342. data/docs/FulfillmentInventory.md +20 -9
  343. data/docs/FulfillmentShipment.md +26 -12
  344. data/docs/GeoPoint.md +20 -9
  345. data/docs/GeocodeRequest.md +26 -12
  346. data/docs/GeocodeResponse.md +28 -13
  347. data/docs/GiftCertificate.md +44 -21
  348. data/docs/GiftCertificateApi.md +622 -433
  349. data/docs/GiftCertificateCreateRequest.md +26 -12
  350. data/docs/GiftCertificateLedgerEntry.md +28 -13
  351. data/docs/GiftCertificateQuery.md +34 -16
  352. data/docs/GiftCertificateResponse.md +26 -12
  353. data/docs/GiftCertificatesResponse.md +26 -12
  354. data/docs/Group.md +26 -12
  355. data/docs/GroupResponse.md +26 -12
  356. data/docs/GroupUserMembership.md +26 -12
  357. data/docs/GroupsResponse.md +26 -12
  358. data/docs/HTTPHeader.md +20 -9
  359. data/docs/IntegrationLog.md +52 -26
  360. data/docs/IntegrationLogApi.md +400 -286
  361. data/docs/IntegrationLogFile.md +24 -11
  362. data/docs/IntegrationLogLog.md +20 -9
  363. data/docs/IntegrationLogQueryFilterValues.md +40 -19
  364. data/docs/IntegrationLogQueryRequest.md +42 -23
  365. data/docs/IntegrationLogQueryResponse.md +28 -13
  366. data/docs/IntegrationLogResponse.md +26 -12
  367. data/docs/IntegrationLogSummary.md +34 -16
  368. data/docs/IntegrationLogSummaryQueryRequest.md +20 -9
  369. data/docs/IntegrationLogSummaryQueryResponse.md +26 -12
  370. data/docs/Item.md +118 -58
  371. data/docs/ItemAccounting.md +20 -9
  372. data/docs/ItemAmember.md +20 -9
  373. data/docs/ItemApi.md +733 -1266
  374. data/docs/ItemAutoOrder.md +50 -29
  375. data/docs/ItemAutoOrderStep.md +46 -24
  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 -23
  385. data/docs/ItemContentAssignment.md +28 -13
  386. data/docs/ItemContentAttribute.md +24 -11
  387. data/docs/ItemContentMultimedia.md +46 -22
  388. data/docs/ItemContentMultimediaThumbnail.md +28 -13
  389. data/docs/ItemDigitalDelivery.md +28 -13
  390. data/docs/ItemDigitalItem.md +26 -17
  391. data/docs/ItemEbay.md +154 -76
  392. data/docs/ItemEbayCategorySpecific.md +20 -9
  393. data/docs/ItemEbayMarketListing.md +26 -12
  394. data/docs/ItemEbayMarketPlaceAnalysis.md +36 -17
  395. data/docs/ItemEmailNotifications.md +20 -9
  396. data/docs/ItemEnrollment123.md +18 -8
  397. data/docs/ItemFulfillmentAddon.md +24 -12
  398. data/docs/ItemGiftCertificate.md +20 -9
  399. data/docs/ItemGoogleProductSearch.md +112 -55
  400. data/docs/ItemIdentifiers.md +24 -15
  401. data/docs/ItemInstantPaymentNotification.md +22 -10
  402. data/docs/ItemInstantPaymentNotifications.md +18 -8
  403. data/docs/ItemInternal.md +18 -8
  404. data/docs/ItemKitComponent.md +26 -12
  405. data/docs/ItemKitDefinition.md +18 -8
  406. data/docs/ItemOption.md +44 -21
  407. data/docs/ItemOptionValue.md +46 -22
  408. data/docs/ItemOptionValueAdditionalItem.md +20 -9
  409. data/docs/ItemOptionValueDigitalItem.md +20 -9
  410. data/docs/ItemPaymentProcessing.md +26 -13
  411. data/docs/ItemPhysical.md +24 -11
  412. data/docs/ItemPricing.md +52 -25
  413. data/docs/ItemPricingTier.md +26 -12
  414. data/docs/ItemPricingTierDiscount.md +20 -9
  415. data/docs/ItemPricingTierLimit.md +22 -12
  416. data/docs/ItemProperty.md +22 -10
  417. data/docs/ItemRealtimePricing.md +22 -10
  418. data/docs/ItemRelated.md +22 -10
  419. data/docs/ItemRelatedItem.md +22 -10
  420. data/docs/ItemReporting.md +20 -9
  421. data/docs/ItemResponse.md +26 -12
  422. data/docs/ItemRestriction.md +32 -16
  423. data/docs/ItemRestrictionItem.md +22 -10
  424. data/docs/ItemRevguard.md +30 -14
  425. data/docs/ItemReviews.md +34 -17
  426. data/docs/ItemSalesforce.md +20 -9
  427. data/docs/ItemShipping.md +112 -57
  428. data/docs/ItemShippingCase.md +24 -11
  429. data/docs/ItemShippingDestinationMarkup.md +28 -14
  430. data/docs/ItemShippingDestinationRestriction.md +22 -10
  431. data/docs/ItemShippingDistributionCenter.md +44 -21
  432. data/docs/ItemShippingMethod.md +46 -23
  433. data/docs/ItemShippingPackageRequirement.md +20 -9
  434. data/docs/ItemTag.md +20 -9
  435. data/docs/ItemTags.md +18 -8
  436. data/docs/ItemTax.md +24 -11
  437. data/docs/ItemTaxExemption.md +26 -12
  438. data/docs/ItemThirdPartyEmailMarketing.md +26 -12
  439. data/docs/ItemVariantItem.md +28 -13
  440. data/docs/ItemVariation.md +26 -12
  441. data/docs/ItemVariationOption.md +24 -11
  442. data/docs/ItemWishlistMember.md +22 -10
  443. data/docs/ItemsRequest.md +18 -8
  444. data/docs/ItemsResponse.md +26 -12
  445. data/docs/KeyValue.md +22 -10
  446. data/docs/LibraryFilterValues.md +24 -11
  447. data/docs/LibraryFilterValuesResponse.md +26 -12
  448. data/docs/LibraryItem.md +96 -47
  449. data/docs/LibraryItemAccount.md +22 -10
  450. data/docs/LibraryItemAsset.md +20 -9
  451. data/docs/LibraryItemAttribute.md +20 -9
  452. data/docs/LibraryItemEmail.md +22 -10
  453. data/docs/LibraryItemPublishedMeta.md +32 -15
  454. data/docs/LibraryItemPurchasedMeta.md +22 -10
  455. data/docs/LibraryItemQuery.md +40 -19
  456. data/docs/LibraryItemResponse.md +26 -12
  457. data/docs/LibraryItemScreenshot.md +20 -9
  458. data/docs/LibraryItemsResponse.md +26 -12
  459. data/docs/LinkedAccount.md +22 -10
  460. data/docs/ListSegmentMembership.md +22 -10
  461. data/docs/LookupRequest.md +26 -13
  462. data/docs/LookupResponse.md +26 -12
  463. data/docs/Mailgun.md +18 -8
  464. data/docs/Metric.md +32 -15
  465. data/docs/Notification.md +38 -18
  466. data/docs/OauthApi.md +179 -124
  467. data/docs/OauthRevokeSuccessResponse.md +20 -9
  468. data/docs/OauthTokenResponse.md +32 -15
  469. data/docs/Order.md +84 -46
  470. data/docs/OrderAffiliate.md +22 -10
  471. data/docs/OrderAffiliateLedger.md +34 -16
  472. data/docs/OrderApi.md +1856 -1742
  473. data/docs/OrderAutoOrder.md +56 -27
  474. data/docs/OrderBilling.md +48 -25
  475. data/docs/OrderBuysafe.md +28 -13
  476. data/docs/OrderByTokenQuery.md +18 -8
  477. data/docs/OrderChannelPartner.md +38 -18
  478. data/docs/OrderCheckout.md +44 -24
  479. data/docs/OrderCoupon.md +26 -12
  480. data/docs/OrderDigitalItem.md +32 -15
  481. data/docs/OrderDigitalOrder.md +26 -12
  482. data/docs/OrderEdi.md +24 -11
  483. data/docs/OrderFormat.md +48 -23
  484. data/docs/OrderFormatResponse.md +20 -9
  485. data/docs/OrderFraudScore.md +56 -27
  486. data/docs/OrderGift.md +36 -17
  487. data/docs/OrderGiftCertificate.md +22 -10
  488. data/docs/OrderInternal.md +26 -13
  489. data/docs/OrderItem.md +128 -73
  490. data/docs/OrderItemEdi.md +20 -9
  491. data/docs/OrderItemEdiIdentification.md +20 -9
  492. data/docs/OrderItemEdiLot.md +22 -10
  493. data/docs/OrderItemOption.md +38 -18
  494. data/docs/OrderItemOptionFileAttachment.md +24 -11
  495. data/docs/OrderItemProperty.md +24 -11
  496. data/docs/OrderItemTag.md +18 -8
  497. data/docs/OrderLinkedShipment.md +26 -12
  498. data/docs/OrderMarketing.md +22 -11
  499. data/docs/OrderPackingSlipResponse.md +26 -12
  500. data/docs/OrderPayment.md +52 -27
  501. data/docs/OrderPaymentCheck.md +18 -8
  502. data/docs/OrderPaymentCreditCard.md +38 -19
  503. data/docs/OrderPaymentECheck.md +36 -17
  504. data/docs/OrderPaymentInsurance.md +24 -11
  505. data/docs/OrderPaymentPurchaseOrder.md +18 -8
  506. data/docs/OrderPaymentTransaction.md +24 -12
  507. data/docs/OrderPaymentTransactionDetail.md +22 -10
  508. data/docs/OrderProcessPaymentRequest.md +20 -9
  509. data/docs/OrderProcessPaymentResponse.md +26 -12
  510. data/docs/OrderProperty.md +24 -13
  511. data/docs/OrderQuery.md +94 -50
  512. data/docs/OrderQueryBatch.md +18 -9
  513. data/docs/OrderQuote.md +22 -10
  514. data/docs/OrderReplacement.md +46 -22
  515. data/docs/OrderReplacementItem.md +22 -10
  516. data/docs/OrderReplacementResponse.md +28 -13
  517. data/docs/OrderResponse.md +26 -12
  518. data/docs/OrderSalesforce.md +18 -8
  519. data/docs/OrderShipping.md +76 -38
  520. data/docs/OrderSummary.md +56 -33
  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 -41
  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 -10
  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 -9426
  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 -16
  628. data/docs/TwilioResponse.md +28 -13
  629. data/docs/TwiliosResponse.md +26 -12
  630. data/docs/UltraCartConfig.md +18 -10
  631. data/docs/UploadCouponCodesRequest.md +26 -12
  632. data/docs/UploadCouponCodesResponse.md +30 -14
  633. data/docs/User.md +44 -21
  634. data/docs/UserApi.md +823 -558
  635. data/docs/UserGroupMembership.md +22 -10
  636. data/docs/UserLogin.md +24 -11
  637. data/docs/UserLoginsResponse.md +26 -12
  638. data/docs/UserResponse.md +26 -12
  639. data/docs/UsersResponse.md +26 -12
  640. data/docs/VerificationRecord.md +22 -10
  641. data/docs/Warning.md +20 -9
  642. data/docs/Webhook.md +52 -26
  643. data/docs/WebhookApi.md +636 -447
  644. data/docs/WebhookEventCategory.md +26 -12
  645. data/docs/WebhookEventSubscription.md +34 -17
  646. data/docs/WebhookLog.md +38 -19
  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 -0
  652. data/docs/WebhookSampleRequestResponse.md +26 -0
  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 -770
  658. data/lib/ultracart_api/api/channel_partner_api.rb +370 -920
  659. data/lib/ultracart_api/api/chargeback_api.rb +410 -0
  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 -1595
  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 -1412
  667. data/lib/ultracart_api/api/oauth_api.rb +198 -171
  668. data/lib/ultracart_api/api/order_api.rb +1728 -1942
  669. data/lib/ultracart_api/api/sso_api.rb +289 -243
  670. data/lib/ultracart_api/api/storefront_api.rb +11407 -10636
  671. data/lib/ultracart_api/api/tax_api.rb +1916 -1580
  672. data/lib/ultracart_api/api/user_api.rb +755 -634
  673. data/lib/ultracart_api/api/webhook_api.rb +601 -514
  674. data/lib/ultracart_api/api_client.rb +399 -400
  675. data/lib/ultracart_api/api_error.rb +57 -38
  676. data/lib/ultracart_api/configuration.rb +302 -229
  677. data/lib/ultracart_api/models/accounts_receivable_retry_config.rb +364 -341
  678. data/lib/ultracart_api/models/accounts_receivable_retry_config_response.rb +287 -252
  679. data/lib/ultracart_api/models/accounts_receivable_retry_day_activity.rb +240 -205
  680. data/lib/ultracart_api/models/accounts_receivable_retry_stat_account.rb +250 -215
  681. data/lib/ultracart_api/models/accounts_receivable_retry_stat_metrics.rb +309 -274
  682. data/lib/ultracart_api/models/accounts_receivable_retry_stat_revenue.rb +228 -193
  683. data/lib/ultracart_api/models/accounts_receivable_retry_stats_response.rb +267 -232
  684. data/lib/ultracart_api/models/activity.rb +264 -247
  685. data/lib/ultracart_api/models/add_library_item_request.rb +324 -289
  686. data/lib/ultracart_api/models/adjust_internal_certificate_request.rb +270 -235
  687. data/lib/ultracart_api/models/adjust_internal_certificate_response.rb +267 -232
  688. data/lib/ultracart_api/models/affiliate_click.rb +319 -304
  689. data/lib/ultracart_api/models/affiliate_click_query.rb +270 -235
  690. data/lib/ultracart_api/models/affiliate_clicks_response.rb +259 -224
  691. data/lib/ultracart_api/models/affiliate_ledger.rb +431 -396
  692. data/lib/ultracart_api/models/affiliate_ledger_query.rb +270 -235
  693. data/lib/ultracart_api/models/affiliate_ledgers_response.rb +259 -224
  694. data/lib/ultracart_api/models/affiliate_link.rb +408 -373
  695. data/lib/ultracart_api/models/api_user_application_profile.rb +260 -225
  696. data/lib/ultracart_api/models/apply_library_item_request.rb +250 -215
  697. data/lib/ultracart_api/models/apply_library_item_response.rb +319 -284
  698. data/lib/ultracart_api/models/auto_order.rb +469 -485
  699. data/lib/ultracart_api/models/auto_order_item.rb +487 -492
  700. data/lib/ultracart_api/models/auto_order_item_future_schedule.rb +250 -215
  701. data/lib/ultracart_api/models/auto_order_item_option.rb +260 -225
  702. data/lib/ultracart_api/models/auto_order_item_simple_schedule.rb +274 -239
  703. data/lib/ultracart_api/models/auto_order_log.rb +230 -195
  704. data/lib/ultracart_api/models/auto_order_query.rb +480 -445
  705. data/lib/ultracart_api/models/auto_order_query_batch.rb +222 -187
  706. data/lib/ultracart_api/models/auto_order_response.rb +256 -221
  707. data/lib/ultracart_api/models/auto_orders_request.rb +222 -187
  708. data/lib/ultracart_api/models/auto_orders_response.rb +258 -223
  709. data/lib/ultracart_api/models/avalara_config.rb +340 -305
  710. data/lib/ultracart_api/models/base_response.rb +247 -212
  711. data/lib/ultracart_api/models/browser.rb +237 -202
  712. data/lib/ultracart_api/models/browser_device.rb +219 -184
  713. data/lib/ultracart_api/models/browser_os.rb +255 -220
  714. data/lib/ultracart_api/models/browser_user_agent.rb +246 -211
  715. data/lib/ultracart_api/models/cart.rb +506 -471
  716. data/lib/ultracart_api/models/cart_affiliate.rb +245 -210
  717. data/lib/ultracart_api/models/cart_affirm_checkout_response.rb +232 -197
  718. data/lib/ultracart_api/models/cart_billing.rb +572 -587
  719. data/lib/ultracart_api/models/cart_buysafe.rb +269 -234
  720. data/lib/ultracart_api/models/cart_checkout.rb +500 -550
  721. data/lib/ultracart_api/models/cart_coupon.rb +220 -185
  722. data/lib/ultracart_api/models/cart_currency_conversion.rb +232 -197
  723. data/lib/ultracart_api/models/cart_customer_profile.rb +438 -413
  724. data/lib/ultracart_api/models/cart_customer_profile_address.rb +350 -315
  725. data/lib/ultracart_api/models/cart_customer_profile_credit_card.rb +304 -269
  726. data/lib/ultracart_api/models/cart_finalize_order_request.rb +228 -193
  727. data/lib/ultracart_api/models/cart_finalize_order_request_options.rb +355 -320
  728. data/lib/ultracart_api/models/cart_finalize_order_response.rb +260 -225
  729. data/lib/ultracart_api/models/cart_gift.rb +313 -278
  730. data/lib/ultracart_api/models/cart_gift_certificate.rb +238 -203
  731. data/lib/ultracart_api/models/cart_item.rb +504 -481
  732. data/lib/ultracart_api/models/cart_item_attribute.rb +240 -205
  733. data/lib/ultracart_api/models/cart_item_multimedia.rb +336 -301
  734. data/lib/ultracart_api/models/cart_item_multimedia_thumbnail.rb +260 -225
  735. data/lib/ultracart_api/models/cart_item_option.rb +378 -343
  736. data/lib/ultracart_api/models/cart_item_option_value.rb +258 -223
  737. data/lib/ultracart_api/models/cart_item_physical.rb +246 -211
  738. data/lib/ultracart_api/models/cart_item_variation_selection.rb +230 -195
  739. data/lib/ultracart_api/models/cart_kit_component_option.rb +398 -363
  740. data/lib/ultracart_api/models/cart_marketing.rb +230 -205
  741. data/lib/ultracart_api/models/cart_payment.rb +275 -249
  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 -217
  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 -356
  769. data/lib/ultracart_api/models/cart_taxes.rb +255 -220
  770. data/lib/ultracart_api/models/cart_upsell_after.rb +255 -240
  771. data/lib/ultracart_api/models/cart_validation_request.rb +231 -196
  772. data/lib/ultracart_api/models/cart_validation_response.rb +231 -196
  773. data/lib/ultracart_api/models/channel_partner_cancel_response.rb +259 -224
  774. data/lib/ultracart_api/models/channel_partner_estimate_shipping_response.rb +259 -224
  775. data/lib/ultracart_api/models/channel_partner_estimate_tax_response.rb +256 -221
  776. data/lib/ultracart_api/models/channel_partner_import_response.rb +281 -246
  777. data/lib/ultracart_api/models/channel_partner_order.rb +1604 -1723
  778. data/lib/ultracart_api/models/channel_partner_order_item.rb +331 -308
  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 -0
  784. data/lib/ultracart_api/models/{conversation_pbx_audio_usage_response.rb → chargeback_dispute_response.rb} +256 -245
  785. data/lib/ultracart_api/models/{conversation_pbx_customer_snapshot_response.rb → chargeback_disputes_response.rb} +258 -245
  786. data/lib/ultracart_api/models/checkout_allowed_countries_response.rb +221 -186
  787. data/lib/ultracart_api/models/checkout_handoff_request.rb +323 -288
  788. data/lib/ultracart_api/models/checkout_handoff_response.rb +241 -206
  789. data/lib/ultracart_api/models/checkout_setup_browser_key_request.rb +222 -187
  790. data/lib/ultracart_api/models/checkout_setup_browser_key_response.rb +220 -185
  791. data/lib/ultracart_api/models/checkout_state_province_response.rb +221 -186
  792. data/lib/ultracart_api/models/city_state_zip.rb +255 -220
  793. data/lib/ultracart_api/models/countries_response.rb +221 -186
  794. data/lib/ultracart_api/models/country.rb +260 -225
  795. data/lib/ultracart_api/models/coupon.rb +864 -917
  796. data/lib/ultracart_api/models/coupon_amount_off_items.rb +267 -244
  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 -209
  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 -264
  814. data/lib/ultracart_api/models/coupon_discount_items.rb +267 -232
  815. data/lib/ultracart_api/models/coupon_editor_values.rb +330 -307
  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 -243
  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 -253
  830. data/lib/ultracart_api/models/coupon_percent_off_items.rb +254 -243
  831. data/lib/ultracart_api/models/coupon_percent_off_items_and_free_shipping.rb +244 -245
  832. data/lib/ultracart_api/models/coupon_percent_off_items_with_items_purchase.rb +254 -243
  833. data/lib/ultracart_api/models/coupon_percent_off_msrp_items.rb +254 -239
  834. data/lib/ultracart_api/models/coupon_percent_off_retail_price_items.rb +254 -219
  835. data/lib/ultracart_api/models/coupon_percent_off_shipping.rb +232 -197
  836. data/lib/ultracart_api/models/coupon_percent_off_subtotal.rb +220 -185
  837. data/lib/ultracart_api/models/coupon_percent_off_subtotal_and_free_shipping.rb +232 -197
  838. data/lib/ultracart_api/models/coupon_percent_off_subtotal_limit.rb +255 -220
  839. data/lib/ultracart_api/models/coupon_percent_off_subtotal_with_items_purchase.rb +232 -197
  840. data/lib/ultracart_api/models/coupon_percent_off_subtotal_with_subtotal.rb +255 -220
  841. data/lib/ultracart_api/models/coupon_query.rb +310 -275
  842. data/lib/ultracart_api/models/coupon_response.rb +268 -233
  843. data/lib/ultracart_api/models/coupon_restriction.rb +246 -211
  844. data/lib/ultracart_api/models/coupon_tier_amount.rb +255 -220
  845. data/lib/ultracart_api/models/coupon_tier_item_discount.rb +232 -197
  846. data/lib/ultracart_api/models/coupon_tier_percent.rb +255 -220
  847. data/lib/ultracart_api/models/coupon_tier_quantity_amount.rb +255 -220
  848. data/lib/ultracart_api/models/coupon_tier_quantity_percent.rb +255 -220
  849. data/lib/ultracart_api/models/coupon_tiered_amount_off_items.rb +244 -221
  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 -221
  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 -1019
  859. data/lib/ultracart_api/models/customer_activity.rb +254 -255
  860. data/lib/ultracart_api/models/customer_affiliate.rb +250 -215
  861. data/lib/ultracart_api/models/customer_attachment.rb +260 -225
  862. data/lib/ultracart_api/models/customer_billing.rb +575 -540
  863. data/lib/ultracart_api/models/customer_card.rb +290 -255
  864. data/lib/ultracart_api/models/customer_editor_values.rb +328 -317
  865. data/lib/ultracart_api/models/customer_email.rb +300 -265
  866. data/lib/ultracart_api/models/customer_email_list_changes.rb +234 -199
  867. data/lib/ultracart_api/models/customer_loyalty.rb +283 -278
  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 -810
  874. data/lib/ultracart_api/models/customer_quotes_summary.rb +250 -215
  875. data/lib/ultracart_api/models/customer_response.rb +256 -221
  876. data/lib/ultracart_api/models/customer_reviewer.rb +310 -275
  877. data/lib/ultracart_api/models/customer_shipping.rb +575 -540
  878. data/lib/ultracart_api/models/customer_software_entitlement.rb +365 -330
  879. data/lib/ultracart_api/models/customer_store_credit.rb +274 -239
  880. data/lib/ultracart_api/models/customer_store_credit_add_request.rb +250 -215
  881. data/lib/ultracart_api/models/customer_store_credit_ledger_entry.rb +295 -260
  882. data/lib/ultracart_api/models/customer_store_credit_response.rb +256 -221
  883. data/lib/ultracart_api/models/customer_tag.rb +235 -200
  884. data/lib/ultracart_api/models/customer_tax_codes.rb +260 -225
  885. data/lib/ultracart_api/models/customers_response.rb +258 -223
  886. data/lib/ultracart_api/models/data_tables_server_side_response.rb +248 -213
  887. data/lib/ultracart_api/models/distance.rb +264 -229
  888. data/lib/ultracart_api/models/distribution_center.rb +559 -674
  889. data/lib/ultracart_api/models/distribution_centers_response.rb +258 -223
  890. data/lib/ultracart_api/models/email_base_template_list_response.rb +221 -186
  891. data/lib/ultracart_api/models/email_campaign.rb +467 -472
  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 -534
  901. data/lib/ultracart_api/models/email_commseq_email_response.rb +256 -221
  902. data/lib/ultracart_api/models/email_commseq_email_send_test_request.rb +304 -269
  903. data/lib/ultracart_api/models/email_commseq_email_send_test_response.rb +247 -212
  904. data/lib/ultracart_api/models/email_commseq_emails_request.rb +258 -223
  905. data/lib/ultracart_api/models/email_commseq_emails_response.rb +258 -223
  906. data/lib/ultracart_api/models/email_commseq_postcard.rb +340 -305
  907. data/lib/ultracart_api/models/email_commseq_postcard_response.rb +256 -221
  908. data/lib/ultracart_api/models/email_commseq_postcard_send_test_request.rb +329 -294
  909. data/lib/ultracart_api/models/email_commseq_postcard_send_test_response.rb +274 -239
  910. data/lib/ultracart_api/models/email_commseq_postcards_request.rb +221 -186
  911. data/lib/ultracart_api/models/email_commseq_postcards_response.rb +258 -223
  912. data/lib/ultracart_api/models/email_commseq_response.rb +256 -221
  913. data/lib/ultracart_api/models/email_commseq_stat.rb +580 -545
  914. data/lib/ultracart_api/models/email_commseq_stat_response.rb +256 -221
  915. data/lib/ultracart_api/models/email_commseq_step.rb +348 -313
  916. data/lib/ultracart_api/models/email_commseq_step_log.rb +240 -205
  917. data/lib/ultracart_api/models/email_commseq_step_logs_response.rb +258 -223
  918. data/lib/ultracart_api/models/email_commseq_webhook_send_test_request.rb +275 -240
  919. data/lib/ultracart_api/models/email_commseq_webhook_send_test_response.rb +277 -242
  920. data/lib/ultracart_api/models/email_commseqs_response.rb +258 -223
  921. data/lib/ultracart_api/models/email_customer.rb +292 -257
  922. data/lib/ultracart_api/models/email_customer_editor_url_response.rb +256 -221
  923. data/lib/ultracart_api/models/email_customers_response.rb +262 -227
  924. data/lib/ultracart_api/models/email_dashboard_activity.rb +280 -245
  925. data/lib/ultracart_api/models/email_dashboard_activity_response.rb +258 -223
  926. data/lib/ultracart_api/models/email_dashboard_stats_response.rb +258 -223
  927. data/lib/ultracart_api/models/email_domain.rb +329 -294
  928. data/lib/ultracart_api/models/email_editor_token_response.rb +256 -221
  929. data/lib/ultracart_api/models/email_flow.rb +505 -500
  930. data/lib/ultracart_api/models/email_flow_back_populate_request.rb +230 -195
  931. data/lib/ultracart_api/models/email_flow_back_populate_response.rb +247 -212
  932. data/lib/ultracart_api/models/email_flow_folder.rb +275 -240
  933. data/lib/ultracart_api/models/email_flow_folder_response.rb +256 -221
  934. data/lib/ultracart_api/models/email_flow_folders_response.rb +258 -223
  935. data/lib/ultracart_api/models/email_flow_response.rb +256 -221
  936. data/lib/ultracart_api/models/email_flows_response.rb +258 -223
  937. data/lib/ultracart_api/models/email_global_settings.rb +219 -184
  938. data/lib/ultracart_api/models/email_global_settings_response.rb +256 -221
  939. data/lib/ultracart_api/models/email_global_unsubscribe_request.rb +219 -184
  940. data/lib/ultracart_api/models/email_global_unsubscribe_response.rb +219 -184
  941. data/lib/ultracart_api/models/email_histogram_property_names_response.rb +221 -186
  942. data/lib/ultracart_api/models/email_histogram_property_values_response.rb +221 -186
  943. data/lib/ultracart_api/models/email_list.rb +347 -312
  944. data/lib/ultracart_api/models/email_list_archive_response.rb +256 -221
  945. data/lib/ultracart_api/models/email_list_customer.rb +250 -215
  946. data/lib/ultracart_api/models/email_list_customers_response.rb +262 -227
  947. data/lib/ultracart_api/models/email_list_response.rb +256 -221
  948. data/lib/ultracart_api/models/email_list_segment_folder.rb +275 -240
  949. data/lib/ultracart_api/models/email_list_segment_folder_response.rb +256 -221
  950. data/lib/ultracart_api/models/email_list_segment_folders_response.rb +258 -223
  951. data/lib/ultracart_api/models/email_list_segment_membership.rb +250 -215
  952. data/lib/ultracart_api/models/email_list_segment_used_by.rb +240 -205
  953. data/lib/ultracart_api/models/email_list_subscribe_response.rb +228 -193
  954. data/lib/ultracart_api/models/email_lists_response.rb +258 -223
  955. data/lib/ultracart_api/models/email_order.rb +249 -214
  956. data/lib/ultracart_api/models/email_orders_response.rb +258 -223
  957. data/lib/ultracart_api/models/email_performance.rb +475 -440
  958. data/lib/ultracart_api/models/email_performance_customer_histogram.rb +222 -187
  959. data/lib/ultracart_api/models/email_performance_customer_histogram_period.rb +260 -225
  960. data/lib/ultracart_api/models/email_performance_daily.rb +280 -245
  961. data/lib/ultracart_api/models/email_performance_response.rb +256 -221
  962. data/lib/ultracart_api/models/email_plan.rb +365 -330
  963. data/lib/ultracart_api/models/email_plan_additional.rb +291 -256
  964. data/lib/ultracart_api/models/email_plan_response.rb +256 -221
  965. data/lib/ultracart_api/models/email_postcard_stat.rb +531 -496
  966. data/lib/ultracart_api/models/email_segment.rb +445 -420
  967. data/lib/ultracart_api/models/email_segment_archive_response.rb +256 -221
  968. data/lib/ultracart_api/models/email_segment_customer.rb +250 -215
  969. data/lib/ultracart_api/models/email_segment_customers_response.rb +262 -227
  970. data/lib/ultracart_api/models/email_segment_download_prepare_response.rb +283 -248
  971. data/lib/ultracart_api/models/email_segment_response.rb +256 -221
  972. data/lib/ultracart_api/models/email_segments_response.rb +258 -223
  973. data/lib/ultracart_api/models/email_sending_domain_response.rb +256 -221
  974. data/lib/ultracart_api/models/email_sending_domains_response.rb +258 -223
  975. data/lib/ultracart_api/models/email_settings.rb +318 -351
  976. data/lib/ultracart_api/models/email_settings_response.rb +256 -221
  977. data/lib/ultracart_api/models/email_stat.rb +591 -556
  978. data/lib/ultracart_api/models/email_stat_postcard_summary_request.rb +230 -195
  979. data/lib/ultracart_api/models/email_stat_postcard_summary_response.rb +258 -223
  980. data/lib/ultracart_api/models/email_stat_summary_request.rb +241 -206
  981. data/lib/ultracart_api/models/email_stat_summary_response.rb +258 -223
  982. data/lib/ultracart_api/models/email_step_stat.rb +410 -475
  983. data/lib/ultracart_api/models/email_step_stat_request.rb +230 -195
  984. data/lib/ultracart_api/models/email_step_stat_response.rb +258 -223
  985. data/lib/ultracart_api/models/email_step_waiting_request.rb +221 -186
  986. data/lib/ultracart_api/models/email_step_waiting_response.rb +221 -186
  987. data/lib/ultracart_api/models/email_template.rb +365 -330
  988. data/lib/ultracart_api/models/email_templates_response.rb +258 -223
  989. data/lib/ultracart_api/models/email_third_party_list.rb +230 -195
  990. data/lib/ultracart_api/models/email_third_party_list_import_request.rb +222 -187
  991. data/lib/ultracart_api/models/email_third_party_provider.rb +324 -289
  992. data/lib/ultracart_api/models/email_third_party_providers_response.rb +258 -223
  993. data/lib/ultracart_api/models/email_third_party_tag.rb +230 -195
  994. data/lib/ultracart_api/models/email_verify_token_request.rb +230 -195
  995. data/lib/ultracart_api/models/email_verify_token_response.rb +257 -222
  996. data/lib/ultracart_api/models/email_verify_token_validate_request.rb +220 -185
  997. data/lib/ultracart_api/models/email_verify_token_validate_response.rb +247 -212
  998. data/lib/ultracart_api/models/email_webhook_editor_values_response.rb +278 -243
  999. data/lib/ultracart_api/models/error.rb +260 -225
  1000. data/lib/ultracart_api/models/error_response.rb +247 -212
  1001. data/lib/ultracart_api/models/experiment.rb +426 -463
  1002. data/lib/ultracart_api/models/experiment_response.rb +256 -221
  1003. data/lib/ultracart_api/models/experiment_variation.rb +432 -407
  1004. data/lib/ultracart_api/models/experiment_variation_stat.rb +320 -307
  1005. data/lib/ultracart_api/models/experiments_response.rb +258 -223
  1006. data/lib/ultracart_api/models/fulfillment_inventory.rb +228 -193
  1007. data/lib/ultracart_api/models/fulfillment_shipment.rb +262 -227
  1008. data/lib/ultracart_api/models/geo_point.rb +228 -193
  1009. data/lib/ultracart_api/models/geocode_request.rb +260 -225
  1010. data/lib/ultracart_api/models/geocode_response.rb +265 -230
  1011. data/lib/ultracart_api/models/gift_certificate.rb +367 -332
  1012. data/lib/ultracart_api/models/gift_certificate_create_request.rb +260 -225
  1013. data/lib/ultracart_api/models/gift_certificate_ledger_entry.rb +285 -250
  1014. data/lib/ultracart_api/models/gift_certificate_query.rb +300 -265
  1015. data/lib/ultracart_api/models/gift_certificate_response.rb +256 -221
  1016. data/lib/ultracart_api/models/gift_certificates_response.rb +258 -223
  1017. data/lib/ultracart_api/models/group.rb +266 -231
  1018. data/lib/ultracart_api/models/group_response.rb +256 -221
  1019. data/lib/ultracart_api/models/group_user_membership.rb +260 -225
  1020. data/lib/ultracart_api/models/groups_response.rb +258 -223
  1021. data/lib/ultracart_api/models/http_header.rb +230 -195
  1022. data/lib/ultracart_api/models/integration_log.rb +379 -355
  1023. data/lib/ultracart_api/models/integration_log_file.rb +246 -211
  1024. data/lib/ultracart_api/models/integration_log_log.rb +228 -193
  1025. data/lib/ultracart_api/models/integration_log_query_filter_values.rb +340 -305
  1026. data/lib/ultracart_api/models/integration_log_query_request.rb +333 -329
  1027. data/lib/ultracart_api/models/integration_log_query_response.rb +267 -232
  1028. data/lib/ultracart_api/models/integration_log_response.rb +256 -221
  1029. data/lib/ultracart_api/models/integration_log_summary.rb +291 -256
  1030. data/lib/ultracart_api/models/integration_log_summary_query_request.rb +230 -195
  1031. data/lib/ultracart_api/models/integration_log_summary_query_response.rb +258 -223
  1032. data/lib/ultracart_api/models/item.rb +748 -713
  1033. data/lib/ultracart_api/models/item_accounting.rb +260 -225
  1034. data/lib/ultracart_api/models/item_amember.rb +245 -210
  1035. data/lib/ultracart_api/models/item_auto_order.rb +403 -418
  1036. data/lib/ultracart_api/models/item_auto_order_step.rb +413 -398
  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 -356
  1046. data/lib/ultracart_api/models/item_content_assignment.rb +285 -250
  1047. data/lib/ultracart_api/models/item_content_attribute.rb +280 -245
  1048. data/lib/ultracart_api/models/item_content_multimedia.rb +441 -406
  1049. data/lib/ultracart_api/models/item_content_multimedia_thumbnail.rb +270 -235
  1050. data/lib/ultracart_api/models/item_digital_delivery.rb +317 -282
  1051. data/lib/ultracart_api/models/item_digital_item.rb +305 -334
  1052. data/lib/ultracart_api/models/item_ebay.rb +901 -866
  1053. data/lib/ultracart_api/models/item_ebay_category_specific.rb +230 -195
  1054. data/lib/ultracart_api/models/item_ebay_market_listing.rb +260 -225
  1055. data/lib/ultracart_api/models/item_ebay_market_place_analysis.rb +311 -276
  1056. data/lib/ultracart_api/models/item_email_notifications.rb +230 -195
  1057. data/lib/ultracart_api/models/item_enrollment123.rb +220 -185
  1058. data/lib/ultracart_api/models/item_fulfillment_addon.rb +250 -225
  1059. data/lib/ultracart_api/models/item_gift_certificate.rb +230 -195
  1060. data/lib/ultracart_api/models/item_google_product_search.rb +1289 -1254
  1061. data/lib/ultracart_api/models/item_identifiers.rb +310 -375
  1062. data/lib/ultracart_api/models/item_instant_payment_notification.rb +270 -235
  1063. data/lib/ultracart_api/models/item_instant_payment_notifications.rb +222 -187
  1064. data/lib/ultracart_api/models/item_internal.rb +235 -200
  1065. data/lib/ultracart_api/models/item_kit_component.rb +260 -225
  1066. data/lib/ultracart_api/models/item_kit_definition.rb +222 -187
  1067. data/lib/ultracart_api/models/item_option.rb +416 -381
  1068. data/lib/ultracart_api/models/item_option_value.rb +409 -374
  1069. data/lib/ultracart_api/models/item_option_value_additional_item.rb +230 -195
  1070. data/lib/ultracart_api/models/item_option_value_digital_item.rb +230 -195
  1071. data/lib/ultracart_api/models/item_payment_processing.rb +264 -239
  1072. data/lib/ultracart_api/models/item_physical.rb +246 -211
  1073. data/lib/ultracart_api/models/item_pricing.rb +422 -387
  1074. data/lib/ultracart_api/models/item_pricing_tier.rb +261 -226
  1075. data/lib/ultracart_api/models/item_pricing_tier_discount.rb +230 -195
  1076. data/lib/ultracart_api/models/item_pricing_tier_limit.rb +240 -227
  1077. data/lib/ultracart_api/models/item_property.rb +270 -235
  1078. data/lib/ultracart_api/models/item_realtime_pricing.rb +240 -205
  1079. data/lib/ultracart_api/models/item_related.rb +242 -207
  1080. data/lib/ultracart_api/models/item_related_item.rb +274 -239
  1081. data/lib/ultracart_api/models/item_reporting.rb +232 -197
  1082. data/lib/ultracart_api/models/item_response.rb +256 -221
  1083. data/lib/ultracart_api/models/item_restriction.rb +292 -267
  1084. data/lib/ultracart_api/models/item_restriction_item.rb +274 -239
  1085. data/lib/ultracart_api/models/item_revguard.rb +280 -245
  1086. data/lib/ultracart_api/models/item_reviews.rb +300 -276
  1087. data/lib/ultracart_api/models/item_salesforce.rb +230 -195
  1088. data/lib/ultracart_api/models/item_shipping.rb +713 -698
  1089. data/lib/ultracart_api/models/item_shipping_case.rb +265 -230
  1090. data/lib/ultracart_api/models/item_shipping_destination_markup.rb +315 -290
  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 -369
  1094. data/lib/ultracart_api/models/item_shipping_package_requirement.rb +230 -195
  1095. data/lib/ultracart_api/models/item_tag.rb +279 -244
  1096. data/lib/ultracart_api/models/item_tags.rb +222 -187
  1097. data/lib/ultracart_api/models/item_tax.rb +286 -251
  1098. data/lib/ultracart_api/models/item_tax_exemption.rb +335 -300
  1099. data/lib/ultracart_api/models/item_third_party_email_marketing.rb +302 -267
  1100. data/lib/ultracart_api/models/item_variant_item.rb +289 -254
  1101. data/lib/ultracart_api/models/item_variation.rb +292 -257
  1102. data/lib/ultracart_api/models/item_variation_option.rb +265 -230
  1103. data/lib/ultracart_api/models/item_wishlist_member.rb +255 -220
  1104. data/lib/ultracart_api/models/items_request.rb +222 -187
  1105. data/lib/ultracart_api/models/items_response.rb +259 -224
  1106. data/lib/ultracart_api/models/key_value.rb +240 -205
  1107. data/lib/ultracart_api/models/library_filter_values.rb +254 -219
  1108. data/lib/ultracart_api/models/library_filter_values_response.rb +256 -221
  1109. data/lib/ultracart_api/models/library_item.rb +606 -571
  1110. data/lib/ultracart_api/models/library_item_account.rb +237 -202
  1111. data/lib/ultracart_api/models/library_item_asset.rb +228 -193
  1112. data/lib/ultracart_api/models/library_item_attribute.rb +228 -193
  1113. data/lib/ultracart_api/models/library_item_email.rb +237 -202
  1114. data/lib/ultracart_api/models/library_item_published_meta.rb +290 -255
  1115. data/lib/ultracart_api/models/library_item_purchased_meta.rb +240 -205
  1116. data/lib/ultracart_api/models/library_item_query.rb +330 -295
  1117. data/lib/ultracart_api/models/library_item_response.rb +256 -221
  1118. data/lib/ultracart_api/models/library_item_screenshot.rb +228 -193
  1119. data/lib/ultracart_api/models/library_items_response.rb +259 -224
  1120. data/lib/ultracart_api/models/linked_account.rb +240 -205
  1121. data/lib/ultracart_api/models/list_segment_membership.rb +237 -202
  1122. data/lib/ultracart_api/models/lookup_request.rb +255 -229
  1123. data/lib/ultracart_api/models/lookup_response.rb +258 -223
  1124. data/lib/ultracart_api/models/mailgun.rb +219 -184
  1125. data/lib/ultracart_api/models/metric.rb +282 -247
  1126. data/lib/ultracart_api/models/notification.rb +322 -287
  1127. data/lib/ultracart_api/models/oauth_revoke_success_response.rb +230 -195
  1128. data/lib/ultracart_api/models/oauth_token_response.rb +321 -286
  1129. data/lib/ultracart_api/models/order.rb +604 -622
  1130. data/lib/ultracart_api/models/order_affiliate.rb +242 -207
  1131. data/lib/ultracart_api/models/order_affiliate_ledger.rb +334 -299
  1132. data/lib/ultracart_api/models/order_auto_order.rb +448 -413
  1133. data/lib/ultracart_api/models/order_billing.rb +597 -612
  1134. data/lib/ultracart_api/models/order_buysafe.rb +268 -233
  1135. data/lib/ultracart_api/models/order_by_token_query.rb +220 -185
  1136. data/lib/ultracart_api/models/order_channel_partner.rb +335 -300
  1137. data/lib/ultracart_api/models/order_checkout.rb +469 -509
  1138. data/lib/ultracart_api/models/order_coupon.rb +290 -255
  1139. data/lib/ultracart_api/models/order_digital_item.rb +290 -255
  1140. data/lib/ultracart_api/models/order_digital_order.rb +262 -227
  1141. data/lib/ultracart_api/models/order_edi.rb +265 -230
  1142. data/lib/ultracart_api/models/order_format.rb +404 -369
  1143. data/lib/ultracart_api/models/order_format_response.rb +232 -197
  1144. data/lib/ultracart_api/models/order_fraud_score.rb +444 -409
  1145. data/lib/ultracart_api/models/order_gift.rb +351 -316
  1146. data/lib/ultracart_api/models/order_gift_certificate.rb +239 -204
  1147. data/lib/ultracart_api/models/order_internal.rb +275 -252
  1148. data/lib/ultracart_api/models/order_item.rb +889 -1028
  1149. data/lib/ultracart_api/models/order_item_edi.rb +234 -199
  1150. data/lib/ultracart_api/models/order_item_edi_identification.rb +230 -195
  1151. data/lib/ultracart_api/models/order_item_edi_lot.rb +240 -205
  1152. data/lib/ultracart_api/models/order_item_option.rb +378 -343
  1153. data/lib/ultracart_api/models/order_item_option_file_attachment.rb +250 -215
  1154. data/lib/ultracart_api/models/order_item_property.rb +280 -245
  1155. data/lib/ultracart_api/models/order_item_tag.rb +235 -200
  1156. data/lib/ultracart_api/models/order_linked_shipment.rb +264 -229
  1157. data/lib/ultracart_api/models/order_marketing.rb +270 -245
  1158. data/lib/ultracart_api/models/order_packing_slip_response.rb +257 -222
  1159. data/lib/ultracart_api/models/order_payment.rb +432 -415
  1160. data/lib/ultracart_api/models/order_payment_check.rb +220 -185
  1161. data/lib/ultracart_api/models/order_payment_credit_card.rb +354 -328
  1162. data/lib/ultracart_api/models/order_payment_e_check.rb +476 -441
  1163. data/lib/ultracart_api/models/order_payment_insurance.rb +250 -215
  1164. data/lib/ultracart_api/models/order_payment_purchase_order.rb +220 -185
  1165. data/lib/ultracart_api/models/order_payment_transaction.rb +252 -227
  1166. data/lib/ultracart_api/models/order_payment_transaction_detail.rb +240 -205
  1167. data/lib/ultracart_api/models/order_process_payment_request.rb +230 -195
  1168. data/lib/ultracart_api/models/order_process_payment_response.rb +256 -221
  1169. data/lib/ultracart_api/models/order_property.rb +280 -280
  1170. data/lib/ultracart_api/models/order_query.rb +826 -843
  1171. data/lib/ultracart_api/models/order_query_batch.rb +222 -231
  1172. data/lib/ultracart_api/models/order_quote.rb +240 -205
  1173. data/lib/ultracart_api/models/order_replacement.rb +467 -432
  1174. data/lib/ultracart_api/models/order_replacement_item.rb +255 -220
  1175. data/lib/ultracart_api/models/order_replacement_response.rb +264 -229
  1176. data/lib/ultracart_api/models/order_response.rb +256 -221
  1177. data/lib/ultracart_api/models/order_salesforce.rb +220 -185
  1178. data/lib/ultracart_api/models/order_shipping.rb +770 -745
  1179. data/lib/ultracart_api/models/order_summary.rb +390 -411
  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 -528
  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 -205
  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 -258
  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 -205
  1287. data/lib/ultracart_api/models/upload_coupon_codes_request.rb +259 -224
  1288. data/lib/ultracart_api/models/upload_coupon_codes_response.rb +283 -248
  1289. data/lib/ultracart_api/models/user.rb +377 -342
  1290. data/lib/ultracart_api/models/user_group_membership.rb +240 -205
  1291. data/lib/ultracart_api/models/user_login.rb +250 -215
  1292. data/lib/ultracart_api/models/user_logins_response.rb +259 -224
  1293. data/lib/ultracart_api/models/user_response.rb +256 -221
  1294. data/lib/ultracart_api/models/users_response.rb +258 -223
  1295. data/lib/ultracart_api/models/verification_record.rb +237 -202
  1296. data/lib/ultracart_api/models/warning.rb +230 -195
  1297. data/lib/ultracart_api/models/webhook.rb +437 -412
  1298. data/lib/ultracart_api/models/webhook_event_category.rb +264 -229
  1299. data/lib/ultracart_api/models/webhook_event_subscription.rb +300 -275
  1300. data/lib/ultracart_api/models/webhook_log.rb +324 -299
  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/{custom_reports_execution_response.rb → webhook_sample_request.rb} +252 -234
  1306. data/lib/ultracart_api/models/{customer_wish_list_items_response.rb → webhook_sample_request_response.rb} +256 -223
  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 -963
  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 +17 -725
  1316. data/docs/AccountsReceivableRetryTransactionReject.md +0 -9
  1317. data/docs/AutoOrderAddonItem.md +0 -13
  1318. data/docs/AutoOrderAddonItemOption.md +0 -9
  1319. data/docs/AutoOrderConsolidate.md +0 -8
  1320. data/docs/AutoOrderManagement.md +0 -8
  1321. data/docs/CartItemProperty.md +0 -11
  1322. data/docs/CartPaymentHealthBenefitCard.md +0 -13
  1323. data/docs/ChanelPartnerReasonCodesResponse.md +0 -18
  1324. data/docs/ChannelPartner.md +0 -15
  1325. data/docs/ChannelPartnerOrderItemProperty.md +0 -11
  1326. data/docs/ChannelPartnerShipToPreference.md +0 -14
  1327. data/docs/ChannelPartnerShipToPreferenceResponse.md +0 -12
  1328. data/docs/ChannelPartnerShipToPreferencesResponse.md +0 -12
  1329. data/docs/ChannelPartnersResponse.md +0 -12
  1330. data/docs/Conversation.md +0 -28
  1331. data/docs/ConversationAgentAuth.md +0 -22
  1332. data/docs/ConversationAgentAuthResponse.md +0 -12
  1333. data/docs/ConversationAgentProfile.md +0 -22
  1334. data/docs/ConversationAgentProfileResponse.md +0 -12
  1335. data/docs/ConversationAgentProfilesResponse.md +0 -12
  1336. data/docs/ConversationApi.md +0 -4975
  1337. data/docs/ConversationAutocompleteRequest.md +0 -9
  1338. data/docs/ConversationAutocompleteResponse.md +0 -14
  1339. data/docs/ConversationAutocompleteValue.md +0 -9
  1340. data/docs/ConversationCannedMessage.md +0 -11
  1341. data/docs/ConversationCannedMessageResponse.md +0 -12
  1342. data/docs/ConversationCannedMessagesResponse.md +0 -12
  1343. data/docs/ConversationCannedMessagesSearch.md +0 -9
  1344. data/docs/ConversationDeleteKnowledgeBaseDocumentResponse.md +0 -12
  1345. data/docs/ConversationDepartment.md +0 -12
  1346. data/docs/ConversationDepartmentMember.md +0 -10
  1347. data/docs/ConversationDepartmentMembersResponse.md +0 -12
  1348. data/docs/ConversationDepartmentResponse.md +0 -12
  1349. data/docs/ConversationDepartmentSettings.md +0 -7
  1350. data/docs/ConversationDepartmentsResponse.md +0 -12
  1351. data/docs/ConversationEngagement.md +0 -16
  1352. data/docs/ConversationEngagementEquation.md +0 -8
  1353. data/docs/ConversationEngagementEquationFunction.md +0 -21
  1354. data/docs/ConversationEngagementEquationGroup.md +0 -8
  1355. data/docs/ConversationEngagementResponse.md +0 -12
  1356. data/docs/ConversationEngagementsResponse.md +0 -12
  1357. data/docs/ConversationEventAddCoupon.md +0 -10
  1358. data/docs/ConversationEventAddItem.md +0 -10
  1359. data/docs/ConversationEventQueuePosition.md +0 -9
  1360. data/docs/ConversationEventRRWeb.md +0 -14
  1361. data/docs/ConversationEventReadMessage.md +0 -10
  1362. data/docs/ConversationEventTyping.md +0 -10
  1363. data/docs/ConversationEventWebchatContext.md +0 -10
  1364. data/docs/ConversationInsertKnowledgeBaseDocumentRequest.md +0 -9
  1365. data/docs/ConversationInsertKnowledgeBaseDocumentResponse.md +0 -14
  1366. data/docs/ConversationJoinRequest.md +0 -8
  1367. data/docs/ConversationKnowledgeBaseDocument.md +0 -15
  1368. data/docs/ConversationKnowledgeBaseDocumentUploadUrl.md +0 -9
  1369. data/docs/ConversationKnowledgeBaseDocumentUploadUrlResponse.md +0 -12
  1370. data/docs/ConversationKnowledgeBaseDocumentsResponse.md +0 -12
  1371. data/docs/ConversationLocationCountry.md +0 -10
  1372. data/docs/ConversationLocationStateProvince.md +0 -9
  1373. data/docs/ConversationLocationsResponse.md +0 -12
  1374. data/docs/ConversationMcpServer.md +0 -15
  1375. data/docs/ConversationMcpServerResponse.md +0 -12
  1376. data/docs/ConversationMcpServerToolsResponse.md +0 -12
  1377. data/docs/ConversationMcpServersResponse.md +0 -12
  1378. data/docs/ConversationMessage.md +0 -23
  1379. data/docs/ConversationMessageTranslation.md +0 -9
  1380. data/docs/ConversationMessageTransportStatus.md +0 -9
  1381. data/docs/ConversationMessagesResponse.md +0 -12
  1382. data/docs/ConversationMultimediaUploadUrl.md +0 -9
  1383. data/docs/ConversationMultimediaUploadUrlResponse.md +0 -12
  1384. data/docs/ConversationParticipant.md +0 -20
  1385. data/docs/ConversationPbxAgent.md +0 -23
  1386. data/docs/ConversationPbxAgentResponse.md +0 -12
  1387. data/docs/ConversationPbxAgentsResponse.md +0 -12
  1388. data/docs/ConversationPbxAudio.md +0 -17
  1389. data/docs/ConversationPbxAudioResponse.md +0 -12
  1390. data/docs/ConversationPbxAudioUploadUrl.md +0 -9
  1391. data/docs/ConversationPbxAudioUploadUrlResponse.md +0 -12
  1392. data/docs/ConversationPbxAudioUsageResponse.md +0 -14
  1393. data/docs/ConversationPbxAudiosResponse.md +0 -12
  1394. data/docs/ConversationPbxCustomerSnapshotRequest.md +0 -15
  1395. data/docs/ConversationPbxCustomerSnapshotResponse.md +0 -14
  1396. data/docs/ConversationPbxMenu.md +0 -18
  1397. data/docs/ConversationPbxMenuMapping.md +0 -11
  1398. data/docs/ConversationPbxMenuResponse.md +0 -12
  1399. data/docs/ConversationPbxMenusResponse.md +0 -12
  1400. data/docs/ConversationPbxPhoneNumber.md +0 -12
  1401. data/docs/ConversationPbxPhoneNumberResponse.md +0 -12
  1402. data/docs/ConversationPbxPhoneNumbersResponse.md +0 -12
  1403. data/docs/ConversationPbxQueue.md +0 -28
  1404. data/docs/ConversationPbxQueueMembers.md +0 -9
  1405. data/docs/ConversationPbxQueueResponse.md +0 -12
  1406. data/docs/ConversationPbxQueuesResponse.md +0 -12
  1407. data/docs/ConversationPbxTimeBased.md +0 -11
  1408. data/docs/ConversationPbxTimeBasedMapping.md +0 -11
  1409. data/docs/ConversationPbxTimeBasedMappingConfig.md +0 -9
  1410. data/docs/ConversationPbxTimeBasedResponse.md +0 -12
  1411. data/docs/ConversationPbxTimeBasedsResponse.md +0 -12
  1412. data/docs/ConversationPbxTimeRange.md +0 -12
  1413. data/docs/ConversationPbxTimeRangeConfig.md +0 -13
  1414. data/docs/ConversationPbxTimeRangeResponse.md +0 -12
  1415. data/docs/ConversationPbxTimeRangesResponse.md +0 -12
  1416. data/docs/ConversationPbxVoicemailMailbox.md +0 -19
  1417. data/docs/ConversationPbxVoicemailMailboxResponse.md +0 -12
  1418. data/docs/ConversationPbxVoicemailMailboxesResponse.md +0 -12
  1419. data/docs/ConversationPbxVoicemailMessage.md +0 -20
  1420. data/docs/ConversationPbxVoicemailMessageResponse.md +0 -12
  1421. data/docs/ConversationPbxVoicemailMessageSummariesResponse.md +0 -12
  1422. data/docs/ConversationPbxVoicemailMessageSummary.md +0 -17
  1423. data/docs/ConversationPermissions.md +0 -8
  1424. data/docs/ConversationPermissionsResponse.md +0 -12
  1425. data/docs/ConversationResponse.md +0 -12
  1426. data/docs/ConversationSearchRequest.md +0 -19
  1427. data/docs/ConversationSearchResponse.md +0 -11
  1428. data/docs/ConversationSentiment.md +0 -13
  1429. data/docs/ConversationStartRequest.md +0 -10
  1430. data/docs/ConversationStartResponse.md +0 -8
  1431. data/docs/ConversationSummary.md +0 -24
  1432. data/docs/ConversationTwilioAccount.md +0 -9
  1433. data/docs/ConversationVirtualAgentBudget.md +0 -11
  1434. data/docs/ConversationVirtualAgentBudgetResponse.md +0 -12
  1435. data/docs/ConversationVirtualAgentCapabilities.md +0 -23
  1436. data/docs/ConversationVirtualAgentCapabilitiesResponse.md +0 -12
  1437. data/docs/ConversationVirtualAgentCapabilityZohoDeskDepartment.md +0 -9
  1438. data/docs/ConversationWebchatContext.md +0 -15
  1439. data/docs/ConversationWebchatQueueStatus.md +0 -22
  1440. data/docs/ConversationWebchatQueueStatusAgent.md +0 -13
  1441. data/docs/ConversationWebchatQueueStatusQueueEntry.md +0 -15
  1442. data/docs/ConversationWebchatQueueStatusUpdateRequest.md +0 -8
  1443. data/docs/ConversationWebchatQueueStatusesResponse.md +0 -12
  1444. data/docs/ConversationWebsocketMessage.md +0 -31
  1445. data/docs/ConversationsResponse.md +0 -12
  1446. data/docs/CouponFreeItemWithItemPurchaseAndFreeShipping.md +0 -12
  1447. data/docs/CouponMoreLoyaltyCashback.md +0 -8
  1448. data/docs/CouponMoreLoyaltyPoints.md +0 -8
  1449. data/docs/CouponNoDiscount.md +0 -8
  1450. data/docs/CouponPercentMoreLoyaltyCashback.md +0 -8
  1451. data/docs/CouponPercentMoreLoyaltyPoints.md +0 -8
  1452. data/docs/CouponTieredPercentOffSubtotalBasedOnMSRP.md +0 -9
  1453. data/docs/CustomDashboard.md +0 -12
  1454. data/docs/CustomDashboardExecutionParameter.md +0 -11
  1455. data/docs/CustomDashboardPage.md +0 -10
  1456. data/docs/CustomDashboardPageReport.md +0 -12
  1457. data/docs/CustomDashboardResponse.md +0 -12
  1458. data/docs/CustomDashboardSchedule.md +0 -12
  1459. data/docs/CustomDashboardScheduleResponse.md +0 -12
  1460. data/docs/CustomDashboardSchedulesResponse.md +0 -12
  1461. data/docs/CustomDashboardsResponse.md +0 -12
  1462. data/docs/CustomReport.md +0 -18
  1463. data/docs/CustomReportAccountConfig.md +0 -18
  1464. data/docs/CustomReportAccountConfigResponse.md +0 -12
  1465. data/docs/CustomReportAnalysisRequest.md +0 -9
  1466. data/docs/CustomReportAnalysisResponse.md +0 -12
  1467. data/docs/CustomReportChartPngUploadResponse.md +0 -13
  1468. data/docs/CustomReportExecutionParameter.md +0 -11
  1469. data/docs/CustomReportExecutionRequest.md +0 -8
  1470. data/docs/CustomReportExecutionResponse.md +0 -15
  1471. data/docs/CustomReportParameter.md +0 -13
  1472. data/docs/CustomReportParameterOption.md +0 -9
  1473. data/docs/CustomReportQuery.md +0 -13
  1474. data/docs/CustomReportResponse.md +0 -12
  1475. data/docs/CustomReportTooltip.md +0 -9
  1476. data/docs/CustomReportUsageBreakdown.md +0 -9
  1477. data/docs/CustomReportsExecutionReportData.md +0 -10
  1478. data/docs/CustomReportsExecutionRequest.md +0 -9
  1479. data/docs/CustomReportsExecutionResponse.md +0 -13
  1480. data/docs/CustomReportsResponse.md +0 -12
  1481. data/docs/CustomerEDI.md +0 -10
  1482. data/docs/CustomerMagicLinkResponse.md +0 -12
  1483. data/docs/CustomerMergeRequest.md +0 -9
  1484. data/docs/CustomerProperty.md +0 -11
  1485. data/docs/CustomerWishListItem.md +0 -14
  1486. data/docs/CustomerWishListItemResponse.md +0 -12
  1487. data/docs/CustomerWishListItemsResponse.md +0 -12
  1488. data/docs/DatawarehouseApi.md +0 -1538
  1489. data/docs/EmailCommseqSequenceTestRequest.md +0 -22
  1490. data/docs/EmailCommseqSequenceTestResponse.md +0 -11
  1491. data/docs/EmailCommseqSmsSendTestRequest.md +0 -10
  1492. data/docs/EmailCommseqSmsSendTestResponse.md +0 -13
  1493. data/docs/EmailEditorValuesResponse.md +0 -12
  1494. data/docs/EmailPostcardTracking.md +0 -32
  1495. data/docs/EmailPostcardTrackingResponse.md +0 -12
  1496. data/docs/EmailRateLimiter.md +0 -10
  1497. data/docs/EmailRateLimitersResponse.md +0 -12
  1498. data/docs/EmailSmsOrder.md +0 -11
  1499. data/docs/EmailSmsOrdersResponse.md +0 -12
  1500. data/docs/EmailSmsStat.md +0 -37
  1501. data/docs/EmailStatSmsSummaryRequest.md +0 -9
  1502. data/docs/EmailStatSmsSummaryResponse.md +0 -12
  1503. data/docs/FileManagerDirectory.md +0 -20
  1504. data/docs/FileManagerFile.md +0 -29
  1505. data/docs/FileManagerPage.md +0 -15
  1506. data/docs/FileManagerPageResponse.md +0 -12
  1507. data/docs/FileManagerUploadRequest.md +0 -10
  1508. data/docs/FileManagerUploadUrlResponse.md +0 -13
  1509. data/docs/HitPageView.md +0 -18
  1510. data/docs/HitPageViewMetaData.md +0 -9
  1511. data/docs/HitSessionStart.md +0 -24
  1512. data/docs/HitSessionUtm.md +0 -22
  1513. data/docs/ItemDigitalItemPdfMeta.md +0 -18
  1514. data/docs/ItemDigitalItemResponse.md +0 -12
  1515. data/docs/ItemDigitalItemsResponse.md +0 -12
  1516. data/docs/ItemInventorySnapshot.md +0 -13
  1517. data/docs/ItemInventorySnapshotDistributionCenter.md +0 -12
  1518. data/docs/ItemInventorySnapshotResponse.md +0 -12
  1519. data/docs/ItemReview.md +0 -45
  1520. data/docs/ItemReviewResponse.md +0 -12
  1521. data/docs/ItemReviewsResponse.md +0 -12
  1522. data/docs/OrderAssignToAffiliateRequest.md +0 -10
  1523. data/docs/OrderCurrentStageHistory.md +0 -10
  1524. data/docs/OrderEdiDocument.md +0 -21
  1525. data/docs/OrderEdiDocumentsResponse.md +0 -12
  1526. data/docs/OrderInvoiceResponse.md +0 -12
  1527. data/docs/OrderPaymentCreditCardDualVaulted.md +0 -10
  1528. data/docs/OrderPaymentCreditCardDualVaultedProperty.md +0 -9
  1529. data/docs/OrderPaymentHealthBenefitCard.md +0 -13
  1530. data/docs/OrderPaymentPayPal.md +0 -9
  1531. data/docs/OrderPointOfSale.md +0 -10
  1532. data/docs/OrderReason.md +0 -10
  1533. data/docs/OrderRefundableResponse.md +0 -20
  1534. data/docs/OrderTransactionalMerchantNote.md +0 -11
  1535. data/docs/OrderUtm.md +0 -39
  1536. data/docs/OrderValidationRequest.md +0 -9
  1537. data/docs/OrderValidationResponse.md +0 -10
  1538. data/docs/PointOfSaleLocation.md +0 -17
  1539. data/docs/PointOfSaleReader.md +0 -16
  1540. data/docs/PointOfSaleRegister.md +0 -11
  1541. data/docs/ReplaceOrderItemIdRequest.md +0 -11
  1542. data/docs/Report.md +0 -18
  1543. data/docs/ReportAuth.md +0 -11
  1544. data/docs/ReportAuthResponse.md +0 -12
  1545. data/docs/ReportDataSet.md +0 -24
  1546. data/docs/ReportDataSetColumn.md +0 -13
  1547. data/docs/ReportDataSetPage.md +0 -17
  1548. data/docs/ReportDataSetPageResponse.md +0 -12
  1549. data/docs/ReportDataSetQuery.md +0 -20
  1550. data/docs/ReportDataSetQueryOrderByColumn.md +0 -9
  1551. data/docs/ReportDataSetResponse.md +0 -12
  1552. data/docs/ReportDataSetRow.md +0 -8
  1553. data/docs/ReportDataSetSchema.md +0 -10
  1554. data/docs/ReportDataSource.md +0 -14
  1555. data/docs/ReportDataSourceSchema.md +0 -11
  1556. data/docs/ReportDryRunQueriesRequest.md +0 -13
  1557. data/docs/ReportDryRunQueriesResponse.md +0 -8
  1558. data/docs/ReportDryRunQueryResult.md +0 -9
  1559. data/docs/ReportExecuteQueriesRequest.md +0 -15
  1560. data/docs/ReportFilter.md +0 -13
  1561. data/docs/ReportFilterConnection.md +0 -10
  1562. data/docs/ReportPage.md +0 -13
  1563. data/docs/ReportPageFilter.md +0 -11
  1564. data/docs/ReportPageVisualization.md +0 -17
  1565. data/docs/ReportPageVisualizationDimension.md +0 -14
  1566. data/docs/ReportPageVisualizationMetric.md +0 -11
  1567. data/docs/ReportResponse.md +0 -12
  1568. data/docs/ReportWebsocketEvent.md +0 -9
  1569. data/docs/ReportsResponse.md +0 -12
  1570. data/docs/RulerValidationRequest.md +0 -8
  1571. data/docs/RulerValidationResponse.md +0 -9
  1572. data/docs/StoreFront.md +0 -18
  1573. data/docs/StoreFrontPageContentAttribute.md +0 -11
  1574. data/docs/StoreFrontsResponse.md +0 -12
  1575. data/docs/WebhookReflow.md +0 -9
  1576. data/docs/WebhookReflowResponse.md +0 -12
  1577. data/docs/WorkflowAgentAuth.md +0 -10
  1578. data/docs/WorkflowAgentAuthResponse.md +0 -12
  1579. data/docs/WorkflowApi.md +0 -620
  1580. data/docs/WorkflowAttachment.md +0 -12
  1581. data/docs/WorkflowAttachmentUploadUrl.md +0 -9
  1582. data/docs/WorkflowAttachmentUploadUrlResponse.md +0 -12
  1583. data/docs/WorkflowGroup.md +0 -9
  1584. data/docs/WorkflowGroupsResponse.md +0 -12
  1585. data/docs/WorkflowNote.md +0 -13
  1586. data/docs/WorkflowTask.md +0 -39
  1587. data/docs/WorkflowTaskHistory.md +0 -11
  1588. data/docs/WorkflowTaskOpenCountResponse.md +0 -12
  1589. data/docs/WorkflowTaskResponse.md +0 -12
  1590. data/docs/WorkflowTaskTagsResponse.md +0 -12
  1591. data/docs/WorkflowTasksRequest.md +0 -27
  1592. data/docs/WorkflowTasksResponse.md +0 -13
  1593. data/docs/WorkflowUser.md +0 -10
  1594. data/docs/WorkflowUserResponse.md +0 -12
  1595. data/docs/WorkflowUsersResponse.md +0 -13
  1596. data/lib/ultracart_api/api/conversation_api.rb +0 -5443
  1597. data/lib/ultracart_api/api/datawarehouse_api.rb +0 -1711
  1598. data/lib/ultracart_api/api/workflow_api.rb +0 -693
  1599. data/lib/ultracart_api/models/accounts_receivable_retry_transaction_reject.rb +0 -195
  1600. data/lib/ultracart_api/models/auto_order_addon_item.rb +0 -232
  1601. data/lib/ultracart_api/models/auto_order_addon_item_option.rb +0 -225
  1602. data/lib/ultracart_api/models/auto_order_consolidate.rb +0 -186
  1603. data/lib/ultracart_api/models/auto_order_management.rb +0 -185
  1604. data/lib/ultracart_api/models/cart_item_property.rb +0 -245
  1605. data/lib/ultracart_api/models/cart_payment_health_benefit_card.rb +0 -235
  1606. data/lib/ultracart_api/models/chanel_partner_reason_codes_response.rb +0 -290
  1607. data/lib/ultracart_api/models/channel_partner.rb +0 -255
  1608. data/lib/ultracart_api/models/channel_partner_order_item_property.rb +0 -245
  1609. data/lib/ultracart_api/models/channel_partner_ship_to_preference.rb +0 -262
  1610. data/lib/ultracart_api/models/channel_partner_ship_to_preference_response.rb +0 -221
  1611. data/lib/ultracart_api/models/channel_partner_ship_to_preferences_response.rb +0 -224
  1612. data/lib/ultracart_api/models/channel_partners_response.rb +0 -224
  1613. data/lib/ultracart_api/models/conversation.rb +0 -410
  1614. data/lib/ultracart_api/models/conversation_agent_auth.rb +0 -316
  1615. data/lib/ultracart_api/models/conversation_agent_auth_response.rb +0 -221
  1616. data/lib/ultracart_api/models/conversation_agent_profile.rb +0 -363
  1617. data/lib/ultracart_api/models/conversation_agent_profile_response.rb +0 -221
  1618. data/lib/ultracart_api/models/conversation_agent_profiles_response.rb +0 -223
  1619. data/lib/ultracart_api/models/conversation_autocomplete_request.rb +0 -193
  1620. data/lib/ultracart_api/models/conversation_autocomplete_response.rb +0 -241
  1621. data/lib/ultracart_api/models/conversation_autocomplete_value.rb +0 -193
  1622. data/lib/ultracart_api/models/conversation_canned_message.rb +0 -213
  1623. data/lib/ultracart_api/models/conversation_canned_message_response.rb +0 -221
  1624. data/lib/ultracart_api/models/conversation_canned_messages_response.rb +0 -223
  1625. data/lib/ultracart_api/models/conversation_canned_messages_search.rb +0 -193
  1626. data/lib/ultracart_api/models/conversation_delete_knowledge_base_document_response.rb +0 -221
  1627. data/lib/ultracart_api/models/conversation_department.rb +0 -222
  1628. data/lib/ultracart_api/models/conversation_department_member.rb +0 -202
  1629. data/lib/ultracart_api/models/conversation_department_members_response.rb +0 -223
  1630. data/lib/ultracart_api/models/conversation_department_response.rb +0 -221
  1631. data/lib/ultracart_api/models/conversation_department_settings.rb +0 -175
  1632. data/lib/ultracart_api/models/conversation_departments_response.rb +0 -223
  1633. data/lib/ultracart_api/models/conversation_engagement.rb +0 -293
  1634. data/lib/ultracart_api/models/conversation_engagement_equation.rb +0 -186
  1635. data/lib/ultracart_api/models/conversation_engagement_equation_function.rb +0 -414
  1636. data/lib/ultracart_api/models/conversation_engagement_equation_group.rb +0 -186
  1637. data/lib/ultracart_api/models/conversation_engagement_response.rb +0 -221
  1638. data/lib/ultracart_api/models/conversation_engagements_response.rb +0 -223
  1639. data/lib/ultracart_api/models/conversation_event_add_coupon.rb +0 -202
  1640. data/lib/ultracart_api/models/conversation_event_add_item.rb +0 -204
  1641. data/lib/ultracart_api/models/conversation_event_queue_position.rb +0 -195
  1642. data/lib/ultracart_api/models/conversation_event_read_message.rb +0 -203
  1643. data/lib/ultracart_api/models/conversation_event_rr_web.rb +0 -273
  1644. data/lib/ultracart_api/models/conversation_event_typing.rb +0 -202
  1645. data/lib/ultracart_api/models/conversation_event_webchat_context.rb +0 -202
  1646. data/lib/ultracart_api/models/conversation_insert_knowledge_base_document_request.rb +0 -193
  1647. data/lib/ultracart_api/models/conversation_insert_knowledge_base_document_response.rb +0 -241
  1648. data/lib/ultracart_api/models/conversation_join_request.rb +0 -184
  1649. data/lib/ultracart_api/models/conversation_knowledge_base_document.rb +0 -248
  1650. data/lib/ultracart_api/models/conversation_knowledge_base_document_upload_url.rb +0 -193
  1651. data/lib/ultracart_api/models/conversation_knowledge_base_document_upload_url_response.rb +0 -221
  1652. data/lib/ultracart_api/models/conversation_knowledge_base_documents_response.rb +0 -224
  1653. data/lib/ultracart_api/models/conversation_location_country.rb +0 -204
  1654. data/lib/ultracart_api/models/conversation_location_state_province.rb +0 -193
  1655. data/lib/ultracart_api/models/conversation_locations_response.rb +0 -223
  1656. data/lib/ultracart_api/models/conversation_mcp_server.rb +0 -289
  1657. data/lib/ultracart_api/models/conversation_mcp_server_response.rb +0 -221
  1658. data/lib/ultracart_api/models/conversation_mcp_server_tools_response.rb +0 -221
  1659. data/lib/ultracart_api/models/conversation_mcp_servers_response.rb +0 -223
  1660. data/lib/ultracart_api/models/conversation_message.rb +0 -365
  1661. data/lib/ultracart_api/models/conversation_message_translation.rb +0 -193
  1662. data/lib/ultracart_api/models/conversation_message_transport_status.rb +0 -228
  1663. data/lib/ultracart_api/models/conversation_messages_response.rb +0 -223
  1664. data/lib/ultracart_api/models/conversation_multimedia_upload_url.rb +0 -193
  1665. data/lib/ultracart_api/models/conversation_multimedia_upload_url_response.rb +0 -221
  1666. data/lib/ultracart_api/models/conversation_participant.rb +0 -295
  1667. data/lib/ultracart_api/models/conversation_pbx_agent.rb +0 -440
  1668. data/lib/ultracart_api/models/conversation_pbx_agent_response.rb +0 -221
  1669. data/lib/ultracart_api/models/conversation_pbx_agents_response.rb +0 -223
  1670. data/lib/ultracart_api/models/conversation_pbx_audio.rb +0 -365
  1671. data/lib/ultracart_api/models/conversation_pbx_audio_response.rb +0 -221
  1672. data/lib/ultracart_api/models/conversation_pbx_audio_upload_url.rb +0 -193
  1673. data/lib/ultracart_api/models/conversation_pbx_audio_upload_url_response.rb +0 -221
  1674. data/lib/ultracart_api/models/conversation_pbx_audios_response.rb +0 -223
  1675. data/lib/ultracart_api/models/conversation_pbx_customer_snapshot_request.rb +0 -248
  1676. data/lib/ultracart_api/models/conversation_pbx_menu.rb +0 -416
  1677. data/lib/ultracart_api/models/conversation_pbx_menu_mapping.rb +0 -269
  1678. data/lib/ultracart_api/models/conversation_pbx_menu_response.rb +0 -221
  1679. data/lib/ultracart_api/models/conversation_pbx_menus_response.rb +0 -223
  1680. data/lib/ultracart_api/models/conversation_pbx_phone_number.rb +0 -324
  1681. data/lib/ultracart_api/models/conversation_pbx_phone_number_response.rb +0 -221
  1682. data/lib/ultracart_api/models/conversation_pbx_phone_numbers_response.rb +0 -223
  1683. data/lib/ultracart_api/models/conversation_pbx_queue.rb +0 -534
  1684. data/lib/ultracart_api/models/conversation_pbx_queue_members.rb +0 -197
  1685. data/lib/ultracart_api/models/conversation_pbx_queue_response.rb +0 -221
  1686. data/lib/ultracart_api/models/conversation_pbx_queues_response.rb +0 -223
  1687. data/lib/ultracart_api/models/conversation_pbx_time_based.rb +0 -211
  1688. data/lib/ultracart_api/models/conversation_pbx_time_based_mapping.rb +0 -299
  1689. data/lib/ultracart_api/models/conversation_pbx_time_based_mapping_config.rb +0 -196
  1690. data/lib/ultracart_api/models/conversation_pbx_time_based_response.rb +0 -221
  1691. data/lib/ultracart_api/models/conversation_pbx_time_baseds_response.rb +0 -223
  1692. data/lib/ultracart_api/models/conversation_pbx_time_range.rb +0 -287
  1693. data/lib/ultracart_api/models/conversation_pbx_time_range_config.rb +0 -235
  1694. data/lib/ultracart_api/models/conversation_pbx_time_range_response.rb +0 -221
  1695. data/lib/ultracart_api/models/conversation_pbx_time_ranges_response.rb +0 -223
  1696. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb +0 -458
  1697. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox_response.rb +0 -221
  1698. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailboxes_response.rb +0 -223
  1699. data/lib/ultracart_api/models/conversation_pbx_voicemail_message.rb +0 -339
  1700. data/lib/ultracart_api/models/conversation_pbx_voicemail_message_response.rb +0 -221
  1701. data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summaries_response.rb +0 -223
  1702. data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summary.rb +0 -309
  1703. data/lib/ultracart_api/models/conversation_permissions.rb +0 -184
  1704. data/lib/ultracart_api/models/conversation_permissions_response.rb +0 -221
  1705. data/lib/ultracart_api/models/conversation_response.rb +0 -221
  1706. data/lib/ultracart_api/models/conversation_search_request.rb +0 -285
  1707. data/lib/ultracart_api/models/conversation_search_response.rb +0 -213
  1708. data/lib/ultracart_api/models/conversation_sentiment.rb +0 -269
  1709. data/lib/ultracart_api/models/conversation_start_request.rb +0 -204
  1710. data/lib/ultracart_api/models/conversation_start_response.rb +0 -184
  1711. data/lib/ultracart_api/models/conversation_summary.rb +0 -369
  1712. data/lib/ultracart_api/models/conversation_twilio_account.rb +0 -195
  1713. data/lib/ultracart_api/models/conversation_virtual_agent_budget.rb +0 -211
  1714. data/lib/ultracart_api/models/conversation_virtual_agent_budget_response.rb +0 -221
  1715. data/lib/ultracart_api/models/conversation_virtual_agent_capabilities.rb +0 -362
  1716. data/lib/ultracart_api/models/conversation_virtual_agent_capabilities_response.rb +0 -221
  1717. data/lib/ultracart_api/models/conversation_virtual_agent_capability_zoho_desk_department.rb +0 -193
  1718. data/lib/ultracart_api/models/conversation_webchat_context.rb +0 -254
  1719. data/lib/ultracart_api/models/conversation_webchat_queue_status.rb +0 -315
  1720. data/lib/ultracart_api/models/conversation_webchat_queue_status_agent.rb +0 -266
  1721. data/lib/ultracart_api/models/conversation_webchat_queue_status_queue_entry.rb +0 -248
  1722. data/lib/ultracart_api/models/conversation_webchat_queue_status_update_request.rb +0 -219
  1723. data/lib/ultracart_api/models/conversation_webchat_queue_statuses_response.rb +0 -223
  1724. data/lib/ultracart_api/models/conversation_websocket_message.rb +0 -441
  1725. data/lib/ultracart_api/models/conversations_response.rb +0 -223
  1726. data/lib/ultracart_api/models/coupon_free_item_with_item_purchase_and_free_shipping.rb +0 -231
  1727. data/lib/ultracart_api/models/coupon_more_loyalty_cashback.rb +0 -185
  1728. data/lib/ultracart_api/models/coupon_more_loyalty_points.rb +0 -185
  1729. data/lib/ultracart_api/models/coupon_no_discount.rb +0 -185
  1730. data/lib/ultracart_api/models/coupon_percent_more_loyalty_cashback.rb +0 -185
  1731. data/lib/ultracart_api/models/coupon_percent_more_loyalty_points.rb +0 -185
  1732. data/lib/ultracart_api/models/coupon_tiered_percent_off_subtotal_based_on_msrp.rb +0 -199
  1733. data/lib/ultracart_api/models/custom_dashboard.rb +0 -224
  1734. data/lib/ultracart_api/models/custom_dashboard_execution_parameter.rb +0 -211
  1735. data/lib/ultracart_api/models/custom_dashboard_page.rb +0 -204
  1736. data/lib/ultracart_api/models/custom_dashboard_page_report.rb +0 -220
  1737. data/lib/ultracart_api/models/custom_dashboard_response.rb +0 -221
  1738. data/lib/ultracart_api/models/custom_dashboard_schedule.rb +0 -223
  1739. data/lib/ultracart_api/models/custom_dashboard_schedule_response.rb +0 -221
  1740. data/lib/ultracart_api/models/custom_dashboard_schedules_response.rb +0 -224
  1741. data/lib/ultracart_api/models/custom_dashboards_response.rb +0 -224
  1742. data/lib/ultracart_api/models/custom_report.rb +0 -280
  1743. data/lib/ultracart_api/models/custom_report_account_config.rb +0 -281
  1744. data/lib/ultracart_api/models/custom_report_account_config_response.rb +0 -221
  1745. data/lib/ultracart_api/models/custom_report_analysis_request.rb +0 -193
  1746. data/lib/ultracart_api/models/custom_report_analysis_response.rb +0 -221
  1747. data/lib/ultracart_api/models/custom_report_chart_png_upload_response.rb +0 -230
  1748. data/lib/ultracart_api/models/custom_report_execution_parameter.rb +0 -211
  1749. data/lib/ultracart_api/models/custom_report_execution_request.rb +0 -186
  1750. data/lib/ultracart_api/models/custom_report_execution_response.rb +0 -250
  1751. data/lib/ultracart_api/models/custom_report_parameter.rb +0 -231
  1752. data/lib/ultracart_api/models/custom_report_parameter_option.rb +0 -193
  1753. data/lib/ultracart_api/models/custom_report_query.rb +0 -231
  1754. data/lib/ultracart_api/models/custom_report_response.rb +0 -221
  1755. data/lib/ultracart_api/models/custom_report_tooltip.rb +0 -193
  1756. data/lib/ultracart_api/models/custom_report_usage_breakdown.rb +0 -194
  1757. data/lib/ultracart_api/models/custom_reports_execution_report_data.rb +0 -202
  1758. data/lib/ultracart_api/models/custom_reports_execution_request.rb +0 -197
  1759. data/lib/ultracart_api/models/custom_reports_response.rb +0 -224
  1760. data/lib/ultracart_api/models/customer_edi.rb +0 -205
  1761. data/lib/ultracart_api/models/customer_magic_link_response.rb +0 -222
  1762. data/lib/ultracart_api/models/customer_merge_request.rb +0 -195
  1763. data/lib/ultracart_api/models/customer_property.rb +0 -245
  1764. data/lib/ultracart_api/models/customer_wish_list_item.rb +0 -260
  1765. data/lib/ultracart_api/models/customer_wish_list_item_response.rb +0 -221
  1766. data/lib/ultracart_api/models/email_commseq_sequence_test_request.rb +0 -312
  1767. data/lib/ultracart_api/models/email_commseq_sequence_test_response.rb +0 -212
  1768. data/lib/ultracart_api/models/email_commseq_sms_send_test_request.rb +0 -202
  1769. data/lib/ultracart_api/models/email_commseq_sms_send_test_response.rb +0 -232
  1770. data/lib/ultracart_api/models/email_editor_values_response.rb +0 -223
  1771. data/lib/ultracart_api/models/email_postcard_tracking.rb +0 -404
  1772. data/lib/ultracart_api/models/email_postcard_tracking_response.rb +0 -221
  1773. data/lib/ultracart_api/models/email_rate_limiter.rb +0 -202
  1774. data/lib/ultracart_api/models/email_rate_limiters_response.rb +0 -223
  1775. data/lib/ultracart_api/models/email_sms_order.rb +0 -214
  1776. data/lib/ultracart_api/models/email_sms_orders_response.rb +0 -223
  1777. data/lib/ultracart_api/models/email_sms_stat.rb +0 -476
  1778. data/lib/ultracart_api/models/email_stat_sms_summary_request.rb +0 -195
  1779. data/lib/ultracart_api/models/email_stat_sms_summary_response.rb +0 -223
  1780. data/lib/ultracart_api/models/file_manager_directory.rb +0 -292
  1781. data/lib/ultracart_api/models/file_manager_file.rb +0 -376
  1782. data/lib/ultracart_api/models/file_manager_page.rb +0 -253
  1783. data/lib/ultracart_api/models/file_manager_page_response.rb +0 -221
  1784. data/lib/ultracart_api/models/file_manager_upload_request.rb +0 -202
  1785. data/lib/ultracart_api/models/file_manager_upload_url_response.rb +0 -230
  1786. data/lib/ultracart_api/models/hit_page_view.rb +0 -276
  1787. data/lib/ultracart_api/models/hit_page_view_meta_data.rb +0 -193
  1788. data/lib/ultracart_api/models/hit_session_start.rb +0 -328
  1789. data/lib/ultracart_api/models/hit_session_utm.rb +0 -310
  1790. data/lib/ultracart_api/models/item_digital_item_pdf_meta.rb +0 -315
  1791. data/lib/ultracart_api/models/item_digital_item_response.rb +0 -221
  1792. data/lib/ultracart_api/models/item_digital_items_response.rb +0 -224
  1793. data/lib/ultracart_api/models/item_inventory_snapshot.rb +0 -231
  1794. data/lib/ultracart_api/models/item_inventory_snapshot_distribution_center.rb +0 -220
  1795. data/lib/ultracart_api/models/item_inventory_snapshot_response.rb +0 -224
  1796. data/lib/ultracart_api/models/item_review.rb +0 -826
  1797. data/lib/ultracart_api/models/item_review_response.rb +0 -221
  1798. data/lib/ultracart_api/models/item_reviews_response.rb +0 -224
  1799. data/lib/ultracart_api/models/order_assign_to_affiliate_request.rb +0 -220
  1800. data/lib/ultracart_api/models/order_current_stage_history.rb +0 -251
  1801. data/lib/ultracart_api/models/order_edi_document.rb +0 -337
  1802. data/lib/ultracart_api/models/order_edi_documents_response.rb +0 -224
  1803. data/lib/ultracart_api/models/order_invoice_response.rb +0 -222
  1804. data/lib/ultracart_api/models/order_payment_credit_card_dual_vaulted.rb +0 -204
  1805. data/lib/ultracart_api/models/order_payment_credit_card_dual_vaulted_property.rb +0 -193
  1806. data/lib/ultracart_api/models/order_payment_health_benefit_card.rb +0 -235
  1807. data/lib/ultracart_api/models/order_payment_pay_pal.rb +0 -195
  1808. data/lib/ultracart_api/models/order_point_of_sale.rb +0 -202
  1809. data/lib/ultracart_api/models/order_reason.rb +0 -205
  1810. data/lib/ultracart_api/models/order_refundable_response.rb +0 -310
  1811. data/lib/ultracart_api/models/order_transactional_merchant_note.rb +0 -215
  1812. data/lib/ultracart_api/models/order_utm.rb +0 -464
  1813. data/lib/ultracart_api/models/order_validation_request.rb +0 -196
  1814. data/lib/ultracart_api/models/order_validation_response.rb +0 -209
  1815. data/lib/ultracart_api/models/point_of_sale_location.rb +0 -290
  1816. data/lib/ultracart_api/models/point_of_sale_reader.rb +0 -299
  1817. data/lib/ultracart_api/models/point_of_sale_register.rb +0 -215
  1818. data/lib/ultracart_api/models/replace_order_item_id_request.rb +0 -245
  1819. data/lib/ultracart_api/models/report.rb +0 -317
  1820. data/lib/ultracart_api/models/report_auth.rb +0 -212
  1821. data/lib/ultracart_api/models/report_auth_response.rb +0 -221
  1822. data/lib/ultracart_api/models/report_data_set.rb +0 -381
  1823. data/lib/ultracart_api/models/report_data_set_column.rb +0 -229
  1824. data/lib/ultracart_api/models/report_data_set_page.rb +0 -273
  1825. data/lib/ultracart_api/models/report_data_set_page_response.rb +0 -221
  1826. data/lib/ultracart_api/models/report_data_set_query.rb +0 -342
  1827. data/lib/ultracart_api/models/report_data_set_query_order_by_column.rb +0 -193
  1828. data/lib/ultracart_api/models/report_data_set_response.rb +0 -221
  1829. data/lib/ultracart_api/models/report_data_set_row.rb +0 -186
  1830. data/lib/ultracart_api/models/report_data_set_schema.rb +0 -238
  1831. data/lib/ultracart_api/models/report_data_source.rb +0 -242
  1832. data/lib/ultracart_api/models/report_data_source_schema.rb +0 -248
  1833. data/lib/ultracart_api/models/report_dry_run_queries_request.rb +0 -231
  1834. data/lib/ultracart_api/models/report_dry_run_queries_response.rb +0 -186
  1835. data/lib/ultracart_api/models/report_dry_run_query_result.rb +0 -193
  1836. data/lib/ultracart_api/models/report_execute_queries_request.rb +0 -288
  1837. data/lib/ultracart_api/models/report_filter.rb +0 -272
  1838. data/lib/ultracart_api/models/report_filter_connection.rb +0 -203
  1839. data/lib/ultracart_api/models/report_page.rb +0 -237
  1840. data/lib/ultracart_api/models/report_page_filter.rb +0 -214
  1841. data/lib/ultracart_api/models/report_page_visualization.rb +0 -309
  1842. data/lib/ultracart_api/models/report_page_visualization_dimension.rb +0 -244
  1843. data/lib/ultracart_api/models/report_page_visualization_metric.rb +0 -248
  1844. data/lib/ultracart_api/models/report_response.rb +0 -221
  1845. data/lib/ultracart_api/models/report_websocket_event.rb +0 -228
  1846. data/lib/ultracart_api/models/reports_response.rb +0 -223
  1847. data/lib/ultracart_api/models/ruler_validation_request.rb +0 -184
  1848. data/lib/ultracart_api/models/ruler_validation_response.rb +0 -193
  1849. data/lib/ultracart_api/models/store_front.rb +0 -274
  1850. data/lib/ultracart_api/models/store_front_page_content_attribute.rb +0 -245
  1851. data/lib/ultracart_api/models/store_fronts_response.rb +0 -223
  1852. data/lib/ultracart_api/models/webhook_reflow.rb +0 -193
  1853. data/lib/ultracart_api/models/webhook_reflow_response.rb +0 -221
  1854. data/lib/ultracart_api/models/workflow_agent_auth.rb +0 -202
  1855. data/lib/ultracart_api/models/workflow_agent_auth_response.rb +0 -221
  1856. data/lib/ultracart_api/models/workflow_attachment.rb +0 -225
  1857. data/lib/ultracart_api/models/workflow_attachment_upload_url.rb +0 -193
  1858. data/lib/ultracart_api/models/workflow_attachment_upload_url_response.rb +0 -221
  1859. data/lib/ultracart_api/models/workflow_group.rb +0 -195
  1860. data/lib/ultracart_api/models/workflow_groups_response.rb +0 -224
  1861. data/lib/ultracart_api/models/workflow_note.rb +0 -236
  1862. data/lib/ultracart_api/models/workflow_task.rb +0 -574
  1863. data/lib/ultracart_api/models/workflow_task_history.rb +0 -214
  1864. data/lib/ultracart_api/models/workflow_task_open_count_response.rb +0 -222
  1865. data/lib/ultracart_api/models/workflow_task_response.rb +0 -221
  1866. data/lib/ultracart_api/models/workflow_task_tags_response.rb +0 -224
  1867. data/lib/ultracart_api/models/workflow_tasks_request.rb +0 -434
  1868. data/lib/ultracart_api/models/workflow_tasks_response.rb +0 -234
  1869. data/lib/ultracart_api/models/workflow_user.rb +0 -205
  1870. data/lib/ultracart_api/models/workflow_user_response.rb +0 -221
  1871. data/lib/ultracart_api/models/workflow_users_response.rb +0 -234
@@ -1,1595 +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'])
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
- # Delete a customer wishlist item
212
- # Delete a customer wishlist item
213
- # @param customer_profile_oid The customer oid for this wishlist.
214
- # @param customer_wishlist_item_oid The wishlist oid for this wishlist item to delete.
215
- # @param [Hash] opts the optional parameters
216
- # @return [nil]
217
- def delete_wish_list_item(customer_profile_oid, customer_wishlist_item_oid, opts = {})
218
- delete_wish_list_item_with_http_info(customer_profile_oid, customer_wishlist_item_oid, opts)
219
- nil
220
- end
221
-
222
- # Delete a customer wishlist item
223
- # Delete a customer wishlist item
224
- # @param customer_profile_oid The customer oid for this wishlist.
225
- # @param customer_wishlist_item_oid The wishlist oid for this wishlist item to delete.
226
- # @param [Hash] opts the optional parameters
227
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
228
- def delete_wish_list_item_with_http_info(customer_profile_oid, customer_wishlist_item_oid, opts = {})
229
- if @api_client.config.debugging
230
- @api_client.config.logger.debug 'Calling API: CustomerApi.delete_wish_list_item ...'
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.delete_wish_list_item"
235
- end
236
- # verify the required parameter 'customer_wishlist_item_oid' is set
237
- if @api_client.config.client_side_validation && customer_wishlist_item_oid.nil?
238
- fail ArgumentError, "Missing the required parameter 'customer_wishlist_item_oid' when calling CustomerApi.delete_wish_list_item"
239
- end
240
- # resource path
241
- local_var_path = '/customer/customers/{customer_profile_oid}/wishlist/{customer_wishlist_item_oid}'.sub('{' + 'customer_profile_oid' + '}', customer_profile_oid.to_s).sub('{' + 'customer_wishlist_item_oid' + '}', customer_wishlist_item_oid.to_s)
242
-
243
- # query parameters
244
- query_params = {}
245
-
246
- # header parameters
247
- header_params = {}
248
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
249
- # HTTP header 'Accept' (if needed)
250
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
251
- # HTTP header 'Content-Type'
252
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
253
-
254
- # form parameters
255
- form_params = {}
256
-
257
- # http body (model)
258
- post_body = nil
259
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
260
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
261
- :header_params => header_params,
262
- :query_params => query_params,
263
- :form_params => form_params,
264
- :body => post_body,
265
- :auth_names => auth_names)
266
- if @api_client.config.debugging
267
- @api_client.config.logger.debug "API called: CustomerApi#delete_wish_list_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
268
- end
269
- return data, status_code, headers
270
- end
271
- # Retrieve a customer
272
- # Retrieves a single customer using the specified customer profile oid.
273
- # @param customer_profile_oid The customer oid to retrieve.
274
- # @param [Hash] opts the optional parameters
275
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
276
- # @return [CustomerResponse]
277
- def get_customer(customer_profile_oid, opts = {})
278
- data, _status_code, _headers = get_customer_with_http_info(customer_profile_oid, opts)
279
- data
280
- end
281
-
282
- # Retrieve a customer
283
- # Retrieves a single customer using the specified customer profile oid.
284
- # @param customer_profile_oid The customer oid to retrieve.
285
- # @param [Hash] opts the optional parameters
286
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
287
- # @return [Array<(CustomerResponse, Fixnum, Hash)>] CustomerResponse data, response status code and response headers
288
- def get_customer_with_http_info(customer_profile_oid, opts = {})
289
- if @api_client.config.debugging
290
- @api_client.config.logger.debug 'Calling API: CustomerApi.get_customer ...'
291
- end
292
- # verify the required parameter 'customer_profile_oid' is set
293
- if @api_client.config.client_side_validation && customer_profile_oid.nil?
294
- fail ArgumentError, "Missing the required parameter 'customer_profile_oid' when calling CustomerApi.get_customer"
295
- end
296
- # resource path
297
- local_var_path = '/customer/customers/{customer_profile_oid}'.sub('{' + 'customer_profile_oid' + '}', customer_profile_oid.to_s)
298
-
299
- # query parameters
300
- query_params = {}
301
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
302
-
303
- # header parameters
304
- header_params = {}
305
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
306
- # HTTP header 'Accept' (if needed)
307
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
308
- # HTTP header 'Content-Type'
309
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
310
-
311
- # form parameters
312
- form_params = {}
313
-
314
- # http body (model)
315
- post_body = nil
316
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
317
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
318
- :header_params => header_params,
319
- :query_params => query_params,
320
- :form_params => form_params,
321
- :body => post_body,
322
- :auth_names => auth_names,
323
- :return_type => 'CustomerResponse')
324
- if @api_client.config.debugging
325
- @api_client.config.logger.debug "API called: CustomerApi#get_customer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
326
- end
327
- return data, status_code, headers
328
- end
329
- # Retrieve a customer by Email
330
- # Retrieves a single customer using the specified customer email address.
331
- # @param email The email address of the customer to retrieve.
332
- # @param [Hash] opts the optional parameters
333
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
334
- # @return [CustomerResponse]
335
- def get_customer_by_email(email, opts = {})
336
- data, _status_code, _headers = get_customer_by_email_with_http_info(email, opts)
337
- data
338
- end
339
-
340
- # Retrieve a customer by Email
341
- # Retrieves a single customer using the specified customer email address.
342
- # @param email The email address of the customer to retrieve.
343
- # @param [Hash] opts the optional parameters
344
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
345
- # @return [Array<(CustomerResponse, Fixnum, Hash)>] CustomerResponse data, response status code and response headers
346
- def get_customer_by_email_with_http_info(email, opts = {})
347
- if @api_client.config.debugging
348
- @api_client.config.logger.debug 'Calling API: CustomerApi.get_customer_by_email ...'
349
- end
350
- # verify the required parameter 'email' is set
351
- if @api_client.config.client_side_validation && email.nil?
352
- fail ArgumentError, "Missing the required parameter 'email' when calling CustomerApi.get_customer_by_email"
353
- end
354
- # resource path
355
- local_var_path = '/customer/customers/by_email/{email}'.sub('{' + 'email' + '}', email.to_s)
356
-
357
- # query parameters
358
- query_params = {}
359
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
360
-
361
- # header parameters
362
- header_params = {}
363
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
364
- # HTTP header 'Accept' (if needed)
365
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
366
- # HTTP header 'Content-Type'
367
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
368
-
369
- # form parameters
370
- form_params = {}
371
-
372
- # http body (model)
373
- post_body = nil
374
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
375
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
376
- :header_params => header_params,
377
- :query_params => query_params,
378
- :form_params => form_params,
379
- :body => post_body,
380
- :auth_names => auth_names,
381
- :return_type => 'CustomerResponse')
382
- if @api_client.config.debugging
383
- @api_client.config.logger.debug "API called: CustomerApi#get_customer_by_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
384
- end
385
- return data, status_code, headers
386
- end
387
- # Retrieve values needed for a customer profile editor
388
- # Retrieve values needed for a customer profile editor.
389
- # @param [Hash] opts the optional parameters
390
- # @return [CustomerEditorValues]
391
- def get_customer_editor_values(opts = {})
392
- data, _status_code, _headers = get_customer_editor_values_with_http_info(opts)
393
- data
394
- end
395
-
396
- # Retrieve values needed for a customer profile editor
397
- # Retrieve values needed for a customer profile editor.
398
- # @param [Hash] opts the optional parameters
399
- # @return [Array<(CustomerEditorValues, Fixnum, Hash)>] CustomerEditorValues data, response status code and response headers
400
- def get_customer_editor_values_with_http_info(opts = {})
401
- if @api_client.config.debugging
402
- @api_client.config.logger.debug 'Calling API: CustomerApi.get_customer_editor_values ...'
403
- end
404
- # resource path
405
- local_var_path = '/customer/editor_values'
406
-
407
- # query parameters
408
- query_params = {}
409
-
410
- # header parameters
411
- header_params = {}
412
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
413
- # HTTP header 'Accept' (if needed)
414
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
415
- # HTTP header 'Content-Type'
416
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
417
-
418
- # form parameters
419
- form_params = {}
420
-
421
- # http body (model)
422
- post_body = nil
423
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
424
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
425
- :header_params => header_params,
426
- :query_params => query_params,
427
- :form_params => form_params,
428
- :body => post_body,
429
- :auth_names => auth_names,
430
- :return_type => 'CustomerEditorValues')
431
- if @api_client.config.debugging
432
- @api_client.config.logger.debug "API called: CustomerApi#get_customer_editor_values\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
433
- end
434
- return data, status_code, headers
435
- end
436
- # Retrieve all email lists across all storefronts
437
- # Retrieve all email lists across all storefronts
438
- # @param [Hash] opts the optional parameters
439
- # @return [EmailListsResponse]
440
- def get_customer_email_lists(opts = {})
441
- data, _status_code, _headers = get_customer_email_lists_with_http_info(opts)
442
- data
443
- end
444
-
445
- # Retrieve all email lists across all storefronts
446
- # Retrieve all email lists across all storefronts
447
- # @param [Hash] opts the optional parameters
448
- # @return [Array<(EmailListsResponse, Fixnum, Hash)>] EmailListsResponse data, response status code and response headers
449
- def get_customer_email_lists_with_http_info(opts = {})
450
- if @api_client.config.debugging
451
- @api_client.config.logger.debug 'Calling API: CustomerApi.get_customer_email_lists ...'
452
- end
453
- # resource path
454
- local_var_path = '/customer/email_lists'
455
-
456
- # query parameters
457
- query_params = {}
458
-
459
- # header parameters
460
- header_params = {}
461
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
462
- # HTTP header 'Accept' (if needed)
463
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
464
- # HTTP header 'Content-Type'
465
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
466
-
467
- # form parameters
468
- form_params = {}
469
-
470
- # http body (model)
471
- post_body = nil
472
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
473
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
474
- :header_params => header_params,
475
- :query_params => query_params,
476
- :form_params => form_params,
477
- :body => post_body,
478
- :auth_names => auth_names,
479
- :return_type => 'EmailListsResponse')
480
- if @api_client.config.debugging
481
- @api_client.config.logger.debug "API called: CustomerApi#get_customer_email_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
482
- end
483
- return data, status_code, headers
484
- end
485
- # Retrieve the customer store credit accumulated through loyalty programs
486
- # Retrieve the customer store credit accumulated through loyalty programs
487
- # @param customer_profile_oid The customer oid to retrieve.
488
- # @param [Hash] opts the optional parameters
489
- # @return [CustomerStoreCreditResponse]
490
- def get_customer_store_credit(customer_profile_oid, opts = {})
491
- data, _status_code, _headers = get_customer_store_credit_with_http_info(customer_profile_oid, opts)
492
- data
493
- end
494
-
495
- # Retrieve the customer store credit accumulated through loyalty programs
496
- # Retrieve the customer store credit accumulated through loyalty programs
497
- # @param customer_profile_oid The customer oid to retrieve.
498
- # @param [Hash] opts the optional parameters
499
- # @return [Array<(CustomerStoreCreditResponse, Fixnum, Hash)>] CustomerStoreCreditResponse data, response status code and response headers
500
- def get_customer_store_credit_with_http_info(customer_profile_oid, opts = {})
501
- if @api_client.config.debugging
502
- @api_client.config.logger.debug 'Calling API: CustomerApi.get_customer_store_credit ...'
503
- end
504
- # verify the required parameter 'customer_profile_oid' is set
505
- if @api_client.config.client_side_validation && customer_profile_oid.nil?
506
- fail ArgumentError, "Missing the required parameter 'customer_profile_oid' when calling CustomerApi.get_customer_store_credit"
507
- end
508
- # resource path
509
- local_var_path = '/customer/customers/{customer_profile_oid}/store_credit'.sub('{' + 'customer_profile_oid' + '}', customer_profile_oid.to_s)
510
-
511
- # query parameters
512
- query_params = {}
513
-
514
- # header parameters
515
- header_params = {}
516
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
517
- # HTTP header 'Accept' (if needed)
518
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
519
- # HTTP header 'Content-Type'
520
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
521
-
522
- # form parameters
523
- form_params = {}
524
-
525
- # http body (model)
526
- post_body = nil
527
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
528
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
529
- :header_params => header_params,
530
- :query_params => query_params,
531
- :form_params => form_params,
532
- :body => post_body,
533
- :auth_names => auth_names,
534
- :return_type => 'CustomerStoreCreditResponse')
535
- if @api_client.config.debugging
536
- @api_client.config.logger.debug "API called: CustomerApi#get_customer_store_credit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
537
- end
538
- return data, status_code, headers
539
- end
540
- # Retrieve wishlist items for customer
541
- # Retrieve wishlist items for customer.
542
- # @param customer_profile_oid The customer oid for this wishlist.
543
- # @param [Hash] opts the optional parameters
544
- # @return [CustomerWishListItemsResponse]
545
- def get_customer_wish_list(customer_profile_oid, opts = {})
546
- data, _status_code, _headers = get_customer_wish_list_with_http_info(customer_profile_oid, opts)
547
- data
548
- end
549
-
550
- # Retrieve wishlist items for customer
551
- # Retrieve wishlist items for customer.
552
- # @param customer_profile_oid The customer oid for this wishlist.
553
- # @param [Hash] opts the optional parameters
554
- # @return [Array<(CustomerWishListItemsResponse, Fixnum, Hash)>] CustomerWishListItemsResponse data, response status code and response headers
555
- def get_customer_wish_list_with_http_info(customer_profile_oid, opts = {})
556
- if @api_client.config.debugging
557
- @api_client.config.logger.debug 'Calling API: CustomerApi.get_customer_wish_list ...'
558
- end
559
- # verify the required parameter 'customer_profile_oid' is set
560
- if @api_client.config.client_side_validation && customer_profile_oid.nil?
561
- fail ArgumentError, "Missing the required parameter 'customer_profile_oid' when calling CustomerApi.get_customer_wish_list"
562
- end
563
- # resource path
564
- local_var_path = '/customer/customers/{customer_profile_oid}/wishlist'.sub('{' + 'customer_profile_oid' + '}', customer_profile_oid.to_s)
565
-
566
- # query parameters
567
- query_params = {}
568
-
569
- # header parameters
570
- header_params = {}
571
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
572
- # HTTP header 'Accept' (if needed)
573
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
574
- # HTTP header 'Content-Type'
575
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
576
-
577
- # form parameters
578
- form_params = {}
579
-
580
- # http body (model)
581
- post_body = nil
582
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
583
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
584
- :header_params => header_params,
585
- :query_params => query_params,
586
- :form_params => form_params,
587
- :body => post_body,
588
- :auth_names => auth_names,
589
- :return_type => 'CustomerWishListItemsResponse')
590
- if @api_client.config.debugging
591
- @api_client.config.logger.debug "API called: CustomerApi#get_customer_wish_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
592
- end
593
- return data, status_code, headers
594
- end
595
- # Retrieve wishlist item for customer
596
- # Retrieve wishlist item for customer.
597
- # @param customer_profile_oid The customer oid for this wishlist.
598
- # @param customer_wishlist_item_oid The wishlist oid for this wishlist item.
599
- # @param [Hash] opts the optional parameters
600
- # @return [CustomerWishListItemResponse]
601
- def get_customer_wish_list_item(customer_profile_oid, customer_wishlist_item_oid, opts = {})
602
- data, _status_code, _headers = get_customer_wish_list_item_with_http_info(customer_profile_oid, customer_wishlist_item_oid, opts)
603
- data
604
- end
605
-
606
- # Retrieve wishlist item for customer
607
- # Retrieve wishlist item for customer.
608
- # @param customer_profile_oid The customer oid for this wishlist.
609
- # @param customer_wishlist_item_oid The wishlist oid for this wishlist item.
610
- # @param [Hash] opts the optional parameters
611
- # @return [Array<(CustomerWishListItemResponse, Fixnum, Hash)>] CustomerWishListItemResponse data, response status code and response headers
612
- def get_customer_wish_list_item_with_http_info(customer_profile_oid, customer_wishlist_item_oid, opts = {})
613
- if @api_client.config.debugging
614
- @api_client.config.logger.debug 'Calling API: CustomerApi.get_customer_wish_list_item ...'
615
- end
616
- # verify the required parameter 'customer_profile_oid' is set
617
- if @api_client.config.client_side_validation && customer_profile_oid.nil?
618
- fail ArgumentError, "Missing the required parameter 'customer_profile_oid' when calling CustomerApi.get_customer_wish_list_item"
619
- end
620
- # verify the required parameter 'customer_wishlist_item_oid' is set
621
- if @api_client.config.client_side_validation && customer_wishlist_item_oid.nil?
622
- fail ArgumentError, "Missing the required parameter 'customer_wishlist_item_oid' when calling CustomerApi.get_customer_wish_list_item"
623
- end
624
- # resource path
625
- local_var_path = '/customer/customers/{customer_profile_oid}/wishlist/{customer_wishlist_item_oid}'.sub('{' + 'customer_profile_oid' + '}', customer_profile_oid.to_s).sub('{' + 'customer_wishlist_item_oid' + '}', customer_wishlist_item_oid.to_s)
626
-
627
- # query parameters
628
- query_params = {}
629
-
630
- # header parameters
631
- header_params = {}
632
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
633
- # HTTP header 'Accept' (if needed)
634
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
635
- # HTTP header 'Content-Type'
636
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
637
-
638
- # form parameters
639
- form_params = {}
640
-
641
- # http body (model)
642
- post_body = nil
643
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
644
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
645
- :header_params => header_params,
646
- :query_params => query_params,
647
- :form_params => form_params,
648
- :body => post_body,
649
- :auth_names => auth_names,
650
- :return_type => 'CustomerWishListItemResponse')
651
- if @api_client.config.debugging
652
- @api_client.config.logger.debug "API called: CustomerApi#get_customer_wish_list_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
653
- end
654
- return data, status_code, headers
655
- end
656
- # Retrieve customers
657
- # 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.
658
- # @param [Hash] opts the optional parameters
659
- # @option opts [String] :email Email
660
- # @option opts [String] :qb_class Quickbooks class
661
- # @option opts [String] :quickbooks_code Quickbooks code
662
- # @option opts [String] :last_modified_dts_start Last modified date start
663
- # @option opts [String] :last_modified_dts_end Last modified date end
664
- # @option opts [String] :signup_dts_start Signup date start
665
- # @option opts [String] :signup_dts_end Signup date end
666
- # @option opts [String] :billing_first_name Billing first name
667
- # @option opts [String] :billing_last_name Billing last name
668
- # @option opts [String] :billing_company Billing company
669
- # @option opts [String] :billing_city Billing city
670
- # @option opts [String] :billing_state Billing state
671
- # @option opts [String] :billing_postal_code Billing postal code
672
- # @option opts [String] :billing_country_code Billing country code
673
- # @option opts [String] :billing_day_phone Billing day phone
674
- # @option opts [String] :billing_evening_phone Billing evening phone
675
- # @option opts [String] :shipping_first_name Shipping first name
676
- # @option opts [String] :shipping_last_name Shipping last name
677
- # @option opts [String] :shipping_company Shipping company
678
- # @option opts [String] :shipping_city Shipping city
679
- # @option opts [String] :shipping_state Shipping state
680
- # @option opts [String] :shipping_postal_code Shipping postal code
681
- # @option opts [String] :shipping_country_code Shipping country code
682
- # @option opts [String] :shipping_day_phone Shipping day phone
683
- # @option opts [String] :shipping_evening_phone Shipping evening phone
684
- # @option opts [Integer] :pricing_tier_oid Pricing tier oid
685
- # @option opts [String] :pricing_tier_name Pricing tier name
686
- # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Max 200) (default to 100)
687
- # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
688
- # @option opts [String] :_since Fetch customers that have been created/modified since this date/time.
689
- # @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.
690
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
691
- # @return [CustomersResponse]
692
- def get_customers(opts = {})
693
- data, _status_code, _headers = get_customers_with_http_info(opts)
694
- data
695
- end
696
-
697
- # Retrieve customers
698
- # 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.
699
- # @param [Hash] opts the optional parameters
700
- # @option opts [String] :email Email
701
- # @option opts [String] :qb_class Quickbooks class
702
- # @option opts [String] :quickbooks_code Quickbooks code
703
- # @option opts [String] :last_modified_dts_start Last modified date start
704
- # @option opts [String] :last_modified_dts_end Last modified date end
705
- # @option opts [String] :signup_dts_start Signup date start
706
- # @option opts [String] :signup_dts_end Signup date end
707
- # @option opts [String] :billing_first_name Billing first name
708
- # @option opts [String] :billing_last_name Billing last name
709
- # @option opts [String] :billing_company Billing company
710
- # @option opts [String] :billing_city Billing city
711
- # @option opts [String] :billing_state Billing state
712
- # @option opts [String] :billing_postal_code Billing postal code
713
- # @option opts [String] :billing_country_code Billing country code
714
- # @option opts [String] :billing_day_phone Billing day phone
715
- # @option opts [String] :billing_evening_phone Billing evening phone
716
- # @option opts [String] :shipping_first_name Shipping first name
717
- # @option opts [String] :shipping_last_name Shipping last name
718
- # @option opts [String] :shipping_company Shipping company
719
- # @option opts [String] :shipping_city Shipping city
720
- # @option opts [String] :shipping_state Shipping state
721
- # @option opts [String] :shipping_postal_code Shipping postal code
722
- # @option opts [String] :shipping_country_code Shipping country code
723
- # @option opts [String] :shipping_day_phone Shipping day phone
724
- # @option opts [String] :shipping_evening_phone Shipping evening phone
725
- # @option opts [Integer] :pricing_tier_oid Pricing tier oid
726
- # @option opts [String] :pricing_tier_name Pricing tier name
727
- # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Max 200)
728
- # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index.
729
- # @option opts [String] :_since Fetch customers that have been created/modified since this date/time.
730
- # @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.
731
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
732
- # @return [Array<(CustomersResponse, Fixnum, Hash)>] CustomersResponse data, response status code and response headers
733
- def get_customers_with_http_info(opts = {})
734
- if @api_client.config.debugging
735
- @api_client.config.logger.debug 'Calling API: CustomerApi.get_customers ...'
736
- end
737
- # resource path
738
- local_var_path = '/customer/customers'
739
-
740
- # query parameters
741
- query_params = {}
742
- query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
743
- query_params[:'qb_class'] = opts[:'qb_class'] if !opts[:'qb_class'].nil?
744
- query_params[:'quickbooks_code'] = opts[:'quickbooks_code'] if !opts[:'quickbooks_code'].nil?
745
- query_params[:'last_modified_dts_start'] = opts[:'last_modified_dts_start'] if !opts[:'last_modified_dts_start'].nil?
746
- query_params[:'last_modified_dts_end'] = opts[:'last_modified_dts_end'] if !opts[:'last_modified_dts_end'].nil?
747
- query_params[:'signup_dts_start'] = opts[:'signup_dts_start'] if !opts[:'signup_dts_start'].nil?
748
- query_params[:'signup_dts_end'] = opts[:'signup_dts_end'] if !opts[:'signup_dts_end'].nil?
749
- query_params[:'billing_first_name'] = opts[:'billing_first_name'] if !opts[:'billing_first_name'].nil?
750
- query_params[:'billing_last_name'] = opts[:'billing_last_name'] if !opts[:'billing_last_name'].nil?
751
- query_params[:'billing_company'] = opts[:'billing_company'] if !opts[:'billing_company'].nil?
752
- query_params[:'billing_city'] = opts[:'billing_city'] if !opts[:'billing_city'].nil?
753
- query_params[:'billing_state'] = opts[:'billing_state'] if !opts[:'billing_state'].nil?
754
- query_params[:'billing_postal_code'] = opts[:'billing_postal_code'] if !opts[:'billing_postal_code'].nil?
755
- query_params[:'billing_country_code'] = opts[:'billing_country_code'] if !opts[:'billing_country_code'].nil?
756
- query_params[:'billing_day_phone'] = opts[:'billing_day_phone'] if !opts[:'billing_day_phone'].nil?
757
- query_params[:'billing_evening_phone'] = opts[:'billing_evening_phone'] if !opts[:'billing_evening_phone'].nil?
758
- query_params[:'shipping_first_name'] = opts[:'shipping_first_name'] if !opts[:'shipping_first_name'].nil?
759
- query_params[:'shipping_last_name'] = opts[:'shipping_last_name'] if !opts[:'shipping_last_name'].nil?
760
- query_params[:'shipping_company'] = opts[:'shipping_company'] if !opts[:'shipping_company'].nil?
761
- query_params[:'shipping_city'] = opts[:'shipping_city'] if !opts[:'shipping_city'].nil?
762
- query_params[:'shipping_state'] = opts[:'shipping_state'] if !opts[:'shipping_state'].nil?
763
- query_params[:'shipping_postal_code'] = opts[:'shipping_postal_code'] if !opts[:'shipping_postal_code'].nil?
764
- query_params[:'shipping_country_code'] = opts[:'shipping_country_code'] if !opts[:'shipping_country_code'].nil?
765
- query_params[:'shipping_day_phone'] = opts[:'shipping_day_phone'] if !opts[:'shipping_day_phone'].nil?
766
- query_params[:'shipping_evening_phone'] = opts[:'shipping_evening_phone'] if !opts[:'shipping_evening_phone'].nil?
767
- query_params[:'pricing_tier_oid'] = opts[:'pricing_tier_oid'] if !opts[:'pricing_tier_oid'].nil?
768
- query_params[:'pricing_tier_name'] = opts[:'pricing_tier_name'] if !opts[:'pricing_tier_name'].nil?
769
- query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
770
- query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
771
- query_params[:'_since'] = opts[:'_since'] if !opts[:'_since'].nil?
772
- query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
773
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
774
-
775
- # header parameters
776
- header_params = {}
777
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
778
- # HTTP header 'Accept' (if needed)
779
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
780
- # HTTP header 'Content-Type'
781
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
782
-
783
- # form parameters
784
- form_params = {}
785
-
786
- # http body (model)
787
- post_body = nil
788
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
789
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
790
- :header_params => header_params,
791
- :query_params => query_params,
792
- :form_params => form_params,
793
- :body => post_body,
794
- :auth_names => auth_names,
795
- :return_type => 'CustomersResponse')
796
- if @api_client.config.debugging
797
- @api_client.config.logger.debug "API called: CustomerApi#get_customers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
798
- end
799
- return data, status_code, headers
800
- end
801
- # Retrieve customers by query
802
- # 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.
803
- # @param customer_query Customer query
804
- # @param [Hash] opts the optional parameters
805
- # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Max 200) (default to 100)
806
- # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
807
- # @option opts [String] :_since Fetch customers that have been created/modified since this date/time.
808
- # @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.
809
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
810
- # @return [CustomersResponse]
811
- def get_customers_by_query(customer_query, opts = {})
812
- data, _status_code, _headers = get_customers_by_query_with_http_info(customer_query, opts)
813
- data
814
- end
815
-
816
- # Retrieve customers by query
817
- # 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.
818
- # @param customer_query Customer query
819
- # @param [Hash] opts the optional parameters
820
- # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Max 200)
821
- # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index.
822
- # @option opts [String] :_since Fetch customers that have been created/modified since this date/time.
823
- # @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.
824
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
825
- # @return [Array<(CustomersResponse, Fixnum, Hash)>] CustomersResponse data, response status code and response headers
826
- def get_customers_by_query_with_http_info(customer_query, opts = {})
827
- if @api_client.config.debugging
828
- @api_client.config.logger.debug 'Calling API: CustomerApi.get_customers_by_query ...'
829
- end
830
- # verify the required parameter 'customer_query' is set
831
- if @api_client.config.client_side_validation && customer_query.nil?
832
- fail ArgumentError, "Missing the required parameter 'customer_query' when calling CustomerApi.get_customers_by_query"
833
- end
834
- # resource path
835
- local_var_path = '/customer/customers/query'
836
-
837
- # query parameters
838
- query_params = {}
839
- query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
840
- query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
841
- query_params[:'_since'] = opts[:'_since'] if !opts[:'_since'].nil?
842
- query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
843
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
844
-
845
- # header parameters
846
- header_params = {}
847
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
848
- # HTTP header 'Accept' (if needed)
849
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
850
- # HTTP header 'Content-Type'
851
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
852
-
853
- # form parameters
854
- form_params = {}
855
-
856
- # http body (model)
857
- post_body = @api_client.object_to_http_body(customer_query)
858
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
859
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
860
- :header_params => header_params,
861
- :query_params => query_params,
862
- :form_params => form_params,
863
- :body => post_body,
864
- :auth_names => auth_names,
865
- :return_type => 'CustomersResponse')
866
- if @api_client.config.debugging
867
- @api_client.config.logger.debug "API called: CustomerApi#get_customers_by_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
868
- end
869
- return data, status_code, headers
870
- end
871
- # Retrieve customers for DataTables plugin
872
- # Retrieves customers from the account. If no searches are specified, all customers will be returned.
873
- # @param [Hash] opts the optional parameters
874
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
875
- # @return [DataTablesServerSideResponse]
876
- def get_customers_for_data_tables(opts = {})
877
- data, _status_code, _headers = get_customers_for_data_tables_with_http_info(opts)
878
- data
879
- end
880
-
881
- # Retrieve customers for DataTables plugin
882
- # Retrieves customers from the account. If no searches are specified, all customers will be returned.
883
- # @param [Hash] opts the optional parameters
884
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
885
- # @return [Array<(DataTablesServerSideResponse, Fixnum, Hash)>] DataTablesServerSideResponse data, response status code and response headers
886
- def get_customers_for_data_tables_with_http_info(opts = {})
887
- if @api_client.config.debugging
888
- @api_client.config.logger.debug 'Calling API: CustomerApi.get_customers_for_data_tables ...'
889
- end
890
- # resource path
891
- local_var_path = '/customer/customers/dataTables'
892
-
893
- # query parameters
894
- query_params = {}
895
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
896
-
897
- # header parameters
898
- header_params = {}
899
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
900
- # HTTP header 'Accept' (if needed)
901
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
902
- # HTTP header 'Content-Type'
903
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
904
-
905
- # form parameters
906
- form_params = {}
907
-
908
- # http body (model)
909
- post_body = nil
910
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
911
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
912
- :header_params => header_params,
913
- :query_params => query_params,
914
- :form_params => form_params,
915
- :body => post_body,
916
- :auth_names => auth_names,
917
- :return_type => 'DataTablesServerSideResponse')
918
- if @api_client.config.debugging
919
- @api_client.config.logger.debug "API called: CustomerApi#get_customers_for_data_tables\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
920
- end
921
- return data, status_code, headers
922
- end
923
- # Create a token that can be used to verify a customer email address
924
- # 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.
925
- # @param token_request Token request
926
- # @param [Hash] opts the optional parameters
927
- # @return [EmailVerifyTokenResponse]
928
- def get_email_verification_token(token_request, opts = {})
929
- data, _status_code, _headers = get_email_verification_token_with_http_info(token_request, opts)
930
- data
931
- end
932
-
933
- # Create a token that can be used to verify a customer email address
934
- # 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.
935
- # @param token_request Token request
936
- # @param [Hash] opts the optional parameters
937
- # @return [Array<(EmailVerifyTokenResponse, Fixnum, Hash)>] EmailVerifyTokenResponse data, response status code and response headers
938
- def get_email_verification_token_with_http_info(token_request, opts = {})
939
- if @api_client.config.debugging
940
- @api_client.config.logger.debug 'Calling API: CustomerApi.get_email_verification_token ...'
941
- end
942
- # verify the required parameter 'token_request' is set
943
- if @api_client.config.client_side_validation && token_request.nil?
944
- fail ArgumentError, "Missing the required parameter 'token_request' when calling CustomerApi.get_email_verification_token"
945
- end
946
- # resource path
947
- local_var_path = '/customer/customers/email_verify/get_token'
948
-
949
- # query parameters
950
- query_params = {}
951
-
952
- # header parameters
953
- header_params = {}
954
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
955
- # HTTP header 'Accept' (if needed)
956
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
957
- # HTTP header 'Content-Type'
958
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
959
-
960
- # form parameters
961
- form_params = {}
962
-
963
- # http body (model)
964
- post_body = @api_client.object_to_http_body(token_request)
965
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
966
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
967
- :header_params => header_params,
968
- :query_params => query_params,
969
- :form_params => form_params,
970
- :body => post_body,
971
- :auth_names => auth_names,
972
- :return_type => 'EmailVerifyTokenResponse')
973
- if @api_client.config.debugging
974
- @api_client.config.logger.debug "API called: CustomerApi#get_email_verification_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
975
- end
976
- return data, status_code, headers
977
- end
978
- # getMagicLink
979
- # Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
980
- # @param customer_profile_oid The customer_profile_oid of the customer.
981
- # @param storefront_host_name The storefront to log into.
982
- # @param [Hash] opts the optional parameters
983
- # @return [CustomerMagicLinkResponse]
984
- def get_magic_link(customer_profile_oid, storefront_host_name, opts = {})
985
- data, _status_code, _headers = get_magic_link_with_http_info(customer_profile_oid, storefront_host_name, opts)
986
- data
987
- end
988
-
989
- # getMagicLink
990
- # Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
991
- # @param customer_profile_oid The customer_profile_oid of the customer.
992
- # @param storefront_host_name The storefront to log into.
993
- # @param [Hash] opts the optional parameters
994
- # @return [Array<(CustomerMagicLinkResponse, Fixnum, Hash)>] CustomerMagicLinkResponse data, response status code and response headers
995
- def get_magic_link_with_http_info(customer_profile_oid, storefront_host_name, opts = {})
996
- if @api_client.config.debugging
997
- @api_client.config.logger.debug 'Calling API: CustomerApi.get_magic_link ...'
998
- end
999
- # verify the required parameter 'customer_profile_oid' is set
1000
- if @api_client.config.client_side_validation && customer_profile_oid.nil?
1001
- fail ArgumentError, "Missing the required parameter 'customer_profile_oid' when calling CustomerApi.get_magic_link"
1002
- end
1003
- # verify the required parameter 'storefront_host_name' is set
1004
- if @api_client.config.client_side_validation && storefront_host_name.nil?
1005
- fail ArgumentError, "Missing the required parameter 'storefront_host_name' when calling CustomerApi.get_magic_link"
1006
- end
1007
- # resource path
1008
- local_var_path = '/customer/customers/{customer_profile_oid}/magic_link/{storefront_host_name}'.sub('{' + 'customer_profile_oid' + '}', customer_profile_oid.to_s).sub('{' + 'storefront_host_name' + '}', storefront_host_name.to_s)
1009
-
1010
- # query parameters
1011
- query_params = {}
1012
-
1013
- # header parameters
1014
- header_params = {}
1015
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1016
- # HTTP header 'Accept' (if needed)
1017
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1018
- # HTTP header 'Content-Type'
1019
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1020
-
1021
- # form parameters
1022
- form_params = {}
1023
-
1024
- # http body (model)
1025
- post_body = nil
1026
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1027
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1028
- :header_params => header_params,
1029
- :query_params => query_params,
1030
- :form_params => form_params,
1031
- :body => post_body,
1032
- :auth_names => auth_names,
1033
- :return_type => 'CustomerMagicLinkResponse')
1034
- if @api_client.config.debugging
1035
- @api_client.config.logger.debug "API called: CustomerApi#get_magic_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1036
- end
1037
- return data, status_code, headers
1038
- end
1039
- # Insert a customer
1040
- # Insert a customer on the UltraCart account.
1041
- # @param customer Customer to insert
1042
- # @param [Hash] opts the optional parameters
1043
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1044
- # @return [CustomerResponse]
1045
- def insert_customer(customer, opts = {})
1046
- data, _status_code, _headers = insert_customer_with_http_info(customer, opts)
1047
- data
1048
- end
1049
-
1050
- # Insert a customer
1051
- # Insert a customer on the UltraCart account.
1052
- # @param customer Customer to insert
1053
- # @param [Hash] opts the optional parameters
1054
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1055
- # @return [Array<(CustomerResponse, Fixnum, Hash)>] CustomerResponse data, response status code and response headers
1056
- def insert_customer_with_http_info(customer, opts = {})
1057
- if @api_client.config.debugging
1058
- @api_client.config.logger.debug 'Calling API: CustomerApi.insert_customer ...'
1059
- end
1060
- # verify the required parameter 'customer' is set
1061
- if @api_client.config.client_side_validation && customer.nil?
1062
- fail ArgumentError, "Missing the required parameter 'customer' when calling CustomerApi.insert_customer"
1063
- end
1064
- # resource path
1065
- local_var_path = '/customer/customers'
1066
-
1067
- # query parameters
1068
- query_params = {}
1069
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1070
-
1071
- # header parameters
1072
- header_params = {}
1073
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1074
- # HTTP header 'Accept' (if needed)
1075
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1076
- # HTTP header 'Content-Type'
1077
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1078
-
1079
- # form parameters
1080
- form_params = {}
1081
-
1082
- # http body (model)
1083
- post_body = @api_client.object_to_http_body(customer)
1084
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1085
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1086
- :header_params => header_params,
1087
- :query_params => query_params,
1088
- :form_params => form_params,
1089
- :body => post_body,
1090
- :auth_names => auth_names,
1091
- :return_type => 'CustomerResponse')
1092
- if @api_client.config.debugging
1093
- @api_client.config.logger.debug "API called: CustomerApi#insert_customer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1094
- end
1095
- return data, status_code, headers
1096
- end
1097
- # Insert a customer wishlist item
1098
- # Insert a customer wishlist item
1099
- # @param wishlist_item Wishlist item to insert
1100
- # @param customer_profile_oid The customer oid for this wishlist.
1101
- # @param [Hash] opts the optional parameters
1102
- # @return [CustomerWishListItem]
1103
- def insert_wish_list_item(wishlist_item, customer_profile_oid, opts = {})
1104
- data, _status_code, _headers = insert_wish_list_item_with_http_info(wishlist_item, customer_profile_oid, opts)
1105
- data
1106
- end
1107
-
1108
- # Insert a customer wishlist item
1109
- # Insert a customer wishlist item
1110
- # @param wishlist_item Wishlist item to insert
1111
- # @param customer_profile_oid The customer oid for this wishlist.
1112
- # @param [Hash] opts the optional parameters
1113
- # @return [Array<(CustomerWishListItem, Fixnum, Hash)>] CustomerWishListItem data, response status code and response headers
1114
- def insert_wish_list_item_with_http_info(wishlist_item, customer_profile_oid, opts = {})
1115
- if @api_client.config.debugging
1116
- @api_client.config.logger.debug 'Calling API: CustomerApi.insert_wish_list_item ...'
1117
- end
1118
- # verify the required parameter 'wishlist_item' is set
1119
- if @api_client.config.client_side_validation && wishlist_item.nil?
1120
- fail ArgumentError, "Missing the required parameter 'wishlist_item' when calling CustomerApi.insert_wish_list_item"
1121
- end
1122
- # verify the required parameter 'customer_profile_oid' is set
1123
- if @api_client.config.client_side_validation && customer_profile_oid.nil?
1124
- fail ArgumentError, "Missing the required parameter 'customer_profile_oid' when calling CustomerApi.insert_wish_list_item"
1125
- end
1126
- # resource path
1127
- local_var_path = '/customer/customers/{customer_profile_oid}/wishlist'.sub('{' + 'customer_profile_oid' + '}', customer_profile_oid.to_s)
1128
-
1129
- # query parameters
1130
- query_params = {}
1131
-
1132
- # header parameters
1133
- header_params = {}
1134
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1135
- # HTTP header 'Accept' (if needed)
1136
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1137
- # HTTP header 'Content-Type'
1138
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1139
-
1140
- # form parameters
1141
- form_params = {}
1142
-
1143
- # http body (model)
1144
- post_body = @api_client.object_to_http_body(wishlist_item)
1145
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1146
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1147
- :header_params => header_params,
1148
- :query_params => query_params,
1149
- :form_params => form_params,
1150
- :body => post_body,
1151
- :auth_names => auth_names,
1152
- :return_type => 'CustomerWishListItem')
1153
- if @api_client.config.debugging
1154
- @api_client.config.logger.debug "API called: CustomerApi#insert_wish_list_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1155
- end
1156
- return data, status_code, headers
1157
- end
1158
- # Merge customer into this customer
1159
- # Merge customer into this customer.
1160
- # @param customer Customer to merge into this profile.
1161
- # @param customer_profile_oid The customer_profile_oid to update.
1162
- # @param [Hash] opts the optional parameters
1163
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1164
- # @return [nil]
1165
- def merge_customer(customer, customer_profile_oid, opts = {})
1166
- merge_customer_with_http_info(customer, customer_profile_oid, opts)
1167
- nil
1168
- end
1169
-
1170
- # Merge customer into this customer
1171
- # Merge customer into this customer.
1172
- # @param customer Customer to merge into this profile.
1173
- # @param customer_profile_oid The customer_profile_oid to update.
1174
- # @param [Hash] opts the optional parameters
1175
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1176
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1177
- def merge_customer_with_http_info(customer, customer_profile_oid, opts = {})
1178
- if @api_client.config.debugging
1179
- @api_client.config.logger.debug 'Calling API: CustomerApi.merge_customer ...'
1180
- end
1181
- # verify the required parameter 'customer' is set
1182
- if @api_client.config.client_side_validation && customer.nil?
1183
- fail ArgumentError, "Missing the required parameter 'customer' when calling CustomerApi.merge_customer"
1184
- end
1185
- # verify the required parameter 'customer_profile_oid' is set
1186
- if @api_client.config.client_side_validation && customer_profile_oid.nil?
1187
- fail ArgumentError, "Missing the required parameter 'customer_profile_oid' when calling CustomerApi.merge_customer"
1188
- end
1189
- # resource path
1190
- local_var_path = '/customer/customers/{customer_profile_oid}/merge'.sub('{' + 'customer_profile_oid' + '}', customer_profile_oid.to_s)
1191
-
1192
- # query parameters
1193
- query_params = {}
1194
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1195
-
1196
- # header parameters
1197
- header_params = {}
1198
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1199
- # HTTP header 'Accept' (if needed)
1200
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1201
- # HTTP header 'Content-Type'
1202
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1203
-
1204
- # form parameters
1205
- form_params = {}
1206
-
1207
- # http body (model)
1208
- post_body = @api_client.object_to_http_body(customer)
1209
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1210
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1211
- :header_params => header_params,
1212
- :query_params => query_params,
1213
- :form_params => form_params,
1214
- :body => post_body,
1215
- :auth_names => auth_names)
1216
- if @api_client.config.debugging
1217
- @api_client.config.logger.debug "API called: CustomerApi#merge_customer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1218
- end
1219
- return data, status_code, headers
1220
- end
1221
- # Searches for all matching values (using POST)
1222
- # @param lookup_request LookupRequest
1223
- # @param [Hash] opts the optional parameters
1224
- # @return [LookupResponse]
1225
- def search_customer_profile_values(lookup_request, opts = {})
1226
- data, _status_code, _headers = search_customer_profile_values_with_http_info(lookup_request, opts)
1227
- data
1228
- end
1229
-
1230
- # Searches for all matching values (using POST)
1231
- # @param lookup_request LookupRequest
1232
- # @param [Hash] opts the optional parameters
1233
- # @return [Array<(LookupResponse, Fixnum, Hash)>] LookupResponse data, response status code and response headers
1234
- def search_customer_profile_values_with_http_info(lookup_request, opts = {})
1235
- if @api_client.config.debugging
1236
- @api_client.config.logger.debug 'Calling API: CustomerApi.search_customer_profile_values ...'
1237
- end
1238
- # verify the required parameter 'lookup_request' is set
1239
- if @api_client.config.client_side_validation && lookup_request.nil?
1240
- fail ArgumentError, "Missing the required parameter 'lookup_request' when calling CustomerApi.search_customer_profile_values"
1241
- end
1242
- # resource path
1243
- local_var_path = '/customer/search'
1244
-
1245
- # query parameters
1246
- query_params = {}
1247
-
1248
- # header parameters
1249
- header_params = {}
1250
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1251
- # HTTP header 'Accept' (if needed)
1252
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1253
- # HTTP header 'Content-Type'
1254
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1255
-
1256
- # form parameters
1257
- form_params = {}
1258
-
1259
- # http body (model)
1260
- post_body = @api_client.object_to_http_body(lookup_request)
1261
- auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
1262
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1263
- :header_params => header_params,
1264
- :query_params => query_params,
1265
- :form_params => form_params,
1266
- :body => post_body,
1267
- :auth_names => auth_names,
1268
- :return_type => 'LookupResponse')
1269
- if @api_client.config.debugging
1270
- @api_client.config.logger.debug "API called: CustomerApi#search_customer_profile_values\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1271
- end
1272
- return data, status_code, headers
1273
- end
1274
- # Search for customers
1275
- # Retrieves customers from the account by matching the search value against most customer fields. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. This search also goes against the cache so updates should not be performed with these result objects. Always re-query the individual customer profile if you are going to make updates.
1276
- # @param [Hash] opts the optional parameters
1277
- # @option opts [String] :search_string Search
1278
- # @option opts [String] :signup_dts_start Signup date start
1279
- # @option opts [String] :signup_dts_end Signup date end
1280
- # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Max 200) (default to 100)
1281
- # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
1282
- # @option opts [String] :_since Fetch customers that have been created/modified since this date/time.
1283
- # @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.
1284
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1285
- # @return [CustomersResponse]
1286
- def search_customers(opts = {})
1287
- data, _status_code, _headers = search_customers_with_http_info(opts)
1288
- data
1289
- end
1290
-
1291
- # Search for customers
1292
- # Retrieves customers from the account by matching the search value against most customer fields. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. This search also goes against the cache so updates should not be performed with these result objects. Always re-query the individual customer profile if you are going to make updates.
1293
- # @param [Hash] opts the optional parameters
1294
- # @option opts [String] :search_string Search
1295
- # @option opts [String] :signup_dts_start Signup date start
1296
- # @option opts [String] :signup_dts_end Signup date end
1297
- # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Max 200)
1298
- # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index.
1299
- # @option opts [String] :_since Fetch customers that have been created/modified since this date/time.
1300
- # @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.
1301
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1302
- # @return [Array<(CustomersResponse, Fixnum, Hash)>] CustomersResponse data, response status code and response headers
1303
- def search_customers_with_http_info(opts = {})
1304
- if @api_client.config.debugging
1305
- @api_client.config.logger.debug 'Calling API: CustomerApi.search_customers ...'
1306
- end
1307
- # resource path
1308
- local_var_path = '/customer/customers/search'
1309
-
1310
- # query parameters
1311
- query_params = {}
1312
- query_params[:'search_string'] = opts[:'search_string'] if !opts[:'search_string'].nil?
1313
- query_params[:'signup_dts_start'] = opts[:'signup_dts_start'] if !opts[:'signup_dts_start'].nil?
1314
- query_params[:'signup_dts_end'] = opts[:'signup_dts_end'] if !opts[:'signup_dts_end'].nil?
1315
- query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
1316
- query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
1317
- query_params[:'_since'] = opts[:'_since'] if !opts[:'_since'].nil?
1318
- query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
1319
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1320
-
1321
- # header parameters
1322
- header_params = {}
1323
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1324
- # HTTP header 'Accept' (if needed)
1325
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1326
- # HTTP header 'Content-Type'
1327
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1328
-
1329
- # form parameters
1330
- form_params = {}
1331
-
1332
- # http body (model)
1333
- post_body = nil
1334
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1335
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1336
- :header_params => header_params,
1337
- :query_params => query_params,
1338
- :form_params => form_params,
1339
- :body => post_body,
1340
- :auth_names => auth_names,
1341
- :return_type => 'CustomersResponse')
1342
- if @api_client.config.debugging
1343
- @api_client.config.logger.debug "API called: CustomerApi#search_customers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1344
- end
1345
- return data, status_code, headers
1346
- end
1347
- # Update a customer
1348
- # Update a customer on the UltraCart account.
1349
- # @param customer Customer to update
1350
- # @param customer_profile_oid The customer_profile_oid to update.
1351
- # @param [Hash] opts the optional parameters
1352
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1353
- # @return [CustomerResponse]
1354
- def update_customer(customer, customer_profile_oid, opts = {})
1355
- data, _status_code, _headers = update_customer_with_http_info(customer, customer_profile_oid, opts)
1356
- data
1357
- end
1358
-
1359
- # Update a customer
1360
- # Update a customer on the UltraCart account.
1361
- # @param customer Customer to update
1362
- # @param customer_profile_oid The customer_profile_oid to update.
1363
- # @param [Hash] opts the optional parameters
1364
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
1365
- # @return [Array<(CustomerResponse, Fixnum, Hash)>] CustomerResponse data, response status code and response headers
1366
- def update_customer_with_http_info(customer, customer_profile_oid, opts = {})
1367
- if @api_client.config.debugging
1368
- @api_client.config.logger.debug 'Calling API: CustomerApi.update_customer ...'
1369
- end
1370
- # verify the required parameter 'customer' is set
1371
- if @api_client.config.client_side_validation && customer.nil?
1372
- fail ArgumentError, "Missing the required parameter 'customer' when calling CustomerApi.update_customer"
1373
- end
1374
- # verify the required parameter 'customer_profile_oid' is set
1375
- if @api_client.config.client_side_validation && customer_profile_oid.nil?
1376
- fail ArgumentError, "Missing the required parameter 'customer_profile_oid' when calling CustomerApi.update_customer"
1377
- end
1378
- # resource path
1379
- local_var_path = '/customer/customers/{customer_profile_oid}'.sub('{' + 'customer_profile_oid' + '}', customer_profile_oid.to_s)
1380
-
1381
- # query parameters
1382
- query_params = {}
1383
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
1384
-
1385
- # header parameters
1386
- header_params = {}
1387
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1388
- # HTTP header 'Accept' (if needed)
1389
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1390
- # HTTP header 'Content-Type'
1391
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1392
-
1393
- # form parameters
1394
- form_params = {}
1395
-
1396
- # http body (model)
1397
- post_body = @api_client.object_to_http_body(customer)
1398
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1399
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1400
- :header_params => header_params,
1401
- :query_params => query_params,
1402
- :form_params => form_params,
1403
- :body => post_body,
1404
- :auth_names => auth_names,
1405
- :return_type => 'CustomerResponse')
1406
- if @api_client.config.debugging
1407
- @api_client.config.logger.debug "API called: CustomerApi#update_customer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1408
- end
1409
- return data, status_code, headers
1410
- end
1411
- # Update email list subscriptions for a customer
1412
- # Update email list subscriptions for a customer
1413
- # @param customer_profile_oid The customer profile oid
1414
- # @param list_changes List changes
1415
- # @param [Hash] opts the optional parameters
1416
- # @return [CustomerEmailListChanges]
1417
- def update_customer_email_lists(customer_profile_oid, list_changes, opts = {})
1418
- data, _status_code, _headers = update_customer_email_lists_with_http_info(customer_profile_oid, list_changes, opts)
1419
- data
1420
- end
1421
-
1422
- # Update email list subscriptions for a customer
1423
- # Update email list subscriptions for a customer
1424
- # @param customer_profile_oid The customer profile oid
1425
- # @param list_changes List changes
1426
- # @param [Hash] opts the optional parameters
1427
- # @return [Array<(CustomerEmailListChanges, Fixnum, Hash)>] CustomerEmailListChanges data, response status code and response headers
1428
- def update_customer_email_lists_with_http_info(customer_profile_oid, list_changes, opts = {})
1429
- if @api_client.config.debugging
1430
- @api_client.config.logger.debug 'Calling API: CustomerApi.update_customer_email_lists ...'
1431
- end
1432
- # verify the required parameter 'customer_profile_oid' is set
1433
- if @api_client.config.client_side_validation && customer_profile_oid.nil?
1434
- fail ArgumentError, "Missing the required parameter 'customer_profile_oid' when calling CustomerApi.update_customer_email_lists"
1435
- end
1436
- # verify the required parameter 'list_changes' is set
1437
- if @api_client.config.client_side_validation && list_changes.nil?
1438
- fail ArgumentError, "Missing the required parameter 'list_changes' when calling CustomerApi.update_customer_email_lists"
1439
- end
1440
- # resource path
1441
- local_var_path = '/customer/customers/{customer_profile_oid}/email_lists'.sub('{' + 'customer_profile_oid' + '}', customer_profile_oid.to_s)
1442
-
1443
- # query parameters
1444
- query_params = {}
1445
-
1446
- # header parameters
1447
- header_params = {}
1448
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1449
- # HTTP header 'Accept' (if needed)
1450
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1451
- # HTTP header 'Content-Type'
1452
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1453
-
1454
- # form parameters
1455
- form_params = {}
1456
-
1457
- # http body (model)
1458
- post_body = @api_client.object_to_http_body(list_changes)
1459
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1460
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1461
- :header_params => header_params,
1462
- :query_params => query_params,
1463
- :form_params => form_params,
1464
- :body => post_body,
1465
- :auth_names => auth_names,
1466
- :return_type => 'CustomerEmailListChanges')
1467
- if @api_client.config.debugging
1468
- @api_client.config.logger.debug "API called: CustomerApi#update_customer_email_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1469
- end
1470
- return data, status_code, headers
1471
- end
1472
- # Update a customer wishlist item
1473
- # Update a customer wishlist item
1474
- # @param wishlist_item Wishlist item to update
1475
- # @param customer_profile_oid The customer oid for this wishlist.
1476
- # @param customer_wishlist_item_oid The wishlist oid for this wishlist item.
1477
- # @param [Hash] opts the optional parameters
1478
- # @return [CustomerWishListItem]
1479
- def update_wish_list_item(wishlist_item, customer_profile_oid, customer_wishlist_item_oid, opts = {})
1480
- data, _status_code, _headers = update_wish_list_item_with_http_info(wishlist_item, customer_profile_oid, customer_wishlist_item_oid, opts)
1481
- data
1482
- end
1483
-
1484
- # Update a customer wishlist item
1485
- # Update a customer wishlist item
1486
- # @param wishlist_item Wishlist item to update
1487
- # @param customer_profile_oid The customer oid for this wishlist.
1488
- # @param customer_wishlist_item_oid The wishlist oid for this wishlist item.
1489
- # @param [Hash] opts the optional parameters
1490
- # @return [Array<(CustomerWishListItem, Fixnum, Hash)>] CustomerWishListItem data, response status code and response headers
1491
- def update_wish_list_item_with_http_info(wishlist_item, customer_profile_oid, customer_wishlist_item_oid, opts = {})
1492
- if @api_client.config.debugging
1493
- @api_client.config.logger.debug 'Calling API: CustomerApi.update_wish_list_item ...'
1494
- end
1495
- # verify the required parameter 'wishlist_item' is set
1496
- if @api_client.config.client_side_validation && wishlist_item.nil?
1497
- fail ArgumentError, "Missing the required parameter 'wishlist_item' when calling CustomerApi.update_wish_list_item"
1498
- end
1499
- # verify the required parameter 'customer_profile_oid' is set
1500
- if @api_client.config.client_side_validation && customer_profile_oid.nil?
1501
- fail ArgumentError, "Missing the required parameter 'customer_profile_oid' when calling CustomerApi.update_wish_list_item"
1502
- end
1503
- # verify the required parameter 'customer_wishlist_item_oid' is set
1504
- if @api_client.config.client_side_validation && customer_wishlist_item_oid.nil?
1505
- fail ArgumentError, "Missing the required parameter 'customer_wishlist_item_oid' when calling CustomerApi.update_wish_list_item"
1506
- end
1507
- # resource path
1508
- local_var_path = '/customer/customers/{customer_profile_oid}/wishlist/{customer_wishlist_item_oid}'.sub('{' + 'customer_profile_oid' + '}', customer_profile_oid.to_s).sub('{' + 'customer_wishlist_item_oid' + '}', customer_wishlist_item_oid.to_s)
1509
-
1510
- # query parameters
1511
- query_params = {}
1512
-
1513
- # header parameters
1514
- header_params = {}
1515
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1516
- # HTTP header 'Accept' (if needed)
1517
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1518
- # HTTP header 'Content-Type'
1519
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1520
-
1521
- # form parameters
1522
- form_params = {}
1523
-
1524
- # http body (model)
1525
- post_body = @api_client.object_to_http_body(wishlist_item)
1526
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1527
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1528
- :header_params => header_params,
1529
- :query_params => query_params,
1530
- :form_params => form_params,
1531
- :body => post_body,
1532
- :auth_names => auth_names,
1533
- :return_type => 'CustomerWishListItem')
1534
- if @api_client.config.debugging
1535
- @api_client.config.logger.debug "API called: CustomerApi#update_wish_list_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1536
- end
1537
- return data, status_code, headers
1538
- end
1539
- # Validate a token that can be used to verify a customer email address
1540
- # 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.
1541
- # @param validation_request Token validation request
1542
- # @param [Hash] opts the optional parameters
1543
- # @return [EmailVerifyTokenValidateResponse]
1544
- def validate_email_verification_token(validation_request, opts = {})
1545
- data, _status_code, _headers = validate_email_verification_token_with_http_info(validation_request, opts)
1546
- data
1547
- end
1548
-
1549
- # Validate a token that can be used to verify a customer email address
1550
- # 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.
1551
- # @param validation_request Token validation request
1552
- # @param [Hash] opts the optional parameters
1553
- # @return [Array<(EmailVerifyTokenValidateResponse, Fixnum, Hash)>] EmailVerifyTokenValidateResponse data, response status code and response headers
1554
- def validate_email_verification_token_with_http_info(validation_request, opts = {})
1555
- if @api_client.config.debugging
1556
- @api_client.config.logger.debug 'Calling API: CustomerApi.validate_email_verification_token ...'
1557
- end
1558
- # verify the required parameter 'validation_request' is set
1559
- if @api_client.config.client_side_validation && validation_request.nil?
1560
- fail ArgumentError, "Missing the required parameter 'validation_request' when calling CustomerApi.validate_email_verification_token"
1561
- end
1562
- # resource path
1563
- local_var_path = '/customer/customers/email_verify/validate_token'
1564
-
1565
- # query parameters
1566
- query_params = {}
1567
-
1568
- # header parameters
1569
- header_params = {}
1570
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1571
- # HTTP header 'Accept' (if needed)
1572
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1573
- # HTTP header 'Content-Type'
1574
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1575
-
1576
- # form parameters
1577
- form_params = {}
1578
-
1579
- # http body (model)
1580
- post_body = @api_client.object_to_http_body(validation_request)
1581
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1582
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1583
- :header_params => header_params,
1584
- :query_params => query_params,
1585
- :form_params => form_params,
1586
- :body => post_body,
1587
- :auth_names => auth_names,
1588
- :return_type => 'EmailVerifyTokenValidateResponse')
1589
- if @api_client.config.debugging
1590
- @api_client.config.logger.debug "API called: CustomerApi#validate_email_verification_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1591
- end
1592
- return data, status_code, headers
1593
- end
1594
- end
1595
- 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