ultracart_api 3.10.152 → 4.0.32.rc

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1609) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +9 -7
  3. data/README.md +1166 -1489
  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 -31
  28. data/docs/AutoOrderApi.md +693 -557
  29. data/docs/AutoOrderItem.md +64 -33
  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 -24
  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 -14
  72. data/docs/CartPaymentAffirm.md +18 -8
  73. data/docs/CartPaymentAmazon.md +18 -8
  74. data/docs/CartPaymentCheck.md +18 -8
  75. data/docs/CartPaymentCreditCard.md +34 -16
  76. data/docs/CartPaymentPurchaseOrder.md +18 -8
  77. data/docs/CartProfileLoginRequest.md +22 -10
  78. data/docs/CartProfileLoginResponse.md +20 -9
  79. data/docs/CartProfileRegisterRequest.md +20 -9
  80. data/docs/CartProfileRegisterResponse.md +20 -9
  81. data/docs/CartProperty.md +24 -11
  82. data/docs/CartResponse.md +20 -9
  83. data/docs/CartSettings.md +28 -13
  84. data/docs/CartSettingsBilling.md +18 -8
  85. data/docs/CartSettingsGift.md +24 -11
  86. data/docs/CartSettingsGiftWrap.md +22 -10
  87. data/docs/CartSettingsPayment.md +42 -20
  88. data/docs/CartSettingsPaymentAmazon.md +22 -10
  89. data/docs/CartSettingsPaymentCreditCard.md +22 -10
  90. data/docs/CartSettingsPaymentPayPal.md +26 -12
  91. data/docs/CartSettingsProvince.md +20 -9
  92. data/docs/CartSettingsShipping.md +26 -12
  93. data/docs/CartSettingsShippingCalendar.md +26 -12
  94. data/docs/CartSettingsShippingEstimate.md +44 -21
  95. data/docs/CartSettingsTaxes.md +18 -8
  96. data/docs/CartSettingsTerms.md +20 -9
  97. data/docs/CartShipping.md +54 -26
  98. data/docs/CartSummary.md +48 -23
  99. data/docs/CartTaxes.md +22 -10
  100. data/docs/CartUpsellAfter.md +22 -10
  101. data/docs/CartValidationRequest.md +20 -9
  102. data/docs/CartValidationResponse.md +20 -9
  103. data/docs/ChannelPartnerApi.md +382 -578
  104. data/docs/ChannelPartnerCancelResponse.md +26 -12
  105. data/docs/ChannelPartnerEstimateShippingResponse.md +26 -12
  106. data/docs/ChannelPartnerEstimateTaxResponse.md +26 -12
  107. data/docs/ChannelPartnerImportResponse.md +30 -14
  108. data/docs/ChannelPartnerOrder.md +176 -87
  109. data/docs/ChannelPartnerOrderItem.md +30 -14
  110. data/docs/ChannelPartnerOrderItemOption.md +20 -9
  111. data/docs/ChannelPartnerOrderTransaction.md +20 -9
  112. data/docs/ChannelPartnerOrderTransactionDetail.md +20 -9
  113. data/docs/ChannelPartnerShippingEstimate.md +20 -9
  114. data/docs/ChargebackApi.md +420 -301
  115. data/docs/ChargebackDispute.md +62 -30
  116. data/docs/ChargebackDisputeResponse.md +26 -12
  117. data/docs/ChargebackDisputesResponse.md +26 -12
  118. data/docs/CheckoutAllowedCountriesResponse.md +18 -8
  119. data/docs/CheckoutApi.md +1566 -1023
  120. data/docs/CheckoutHandoffRequest.md +32 -15
  121. data/docs/CheckoutHandoffResponse.md +22 -10
  122. data/docs/CheckoutSetupBrowserKeyRequest.md +18 -8
  123. data/docs/CheckoutSetupBrowserKeyResponse.md +18 -8
  124. data/docs/CheckoutStateProvinceResponse.md +18 -8
  125. data/docs/CityStateZip.md +26 -12
  126. data/docs/CountriesResponse.md +18 -8
  127. data/docs/Country.md +20 -9
  128. data/docs/Coupon.md +136 -73
  129. data/docs/CouponAmountOffItems.md +24 -11
  130. data/docs/CouponAmountOffShipping.md +22 -10
  131. data/docs/CouponAmountOffShippingWithItemsPurchase.md +24 -11
  132. data/docs/CouponAmountOffSubtotal.md +20 -9
  133. data/docs/CouponAmountOffSubtotalAndShipping.md +20 -9
  134. data/docs/CouponAmountOffSubtotalFreeShippingWithPurchase.md +24 -11
  135. data/docs/CouponAmountOffSubtotalWithBlockPurchase.md +24 -11
  136. data/docs/CouponAmountOffSubtotalWithItemsPurchase.md +24 -11
  137. data/docs/CouponAmountOffSubtotalWithPurchase.md +22 -10
  138. data/docs/CouponAmountShippingWithSubtotal.md +24 -11
  139. data/docs/CouponApi.md +1500 -1043
  140. data/docs/CouponAutoApplyCondition.md +22 -10
  141. data/docs/CouponAutoApplyConditions.md +28 -13
  142. data/docs/CouponAutomaticallyApplyCouponCodes.md +18 -8
  143. data/docs/CouponBuyOneGetOneLimit.md +20 -9
  144. data/docs/CouponCodesRequest.md +30 -14
  145. data/docs/CouponCodesResponse.md +28 -13
  146. data/docs/CouponDeletesRequest.md +20 -9
  147. data/docs/CouponDiscountItemWithItemPurchase.md +26 -12
  148. data/docs/CouponDiscountItems.md +24 -11
  149. data/docs/CouponEditorValues.md +36 -17
  150. data/docs/CouponExistsResponse.md +28 -13
  151. data/docs/CouponFreeItemAndShippingWithSubtotal.md +26 -12
  152. data/docs/CouponFreeItemWithItemPurchase.md +24 -11
  153. data/docs/CouponFreeItemWithSubtotal.md +24 -11
  154. data/docs/CouponFreeItemsWithItemPurchase.md +26 -12
  155. data/docs/CouponFreeItemsWithMixMatchPurchase.md +26 -12
  156. data/docs/CouponFreeShipping.md +18 -8
  157. data/docs/CouponFreeShippingSpecificItems.md +18 -8
  158. data/docs/CouponFreeShippingWithItemsPurchase.md +20 -9
  159. data/docs/CouponFreeShippingWithSubtotal.md +22 -10
  160. data/docs/CouponItemSearchResult.md +32 -15
  161. data/docs/CouponItemSearchResultsResponse.md +26 -12
  162. data/docs/CouponMultipleAmountsOffItems.md +20 -9
  163. data/docs/CouponPercentOffItemWithItemsQuantityPurchase.md +26 -12
  164. data/docs/CouponPercentOffItems.md +24 -11
  165. data/docs/CouponPercentOffItemsAndFreeShipping.md +22 -10
  166. data/docs/CouponPercentOffItemsWithItemsPurchase.md +24 -11
  167. data/docs/CouponPercentOffMsrpItems.md +24 -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 -10
  184. data/docs/CouponTieredAmountOffSubtotal.md +20 -9
  185. data/docs/CouponTieredPercentOffItems.md +22 -10
  186. data/docs/CouponTieredPercentOffShipping.md +22 -10
  187. data/docs/CouponTieredPercentOffSubtotal.md +20 -9
  188. data/docs/CouponType.md +20 -9
  189. data/docs/CouponsRequest.md +18 -8
  190. data/docs/CouponsResponse.md +26 -12
  191. data/docs/Currency.md +26 -12
  192. data/docs/Customer.md +134 -69
  193. data/docs/CustomerActivity.md +24 -15
  194. data/docs/CustomerAffiliate.md +24 -11
  195. data/docs/CustomerApi.md +1380 -1077
  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 -14
  203. data/docs/CustomerLoyaltyLedger.md +46 -22
  204. data/docs/CustomerLoyaltyRedemption.md +42 -20
  205. data/docs/CustomerOrdersSummary.md +24 -11
  206. data/docs/CustomerPricingTier.md +20 -9
  207. data/docs/CustomerPrivacy.md +24 -11
  208. data/docs/CustomerQuery.md +74 -36
  209. data/docs/CustomerQuotesSummary.md +24 -11
  210. data/docs/CustomerResponse.md +26 -12
  211. data/docs/CustomerReviewer.md +36 -17
  212. data/docs/CustomerShipping.md +50 -24
  213. data/docs/CustomerSoftwareEntitlement.md +32 -15
  214. data/docs/CustomerStoreCredit.md +28 -13
  215. data/docs/CustomerStoreCreditAddRequest.md +24 -11
  216. data/docs/CustomerStoreCreditLedgerEntry.md +30 -14
  217. data/docs/CustomerStoreCreditResponse.md +26 -12
  218. data/docs/CustomerTag.md +18 -8
  219. data/docs/CustomerTaxCodes.md +26 -12
  220. data/docs/CustomersResponse.md +26 -12
  221. data/docs/DataTablesServerSideResponse.md +24 -11
  222. data/docs/Distance.md +20 -9
  223. data/docs/DistributionCenter.md +86 -57
  224. data/docs/DistributionCentersResponse.md +26 -12
  225. data/docs/EmailBaseTemplateListResponse.md +18 -8
  226. data/docs/EmailCampaign.md +64 -33
  227. data/docs/EmailCampaignFolder.md +26 -12
  228. data/docs/EmailCampaignFolderResponse.md +26 -12
  229. data/docs/EmailCampaignFoldersResponse.md +26 -12
  230. data/docs/EmailCampaignResponse.md +26 -12
  231. data/docs/EmailCampaignsResponse.md +26 -12
  232. data/docs/EmailClick.md +20 -9
  233. data/docs/EmailClicksResponse.md +26 -12
  234. data/docs/EmailCommseq.md +24 -11
  235. data/docs/EmailCommseqEmail.md +68 -33
  236. data/docs/EmailCommseqEmailResponse.md +26 -12
  237. data/docs/EmailCommseqEmailSendTestRequest.md +36 -17
  238. data/docs/EmailCommseqEmailSendTestResponse.md +24 -11
  239. data/docs/EmailCommseqEmailsRequest.md +26 -12
  240. data/docs/EmailCommseqEmailsResponse.md +26 -12
  241. data/docs/EmailCommseqPostcard.md +42 -20
  242. data/docs/EmailCommseqPostcardResponse.md +26 -12
  243. data/docs/EmailCommseqPostcardSendTestRequest.md +42 -20
  244. data/docs/EmailCommseqPostcardSendTestResponse.md +30 -14
  245. data/docs/EmailCommseqPostcardsRequest.md +18 -8
  246. data/docs/EmailCommseqPostcardsResponse.md +26 -12
  247. data/docs/EmailCommseqResponse.md +26 -12
  248. data/docs/EmailCommseqStat.md +90 -44
  249. data/docs/EmailCommseqStatResponse.md +26 -12
  250. data/docs/EmailCommseqStep.md +36 -17
  251. data/docs/EmailCommseqStepLog.md +22 -10
  252. data/docs/EmailCommseqStepLogsResponse.md +26 -12
  253. data/docs/EmailCommseqWebhookSendTestRequest.md +30 -14
  254. data/docs/EmailCommseqWebhookSendTestResponse.md +30 -14
  255. data/docs/EmailCommseqsResponse.md +26 -12
  256. data/docs/EmailCustomer.md +32 -15
  257. data/docs/EmailCustomerEditorUrlResponse.md +26 -12
  258. data/docs/EmailCustomersResponse.md +26 -12
  259. data/docs/EmailDashboardActivity.md +30 -14
  260. data/docs/EmailDashboardActivityResponse.md +26 -12
  261. data/docs/EmailDashboardStatsResponse.md +26 -12
  262. data/docs/EmailDomain.md +42 -20
  263. data/docs/EmailEditorTokenResponse.md +26 -12
  264. data/docs/EmailFlow.md +72 -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 -22
  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 -19
  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 -1167
  374. data/docs/ItemAutoOrder.md +50 -29
  375. data/docs/ItemAutoOrderStep.md +46 -22
  376. data/docs/ItemAutoOrderStepArbitraryUnitCostSchedule.md +20 -9
  377. data/docs/ItemAutoOrderStepGrandfatherPricing.md +20 -9
  378. data/docs/ItemCCBill.md +28 -13
  379. data/docs/ItemChannelPartnerMapping.md +54 -26
  380. data/docs/ItemChargeback.md +20 -9
  381. data/docs/ItemChargebackAddendum.md +24 -11
  382. data/docs/ItemChargebackAdjustmentRequest.md +22 -10
  383. data/docs/ItemCheckout.md +24 -11
  384. data/docs/ItemContent.md +42 -20
  385. data/docs/ItemContentAssignment.md +28 -13
  386. data/docs/ItemContentAttribute.md +24 -11
  387. data/docs/ItemContentMultimedia.md +46 -22
  388. data/docs/ItemContentMultimediaThumbnail.md +28 -13
  389. data/docs/ItemDigitalDelivery.md +28 -13
  390. data/docs/ItemDigitalItem.md +26 -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 -11
  401. data/docs/ItemInstantPaymentNotification.md +22 -10
  402. data/docs/ItemInstantPaymentNotifications.md +18 -8
  403. data/docs/ItemInternal.md +18 -8
  404. data/docs/ItemKitComponent.md +26 -12
  405. data/docs/ItemKitDefinition.md +18 -8
  406. data/docs/ItemOption.md +44 -21
  407. data/docs/ItemOptionValue.md +46 -22
  408. data/docs/ItemOptionValueAdditionalItem.md +20 -9
  409. data/docs/ItemOptionValueDigitalItem.md +20 -9
  410. data/docs/ItemPaymentProcessing.md +26 -12
  411. data/docs/ItemPhysical.md +24 -11
  412. data/docs/ItemPricing.md +52 -25
  413. data/docs/ItemPricingTier.md +26 -12
  414. data/docs/ItemPricingTierDiscount.md +20 -9
  415. data/docs/ItemPricingTierLimit.md +22 -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 -15
  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 -55
  428. data/docs/ItemShippingCase.md +24 -11
  429. data/docs/ItemShippingDestinationMarkup.md +28 -13
  430. data/docs/ItemShippingDestinationRestriction.md +22 -10
  431. data/docs/ItemShippingDistributionCenter.md +44 -21
  432. data/docs/ItemShippingMethod.md +46 -22
  433. data/docs/ItemShippingPackageRequirement.md +20 -9
  434. data/docs/ItemTag.md +20 -9
  435. data/docs/ItemTags.md +18 -8
  436. data/docs/ItemTax.md +24 -11
  437. data/docs/ItemTaxExemption.md +26 -12
  438. data/docs/ItemThirdPartyEmailMarketing.md +26 -12
  439. data/docs/ItemVariantItem.md +28 -13
  440. data/docs/ItemVariation.md +26 -12
  441. data/docs/ItemVariationOption.md +24 -11
  442. data/docs/ItemWishlistMember.md +22 -10
  443. data/docs/ItemsRequest.md +18 -8
  444. data/docs/ItemsResponse.md +26 -12
  445. data/docs/KeyValue.md +22 -10
  446. data/docs/LibraryFilterValues.md +24 -11
  447. data/docs/LibraryFilterValuesResponse.md +26 -12
  448. data/docs/LibraryItem.md +96 -47
  449. data/docs/LibraryItemAccount.md +22 -10
  450. data/docs/LibraryItemAsset.md +20 -9
  451. data/docs/LibraryItemAttribute.md +20 -9
  452. data/docs/LibraryItemEmail.md +22 -10
  453. data/docs/LibraryItemPublishedMeta.md +32 -15
  454. data/docs/LibraryItemPurchasedMeta.md +22 -10
  455. data/docs/LibraryItemQuery.md +40 -19
  456. data/docs/LibraryItemResponse.md +26 -12
  457. data/docs/LibraryItemScreenshot.md +20 -9
  458. data/docs/LibraryItemsResponse.md +26 -12
  459. data/docs/LinkedAccount.md +22 -10
  460. data/docs/ListSegmentMembership.md +22 -10
  461. data/docs/LookupRequest.md +26 -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 -45
  470. data/docs/OrderAffiliate.md +22 -10
  471. data/docs/OrderAffiliateLedger.md +34 -16
  472. data/docs/OrderApi.md +1856 -1469
  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 -68
  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 -25
  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 -11
  511. data/docs/OrderQuery.md +94 -46
  512. data/docs/OrderQueryBatch.md +18 -8
  513. data/docs/OrderQuote.md +22 -10
  514. data/docs/OrderReplacement.md +46 -22
  515. data/docs/OrderReplacementItem.md +22 -10
  516. data/docs/OrderReplacementResponse.md +28 -13
  517. data/docs/OrderResponse.md +26 -12
  518. data/docs/OrderSalesforce.md +18 -8
  519. data/docs/OrderShipping.md +76 -38
  520. data/docs/OrderSummary.md +56 -27
  521. data/docs/OrderTag.md +18 -8
  522. data/docs/OrderTaxes.md +50 -24
  523. data/docs/OrderTokenResponse.md +26 -12
  524. data/docs/OrderTrackingNumberDetail.md +40 -19
  525. data/docs/OrderTrackingNumberDetails.md +52 -25
  526. data/docs/OrdersResponse.md +26 -12
  527. data/docs/Permission.md +22 -10
  528. data/docs/PricingTier.md +78 -40
  529. data/docs/PricingTierNotification.md +22 -10
  530. data/docs/PricingTiersResponse.md +26 -12
  531. data/docs/Property.md +20 -9
  532. data/docs/PublishLibraryItemRequest.md +18 -8
  533. data/docs/RegisterAffiliateClickRequest.md +28 -13
  534. data/docs/RegisterAffiliateClickResponse.md +24 -11
  535. data/docs/ResponseMetadata.md +20 -9
  536. data/docs/ResultSet.md +28 -13
  537. data/docs/ScreenRecording.md +116 -57
  538. data/docs/ScreenRecordingAdPlatform.md +30 -14
  539. data/docs/ScreenRecordingFilter.md +136 -67
  540. data/docs/ScreenRecordingFilterGeoDistance.md +26 -12
  541. data/docs/ScreenRecordingFilterIpSearch.md +24 -11
  542. data/docs/ScreenRecordingFilterPageView.md +50 -24
  543. data/docs/ScreenRecordingFilterPageViewEvent.md +20 -9
  544. data/docs/ScreenRecordingFilterPageViewEventParam.md +26 -12
  545. data/docs/ScreenRecordingFilterPageViewParam.md +20 -9
  546. data/docs/ScreenRecordingFilterPageViewReferrerParam.md +20 -9
  547. data/docs/ScreenRecordingFilterRangeBigDecimal.md +26 -12
  548. data/docs/ScreenRecordingFilterRangeDate.md +20 -9
  549. data/docs/ScreenRecordingFilterRangeInteger.md +26 -12
  550. data/docs/ScreenRecordingFilterStringSearch.md +26 -12
  551. data/docs/ScreenRecordingFilterValues.md +58 -28
  552. data/docs/ScreenRecordingFilterValuesEvent.md +20 -9
  553. data/docs/ScreenRecordingFilterValuesEventParams.md +26 -12
  554. data/docs/ScreenRecordingFilterValuesPageParam.md +20 -9
  555. data/docs/ScreenRecordingFilterValuesPageView.md +28 -13
  556. data/docs/ScreenRecordingHeatmap.md +64 -31
  557. data/docs/ScreenRecordingHeatmapIndexRequest.md +18 -8
  558. data/docs/ScreenRecordingHeatmapIndexResponse.md +26 -12
  559. data/docs/ScreenRecordingHeatmapRequest.md +22 -10
  560. data/docs/ScreenRecordingHeatmapReset.md +18 -8
  561. data/docs/ScreenRecordingHeatmapResponse.md +26 -12
  562. data/docs/ScreenRecordingHeatmapUrl.md +28 -13
  563. data/docs/ScreenRecordingMerchantNotesRequest.md +18 -8
  564. data/docs/ScreenRecordingMultifield.md +26 -12
  565. data/docs/ScreenRecordingPageView.md +54 -26
  566. data/docs/ScreenRecordingPageViewDataResponse.md +26 -12
  567. data/docs/ScreenRecordingPageViewEvent.md +28 -13
  568. data/docs/ScreenRecordingPageViewEventParameter.md +20 -9
  569. data/docs/ScreenRecordingPageViewParameter.md +20 -9
  570. data/docs/ScreenRecordingQueryRequest.md +18 -8
  571. data/docs/ScreenRecordingQueryResponse.md +38 -18
  572. data/docs/ScreenRecordingResponse.md +28 -13
  573. data/docs/ScreenRecordingSegment.md +36 -17
  574. data/docs/ScreenRecordingSegmentResponse.md +26 -12
  575. data/docs/ScreenRecordingSegmentsResponse.md +26 -12
  576. data/docs/ScreenRecordingSettings.md +32 -15
  577. data/docs/ScreenRecordingSettingsResponse.md +26 -12
  578. data/docs/ScreenRecordingStoreFront.md +20 -9
  579. data/docs/ScreenRecordingTagsRequest.md +18 -8
  580. data/docs/ScreenRecordingTagsResponse.md +26 -12
  581. data/docs/ScreenRecordingUserAgent.md +26 -12
  582. data/docs/ScreenRecordingUserAgentDevice.md +18 -8
  583. data/docs/ScreenRecordingUserAgentOS.md +22 -10
  584. data/docs/ScreenRecordingUserProperty.md +20 -9
  585. data/docs/ScreenshotsResponse.md +26 -12
  586. data/docs/SelfConfig.md +18 -8
  587. data/docs/SimpleValue.md +20 -9
  588. data/docs/SingleSignOnAuthorizeRequest.md +20 -9
  589. data/docs/SingleSignOnAuthorizeResponse.md +20 -9
  590. data/docs/SingleSignOnTokenRequest.md +20 -9
  591. data/docs/SingleSignOnTokenResponse.md +22 -10
  592. data/docs/SovosConfig.md +30 -14
  593. data/docs/SsoApi.md +300 -201
  594. data/docs/StateProvince.md +20 -9
  595. data/docs/StepWaiting.md +20 -9
  596. data/docs/StorefrontApi.md +13005 -9053
  597. data/docs/TaxApi.md +2101 -1421
  598. data/docs/TaxCity.md +34 -16
  599. data/docs/TaxCountry.md +34 -16
  600. data/docs/TaxCountryCode.md +26 -12
  601. data/docs/TaxCounty.md +36 -17
  602. data/docs/TaxJarConfig.md +30 -14
  603. data/docs/TaxPostalCode.md +30 -14
  604. data/docs/TaxProviderActivateResult.md +20 -9
  605. data/docs/TaxProviderAvalara.md +24 -11
  606. data/docs/TaxProviderAvalaraCompaniesResult.md +18 -8
  607. data/docs/TaxProviderAvalaraCompany.md +26 -12
  608. data/docs/TaxProviderSelf.md +26 -12
  609. data/docs/TaxProviderSelfCountriesResponse.md +18 -8
  610. data/docs/TaxProviderSelfRegionsResponse.md +18 -8
  611. data/docs/TaxProviderSovos.md +24 -11
  612. data/docs/TaxProviderTaxJar.md +24 -11
  613. data/docs/TaxProviderTestResult.md +20 -9
  614. data/docs/TaxProviderUltraCart.md +26 -12
  615. data/docs/TaxProviderUltraCartState.md +36 -17
  616. data/docs/TaxProvidersResponse.md +34 -16
  617. data/docs/TaxState.md +52 -25
  618. data/docs/TaxStateCode.md +26 -12
  619. data/docs/TempMultimedia.md +30 -14
  620. data/docs/TempMultimediaResponse.md +26 -12
  621. data/docs/ThumbnailParametersRequest.md +26 -12
  622. data/docs/ThumbnailParametersResponse.md +26 -12
  623. data/docs/TransactionEmail.md +56 -27
  624. data/docs/TransactionEmailListResponse.md +26 -12
  625. data/docs/TransactionEmailOption.md +32 -15
  626. data/docs/TransactionEmailResponse.md +26 -12
  627. data/docs/Twilio.md +24 -11
  628. data/docs/TwilioResponse.md +28 -13
  629. data/docs/TwiliosResponse.md +26 -12
  630. data/docs/UltraCartConfig.md +18 -8
  631. data/docs/UploadCouponCodesRequest.md +26 -12
  632. data/docs/UploadCouponCodesResponse.md +30 -14
  633. data/docs/User.md +44 -21
  634. data/docs/UserApi.md +823 -558
  635. data/docs/UserGroupMembership.md +22 -10
  636. data/docs/UserLogin.md +24 -11
  637. data/docs/UserLoginsResponse.md +26 -12
  638. data/docs/UserResponse.md +26 -12
  639. data/docs/UsersResponse.md +26 -12
  640. data/docs/VerificationRecord.md +22 -10
  641. data/docs/Warning.md +20 -9
  642. data/docs/Webhook.md +52 -26
  643. data/docs/WebhookApi.md +636 -447
  644. data/docs/WebhookEventCategory.md +26 -12
  645. data/docs/WebhookEventSubscription.md +34 -16
  646. data/docs/WebhookLog.md +38 -18
  647. data/docs/WebhookLogResponse.md +26 -12
  648. data/docs/WebhookLogSummariesResponse.md +26 -12
  649. data/docs/WebhookLogSummary.md +22 -10
  650. data/docs/WebhookResponse.md +26 -12
  651. data/docs/WebhookSampleRequest.md +24 -11
  652. data/docs/WebhookSampleRequestResponse.md +26 -12
  653. data/docs/WebhooksResponse.md +26 -12
  654. data/docs/Weight.md +20 -9
  655. data/git_push.sh +57 -55
  656. data/lib/ultracart_api/api/affiliate_api.rb +191 -164
  657. data/lib/ultracart_api/api/auto_order_api.rb +672 -639
  658. data/lib/ultracart_api/api/channel_partner_api.rb +370 -664
  659. data/lib/ultracart_api/api/chargeback_api.rb +410 -356
  660. data/lib/ultracart_api/api/checkout_api.rb +1341 -1111
  661. data/lib/ultracart_api/api/coupon_api.rb +1390 -1161
  662. data/lib/ultracart_api/api/customer_api.rb +1292 -1218
  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 -1303
  667. data/lib/ultracart_api/api/oauth_api.rb +198 -171
  668. data/lib/ultracart_api/api/order_api.rb +1728 -1645
  669. data/lib/ultracart_api/api/sso_api.rb +289 -243
  670. data/lib/ultracart_api/api/storefront_api.rb +11407 -10209
  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 -455
  699. data/lib/ultracart_api/models/auto_order_item.rb +487 -472
  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 -540
  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 -240
  742. data/lib/ultracart_api/models/cart_payment_affirm.rb +220 -185
  743. data/lib/ultracart_api/models/cart_payment_amazon.rb +220 -185
  744. data/lib/ultracart_api/models/cart_payment_check.rb +220 -185
  745. data/lib/ultracart_api/models/cart_payment_credit_card.rb +300 -265
  746. data/lib/ultracart_api/models/cart_payment_purchase_order.rb +220 -185
  747. data/lib/ultracart_api/models/cart_profile_login_request.rb +239 -204
  748. data/lib/ultracart_api/models/cart_profile_login_response.rb +231 -196
  749. data/lib/ultracart_api/models/cart_profile_register_request.rb +229 -194
  750. data/lib/ultracart_api/models/cart_profile_register_response.rb +231 -196
  751. data/lib/ultracart_api/models/cart_property.rb +280 -245
  752. data/lib/ultracart_api/models/cart_response.rb +231 -196
  753. data/lib/ultracart_api/models/cart_settings.rb +264 -229
  754. data/lib/ultracart_api/models/cart_settings_billing.rb +222 -187
  755. data/lib/ultracart_api/models/cart_settings_gift.rb +251 -216
  756. data/lib/ultracart_api/models/cart_settings_gift_wrap.rb +239 -204
  757. data/lib/ultracart_api/models/cart_settings_payment.rb +337 -302
  758. data/lib/ultracart_api/models/cart_settings_payment_amazon.rb +240 -205
  759. data/lib/ultracart_api/models/cart_settings_payment_credit_card.rb +242 -207
  760. data/lib/ultracart_api/models/cart_settings_payment_pay_pal.rb +260 -225
  761. data/lib/ultracart_api/models/cart_settings_province.rb +228 -193
  762. data/lib/ultracart_api/models/cart_settings_shipping.rb +262 -227
  763. data/lib/ultracart_api/models/cart_settings_shipping_calendar.rb +264 -229
  764. data/lib/ultracart_api/models/cart_settings_shipping_estimate.rb +345 -310
  765. data/lib/ultracart_api/models/cart_settings_taxes.rb +221 -186
  766. data/lib/ultracart_api/models/cart_settings_terms.rb +230 -195
  767. data/lib/ultracart_api/models/cart_shipping.rb +625 -590
  768. data/lib/ultracart_api/models/cart_summary.rb +354 -319
  769. data/lib/ultracart_api/models/cart_taxes.rb +255 -220
  770. data/lib/ultracart_api/models/cart_upsell_after.rb +255 -220
  771. data/lib/ultracart_api/models/cart_validation_request.rb +231 -196
  772. data/lib/ultracart_api/models/cart_validation_response.rb +231 -196
  773. data/lib/ultracart_api/models/channel_partner_cancel_response.rb +259 -224
  774. data/lib/ultracart_api/models/channel_partner_estimate_shipping_response.rb +259 -224
  775. data/lib/ultracart_api/models/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 -1569
  778. data/lib/ultracart_api/models/channel_partner_order_item.rb +331 -296
  779. data/lib/ultracart_api/models/channel_partner_order_item_option.rb +230 -195
  780. data/lib/ultracart_api/models/channel_partner_order_transaction.rb +232 -197
  781. data/lib/ultracart_api/models/channel_partner_order_transaction_detail.rb +230 -195
  782. data/lib/ultracart_api/models/channel_partner_shipping_estimate.rb +230 -195
  783. data/lib/ultracart_api/models/chargeback_dispute.rb +649 -614
  784. data/lib/ultracart_api/models/chargeback_dispute_response.rb +256 -221
  785. data/lib/ultracart_api/models/chargeback_disputes_response.rb +258 -223
  786. data/lib/ultracart_api/models/checkout_allowed_countries_response.rb +221 -186
  787. data/lib/ultracart_api/models/checkout_handoff_request.rb +323 -288
  788. data/lib/ultracart_api/models/checkout_handoff_response.rb +241 -206
  789. data/lib/ultracart_api/models/checkout_setup_browser_key_request.rb +222 -187
  790. data/lib/ultracart_api/models/checkout_setup_browser_key_response.rb +220 -185
  791. data/lib/ultracart_api/models/checkout_state_province_response.rb +221 -186
  792. data/lib/ultracart_api/models/city_state_zip.rb +255 -220
  793. data/lib/ultracart_api/models/countries_response.rb +221 -186
  794. data/lib/ultracart_api/models/country.rb +260 -225
  795. data/lib/ultracart_api/models/coupon.rb +864 -908
  796. data/lib/ultracart_api/models/coupon_amount_off_items.rb +267 -232
  797. data/lib/ultracart_api/models/coupon_amount_off_shipping.rb +257 -222
  798. data/lib/ultracart_api/models/coupon_amount_off_shipping_with_items_purchase.rb +269 -234
  799. data/lib/ultracart_api/models/coupon_amount_off_subtotal.rb +245 -210
  800. data/lib/ultracart_api/models/coupon_amount_off_subtotal_and_shipping.rb +245 -210
  801. data/lib/ultracart_api/models/coupon_amount_off_subtotal_free_shipping_with_purchase.rb +267 -232
  802. data/lib/ultracart_api/models/coupon_amount_off_subtotal_with_block_purchase.rb +265 -230
  803. data/lib/ultracart_api/models/coupon_amount_off_subtotal_with_items_purchase.rb +267 -232
  804. data/lib/ultracart_api/models/coupon_amount_off_subtotal_with_purchase.rb +255 -220
  805. data/lib/ultracart_api/models/coupon_amount_shipping_with_subtotal.rb +267 -232
  806. data/lib/ultracart_api/models/coupon_auto_apply_condition.rb +239 -204
  807. data/lib/ultracart_api/models/coupon_auto_apply_conditions.rb +269 -234
  808. data/lib/ultracart_api/models/coupon_automatically_apply_coupon_codes.rb +222 -187
  809. data/lib/ultracart_api/models/coupon_buy_one_get_one_limit.rb +232 -197
  810. data/lib/ultracart_api/models/coupon_codes_request.rb +277 -242
  811. data/lib/ultracart_api/models/coupon_codes_response.rb +269 -234
  812. data/lib/ultracart_api/models/coupon_deletes_request.rb +234 -199
  813. data/lib/ultracart_api/models/coupon_discount_item_with_item_purchase.rb +275 -240
  814. data/lib/ultracart_api/models/coupon_discount_items.rb +267 -232
  815. data/lib/ultracart_api/models/coupon_editor_values.rb +330 -295
  816. data/lib/ultracart_api/models/coupon_exists_response.rb +267 -232
  817. data/lib/ultracart_api/models/coupon_free_item_and_shipping_with_subtotal.rb +279 -244
  818. data/lib/ultracart_api/models/coupon_free_item_with_item_purchase.rb +254 -219
  819. data/lib/ultracart_api/models/coupon_free_item_with_subtotal.rb +267 -232
  820. data/lib/ultracart_api/models/coupon_free_items_with_item_purchase.rb +260 -225
  821. data/lib/ultracart_api/models/coupon_free_items_with_mix_match_purchase.rb +260 -225
  822. data/lib/ultracart_api/models/coupon_free_shipping.rb +222 -187
  823. data/lib/ultracart_api/models/coupon_free_shipping_specific_items.rb +222 -187
  824. data/lib/ultracart_api/models/coupon_free_shipping_with_items_purchase.rb +234 -199
  825. data/lib/ultracart_api/models/coupon_free_shipping_with_subtotal.rb +257 -222
  826. data/lib/ultracart_api/models/coupon_item_search_result.rb +290 -255
  827. data/lib/ultracart_api/models/coupon_item_search_results_response.rb +259 -224
  828. data/lib/ultracart_api/models/coupon_multiple_amounts_off_items.rb +232 -197
  829. data/lib/ultracart_api/models/coupon_percent_off_item_with_items_quantity_purchase.rb +264 -229
  830. data/lib/ultracart_api/models/coupon_percent_off_items.rb +254 -219
  831. data/lib/ultracart_api/models/coupon_percent_off_items_and_free_shipping.rb +244 -209
  832. data/lib/ultracart_api/models/coupon_percent_off_items_with_items_purchase.rb +254 -219
  833. data/lib/ultracart_api/models/coupon_percent_off_msrp_items.rb +254 -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 -209
  850. data/lib/ultracart_api/models/coupon_tiered_amount_off_subtotal.rb +234 -199
  851. data/lib/ultracart_api/models/coupon_tiered_percent_off_items.rb +244 -209
  852. data/lib/ultracart_api/models/coupon_tiered_percent_off_shipping.rb +259 -224
  853. data/lib/ultracart_api/models/coupon_tiered_percent_off_subtotal.rb +234 -199
  854. data/lib/ultracart_api/models/coupon_type.rb +230 -195
  855. data/lib/ultracart_api/models/coupons_request.rb +222 -187
  856. data/lib/ultracart_api/models/coupons_response.rb +258 -223
  857. data/lib/ultracart_api/models/currency.rb +260 -225
  858. data/lib/ultracart_api/models/customer.rb +978 -972
  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 -248
  868. data/lib/ultracart_api/models/customer_loyalty_ledger.rb +360 -325
  869. data/lib/ultracart_api/models/customer_loyalty_redemption.rb +340 -305
  870. data/lib/ultracart_api/models/customer_orders_summary.rb +250 -215
  871. data/lib/ultracart_api/models/customer_pricing_tier.rb +245 -210
  872. data/lib/ultracart_api/models/customer_privacy.rb +250 -215
  873. data/lib/ultracart_api/models/customer_query.rb +789 -754
  874. data/lib/ultracart_api/models/customer_quotes_summary.rb +250 -215
  875. data/lib/ultracart_api/models/customer_response.rb +256 -221
  876. data/lib/ultracart_api/models/customer_reviewer.rb +310 -275
  877. data/lib/ultracart_api/models/customer_shipping.rb +575 -540
  878. data/lib/ultracart_api/models/customer_software_entitlement.rb +365 -330
  879. data/lib/ultracart_api/models/customer_store_credit.rb +274 -239
  880. data/lib/ultracart_api/models/customer_store_credit_add_request.rb +250 -215
  881. data/lib/ultracart_api/models/customer_store_credit_ledger_entry.rb +295 -260
  882. data/lib/ultracart_api/models/customer_store_credit_response.rb +256 -221
  883. data/lib/ultracart_api/models/customer_tag.rb +235 -200
  884. data/lib/ultracart_api/models/customer_tax_codes.rb +260 -225
  885. data/lib/ultracart_api/models/customers_response.rb +258 -223
  886. data/lib/ultracart_api/models/data_tables_server_side_response.rb +248 -213
  887. data/lib/ultracart_api/models/distance.rb +264 -229
  888. data/lib/ultracart_api/models/distribution_center.rb +559 -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 -452
  892. data/lib/ultracart_api/models/email_campaign_folder.rb +275 -240
  893. data/lib/ultracart_api/models/email_campaign_folder_response.rb +256 -221
  894. data/lib/ultracart_api/models/email_campaign_folders_response.rb +258 -223
  895. data/lib/ultracart_api/models/email_campaign_response.rb +256 -221
  896. data/lib/ultracart_api/models/email_campaigns_response.rb +258 -223
  897. data/lib/ultracart_api/models/email_click.rb +230 -195
  898. data/lib/ultracart_api/models/email_clicks_response.rb +258 -223
  899. data/lib/ultracart_api/models/email_commseq.rb +252 -217
  900. data/lib/ultracart_api/models/email_commseq_email.rb +470 -435
  901. data/lib/ultracart_api/models/email_commseq_email_response.rb +256 -221
  902. data/lib/ultracart_api/models/email_commseq_email_send_test_request.rb +304 -269
  903. data/lib/ultracart_api/models/email_commseq_email_send_test_response.rb +247 -212
  904. data/lib/ultracart_api/models/email_commseq_emails_request.rb +258 -223
  905. data/lib/ultracart_api/models/email_commseq_emails_response.rb +258 -223
  906. data/lib/ultracart_api/models/email_commseq_postcard.rb +340 -305
  907. data/lib/ultracart_api/models/email_commseq_postcard_response.rb +256 -221
  908. data/lib/ultracart_api/models/email_commseq_postcard_send_test_request.rb +329 -294
  909. data/lib/ultracart_api/models/email_commseq_postcard_send_test_response.rb +274 -239
  910. data/lib/ultracart_api/models/email_commseq_postcards_request.rb +221 -186
  911. data/lib/ultracart_api/models/email_commseq_postcards_response.rb +258 -223
  912. data/lib/ultracart_api/models/email_commseq_response.rb +256 -221
  913. data/lib/ultracart_api/models/email_commseq_stat.rb +580 -545
  914. data/lib/ultracart_api/models/email_commseq_stat_response.rb +256 -221
  915. data/lib/ultracart_api/models/email_commseq_step.rb +348 -313
  916. data/lib/ultracart_api/models/email_commseq_step_log.rb +240 -205
  917. data/lib/ultracart_api/models/email_commseq_step_logs_response.rb +258 -223
  918. data/lib/ultracart_api/models/email_commseq_webhook_send_test_request.rb +275 -240
  919. data/lib/ultracart_api/models/email_commseq_webhook_send_test_response.rb +277 -242
  920. data/lib/ultracart_api/models/email_commseqs_response.rb +258 -223
  921. data/lib/ultracart_api/models/email_customer.rb +292 -257
  922. data/lib/ultracart_api/models/email_customer_editor_url_response.rb +256 -221
  923. data/lib/ultracart_api/models/email_customers_response.rb +262 -227
  924. data/lib/ultracart_api/models/email_dashboard_activity.rb +280 -245
  925. data/lib/ultracart_api/models/email_dashboard_activity_response.rb +258 -223
  926. data/lib/ultracart_api/models/email_dashboard_stats_response.rb +258 -223
  927. data/lib/ultracart_api/models/email_domain.rb +329 -294
  928. data/lib/ultracart_api/models/email_editor_token_response.rb +256 -221
  929. data/lib/ultracart_api/models/email_flow.rb +505 -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 -311
  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 -295
  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 -378
  1037. data/lib/ultracart_api/models/item_auto_order_step_arbitrary_unit_cost_schedule.rb +230 -195
  1038. data/lib/ultracart_api/models/item_auto_order_step_grandfather_pricing.rb +230 -195
  1039. data/lib/ultracart_api/models/item_cc_bill.rb +270 -235
  1040. data/lib/ultracart_api/models/item_channel_partner_mapping.rb +445 -410
  1041. data/lib/ultracart_api/models/item_chargeback.rb +234 -199
  1042. data/lib/ultracart_api/models/item_chargeback_addendum.rb +250 -215
  1043. data/lib/ultracart_api/models/item_chargeback_adjustment_request.rb +240 -205
  1044. data/lib/ultracart_api/models/item_checkout.rb +265 -230
  1045. data/lib/ultracart_api/models/item_content.rb +361 -326
  1046. data/lib/ultracart_api/models/item_content_assignment.rb +285 -250
  1047. data/lib/ultracart_api/models/item_content_attribute.rb +280 -245
  1048. data/lib/ultracart_api/models/item_content_multimedia.rb +441 -406
  1049. data/lib/ultracart_api/models/item_content_multimedia_thumbnail.rb +270 -235
  1050. data/lib/ultracart_api/models/item_digital_delivery.rb +317 -282
  1051. data/lib/ultracart_api/models/item_digital_item.rb +305 -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 -275
  1062. data/lib/ultracart_api/models/item_instant_payment_notification.rb +270 -235
  1063. data/lib/ultracart_api/models/item_instant_payment_notifications.rb +222 -187
  1064. data/lib/ultracart_api/models/item_internal.rb +235 -200
  1065. data/lib/ultracart_api/models/item_kit_component.rb +260 -225
  1066. data/lib/ultracart_api/models/item_kit_definition.rb +222 -187
  1067. data/lib/ultracart_api/models/item_option.rb +416 -381
  1068. data/lib/ultracart_api/models/item_option_value.rb +409 -374
  1069. data/lib/ultracart_api/models/item_option_value_additional_item.rb +230 -195
  1070. data/lib/ultracart_api/models/item_option_value_digital_item.rb +230 -195
  1071. data/lib/ultracart_api/models/item_payment_processing.rb +264 -229
  1072. data/lib/ultracart_api/models/item_physical.rb +246 -211
  1073. data/lib/ultracart_api/models/item_pricing.rb +422 -387
  1074. data/lib/ultracart_api/models/item_pricing_tier.rb +261 -226
  1075. data/lib/ultracart_api/models/item_pricing_tier_discount.rb +230 -195
  1076. data/lib/ultracart_api/models/item_pricing_tier_limit.rb +240 -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 -257
  1084. data/lib/ultracart_api/models/item_restriction_item.rb +274 -239
  1085. data/lib/ultracart_api/models/item_revguard.rb +280 -245
  1086. data/lib/ultracart_api/models/item_reviews.rb +300 -276
  1087. data/lib/ultracart_api/models/item_salesforce.rb +230 -195
  1088. data/lib/ultracart_api/models/item_shipping.rb +713 -678
  1089. data/lib/ultracart_api/models/item_shipping_case.rb +265 -230
  1090. data/lib/ultracart_api/models/item_shipping_destination_markup.rb +315 -280
  1091. data/lib/ultracart_api/models/item_shipping_destination_restriction.rb +304 -269
  1092. data/lib/ultracart_api/models/item_shipping_distribution_center.rb +380 -345
  1093. data/lib/ultracart_api/models/item_shipping_method.rb +394 -359
  1094. data/lib/ultracart_api/models/item_shipping_package_requirement.rb +230 -195
  1095. data/lib/ultracart_api/models/item_tag.rb +279 -244
  1096. data/lib/ultracart_api/models/item_tags.rb +222 -187
  1097. data/lib/ultracart_api/models/item_tax.rb +286 -251
  1098. data/lib/ultracart_api/models/item_tax_exemption.rb +335 -300
  1099. data/lib/ultracart_api/models/item_third_party_email_marketing.rb +302 -267
  1100. data/lib/ultracart_api/models/item_variant_item.rb +289 -254
  1101. data/lib/ultracart_api/models/item_variation.rb +292 -257
  1102. data/lib/ultracart_api/models/item_variation_option.rb +265 -230
  1103. data/lib/ultracart_api/models/item_wishlist_member.rb +255 -220
  1104. data/lib/ultracart_api/models/items_request.rb +222 -187
  1105. data/lib/ultracart_api/models/items_response.rb +259 -224
  1106. data/lib/ultracart_api/models/key_value.rb +240 -205
  1107. data/lib/ultracart_api/models/library_filter_values.rb +254 -219
  1108. data/lib/ultracart_api/models/library_filter_values_response.rb +256 -221
  1109. data/lib/ultracart_api/models/library_item.rb +606 -571
  1110. data/lib/ultracart_api/models/library_item_account.rb +237 -202
  1111. data/lib/ultracart_api/models/library_item_asset.rb +228 -193
  1112. data/lib/ultracart_api/models/library_item_attribute.rb +228 -193
  1113. data/lib/ultracart_api/models/library_item_email.rb +237 -202
  1114. data/lib/ultracart_api/models/library_item_published_meta.rb +290 -255
  1115. data/lib/ultracart_api/models/library_item_purchased_meta.rb +240 -205
  1116. data/lib/ultracart_api/models/library_item_query.rb +330 -295
  1117. data/lib/ultracart_api/models/library_item_response.rb +256 -221
  1118. data/lib/ultracart_api/models/library_item_screenshot.rb +228 -193
  1119. data/lib/ultracart_api/models/library_items_response.rb +259 -224
  1120. data/lib/ultracart_api/models/linked_account.rb +240 -205
  1121. data/lib/ultracart_api/models/list_segment_membership.rb +237 -202
  1122. data/lib/ultracart_api/models/lookup_request.rb +255 -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 -610
  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 -919
  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 -397
  1160. data/lib/ultracart_api/models/order_payment_check.rb +220 -185
  1161. data/lib/ultracart_api/models/order_payment_credit_card.rb +354 -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 -245
  1170. data/lib/ultracart_api/models/order_query.rb +826 -791
  1171. data/lib/ultracart_api/models/order_query_batch.rb +222 -187
  1172. data/lib/ultracart_api/models/order_quote.rb +240 -205
  1173. data/lib/ultracart_api/models/order_replacement.rb +467 -432
  1174. data/lib/ultracart_api/models/order_replacement_item.rb +255 -220
  1175. data/lib/ultracart_api/models/order_replacement_response.rb +264 -229
  1176. data/lib/ultracart_api/models/order_response.rb +256 -221
  1177. data/lib/ultracart_api/models/order_salesforce.rb +220 -185
  1178. data/lib/ultracart_api/models/order_shipping.rb +770 -745
  1179. data/lib/ultracart_api/models/order_summary.rb +390 -355
  1180. data/lib/ultracart_api/models/order_tag.rb +235 -200
  1181. data/lib/ultracart_api/models/order_taxes.rb +395 -360
  1182. data/lib/ultracart_api/models/order_token_response.rb +257 -222
  1183. data/lib/ultracart_api/models/order_tracking_number_detail.rb +320 -285
  1184. data/lib/ultracart_api/models/order_tracking_number_details.rb +374 -339
  1185. data/lib/ultracart_api/models/orders_response.rb +259 -224
  1186. data/lib/ultracart_api/models/permission.rb +240 -205
  1187. data/lib/ultracart_api/models/pricing_tier.rb +533 -518
  1188. data/lib/ultracart_api/models/pricing_tier_notification.rb +270 -235
  1189. data/lib/ultracart_api/models/pricing_tiers_response.rb +259 -224
  1190. data/lib/ultracart_api/models/property.rb +228 -193
  1191. data/lib/ultracart_api/models/publish_library_item_request.rb +220 -185
  1192. data/lib/ultracart_api/models/register_affiliate_click_request.rb +270 -235
  1193. data/lib/ultracart_api/models/register_affiliate_click_response.rb +254 -219
  1194. data/lib/ultracart_api/models/response_metadata.rb +229 -194
  1195. data/lib/ultracart_api/models/result_set.rb +270 -235
  1196. data/lib/ultracart_api/models/screen_recording.rb +688 -653
  1197. data/lib/ultracart_api/models/screen_recording_ad_platform.rb +280 -245
  1198. data/lib/ultracart_api/models/screen_recording_filter.rb +758 -723
  1199. data/lib/ultracart_api/models/screen_recording_filter_geo_distance.rb +255 -220
  1200. data/lib/ultracart_api/models/screen_recording_filter_ip_search.rb +246 -211
  1201. data/lib/ultracart_api/models/screen_recording_filter_page_view.rb +369 -334
  1202. data/lib/ultracart_api/models/screen_recording_filter_page_view_event.rb +230 -195
  1203. data/lib/ultracart_api/models/screen_recording_filter_page_view_event_param.rb +255 -220
  1204. data/lib/ultracart_api/models/screen_recording_filter_page_view_param.rb +228 -193
  1205. data/lib/ultracart_api/models/screen_recording_filter_page_view_referrer_param.rb +228 -193
  1206. data/lib/ultracart_api/models/screen_recording_filter_range_big_decimal.rb +255 -220
  1207. data/lib/ultracart_api/models/screen_recording_filter_range_date.rb +230 -195
  1208. data/lib/ultracart_api/models/screen_recording_filter_range_integer.rb +255 -220
  1209. data/lib/ultracart_api/models/screen_recording_filter_string_search.rb +255 -220
  1210. data/lib/ultracart_api/models/screen_recording_filter_values.rb +435 -400
  1211. data/lib/ultracart_api/models/screen_recording_filter_values_event.rb +230 -195
  1212. data/lib/ultracart_api/models/screen_recording_filter_values_event_params.rb +263 -228
  1213. data/lib/ultracart_api/models/screen_recording_filter_values_page_param.rb +230 -195
  1214. data/lib/ultracart_api/models/screen_recording_filter_values_page_view.rb +272 -237
  1215. data/lib/ultracart_api/models/screen_recording_heatmap.rb +426 -391
  1216. data/lib/ultracart_api/models/screen_recording_heatmap_index_request.rb +219 -184
  1217. data/lib/ultracart_api/models/screen_recording_heatmap_index_response.rb +258 -223
  1218. data/lib/ultracart_api/models/screen_recording_heatmap_request.rb +239 -204
  1219. data/lib/ultracart_api/models/screen_recording_heatmap_reset.rb +219 -184
  1220. data/lib/ultracart_api/models/screen_recording_heatmap_response.rb +256 -221
  1221. data/lib/ultracart_api/models/screen_recording_heatmap_url.rb +266 -231
  1222. data/lib/ultracart_api/models/screen_recording_merchant_notes_request.rb +219 -184
  1223. data/lib/ultracart_api/models/screen_recording_multifield.rb +255 -220
  1224. data/lib/ultracart_api/models/screen_recording_page_view.rb +391 -356
  1225. data/lib/ultracart_api/models/screen_recording_page_view_data_response.rb +256 -221
  1226. data/lib/ultracart_api/models/screen_recording_page_view_event.rb +267 -232
  1227. data/lib/ultracart_api/models/screen_recording_page_view_event_parameter.rb +228 -193
  1228. data/lib/ultracart_api/models/screen_recording_page_view_parameter.rb +228 -193
  1229. data/lib/ultracart_api/models/screen_recording_query_request.rb +219 -184
  1230. data/lib/ultracart_api/models/screen_recording_query_response.rb +314 -279
  1231. data/lib/ultracart_api/models/screen_recording_response.rb +265 -230
  1232. data/lib/ultracart_api/models/screen_recording_segment.rb +302 -267
  1233. data/lib/ultracart_api/models/screen_recording_segment_response.rb +256 -221
  1234. data/lib/ultracart_api/models/screen_recording_segments_response.rb +258 -223
  1235. data/lib/ultracart_api/models/screen_recording_settings.rb +284 -249
  1236. data/lib/ultracart_api/models/screen_recording_settings_response.rb +256 -221
  1237. data/lib/ultracart_api/models/screen_recording_store_front.rb +228 -193
  1238. data/lib/ultracart_api/models/screen_recording_tags_request.rb +221 -186
  1239. data/lib/ultracart_api/models/screen_recording_tags_response.rb +258 -223
  1240. data/lib/ultracart_api/models/screen_recording_user_agent.rb +255 -220
  1241. data/lib/ultracart_api/models/screen_recording_user_agent_device.rb +219 -184
  1242. data/lib/ultracart_api/models/screen_recording_user_agent_os.rb +237 -202
  1243. data/lib/ultracart_api/models/screen_recording_user_property.rb +228 -193
  1244. data/lib/ultracart_api/models/screenshots_response.rb +259 -224
  1245. data/lib/ultracart_api/models/self_config.rb +220 -185
  1246. data/lib/ultracart_api/models/simple_value.rb +230 -195
  1247. data/lib/ultracart_api/models/single_sign_on_authorize_request.rb +230 -195
  1248. data/lib/ultracart_api/models/single_sign_on_authorize_response.rb +230 -195
  1249. data/lib/ultracart_api/models/single_sign_on_token_request.rb +230 -195
  1250. data/lib/ultracart_api/models/single_sign_on_token_response.rb +240 -205
  1251. data/lib/ultracart_api/models/sovos_config.rb +280 -245
  1252. data/lib/ultracart_api/models/state_province.rb +245 -210
  1253. data/lib/ultracart_api/models/step_waiting.rb +228 -193
  1254. data/lib/ultracart_api/models/tax_city.rb +302 -267
  1255. data/lib/ultracart_api/models/tax_country.rb +302 -267
  1256. data/lib/ultracart_api/models/tax_country_code.rb +260 -225
  1257. data/lib/ultracart_api/models/tax_county.rb +312 -277
  1258. data/lib/ultracart_api/models/tax_jar_config.rb +280 -245
  1259. data/lib/ultracart_api/models/tax_postal_code.rb +280 -245
  1260. data/lib/ultracart_api/models/tax_provider_activate_result.rb +229 -194
  1261. data/lib/ultracart_api/models/tax_provider_avalara.rb +249 -214
  1262. data/lib/ultracart_api/models/tax_provider_avalara_companies_result.rb +222 -187
  1263. data/lib/ultracart_api/models/tax_provider_avalara_company.rb +260 -225
  1264. data/lib/ultracart_api/models/tax_provider_self.rb +261 -226
  1265. data/lib/ultracart_api/models/tax_provider_self_countries_response.rb +222 -187
  1266. data/lib/ultracart_api/models/tax_provider_self_regions_response.rb +222 -187
  1267. data/lib/ultracart_api/models/tax_provider_sovos.rb +249 -214
  1268. data/lib/ultracart_api/models/tax_provider_tax_jar.rb +249 -214
  1269. data/lib/ultracart_api/models/tax_provider_test_result.rb +229 -194
  1270. data/lib/ultracart_api/models/tax_provider_ultra_cart.rb +261 -226
  1271. data/lib/ultracart_api/models/tax_provider_ultra_cart_state.rb +310 -275
  1272. data/lib/ultracart_api/models/tax_providers_response.rb +292 -257
  1273. data/lib/ultracart_api/models/tax_state.rb +392 -357
  1274. data/lib/ultracart_api/models/tax_state_code.rb +260 -225
  1275. data/lib/ultracart_api/models/temp_multimedia.rb +329 -294
  1276. data/lib/ultracart_api/models/temp_multimedia_response.rb +256 -221
  1277. data/lib/ultracart_api/models/thumbnail_parameters_request.rb +255 -220
  1278. data/lib/ultracart_api/models/thumbnail_parameters_response.rb +257 -222
  1279. data/lib/ultracart_api/models/transaction_email.rb +414 -379
  1280. data/lib/ultracart_api/models/transaction_email_list_response.rb +258 -223
  1281. data/lib/ultracart_api/models/transaction_email_option.rb +282 -247
  1282. data/lib/ultracart_api/models/transaction_email_response.rb +256 -221
  1283. data/lib/ultracart_api/models/twilio.rb +248 -213
  1284. data/lib/ultracart_api/models/twilio_response.rb +265 -230
  1285. data/lib/ultracart_api/models/twilios_response.rb +258 -223
  1286. data/lib/ultracart_api/models/ultra_cart_config.rb +220 -185
  1287. data/lib/ultracart_api/models/upload_coupon_codes_request.rb +259 -224
  1288. data/lib/ultracart_api/models/upload_coupon_codes_response.rb +283 -248
  1289. data/lib/ultracart_api/models/user.rb +377 -342
  1290. data/lib/ultracart_api/models/user_group_membership.rb +240 -205
  1291. data/lib/ultracart_api/models/user_login.rb +250 -215
  1292. data/lib/ultracart_api/models/user_logins_response.rb +259 -224
  1293. data/lib/ultracart_api/models/user_response.rb +256 -221
  1294. data/lib/ultracart_api/models/users_response.rb +258 -223
  1295. data/lib/ultracart_api/models/verification_record.rb +237 -202
  1296. data/lib/ultracart_api/models/warning.rb +230 -195
  1297. data/lib/ultracart_api/models/webhook.rb +437 -412
  1298. data/lib/ultracart_api/models/webhook_event_category.rb +264 -229
  1299. data/lib/ultracart_api/models/webhook_event_subscription.rb +300 -265
  1300. data/lib/ultracart_api/models/webhook_log.rb +324 -289
  1301. data/lib/ultracart_api/models/webhook_log_response.rb +256 -221
  1302. data/lib/ultracart_api/models/webhook_log_summaries_response.rb +259 -224
  1303. data/lib/ultracart_api/models/webhook_log_summary.rb +240 -205
  1304. data/lib/ultracart_api/models/webhook_response.rb +256 -221
  1305. data/lib/ultracart_api/models/webhook_sample_request.rb +252 -217
  1306. data/lib/ultracart_api/models/webhook_sample_request_response.rb +256 -221
  1307. data/lib/ultracart_api/models/webhooks_response.rb +258 -223
  1308. data/lib/ultracart_api/models/weight.rb +264 -229
  1309. data/lib/ultracart_api/version.rb +15 -15
  1310. data/lib/ultracart_api.rb +689 -836
  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 +5 -459
  1316. data/docs/AccountsReceivableRetryTransactionReject.md +0 -9
  1317. data/docs/AutoOrderAddonItem.md +0 -13
  1318. data/docs/AutoOrderAddonItemOption.md +0 -9
  1319. data/docs/AutoOrderManagement.md +0 -8
  1320. data/docs/CartItemProperty.md +0 -11
  1321. data/docs/ChannelPartner.md +0 -15
  1322. data/docs/ChannelPartnerShipToPreference.md +0 -14
  1323. data/docs/ChannelPartnerShipToPreferenceResponse.md +0 -12
  1324. data/docs/ChannelPartnerShipToPreferencesResponse.md +0 -12
  1325. data/docs/ChannelPartnersResponse.md +0 -12
  1326. data/docs/Conversation.md +0 -26
  1327. data/docs/ConversationAgentAuth.md +0 -13
  1328. data/docs/ConversationAgentAuthResponse.md +0 -12
  1329. data/docs/ConversationAgentProfile.md +0 -14
  1330. data/docs/ConversationAgentProfileResponse.md +0 -12
  1331. data/docs/ConversationApi.md +0 -1768
  1332. data/docs/ConversationAutocompleteRequest.md +0 -9
  1333. data/docs/ConversationAutocompleteResponse.md +0 -14
  1334. data/docs/ConversationAutocompleteValue.md +0 -9
  1335. data/docs/ConversationCannedMessage.md +0 -11
  1336. data/docs/ConversationCannedMessageResponse.md +0 -12
  1337. data/docs/ConversationCannedMessagesResponse.md +0 -12
  1338. data/docs/ConversationCannedMessagesSearch.md +0 -9
  1339. data/docs/ConversationDepartment.md +0 -12
  1340. data/docs/ConversationDepartmentMember.md +0 -10
  1341. data/docs/ConversationDepartmentMembersResponse.md +0 -12
  1342. data/docs/ConversationDepartmentResponse.md +0 -12
  1343. data/docs/ConversationDepartmentSettings.md +0 -7
  1344. data/docs/ConversationDepartmentsResponse.md +0 -12
  1345. data/docs/ConversationEngagement.md +0 -16
  1346. data/docs/ConversationEngagementEquation.md +0 -8
  1347. data/docs/ConversationEngagementEquationFunction.md +0 -21
  1348. data/docs/ConversationEngagementEquationGroup.md +0 -8
  1349. data/docs/ConversationEngagementResponse.md +0 -12
  1350. data/docs/ConversationEngagementsResponse.md +0 -12
  1351. data/docs/ConversationEventAddCoupon.md +0 -10
  1352. data/docs/ConversationEventAddItem.md +0 -10
  1353. data/docs/ConversationEventQueuePosition.md +0 -9
  1354. data/docs/ConversationEventRRWeb.md +0 -14
  1355. data/docs/ConversationEventReadMessage.md +0 -10
  1356. data/docs/ConversationEventTyping.md +0 -10
  1357. data/docs/ConversationEventWebchatContext.md +0 -10
  1358. data/docs/ConversationJoinRequest.md +0 -8
  1359. data/docs/ConversationLocationCountry.md +0 -10
  1360. data/docs/ConversationLocationStateProvince.md +0 -9
  1361. data/docs/ConversationLocationsResponse.md +0 -12
  1362. data/docs/ConversationMessage.md +0 -22
  1363. data/docs/ConversationMessageTranslation.md +0 -9
  1364. data/docs/ConversationMessageTransportStatus.md +0 -9
  1365. data/docs/ConversationMessagesResponse.md +0 -12
  1366. data/docs/ConversationMultimediaUploadUrl.md +0 -9
  1367. data/docs/ConversationMultimediaUploadUrlResponse.md +0 -12
  1368. data/docs/ConversationParticipant.md +0 -20
  1369. data/docs/ConversationPermissions.md +0 -8
  1370. data/docs/ConversationPermissionsResponse.md +0 -12
  1371. data/docs/ConversationResponse.md +0 -12
  1372. data/docs/ConversationSearchRequest.md +0 -19
  1373. data/docs/ConversationSearchResponse.md +0 -11
  1374. data/docs/ConversationSentiment.md +0 -13
  1375. data/docs/ConversationStartRequest.md +0 -10
  1376. data/docs/ConversationStartResponse.md +0 -8
  1377. data/docs/ConversationSummary.md +0 -24
  1378. data/docs/ConversationTwilioAccount.md +0 -9
  1379. data/docs/ConversationWebchatContext.md +0 -15
  1380. data/docs/ConversationWebchatQueueStatus.md +0 -22
  1381. data/docs/ConversationWebchatQueueStatusAgent.md +0 -13
  1382. data/docs/ConversationWebchatQueueStatusQueueEntry.md +0 -15
  1383. data/docs/ConversationWebchatQueueStatusUpdateRequest.md +0 -8
  1384. data/docs/ConversationWebchatQueueStatusesResponse.md +0 -12
  1385. data/docs/ConversationWebsocketMessage.md +0 -31
  1386. data/docs/ConversationsResponse.md +0 -12
  1387. data/docs/CouponMoreLoyaltyCashback.md +0 -8
  1388. data/docs/CouponMoreLoyaltyPoints.md +0 -8
  1389. data/docs/CouponNoDiscount.md +0 -8
  1390. data/docs/CouponPercentMoreLoyaltyCashback.md +0 -8
  1391. data/docs/CouponPercentMoreLoyaltyPoints.md +0 -8
  1392. data/docs/CouponTieredPercentOffSubtotalBasedOnMSRP.md +0 -9
  1393. data/docs/CustomerEDI.md +0 -10
  1394. data/docs/CustomerMagicLinkResponse.md +0 -12
  1395. data/docs/CustomerMergeRequest.md +0 -9
  1396. data/docs/DatawarehouseApi.md +0 -512
  1397. data/docs/EmailCommseqSequenceTestRequest.md +0 -22
  1398. data/docs/EmailCommseqSequenceTestResponse.md +0 -11
  1399. data/docs/EmailCommseqSmsSendTestRequest.md +0 -10
  1400. data/docs/EmailCommseqSmsSendTestResponse.md +0 -13
  1401. data/docs/EmailPostcardTracking.md +0 -32
  1402. data/docs/EmailPostcardTrackingResponse.md +0 -12
  1403. data/docs/FileManagerDirectory.md +0 -20
  1404. data/docs/FileManagerFile.md +0 -29
  1405. data/docs/FileManagerPage.md +0 -15
  1406. data/docs/FileManagerPageResponse.md +0 -12
  1407. data/docs/FileManagerUploadRequest.md +0 -10
  1408. data/docs/FileManagerUploadUrlResponse.md +0 -13
  1409. data/docs/HitPageView.md +0 -18
  1410. data/docs/HitPageViewMetaData.md +0 -9
  1411. data/docs/HitSessionStart.md +0 -24
  1412. data/docs/HitSessionUtm.md +0 -22
  1413. data/docs/ItemDigitalItemPdfMeta.md +0 -18
  1414. data/docs/ItemDigitalItemResponse.md +0 -12
  1415. data/docs/ItemDigitalItemsResponse.md +0 -12
  1416. data/docs/ItemReview.md +0 -44
  1417. data/docs/ItemReviewResponse.md +0 -12
  1418. data/docs/ItemReviewsResponse.md +0 -12
  1419. data/docs/OrderEdiDocument.md +0 -21
  1420. data/docs/OrderEdiDocumentsResponse.md +0 -12
  1421. data/docs/OrderInvoiceResponse.md +0 -12
  1422. data/docs/OrderPaymentCreditCardDualVaulted.md +0 -10
  1423. data/docs/OrderPaymentCreditCardDualVaultedProperty.md +0 -9
  1424. data/docs/OrderPointOfSale.md +0 -10
  1425. data/docs/OrderReason.md +0 -10
  1426. data/docs/OrderRefundableResponse.md +0 -19
  1427. data/docs/OrderTransactionalMerchantNote.md +0 -11
  1428. data/docs/OrderUtm.md +0 -31
  1429. data/docs/PointOfSaleLocation.md +0 -17
  1430. data/docs/PointOfSaleReader.md +0 -16
  1431. data/docs/PointOfSaleRegister.md +0 -11
  1432. data/docs/Report.md +0 -18
  1433. data/docs/ReportAuth.md +0 -11
  1434. data/docs/ReportAuthResponse.md +0 -12
  1435. data/docs/ReportDataSet.md +0 -24
  1436. data/docs/ReportDataSetColumn.md +0 -13
  1437. data/docs/ReportDataSetPage.md +0 -17
  1438. data/docs/ReportDataSetPageResponse.md +0 -12
  1439. data/docs/ReportDataSetQuery.md +0 -19
  1440. data/docs/ReportDataSetResponse.md +0 -12
  1441. data/docs/ReportDataSetRow.md +0 -8
  1442. data/docs/ReportDataSetSchema.md +0 -10
  1443. data/docs/ReportDataSource.md +0 -14
  1444. data/docs/ReportDataSourceSchema.md +0 -11
  1445. data/docs/ReportDryRunQueriesRequest.md +0 -13
  1446. data/docs/ReportDryRunQueriesResponse.md +0 -8
  1447. data/docs/ReportDryRunQueryResult.md +0 -9
  1448. data/docs/ReportExecuteQueriesRequest.md +0 -15
  1449. data/docs/ReportFilter.md +0 -13
  1450. data/docs/ReportFilterConnection.md +0 -10
  1451. data/docs/ReportPage.md +0 -13
  1452. data/docs/ReportPageFilter.md +0 -11
  1453. data/docs/ReportPageVisualization.md +0 -17
  1454. data/docs/ReportPageVisualizationDimension.md +0 -14
  1455. data/docs/ReportPageVisualizationMetric.md +0 -11
  1456. data/docs/ReportResponse.md +0 -12
  1457. data/docs/ReportWebsocketEvent.md +0 -9
  1458. data/docs/ReportsResponse.md +0 -12
  1459. data/docs/RulerValidationRequest.md +0 -8
  1460. data/docs/RulerValidationResponse.md +0 -9
  1461. data/docs/StoreFront.md +0 -18
  1462. data/docs/StoreFrontsResponse.md +0 -12
  1463. data/lib/ultracart_api/api/conversation_api.rb +0 -1936
  1464. data/lib/ultracart_api/api/datawarehouse_api.rb +0 -584
  1465. data/lib/ultracart_api/models/accounts_receivable_retry_transaction_reject.rb +0 -195
  1466. data/lib/ultracart_api/models/auto_order_addon_item.rb +0 -232
  1467. data/lib/ultracart_api/models/auto_order_addon_item_option.rb +0 -225
  1468. data/lib/ultracart_api/models/auto_order_management.rb +0 -185
  1469. data/lib/ultracart_api/models/cart_item_property.rb +0 -245
  1470. data/lib/ultracart_api/models/channel_partner.rb +0 -255
  1471. data/lib/ultracart_api/models/channel_partner_ship_to_preference.rb +0 -262
  1472. data/lib/ultracart_api/models/channel_partner_ship_to_preference_response.rb +0 -221
  1473. data/lib/ultracart_api/models/channel_partner_ship_to_preferences_response.rb +0 -224
  1474. data/lib/ultracart_api/models/channel_partners_response.rb +0 -224
  1475. data/lib/ultracart_api/models/conversation.rb +0 -390
  1476. data/lib/ultracart_api/models/conversation_agent_auth.rb +0 -231
  1477. data/lib/ultracart_api/models/conversation_agent_auth_response.rb +0 -221
  1478. data/lib/ultracart_api/models/conversation_agent_profile.rb +0 -279
  1479. data/lib/ultracart_api/models/conversation_agent_profile_response.rb +0 -221
  1480. data/lib/ultracart_api/models/conversation_autocomplete_request.rb +0 -193
  1481. data/lib/ultracart_api/models/conversation_autocomplete_response.rb +0 -241
  1482. data/lib/ultracart_api/models/conversation_autocomplete_value.rb +0 -193
  1483. data/lib/ultracart_api/models/conversation_canned_message.rb +0 -213
  1484. data/lib/ultracart_api/models/conversation_canned_message_response.rb +0 -221
  1485. data/lib/ultracart_api/models/conversation_canned_messages_response.rb +0 -223
  1486. data/lib/ultracart_api/models/conversation_canned_messages_search.rb +0 -193
  1487. data/lib/ultracart_api/models/conversation_department.rb +0 -222
  1488. data/lib/ultracart_api/models/conversation_department_member.rb +0 -202
  1489. data/lib/ultracart_api/models/conversation_department_members_response.rb +0 -223
  1490. data/lib/ultracart_api/models/conversation_department_response.rb +0 -221
  1491. data/lib/ultracart_api/models/conversation_department_settings.rb +0 -175
  1492. data/lib/ultracart_api/models/conversation_departments_response.rb +0 -223
  1493. data/lib/ultracart_api/models/conversation_engagement.rb +0 -293
  1494. data/lib/ultracart_api/models/conversation_engagement_equation.rb +0 -186
  1495. data/lib/ultracart_api/models/conversation_engagement_equation_function.rb +0 -414
  1496. data/lib/ultracart_api/models/conversation_engagement_equation_group.rb +0 -186
  1497. data/lib/ultracart_api/models/conversation_engagement_response.rb +0 -221
  1498. data/lib/ultracart_api/models/conversation_engagements_response.rb +0 -223
  1499. data/lib/ultracart_api/models/conversation_event_add_coupon.rb +0 -202
  1500. data/lib/ultracart_api/models/conversation_event_add_item.rb +0 -204
  1501. data/lib/ultracart_api/models/conversation_event_queue_position.rb +0 -195
  1502. data/lib/ultracart_api/models/conversation_event_read_message.rb +0 -203
  1503. data/lib/ultracart_api/models/conversation_event_rr_web.rb +0 -273
  1504. data/lib/ultracart_api/models/conversation_event_typing.rb +0 -202
  1505. data/lib/ultracart_api/models/conversation_event_webchat_context.rb +0 -202
  1506. data/lib/ultracart_api/models/conversation_join_request.rb +0 -184
  1507. data/lib/ultracart_api/models/conversation_location_country.rb +0 -204
  1508. data/lib/ultracart_api/models/conversation_location_state_province.rb +0 -193
  1509. data/lib/ultracart_api/models/conversation_locations_response.rb +0 -223
  1510. data/lib/ultracart_api/models/conversation_message.rb +0 -356
  1511. data/lib/ultracart_api/models/conversation_message_translation.rb +0 -193
  1512. data/lib/ultracart_api/models/conversation_message_transport_status.rb +0 -228
  1513. data/lib/ultracart_api/models/conversation_messages_response.rb +0 -223
  1514. data/lib/ultracart_api/models/conversation_multimedia_upload_url.rb +0 -193
  1515. data/lib/ultracart_api/models/conversation_multimedia_upload_url_response.rb +0 -221
  1516. data/lib/ultracart_api/models/conversation_participant.rb +0 -295
  1517. data/lib/ultracart_api/models/conversation_permissions.rb +0 -184
  1518. data/lib/ultracart_api/models/conversation_permissions_response.rb +0 -221
  1519. data/lib/ultracart_api/models/conversation_response.rb +0 -221
  1520. data/lib/ultracart_api/models/conversation_search_request.rb +0 -285
  1521. data/lib/ultracart_api/models/conversation_search_response.rb +0 -213
  1522. data/lib/ultracart_api/models/conversation_sentiment.rb +0 -269
  1523. data/lib/ultracart_api/models/conversation_start_request.rb +0 -204
  1524. data/lib/ultracart_api/models/conversation_start_response.rb +0 -184
  1525. data/lib/ultracart_api/models/conversation_summary.rb +0 -369
  1526. data/lib/ultracart_api/models/conversation_twilio_account.rb +0 -195
  1527. data/lib/ultracart_api/models/conversation_webchat_context.rb +0 -254
  1528. data/lib/ultracart_api/models/conversation_webchat_queue_status.rb +0 -315
  1529. data/lib/ultracart_api/models/conversation_webchat_queue_status_agent.rb +0 -266
  1530. data/lib/ultracart_api/models/conversation_webchat_queue_status_queue_entry.rb +0 -248
  1531. data/lib/ultracart_api/models/conversation_webchat_queue_status_update_request.rb +0 -219
  1532. data/lib/ultracart_api/models/conversation_webchat_queue_statuses_response.rb +0 -223
  1533. data/lib/ultracart_api/models/conversation_websocket_message.rb +0 -441
  1534. data/lib/ultracart_api/models/conversations_response.rb +0 -223
  1535. data/lib/ultracart_api/models/coupon_more_loyalty_cashback.rb +0 -185
  1536. data/lib/ultracart_api/models/coupon_more_loyalty_points.rb +0 -185
  1537. data/lib/ultracart_api/models/coupon_no_discount.rb +0 -185
  1538. data/lib/ultracart_api/models/coupon_percent_more_loyalty_cashback.rb +0 -185
  1539. data/lib/ultracart_api/models/coupon_percent_more_loyalty_points.rb +0 -185
  1540. data/lib/ultracart_api/models/coupon_tiered_percent_off_subtotal_based_on_msrp.rb +0 -199
  1541. data/lib/ultracart_api/models/customer_edi.rb +0 -205
  1542. data/lib/ultracart_api/models/customer_magic_link_response.rb +0 -222
  1543. data/lib/ultracart_api/models/customer_merge_request.rb +0 -195
  1544. data/lib/ultracart_api/models/email_commseq_sequence_test_request.rb +0 -312
  1545. data/lib/ultracart_api/models/email_commseq_sequence_test_response.rb +0 -212
  1546. data/lib/ultracart_api/models/email_commseq_sms_send_test_request.rb +0 -202
  1547. data/lib/ultracart_api/models/email_commseq_sms_send_test_response.rb +0 -232
  1548. data/lib/ultracart_api/models/email_postcard_tracking.rb +0 -404
  1549. data/lib/ultracart_api/models/email_postcard_tracking_response.rb +0 -221
  1550. data/lib/ultracart_api/models/file_manager_directory.rb +0 -292
  1551. data/lib/ultracart_api/models/file_manager_file.rb +0 -376
  1552. data/lib/ultracart_api/models/file_manager_page.rb +0 -253
  1553. data/lib/ultracart_api/models/file_manager_page_response.rb +0 -221
  1554. data/lib/ultracart_api/models/file_manager_upload_request.rb +0 -202
  1555. data/lib/ultracart_api/models/file_manager_upload_url_response.rb +0 -230
  1556. data/lib/ultracart_api/models/hit_page_view.rb +0 -276
  1557. data/lib/ultracart_api/models/hit_page_view_meta_data.rb +0 -193
  1558. data/lib/ultracart_api/models/hit_session_start.rb +0 -328
  1559. data/lib/ultracart_api/models/hit_session_utm.rb +0 -310
  1560. data/lib/ultracart_api/models/item_digital_item_pdf_meta.rb +0 -315
  1561. data/lib/ultracart_api/models/item_digital_item_response.rb +0 -221
  1562. data/lib/ultracart_api/models/item_digital_items_response.rb +0 -224
  1563. data/lib/ultracart_api/models/item_review.rb +0 -801
  1564. data/lib/ultracart_api/models/item_review_response.rb +0 -221
  1565. data/lib/ultracart_api/models/item_reviews_response.rb +0 -224
  1566. data/lib/ultracart_api/models/order_edi_document.rb +0 -337
  1567. data/lib/ultracart_api/models/order_edi_documents_response.rb +0 -224
  1568. data/lib/ultracart_api/models/order_invoice_response.rb +0 -222
  1569. data/lib/ultracart_api/models/order_payment_credit_card_dual_vaulted.rb +0 -204
  1570. data/lib/ultracart_api/models/order_payment_credit_card_dual_vaulted_property.rb +0 -193
  1571. data/lib/ultracart_api/models/order_point_of_sale.rb +0 -202
  1572. data/lib/ultracart_api/models/order_reason.rb +0 -205
  1573. data/lib/ultracart_api/models/order_refundable_response.rb +0 -300
  1574. data/lib/ultracart_api/models/order_transactional_merchant_note.rb +0 -215
  1575. data/lib/ultracart_api/models/order_utm.rb +0 -392
  1576. data/lib/ultracart_api/models/point_of_sale_location.rb +0 -290
  1577. data/lib/ultracart_api/models/point_of_sale_reader.rb +0 -299
  1578. data/lib/ultracart_api/models/point_of_sale_register.rb +0 -215
  1579. data/lib/ultracart_api/models/report.rb +0 -317
  1580. data/lib/ultracart_api/models/report_auth.rb +0 -212
  1581. data/lib/ultracart_api/models/report_auth_response.rb +0 -221
  1582. data/lib/ultracart_api/models/report_data_set.rb +0 -381
  1583. data/lib/ultracart_api/models/report_data_set_column.rb +0 -229
  1584. data/lib/ultracart_api/models/report_data_set_page.rb +0 -273
  1585. data/lib/ultracart_api/models/report_data_set_page_response.rb +0 -221
  1586. data/lib/ultracart_api/models/report_data_set_query.rb +0 -330
  1587. data/lib/ultracart_api/models/report_data_set_response.rb +0 -221
  1588. data/lib/ultracart_api/models/report_data_set_row.rb +0 -186
  1589. data/lib/ultracart_api/models/report_data_set_schema.rb +0 -238
  1590. data/lib/ultracart_api/models/report_data_source.rb +0 -242
  1591. data/lib/ultracart_api/models/report_data_source_schema.rb +0 -248
  1592. data/lib/ultracart_api/models/report_dry_run_queries_request.rb +0 -231
  1593. data/lib/ultracart_api/models/report_dry_run_queries_response.rb +0 -186
  1594. data/lib/ultracart_api/models/report_dry_run_query_result.rb +0 -193
  1595. data/lib/ultracart_api/models/report_execute_queries_request.rb +0 -288
  1596. data/lib/ultracart_api/models/report_filter.rb +0 -272
  1597. data/lib/ultracart_api/models/report_filter_connection.rb +0 -203
  1598. data/lib/ultracart_api/models/report_page.rb +0 -237
  1599. data/lib/ultracart_api/models/report_page_filter.rb +0 -214
  1600. data/lib/ultracart_api/models/report_page_visualization.rb +0 -309
  1601. data/lib/ultracart_api/models/report_page_visualization_dimension.rb +0 -244
  1602. data/lib/ultracart_api/models/report_page_visualization_metric.rb +0 -248
  1603. data/lib/ultracart_api/models/report_response.rb +0 -221
  1604. data/lib/ultracart_api/models/report_websocket_event.rb +0 -228
  1605. data/lib/ultracart_api/models/reports_response.rb +0 -223
  1606. data/lib/ultracart_api/models/ruler_validation_request.rb +0 -184
  1607. data/lib/ultracart_api/models/ruler_validation_response.rb +0 -193
  1608. data/lib/ultracart_api/models/store_front.rb +0 -274
  1609. data/lib/ultracart_api/models/store_fronts_response.rb +0 -223
@@ -1,1936 +0,0 @@
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 ConversationApi
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::ConversationApi.new(api_client)
33
- end
34
-
35
- # Delete a conversation canned message
36
- # Delete a conversation canned message
37
- # @param conversation_canned_message_oid
38
- # @param [Hash] opts the optional parameters
39
- # @return [nil]
40
- def delete_conversation_canned_message(conversation_canned_message_oid, opts = {})
41
- delete_conversation_canned_message_with_http_info(conversation_canned_message_oid, opts)
42
- nil
43
- end
44
-
45
- # Delete a conversation canned message
46
- # Delete a conversation canned message
47
- # @param conversation_canned_message_oid
48
- # @param [Hash] opts the optional parameters
49
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
50
- def delete_conversation_canned_message_with_http_info(conversation_canned_message_oid, opts = {})
51
- if @api_client.config.debugging
52
- @api_client.config.logger.debug 'Calling API: ConversationApi.delete_conversation_canned_message ...'
53
- end
54
- # verify the required parameter 'conversation_canned_message_oid' is set
55
- if @api_client.config.client_side_validation && conversation_canned_message_oid.nil?
56
- fail ArgumentError, "Missing the required parameter 'conversation_canned_message_oid' when calling ConversationApi.delete_conversation_canned_message"
57
- end
58
- # resource path
59
- local_var_path = '/conversation/canned_messages/{conversation_canned_message_oid}'.sub('{' + 'conversation_canned_message_oid' + '}', conversation_canned_message_oid.to_s)
60
-
61
- # query parameters
62
- query_params = {}
63
-
64
- # header parameters
65
- header_params = {}
66
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
67
- # HTTP header 'Accept' (if needed)
68
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
69
- # HTTP header 'Content-Type'
70
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
71
-
72
- # form parameters
73
- form_params = {}
74
-
75
- # http body (model)
76
- post_body = nil
77
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
78
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
79
- :header_params => header_params,
80
- :query_params => query_params,
81
- :form_params => form_params,
82
- :body => post_body,
83
- :auth_names => auth_names)
84
- if @api_client.config.debugging
85
- @api_client.config.logger.debug "API called: ConversationApi#delete_conversation_canned_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
86
- end
87
- return data, status_code, headers
88
- end
89
- # Delete a conversation department
90
- # Delete a conversation department
91
- # @param conversation_department_oid
92
- # @param [Hash] opts the optional parameters
93
- # @return [nil]
94
- def delete_department(conversation_department_oid, opts = {})
95
- delete_department_with_http_info(conversation_department_oid, opts)
96
- nil
97
- end
98
-
99
- # Delete a conversation department
100
- # Delete a conversation department
101
- # @param conversation_department_oid
102
- # @param [Hash] opts the optional parameters
103
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
104
- def delete_department_with_http_info(conversation_department_oid, opts = {})
105
- if @api_client.config.debugging
106
- @api_client.config.logger.debug 'Calling API: ConversationApi.delete_department ...'
107
- end
108
- # verify the required parameter 'conversation_department_oid' is set
109
- if @api_client.config.client_side_validation && conversation_department_oid.nil?
110
- fail ArgumentError, "Missing the required parameter 'conversation_department_oid' when calling ConversationApi.delete_department"
111
- end
112
- # resource path
113
- local_var_path = '/conversation/departments/{conversation_department_oid}'.sub('{' + 'conversation_department_oid' + '}', conversation_department_oid.to_s)
114
-
115
- # query parameters
116
- query_params = {}
117
-
118
- # header parameters
119
- header_params = {}
120
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
121
- # HTTP header 'Accept' (if needed)
122
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
123
- # HTTP header 'Content-Type'
124
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
125
-
126
- # form parameters
127
- form_params = {}
128
-
129
- # http body (model)
130
- post_body = nil
131
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
132
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
133
- :header_params => header_params,
134
- :query_params => query_params,
135
- :form_params => form_params,
136
- :body => post_body,
137
- :auth_names => auth_names)
138
- if @api_client.config.debugging
139
- @api_client.config.logger.debug "API called: ConversationApi#delete_department\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
140
- end
141
- return data, status_code, headers
142
- end
143
- # Delete a conversation engagement
144
- # Delete a conversation engagement
145
- # @param conversation_engagement_oid
146
- # @param [Hash] opts the optional parameters
147
- # @return [nil]
148
- def delete_engagement(conversation_engagement_oid, opts = {})
149
- delete_engagement_with_http_info(conversation_engagement_oid, opts)
150
- nil
151
- end
152
-
153
- # Delete a conversation engagement
154
- # Delete a conversation engagement
155
- # @param conversation_engagement_oid
156
- # @param [Hash] opts the optional parameters
157
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
158
- def delete_engagement_with_http_info(conversation_engagement_oid, opts = {})
159
- if @api_client.config.debugging
160
- @api_client.config.logger.debug 'Calling API: ConversationApi.delete_engagement ...'
161
- end
162
- # verify the required parameter 'conversation_engagement_oid' is set
163
- if @api_client.config.client_side_validation && conversation_engagement_oid.nil?
164
- fail ArgumentError, "Missing the required parameter 'conversation_engagement_oid' when calling ConversationApi.delete_engagement"
165
- end
166
- # resource path
167
- local_var_path = '/conversation/engagements/{conversation_engagement_oid}'.sub('{' + 'conversation_engagement_oid' + '}', conversation_engagement_oid.to_s)
168
-
169
- # query parameters
170
- query_params = {}
171
-
172
- # header parameters
173
- header_params = {}
174
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
175
- # HTTP header 'Accept' (if needed)
176
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
177
- # HTTP header 'Content-Type'
178
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
179
-
180
- # form parameters
181
- form_params = {}
182
-
183
- # http body (model)
184
- post_body = nil
185
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
186
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
187
- :header_params => header_params,
188
- :query_params => query_params,
189
- :form_params => form_params,
190
- :body => post_body,
191
- :auth_names => auth_names)
192
- if @api_client.config.debugging
193
- @api_client.config.logger.debug "API called: ConversationApi#delete_engagement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
194
- end
195
- return data, status_code, headers
196
- end
197
- # Agent keep alive
198
- # Called periodically by the conversation API to keep the session alive.
199
- # @param [Hash] opts the optional parameters
200
- # @return [nil]
201
- def get_agent_keep_alive(opts = {})
202
- get_agent_keep_alive_with_http_info(opts)
203
- nil
204
- end
205
-
206
- # Agent keep alive
207
- # Called periodically by the conversation API to keep the session alive.
208
- # @param [Hash] opts the optional parameters
209
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
210
- def get_agent_keep_alive_with_http_info(opts = {})
211
- if @api_client.config.debugging
212
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_agent_keep_alive ...'
213
- end
214
- # resource path
215
- local_var_path = '/conversation/agent/keepalive'
216
-
217
- # query parameters
218
- query_params = {}
219
-
220
- # header parameters
221
- header_params = {}
222
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
223
- # HTTP header 'Accept' (if needed)
224
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
225
- # HTTP header 'Content-Type'
226
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
227
-
228
- # form parameters
229
- form_params = {}
230
-
231
- # http body (model)
232
- post_body = nil
233
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
234
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
235
- :header_params => header_params,
236
- :query_params => query_params,
237
- :form_params => form_params,
238
- :body => post_body,
239
- :auth_names => auth_names)
240
- if @api_client.config.debugging
241
- @api_client.config.logger.debug "API called: ConversationApi#get_agent_keep_alive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
242
- end
243
- return data, status_code, headers
244
- end
245
- # Get agent profile
246
- # Retrieve the agents profile
247
- # @param [Hash] opts the optional parameters
248
- # @return [ConversationAgentProfileResponse]
249
- def get_agent_profile(opts = {})
250
- data, _status_code, _headers = get_agent_profile_with_http_info(opts)
251
- data
252
- end
253
-
254
- # Get agent profile
255
- # Retrieve the agents profile
256
- # @param [Hash] opts the optional parameters
257
- # @return [Array<(ConversationAgentProfileResponse, Fixnum, Hash)>] ConversationAgentProfileResponse data, response status code and response headers
258
- def get_agent_profile_with_http_info(opts = {})
259
- if @api_client.config.debugging
260
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_agent_profile ...'
261
- end
262
- # resource path
263
- local_var_path = '/conversation/agent/profile'
264
-
265
- # query parameters
266
- query_params = {}
267
-
268
- # header parameters
269
- header_params = {}
270
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
271
- # HTTP header 'Accept' (if needed)
272
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
273
- # HTTP header 'Content-Type'
274
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
275
-
276
- # form parameters
277
- form_params = {}
278
-
279
- # http body (model)
280
- post_body = nil
281
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
282
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
283
- :header_params => header_params,
284
- :query_params => query_params,
285
- :form_params => form_params,
286
- :body => post_body,
287
- :auth_names => auth_names,
288
- :return_type => 'ConversationAgentProfileResponse')
289
- if @api_client.config.debugging
290
- @api_client.config.logger.debug "API called: ConversationApi#get_agent_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
291
- end
292
- return data, status_code, headers
293
- end
294
- # Get agent websocket authorization
295
- # Retrieve a JWT to authorize an agent to make a websocket connection.
296
- # @param [Hash] opts the optional parameters
297
- # @return [ConversationAgentAuthResponse]
298
- def get_agent_websocket_authorization(opts = {})
299
- data, _status_code, _headers = get_agent_websocket_authorization_with_http_info(opts)
300
- data
301
- end
302
-
303
- # Get agent websocket authorization
304
- # Retrieve a JWT to authorize an agent to make a websocket connection.
305
- # @param [Hash] opts the optional parameters
306
- # @return [Array<(ConversationAgentAuthResponse, Fixnum, Hash)>] ConversationAgentAuthResponse data, response status code and response headers
307
- def get_agent_websocket_authorization_with_http_info(opts = {})
308
- if @api_client.config.debugging
309
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_agent_websocket_authorization ...'
310
- end
311
- # resource path
312
- local_var_path = '/conversation/agent/auth'
313
-
314
- # query parameters
315
- query_params = {}
316
-
317
- # header parameters
318
- header_params = {}
319
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
320
- # HTTP header 'Accept' (if needed)
321
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
322
- # HTTP header 'Content-Type'
323
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
324
-
325
- # form parameters
326
- form_params = {}
327
-
328
- # http body (model)
329
- post_body = nil
330
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
331
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
332
- :header_params => header_params,
333
- :query_params => query_params,
334
- :form_params => form_params,
335
- :body => post_body,
336
- :auth_names => auth_names,
337
- :return_type => 'ConversationAgentAuthResponse')
338
- if @api_client.config.debugging
339
- @api_client.config.logger.debug "API called: ConversationApi#get_agent_websocket_authorization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
340
- end
341
- return data, status_code, headers
342
- end
343
- # Retrieve a conversation
344
- # Retrieve a conversation including the participants and messages
345
- # @param conversation_uuid
346
- # @param [Hash] opts the optional parameters
347
- # @option opts [Integer] :limit
348
- # @return [ConversationResponse]
349
- def get_conversation(conversation_uuid, opts = {})
350
- data, _status_code, _headers = get_conversation_with_http_info(conversation_uuid, opts)
351
- data
352
- end
353
-
354
- # Retrieve a conversation
355
- # Retrieve a conversation including the participants and messages
356
- # @param conversation_uuid
357
- # @param [Hash] opts the optional parameters
358
- # @option opts [Integer] :limit
359
- # @return [Array<(ConversationResponse, Fixnum, Hash)>] ConversationResponse data, response status code and response headers
360
- def get_conversation_with_http_info(conversation_uuid, opts = {})
361
- if @api_client.config.debugging
362
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation ...'
363
- end
364
- # verify the required parameter 'conversation_uuid' is set
365
- if @api_client.config.client_side_validation && conversation_uuid.nil?
366
- fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.get_conversation"
367
- end
368
- # resource path
369
- local_var_path = '/conversation/conversations/{conversation_uuid}'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.to_s)
370
-
371
- # query parameters
372
- query_params = {}
373
- query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
374
-
375
- # header parameters
376
- header_params = {}
377
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
378
- # HTTP header 'Accept' (if needed)
379
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
380
- # HTTP header 'Content-Type'
381
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
382
-
383
- # form parameters
384
- form_params = {}
385
-
386
- # http body (model)
387
- post_body = nil
388
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
389
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
390
- :header_params => header_params,
391
- :query_params => query_params,
392
- :form_params => form_params,
393
- :body => post_body,
394
- :auth_names => auth_names,
395
- :return_type => 'ConversationResponse')
396
- if @api_client.config.debugging
397
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
398
- end
399
- return data, status_code, headers
400
- end
401
- # Retrieve a list of canned messages ordered by short_code
402
- # Retrieve a list of canned messages ordered by short_code
403
- # @param [Hash] opts the optional parameters
404
- # @return [ConversationCannedMessagesResponse]
405
- def get_conversation_canned_messages(opts = {})
406
- data, _status_code, _headers = get_conversation_canned_messages_with_http_info(opts)
407
- data
408
- end
409
-
410
- # Retrieve a list of canned messages ordered by short_code
411
- # Retrieve a list of canned messages ordered by short_code
412
- # @param [Hash] opts the optional parameters
413
- # @return [Array<(ConversationCannedMessagesResponse, Fixnum, Hash)>] ConversationCannedMessagesResponse data, response status code and response headers
414
- def get_conversation_canned_messages_with_http_info(opts = {})
415
- if @api_client.config.debugging
416
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_canned_messages ...'
417
- end
418
- # resource path
419
- local_var_path = '/conversation/canned_messages'
420
-
421
- # query parameters
422
- query_params = {}
423
-
424
- # header parameters
425
- header_params = {}
426
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
427
- # HTTP header 'Accept' (if needed)
428
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
429
- # HTTP header 'Content-Type'
430
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
431
-
432
- # form parameters
433
- form_params = {}
434
-
435
- # http body (model)
436
- post_body = nil
437
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
438
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
439
- :header_params => header_params,
440
- :query_params => query_params,
441
- :form_params => form_params,
442
- :body => post_body,
443
- :auth_names => auth_names,
444
- :return_type => 'ConversationCannedMessagesResponse')
445
- if @api_client.config.debugging
446
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_canned_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
447
- end
448
- return data, status_code, headers
449
- end
450
- # Get a webchat conversation context
451
- # Get a webchat conversation context
452
- # @param conversation_uuid
453
- # @param [Hash] opts the optional parameters
454
- # @return [ConversationWebchatContext]
455
- def get_conversation_context(conversation_uuid, opts = {})
456
- data, _status_code, _headers = get_conversation_context_with_http_info(conversation_uuid, opts)
457
- data
458
- end
459
-
460
- # Get a webchat conversation context
461
- # Get a webchat conversation context
462
- # @param conversation_uuid
463
- # @param [Hash] opts the optional parameters
464
- # @return [Array<(ConversationWebchatContext, Fixnum, Hash)>] ConversationWebchatContext data, response status code and response headers
465
- def get_conversation_context_with_http_info(conversation_uuid, opts = {})
466
- if @api_client.config.debugging
467
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_context ...'
468
- end
469
- # verify the required parameter 'conversation_uuid' is set
470
- if @api_client.config.client_side_validation && conversation_uuid.nil?
471
- fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.get_conversation_context"
472
- end
473
- # resource path
474
- local_var_path = '/conversation/conversations/{conversation_uuid}/context'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.to_s)
475
-
476
- # query parameters
477
- query_params = {}
478
-
479
- # header parameters
480
- header_params = {}
481
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
482
- # HTTP header 'Accept' (if needed)
483
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
484
- # HTTP header 'Content-Type'
485
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
486
-
487
- # form parameters
488
- form_params = {}
489
-
490
- # http body (model)
491
- post_body = nil
492
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
493
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
494
- :header_params => header_params,
495
- :query_params => query_params,
496
- :form_params => form_params,
497
- :body => post_body,
498
- :auth_names => auth_names,
499
- :return_type => 'ConversationWebchatContext')
500
- if @api_client.config.debugging
501
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_context\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
502
- end
503
- return data, status_code, headers
504
- end
505
- # Retrieve a list of possible department members
506
- # Retrieve a list of possible department members
507
- # @param [Hash] opts the optional parameters
508
- # @return [ConversationDepartmentMembersResponse]
509
- def get_conversation_department_member_list(opts = {})
510
- data, _status_code, _headers = get_conversation_department_member_list_with_http_info(opts)
511
- data
512
- end
513
-
514
- # Retrieve a list of possible department members
515
- # Retrieve a list of possible department members
516
- # @param [Hash] opts the optional parameters
517
- # @return [Array<(ConversationDepartmentMembersResponse, Fixnum, Hash)>] ConversationDepartmentMembersResponse data, response status code and response headers
518
- def get_conversation_department_member_list_with_http_info(opts = {})
519
- if @api_client.config.debugging
520
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_department_member_list ...'
521
- end
522
- # resource path
523
- local_var_path = '/conversation/department_members'
524
-
525
- # query parameters
526
- query_params = {}
527
-
528
- # header parameters
529
- 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
- # HTTP header 'Content-Type'
534
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
535
-
536
- # form parameters
537
- form_params = {}
538
-
539
- # http body (model)
540
- post_body = nil
541
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
542
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
543
- :header_params => header_params,
544
- :query_params => query_params,
545
- :form_params => form_params,
546
- :body => post_body,
547
- :auth_names => auth_names,
548
- :return_type => 'ConversationDepartmentMembersResponse')
549
- if @api_client.config.debugging
550
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_department_member_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
551
- end
552
- return data, status_code, headers
553
- end
554
- # Retrieve a list of departments ordered by name
555
- # Retrieve a list of departments ordered by name
556
- # @param [Hash] opts the optional parameters
557
- # @return [ConversationDepartmentsResponse]
558
- def get_conversation_departments(opts = {})
559
- data, _status_code, _headers = get_conversation_departments_with_http_info(opts)
560
- data
561
- end
562
-
563
- # Retrieve a list of departments ordered by name
564
- # Retrieve a list of departments ordered by name
565
- # @param [Hash] opts the optional parameters
566
- # @return [Array<(ConversationDepartmentsResponse, Fixnum, Hash)>] ConversationDepartmentsResponse data, response status code and response headers
567
- def get_conversation_departments_with_http_info(opts = {})
568
- if @api_client.config.debugging
569
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_departments ...'
570
- end
571
- # resource path
572
- local_var_path = '/conversation/departments'
573
-
574
- # query parameters
575
- query_params = {}
576
-
577
- # header parameters
578
- header_params = {}
579
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
580
- # HTTP header 'Accept' (if needed)
581
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
582
- # HTTP header 'Content-Type'
583
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
584
-
585
- # form parameters
586
- form_params = {}
587
-
588
- # http body (model)
589
- post_body = nil
590
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
591
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
592
- :header_params => header_params,
593
- :query_params => query_params,
594
- :form_params => form_params,
595
- :body => post_body,
596
- :auth_names => auth_names,
597
- :return_type => 'ConversationDepartmentsResponse')
598
- if @api_client.config.debugging
599
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_departments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
600
- end
601
- return data, status_code, headers
602
- end
603
- # Retrieve an engagement
604
- # Retrieve an engagement
605
- # @param conversation_engagement_oid
606
- # @param [Hash] opts the optional parameters
607
- # @return [ConversationEngagementResponse]
608
- def get_conversation_engagement(conversation_engagement_oid, opts = {})
609
- data, _status_code, _headers = get_conversation_engagement_with_http_info(conversation_engagement_oid, opts)
610
- data
611
- end
612
-
613
- # Retrieve an engagement
614
- # Retrieve an engagement
615
- # @param conversation_engagement_oid
616
- # @param [Hash] opts the optional parameters
617
- # @return [Array<(ConversationEngagementResponse, Fixnum, Hash)>] ConversationEngagementResponse data, response status code and response headers
618
- def get_conversation_engagement_with_http_info(conversation_engagement_oid, opts = {})
619
- if @api_client.config.debugging
620
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_engagement ...'
621
- end
622
- # verify the required parameter 'conversation_engagement_oid' is set
623
- if @api_client.config.client_side_validation && conversation_engagement_oid.nil?
624
- fail ArgumentError, "Missing the required parameter 'conversation_engagement_oid' when calling ConversationApi.get_conversation_engagement"
625
- end
626
- # resource path
627
- local_var_path = '/conversation/engagements/{conversation_engagement_oid}'.sub('{' + 'conversation_engagement_oid' + '}', conversation_engagement_oid.to_s)
628
-
629
- # query parameters
630
- query_params = {}
631
-
632
- # header parameters
633
- header_params = {}
634
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
635
- # HTTP header 'Accept' (if needed)
636
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
637
- # HTTP header 'Content-Type'
638
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
639
-
640
- # form parameters
641
- form_params = {}
642
-
643
- # http body (model)
644
- post_body = nil
645
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
646
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
647
- :header_params => header_params,
648
- :query_params => query_params,
649
- :form_params => form_params,
650
- :body => post_body,
651
- :auth_names => auth_names,
652
- :return_type => 'ConversationEngagementResponse')
653
- if @api_client.config.debugging
654
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_engagement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
655
- end
656
- return data, status_code, headers
657
- end
658
- # Retrieve a list of engagements ordered by name
659
- # Retrieve a list of engagements ordered by name
660
- # @param [Hash] opts the optional parameters
661
- # @return [ConversationEngagementsResponse]
662
- def get_conversation_engagements(opts = {})
663
- data, _status_code, _headers = get_conversation_engagements_with_http_info(opts)
664
- data
665
- end
666
-
667
- # Retrieve a list of engagements ordered by name
668
- # Retrieve a list of engagements ordered by name
669
- # @param [Hash] opts the optional parameters
670
- # @return [Array<(ConversationEngagementsResponse, Fixnum, Hash)>] ConversationEngagementsResponse data, response status code and response headers
671
- def get_conversation_engagements_with_http_info(opts = {})
672
- if @api_client.config.debugging
673
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_engagements ...'
674
- end
675
- # resource path
676
- local_var_path = '/conversation/engagements'
677
-
678
- # query parameters
679
- query_params = {}
680
-
681
- # header parameters
682
- header_params = {}
683
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
684
- # HTTP header 'Accept' (if needed)
685
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
686
- # HTTP header 'Content-Type'
687
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
688
-
689
- # form parameters
690
- form_params = {}
691
-
692
- # http body (model)
693
- post_body = nil
694
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
695
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
696
- :header_params => header_params,
697
- :query_params => query_params,
698
- :form_params => form_params,
699
- :body => post_body,
700
- :auth_names => auth_names,
701
- :return_type => 'ConversationEngagementsResponse')
702
- if @api_client.config.debugging
703
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_engagements\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
704
- end
705
- return data, status_code, headers
706
- end
707
- # Retrieve conversation messages
708
- # Retrieve conversation messages since a particular time
709
- # @param conversation_uuid
710
- # @param since
711
- # @param [Hash] opts the optional parameters
712
- # @option opts [Integer] :limit
713
- # @return [ConversationMessagesResponse]
714
- def get_conversation_messages(conversation_uuid, since, opts = {})
715
- data, _status_code, _headers = get_conversation_messages_with_http_info(conversation_uuid, since, opts)
716
- data
717
- end
718
-
719
- # Retrieve conversation messages
720
- # Retrieve conversation messages since a particular time
721
- # @param conversation_uuid
722
- # @param since
723
- # @param [Hash] opts the optional parameters
724
- # @option opts [Integer] :limit
725
- # @return [Array<(ConversationMessagesResponse, Fixnum, Hash)>] ConversationMessagesResponse data, response status code and response headers
726
- def get_conversation_messages_with_http_info(conversation_uuid, since, opts = {})
727
- if @api_client.config.debugging
728
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_messages ...'
729
- end
730
- # verify the required parameter 'conversation_uuid' is set
731
- if @api_client.config.client_side_validation && conversation_uuid.nil?
732
- fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.get_conversation_messages"
733
- end
734
- # verify the required parameter 'since' is set
735
- if @api_client.config.client_side_validation && since.nil?
736
- fail ArgumentError, "Missing the required parameter 'since' when calling ConversationApi.get_conversation_messages"
737
- end
738
- # resource path
739
- local_var_path = '/conversation/conversations/{conversation_uuid}/messages/{since}'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.to_s).sub('{' + 'since' + '}', since.to_s)
740
-
741
- # query parameters
742
- query_params = {}
743
- query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
744
-
745
- # header parameters
746
- header_params = {}
747
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
748
- # HTTP header 'Accept' (if needed)
749
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
750
- # HTTP header 'Content-Type'
751
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
752
-
753
- # form parameters
754
- form_params = {}
755
-
756
- # http body (model)
757
- post_body = nil
758
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
759
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
760
- :header_params => header_params,
761
- :query_params => query_params,
762
- :form_params => form_params,
763
- :body => post_body,
764
- :auth_names => auth_names,
765
- :return_type => 'ConversationMessagesResponse')
766
- if @api_client.config.debugging
767
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
768
- end
769
- return data, status_code, headers
770
- end
771
- # Get a presigned conersation multimedia upload URL
772
- # Get a presigned conersation multimedia upload URL
773
- # @param extension
774
- # @param [Hash] opts the optional parameters
775
- # @return [ConversationMultimediaUploadUrlResponse]
776
- def get_conversation_multimedia_upload_url(extension, opts = {})
777
- data, _status_code, _headers = get_conversation_multimedia_upload_url_with_http_info(extension, opts)
778
- data
779
- end
780
-
781
- # Get a presigned conersation multimedia upload URL
782
- # Get a presigned conersation multimedia upload URL
783
- # @param extension
784
- # @param [Hash] opts the optional parameters
785
- # @return [Array<(ConversationMultimediaUploadUrlResponse, Fixnum, Hash)>] ConversationMultimediaUploadUrlResponse data, response status code and response headers
786
- def get_conversation_multimedia_upload_url_with_http_info(extension, opts = {})
787
- if @api_client.config.debugging
788
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_multimedia_upload_url ...'
789
- end
790
- # verify the required parameter 'extension' is set
791
- if @api_client.config.client_side_validation && extension.nil?
792
- fail ArgumentError, "Missing the required parameter 'extension' when calling ConversationApi.get_conversation_multimedia_upload_url"
793
- end
794
- # resource path
795
- local_var_path = '/conversation/upload_url/{extension}'.sub('{' + 'extension' + '}', extension.to_s)
796
-
797
- # query parameters
798
- query_params = {}
799
-
800
- # header parameters
801
- header_params = {}
802
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
803
- # HTTP header 'Accept' (if needed)
804
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
805
- # HTTP header 'Content-Type'
806
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
807
-
808
- # form parameters
809
- form_params = {}
810
-
811
- # http body (model)
812
- post_body = nil
813
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
814
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
815
- :header_params => header_params,
816
- :query_params => query_params,
817
- :form_params => form_params,
818
- :body => post_body,
819
- :auth_names => auth_names,
820
- :return_type => 'ConversationMultimediaUploadUrlResponse')
821
- if @api_client.config.debugging
822
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_multimedia_upload_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
823
- end
824
- return data, status_code, headers
825
- end
826
- # Retrieve conversation permissions
827
- # Retrieve conversation permissions
828
- # @param [Hash] opts the optional parameters
829
- # @return [ConversationPermissionsResponse]
830
- def get_conversation_permissions(opts = {})
831
- data, _status_code, _headers = get_conversation_permissions_with_http_info(opts)
832
- data
833
- end
834
-
835
- # Retrieve conversation permissions
836
- # Retrieve conversation permissions
837
- # @param [Hash] opts the optional parameters
838
- # @return [Array<(ConversationPermissionsResponse, Fixnum, Hash)>] ConversationPermissionsResponse data, response status code and response headers
839
- def get_conversation_permissions_with_http_info(opts = {})
840
- if @api_client.config.debugging
841
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_permissions ...'
842
- end
843
- # resource path
844
- local_var_path = '/conversation/permissions'
845
-
846
- # query parameters
847
- query_params = {}
848
-
849
- # header parameters
850
- header_params = {}
851
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
852
- # HTTP header 'Accept' (if needed)
853
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
854
- # HTTP header 'Content-Type'
855
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
856
-
857
- # form parameters
858
- form_params = {}
859
-
860
- # http body (model)
861
- post_body = nil
862
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
863
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
864
- :header_params => header_params,
865
- :query_params => query_params,
866
- :form_params => form_params,
867
- :body => post_body,
868
- :auth_names => auth_names,
869
- :return_type => 'ConversationPermissionsResponse')
870
- if @api_client.config.debugging
871
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
872
- end
873
- return data, status_code, headers
874
- end
875
- # Retrieve a conversation webchat queue statuses
876
- # Retrieve a conversation webchat queue statuses including agent status and queue entries
877
- # @param [Hash] opts the optional parameters
878
- # @return [ConversationWebchatQueueStatusesResponse]
879
- def get_conversation_webchat_queue_statuses(opts = {})
880
- data, _status_code, _headers = get_conversation_webchat_queue_statuses_with_http_info(opts)
881
- data
882
- end
883
-
884
- # Retrieve a conversation webchat queue statuses
885
- # Retrieve a conversation webchat queue statuses including agent status and queue entries
886
- # @param [Hash] opts the optional parameters
887
- # @return [Array<(ConversationWebchatQueueStatusesResponse, Fixnum, Hash)>] ConversationWebchatQueueStatusesResponse data, response status code and response headers
888
- def get_conversation_webchat_queue_statuses_with_http_info(opts = {})
889
- if @api_client.config.debugging
890
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_webchat_queue_statuses ...'
891
- end
892
- # resource path
893
- local_var_path = '/conversation/conversations/queues/statuses'
894
-
895
- # query parameters
896
- query_params = {}
897
-
898
- # header parameters
899
- header_params = {}
900
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
901
- # HTTP header 'Accept' (if needed)
902
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
903
- # HTTP header 'Content-Type'
904
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
905
-
906
- # form parameters
907
- form_params = {}
908
-
909
- # http body (model)
910
- post_body = nil
911
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
912
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
913
- :header_params => header_params,
914
- :query_params => query_params,
915
- :form_params => form_params,
916
- :body => post_body,
917
- :auth_names => auth_names,
918
- :return_type => 'ConversationWebchatQueueStatusesResponse')
919
- if @api_client.config.debugging
920
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_webchat_queue_statuses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
921
- end
922
- return data, status_code, headers
923
- end
924
- # Retrieve a list of conversation summaries newest to oldest
925
- # Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
926
- # @param [Hash] opts the optional parameters
927
- # @option opts [String] :medium
928
- # @option opts [String] :before
929
- # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Max 200) (default to 100)
930
- # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
931
- # @return [ConversationsResponse]
932
- def get_conversations(opts = {})
933
- data, _status_code, _headers = get_conversations_with_http_info(opts)
934
- data
935
- end
936
-
937
- # Retrieve a list of conversation summaries newest to oldest
938
- # Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
939
- # @param [Hash] opts the optional parameters
940
- # @option opts [String] :medium
941
- # @option opts [String] :before
942
- # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Max 200)
943
- # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index.
944
- # @return [Array<(ConversationsResponse, Fixnum, Hash)>] ConversationsResponse data, response status code and response headers
945
- def get_conversations_with_http_info(opts = {})
946
- if @api_client.config.debugging
947
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversations ...'
948
- end
949
- # resource path
950
- local_var_path = '/conversation/conversations'
951
-
952
- # query parameters
953
- query_params = {}
954
- query_params[:'medium'] = opts[:'medium'] if !opts[:'medium'].nil?
955
- query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
956
- query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
957
- query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
958
-
959
- # header parameters
960
- header_params = {}
961
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
962
- # HTTP header 'Accept' (if needed)
963
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
964
- # HTTP header 'Content-Type'
965
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
966
-
967
- # form parameters
968
- form_params = {}
969
-
970
- # http body (model)
971
- post_body = nil
972
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
973
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
974
- :header_params => header_params,
975
- :query_params => query_params,
976
- :form_params => form_params,
977
- :body => post_body,
978
- :auth_names => auth_names,
979
- :return_type => 'ConversationsResponse')
980
- if @api_client.config.debugging
981
- @api_client.config.logger.debug "API called: ConversationApi#get_conversations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
982
- end
983
- return data, status_code, headers
984
- end
985
- # Retrieve a list of matching terms for a search field
986
- # Retrieve a list of matching terms for a search field
987
- # @param autocomplete_request Autocomplete Request
988
- # @param [Hash] opts the optional parameters
989
- # @return [ConversationAutocompleteResponse]
990
- def get_conversations_autocomplete(autocomplete_request, opts = {})
991
- data, _status_code, _headers = get_conversations_autocomplete_with_http_info(autocomplete_request, opts)
992
- data
993
- end
994
-
995
- # Retrieve a list of matching terms for a search field
996
- # Retrieve a list of matching terms for a search field
997
- # @param autocomplete_request Autocomplete Request
998
- # @param [Hash] opts the optional parameters
999
- # @return [Array<(ConversationAutocompleteResponse, Fixnum, Hash)>] ConversationAutocompleteResponse data, response status code and response headers
1000
- def get_conversations_autocomplete_with_http_info(autocomplete_request, opts = {})
1001
- if @api_client.config.debugging
1002
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversations_autocomplete ...'
1003
- end
1004
- # verify the required parameter 'autocomplete_request' is set
1005
- if @api_client.config.client_side_validation && autocomplete_request.nil?
1006
- fail ArgumentError, "Missing the required parameter 'autocomplete_request' when calling ConversationApi.get_conversations_autocomplete"
1007
- end
1008
- # resource path
1009
- local_var_path = '/conversation/conversations/autocomplete'
1010
-
1011
- # query parameters
1012
- query_params = {}
1013
-
1014
- # header parameters
1015
- header_params = {}
1016
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1017
- # HTTP header 'Accept' (if needed)
1018
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1019
- # HTTP header 'Content-Type'
1020
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1021
-
1022
- # form parameters
1023
- form_params = {}
1024
-
1025
- # http body (model)
1026
- post_body = @api_client.object_to_http_body(autocomplete_request)
1027
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1028
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1029
- :header_params => header_params,
1030
- :query_params => query_params,
1031
- :form_params => form_params,
1032
- :body => post_body,
1033
- :auth_names => auth_names,
1034
- :return_type => 'ConversationAutocompleteResponse')
1035
- if @api_client.config.debugging
1036
- @api_client.config.logger.debug "API called: ConversationApi#get_conversations_autocomplete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1037
- end
1038
- return data, status_code, headers
1039
- end
1040
- # Search conversations
1041
- # Search conversations
1042
- # @param search_request Search Request
1043
- # @param [Hash] opts the optional parameters
1044
- # @return [ConversationSearchResponse]
1045
- def get_conversations_search(search_request, opts = {})
1046
- data, _status_code, _headers = get_conversations_search_with_http_info(search_request, opts)
1047
- data
1048
- end
1049
-
1050
- # Search conversations
1051
- # Search conversations
1052
- # @param search_request Search Request
1053
- # @param [Hash] opts the optional parameters
1054
- # @return [Array<(ConversationSearchResponse, Fixnum, Hash)>] ConversationSearchResponse data, response status code and response headers
1055
- def get_conversations_search_with_http_info(search_request, opts = {})
1056
- if @api_client.config.debugging
1057
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversations_search ...'
1058
- end
1059
- # verify the required parameter 'search_request' is set
1060
- if @api_client.config.client_side_validation && search_request.nil?
1061
- fail ArgumentError, "Missing the required parameter 'search_request' when calling ConversationApi.get_conversations_search"
1062
- end
1063
- # resource path
1064
- local_var_path = '/conversation/conversations/search'
1065
-
1066
- # query parameters
1067
- query_params = {}
1068
-
1069
- # header parameters
1070
- header_params = {}
1071
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1072
- # HTTP header 'Accept' (if needed)
1073
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1074
- # HTTP header 'Content-Type'
1075
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1076
-
1077
- # form parameters
1078
- form_params = {}
1079
-
1080
- # http body (model)
1081
- post_body = @api_client.object_to_http_body(search_request)
1082
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1083
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1084
- :header_params => header_params,
1085
- :query_params => query_params,
1086
- :form_params => form_params,
1087
- :body => post_body,
1088
- :auth_names => auth_names,
1089
- :return_type => 'ConversationSearchResponse')
1090
- if @api_client.config.debugging
1091
- @api_client.config.logger.debug "API called: ConversationApi#get_conversations_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1092
- end
1093
- return data, status_code, headers
1094
- end
1095
- # Get location data for engagement configuration
1096
- # Get location data for engagement configuration
1097
- # @param [Hash] opts the optional parameters
1098
- # @return [ConversationLocationsResponse]
1099
- def get_locations_for_engagement(opts = {})
1100
- data, _status_code, _headers = get_locations_for_engagement_with_http_info(opts)
1101
- data
1102
- end
1103
-
1104
- # Get location data for engagement configuration
1105
- # Get location data for engagement configuration
1106
- # @param [Hash] opts the optional parameters
1107
- # @return [Array<(ConversationLocationsResponse, Fixnum, Hash)>] ConversationLocationsResponse data, response status code and response headers
1108
- def get_locations_for_engagement_with_http_info(opts = {})
1109
- if @api_client.config.debugging
1110
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_locations_for_engagement ...'
1111
- end
1112
- # resource path
1113
- local_var_path = '/conversation/locations'
1114
-
1115
- # query parameters
1116
- query_params = {}
1117
-
1118
- # header parameters
1119
- header_params = {}
1120
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1121
- # HTTP header 'Accept' (if needed)
1122
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1123
- # HTTP header 'Content-Type'
1124
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1125
-
1126
- # form parameters
1127
- form_params = {}
1128
-
1129
- # http body (model)
1130
- post_body = nil
1131
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1132
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
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 => 'ConversationLocationsResponse')
1139
- if @api_client.config.debugging
1140
- @api_client.config.logger.debug "API called: ConversationApi#get_locations_for_engagement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1141
- end
1142
- return data, status_code, headers
1143
- end
1144
- # Insert a canned message
1145
- # Insert a canned message
1146
- # @param canned_message Canned message
1147
- # @param [Hash] opts the optional parameters
1148
- # @return [ConversationCannedMessageResponse]
1149
- def insert_conversation_canned_message(canned_message, opts = {})
1150
- data, _status_code, _headers = insert_conversation_canned_message_with_http_info(canned_message, opts)
1151
- data
1152
- end
1153
-
1154
- # Insert a canned message
1155
- # Insert a canned message
1156
- # @param canned_message Canned message
1157
- # @param [Hash] opts the optional parameters
1158
- # @return [Array<(ConversationCannedMessageResponse, Fixnum, Hash)>] ConversationCannedMessageResponse data, response status code and response headers
1159
- def insert_conversation_canned_message_with_http_info(canned_message, opts = {})
1160
- if @api_client.config.debugging
1161
- @api_client.config.logger.debug 'Calling API: ConversationApi.insert_conversation_canned_message ...'
1162
- end
1163
- # verify the required parameter 'canned_message' is set
1164
- if @api_client.config.client_side_validation && canned_message.nil?
1165
- fail ArgumentError, "Missing the required parameter 'canned_message' when calling ConversationApi.insert_conversation_canned_message"
1166
- end
1167
- # resource path
1168
- local_var_path = '/conversation/canned_messages'
1169
-
1170
- # query parameters
1171
- query_params = {}
1172
-
1173
- # header parameters
1174
- header_params = {}
1175
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1176
- # HTTP header 'Accept' (if needed)
1177
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1178
- # HTTP header 'Content-Type'
1179
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1180
-
1181
- # form parameters
1182
- form_params = {}
1183
-
1184
- # http body (model)
1185
- post_body = @api_client.object_to_http_body(canned_message)
1186
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1187
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1188
- :header_params => header_params,
1189
- :query_params => query_params,
1190
- :form_params => form_params,
1191
- :body => post_body,
1192
- :auth_names => auth_names,
1193
- :return_type => 'ConversationCannedMessageResponse')
1194
- if @api_client.config.debugging
1195
- @api_client.config.logger.debug "API called: ConversationApi#insert_conversation_canned_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1196
- end
1197
- return data, status_code, headers
1198
- end
1199
- # Insert a department
1200
- # Insert a department
1201
- # @param department Department
1202
- # @param [Hash] opts the optional parameters
1203
- # @return [ConversationDepartmentResponse]
1204
- def insert_conversation_department(department, opts = {})
1205
- data, _status_code, _headers = insert_conversation_department_with_http_info(department, opts)
1206
- data
1207
- end
1208
-
1209
- # Insert a department
1210
- # Insert a department
1211
- # @param department Department
1212
- # @param [Hash] opts the optional parameters
1213
- # @return [Array<(ConversationDepartmentResponse, Fixnum, Hash)>] ConversationDepartmentResponse data, response status code and response headers
1214
- def insert_conversation_department_with_http_info(department, opts = {})
1215
- if @api_client.config.debugging
1216
- @api_client.config.logger.debug 'Calling API: ConversationApi.insert_conversation_department ...'
1217
- end
1218
- # verify the required parameter 'department' is set
1219
- if @api_client.config.client_side_validation && department.nil?
1220
- fail ArgumentError, "Missing the required parameter 'department' when calling ConversationApi.insert_conversation_department"
1221
- end
1222
- # resource path
1223
- local_var_path = '/conversation/departments'
1224
-
1225
- # query parameters
1226
- query_params = {}
1227
-
1228
- # header parameters
1229
- header_params = {}
1230
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1231
- # HTTP header 'Accept' (if needed)
1232
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1233
- # HTTP header 'Content-Type'
1234
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1235
-
1236
- # form parameters
1237
- form_params = {}
1238
-
1239
- # http body (model)
1240
- post_body = @api_client.object_to_http_body(department)
1241
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1242
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1243
- :header_params => header_params,
1244
- :query_params => query_params,
1245
- :form_params => form_params,
1246
- :body => post_body,
1247
- :auth_names => auth_names,
1248
- :return_type => 'ConversationDepartmentResponse')
1249
- if @api_client.config.debugging
1250
- @api_client.config.logger.debug "API called: ConversationApi#insert_conversation_department\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1251
- end
1252
- return data, status_code, headers
1253
- end
1254
- # Insert a engagement
1255
- # Insert a engagement
1256
- # @param engagement Engagement
1257
- # @param [Hash] opts the optional parameters
1258
- # @return [ConversationEngagementResponse]
1259
- def insert_conversation_engagement(engagement, opts = {})
1260
- data, _status_code, _headers = insert_conversation_engagement_with_http_info(engagement, opts)
1261
- data
1262
- end
1263
-
1264
- # Insert a engagement
1265
- # Insert a engagement
1266
- # @param engagement Engagement
1267
- # @param [Hash] opts the optional parameters
1268
- # @return [Array<(ConversationEngagementResponse, Fixnum, Hash)>] ConversationEngagementResponse data, response status code and response headers
1269
- def insert_conversation_engagement_with_http_info(engagement, opts = {})
1270
- if @api_client.config.debugging
1271
- @api_client.config.logger.debug 'Calling API: ConversationApi.insert_conversation_engagement ...'
1272
- end
1273
- # verify the required parameter 'engagement' is set
1274
- if @api_client.config.client_side_validation && engagement.nil?
1275
- fail ArgumentError, "Missing the required parameter 'engagement' when calling ConversationApi.insert_conversation_engagement"
1276
- end
1277
- # resource path
1278
- local_var_path = '/conversation/engagements'
1279
-
1280
- # query parameters
1281
- query_params = {}
1282
-
1283
- # header parameters
1284
- header_params = {}
1285
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1286
- # HTTP header 'Accept' (if needed)
1287
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1288
- # HTTP header 'Content-Type'
1289
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1290
-
1291
- # form parameters
1292
- form_params = {}
1293
-
1294
- # http body (model)
1295
- post_body = @api_client.object_to_http_body(engagement)
1296
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1297
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1298
- :header_params => header_params,
1299
- :query_params => query_params,
1300
- :form_params => form_params,
1301
- :body => post_body,
1302
- :auth_names => auth_names,
1303
- :return_type => 'ConversationEngagementResponse')
1304
- if @api_client.config.debugging
1305
- @api_client.config.logger.debug "API called: ConversationApi#insert_conversation_engagement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1306
- end
1307
- return data, status_code, headers
1308
- end
1309
- # Join a conversation
1310
- # Join a conversation
1311
- # @param conversation_uuid
1312
- # @param [Hash] opts the optional parameters
1313
- # @option opts [ConversationJoinRequest] :join_request Join request
1314
- # @return [nil]
1315
- def join_conversation(conversation_uuid, opts = {})
1316
- join_conversation_with_http_info(conversation_uuid, opts)
1317
- nil
1318
- end
1319
-
1320
- # Join a conversation
1321
- # Join a conversation
1322
- # @param conversation_uuid
1323
- # @param [Hash] opts the optional parameters
1324
- # @option opts [ConversationJoinRequest] :join_request Join request
1325
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1326
- def join_conversation_with_http_info(conversation_uuid, opts = {})
1327
- if @api_client.config.debugging
1328
- @api_client.config.logger.debug 'Calling API: ConversationApi.join_conversation ...'
1329
- end
1330
- # verify the required parameter 'conversation_uuid' is set
1331
- if @api_client.config.client_side_validation && conversation_uuid.nil?
1332
- fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.join_conversation"
1333
- end
1334
- # resource path
1335
- local_var_path = '/conversation/conversations/{conversation_uuid}/join'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.to_s)
1336
-
1337
- # query parameters
1338
- query_params = {}
1339
-
1340
- # header parameters
1341
- header_params = {}
1342
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1343
- # HTTP header 'Accept' (if needed)
1344
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1345
- # HTTP header 'Content-Type'
1346
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1347
-
1348
- # form parameters
1349
- form_params = {}
1350
-
1351
- # http body (model)
1352
- post_body = @api_client.object_to_http_body(opts[:'join_request'])
1353
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1354
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1355
- :header_params => header_params,
1356
- :query_params => query_params,
1357
- :form_params => form_params,
1358
- :body => post_body,
1359
- :auth_names => auth_names)
1360
- if @api_client.config.debugging
1361
- @api_client.config.logger.debug "API called: ConversationApi#join_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1362
- end
1363
- return data, status_code, headers
1364
- end
1365
- # Leave a conversation
1366
- # Leave a conversation
1367
- # @param conversation_uuid
1368
- # @param [Hash] opts the optional parameters
1369
- # @return [nil]
1370
- def leave_conversation(conversation_uuid, opts = {})
1371
- leave_conversation_with_http_info(conversation_uuid, opts)
1372
- nil
1373
- end
1374
-
1375
- # Leave a conversation
1376
- # Leave a conversation
1377
- # @param conversation_uuid
1378
- # @param [Hash] opts the optional parameters
1379
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1380
- def leave_conversation_with_http_info(conversation_uuid, opts = {})
1381
- if @api_client.config.debugging
1382
- @api_client.config.logger.debug 'Calling API: ConversationApi.leave_conversation ...'
1383
- end
1384
- # verify the required parameter 'conversation_uuid' is set
1385
- if @api_client.config.client_side_validation && conversation_uuid.nil?
1386
- fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.leave_conversation"
1387
- end
1388
- # resource path
1389
- local_var_path = '/conversation/conversations/{conversation_uuid}/leave'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.to_s)
1390
-
1391
- # query parameters
1392
- query_params = {}
1393
-
1394
- # header parameters
1395
- header_params = {}
1396
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1397
- # HTTP header 'Accept' (if needed)
1398
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1399
- # HTTP header 'Content-Type'
1400
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1401
-
1402
- # form parameters
1403
- form_params = {}
1404
-
1405
- # http body (model)
1406
- post_body = nil
1407
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1408
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
1409
- :header_params => header_params,
1410
- :query_params => query_params,
1411
- :form_params => form_params,
1412
- :body => post_body,
1413
- :auth_names => auth_names)
1414
- if @api_client.config.debugging
1415
- @api_client.config.logger.debug "API called: ConversationApi#leave_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1416
- end
1417
- return data, status_code, headers
1418
- end
1419
- # Mark a conversation as read
1420
- # Mark a conversation as read
1421
- # @param conversation_uuid
1422
- # @param [Hash] opts the optional parameters
1423
- # @return [nil]
1424
- def mark_read_conversation(conversation_uuid, opts = {})
1425
- mark_read_conversation_with_http_info(conversation_uuid, opts)
1426
- nil
1427
- end
1428
-
1429
- # Mark a conversation as read
1430
- # Mark a conversation as read
1431
- # @param conversation_uuid
1432
- # @param [Hash] opts the optional parameters
1433
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1434
- def mark_read_conversation_with_http_info(conversation_uuid, opts = {})
1435
- if @api_client.config.debugging
1436
- @api_client.config.logger.debug 'Calling API: ConversationApi.mark_read_conversation ...'
1437
- end
1438
- # verify the required parameter 'conversation_uuid' is set
1439
- if @api_client.config.client_side_validation && conversation_uuid.nil?
1440
- fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.mark_read_conversation"
1441
- end
1442
- # resource path
1443
- local_var_path = '/conversation/conversations/{conversation_uuid}/markread'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.to_s)
1444
-
1445
- # query parameters
1446
- query_params = {}
1447
-
1448
- # header parameters
1449
- header_params = {}
1450
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1451
- # HTTP header 'Accept' (if needed)
1452
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1453
- # HTTP header 'Content-Type'
1454
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1455
-
1456
- # form parameters
1457
- form_params = {}
1458
-
1459
- # http body (model)
1460
- post_body = nil
1461
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1462
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1463
- :header_params => header_params,
1464
- :query_params => query_params,
1465
- :form_params => form_params,
1466
- :body => post_body,
1467
- :auth_names => auth_names)
1468
- if @api_client.config.debugging
1469
- @api_client.config.logger.debug "API called: ConversationApi#mark_read_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1470
- end
1471
- return data, status_code, headers
1472
- end
1473
- # Search for canned messages by short_code
1474
- # Search for canned messages by short_code
1475
- # @param search_request Search request
1476
- # @param [Hash] opts the optional parameters
1477
- # @return [ConversationCannedMessagesResponse]
1478
- def search_conversation_canned_messages(search_request, opts = {})
1479
- data, _status_code, _headers = search_conversation_canned_messages_with_http_info(search_request, opts)
1480
- data
1481
- end
1482
-
1483
- # Search for canned messages by short_code
1484
- # Search for canned messages by short_code
1485
- # @param search_request Search request
1486
- # @param [Hash] opts the optional parameters
1487
- # @return [Array<(ConversationCannedMessagesResponse, Fixnum, Hash)>] ConversationCannedMessagesResponse data, response status code and response headers
1488
- def search_conversation_canned_messages_with_http_info(search_request, opts = {})
1489
- if @api_client.config.debugging
1490
- @api_client.config.logger.debug 'Calling API: ConversationApi.search_conversation_canned_messages ...'
1491
- end
1492
- # verify the required parameter 'search_request' is set
1493
- if @api_client.config.client_side_validation && search_request.nil?
1494
- fail ArgumentError, "Missing the required parameter 'search_request' when calling ConversationApi.search_conversation_canned_messages"
1495
- end
1496
- # resource path
1497
- local_var_path = '/conversation/canned_messages/search'
1498
-
1499
- # query parameters
1500
- query_params = {}
1501
-
1502
- # header parameters
1503
- header_params = {}
1504
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1505
- # HTTP header 'Accept' (if needed)
1506
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1507
- # HTTP header 'Content-Type'
1508
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1509
-
1510
- # form parameters
1511
- form_params = {}
1512
-
1513
- # http body (model)
1514
- post_body = @api_client.object_to_http_body(search_request)
1515
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1516
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1517
- :header_params => header_params,
1518
- :query_params => query_params,
1519
- :form_params => form_params,
1520
- :body => post_body,
1521
- :auth_names => auth_names,
1522
- :return_type => 'ConversationCannedMessagesResponse')
1523
- if @api_client.config.debugging
1524
- @api_client.config.logger.debug "API called: ConversationApi#search_conversation_canned_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1525
- end
1526
- return data, status_code, headers
1527
- end
1528
- # Unsubscribe any SMS participants in this conversation
1529
- # Unsubscribe any SMS participants in this conversation
1530
- # @param conversation_uuid
1531
- # @param [Hash] opts the optional parameters
1532
- # @return [nil]
1533
- def sms_unsubscribe_conversation(conversation_uuid, opts = {})
1534
- sms_unsubscribe_conversation_with_http_info(conversation_uuid, opts)
1535
- nil
1536
- end
1537
-
1538
- # Unsubscribe any SMS participants in this conversation
1539
- # Unsubscribe any SMS participants in this conversation
1540
- # @param conversation_uuid
1541
- # @param [Hash] opts the optional parameters
1542
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1543
- def sms_unsubscribe_conversation_with_http_info(conversation_uuid, opts = {})
1544
- if @api_client.config.debugging
1545
- @api_client.config.logger.debug 'Calling API: ConversationApi.sms_unsubscribe_conversation ...'
1546
- end
1547
- # verify the required parameter 'conversation_uuid' is set
1548
- if @api_client.config.client_side_validation && conversation_uuid.nil?
1549
- fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.sms_unsubscribe_conversation"
1550
- end
1551
- # resource path
1552
- local_var_path = '/conversation/conversations/{conversation_uuid}/sms_unsubscribe'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.to_s)
1553
-
1554
- # query parameters
1555
- query_params = {}
1556
-
1557
- # header parameters
1558
- header_params = {}
1559
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1560
- # HTTP header 'Accept' (if needed)
1561
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1562
- # HTTP header 'Content-Type'
1563
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1564
-
1565
- # form parameters
1566
- form_params = {}
1567
-
1568
- # http body (model)
1569
- post_body = nil
1570
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1571
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1572
- :header_params => header_params,
1573
- :query_params => query_params,
1574
- :form_params => form_params,
1575
- :body => post_body,
1576
- :auth_names => auth_names)
1577
- if @api_client.config.debugging
1578
- @api_client.config.logger.debug "API called: ConversationApi#sms_unsubscribe_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1579
- end
1580
- return data, status_code, headers
1581
- end
1582
- # Start a conversation
1583
- # Start a new conversation
1584
- # @param start_request Start request
1585
- # @param [Hash] opts the optional parameters
1586
- # @return [ConversationStartResponse]
1587
- def start_conversation(start_request, opts = {})
1588
- data, _status_code, _headers = start_conversation_with_http_info(start_request, opts)
1589
- data
1590
- end
1591
-
1592
- # Start a conversation
1593
- # Start a new conversation
1594
- # @param start_request Start request
1595
- # @param [Hash] opts the optional parameters
1596
- # @return [Array<(ConversationStartResponse, Fixnum, Hash)>] ConversationStartResponse data, response status code and response headers
1597
- def start_conversation_with_http_info(start_request, opts = {})
1598
- if @api_client.config.debugging
1599
- @api_client.config.logger.debug 'Calling API: ConversationApi.start_conversation ...'
1600
- end
1601
- # verify the required parameter 'start_request' is set
1602
- if @api_client.config.client_side_validation && start_request.nil?
1603
- fail ArgumentError, "Missing the required parameter 'start_request' when calling ConversationApi.start_conversation"
1604
- end
1605
- # resource path
1606
- local_var_path = '/conversation/conversations'
1607
-
1608
- # query parameters
1609
- query_params = {}
1610
-
1611
- # header parameters
1612
- header_params = {}
1613
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1614
- # HTTP header 'Accept' (if needed)
1615
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1616
- # HTTP header 'Content-Type'
1617
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1618
-
1619
- # form parameters
1620
- form_params = {}
1621
-
1622
- # http body (model)
1623
- post_body = @api_client.object_to_http_body(start_request)
1624
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1625
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1626
- :header_params => header_params,
1627
- :query_params => query_params,
1628
- :form_params => form_params,
1629
- :body => post_body,
1630
- :auth_names => auth_names,
1631
- :return_type => 'ConversationStartResponse')
1632
- if @api_client.config.debugging
1633
- @api_client.config.logger.debug "API called: ConversationApi#start_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1634
- end
1635
- return data, status_code, headers
1636
- end
1637
- # Update agent profile
1638
- # Update agent profile
1639
- # @param profile_request Profile request
1640
- # @param [Hash] opts the optional parameters
1641
- # @return [ConversationAgentProfileResponse]
1642
- def update_agent_profile(profile_request, opts = {})
1643
- data, _status_code, _headers = update_agent_profile_with_http_info(profile_request, opts)
1644
- data
1645
- end
1646
-
1647
- # Update agent profile
1648
- # Update agent profile
1649
- # @param profile_request Profile request
1650
- # @param [Hash] opts the optional parameters
1651
- # @return [Array<(ConversationAgentProfileResponse, Fixnum, Hash)>] ConversationAgentProfileResponse data, response status code and response headers
1652
- def update_agent_profile_with_http_info(profile_request, opts = {})
1653
- if @api_client.config.debugging
1654
- @api_client.config.logger.debug 'Calling API: ConversationApi.update_agent_profile ...'
1655
- end
1656
- # verify the required parameter 'profile_request' is set
1657
- if @api_client.config.client_side_validation && profile_request.nil?
1658
- fail ArgumentError, "Missing the required parameter 'profile_request' when calling ConversationApi.update_agent_profile"
1659
- end
1660
- # resource path
1661
- local_var_path = '/conversation/agent/profile'
1662
-
1663
- # query parameters
1664
- query_params = {}
1665
-
1666
- # header parameters
1667
- header_params = {}
1668
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1669
- # HTTP header 'Accept' (if needed)
1670
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1671
- # HTTP header 'Content-Type'
1672
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1673
-
1674
- # form parameters
1675
- form_params = {}
1676
-
1677
- # http body (model)
1678
- post_body = @api_client.object_to_http_body(profile_request)
1679
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1680
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1681
- :header_params => header_params,
1682
- :query_params => query_params,
1683
- :form_params => form_params,
1684
- :body => post_body,
1685
- :auth_names => auth_names,
1686
- :return_type => 'ConversationAgentProfileResponse')
1687
- if @api_client.config.debugging
1688
- @api_client.config.logger.debug "API called: ConversationApi#update_agent_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1689
- end
1690
- return data, status_code, headers
1691
- end
1692
- # Update a canned message
1693
- # Update a canned message
1694
- # @param conversation_canned_message_oid
1695
- # @param canned_message Canned message
1696
- # @param [Hash] opts the optional parameters
1697
- # @return [ConversationCannedMessageResponse]
1698
- def update_conversation_canned_message(conversation_canned_message_oid, canned_message, opts = {})
1699
- data, _status_code, _headers = update_conversation_canned_message_with_http_info(conversation_canned_message_oid, canned_message, opts)
1700
- data
1701
- end
1702
-
1703
- # Update a canned message
1704
- # Update a canned message
1705
- # @param conversation_canned_message_oid
1706
- # @param canned_message Canned message
1707
- # @param [Hash] opts the optional parameters
1708
- # @return [Array<(ConversationCannedMessageResponse, Fixnum, Hash)>] ConversationCannedMessageResponse data, response status code and response headers
1709
- def update_conversation_canned_message_with_http_info(conversation_canned_message_oid, canned_message, opts = {})
1710
- if @api_client.config.debugging
1711
- @api_client.config.logger.debug 'Calling API: ConversationApi.update_conversation_canned_message ...'
1712
- end
1713
- # verify the required parameter 'conversation_canned_message_oid' is set
1714
- if @api_client.config.client_side_validation && conversation_canned_message_oid.nil?
1715
- fail ArgumentError, "Missing the required parameter 'conversation_canned_message_oid' when calling ConversationApi.update_conversation_canned_message"
1716
- end
1717
- # verify the required parameter 'canned_message' is set
1718
- if @api_client.config.client_side_validation && canned_message.nil?
1719
- fail ArgumentError, "Missing the required parameter 'canned_message' when calling ConversationApi.update_conversation_canned_message"
1720
- end
1721
- # resource path
1722
- local_var_path = '/conversation/canned_messages/{conversation_canned_message_oid}'.sub('{' + 'conversation_canned_message_oid' + '}', conversation_canned_message_oid.to_s)
1723
-
1724
- # query parameters
1725
- query_params = {}
1726
-
1727
- # header parameters
1728
- header_params = {}
1729
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1730
- # HTTP header 'Accept' (if needed)
1731
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1732
- # HTTP header 'Content-Type'
1733
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1734
-
1735
- # form parameters
1736
- form_params = {}
1737
-
1738
- # http body (model)
1739
- post_body = @api_client.object_to_http_body(canned_message)
1740
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1741
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1742
- :header_params => header_params,
1743
- :query_params => query_params,
1744
- :form_params => form_params,
1745
- :body => post_body,
1746
- :auth_names => auth_names,
1747
- :return_type => 'ConversationCannedMessageResponse')
1748
- if @api_client.config.debugging
1749
- @api_client.config.logger.debug "API called: ConversationApi#update_conversation_canned_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1750
- end
1751
- return data, status_code, headers
1752
- end
1753
- # Update a department
1754
- # Update a department
1755
- # @param conversation_department_oid
1756
- # @param department Department
1757
- # @param [Hash] opts the optional parameters
1758
- # @return [ConversationDepartmentResponse]
1759
- def update_conversation_department(conversation_department_oid, department, opts = {})
1760
- data, _status_code, _headers = update_conversation_department_with_http_info(conversation_department_oid, department, opts)
1761
- data
1762
- end
1763
-
1764
- # Update a department
1765
- # Update a department
1766
- # @param conversation_department_oid
1767
- # @param department Department
1768
- # @param [Hash] opts the optional parameters
1769
- # @return [Array<(ConversationDepartmentResponse, Fixnum, Hash)>] ConversationDepartmentResponse data, response status code and response headers
1770
- def update_conversation_department_with_http_info(conversation_department_oid, department, opts = {})
1771
- if @api_client.config.debugging
1772
- @api_client.config.logger.debug 'Calling API: ConversationApi.update_conversation_department ...'
1773
- end
1774
- # verify the required parameter 'conversation_department_oid' is set
1775
- if @api_client.config.client_side_validation && conversation_department_oid.nil?
1776
- fail ArgumentError, "Missing the required parameter 'conversation_department_oid' when calling ConversationApi.update_conversation_department"
1777
- end
1778
- # verify the required parameter 'department' is set
1779
- if @api_client.config.client_side_validation && department.nil?
1780
- fail ArgumentError, "Missing the required parameter 'department' when calling ConversationApi.update_conversation_department"
1781
- end
1782
- # resource path
1783
- local_var_path = '/conversation/departments/{conversation_department_oid}'.sub('{' + 'conversation_department_oid' + '}', conversation_department_oid.to_s)
1784
-
1785
- # query parameters
1786
- query_params = {}
1787
-
1788
- # header parameters
1789
- header_params = {}
1790
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1791
- # HTTP header 'Accept' (if needed)
1792
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1793
- # HTTP header 'Content-Type'
1794
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1795
-
1796
- # form parameters
1797
- form_params = {}
1798
-
1799
- # http body (model)
1800
- post_body = @api_client.object_to_http_body(department)
1801
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1802
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1803
- :header_params => header_params,
1804
- :query_params => query_params,
1805
- :form_params => form_params,
1806
- :body => post_body,
1807
- :auth_names => auth_names,
1808
- :return_type => 'ConversationDepartmentResponse')
1809
- if @api_client.config.debugging
1810
- @api_client.config.logger.debug "API called: ConversationApi#update_conversation_department\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1811
- end
1812
- return data, status_code, headers
1813
- end
1814
- # Update a engagement
1815
- # Update a engagement
1816
- # @param conversation_engagement_oid
1817
- # @param engagement Engagement
1818
- # @param [Hash] opts the optional parameters
1819
- # @return [ConversationEngagementResponse]
1820
- def update_conversation_engagement(conversation_engagement_oid, engagement, opts = {})
1821
- data, _status_code, _headers = update_conversation_engagement_with_http_info(conversation_engagement_oid, engagement, opts)
1822
- data
1823
- end
1824
-
1825
- # Update a engagement
1826
- # Update a engagement
1827
- # @param conversation_engagement_oid
1828
- # @param engagement Engagement
1829
- # @param [Hash] opts the optional parameters
1830
- # @return [Array<(ConversationEngagementResponse, Fixnum, Hash)>] ConversationEngagementResponse data, response status code and response headers
1831
- def update_conversation_engagement_with_http_info(conversation_engagement_oid, engagement, opts = {})
1832
- if @api_client.config.debugging
1833
- @api_client.config.logger.debug 'Calling API: ConversationApi.update_conversation_engagement ...'
1834
- end
1835
- # verify the required parameter 'conversation_engagement_oid' is set
1836
- if @api_client.config.client_side_validation && conversation_engagement_oid.nil?
1837
- fail ArgumentError, "Missing the required parameter 'conversation_engagement_oid' when calling ConversationApi.update_conversation_engagement"
1838
- end
1839
- # verify the required parameter 'engagement' is set
1840
- if @api_client.config.client_side_validation && engagement.nil?
1841
- fail ArgumentError, "Missing the required parameter 'engagement' when calling ConversationApi.update_conversation_engagement"
1842
- end
1843
- # resource path
1844
- local_var_path = '/conversation/engagements/{conversation_engagement_oid}'.sub('{' + 'conversation_engagement_oid' + '}', conversation_engagement_oid.to_s)
1845
-
1846
- # query parameters
1847
- query_params = {}
1848
-
1849
- # header parameters
1850
- header_params = {}
1851
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1852
- # HTTP header 'Accept' (if needed)
1853
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1854
- # HTTP header 'Content-Type'
1855
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1856
-
1857
- # form parameters
1858
- form_params = {}
1859
-
1860
- # http body (model)
1861
- post_body = @api_client.object_to_http_body(engagement)
1862
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1863
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1864
- :header_params => header_params,
1865
- :query_params => query_params,
1866
- :form_params => form_params,
1867
- :body => post_body,
1868
- :auth_names => auth_names,
1869
- :return_type => 'ConversationEngagementResponse')
1870
- if @api_client.config.debugging
1871
- @api_client.config.logger.debug "API called: ConversationApi#update_conversation_engagement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1872
- end
1873
- return data, status_code, headers
1874
- end
1875
- # Update status within the queue
1876
- # Update status within the queue
1877
- # @param queue_name
1878
- # @param status_request Status request
1879
- # @param [Hash] opts the optional parameters
1880
- # @return [nil]
1881
- def update_conversation_webchat_queue_status(queue_name, status_request, opts = {})
1882
- update_conversation_webchat_queue_status_with_http_info(queue_name, status_request, opts)
1883
- nil
1884
- end
1885
-
1886
- # Update status within the queue
1887
- # Update status within the queue
1888
- # @param queue_name
1889
- # @param status_request Status request
1890
- # @param [Hash] opts the optional parameters
1891
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1892
- def update_conversation_webchat_queue_status_with_http_info(queue_name, status_request, opts = {})
1893
- if @api_client.config.debugging
1894
- @api_client.config.logger.debug 'Calling API: ConversationApi.update_conversation_webchat_queue_status ...'
1895
- end
1896
- # verify the required parameter 'queue_name' is set
1897
- if @api_client.config.client_side_validation && queue_name.nil?
1898
- fail ArgumentError, "Missing the required parameter 'queue_name' when calling ConversationApi.update_conversation_webchat_queue_status"
1899
- end
1900
- # verify the required parameter 'status_request' is set
1901
- if @api_client.config.client_side_validation && status_request.nil?
1902
- fail ArgumentError, "Missing the required parameter 'status_request' when calling ConversationApi.update_conversation_webchat_queue_status"
1903
- end
1904
- # resource path
1905
- local_var_path = '/conversation/conversations/queues/{queue_name}/status'.sub('{' + 'queue_name' + '}', queue_name.to_s)
1906
-
1907
- # query parameters
1908
- query_params = {}
1909
-
1910
- # header parameters
1911
- header_params = {}
1912
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1913
- # HTTP header 'Accept' (if needed)
1914
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1915
- # HTTP header 'Content-Type'
1916
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1917
-
1918
- # form parameters
1919
- form_params = {}
1920
-
1921
- # http body (model)
1922
- post_body = @api_client.object_to_http_body(status_request)
1923
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1924
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1925
- :header_params => header_params,
1926
- :query_params => query_params,
1927
- :form_params => form_params,
1928
- :body => post_body,
1929
- :auth_names => auth_names)
1930
- if @api_client.config.debugging
1931
- @api_client.config.logger.debug "API called: ConversationApi#update_conversation_webchat_queue_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1932
- end
1933
- return data, status_code, headers
1934
- end
1935
- end
1936
- end