ultracart_api 3.11.10 → 4.0.32.rc

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (1779) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +9 -7
  3. data/README.md +1166 -1743
  4. data/Rakefile +10 -8
  5. data/docs/AccountsReceivableRetryConfig.md +46 -23
  6. data/docs/AccountsReceivableRetryConfigResponse.md +32 -15
  7. data/docs/AccountsReceivableRetryDayActivity.md +22 -10
  8. data/docs/AccountsReceivableRetryStatAccount.md +24 -11
  9. data/docs/AccountsReceivableRetryStatMetrics.md +38 -18
  10. data/docs/AccountsReceivableRetryStatRevenue.md +20 -9
  11. data/docs/AccountsReceivableRetryStatsResponse.md +28 -13
  12. data/docs/Activity.md +28 -15
  13. data/docs/AddLibraryItemRequest.md +38 -18
  14. data/docs/AdjustInternalCertificateRequest.md +28 -13
  15. data/docs/AdjustInternalCertificateResponse.md +28 -13
  16. data/docs/AffiliateApi.md +173 -126
  17. data/docs/AffiliateClick.md +38 -20
  18. data/docs/AffiliateClickQuery.md +28 -13
  19. data/docs/AffiliateClicksResponse.md +26 -12
  20. data/docs/AffiliateLedger.md +54 -26
  21. data/docs/AffiliateLedgerQuery.md +28 -13
  22. data/docs/AffiliateLedgersResponse.md +26 -12
  23. data/docs/AffiliateLink.md +44 -21
  24. data/docs/ApiUserApplicationProfile.md +26 -12
  25. data/docs/ApplyLibraryItemRequest.md +24 -11
  26. data/docs/ApplyLibraryItemResponse.md +38 -18
  27. data/docs/AutoOrder.md +60 -34
  28. data/docs/AutoOrderApi.md +693 -675
  29. data/docs/AutoOrderItem.md +64 -35
  30. data/docs/AutoOrderItemFutureSchedule.md +24 -11
  31. data/docs/AutoOrderItemOption.md +20 -9
  32. data/docs/AutoOrderItemSimpleSchedule.md +22 -10
  33. data/docs/AutoOrderLog.md +20 -9
  34. data/docs/AutoOrderQuery.md +58 -28
  35. data/docs/AutoOrderQueryBatch.md +18 -8
  36. data/docs/AutoOrderResponse.md +26 -12
  37. data/docs/AutoOrdersRequest.md +18 -8
  38. data/docs/AutoOrdersResponse.md +26 -12
  39. data/docs/AvalaraConfig.md +42 -20
  40. data/docs/BaseResponse.md +24 -11
  41. data/docs/Browser.md +22 -10
  42. data/docs/BrowserDevice.md +18 -8
  43. data/docs/BrowserOS.md +26 -12
  44. data/docs/BrowserUserAgent.md +24 -11
  45. data/docs/Cart.md +68 -33
  46. data/docs/CartAffiliate.md +20 -9
  47. data/docs/CartAffirmCheckoutResponse.md +20 -9
  48. data/docs/CartBilling.md +46 -24
  49. data/docs/CartBuysafe.md +28 -13
  50. data/docs/CartCheckout.md +44 -25
  51. data/docs/CartCoupon.md +18 -8
  52. data/docs/CartCurrencyConversion.md +20 -9
  53. data/docs/CartCustomerProfile.md +60 -30
  54. data/docs/CartCustomerProfileAddress.md +44 -21
  55. data/docs/CartCustomerProfileCreditCard.md +28 -13
  56. data/docs/CartFinalizeOrderRequest.md +20 -9
  57. data/docs/CartFinalizeOrderRequestOptions.md +42 -20
  58. data/docs/CartFinalizeOrderResponse.md +26 -12
  59. data/docs/CartGift.md +28 -13
  60. data/docs/CartGiftCertificate.md +22 -10
  61. data/docs/CartItem.md +74 -37
  62. data/docs/CartItemAttribute.md +22 -10
  63. data/docs/CartItemMultimedia.md +34 -16
  64. data/docs/CartItemMultimediaThumbnail.md +26 -12
  65. data/docs/CartItemOption.md +40 -19
  66. data/docs/CartItemOptionValue.md +26 -12
  67. data/docs/CartItemPhysical.md +24 -11
  68. data/docs/CartItemVariationSelection.md +20 -9
  69. data/docs/CartKitComponentOption.md +44 -21
  70. data/docs/CartMarketing.md +20 -10
  71. data/docs/CartPayment.md +30 -15
  72. data/docs/CartPaymentAffirm.md +18 -8
  73. data/docs/CartPaymentAmazon.md +18 -8
  74. data/docs/CartPaymentCheck.md +18 -8
  75. data/docs/CartPaymentCreditCard.md +34 -16
  76. data/docs/CartPaymentPurchaseOrder.md +18 -8
  77. data/docs/CartProfileLoginRequest.md +22 -10
  78. data/docs/CartProfileLoginResponse.md +20 -9
  79. data/docs/CartProfileRegisterRequest.md +20 -9
  80. data/docs/CartProfileRegisterResponse.md +20 -9
  81. data/docs/CartProperty.md +24 -11
  82. data/docs/CartResponse.md +20 -9
  83. data/docs/CartSettings.md +28 -13
  84. data/docs/CartSettingsBilling.md +18 -8
  85. data/docs/CartSettingsGift.md +24 -11
  86. data/docs/CartSettingsGiftWrap.md +22 -10
  87. data/docs/CartSettingsPayment.md +42 -20
  88. data/docs/CartSettingsPaymentAmazon.md +22 -10
  89. data/docs/CartSettingsPaymentCreditCard.md +22 -11
  90. data/docs/CartSettingsPaymentPayPal.md +26 -12
  91. data/docs/CartSettingsProvince.md +20 -9
  92. data/docs/CartSettingsShipping.md +26 -12
  93. data/docs/CartSettingsShippingCalendar.md +26 -12
  94. data/docs/CartSettingsShippingEstimate.md +44 -21
  95. data/docs/CartSettingsTaxes.md +18 -8
  96. data/docs/CartSettingsTerms.md +20 -9
  97. data/docs/CartShipping.md +54 -26
  98. data/docs/CartSummary.md +48 -27
  99. data/docs/CartTaxes.md +22 -10
  100. data/docs/CartUpsellAfter.md +22 -10
  101. data/docs/CartValidationRequest.md +20 -9
  102. data/docs/CartValidationResponse.md +20 -9
  103. data/docs/ChannelPartnerApi.md +382 -811
  104. data/docs/ChannelPartnerCancelResponse.md +26 -12
  105. data/docs/ChannelPartnerEstimateShippingResponse.md +26 -12
  106. data/docs/ChannelPartnerEstimateTaxResponse.md +26 -12
  107. data/docs/ChannelPartnerImportResponse.md +30 -14
  108. data/docs/ChannelPartnerOrder.md +176 -100
  109. data/docs/ChannelPartnerOrderItem.md +30 -15
  110. data/docs/ChannelPartnerOrderItemOption.md +20 -9
  111. data/docs/ChannelPartnerOrderTransaction.md +20 -9
  112. data/docs/ChannelPartnerOrderTransactionDetail.md +20 -9
  113. data/docs/ChannelPartnerShippingEstimate.md +20 -9
  114. data/docs/ChargebackApi.md +420 -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 -74
  129. data/docs/CouponAmountOffItems.md +24 -12
  130. data/docs/CouponAmountOffShipping.md +22 -10
  131. data/docs/CouponAmountOffShippingWithItemsPurchase.md +24 -11
  132. data/docs/CouponAmountOffSubtotal.md +20 -9
  133. data/docs/CouponAmountOffSubtotalAndShipping.md +20 -9
  134. data/docs/CouponAmountOffSubtotalFreeShippingWithPurchase.md +24 -11
  135. data/docs/CouponAmountOffSubtotalWithBlockPurchase.md +24 -11
  136. data/docs/CouponAmountOffSubtotalWithItemsPurchase.md +24 -11
  137. data/docs/CouponAmountOffSubtotalWithPurchase.md +22 -10
  138. data/docs/CouponAmountShippingWithSubtotal.md +24 -11
  139. data/docs/CouponApi.md +1500 -1043
  140. data/docs/CouponAutoApplyCondition.md +22 -10
  141. data/docs/CouponAutoApplyConditions.md +28 -13
  142. data/docs/CouponAutomaticallyApplyCouponCodes.md +18 -8
  143. data/docs/CouponBuyOneGetOneLimit.md +20 -10
  144. data/docs/CouponCodesRequest.md +30 -14
  145. data/docs/CouponCodesResponse.md +28 -13
  146. data/docs/CouponDeletesRequest.md +20 -9
  147. data/docs/CouponDiscountItemWithItemPurchase.md +26 -14
  148. data/docs/CouponDiscountItems.md +24 -11
  149. data/docs/CouponEditorValues.md +36 -18
  150. data/docs/CouponExistsResponse.md +28 -13
  151. data/docs/CouponFreeItemAndShippingWithSubtotal.md +26 -12
  152. data/docs/CouponFreeItemWithItemPurchase.md +24 -13
  153. data/docs/CouponFreeItemWithSubtotal.md +24 -11
  154. data/docs/CouponFreeItemsWithItemPurchase.md +26 -12
  155. data/docs/CouponFreeItemsWithMixMatchPurchase.md +26 -12
  156. data/docs/CouponFreeShipping.md +18 -8
  157. data/docs/CouponFreeShippingSpecificItems.md +18 -8
  158. data/docs/CouponFreeShippingWithItemsPurchase.md +20 -9
  159. data/docs/CouponFreeShippingWithSubtotal.md +22 -10
  160. data/docs/CouponItemSearchResult.md +32 -15
  161. data/docs/CouponItemSearchResultsResponse.md +26 -12
  162. data/docs/CouponMultipleAmountsOffItems.md +20 -9
  163. data/docs/CouponPercentOffItemWithItemsQuantityPurchase.md +26 -14
  164. data/docs/CouponPercentOffItems.md +24 -13
  165. data/docs/CouponPercentOffItemsAndFreeShipping.md +22 -12
  166. data/docs/CouponPercentOffItemsWithItemsPurchase.md +24 -13
  167. data/docs/CouponPercentOffMsrpItems.md +24 -13
  168. data/docs/CouponPercentOffRetailPriceItems.md +24 -11
  169. data/docs/CouponPercentOffShipping.md +20 -9
  170. data/docs/CouponPercentOffSubtotal.md +18 -8
  171. data/docs/CouponPercentOffSubtotalAndFreeShipping.md +20 -9
  172. data/docs/CouponPercentOffSubtotalLimit.md +22 -10
  173. data/docs/CouponPercentOffSubtotalWithItemsPurchase.md +20 -9
  174. data/docs/CouponPercentOffSubtotalWithSubtotal.md +22 -10
  175. data/docs/CouponQuery.md +36 -17
  176. data/docs/CouponResponse.md +28 -13
  177. data/docs/CouponRestriction.md +24 -11
  178. data/docs/CouponTierAmount.md +22 -10
  179. data/docs/CouponTierItemDiscount.md +20 -9
  180. data/docs/CouponTierPercent.md +22 -10
  181. data/docs/CouponTierQuantityAmount.md +22 -10
  182. data/docs/CouponTierQuantityPercent.md +22 -10
  183. data/docs/CouponTieredAmountOffItems.md +22 -11
  184. data/docs/CouponTieredAmountOffSubtotal.md +20 -9
  185. data/docs/CouponTieredPercentOffItems.md +22 -11
  186. data/docs/CouponTieredPercentOffShipping.md +22 -10
  187. data/docs/CouponTieredPercentOffSubtotal.md +20 -9
  188. data/docs/CouponType.md +20 -9
  189. data/docs/CouponsRequest.md +18 -8
  190. data/docs/CouponsResponse.md +26 -12
  191. data/docs/Currency.md +26 -12
  192. data/docs/Customer.md +134 -71
  193. data/docs/CustomerActivity.md +24 -15
  194. data/docs/CustomerAffiliate.md +24 -11
  195. data/docs/CustomerApi.md +1380 -1347
  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 -37
  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 -41
  236. data/docs/EmailCommseqEmailResponse.md +26 -12
  237. data/docs/EmailCommseqEmailSendTestRequest.md +36 -17
  238. data/docs/EmailCommseqEmailSendTestResponse.md +24 -11
  239. data/docs/EmailCommseqEmailsRequest.md +26 -12
  240. data/docs/EmailCommseqEmailsResponse.md +26 -12
  241. data/docs/EmailCommseqPostcard.md +42 -20
  242. data/docs/EmailCommseqPostcardResponse.md +26 -12
  243. data/docs/EmailCommseqPostcardSendTestRequest.md +42 -20
  244. data/docs/EmailCommseqPostcardSendTestResponse.md +30 -14
  245. data/docs/EmailCommseqPostcardsRequest.md +18 -8
  246. data/docs/EmailCommseqPostcardsResponse.md +26 -12
  247. data/docs/EmailCommseqResponse.md +26 -12
  248. data/docs/EmailCommseqStat.md +90 -44
  249. data/docs/EmailCommseqStatResponse.md +26 -12
  250. data/docs/EmailCommseqStep.md +36 -17
  251. data/docs/EmailCommseqStepLog.md +22 -10
  252. data/docs/EmailCommseqStepLogsResponse.md +26 -12
  253. data/docs/EmailCommseqWebhookSendTestRequest.md +30 -14
  254. data/docs/EmailCommseqWebhookSendTestResponse.md +30 -14
  255. data/docs/EmailCommseqsResponse.md +26 -12
  256. data/docs/EmailCustomer.md +32 -15
  257. data/docs/EmailCustomerEditorUrlResponse.md +26 -12
  258. data/docs/EmailCustomersResponse.md +26 -12
  259. data/docs/EmailDashboardActivity.md +30 -14
  260. data/docs/EmailDashboardActivityResponse.md +26 -12
  261. data/docs/EmailDashboardStatsResponse.md +26 -12
  262. data/docs/EmailDomain.md +42 -20
  263. data/docs/EmailEditorTokenResponse.md +26 -12
  264. data/docs/EmailFlow.md +72 -38
  265. data/docs/EmailFlowBackPopulateRequest.md +20 -9
  266. data/docs/EmailFlowBackPopulateResponse.md +24 -11
  267. data/docs/EmailFlowFolder.md +26 -12
  268. data/docs/EmailFlowFolderResponse.md +26 -12
  269. data/docs/EmailFlowFoldersResponse.md +26 -12
  270. data/docs/EmailFlowResponse.md +26 -12
  271. data/docs/EmailFlowsResponse.md +26 -12
  272. data/docs/EmailGlobalSettings.md +18 -8
  273. data/docs/EmailGlobalSettingsResponse.md +26 -12
  274. data/docs/EmailGlobalUnsubscribeRequest.md +18 -8
  275. data/docs/EmailGlobalUnsubscribeResponse.md +18 -8
  276. data/docs/EmailHistogramPropertyNamesResponse.md +18 -8
  277. data/docs/EmailHistogramPropertyValuesResponse.md +18 -8
  278. data/docs/EmailList.md +40 -19
  279. data/docs/EmailListArchiveResponse.md +26 -12
  280. data/docs/EmailListCustomer.md +24 -11
  281. data/docs/EmailListCustomersResponse.md +26 -12
  282. data/docs/EmailListResponse.md +26 -12
  283. data/docs/EmailListSegmentFolder.md +26 -12
  284. data/docs/EmailListSegmentFolderResponse.md +26 -12
  285. data/docs/EmailListSegmentFoldersResponse.md +26 -12
  286. data/docs/EmailListSegmentMembership.md +24 -11
  287. data/docs/EmailListSegmentUsedBy.md +22 -10
  288. data/docs/EmailListSubscribeResponse.md +20 -9
  289. data/docs/EmailListsResponse.md +26 -12
  290. data/docs/EmailOrder.md +24 -11
  291. data/docs/EmailOrdersResponse.md +26 -12
  292. data/docs/EmailPerformance.md +62 -30
  293. data/docs/EmailPerformanceCustomerHistogram.md +18 -8
  294. data/docs/EmailPerformanceCustomerHistogramPeriod.md +26 -12
  295. data/docs/EmailPerformanceDaily.md +30 -14
  296. data/docs/EmailPerformanceResponse.md +26 -12
  297. data/docs/EmailPlan.md +50 -24
  298. data/docs/EmailPlanAdditional.md +34 -16
  299. data/docs/EmailPlanResponse.md +26 -12
  300. data/docs/EmailPostcardStat.md +80 -39
  301. data/docs/EmailSegment.md +58 -29
  302. data/docs/EmailSegmentArchiveResponse.md +26 -12
  303. data/docs/EmailSegmentCustomer.md +24 -11
  304. data/docs/EmailSegmentCustomersResponse.md +26 -12
  305. data/docs/EmailSegmentDownloadPrepareResponse.md +32 -15
  306. data/docs/EmailSegmentResponse.md +26 -12
  307. data/docs/EmailSegmentsResponse.md +26 -12
  308. data/docs/EmailSendingDomainResponse.md +26 -12
  309. data/docs/EmailSendingDomainsResponse.md +26 -12
  310. data/docs/EmailSettings.md +40 -26
  311. data/docs/EmailSettingsResponse.md +26 -12
  312. data/docs/EmailStat.md +92 -45
  313. data/docs/EmailStatPostcardSummaryRequest.md +20 -9
  314. data/docs/EmailStatPostcardSummaryResponse.md +26 -12
  315. data/docs/EmailStatSummaryRequest.md +22 -10
  316. data/docs/EmailStatSummaryResponse.md +26 -12
  317. data/docs/EmailStepStat.md +56 -37
  318. data/docs/EmailStepStatRequest.md +20 -9
  319. data/docs/EmailStepStatResponse.md +26 -12
  320. data/docs/EmailStepWaitingRequest.md +18 -8
  321. data/docs/EmailStepWaitingResponse.md +18 -8
  322. data/docs/EmailTemplate.md +38 -18
  323. data/docs/EmailTemplatesResponse.md +26 -12
  324. data/docs/EmailThirdPartyList.md +20 -9
  325. data/docs/EmailThirdPartyListImportRequest.md +18 -8
  326. data/docs/EmailThirdPartyProvider.md +38 -18
  327. data/docs/EmailThirdPartyProvidersResponse.md +26 -12
  328. data/docs/EmailThirdPartyTag.md +20 -9
  329. data/docs/EmailVerifyTokenRequest.md +20 -9
  330. data/docs/EmailVerifyTokenResponse.md +26 -12
  331. data/docs/EmailVerifyTokenValidateRequest.md +18 -8
  332. data/docs/EmailVerifyTokenValidateResponse.md +24 -11
  333. data/docs/EmailWebhookEditorValuesResponse.md +30 -14
  334. data/docs/Error.md +26 -12
  335. data/docs/ErrorResponse.md +24 -11
  336. data/docs/Experiment.md +52 -31
  337. data/docs/ExperimentResponse.md +26 -12
  338. data/docs/ExperimentVariation.md +60 -30
  339. data/docs/ExperimentVariationStat.md +38 -20
  340. data/docs/ExperimentsResponse.md +26 -12
  341. data/docs/FulfillmentApi.md +459 -318
  342. data/docs/FulfillmentInventory.md +20 -9
  343. data/docs/FulfillmentShipment.md +26 -12
  344. data/docs/GeoPoint.md +20 -9
  345. data/docs/GeocodeRequest.md +26 -12
  346. data/docs/GeocodeResponse.md +28 -13
  347. data/docs/GiftCertificate.md +44 -21
  348. data/docs/GiftCertificateApi.md +622 -433
  349. data/docs/GiftCertificateCreateRequest.md +26 -12
  350. data/docs/GiftCertificateLedgerEntry.md +28 -13
  351. data/docs/GiftCertificateQuery.md +34 -16
  352. data/docs/GiftCertificateResponse.md +26 -12
  353. data/docs/GiftCertificatesResponse.md +26 -12
  354. data/docs/Group.md +26 -12
  355. data/docs/GroupResponse.md +26 -12
  356. data/docs/GroupUserMembership.md +26 -12
  357. data/docs/GroupsResponse.md +26 -12
  358. data/docs/HTTPHeader.md +20 -9
  359. data/docs/IntegrationLog.md +52 -26
  360. data/docs/IntegrationLogApi.md +400 -286
  361. data/docs/IntegrationLogFile.md +24 -11
  362. data/docs/IntegrationLogLog.md +20 -9
  363. data/docs/IntegrationLogQueryFilterValues.md +40 -19
  364. data/docs/IntegrationLogQueryRequest.md +42 -23
  365. data/docs/IntegrationLogQueryResponse.md +28 -13
  366. data/docs/IntegrationLogResponse.md +26 -12
  367. data/docs/IntegrationLogSummary.md +34 -16
  368. data/docs/IntegrationLogSummaryQueryRequest.md +20 -9
  369. data/docs/IntegrationLogSummaryQueryResponse.md +26 -12
  370. data/docs/Item.md +118 -58
  371. data/docs/ItemAccounting.md +20 -9
  372. data/docs/ItemAmember.md +20 -9
  373. data/docs/ItemApi.md +733 -1266
  374. data/docs/ItemAutoOrder.md +50 -29
  375. data/docs/ItemAutoOrderStep.md +46 -24
  376. data/docs/ItemAutoOrderStepArbitraryUnitCostSchedule.md +20 -9
  377. data/docs/ItemAutoOrderStepGrandfatherPricing.md +20 -9
  378. data/docs/ItemCCBill.md +28 -13
  379. data/docs/ItemChannelPartnerMapping.md +54 -26
  380. data/docs/ItemChargeback.md +20 -9
  381. data/docs/ItemChargebackAddendum.md +24 -11
  382. data/docs/ItemChargebackAdjustmentRequest.md +22 -10
  383. data/docs/ItemCheckout.md +24 -11
  384. data/docs/ItemContent.md +42 -23
  385. data/docs/ItemContentAssignment.md +28 -13
  386. data/docs/ItemContentAttribute.md +24 -11
  387. data/docs/ItemContentMultimedia.md +46 -22
  388. data/docs/ItemContentMultimediaThumbnail.md +28 -13
  389. data/docs/ItemDigitalDelivery.md +28 -13
  390. data/docs/ItemDigitalItem.md +26 -17
  391. data/docs/ItemEbay.md +154 -76
  392. data/docs/ItemEbayCategorySpecific.md +20 -9
  393. data/docs/ItemEbayMarketListing.md +26 -12
  394. data/docs/ItemEbayMarketPlaceAnalysis.md +36 -17
  395. data/docs/ItemEmailNotifications.md +20 -9
  396. data/docs/ItemEnrollment123.md +18 -8
  397. data/docs/ItemFulfillmentAddon.md +24 -12
  398. data/docs/ItemGiftCertificate.md +20 -9
  399. data/docs/ItemGoogleProductSearch.md +112 -55
  400. data/docs/ItemIdentifiers.md +24 -15
  401. data/docs/ItemInstantPaymentNotification.md +22 -10
  402. data/docs/ItemInstantPaymentNotifications.md +18 -8
  403. data/docs/ItemInternal.md +18 -8
  404. data/docs/ItemKitComponent.md +26 -12
  405. data/docs/ItemKitDefinition.md +18 -8
  406. data/docs/ItemOption.md +44 -21
  407. data/docs/ItemOptionValue.md +46 -22
  408. data/docs/ItemOptionValueAdditionalItem.md +20 -9
  409. data/docs/ItemOptionValueDigitalItem.md +20 -9
  410. data/docs/ItemPaymentProcessing.md +26 -13
  411. data/docs/ItemPhysical.md +24 -11
  412. data/docs/ItemPricing.md +52 -25
  413. data/docs/ItemPricingTier.md +26 -12
  414. data/docs/ItemPricingTierDiscount.md +20 -9
  415. data/docs/ItemPricingTierLimit.md +22 -12
  416. data/docs/ItemProperty.md +22 -10
  417. data/docs/ItemRealtimePricing.md +22 -10
  418. data/docs/ItemRelated.md +22 -10
  419. data/docs/ItemRelatedItem.md +22 -10
  420. data/docs/ItemReporting.md +20 -9
  421. data/docs/ItemResponse.md +26 -12
  422. data/docs/ItemRestriction.md +32 -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 -56
  428. data/docs/ItemShippingCase.md +24 -11
  429. data/docs/ItemShippingDestinationMarkup.md +28 -14
  430. data/docs/ItemShippingDestinationRestriction.md +22 -10
  431. data/docs/ItemShippingDistributionCenter.md +44 -21
  432. data/docs/ItemShippingMethod.md +46 -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 -46
  470. data/docs/OrderAffiliate.md +22 -10
  471. data/docs/OrderAffiliateLedger.md +34 -16
  472. data/docs/OrderApi.md +1856 -1593
  473. data/docs/OrderAutoOrder.md +56 -27
  474. data/docs/OrderBilling.md +48 -25
  475. data/docs/OrderBuysafe.md +28 -13
  476. data/docs/OrderByTokenQuery.md +18 -8
  477. data/docs/OrderChannelPartner.md +38 -18
  478. data/docs/OrderCheckout.md +44 -24
  479. data/docs/OrderCoupon.md +26 -12
  480. data/docs/OrderDigitalItem.md +32 -15
  481. data/docs/OrderDigitalOrder.md +26 -12
  482. data/docs/OrderEdi.md +24 -11
  483. data/docs/OrderFormat.md +48 -23
  484. data/docs/OrderFormatResponse.md +20 -9
  485. data/docs/OrderFraudScore.md +56 -27
  486. data/docs/OrderGift.md +36 -17
  487. data/docs/OrderGiftCertificate.md +22 -10
  488. data/docs/OrderInternal.md +26 -13
  489. data/docs/OrderItem.md +128 -73
  490. data/docs/OrderItemEdi.md +20 -9
  491. data/docs/OrderItemEdiIdentification.md +20 -9
  492. data/docs/OrderItemEdiLot.md +22 -10
  493. data/docs/OrderItemOption.md +38 -18
  494. data/docs/OrderItemOptionFileAttachment.md +24 -11
  495. data/docs/OrderItemProperty.md +24 -11
  496. data/docs/OrderItemTag.md +18 -8
  497. data/docs/OrderLinkedShipment.md +26 -12
  498. data/docs/OrderMarketing.md +22 -11
  499. data/docs/OrderPackingSlipResponse.md +26 -12
  500. data/docs/OrderPayment.md +52 -27
  501. data/docs/OrderPaymentCheck.md +18 -8
  502. data/docs/OrderPaymentCreditCard.md +38 -19
  503. data/docs/OrderPaymentECheck.md +36 -17
  504. data/docs/OrderPaymentInsurance.md +24 -11
  505. data/docs/OrderPaymentPurchaseOrder.md +18 -8
  506. data/docs/OrderPaymentTransaction.md +24 -12
  507. data/docs/OrderPaymentTransactionDetail.md +22 -10
  508. data/docs/OrderProcessPaymentRequest.md +20 -9
  509. data/docs/OrderProcessPaymentResponse.md +26 -12
  510. data/docs/OrderProperty.md +24 -13
  511. data/docs/OrderQuery.md +94 -50
  512. data/docs/OrderQueryBatch.md +18 -9
  513. data/docs/OrderQuote.md +22 -10
  514. data/docs/OrderReplacement.md +46 -22
  515. data/docs/OrderReplacementItem.md +22 -10
  516. data/docs/OrderReplacementResponse.md +28 -13
  517. data/docs/OrderResponse.md +26 -12
  518. data/docs/OrderSalesforce.md +18 -8
  519. data/docs/OrderShipping.md +76 -38
  520. data/docs/OrderSummary.md +56 -33
  521. data/docs/OrderTag.md +18 -8
  522. data/docs/OrderTaxes.md +50 -24
  523. data/docs/OrderTokenResponse.md +26 -12
  524. data/docs/OrderTrackingNumberDetail.md +40 -19
  525. data/docs/OrderTrackingNumberDetails.md +52 -25
  526. data/docs/OrdersResponse.md +26 -12
  527. data/docs/Permission.md +22 -10
  528. data/docs/PricingTier.md +78 -41
  529. data/docs/PricingTierNotification.md +22 -10
  530. data/docs/PricingTiersResponse.md +26 -12
  531. data/docs/Property.md +20 -9
  532. data/docs/PublishLibraryItemRequest.md +18 -8
  533. data/docs/RegisterAffiliateClickRequest.md +28 -13
  534. data/docs/RegisterAffiliateClickResponse.md +24 -11
  535. data/docs/ResponseMetadata.md +20 -9
  536. data/docs/ResultSet.md +28 -13
  537. data/docs/ScreenRecording.md +116 -57
  538. data/docs/ScreenRecordingAdPlatform.md +30 -14
  539. data/docs/ScreenRecordingFilter.md +136 -67
  540. data/docs/ScreenRecordingFilterGeoDistance.md +26 -12
  541. data/docs/ScreenRecordingFilterIpSearch.md +24 -11
  542. data/docs/ScreenRecordingFilterPageView.md +50 -24
  543. data/docs/ScreenRecordingFilterPageViewEvent.md +20 -9
  544. data/docs/ScreenRecordingFilterPageViewEventParam.md +26 -12
  545. data/docs/ScreenRecordingFilterPageViewParam.md +20 -9
  546. data/docs/ScreenRecordingFilterPageViewReferrerParam.md +20 -9
  547. data/docs/ScreenRecordingFilterRangeBigDecimal.md +26 -12
  548. data/docs/ScreenRecordingFilterRangeDate.md +20 -9
  549. data/docs/ScreenRecordingFilterRangeInteger.md +26 -12
  550. data/docs/ScreenRecordingFilterStringSearch.md +26 -12
  551. data/docs/ScreenRecordingFilterValues.md +58 -28
  552. data/docs/ScreenRecordingFilterValuesEvent.md +20 -9
  553. data/docs/ScreenRecordingFilterValuesEventParams.md +26 -12
  554. data/docs/ScreenRecordingFilterValuesPageParam.md +20 -9
  555. data/docs/ScreenRecordingFilterValuesPageView.md +28 -13
  556. data/docs/ScreenRecordingHeatmap.md +64 -31
  557. data/docs/ScreenRecordingHeatmapIndexRequest.md +18 -8
  558. data/docs/ScreenRecordingHeatmapIndexResponse.md +26 -12
  559. data/docs/ScreenRecordingHeatmapRequest.md +22 -10
  560. data/docs/ScreenRecordingHeatmapReset.md +18 -8
  561. data/docs/ScreenRecordingHeatmapResponse.md +26 -12
  562. data/docs/ScreenRecordingHeatmapUrl.md +28 -13
  563. data/docs/ScreenRecordingMerchantNotesRequest.md +18 -8
  564. data/docs/ScreenRecordingMultifield.md +26 -12
  565. data/docs/ScreenRecordingPageView.md +54 -26
  566. data/docs/ScreenRecordingPageViewDataResponse.md +26 -12
  567. data/docs/ScreenRecordingPageViewEvent.md +28 -13
  568. data/docs/ScreenRecordingPageViewEventParameter.md +20 -9
  569. data/docs/ScreenRecordingPageViewParameter.md +20 -9
  570. data/docs/ScreenRecordingQueryRequest.md +18 -8
  571. data/docs/ScreenRecordingQueryResponse.md +38 -18
  572. data/docs/ScreenRecordingResponse.md +28 -13
  573. data/docs/ScreenRecordingSegment.md +36 -17
  574. data/docs/ScreenRecordingSegmentResponse.md +26 -12
  575. data/docs/ScreenRecordingSegmentsResponse.md +26 -12
  576. data/docs/ScreenRecordingSettings.md +32 -15
  577. data/docs/ScreenRecordingSettingsResponse.md +26 -12
  578. data/docs/ScreenRecordingStoreFront.md +20 -9
  579. data/docs/ScreenRecordingTagsRequest.md +18 -8
  580. data/docs/ScreenRecordingTagsResponse.md +26 -12
  581. data/docs/ScreenRecordingUserAgent.md +26 -12
  582. data/docs/ScreenRecordingUserAgentDevice.md +18 -8
  583. data/docs/ScreenRecordingUserAgentOS.md +22 -10
  584. data/docs/ScreenRecordingUserProperty.md +20 -9
  585. data/docs/ScreenshotsResponse.md +26 -12
  586. data/docs/SelfConfig.md +18 -10
  587. data/docs/SimpleValue.md +20 -9
  588. data/docs/SingleSignOnAuthorizeRequest.md +20 -9
  589. data/docs/SingleSignOnAuthorizeResponse.md +20 -9
  590. data/docs/SingleSignOnTokenRequest.md +20 -9
  591. data/docs/SingleSignOnTokenResponse.md +22 -10
  592. data/docs/SovosConfig.md +30 -14
  593. data/docs/SsoApi.md +300 -201
  594. data/docs/StateProvince.md +20 -9
  595. data/docs/StepWaiting.md +20 -9
  596. data/docs/StorefrontApi.md +13005 -9377
  597. data/docs/TaxApi.md +2101 -1421
  598. data/docs/TaxCity.md +34 -16
  599. data/docs/TaxCountry.md +34 -16
  600. data/docs/TaxCountryCode.md +26 -12
  601. data/docs/TaxCounty.md +36 -17
  602. data/docs/TaxJarConfig.md +30 -14
  603. data/docs/TaxPostalCode.md +30 -14
  604. data/docs/TaxProviderActivateResult.md +20 -9
  605. data/docs/TaxProviderAvalara.md +24 -11
  606. data/docs/TaxProviderAvalaraCompaniesResult.md +18 -8
  607. data/docs/TaxProviderAvalaraCompany.md +26 -12
  608. data/docs/TaxProviderSelf.md +26 -12
  609. data/docs/TaxProviderSelfCountriesResponse.md +18 -8
  610. data/docs/TaxProviderSelfRegionsResponse.md +18 -8
  611. data/docs/TaxProviderSovos.md +24 -11
  612. data/docs/TaxProviderTaxJar.md +24 -11
  613. data/docs/TaxProviderTestResult.md +20 -9
  614. data/docs/TaxProviderUltraCart.md +26 -12
  615. data/docs/TaxProviderUltraCartState.md +36 -17
  616. data/docs/TaxProvidersResponse.md +34 -16
  617. data/docs/TaxState.md +52 -25
  618. data/docs/TaxStateCode.md +26 -12
  619. data/docs/TempMultimedia.md +30 -14
  620. data/docs/TempMultimediaResponse.md +26 -12
  621. data/docs/ThumbnailParametersRequest.md +26 -12
  622. data/docs/ThumbnailParametersResponse.md +26 -12
  623. data/docs/TransactionEmail.md +56 -27
  624. data/docs/TransactionEmailListResponse.md +26 -12
  625. data/docs/TransactionEmailOption.md +32 -15
  626. data/docs/TransactionEmailResponse.md +26 -12
  627. data/docs/Twilio.md +24 -16
  628. data/docs/TwilioResponse.md +28 -13
  629. data/docs/TwiliosResponse.md +26 -12
  630. data/docs/UltraCartConfig.md +18 -10
  631. data/docs/UploadCouponCodesRequest.md +26 -12
  632. data/docs/UploadCouponCodesResponse.md +30 -14
  633. data/docs/User.md +44 -21
  634. data/docs/UserApi.md +823 -558
  635. data/docs/UserGroupMembership.md +22 -10
  636. data/docs/UserLogin.md +24 -11
  637. data/docs/UserLoginsResponse.md +26 -12
  638. data/docs/UserResponse.md +26 -12
  639. data/docs/UsersResponse.md +26 -12
  640. data/docs/VerificationRecord.md +22 -10
  641. data/docs/Warning.md +20 -9
  642. data/docs/Webhook.md +52 -26
  643. data/docs/WebhookApi.md +636 -463
  644. data/docs/WebhookEventCategory.md +26 -12
  645. data/docs/WebhookEventSubscription.md +34 -17
  646. data/docs/WebhookLog.md +38 -19
  647. data/docs/WebhookLogResponse.md +26 -12
  648. data/docs/WebhookLogSummariesResponse.md +26 -12
  649. data/docs/WebhookLogSummary.md +22 -10
  650. data/docs/WebhookResponse.md +26 -12
  651. data/docs/WebhookSampleRequest.md +24 -0
  652. data/docs/WebhookSampleRequestResponse.md +26 -0
  653. data/docs/WebhooksResponse.md +26 -12
  654. data/docs/Weight.md +20 -9
  655. data/git_push.sh +57 -55
  656. data/lib/ultracart_api/api/affiliate_api.rb +191 -164
  657. data/lib/ultracart_api/api/auto_order_api.rb +672 -770
  658. data/lib/ultracart_api/api/channel_partner_api.rb +370 -920
  659. data/lib/ultracart_api/api/chargeback_api.rb +410 -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 -1523
  663. data/lib/ultracart_api/api/fulfillment_api.rb +452 -381
  664. data/lib/ultracart_api/api/gift_certificate_api.rb +594 -502
  665. data/lib/ultracart_api/api/integration_log_api.rb +404 -350
  666. data/lib/ultracart_api/api/item_api.rb +686 -1412
  667. data/lib/ultracart_api/api/oauth_api.rb +198 -171
  668. data/lib/ultracart_api/api/order_api.rb +1728 -1785
  669. data/lib/ultracart_api/api/sso_api.rb +289 -243
  670. data/lib/ultracart_api/api/storefront_api.rb +11407 -10583
  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 -538
  674. data/lib/ultracart_api/api_client.rb +399 -400
  675. data/lib/ultracart_api/api_error.rb +57 -38
  676. data/lib/ultracart_api/configuration.rb +302 -229
  677. data/lib/ultracart_api/models/accounts_receivable_retry_config.rb +364 -341
  678. data/lib/ultracart_api/models/accounts_receivable_retry_config_response.rb +287 -252
  679. data/lib/ultracart_api/models/accounts_receivable_retry_day_activity.rb +240 -205
  680. data/lib/ultracart_api/models/accounts_receivable_retry_stat_account.rb +250 -215
  681. data/lib/ultracart_api/models/accounts_receivable_retry_stat_metrics.rb +309 -274
  682. data/lib/ultracart_api/models/accounts_receivable_retry_stat_revenue.rb +228 -193
  683. data/lib/ultracart_api/models/accounts_receivable_retry_stats_response.rb +267 -232
  684. data/lib/ultracart_api/models/activity.rb +264 -247
  685. data/lib/ultracart_api/models/add_library_item_request.rb +324 -289
  686. data/lib/ultracart_api/models/adjust_internal_certificate_request.rb +270 -235
  687. data/lib/ultracart_api/models/adjust_internal_certificate_response.rb +267 -232
  688. data/lib/ultracart_api/models/affiliate_click.rb +319 -304
  689. data/lib/ultracart_api/models/affiliate_click_query.rb +270 -235
  690. data/lib/ultracart_api/models/affiliate_clicks_response.rb +259 -224
  691. data/lib/ultracart_api/models/affiliate_ledger.rb +431 -396
  692. data/lib/ultracart_api/models/affiliate_ledger_query.rb +270 -235
  693. data/lib/ultracart_api/models/affiliate_ledgers_response.rb +259 -224
  694. data/lib/ultracart_api/models/affiliate_link.rb +408 -373
  695. data/lib/ultracart_api/models/api_user_application_profile.rb +260 -225
  696. data/lib/ultracart_api/models/apply_library_item_request.rb +250 -215
  697. data/lib/ultracart_api/models/apply_library_item_response.rb +319 -284
  698. data/lib/ultracart_api/models/auto_order.rb +469 -485
  699. data/lib/ultracart_api/models/auto_order_item.rb +487 -492
  700. data/lib/ultracart_api/models/auto_order_item_future_schedule.rb +250 -215
  701. data/lib/ultracart_api/models/auto_order_item_option.rb +260 -225
  702. data/lib/ultracart_api/models/auto_order_item_simple_schedule.rb +274 -239
  703. data/lib/ultracart_api/models/auto_order_log.rb +230 -195
  704. data/lib/ultracart_api/models/auto_order_query.rb +480 -445
  705. data/lib/ultracart_api/models/auto_order_query_batch.rb +222 -187
  706. data/lib/ultracart_api/models/auto_order_response.rb +256 -221
  707. data/lib/ultracart_api/models/auto_orders_request.rb +222 -187
  708. data/lib/ultracart_api/models/auto_orders_response.rb +258 -223
  709. data/lib/ultracart_api/models/avalara_config.rb +340 -305
  710. data/lib/ultracart_api/models/base_response.rb +247 -212
  711. data/lib/ultracart_api/models/browser.rb +237 -202
  712. data/lib/ultracart_api/models/browser_device.rb +219 -184
  713. data/lib/ultracart_api/models/browser_os.rb +255 -220
  714. data/lib/ultracart_api/models/browser_user_agent.rb +246 -211
  715. data/lib/ultracart_api/models/cart.rb +506 -471
  716. data/lib/ultracart_api/models/cart_affiliate.rb +245 -210
  717. data/lib/ultracart_api/models/cart_affirm_checkout_response.rb +232 -197
  718. data/lib/ultracart_api/models/cart_billing.rb +572 -587
  719. data/lib/ultracart_api/models/cart_buysafe.rb +269 -234
  720. data/lib/ultracart_api/models/cart_checkout.rb +500 -550
  721. data/lib/ultracart_api/models/cart_coupon.rb +220 -185
  722. data/lib/ultracart_api/models/cart_currency_conversion.rb +232 -197
  723. data/lib/ultracart_api/models/cart_customer_profile.rb +438 -413
  724. data/lib/ultracart_api/models/cart_customer_profile_address.rb +350 -315
  725. data/lib/ultracart_api/models/cart_customer_profile_credit_card.rb +304 -269
  726. data/lib/ultracart_api/models/cart_finalize_order_request.rb +228 -193
  727. data/lib/ultracart_api/models/cart_finalize_order_request_options.rb +355 -320
  728. data/lib/ultracart_api/models/cart_finalize_order_response.rb +260 -225
  729. data/lib/ultracart_api/models/cart_gift.rb +313 -278
  730. data/lib/ultracart_api/models/cart_gift_certificate.rb +238 -203
  731. data/lib/ultracart_api/models/cart_item.rb +504 -481
  732. data/lib/ultracart_api/models/cart_item_attribute.rb +240 -205
  733. data/lib/ultracart_api/models/cart_item_multimedia.rb +336 -301
  734. data/lib/ultracart_api/models/cart_item_multimedia_thumbnail.rb +260 -225
  735. data/lib/ultracart_api/models/cart_item_option.rb +378 -343
  736. data/lib/ultracart_api/models/cart_item_option_value.rb +258 -223
  737. data/lib/ultracart_api/models/cart_item_physical.rb +246 -211
  738. data/lib/ultracart_api/models/cart_item_variation_selection.rb +230 -195
  739. data/lib/ultracart_api/models/cart_kit_component_option.rb +398 -363
  740. data/lib/ultracart_api/models/cart_marketing.rb +230 -205
  741. data/lib/ultracart_api/models/cart_payment.rb +275 -249
  742. data/lib/ultracart_api/models/cart_payment_affirm.rb +220 -185
  743. data/lib/ultracart_api/models/cart_payment_amazon.rb +220 -185
  744. data/lib/ultracart_api/models/cart_payment_check.rb +220 -185
  745. data/lib/ultracart_api/models/cart_payment_credit_card.rb +300 -265
  746. data/lib/ultracart_api/models/cart_payment_purchase_order.rb +220 -185
  747. data/lib/ultracart_api/models/cart_profile_login_request.rb +239 -204
  748. data/lib/ultracart_api/models/cart_profile_login_response.rb +231 -196
  749. data/lib/ultracart_api/models/cart_profile_register_request.rb +229 -194
  750. data/lib/ultracart_api/models/cart_profile_register_response.rb +231 -196
  751. data/lib/ultracart_api/models/cart_property.rb +280 -245
  752. data/lib/ultracart_api/models/cart_response.rb +231 -196
  753. data/lib/ultracart_api/models/cart_settings.rb +264 -229
  754. data/lib/ultracart_api/models/cart_settings_billing.rb +222 -187
  755. data/lib/ultracart_api/models/cart_settings_gift.rb +251 -216
  756. data/lib/ultracart_api/models/cart_settings_gift_wrap.rb +239 -204
  757. data/lib/ultracart_api/models/cart_settings_payment.rb +337 -302
  758. data/lib/ultracart_api/models/cart_settings_payment_amazon.rb +240 -205
  759. data/lib/ultracart_api/models/cart_settings_payment_credit_card.rb +242 -217
  760. data/lib/ultracart_api/models/cart_settings_payment_pay_pal.rb +260 -225
  761. data/lib/ultracart_api/models/cart_settings_province.rb +228 -193
  762. data/lib/ultracart_api/models/cart_settings_shipping.rb +262 -227
  763. data/lib/ultracart_api/models/cart_settings_shipping_calendar.rb +264 -229
  764. data/lib/ultracart_api/models/cart_settings_shipping_estimate.rb +345 -310
  765. data/lib/ultracart_api/models/cart_settings_taxes.rb +221 -186
  766. data/lib/ultracart_api/models/cart_settings_terms.rb +230 -195
  767. data/lib/ultracart_api/models/cart_shipping.rb +625 -590
  768. data/lib/ultracart_api/models/cart_summary.rb +354 -356
  769. data/lib/ultracart_api/models/cart_taxes.rb +255 -220
  770. data/lib/ultracart_api/models/cart_upsell_after.rb +255 -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 -1723
  778. data/lib/ultracart_api/models/channel_partner_order_item.rb +331 -308
  779. data/lib/ultracart_api/models/channel_partner_order_item_option.rb +230 -195
  780. data/lib/ultracart_api/models/channel_partner_order_transaction.rb +232 -197
  781. data/lib/ultracart_api/models/channel_partner_order_transaction_detail.rb +230 -195
  782. data/lib/ultracart_api/models/channel_partner_shipping_estimate.rb +230 -195
  783. data/lib/ultracart_api/models/chargeback_dispute.rb +649 -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 -917
  796. data/lib/ultracart_api/models/coupon_amount_off_items.rb +267 -244
  797. data/lib/ultracart_api/models/coupon_amount_off_shipping.rb +257 -222
  798. data/lib/ultracart_api/models/coupon_amount_off_shipping_with_items_purchase.rb +269 -234
  799. data/lib/ultracart_api/models/coupon_amount_off_subtotal.rb +245 -210
  800. data/lib/ultracart_api/models/coupon_amount_off_subtotal_and_shipping.rb +245 -210
  801. data/lib/ultracart_api/models/coupon_amount_off_subtotal_free_shipping_with_purchase.rb +267 -232
  802. data/lib/ultracart_api/models/coupon_amount_off_subtotal_with_block_purchase.rb +265 -230
  803. data/lib/ultracart_api/models/coupon_amount_off_subtotal_with_items_purchase.rb +267 -232
  804. data/lib/ultracart_api/models/coupon_amount_off_subtotal_with_purchase.rb +255 -220
  805. data/lib/ultracart_api/models/coupon_amount_shipping_with_subtotal.rb +267 -232
  806. data/lib/ultracart_api/models/coupon_auto_apply_condition.rb +239 -204
  807. data/lib/ultracart_api/models/coupon_auto_apply_conditions.rb +269 -234
  808. data/lib/ultracart_api/models/coupon_automatically_apply_coupon_codes.rb +222 -187
  809. data/lib/ultracart_api/models/coupon_buy_one_get_one_limit.rb +232 -209
  810. data/lib/ultracart_api/models/coupon_codes_request.rb +277 -242
  811. data/lib/ultracart_api/models/coupon_codes_response.rb +269 -234
  812. data/lib/ultracart_api/models/coupon_deletes_request.rb +234 -199
  813. data/lib/ultracart_api/models/coupon_discount_item_with_item_purchase.rb +275 -264
  814. data/lib/ultracart_api/models/coupon_discount_items.rb +267 -232
  815. data/lib/ultracart_api/models/coupon_editor_values.rb +330 -307
  816. data/lib/ultracart_api/models/coupon_exists_response.rb +267 -232
  817. data/lib/ultracart_api/models/coupon_free_item_and_shipping_with_subtotal.rb +279 -244
  818. data/lib/ultracart_api/models/coupon_free_item_with_item_purchase.rb +254 -243
  819. data/lib/ultracart_api/models/coupon_free_item_with_subtotal.rb +267 -232
  820. data/lib/ultracart_api/models/coupon_free_items_with_item_purchase.rb +260 -225
  821. data/lib/ultracart_api/models/coupon_free_items_with_mix_match_purchase.rb +260 -225
  822. data/lib/ultracart_api/models/coupon_free_shipping.rb +222 -187
  823. data/lib/ultracart_api/models/coupon_free_shipping_specific_items.rb +222 -187
  824. data/lib/ultracart_api/models/coupon_free_shipping_with_items_purchase.rb +234 -199
  825. data/lib/ultracart_api/models/coupon_free_shipping_with_subtotal.rb +257 -222
  826. data/lib/ultracart_api/models/coupon_item_search_result.rb +290 -255
  827. data/lib/ultracart_api/models/coupon_item_search_results_response.rb +259 -224
  828. data/lib/ultracart_api/models/coupon_multiple_amounts_off_items.rb +232 -197
  829. data/lib/ultracart_api/models/coupon_percent_off_item_with_items_quantity_purchase.rb +264 -253
  830. data/lib/ultracart_api/models/coupon_percent_off_items.rb +254 -243
  831. data/lib/ultracart_api/models/coupon_percent_off_items_and_free_shipping.rb +244 -233
  832. data/lib/ultracart_api/models/coupon_percent_off_items_with_items_purchase.rb +254 -243
  833. data/lib/ultracart_api/models/coupon_percent_off_msrp_items.rb +254 -239
  834. data/lib/ultracart_api/models/coupon_percent_off_retail_price_items.rb +254 -219
  835. data/lib/ultracart_api/models/coupon_percent_off_shipping.rb +232 -197
  836. data/lib/ultracart_api/models/coupon_percent_off_subtotal.rb +220 -185
  837. data/lib/ultracart_api/models/coupon_percent_off_subtotal_and_free_shipping.rb +232 -197
  838. data/lib/ultracart_api/models/coupon_percent_off_subtotal_limit.rb +255 -220
  839. data/lib/ultracart_api/models/coupon_percent_off_subtotal_with_items_purchase.rb +232 -197
  840. data/lib/ultracart_api/models/coupon_percent_off_subtotal_with_subtotal.rb +255 -220
  841. data/lib/ultracart_api/models/coupon_query.rb +310 -275
  842. data/lib/ultracart_api/models/coupon_response.rb +268 -233
  843. data/lib/ultracart_api/models/coupon_restriction.rb +246 -211
  844. data/lib/ultracart_api/models/coupon_tier_amount.rb +255 -220
  845. data/lib/ultracart_api/models/coupon_tier_item_discount.rb +232 -197
  846. data/lib/ultracart_api/models/coupon_tier_percent.rb +255 -220
  847. data/lib/ultracart_api/models/coupon_tier_quantity_amount.rb +255 -220
  848. data/lib/ultracart_api/models/coupon_tier_quantity_percent.rb +255 -220
  849. data/lib/ultracart_api/models/coupon_tiered_amount_off_items.rb +244 -221
  850. data/lib/ultracart_api/models/coupon_tiered_amount_off_subtotal.rb +234 -199
  851. data/lib/ultracart_api/models/coupon_tiered_percent_off_items.rb +244 -221
  852. data/lib/ultracart_api/models/coupon_tiered_percent_off_shipping.rb +259 -224
  853. data/lib/ultracart_api/models/coupon_tiered_percent_off_subtotal.rb +234 -199
  854. data/lib/ultracart_api/models/coupon_type.rb +230 -195
  855. data/lib/ultracart_api/models/coupons_request.rb +222 -187
  856. data/lib/ultracart_api/models/coupons_response.rb +258 -223
  857. data/lib/ultracart_api/models/currency.rb +260 -225
  858. data/lib/ultracart_api/models/customer.rb +978 -994
  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 -766
  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 -507
  901. data/lib/ultracart_api/models/email_commseq_email_response.rb +256 -221
  902. data/lib/ultracart_api/models/email_commseq_email_send_test_request.rb +304 -269
  903. data/lib/ultracart_api/models/email_commseq_email_send_test_response.rb +247 -212
  904. data/lib/ultracart_api/models/email_commseq_emails_request.rb +258 -223
  905. data/lib/ultracart_api/models/email_commseq_emails_response.rb +258 -223
  906. data/lib/ultracart_api/models/email_commseq_postcard.rb +340 -305
  907. data/lib/ultracart_api/models/email_commseq_postcard_response.rb +256 -221
  908. data/lib/ultracart_api/models/email_commseq_postcard_send_test_request.rb +329 -294
  909. data/lib/ultracart_api/models/email_commseq_postcard_send_test_response.rb +274 -239
  910. data/lib/ultracart_api/models/email_commseq_postcards_request.rb +221 -186
  911. data/lib/ultracart_api/models/email_commseq_postcards_response.rb +258 -223
  912. data/lib/ultracart_api/models/email_commseq_response.rb +256 -221
  913. data/lib/ultracart_api/models/email_commseq_stat.rb +580 -545
  914. data/lib/ultracart_api/models/email_commseq_stat_response.rb +256 -221
  915. data/lib/ultracart_api/models/email_commseq_step.rb +348 -313
  916. data/lib/ultracart_api/models/email_commseq_step_log.rb +240 -205
  917. data/lib/ultracart_api/models/email_commseq_step_logs_response.rb +258 -223
  918. data/lib/ultracart_api/models/email_commseq_webhook_send_test_request.rb +275 -240
  919. data/lib/ultracart_api/models/email_commseq_webhook_send_test_response.rb +277 -242
  920. data/lib/ultracart_api/models/email_commseqs_response.rb +258 -223
  921. data/lib/ultracart_api/models/email_customer.rb +292 -257
  922. data/lib/ultracart_api/models/email_customer_editor_url_response.rb +256 -221
  923. data/lib/ultracart_api/models/email_customers_response.rb +262 -227
  924. data/lib/ultracart_api/models/email_dashboard_activity.rb +280 -245
  925. data/lib/ultracart_api/models/email_dashboard_activity_response.rb +258 -223
  926. data/lib/ultracart_api/models/email_dashboard_stats_response.rb +258 -223
  927. data/lib/ultracart_api/models/email_domain.rb +329 -294
  928. data/lib/ultracart_api/models/email_editor_token_response.rb +256 -221
  929. data/lib/ultracart_api/models/email_flow.rb +505 -500
  930. data/lib/ultracart_api/models/email_flow_back_populate_request.rb +230 -195
  931. data/lib/ultracart_api/models/email_flow_back_populate_response.rb +247 -212
  932. data/lib/ultracart_api/models/email_flow_folder.rb +275 -240
  933. data/lib/ultracart_api/models/email_flow_folder_response.rb +256 -221
  934. data/lib/ultracart_api/models/email_flow_folders_response.rb +258 -223
  935. data/lib/ultracart_api/models/email_flow_response.rb +256 -221
  936. data/lib/ultracart_api/models/email_flows_response.rb +258 -223
  937. data/lib/ultracart_api/models/email_global_settings.rb +219 -184
  938. data/lib/ultracart_api/models/email_global_settings_response.rb +256 -221
  939. data/lib/ultracart_api/models/email_global_unsubscribe_request.rb +219 -184
  940. data/lib/ultracart_api/models/email_global_unsubscribe_response.rb +219 -184
  941. data/lib/ultracart_api/models/email_histogram_property_names_response.rb +221 -186
  942. data/lib/ultracart_api/models/email_histogram_property_values_response.rb +221 -186
  943. data/lib/ultracart_api/models/email_list.rb +347 -312
  944. data/lib/ultracart_api/models/email_list_archive_response.rb +256 -221
  945. data/lib/ultracart_api/models/email_list_customer.rb +250 -215
  946. data/lib/ultracart_api/models/email_list_customers_response.rb +262 -227
  947. data/lib/ultracart_api/models/email_list_response.rb +256 -221
  948. data/lib/ultracart_api/models/email_list_segment_folder.rb +275 -240
  949. data/lib/ultracart_api/models/email_list_segment_folder_response.rb +256 -221
  950. data/lib/ultracart_api/models/email_list_segment_folders_response.rb +258 -223
  951. data/lib/ultracart_api/models/email_list_segment_membership.rb +250 -215
  952. data/lib/ultracart_api/models/email_list_segment_used_by.rb +240 -205
  953. data/lib/ultracart_api/models/email_list_subscribe_response.rb +228 -193
  954. data/lib/ultracart_api/models/email_lists_response.rb +258 -223
  955. data/lib/ultracart_api/models/email_order.rb +249 -214
  956. data/lib/ultracart_api/models/email_orders_response.rb +258 -223
  957. data/lib/ultracart_api/models/email_performance.rb +475 -440
  958. data/lib/ultracart_api/models/email_performance_customer_histogram.rb +222 -187
  959. data/lib/ultracart_api/models/email_performance_customer_histogram_period.rb +260 -225
  960. data/lib/ultracart_api/models/email_performance_daily.rb +280 -245
  961. data/lib/ultracart_api/models/email_performance_response.rb +256 -221
  962. data/lib/ultracart_api/models/email_plan.rb +365 -330
  963. data/lib/ultracart_api/models/email_plan_additional.rb +291 -256
  964. data/lib/ultracart_api/models/email_plan_response.rb +256 -221
  965. data/lib/ultracart_api/models/email_postcard_stat.rb +531 -496
  966. data/lib/ultracart_api/models/email_segment.rb +445 -420
  967. data/lib/ultracart_api/models/email_segment_archive_response.rb +256 -221
  968. data/lib/ultracart_api/models/email_segment_customer.rb +250 -215
  969. data/lib/ultracart_api/models/email_segment_customers_response.rb +262 -227
  970. data/lib/ultracart_api/models/email_segment_download_prepare_response.rb +283 -248
  971. data/lib/ultracart_api/models/email_segment_response.rb +256 -221
  972. data/lib/ultracart_api/models/email_segments_response.rb +258 -223
  973. data/lib/ultracart_api/models/email_sending_domain_response.rb +256 -221
  974. data/lib/ultracart_api/models/email_sending_domains_response.rb +258 -223
  975. data/lib/ultracart_api/models/email_settings.rb +318 -351
  976. data/lib/ultracart_api/models/email_settings_response.rb +256 -221
  977. data/lib/ultracart_api/models/email_stat.rb +591 -556
  978. data/lib/ultracart_api/models/email_stat_postcard_summary_request.rb +230 -195
  979. data/lib/ultracart_api/models/email_stat_postcard_summary_response.rb +258 -223
  980. data/lib/ultracart_api/models/email_stat_summary_request.rb +241 -206
  981. data/lib/ultracart_api/models/email_stat_summary_response.rb +258 -223
  982. data/lib/ultracart_api/models/email_step_stat.rb +410 -475
  983. data/lib/ultracart_api/models/email_step_stat_request.rb +230 -195
  984. data/lib/ultracart_api/models/email_step_stat_response.rb +258 -223
  985. data/lib/ultracart_api/models/email_step_waiting_request.rb +221 -186
  986. data/lib/ultracart_api/models/email_step_waiting_response.rb +221 -186
  987. data/lib/ultracart_api/models/email_template.rb +365 -330
  988. data/lib/ultracart_api/models/email_templates_response.rb +258 -223
  989. data/lib/ultracart_api/models/email_third_party_list.rb +230 -195
  990. data/lib/ultracart_api/models/email_third_party_list_import_request.rb +222 -187
  991. data/lib/ultracart_api/models/email_third_party_provider.rb +324 -289
  992. data/lib/ultracart_api/models/email_third_party_providers_response.rb +258 -223
  993. data/lib/ultracart_api/models/email_third_party_tag.rb +230 -195
  994. data/lib/ultracart_api/models/email_verify_token_request.rb +230 -195
  995. data/lib/ultracart_api/models/email_verify_token_response.rb +257 -222
  996. data/lib/ultracart_api/models/email_verify_token_validate_request.rb +220 -185
  997. data/lib/ultracart_api/models/email_verify_token_validate_response.rb +247 -212
  998. data/lib/ultracart_api/models/email_webhook_editor_values_response.rb +278 -243
  999. data/lib/ultracart_api/models/error.rb +260 -225
  1000. data/lib/ultracart_api/models/error_response.rb +247 -212
  1001. data/lib/ultracart_api/models/experiment.rb +426 -463
  1002. data/lib/ultracart_api/models/experiment_response.rb +256 -221
  1003. data/lib/ultracart_api/models/experiment_variation.rb +432 -407
  1004. data/lib/ultracart_api/models/experiment_variation_stat.rb +320 -307
  1005. data/lib/ultracart_api/models/experiments_response.rb +258 -223
  1006. data/lib/ultracart_api/models/fulfillment_inventory.rb +228 -193
  1007. data/lib/ultracart_api/models/fulfillment_shipment.rb +262 -227
  1008. data/lib/ultracart_api/models/geo_point.rb +228 -193
  1009. data/lib/ultracart_api/models/geocode_request.rb +260 -225
  1010. data/lib/ultracart_api/models/geocode_response.rb +265 -230
  1011. data/lib/ultracart_api/models/gift_certificate.rb +367 -332
  1012. data/lib/ultracart_api/models/gift_certificate_create_request.rb +260 -225
  1013. data/lib/ultracart_api/models/gift_certificate_ledger_entry.rb +285 -250
  1014. data/lib/ultracart_api/models/gift_certificate_query.rb +300 -265
  1015. data/lib/ultracart_api/models/gift_certificate_response.rb +256 -221
  1016. data/lib/ultracart_api/models/gift_certificates_response.rb +258 -223
  1017. data/lib/ultracart_api/models/group.rb +266 -231
  1018. data/lib/ultracart_api/models/group_response.rb +256 -221
  1019. data/lib/ultracart_api/models/group_user_membership.rb +260 -225
  1020. data/lib/ultracart_api/models/groups_response.rb +258 -223
  1021. data/lib/ultracart_api/models/http_header.rb +230 -195
  1022. data/lib/ultracart_api/models/integration_log.rb +379 -355
  1023. data/lib/ultracart_api/models/integration_log_file.rb +246 -211
  1024. data/lib/ultracart_api/models/integration_log_log.rb +228 -193
  1025. data/lib/ultracart_api/models/integration_log_query_filter_values.rb +340 -305
  1026. data/lib/ultracart_api/models/integration_log_query_request.rb +333 -329
  1027. data/lib/ultracart_api/models/integration_log_query_response.rb +267 -232
  1028. data/lib/ultracart_api/models/integration_log_response.rb +256 -221
  1029. data/lib/ultracart_api/models/integration_log_summary.rb +291 -256
  1030. data/lib/ultracart_api/models/integration_log_summary_query_request.rb +230 -195
  1031. data/lib/ultracart_api/models/integration_log_summary_query_response.rb +258 -223
  1032. data/lib/ultracart_api/models/item.rb +748 -713
  1033. data/lib/ultracart_api/models/item_accounting.rb +260 -225
  1034. data/lib/ultracart_api/models/item_amember.rb +245 -210
  1035. data/lib/ultracart_api/models/item_auto_order.rb +403 -418
  1036. data/lib/ultracart_api/models/item_auto_order_step.rb +413 -398
  1037. data/lib/ultracart_api/models/item_auto_order_step_arbitrary_unit_cost_schedule.rb +230 -195
  1038. data/lib/ultracart_api/models/item_auto_order_step_grandfather_pricing.rb +230 -195
  1039. data/lib/ultracart_api/models/item_cc_bill.rb +270 -235
  1040. data/lib/ultracart_api/models/item_channel_partner_mapping.rb +445 -410
  1041. data/lib/ultracart_api/models/item_chargeback.rb +234 -199
  1042. data/lib/ultracart_api/models/item_chargeback_addendum.rb +250 -215
  1043. data/lib/ultracart_api/models/item_chargeback_adjustment_request.rb +240 -205
  1044. data/lib/ultracart_api/models/item_checkout.rb +265 -230
  1045. data/lib/ultracart_api/models/item_content.rb +361 -356
  1046. data/lib/ultracart_api/models/item_content_assignment.rb +285 -250
  1047. data/lib/ultracart_api/models/item_content_attribute.rb +280 -245
  1048. data/lib/ultracart_api/models/item_content_multimedia.rb +441 -406
  1049. data/lib/ultracart_api/models/item_content_multimedia_thumbnail.rb +270 -235
  1050. data/lib/ultracart_api/models/item_digital_delivery.rb +317 -282
  1051. data/lib/ultracart_api/models/item_digital_item.rb +305 -334
  1052. data/lib/ultracart_api/models/item_ebay.rb +901 -866
  1053. data/lib/ultracart_api/models/item_ebay_category_specific.rb +230 -195
  1054. data/lib/ultracart_api/models/item_ebay_market_listing.rb +260 -225
  1055. data/lib/ultracart_api/models/item_ebay_market_place_analysis.rb +311 -276
  1056. data/lib/ultracart_api/models/item_email_notifications.rb +230 -195
  1057. data/lib/ultracart_api/models/item_enrollment123.rb +220 -185
  1058. data/lib/ultracart_api/models/item_fulfillment_addon.rb +250 -225
  1059. data/lib/ultracart_api/models/item_gift_certificate.rb +230 -195
  1060. data/lib/ultracart_api/models/item_google_product_search.rb +1289 -1254
  1061. data/lib/ultracart_api/models/item_identifiers.rb +310 -375
  1062. data/lib/ultracart_api/models/item_instant_payment_notification.rb +270 -235
  1063. data/lib/ultracart_api/models/item_instant_payment_notifications.rb +222 -187
  1064. data/lib/ultracart_api/models/item_internal.rb +235 -200
  1065. data/lib/ultracart_api/models/item_kit_component.rb +260 -225
  1066. data/lib/ultracart_api/models/item_kit_definition.rb +222 -187
  1067. data/lib/ultracart_api/models/item_option.rb +416 -381
  1068. data/lib/ultracart_api/models/item_option_value.rb +409 -374
  1069. data/lib/ultracart_api/models/item_option_value_additional_item.rb +230 -195
  1070. data/lib/ultracart_api/models/item_option_value_digital_item.rb +230 -195
  1071. data/lib/ultracart_api/models/item_payment_processing.rb +264 -239
  1072. data/lib/ultracart_api/models/item_physical.rb +246 -211
  1073. data/lib/ultracart_api/models/item_pricing.rb +422 -387
  1074. data/lib/ultracart_api/models/item_pricing_tier.rb +261 -226
  1075. data/lib/ultracart_api/models/item_pricing_tier_discount.rb +230 -195
  1076. data/lib/ultracart_api/models/item_pricing_tier_limit.rb +240 -227
  1077. data/lib/ultracart_api/models/item_property.rb +270 -235
  1078. data/lib/ultracart_api/models/item_realtime_pricing.rb +240 -205
  1079. data/lib/ultracart_api/models/item_related.rb +242 -207
  1080. data/lib/ultracart_api/models/item_related_item.rb +274 -239
  1081. data/lib/ultracart_api/models/item_reporting.rb +232 -197
  1082. data/lib/ultracart_api/models/item_response.rb +256 -221
  1083. data/lib/ultracart_api/models/item_restriction.rb +292 -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 -688
  1089. data/lib/ultracart_api/models/item_shipping_case.rb +265 -230
  1090. data/lib/ultracart_api/models/item_shipping_destination_markup.rb +315 -290
  1091. data/lib/ultracart_api/models/item_shipping_destination_restriction.rb +304 -269
  1092. data/lib/ultracart_api/models/item_shipping_distribution_center.rb +380 -345
  1093. data/lib/ultracart_api/models/item_shipping_method.rb +394 -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 -622
  1130. data/lib/ultracart_api/models/order_affiliate.rb +242 -207
  1131. data/lib/ultracart_api/models/order_affiliate_ledger.rb +334 -299
  1132. data/lib/ultracart_api/models/order_auto_order.rb +448 -413
  1133. data/lib/ultracart_api/models/order_billing.rb +597 -612
  1134. data/lib/ultracart_api/models/order_buysafe.rb +268 -233
  1135. data/lib/ultracart_api/models/order_by_token_query.rb +220 -185
  1136. data/lib/ultracart_api/models/order_channel_partner.rb +335 -300
  1137. data/lib/ultracart_api/models/order_checkout.rb +469 -509
  1138. data/lib/ultracart_api/models/order_coupon.rb +290 -255
  1139. data/lib/ultracart_api/models/order_digital_item.rb +290 -255
  1140. data/lib/ultracart_api/models/order_digital_order.rb +262 -227
  1141. data/lib/ultracart_api/models/order_edi.rb +265 -230
  1142. data/lib/ultracart_api/models/order_format.rb +404 -369
  1143. data/lib/ultracart_api/models/order_format_response.rb +232 -197
  1144. data/lib/ultracart_api/models/order_fraud_score.rb +444 -409
  1145. data/lib/ultracart_api/models/order_gift.rb +351 -316
  1146. data/lib/ultracart_api/models/order_gift_certificate.rb +239 -204
  1147. data/lib/ultracart_api/models/order_internal.rb +275 -252
  1148. data/lib/ultracart_api/models/order_item.rb +889 -1028
  1149. data/lib/ultracart_api/models/order_item_edi.rb +234 -199
  1150. data/lib/ultracart_api/models/order_item_edi_identification.rb +230 -195
  1151. data/lib/ultracart_api/models/order_item_edi_lot.rb +240 -205
  1152. data/lib/ultracart_api/models/order_item_option.rb +378 -343
  1153. data/lib/ultracart_api/models/order_item_option_file_attachment.rb +250 -215
  1154. data/lib/ultracart_api/models/order_item_property.rb +280 -245
  1155. data/lib/ultracart_api/models/order_item_tag.rb +235 -200
  1156. data/lib/ultracart_api/models/order_linked_shipment.rb +264 -229
  1157. data/lib/ultracart_api/models/order_marketing.rb +270 -245
  1158. data/lib/ultracart_api/models/order_packing_slip_response.rb +257 -222
  1159. data/lib/ultracart_api/models/order_payment.rb +432 -415
  1160. data/lib/ultracart_api/models/order_payment_check.rb +220 -185
  1161. data/lib/ultracart_api/models/order_payment_credit_card.rb +354 -328
  1162. data/lib/ultracart_api/models/order_payment_e_check.rb +476 -441
  1163. data/lib/ultracart_api/models/order_payment_insurance.rb +250 -215
  1164. data/lib/ultracart_api/models/order_payment_purchase_order.rb +220 -185
  1165. data/lib/ultracart_api/models/order_payment_transaction.rb +252 -227
  1166. data/lib/ultracart_api/models/order_payment_transaction_detail.rb +240 -205
  1167. data/lib/ultracart_api/models/order_process_payment_request.rb +230 -195
  1168. data/lib/ultracart_api/models/order_process_payment_response.rb +256 -221
  1169. data/lib/ultracart_api/models/order_property.rb +280 -280
  1170. data/lib/ultracart_api/models/order_query.rb +826 -843
  1171. data/lib/ultracart_api/models/order_query_batch.rb +222 -231
  1172. data/lib/ultracart_api/models/order_quote.rb +240 -205
  1173. data/lib/ultracart_api/models/order_replacement.rb +467 -432
  1174. data/lib/ultracart_api/models/order_replacement_item.rb +255 -220
  1175. data/lib/ultracart_api/models/order_replacement_response.rb +264 -229
  1176. data/lib/ultracart_api/models/order_response.rb +256 -221
  1177. data/lib/ultracart_api/models/order_salesforce.rb +220 -185
  1178. data/lib/ultracart_api/models/order_shipping.rb +770 -745
  1179. data/lib/ultracart_api/models/order_summary.rb +390 -411
  1180. data/lib/ultracart_api/models/order_tag.rb +235 -200
  1181. data/lib/ultracart_api/models/order_taxes.rb +395 -360
  1182. data/lib/ultracart_api/models/order_token_response.rb +257 -222
  1183. data/lib/ultracart_api/models/order_tracking_number_detail.rb +320 -285
  1184. data/lib/ultracart_api/models/order_tracking_number_details.rb +374 -339
  1185. data/lib/ultracart_api/models/orders_response.rb +259 -224
  1186. data/lib/ultracart_api/models/permission.rb +240 -205
  1187. data/lib/ultracart_api/models/pricing_tier.rb +533 -528
  1188. data/lib/ultracart_api/models/pricing_tier_notification.rb +270 -235
  1189. data/lib/ultracart_api/models/pricing_tiers_response.rb +259 -224
  1190. data/lib/ultracart_api/models/property.rb +228 -193
  1191. data/lib/ultracart_api/models/publish_library_item_request.rb +220 -185
  1192. data/lib/ultracart_api/models/register_affiliate_click_request.rb +270 -235
  1193. data/lib/ultracart_api/models/register_affiliate_click_response.rb +254 -219
  1194. data/lib/ultracart_api/models/response_metadata.rb +229 -194
  1195. data/lib/ultracart_api/models/result_set.rb +270 -235
  1196. data/lib/ultracart_api/models/screen_recording.rb +688 -653
  1197. data/lib/ultracart_api/models/screen_recording_ad_platform.rb +280 -245
  1198. data/lib/ultracart_api/models/screen_recording_filter.rb +758 -723
  1199. data/lib/ultracart_api/models/screen_recording_filter_geo_distance.rb +255 -220
  1200. data/lib/ultracart_api/models/screen_recording_filter_ip_search.rb +246 -211
  1201. data/lib/ultracart_api/models/screen_recording_filter_page_view.rb +369 -334
  1202. data/lib/ultracart_api/models/screen_recording_filter_page_view_event.rb +230 -195
  1203. data/lib/ultracart_api/models/screen_recording_filter_page_view_event_param.rb +255 -220
  1204. data/lib/ultracart_api/models/screen_recording_filter_page_view_param.rb +228 -193
  1205. data/lib/ultracart_api/models/screen_recording_filter_page_view_referrer_param.rb +228 -193
  1206. data/lib/ultracart_api/models/screen_recording_filter_range_big_decimal.rb +255 -220
  1207. data/lib/ultracart_api/models/screen_recording_filter_range_date.rb +230 -195
  1208. data/lib/ultracart_api/models/screen_recording_filter_range_integer.rb +255 -220
  1209. data/lib/ultracart_api/models/screen_recording_filter_string_search.rb +255 -220
  1210. data/lib/ultracart_api/models/screen_recording_filter_values.rb +435 -400
  1211. data/lib/ultracart_api/models/screen_recording_filter_values_event.rb +230 -195
  1212. data/lib/ultracart_api/models/screen_recording_filter_values_event_params.rb +263 -228
  1213. data/lib/ultracart_api/models/screen_recording_filter_values_page_param.rb +230 -195
  1214. data/lib/ultracart_api/models/screen_recording_filter_values_page_view.rb +272 -237
  1215. data/lib/ultracart_api/models/screen_recording_heatmap.rb +426 -391
  1216. data/lib/ultracart_api/models/screen_recording_heatmap_index_request.rb +219 -184
  1217. data/lib/ultracart_api/models/screen_recording_heatmap_index_response.rb +258 -223
  1218. data/lib/ultracart_api/models/screen_recording_heatmap_request.rb +239 -204
  1219. data/lib/ultracart_api/models/screen_recording_heatmap_reset.rb +219 -184
  1220. data/lib/ultracart_api/models/screen_recording_heatmap_response.rb +256 -221
  1221. data/lib/ultracart_api/models/screen_recording_heatmap_url.rb +266 -231
  1222. data/lib/ultracart_api/models/screen_recording_merchant_notes_request.rb +219 -184
  1223. data/lib/ultracart_api/models/screen_recording_multifield.rb +255 -220
  1224. data/lib/ultracart_api/models/screen_recording_page_view.rb +391 -356
  1225. data/lib/ultracart_api/models/screen_recording_page_view_data_response.rb +256 -221
  1226. data/lib/ultracart_api/models/screen_recording_page_view_event.rb +267 -232
  1227. data/lib/ultracart_api/models/screen_recording_page_view_event_parameter.rb +228 -193
  1228. data/lib/ultracart_api/models/screen_recording_page_view_parameter.rb +228 -193
  1229. data/lib/ultracart_api/models/screen_recording_query_request.rb +219 -184
  1230. data/lib/ultracart_api/models/screen_recording_query_response.rb +314 -279
  1231. data/lib/ultracart_api/models/screen_recording_response.rb +265 -230
  1232. data/lib/ultracart_api/models/screen_recording_segment.rb +302 -267
  1233. data/lib/ultracart_api/models/screen_recording_segment_response.rb +256 -221
  1234. data/lib/ultracart_api/models/screen_recording_segments_response.rb +258 -223
  1235. data/lib/ultracart_api/models/screen_recording_settings.rb +284 -249
  1236. data/lib/ultracart_api/models/screen_recording_settings_response.rb +256 -221
  1237. data/lib/ultracart_api/models/screen_recording_store_front.rb +228 -193
  1238. data/lib/ultracart_api/models/screen_recording_tags_request.rb +221 -186
  1239. data/lib/ultracart_api/models/screen_recording_tags_response.rb +258 -223
  1240. data/lib/ultracart_api/models/screen_recording_user_agent.rb +255 -220
  1241. data/lib/ultracart_api/models/screen_recording_user_agent_device.rb +219 -184
  1242. data/lib/ultracart_api/models/screen_recording_user_agent_os.rb +237 -202
  1243. data/lib/ultracart_api/models/screen_recording_user_property.rb +228 -193
  1244. data/lib/ultracart_api/models/screenshots_response.rb +259 -224
  1245. data/lib/ultracart_api/models/self_config.rb +220 -205
  1246. data/lib/ultracart_api/models/simple_value.rb +230 -195
  1247. data/lib/ultracart_api/models/single_sign_on_authorize_request.rb +230 -195
  1248. data/lib/ultracart_api/models/single_sign_on_authorize_response.rb +230 -195
  1249. data/lib/ultracart_api/models/single_sign_on_token_request.rb +230 -195
  1250. data/lib/ultracart_api/models/single_sign_on_token_response.rb +240 -205
  1251. data/lib/ultracart_api/models/sovos_config.rb +280 -245
  1252. data/lib/ultracart_api/models/state_province.rb +245 -210
  1253. data/lib/ultracart_api/models/step_waiting.rb +228 -193
  1254. data/lib/ultracart_api/models/tax_city.rb +302 -267
  1255. data/lib/ultracart_api/models/tax_country.rb +302 -267
  1256. data/lib/ultracart_api/models/tax_country_code.rb +260 -225
  1257. data/lib/ultracart_api/models/tax_county.rb +312 -277
  1258. data/lib/ultracart_api/models/tax_jar_config.rb +280 -245
  1259. data/lib/ultracart_api/models/tax_postal_code.rb +280 -245
  1260. data/lib/ultracart_api/models/tax_provider_activate_result.rb +229 -194
  1261. data/lib/ultracart_api/models/tax_provider_avalara.rb +249 -214
  1262. data/lib/ultracart_api/models/tax_provider_avalara_companies_result.rb +222 -187
  1263. data/lib/ultracart_api/models/tax_provider_avalara_company.rb +260 -225
  1264. data/lib/ultracart_api/models/tax_provider_self.rb +261 -226
  1265. data/lib/ultracart_api/models/tax_provider_self_countries_response.rb +222 -187
  1266. data/lib/ultracart_api/models/tax_provider_self_regions_response.rb +222 -187
  1267. data/lib/ultracart_api/models/tax_provider_sovos.rb +249 -214
  1268. data/lib/ultracart_api/models/tax_provider_tax_jar.rb +249 -214
  1269. data/lib/ultracart_api/models/tax_provider_test_result.rb +229 -194
  1270. data/lib/ultracart_api/models/tax_provider_ultra_cart.rb +261 -226
  1271. data/lib/ultracart_api/models/tax_provider_ultra_cart_state.rb +310 -275
  1272. data/lib/ultracart_api/models/tax_providers_response.rb +292 -257
  1273. data/lib/ultracart_api/models/tax_state.rb +392 -357
  1274. data/lib/ultracart_api/models/tax_state_code.rb +260 -225
  1275. data/lib/ultracart_api/models/temp_multimedia.rb +329 -294
  1276. data/lib/ultracart_api/models/temp_multimedia_response.rb +256 -221
  1277. data/lib/ultracart_api/models/thumbnail_parameters_request.rb +255 -220
  1278. data/lib/ultracart_api/models/thumbnail_parameters_response.rb +257 -222
  1279. data/lib/ultracart_api/models/transaction_email.rb +414 -379
  1280. data/lib/ultracart_api/models/transaction_email_list_response.rb +258 -223
  1281. data/lib/ultracart_api/models/transaction_email_option.rb +282 -247
  1282. data/lib/ultracart_api/models/transaction_email_response.rb +256 -221
  1283. data/lib/ultracart_api/models/twilio.rb +248 -258
  1284. data/lib/ultracart_api/models/twilio_response.rb +265 -230
  1285. data/lib/ultracart_api/models/twilios_response.rb +258 -223
  1286. data/lib/ultracart_api/models/ultra_cart_config.rb +220 -205
  1287. data/lib/ultracart_api/models/upload_coupon_codes_request.rb +259 -224
  1288. data/lib/ultracart_api/models/upload_coupon_codes_response.rb +283 -248
  1289. data/lib/ultracart_api/models/user.rb +377 -342
  1290. data/lib/ultracart_api/models/user_group_membership.rb +240 -205
  1291. data/lib/ultracart_api/models/user_login.rb +250 -215
  1292. data/lib/ultracart_api/models/user_logins_response.rb +259 -224
  1293. data/lib/ultracart_api/models/user_response.rb +256 -221
  1294. data/lib/ultracart_api/models/users_response.rb +258 -223
  1295. data/lib/ultracart_api/models/verification_record.rb +237 -202
  1296. data/lib/ultracart_api/models/warning.rb +230 -195
  1297. data/lib/ultracart_api/models/webhook.rb +437 -412
  1298. data/lib/ultracart_api/models/webhook_event_category.rb +264 -229
  1299. data/lib/ultracart_api/models/webhook_event_subscription.rb +300 -275
  1300. data/lib/ultracart_api/models/webhook_log.rb +324 -299
  1301. data/lib/ultracart_api/models/webhook_log_response.rb +256 -221
  1302. data/lib/ultracart_api/models/webhook_log_summaries_response.rb +259 -224
  1303. data/lib/ultracart_api/models/webhook_log_summary.rb +240 -205
  1304. data/lib/ultracart_api/models/webhook_response.rb +256 -221
  1305. data/lib/ultracart_api/models/{conversation_pbx_audio_usage_response.rb → webhook_sample_request.rb} +252 -245
  1306. data/lib/ultracart_api/models/{customer_wish_list_items_response.rb → webhook_sample_request_response.rb} +256 -223
  1307. data/lib/ultracart_api/models/webhooks_response.rb +258 -223
  1308. data/lib/ultracart_api/models/weight.rb +264 -229
  1309. data/lib/ultracart_api/version.rb +15 -15
  1310. data/lib/ultracart_api.rb +689 -920
  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 +9 -631
  1316. data/docs/AccountsReceivableRetryTransactionReject.md +0 -9
  1317. data/docs/AutoOrderAddonItem.md +0 -13
  1318. data/docs/AutoOrderAddonItemOption.md +0 -9
  1319. data/docs/AutoOrderConsolidate.md +0 -8
  1320. data/docs/AutoOrderManagement.md +0 -8
  1321. data/docs/CartItemProperty.md +0 -11
  1322. data/docs/CartPaymentHealthBenefitCard.md +0 -13
  1323. data/docs/ChanelPartnerReasonCodesResponse.md +0 -18
  1324. data/docs/ChannelPartner.md +0 -15
  1325. data/docs/ChannelPartnerOrderItemProperty.md +0 -11
  1326. data/docs/ChannelPartnerShipToPreference.md +0 -14
  1327. data/docs/ChannelPartnerShipToPreferenceResponse.md +0 -12
  1328. data/docs/ChannelPartnerShipToPreferencesResponse.md +0 -12
  1329. data/docs/ChannelPartnersResponse.md +0 -12
  1330. data/docs/Conversation.md +0 -26
  1331. data/docs/ConversationAgentAuth.md +0 -22
  1332. data/docs/ConversationAgentAuthResponse.md +0 -12
  1333. data/docs/ConversationAgentProfile.md +0 -19
  1334. data/docs/ConversationAgentProfileResponse.md +0 -12
  1335. data/docs/ConversationAgentProfilesResponse.md +0 -12
  1336. data/docs/ConversationApi.md +0 -4245
  1337. data/docs/ConversationAutocompleteRequest.md +0 -9
  1338. data/docs/ConversationAutocompleteResponse.md +0 -14
  1339. data/docs/ConversationAutocompleteValue.md +0 -9
  1340. data/docs/ConversationCannedMessage.md +0 -11
  1341. data/docs/ConversationCannedMessageResponse.md +0 -12
  1342. data/docs/ConversationCannedMessagesResponse.md +0 -12
  1343. data/docs/ConversationCannedMessagesSearch.md +0 -9
  1344. data/docs/ConversationDepartment.md +0 -12
  1345. data/docs/ConversationDepartmentMember.md +0 -10
  1346. data/docs/ConversationDepartmentMembersResponse.md +0 -12
  1347. data/docs/ConversationDepartmentResponse.md +0 -12
  1348. data/docs/ConversationDepartmentSettings.md +0 -7
  1349. data/docs/ConversationDepartmentsResponse.md +0 -12
  1350. data/docs/ConversationEngagement.md +0 -16
  1351. data/docs/ConversationEngagementEquation.md +0 -8
  1352. data/docs/ConversationEngagementEquationFunction.md +0 -21
  1353. data/docs/ConversationEngagementEquationGroup.md +0 -8
  1354. data/docs/ConversationEngagementResponse.md +0 -12
  1355. data/docs/ConversationEngagementsResponse.md +0 -12
  1356. data/docs/ConversationEventAddCoupon.md +0 -10
  1357. data/docs/ConversationEventAddItem.md +0 -10
  1358. data/docs/ConversationEventQueuePosition.md +0 -9
  1359. data/docs/ConversationEventRRWeb.md +0 -14
  1360. data/docs/ConversationEventReadMessage.md +0 -10
  1361. data/docs/ConversationEventTyping.md +0 -10
  1362. data/docs/ConversationEventWebchatContext.md +0 -10
  1363. data/docs/ConversationJoinRequest.md +0 -8
  1364. data/docs/ConversationLocationCountry.md +0 -10
  1365. data/docs/ConversationLocationStateProvince.md +0 -9
  1366. data/docs/ConversationLocationsResponse.md +0 -12
  1367. data/docs/ConversationMessage.md +0 -22
  1368. data/docs/ConversationMessageTranslation.md +0 -9
  1369. data/docs/ConversationMessageTransportStatus.md +0 -9
  1370. data/docs/ConversationMessagesResponse.md +0 -12
  1371. data/docs/ConversationMultimediaUploadUrl.md +0 -9
  1372. data/docs/ConversationMultimediaUploadUrlResponse.md +0 -12
  1373. data/docs/ConversationParticipant.md +0 -20
  1374. data/docs/ConversationPbxAgent.md +0 -23
  1375. data/docs/ConversationPbxAgentResponse.md +0 -12
  1376. data/docs/ConversationPbxAgentsResponse.md +0 -12
  1377. data/docs/ConversationPbxAudio.md +0 -17
  1378. data/docs/ConversationPbxAudioResponse.md +0 -12
  1379. data/docs/ConversationPbxAudioUploadUrl.md +0 -9
  1380. data/docs/ConversationPbxAudioUploadUrlResponse.md +0 -12
  1381. data/docs/ConversationPbxAudioUsageResponse.md +0 -14
  1382. data/docs/ConversationPbxAudiosResponse.md +0 -12
  1383. data/docs/ConversationPbxCustomerSnapshotRequest.md +0 -15
  1384. data/docs/ConversationPbxCustomerSnapshotResponse.md +0 -14
  1385. data/docs/ConversationPbxMenu.md +0 -18
  1386. data/docs/ConversationPbxMenuMapping.md +0 -11
  1387. data/docs/ConversationPbxMenuResponse.md +0 -12
  1388. data/docs/ConversationPbxMenusResponse.md +0 -12
  1389. data/docs/ConversationPbxPhoneNumber.md +0 -12
  1390. data/docs/ConversationPbxPhoneNumberResponse.md +0 -12
  1391. data/docs/ConversationPbxPhoneNumbersResponse.md +0 -12
  1392. data/docs/ConversationPbxQueue.md +0 -28
  1393. data/docs/ConversationPbxQueueMembers.md +0 -9
  1394. data/docs/ConversationPbxQueueResponse.md +0 -12
  1395. data/docs/ConversationPbxQueuesResponse.md +0 -12
  1396. data/docs/ConversationPbxTimeBased.md +0 -11
  1397. data/docs/ConversationPbxTimeBasedMapping.md +0 -11
  1398. data/docs/ConversationPbxTimeBasedMappingConfig.md +0 -9
  1399. data/docs/ConversationPbxTimeBasedResponse.md +0 -12
  1400. data/docs/ConversationPbxTimeBasedsResponse.md +0 -12
  1401. data/docs/ConversationPbxTimeRange.md +0 -12
  1402. data/docs/ConversationPbxTimeRangeConfig.md +0 -13
  1403. data/docs/ConversationPbxTimeRangeResponse.md +0 -12
  1404. data/docs/ConversationPbxTimeRangesResponse.md +0 -12
  1405. data/docs/ConversationPbxVoicemailMailbox.md +0 -19
  1406. data/docs/ConversationPbxVoicemailMailboxResponse.md +0 -12
  1407. data/docs/ConversationPbxVoicemailMailboxesResponse.md +0 -12
  1408. data/docs/ConversationPbxVoicemailMessage.md +0 -20
  1409. data/docs/ConversationPbxVoicemailMessageResponse.md +0 -12
  1410. data/docs/ConversationPbxVoicemailMessageSummariesResponse.md +0 -12
  1411. data/docs/ConversationPbxVoicemailMessageSummary.md +0 -17
  1412. data/docs/ConversationPermissions.md +0 -8
  1413. data/docs/ConversationPermissionsResponse.md +0 -12
  1414. data/docs/ConversationResponse.md +0 -12
  1415. data/docs/ConversationSearchRequest.md +0 -19
  1416. data/docs/ConversationSearchResponse.md +0 -11
  1417. data/docs/ConversationSentiment.md +0 -13
  1418. data/docs/ConversationStartRequest.md +0 -10
  1419. data/docs/ConversationStartResponse.md +0 -8
  1420. data/docs/ConversationSummary.md +0 -24
  1421. data/docs/ConversationTwilioAccount.md +0 -9
  1422. data/docs/ConversationWebchatContext.md +0 -15
  1423. data/docs/ConversationWebchatQueueStatus.md +0 -22
  1424. data/docs/ConversationWebchatQueueStatusAgent.md +0 -13
  1425. data/docs/ConversationWebchatQueueStatusQueueEntry.md +0 -15
  1426. data/docs/ConversationWebchatQueueStatusUpdateRequest.md +0 -8
  1427. data/docs/ConversationWebchatQueueStatusesResponse.md +0 -12
  1428. data/docs/ConversationWebsocketMessage.md +0 -31
  1429. data/docs/ConversationsResponse.md +0 -12
  1430. data/docs/CouponFreeItemWithItemPurchaseAndFreeShipping.md +0 -11
  1431. data/docs/CouponMoreLoyaltyCashback.md +0 -8
  1432. data/docs/CouponMoreLoyaltyPoints.md +0 -8
  1433. data/docs/CouponNoDiscount.md +0 -8
  1434. data/docs/CouponPercentMoreLoyaltyCashback.md +0 -8
  1435. data/docs/CouponPercentMoreLoyaltyPoints.md +0 -8
  1436. data/docs/CouponTieredPercentOffSubtotalBasedOnMSRP.md +0 -9
  1437. data/docs/CustomerEDI.md +0 -10
  1438. data/docs/CustomerMagicLinkResponse.md +0 -12
  1439. data/docs/CustomerMergeRequest.md +0 -9
  1440. data/docs/CustomerProperty.md +0 -11
  1441. data/docs/CustomerWishListItem.md +0 -14
  1442. data/docs/CustomerWishListItemResponse.md +0 -12
  1443. data/docs/CustomerWishListItemsResponse.md +0 -12
  1444. data/docs/DatawarehouseApi.md +0 -512
  1445. data/docs/EmailCommseqSequenceTestRequest.md +0 -22
  1446. data/docs/EmailCommseqSequenceTestResponse.md +0 -11
  1447. data/docs/EmailCommseqSmsSendTestRequest.md +0 -10
  1448. data/docs/EmailCommseqSmsSendTestResponse.md +0 -13
  1449. data/docs/EmailPostcardTracking.md +0 -32
  1450. data/docs/EmailPostcardTrackingResponse.md +0 -12
  1451. data/docs/EmailRateLimiter.md +0 -10
  1452. data/docs/EmailRateLimitersResponse.md +0 -12
  1453. data/docs/EmailSmsOrder.md +0 -11
  1454. data/docs/EmailSmsOrdersResponse.md +0 -12
  1455. data/docs/EmailSmsStat.md +0 -37
  1456. data/docs/EmailStatSmsSummaryRequest.md +0 -9
  1457. data/docs/EmailStatSmsSummaryResponse.md +0 -12
  1458. data/docs/FileManagerDirectory.md +0 -20
  1459. data/docs/FileManagerFile.md +0 -29
  1460. data/docs/FileManagerPage.md +0 -15
  1461. data/docs/FileManagerPageResponse.md +0 -12
  1462. data/docs/FileManagerUploadRequest.md +0 -10
  1463. data/docs/FileManagerUploadUrlResponse.md +0 -13
  1464. data/docs/HitPageView.md +0 -18
  1465. data/docs/HitPageViewMetaData.md +0 -9
  1466. data/docs/HitSessionStart.md +0 -24
  1467. data/docs/HitSessionUtm.md +0 -22
  1468. data/docs/ItemDigitalItemPdfMeta.md +0 -18
  1469. data/docs/ItemDigitalItemResponse.md +0 -12
  1470. data/docs/ItemDigitalItemsResponse.md +0 -12
  1471. data/docs/ItemInventorySnapshot.md +0 -13
  1472. data/docs/ItemInventorySnapshotDistributionCenter.md +0 -12
  1473. data/docs/ItemInventorySnapshotResponse.md +0 -12
  1474. data/docs/ItemReview.md +0 -45
  1475. data/docs/ItemReviewResponse.md +0 -12
  1476. data/docs/ItemReviewsResponse.md +0 -12
  1477. data/docs/OrderCurrentStageHistory.md +0 -10
  1478. data/docs/OrderEdiDocument.md +0 -21
  1479. data/docs/OrderEdiDocumentsResponse.md +0 -12
  1480. data/docs/OrderInvoiceResponse.md +0 -12
  1481. data/docs/OrderPaymentCreditCardDualVaulted.md +0 -10
  1482. data/docs/OrderPaymentCreditCardDualVaultedProperty.md +0 -9
  1483. data/docs/OrderPaymentHealthBenefitCard.md +0 -13
  1484. data/docs/OrderPaymentPayPal.md +0 -9
  1485. data/docs/OrderPointOfSale.md +0 -10
  1486. data/docs/OrderReason.md +0 -10
  1487. data/docs/OrderRefundableResponse.md +0 -20
  1488. data/docs/OrderTransactionalMerchantNote.md +0 -11
  1489. data/docs/OrderUtm.md +0 -39
  1490. data/docs/OrderValidationRequest.md +0 -9
  1491. data/docs/OrderValidationResponse.md +0 -10
  1492. data/docs/PointOfSaleLocation.md +0 -17
  1493. data/docs/PointOfSaleReader.md +0 -16
  1494. data/docs/PointOfSaleRegister.md +0 -11
  1495. data/docs/Report.md +0 -18
  1496. data/docs/ReportAuth.md +0 -11
  1497. data/docs/ReportAuthResponse.md +0 -12
  1498. data/docs/ReportDataSet.md +0 -24
  1499. data/docs/ReportDataSetColumn.md +0 -13
  1500. data/docs/ReportDataSetPage.md +0 -17
  1501. data/docs/ReportDataSetPageResponse.md +0 -12
  1502. data/docs/ReportDataSetQuery.md +0 -20
  1503. data/docs/ReportDataSetQueryOrderByColumn.md +0 -9
  1504. data/docs/ReportDataSetResponse.md +0 -12
  1505. data/docs/ReportDataSetRow.md +0 -8
  1506. data/docs/ReportDataSetSchema.md +0 -10
  1507. data/docs/ReportDataSource.md +0 -14
  1508. data/docs/ReportDataSourceSchema.md +0 -11
  1509. data/docs/ReportDryRunQueriesRequest.md +0 -13
  1510. data/docs/ReportDryRunQueriesResponse.md +0 -8
  1511. data/docs/ReportDryRunQueryResult.md +0 -9
  1512. data/docs/ReportExecuteQueriesRequest.md +0 -15
  1513. data/docs/ReportFilter.md +0 -13
  1514. data/docs/ReportFilterConnection.md +0 -10
  1515. data/docs/ReportPage.md +0 -13
  1516. data/docs/ReportPageFilter.md +0 -11
  1517. data/docs/ReportPageVisualization.md +0 -17
  1518. data/docs/ReportPageVisualizationDimension.md +0 -14
  1519. data/docs/ReportPageVisualizationMetric.md +0 -11
  1520. data/docs/ReportResponse.md +0 -12
  1521. data/docs/ReportWebsocketEvent.md +0 -9
  1522. data/docs/ReportsResponse.md +0 -12
  1523. data/docs/RulerValidationRequest.md +0 -8
  1524. data/docs/RulerValidationResponse.md +0 -9
  1525. data/docs/StoreFront.md +0 -18
  1526. data/docs/StoreFrontPageContentAttribute.md +0 -11
  1527. data/docs/StoreFrontsResponse.md +0 -12
  1528. data/docs/WebhookReflow.md +0 -9
  1529. data/docs/WebhookReflowResponse.md +0 -12
  1530. data/docs/WorkflowAgentAuth.md +0 -10
  1531. data/docs/WorkflowAgentAuthResponse.md +0 -12
  1532. data/docs/WorkflowApi.md +0 -620
  1533. data/docs/WorkflowAttachment.md +0 -12
  1534. data/docs/WorkflowAttachmentUploadUrl.md +0 -9
  1535. data/docs/WorkflowAttachmentUploadUrlResponse.md +0 -12
  1536. data/docs/WorkflowGroup.md +0 -9
  1537. data/docs/WorkflowGroupsResponse.md +0 -12
  1538. data/docs/WorkflowNote.md +0 -13
  1539. data/docs/WorkflowTask.md +0 -39
  1540. data/docs/WorkflowTaskHistory.md +0 -11
  1541. data/docs/WorkflowTaskOpenCountResponse.md +0 -12
  1542. data/docs/WorkflowTaskResponse.md +0 -12
  1543. data/docs/WorkflowTaskTagsResponse.md +0 -12
  1544. data/docs/WorkflowTasksRequest.md +0 -27
  1545. data/docs/WorkflowTasksResponse.md +0 -13
  1546. data/docs/WorkflowUser.md +0 -10
  1547. data/docs/WorkflowUserResponse.md +0 -12
  1548. data/docs/WorkflowUsersResponse.md +0 -13
  1549. data/lib/ultracart_api/api/conversation_api.rb +0 -4632
  1550. data/lib/ultracart_api/api/datawarehouse_api.rb +0 -584
  1551. data/lib/ultracart_api/api/workflow_api.rb +0 -693
  1552. data/lib/ultracart_api/models/accounts_receivable_retry_transaction_reject.rb +0 -195
  1553. data/lib/ultracart_api/models/auto_order_addon_item.rb +0 -232
  1554. data/lib/ultracart_api/models/auto_order_addon_item_option.rb +0 -225
  1555. data/lib/ultracart_api/models/auto_order_consolidate.rb +0 -186
  1556. data/lib/ultracart_api/models/auto_order_management.rb +0 -185
  1557. data/lib/ultracart_api/models/cart_item_property.rb +0 -245
  1558. data/lib/ultracart_api/models/cart_payment_health_benefit_card.rb +0 -235
  1559. data/lib/ultracart_api/models/chanel_partner_reason_codes_response.rb +0 -290
  1560. data/lib/ultracart_api/models/channel_partner.rb +0 -255
  1561. data/lib/ultracart_api/models/channel_partner_order_item_property.rb +0 -245
  1562. data/lib/ultracart_api/models/channel_partner_ship_to_preference.rb +0 -262
  1563. data/lib/ultracart_api/models/channel_partner_ship_to_preference_response.rb +0 -221
  1564. data/lib/ultracart_api/models/channel_partner_ship_to_preferences_response.rb +0 -224
  1565. data/lib/ultracart_api/models/channel_partners_response.rb +0 -224
  1566. data/lib/ultracart_api/models/conversation.rb +0 -390
  1567. data/lib/ultracart_api/models/conversation_agent_auth.rb +0 -316
  1568. data/lib/ultracart_api/models/conversation_agent_auth_response.rb +0 -221
  1569. data/lib/ultracart_api/models/conversation_agent_profile.rb +0 -329
  1570. data/lib/ultracart_api/models/conversation_agent_profile_response.rb +0 -221
  1571. data/lib/ultracart_api/models/conversation_agent_profiles_response.rb +0 -223
  1572. data/lib/ultracart_api/models/conversation_autocomplete_request.rb +0 -193
  1573. data/lib/ultracart_api/models/conversation_autocomplete_response.rb +0 -241
  1574. data/lib/ultracart_api/models/conversation_autocomplete_value.rb +0 -193
  1575. data/lib/ultracart_api/models/conversation_canned_message.rb +0 -213
  1576. data/lib/ultracart_api/models/conversation_canned_message_response.rb +0 -221
  1577. data/lib/ultracart_api/models/conversation_canned_messages_response.rb +0 -223
  1578. data/lib/ultracart_api/models/conversation_canned_messages_search.rb +0 -193
  1579. data/lib/ultracart_api/models/conversation_department.rb +0 -222
  1580. data/lib/ultracart_api/models/conversation_department_member.rb +0 -202
  1581. data/lib/ultracart_api/models/conversation_department_members_response.rb +0 -223
  1582. data/lib/ultracart_api/models/conversation_department_response.rb +0 -221
  1583. data/lib/ultracart_api/models/conversation_department_settings.rb +0 -175
  1584. data/lib/ultracart_api/models/conversation_departments_response.rb +0 -223
  1585. data/lib/ultracart_api/models/conversation_engagement.rb +0 -293
  1586. data/lib/ultracart_api/models/conversation_engagement_equation.rb +0 -186
  1587. data/lib/ultracart_api/models/conversation_engagement_equation_function.rb +0 -414
  1588. data/lib/ultracart_api/models/conversation_engagement_equation_group.rb +0 -186
  1589. data/lib/ultracart_api/models/conversation_engagement_response.rb +0 -221
  1590. data/lib/ultracart_api/models/conversation_engagements_response.rb +0 -223
  1591. data/lib/ultracart_api/models/conversation_event_add_coupon.rb +0 -202
  1592. data/lib/ultracart_api/models/conversation_event_add_item.rb +0 -204
  1593. data/lib/ultracart_api/models/conversation_event_queue_position.rb +0 -195
  1594. data/lib/ultracart_api/models/conversation_event_read_message.rb +0 -203
  1595. data/lib/ultracart_api/models/conversation_event_rr_web.rb +0 -273
  1596. data/lib/ultracart_api/models/conversation_event_typing.rb +0 -202
  1597. data/lib/ultracart_api/models/conversation_event_webchat_context.rb +0 -202
  1598. data/lib/ultracart_api/models/conversation_join_request.rb +0 -184
  1599. data/lib/ultracart_api/models/conversation_location_country.rb +0 -204
  1600. data/lib/ultracart_api/models/conversation_location_state_province.rb +0 -193
  1601. data/lib/ultracart_api/models/conversation_locations_response.rb +0 -223
  1602. data/lib/ultracart_api/models/conversation_message.rb +0 -356
  1603. data/lib/ultracart_api/models/conversation_message_translation.rb +0 -193
  1604. data/lib/ultracart_api/models/conversation_message_transport_status.rb +0 -228
  1605. data/lib/ultracart_api/models/conversation_messages_response.rb +0 -223
  1606. data/lib/ultracart_api/models/conversation_multimedia_upload_url.rb +0 -193
  1607. data/lib/ultracart_api/models/conversation_multimedia_upload_url_response.rb +0 -221
  1608. data/lib/ultracart_api/models/conversation_participant.rb +0 -295
  1609. data/lib/ultracart_api/models/conversation_pbx_agent.rb +0 -440
  1610. data/lib/ultracart_api/models/conversation_pbx_agent_response.rb +0 -221
  1611. data/lib/ultracart_api/models/conversation_pbx_agents_response.rb +0 -223
  1612. data/lib/ultracart_api/models/conversation_pbx_audio.rb +0 -365
  1613. data/lib/ultracart_api/models/conversation_pbx_audio_response.rb +0 -221
  1614. data/lib/ultracart_api/models/conversation_pbx_audio_upload_url.rb +0 -193
  1615. data/lib/ultracart_api/models/conversation_pbx_audio_upload_url_response.rb +0 -221
  1616. data/lib/ultracart_api/models/conversation_pbx_audios_response.rb +0 -223
  1617. data/lib/ultracart_api/models/conversation_pbx_customer_snapshot_request.rb +0 -248
  1618. data/lib/ultracart_api/models/conversation_pbx_customer_snapshot_response.rb +0 -245
  1619. data/lib/ultracart_api/models/conversation_pbx_menu.rb +0 -416
  1620. data/lib/ultracart_api/models/conversation_pbx_menu_mapping.rb +0 -269
  1621. data/lib/ultracart_api/models/conversation_pbx_menu_response.rb +0 -221
  1622. data/lib/ultracart_api/models/conversation_pbx_menus_response.rb +0 -223
  1623. data/lib/ultracart_api/models/conversation_pbx_phone_number.rb +0 -324
  1624. data/lib/ultracart_api/models/conversation_pbx_phone_number_response.rb +0 -221
  1625. data/lib/ultracart_api/models/conversation_pbx_phone_numbers_response.rb +0 -223
  1626. data/lib/ultracart_api/models/conversation_pbx_queue.rb +0 -534
  1627. data/lib/ultracart_api/models/conversation_pbx_queue_members.rb +0 -197
  1628. data/lib/ultracart_api/models/conversation_pbx_queue_response.rb +0 -221
  1629. data/lib/ultracart_api/models/conversation_pbx_queues_response.rb +0 -223
  1630. data/lib/ultracart_api/models/conversation_pbx_time_based.rb +0 -211
  1631. data/lib/ultracart_api/models/conversation_pbx_time_based_mapping.rb +0 -299
  1632. data/lib/ultracart_api/models/conversation_pbx_time_based_mapping_config.rb +0 -196
  1633. data/lib/ultracart_api/models/conversation_pbx_time_based_response.rb +0 -221
  1634. data/lib/ultracart_api/models/conversation_pbx_time_baseds_response.rb +0 -223
  1635. data/lib/ultracart_api/models/conversation_pbx_time_range.rb +0 -287
  1636. data/lib/ultracart_api/models/conversation_pbx_time_range_config.rb +0 -235
  1637. data/lib/ultracart_api/models/conversation_pbx_time_range_response.rb +0 -221
  1638. data/lib/ultracart_api/models/conversation_pbx_time_ranges_response.rb +0 -223
  1639. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb +0 -458
  1640. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox_response.rb +0 -221
  1641. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailboxes_response.rb +0 -223
  1642. data/lib/ultracart_api/models/conversation_pbx_voicemail_message.rb +0 -339
  1643. data/lib/ultracart_api/models/conversation_pbx_voicemail_message_response.rb +0 -221
  1644. data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summaries_response.rb +0 -223
  1645. data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summary.rb +0 -309
  1646. data/lib/ultracart_api/models/conversation_permissions.rb +0 -184
  1647. data/lib/ultracart_api/models/conversation_permissions_response.rb +0 -221
  1648. data/lib/ultracart_api/models/conversation_response.rb +0 -221
  1649. data/lib/ultracart_api/models/conversation_search_request.rb +0 -285
  1650. data/lib/ultracart_api/models/conversation_search_response.rb +0 -213
  1651. data/lib/ultracart_api/models/conversation_sentiment.rb +0 -269
  1652. data/lib/ultracart_api/models/conversation_start_request.rb +0 -204
  1653. data/lib/ultracart_api/models/conversation_start_response.rb +0 -184
  1654. data/lib/ultracart_api/models/conversation_summary.rb +0 -369
  1655. data/lib/ultracart_api/models/conversation_twilio_account.rb +0 -195
  1656. data/lib/ultracart_api/models/conversation_webchat_context.rb +0 -254
  1657. data/lib/ultracart_api/models/conversation_webchat_queue_status.rb +0 -315
  1658. data/lib/ultracart_api/models/conversation_webchat_queue_status_agent.rb +0 -266
  1659. data/lib/ultracart_api/models/conversation_webchat_queue_status_queue_entry.rb +0 -248
  1660. data/lib/ultracart_api/models/conversation_webchat_queue_status_update_request.rb +0 -219
  1661. data/lib/ultracart_api/models/conversation_webchat_queue_statuses_response.rb +0 -223
  1662. data/lib/ultracart_api/models/conversation_websocket_message.rb +0 -441
  1663. data/lib/ultracart_api/models/conversations_response.rb +0 -223
  1664. data/lib/ultracart_api/models/coupon_free_item_with_item_purchase_and_free_shipping.rb +0 -219
  1665. data/lib/ultracart_api/models/coupon_more_loyalty_cashback.rb +0 -185
  1666. data/lib/ultracart_api/models/coupon_more_loyalty_points.rb +0 -185
  1667. data/lib/ultracart_api/models/coupon_no_discount.rb +0 -185
  1668. data/lib/ultracart_api/models/coupon_percent_more_loyalty_cashback.rb +0 -185
  1669. data/lib/ultracart_api/models/coupon_percent_more_loyalty_points.rb +0 -185
  1670. data/lib/ultracart_api/models/coupon_tiered_percent_off_subtotal_based_on_msrp.rb +0 -199
  1671. data/lib/ultracart_api/models/customer_edi.rb +0 -205
  1672. data/lib/ultracart_api/models/customer_magic_link_response.rb +0 -222
  1673. data/lib/ultracart_api/models/customer_merge_request.rb +0 -195
  1674. data/lib/ultracart_api/models/customer_property.rb +0 -245
  1675. data/lib/ultracart_api/models/customer_wish_list_item.rb +0 -260
  1676. data/lib/ultracart_api/models/customer_wish_list_item_response.rb +0 -221
  1677. data/lib/ultracart_api/models/email_commseq_sequence_test_request.rb +0 -312
  1678. data/lib/ultracart_api/models/email_commseq_sequence_test_response.rb +0 -212
  1679. data/lib/ultracart_api/models/email_commseq_sms_send_test_request.rb +0 -202
  1680. data/lib/ultracart_api/models/email_commseq_sms_send_test_response.rb +0 -232
  1681. data/lib/ultracart_api/models/email_postcard_tracking.rb +0 -404
  1682. data/lib/ultracart_api/models/email_postcard_tracking_response.rb +0 -221
  1683. data/lib/ultracart_api/models/email_rate_limiter.rb +0 -202
  1684. data/lib/ultracart_api/models/email_rate_limiters_response.rb +0 -223
  1685. data/lib/ultracart_api/models/email_sms_order.rb +0 -214
  1686. data/lib/ultracart_api/models/email_sms_orders_response.rb +0 -223
  1687. data/lib/ultracart_api/models/email_sms_stat.rb +0 -476
  1688. data/lib/ultracart_api/models/email_stat_sms_summary_request.rb +0 -195
  1689. data/lib/ultracart_api/models/email_stat_sms_summary_response.rb +0 -223
  1690. data/lib/ultracart_api/models/file_manager_directory.rb +0 -292
  1691. data/lib/ultracart_api/models/file_manager_file.rb +0 -376
  1692. data/lib/ultracart_api/models/file_manager_page.rb +0 -253
  1693. data/lib/ultracart_api/models/file_manager_page_response.rb +0 -221
  1694. data/lib/ultracart_api/models/file_manager_upload_request.rb +0 -202
  1695. data/lib/ultracart_api/models/file_manager_upload_url_response.rb +0 -230
  1696. data/lib/ultracart_api/models/hit_page_view.rb +0 -276
  1697. data/lib/ultracart_api/models/hit_page_view_meta_data.rb +0 -193
  1698. data/lib/ultracart_api/models/hit_session_start.rb +0 -328
  1699. data/lib/ultracart_api/models/hit_session_utm.rb +0 -310
  1700. data/lib/ultracart_api/models/item_digital_item_pdf_meta.rb +0 -315
  1701. data/lib/ultracart_api/models/item_digital_item_response.rb +0 -221
  1702. data/lib/ultracart_api/models/item_digital_items_response.rb +0 -224
  1703. data/lib/ultracart_api/models/item_inventory_snapshot.rb +0 -231
  1704. data/lib/ultracart_api/models/item_inventory_snapshot_distribution_center.rb +0 -220
  1705. data/lib/ultracart_api/models/item_inventory_snapshot_response.rb +0 -224
  1706. data/lib/ultracart_api/models/item_review.rb +0 -826
  1707. data/lib/ultracart_api/models/item_review_response.rb +0 -221
  1708. data/lib/ultracart_api/models/item_reviews_response.rb +0 -224
  1709. data/lib/ultracart_api/models/order_current_stage_history.rb +0 -251
  1710. data/lib/ultracart_api/models/order_edi_document.rb +0 -337
  1711. data/lib/ultracart_api/models/order_edi_documents_response.rb +0 -224
  1712. data/lib/ultracart_api/models/order_invoice_response.rb +0 -222
  1713. data/lib/ultracart_api/models/order_payment_credit_card_dual_vaulted.rb +0 -204
  1714. data/lib/ultracart_api/models/order_payment_credit_card_dual_vaulted_property.rb +0 -193
  1715. data/lib/ultracart_api/models/order_payment_health_benefit_card.rb +0 -235
  1716. data/lib/ultracart_api/models/order_payment_pay_pal.rb +0 -195
  1717. data/lib/ultracart_api/models/order_point_of_sale.rb +0 -202
  1718. data/lib/ultracart_api/models/order_reason.rb +0 -205
  1719. data/lib/ultracart_api/models/order_refundable_response.rb +0 -310
  1720. data/lib/ultracart_api/models/order_transactional_merchant_note.rb +0 -215
  1721. data/lib/ultracart_api/models/order_utm.rb +0 -464
  1722. data/lib/ultracart_api/models/order_validation_request.rb +0 -196
  1723. data/lib/ultracart_api/models/order_validation_response.rb +0 -209
  1724. data/lib/ultracart_api/models/point_of_sale_location.rb +0 -290
  1725. data/lib/ultracart_api/models/point_of_sale_reader.rb +0 -299
  1726. data/lib/ultracart_api/models/point_of_sale_register.rb +0 -215
  1727. data/lib/ultracart_api/models/report.rb +0 -317
  1728. data/lib/ultracart_api/models/report_auth.rb +0 -212
  1729. data/lib/ultracart_api/models/report_auth_response.rb +0 -221
  1730. data/lib/ultracart_api/models/report_data_set.rb +0 -381
  1731. data/lib/ultracart_api/models/report_data_set_column.rb +0 -229
  1732. data/lib/ultracart_api/models/report_data_set_page.rb +0 -273
  1733. data/lib/ultracart_api/models/report_data_set_page_response.rb +0 -221
  1734. data/lib/ultracart_api/models/report_data_set_query.rb +0 -342
  1735. data/lib/ultracart_api/models/report_data_set_query_order_by_column.rb +0 -193
  1736. data/lib/ultracart_api/models/report_data_set_response.rb +0 -221
  1737. data/lib/ultracart_api/models/report_data_set_row.rb +0 -186
  1738. data/lib/ultracart_api/models/report_data_set_schema.rb +0 -238
  1739. data/lib/ultracart_api/models/report_data_source.rb +0 -242
  1740. data/lib/ultracart_api/models/report_data_source_schema.rb +0 -248
  1741. data/lib/ultracart_api/models/report_dry_run_queries_request.rb +0 -231
  1742. data/lib/ultracart_api/models/report_dry_run_queries_response.rb +0 -186
  1743. data/lib/ultracart_api/models/report_dry_run_query_result.rb +0 -193
  1744. data/lib/ultracart_api/models/report_execute_queries_request.rb +0 -288
  1745. data/lib/ultracart_api/models/report_filter.rb +0 -272
  1746. data/lib/ultracart_api/models/report_filter_connection.rb +0 -203
  1747. data/lib/ultracart_api/models/report_page.rb +0 -237
  1748. data/lib/ultracart_api/models/report_page_filter.rb +0 -214
  1749. data/lib/ultracart_api/models/report_page_visualization.rb +0 -309
  1750. data/lib/ultracart_api/models/report_page_visualization_dimension.rb +0 -244
  1751. data/lib/ultracart_api/models/report_page_visualization_metric.rb +0 -248
  1752. data/lib/ultracart_api/models/report_response.rb +0 -221
  1753. data/lib/ultracart_api/models/report_websocket_event.rb +0 -228
  1754. data/lib/ultracart_api/models/reports_response.rb +0 -223
  1755. data/lib/ultracart_api/models/ruler_validation_request.rb +0 -184
  1756. data/lib/ultracart_api/models/ruler_validation_response.rb +0 -193
  1757. data/lib/ultracart_api/models/store_front.rb +0 -274
  1758. data/lib/ultracart_api/models/store_front_page_content_attribute.rb +0 -245
  1759. data/lib/ultracart_api/models/store_fronts_response.rb +0 -223
  1760. data/lib/ultracart_api/models/webhook_reflow.rb +0 -193
  1761. data/lib/ultracart_api/models/webhook_reflow_response.rb +0 -221
  1762. data/lib/ultracart_api/models/workflow_agent_auth.rb +0 -202
  1763. data/lib/ultracart_api/models/workflow_agent_auth_response.rb +0 -221
  1764. data/lib/ultracart_api/models/workflow_attachment.rb +0 -225
  1765. data/lib/ultracart_api/models/workflow_attachment_upload_url.rb +0 -193
  1766. data/lib/ultracart_api/models/workflow_attachment_upload_url_response.rb +0 -221
  1767. data/lib/ultracart_api/models/workflow_group.rb +0 -195
  1768. data/lib/ultracart_api/models/workflow_groups_response.rb +0 -224
  1769. data/lib/ultracart_api/models/workflow_note.rb +0 -236
  1770. data/lib/ultracart_api/models/workflow_task.rb +0 -574
  1771. data/lib/ultracart_api/models/workflow_task_history.rb +0 -214
  1772. data/lib/ultracart_api/models/workflow_task_open_count_response.rb +0 -222
  1773. data/lib/ultracart_api/models/workflow_task_response.rb +0 -221
  1774. data/lib/ultracart_api/models/workflow_task_tags_response.rb +0 -224
  1775. data/lib/ultracart_api/models/workflow_tasks_request.rb +0 -434
  1776. data/lib/ultracart_api/models/workflow_tasks_response.rb +0 -234
  1777. data/lib/ultracart_api/models/workflow_user.rb +0 -205
  1778. data/lib/ultracart_api/models/workflow_user_response.rb +0 -221
  1779. data/lib/ultracart_api/models/workflow_users_response.rb +0 -234
@@ -1,4245 +0,0 @@
1
- # UltracartClient::ConversationApi
2
-
3
- All URIs are relative to *https://secure.ultracart.com/rest/v2*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**delete_conversation_canned_message**](ConversationApi.md#delete_conversation_canned_message) | **DELETE** /conversation/canned_messages/{conversation_canned_message_oid} | Delete a conversation canned message
8
- [**delete_department**](ConversationApi.md#delete_department) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department
9
- [**delete_engagement**](ConversationApi.md#delete_engagement) | **DELETE** /conversation/engagements/{conversation_engagement_oid} | Delete a conversation engagement
10
- [**delete_pbx_agent_voicemail**](ConversationApi.md#delete_pbx_agent_voicemail) | **DELETE** /conversation/pbx/agent/voicemails/{recording_sid} | Delete Agent Voicemail
11
- [**delete_pbx_audio**](ConversationApi.md#delete_pbx_audio) | **DELETE** /conversation/pbx/audio/{conversationPbxAudioUuid} | Delete pbx audio
12
- [**delete_pbx_menu**](ConversationApi.md#delete_pbx_menu) | **DELETE** /conversation/pbx/menu/{conversationPbxMenuUuid} | Delete pbx menu
13
- [**delete_pbx_queue**](ConversationApi.md#delete_pbx_queue) | **DELETE** /conversation/pbx/queue/{conversationPbxQueueUuid} | Delete pbx queue
14
- [**delete_pbx_queue_voicemail**](ConversationApi.md#delete_pbx_queue_voicemail) | **DELETE** /conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid} | Delete Queue Voicemail
15
- [**delete_pbx_time_based**](ConversationApi.md#delete_pbx_time_based) | **DELETE** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Delete pbx timeBased
16
- [**delete_pbx_time_range**](ConversationApi.md#delete_pbx_time_range) | **DELETE** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Delete pbx timeRange
17
- [**delete_pbx_voicemail_mailbox**](ConversationApi.md#delete_pbx_voicemail_mailbox) | **DELETE** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Delete pbx voicemailMailbox
18
- [**get_agent_keep_alive**](ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
19
- [**get_agent_profile**](ConversationApi.md#get_agent_profile) | **GET** /conversation/agent/profile | Get agent profile
20
- [**get_agent_profiles**](ConversationApi.md#get_agent_profiles) | **GET** /conversation/agent/profiles | Get agent profiles
21
- [**get_agent_websocket_authorization**](ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
22
- [**get_conversation**](ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
23
- [**get_conversation_canned_messages**](ConversationApi.md#get_conversation_canned_messages) | **GET** /conversation/canned_messages | Retrieve a list of canned messages ordered by short_code
24
- [**get_conversation_context**](ConversationApi.md#get_conversation_context) | **PUT** /conversation/conversations/{conversation_uuid}/context | Get a webchat conversation context
25
- [**get_conversation_department_member_list**](ConversationApi.md#get_conversation_department_member_list) | **GET** /conversation/department_members | Retrieve a list of possible department members
26
- [**get_conversation_departments**](ConversationApi.md#get_conversation_departments) | **GET** /conversation/departments | Retrieve a list of departments ordered by name
27
- [**get_conversation_engagement**](ConversationApi.md#get_conversation_engagement) | **GET** /conversation/engagements/{conversation_engagement_oid} | Retrieve an engagement
28
- [**get_conversation_engagements**](ConversationApi.md#get_conversation_engagements) | **GET** /conversation/engagements | Retrieve a list of engagements ordered by name
29
- [**get_conversation_messages**](ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
30
- [**get_conversation_multimedia_upload_url**](ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conversation multimedia upload URL
31
- [**get_conversation_pbx_audio_upload_url**](ConversationApi.md#get_conversation_pbx_audio_upload_url) | **GET** /conversation/pbx/audio/upload_url/{extension} | Get a pre-signed conversation multimedia upload URL
32
- [**get_conversation_pbx_customer_snapshot**](ConversationApi.md#get_conversation_pbx_customer_snapshot) | **POST** /conversation/pbx/customer_snapshot | Get orders and customer information for a phone number
33
- [**get_conversation_permissions**](ConversationApi.md#get_conversation_permissions) | **GET** /conversation/permissions | Retrieve conversation permissions
34
- [**get_conversation_webchat_queue_statuses**](ConversationApi.md#get_conversation_webchat_queue_statuses) | **GET** /conversation/conversations/queues/statuses | Retrieve a conversation webchat queue statuses
35
- [**get_conversations**](ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
36
- [**get_conversations_autocomplete**](ConversationApi.md#get_conversations_autocomplete) | **POST** /conversation/conversations/autocomplete | Retrieve a list of matching terms for a search field
37
- [**get_conversations_search**](ConversationApi.md#get_conversations_search) | **POST** /conversation/conversations/search | Search conversations
38
- [**get_locations_for_engagement**](ConversationApi.md#get_locations_for_engagement) | **POST** /conversation/locations | Get location data for engagement configuration
39
- [**get_pbx_agent**](ConversationApi.md#get_pbx_agent) | **GET** /conversation/pbx/agent/{conversationPbxAgentUuid} | Get pbx agent
40
- [**get_pbx_agent_voicemail**](ConversationApi.md#get_pbx_agent_voicemail) | **GET** /conversation/pbx/agent/voicemails/{recording_sid} | Get Agent Voicemail
41
- [**get_pbx_agent_voicemails**](ConversationApi.md#get_pbx_agent_voicemails) | **GET** /conversation/pbx/agent/voicemails | Get Agent Voicemails
42
- [**get_pbx_agents**](ConversationApi.md#get_pbx_agents) | **GET** /conversation/pbx/agent | Get pbx agents
43
- [**get_pbx_audio**](ConversationApi.md#get_pbx_audio) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid} | Get pbx audio
44
- [**get_pbx_audio_usage**](ConversationApi.md#get_pbx_audio_usage) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid}/usage | Get pbx audio usage
45
- [**get_pbx_audios**](ConversationApi.md#get_pbx_audios) | **GET** /conversation/pbx/audio | Get pbx audios
46
- [**get_pbx_menu**](ConversationApi.md#get_pbx_menu) | **GET** /conversation/pbx/menu/{conversationPbxMenuUuid} | Get pbx menu
47
- [**get_pbx_menus**](ConversationApi.md#get_pbx_menus) | **GET** /conversation/pbx/menu | Get pbx menus
48
- [**get_pbx_phone_number**](ConversationApi.md#get_pbx_phone_number) | **GET** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Get pbx phoneNumber
49
- [**get_pbx_phone_numbers**](ConversationApi.md#get_pbx_phone_numbers) | **GET** /conversation/pbx/phone_number | Get pbx phoneNumbers
50
- [**get_pbx_queue**](ConversationApi.md#get_pbx_queue) | **GET** /conversation/pbx/queue/{conversationPbxQueueUuid} | Get pbx queue
51
- [**get_pbx_queue_voicemail**](ConversationApi.md#get_pbx_queue_voicemail) | **GET** /conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid} | Get Queue Voicemail
52
- [**get_pbx_queue_voicemails**](ConversationApi.md#get_pbx_queue_voicemails) | **GET** /conversation/pbx/queues/{queue_uuid}/voicemails | Get Queue Voicemails
53
- [**get_pbx_queues**](ConversationApi.md#get_pbx_queues) | **GET** /conversation/pbx/queue | Get pbx queues
54
- [**get_pbx_time_based**](ConversationApi.md#get_pbx_time_based) | **GET** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Get pbx timeBased
55
- [**get_pbx_time_baseds**](ConversationApi.md#get_pbx_time_baseds) | **GET** /conversation/pbx/time_based | Get pbx timeBaseds
56
- [**get_pbx_time_range**](ConversationApi.md#get_pbx_time_range) | **GET** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Get pbx timeRange
57
- [**get_pbx_time_ranges**](ConversationApi.md#get_pbx_time_ranges) | **GET** /conversation/pbx/time_range | Get pbx timeRanges
58
- [**get_pbx_voicemail_mailbox**](ConversationApi.md#get_pbx_voicemail_mailbox) | **GET** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Get pbx voicemailMailbox
59
- [**get_pbx_voicemail_mailboxes**](ConversationApi.md#get_pbx_voicemail_mailboxes) | **GET** /conversation/pbx/voicemail_mailbox | Get pbx voicemailMailboxes
60
- [**insert_conversation_canned_message**](ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message
61
- [**insert_conversation_department**](ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department
62
- [**insert_conversation_engagement**](ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement
63
- [**insert_pbx_audio**](ConversationApi.md#insert_pbx_audio) | **POST** /conversation/pbx/audio | Insert pbx audio
64
- [**insert_pbx_menu**](ConversationApi.md#insert_pbx_menu) | **POST** /conversation/pbx/menu | Insert pbx menu
65
- [**insert_pbx_queue**](ConversationApi.md#insert_pbx_queue) | **POST** /conversation/pbx/queue | Insert pbx queue
66
- [**insert_pbx_time_based**](ConversationApi.md#insert_pbx_time_based) | **POST** /conversation/pbx/time_based | Insert pbx timeBased
67
- [**insert_pbx_time_range**](ConversationApi.md#insert_pbx_time_range) | **POST** /conversation/pbx/time_range | Insert pbx timeRange
68
- [**insert_pbx_voicemail_mailbox**](ConversationApi.md#insert_pbx_voicemail_mailbox) | **POST** /conversation/pbx/voicemail_mailbox | Insert pbx voicemailMailbox
69
- [**join_conversation**](ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
70
- [**leave_conversation**](ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
71
- [**listened_pbx_agent_voicemail**](ConversationApi.md#listened_pbx_agent_voicemail) | **GET** /conversation/pbx/agent/voicemails/{recording_sid}/listened | Listened Agent Voicemail
72
- [**listened_pbx_queue_voicemail**](ConversationApi.md#listened_pbx_queue_voicemail) | **GET** /conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid}/listened | Listened Queue Voicemail
73
- [**mark_read_conversation**](ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
74
- [**reset_conversation_pbx_queue_statistics**](ConversationApi.md#reset_conversation_pbx_queue_statistics) | **POST** /conversation/pbx/queues/{queue_uuid}/reset_statistics | reset statistics within the queue
75
- [**search_conversation_canned_messages**](ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code
76
- [**sms_unsubscribe_conversation**](ConversationApi.md#sms_unsubscribe_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/sms_unsubscribe | Unsubscribe any SMS participants in this conversation
77
- [**start_conversation**](ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
78
- [**update_agent_profile**](ConversationApi.md#update_agent_profile) | **PUT** /conversation/agent/profile | Update agent profile
79
- [**update_conversation_canned_message**](ConversationApi.md#update_conversation_canned_message) | **PUT** /conversation/canned_messages/{conversation_canned_message_oid} | Update a canned message
80
- [**update_conversation_department**](ConversationApi.md#update_conversation_department) | **PUT** /conversation/departments/{conversation_department_oid} | Update a department
81
- [**update_conversation_engagement**](ConversationApi.md#update_conversation_engagement) | **PUT** /conversation/engagements/{conversation_engagement_oid} | Update a engagement
82
- [**update_conversation_webchat_queue_status**](ConversationApi.md#update_conversation_webchat_queue_status) | **PUT** /conversation/conversations/queues/{queue_name}/status | Update status within the queue
83
- [**update_pbx_agent**](ConversationApi.md#update_pbx_agent) | **PUT** /conversation/pbx/agent/{conversationPbxAgentUuid} | Update pbx agent
84
- [**update_pbx_audio**](ConversationApi.md#update_pbx_audio) | **PUT** /conversation/pbx/audio/{conversationPbxAudioUuid} | Update pbx audio
85
- [**update_pbx_menu**](ConversationApi.md#update_pbx_menu) | **PUT** /conversation/pbx/menu/{conversationPbxMenuUuid} | Update pbx menu
86
- [**update_pbx_phone_number**](ConversationApi.md#update_pbx_phone_number) | **PUT** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Update pbx phoneNumber
87
- [**update_pbx_queue**](ConversationApi.md#update_pbx_queue) | **PUT** /conversation/pbx/queue/{conversationPbxQueueUuid} | Update pbx queue
88
- [**update_pbx_time_based**](ConversationApi.md#update_pbx_time_based) | **PUT** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Update pbx timeBased
89
- [**update_pbx_time_range**](ConversationApi.md#update_pbx_time_range) | **PUT** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Update pbx timeRange
90
- [**update_pbx_voicemail_mailbox**](ConversationApi.md#update_pbx_voicemail_mailbox) | **PUT** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Update pbx voicemailMailbox
91
-
92
-
93
- # **delete_conversation_canned_message**
94
- > delete_conversation_canned_message(conversation_canned_message_oid)
95
-
96
- Delete a conversation canned message
97
-
98
- Delete a conversation canned message
99
-
100
- ### Example
101
- ```ruby
102
- # load the gem
103
- require 'ultracart_api'
104
-
105
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
106
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
107
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
108
-
109
-
110
- conversation_canned_message_oid = 56 # Integer |
111
-
112
-
113
- begin
114
- #Delete a conversation canned message
115
- api_instance.delete_conversation_canned_message(conversation_canned_message_oid)
116
- rescue UltracartClient::ApiError => e
117
- puts "Exception when calling ConversationApi->delete_conversation_canned_message: #{e}"
118
- end
119
- ```
120
-
121
- ### Parameters
122
-
123
- Name | Type | Description | Notes
124
- ------------- | ------------- | ------------- | -------------
125
- **conversation_canned_message_oid** | **Integer**| |
126
-
127
- ### Return type
128
-
129
- nil (empty response body)
130
-
131
- ### Authorization
132
-
133
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
134
-
135
- ### HTTP request headers
136
-
137
- - **Content-Type**: application/json
138
- - **Accept**: application/json
139
-
140
-
141
-
142
- # **delete_department**
143
- > delete_department(conversation_department_oid)
144
-
145
- Delete a conversation department
146
-
147
- Delete a conversation department
148
-
149
- ### Example
150
- ```ruby
151
- # load the gem
152
- require 'ultracart_api'
153
-
154
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
155
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
156
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
157
-
158
-
159
- conversation_department_oid = 56 # Integer |
160
-
161
-
162
- begin
163
- #Delete a conversation department
164
- api_instance.delete_department(conversation_department_oid)
165
- rescue UltracartClient::ApiError => e
166
- puts "Exception when calling ConversationApi->delete_department: #{e}"
167
- end
168
- ```
169
-
170
- ### Parameters
171
-
172
- Name | Type | Description | Notes
173
- ------------- | ------------- | ------------- | -------------
174
- **conversation_department_oid** | **Integer**| |
175
-
176
- ### Return type
177
-
178
- nil (empty response body)
179
-
180
- ### Authorization
181
-
182
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
183
-
184
- ### HTTP request headers
185
-
186
- - **Content-Type**: application/json
187
- - **Accept**: application/json
188
-
189
-
190
-
191
- # **delete_engagement**
192
- > delete_engagement(conversation_engagement_oid)
193
-
194
- Delete a conversation engagement
195
-
196
- Delete a conversation engagement
197
-
198
- ### Example
199
- ```ruby
200
- # load the gem
201
- require 'ultracart_api'
202
-
203
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
204
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
205
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
206
-
207
-
208
- conversation_engagement_oid = 56 # Integer |
209
-
210
-
211
- begin
212
- #Delete a conversation engagement
213
- api_instance.delete_engagement(conversation_engagement_oid)
214
- rescue UltracartClient::ApiError => e
215
- puts "Exception when calling ConversationApi->delete_engagement: #{e}"
216
- end
217
- ```
218
-
219
- ### Parameters
220
-
221
- Name | Type | Description | Notes
222
- ------------- | ------------- | ------------- | -------------
223
- **conversation_engagement_oid** | **Integer**| |
224
-
225
- ### Return type
226
-
227
- nil (empty response body)
228
-
229
- ### Authorization
230
-
231
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
232
-
233
- ### HTTP request headers
234
-
235
- - **Content-Type**: application/json
236
- - **Accept**: application/json
237
-
238
-
239
-
240
- # **delete_pbx_agent_voicemail**
241
- > delete_pbx_agent_voicemail(recording_sid)
242
-
243
- Delete Agent Voicemail
244
-
245
- Delete pbx agent Voicemail
246
-
247
- ### Example
248
- ```ruby
249
- # load the gem
250
- require 'ultracart_api'
251
-
252
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
253
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
254
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
255
-
256
-
257
- recording_sid = 'recording_sid_example' # String |
258
-
259
-
260
- begin
261
- #Delete Agent Voicemail
262
- api_instance.delete_pbx_agent_voicemail(recording_sid)
263
- rescue UltracartClient::ApiError => e
264
- puts "Exception when calling ConversationApi->delete_pbx_agent_voicemail: #{e}"
265
- end
266
- ```
267
-
268
- ### Parameters
269
-
270
- Name | Type | Description | Notes
271
- ------------- | ------------- | ------------- | -------------
272
- **recording_sid** | **String**| |
273
-
274
- ### Return type
275
-
276
- nil (empty response body)
277
-
278
- ### Authorization
279
-
280
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
281
-
282
- ### HTTP request headers
283
-
284
- - **Content-Type**: application/json
285
- - **Accept**: application/json
286
-
287
-
288
-
289
- # **delete_pbx_audio**
290
- > ConversationPbxAudioResponse delete_pbx_audio(conversation_pbx_audio_uuid)
291
-
292
- Delete pbx audio
293
-
294
- Delete a pbx audio
295
-
296
- ### Example
297
- ```ruby
298
- # load the gem
299
- require 'ultracart_api'
300
-
301
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
302
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
303
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
304
-
305
-
306
- conversation_pbx_audio_uuid = 'conversation_pbx_audio_uuid_example' # String |
307
-
308
-
309
- begin
310
- #Delete pbx audio
311
- result = api_instance.delete_pbx_audio(conversation_pbx_audio_uuid)
312
- p result
313
- rescue UltracartClient::ApiError => e
314
- puts "Exception when calling ConversationApi->delete_pbx_audio: #{e}"
315
- end
316
- ```
317
-
318
- ### Parameters
319
-
320
- Name | Type | Description | Notes
321
- ------------- | ------------- | ------------- | -------------
322
- **conversation_pbx_audio_uuid** | **String**| |
323
-
324
- ### Return type
325
-
326
- [**ConversationPbxAudioResponse**](ConversationPbxAudioResponse.md)
327
-
328
- ### Authorization
329
-
330
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
331
-
332
- ### HTTP request headers
333
-
334
- - **Content-Type**: application/json
335
- - **Accept**: application/json
336
-
337
-
338
-
339
- # **delete_pbx_menu**
340
- > ConversationPbxMenuResponse delete_pbx_menu(conversation_pbx_menu_uuid)
341
-
342
- Delete pbx menu
343
-
344
- Delete a pbx menu
345
-
346
- ### Example
347
- ```ruby
348
- # load the gem
349
- require 'ultracart_api'
350
-
351
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
352
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
353
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
354
-
355
-
356
- conversation_pbx_menu_uuid = 'conversation_pbx_menu_uuid_example' # String |
357
-
358
-
359
- begin
360
- #Delete pbx menu
361
- result = api_instance.delete_pbx_menu(conversation_pbx_menu_uuid)
362
- p result
363
- rescue UltracartClient::ApiError => e
364
- puts "Exception when calling ConversationApi->delete_pbx_menu: #{e}"
365
- end
366
- ```
367
-
368
- ### Parameters
369
-
370
- Name | Type | Description | Notes
371
- ------------- | ------------- | ------------- | -------------
372
- **conversation_pbx_menu_uuid** | **String**| |
373
-
374
- ### Return type
375
-
376
- [**ConversationPbxMenuResponse**](ConversationPbxMenuResponse.md)
377
-
378
- ### Authorization
379
-
380
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
381
-
382
- ### HTTP request headers
383
-
384
- - **Content-Type**: application/json
385
- - **Accept**: application/json
386
-
387
-
388
-
389
- # **delete_pbx_queue**
390
- > ConversationPbxQueueResponse delete_pbx_queue(conversation_pbx_queue_uuid)
391
-
392
- Delete pbx queue
393
-
394
- Delete a pbx queue
395
-
396
- ### Example
397
- ```ruby
398
- # load the gem
399
- require 'ultracart_api'
400
-
401
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
402
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
403
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
404
-
405
-
406
- conversation_pbx_queue_uuid = 'conversation_pbx_queue_uuid_example' # String |
407
-
408
-
409
- begin
410
- #Delete pbx queue
411
- result = api_instance.delete_pbx_queue(conversation_pbx_queue_uuid)
412
- p result
413
- rescue UltracartClient::ApiError => e
414
- puts "Exception when calling ConversationApi->delete_pbx_queue: #{e}"
415
- end
416
- ```
417
-
418
- ### Parameters
419
-
420
- Name | Type | Description | Notes
421
- ------------- | ------------- | ------------- | -------------
422
- **conversation_pbx_queue_uuid** | **String**| |
423
-
424
- ### Return type
425
-
426
- [**ConversationPbxQueueResponse**](ConversationPbxQueueResponse.md)
427
-
428
- ### Authorization
429
-
430
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
431
-
432
- ### HTTP request headers
433
-
434
- - **Content-Type**: application/json
435
- - **Accept**: application/json
436
-
437
-
438
-
439
- # **delete_pbx_queue_voicemail**
440
- > delete_pbx_queue_voicemail(queue_uuid, recording_sid)
441
-
442
- Delete Queue Voicemail
443
-
444
- Delete pbx queue Voicemail
445
-
446
- ### Example
447
- ```ruby
448
- # load the gem
449
- require 'ultracart_api'
450
-
451
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
452
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
453
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
454
-
455
-
456
- queue_uuid = 'queue_uuid_example' # String |
457
-
458
- recording_sid = 'recording_sid_example' # String |
459
-
460
-
461
- begin
462
- #Delete Queue Voicemail
463
- api_instance.delete_pbx_queue_voicemail(queue_uuid, recording_sid)
464
- rescue UltracartClient::ApiError => e
465
- puts "Exception when calling ConversationApi->delete_pbx_queue_voicemail: #{e}"
466
- end
467
- ```
468
-
469
- ### Parameters
470
-
471
- Name | Type | Description | Notes
472
- ------------- | ------------- | ------------- | -------------
473
- **queue_uuid** | **String**| |
474
- **recording_sid** | **String**| |
475
-
476
- ### Return type
477
-
478
- nil (empty response body)
479
-
480
- ### Authorization
481
-
482
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
483
-
484
- ### HTTP request headers
485
-
486
- - **Content-Type**: application/json
487
- - **Accept**: application/json
488
-
489
-
490
-
491
- # **delete_pbx_time_based**
492
- > ConversationPbxTimeBasedResponse delete_pbx_time_based(conversation_pbx_time_based_uuid)
493
-
494
- Delete pbx timeBased
495
-
496
- Delete a pbx timeBased
497
-
498
- ### Example
499
- ```ruby
500
- # load the gem
501
- require 'ultracart_api'
502
-
503
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
504
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
505
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
506
-
507
-
508
- conversation_pbx_time_based_uuid = 'conversation_pbx_time_based_uuid_example' # String |
509
-
510
-
511
- begin
512
- #Delete pbx timeBased
513
- result = api_instance.delete_pbx_time_based(conversation_pbx_time_based_uuid)
514
- p result
515
- rescue UltracartClient::ApiError => e
516
- puts "Exception when calling ConversationApi->delete_pbx_time_based: #{e}"
517
- end
518
- ```
519
-
520
- ### Parameters
521
-
522
- Name | Type | Description | Notes
523
- ------------- | ------------- | ------------- | -------------
524
- **conversation_pbx_time_based_uuid** | **String**| |
525
-
526
- ### Return type
527
-
528
- [**ConversationPbxTimeBasedResponse**](ConversationPbxTimeBasedResponse.md)
529
-
530
- ### Authorization
531
-
532
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
533
-
534
- ### HTTP request headers
535
-
536
- - **Content-Type**: application/json
537
- - **Accept**: application/json
538
-
539
-
540
-
541
- # **delete_pbx_time_range**
542
- > ConversationPbxTimeRangeResponse delete_pbx_time_range(conversation_pbx_time_range_uuid)
543
-
544
- Delete pbx timeRange
545
-
546
- Delete a pbx timeRange
547
-
548
- ### Example
549
- ```ruby
550
- # load the gem
551
- require 'ultracart_api'
552
-
553
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
554
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
555
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
556
-
557
-
558
- conversation_pbx_time_range_uuid = 'conversation_pbx_time_range_uuid_example' # String |
559
-
560
-
561
- begin
562
- #Delete pbx timeRange
563
- result = api_instance.delete_pbx_time_range(conversation_pbx_time_range_uuid)
564
- p result
565
- rescue UltracartClient::ApiError => e
566
- puts "Exception when calling ConversationApi->delete_pbx_time_range: #{e}"
567
- end
568
- ```
569
-
570
- ### Parameters
571
-
572
- Name | Type | Description | Notes
573
- ------------- | ------------- | ------------- | -------------
574
- **conversation_pbx_time_range_uuid** | **String**| |
575
-
576
- ### Return type
577
-
578
- [**ConversationPbxTimeRangeResponse**](ConversationPbxTimeRangeResponse.md)
579
-
580
- ### Authorization
581
-
582
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
583
-
584
- ### HTTP request headers
585
-
586
- - **Content-Type**: application/json
587
- - **Accept**: application/json
588
-
589
-
590
-
591
- # **delete_pbx_voicemail_mailbox**
592
- > ConversationPbxVoicemailMailboxResponse delete_pbx_voicemail_mailbox(conversation_pbx_voicemail_mailbox_uuid)
593
-
594
- Delete pbx voicemailMailbox
595
-
596
- Delete a pbx voicemailMailbox
597
-
598
- ### Example
599
- ```ruby
600
- # load the gem
601
- require 'ultracart_api'
602
-
603
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
604
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
605
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
606
-
607
-
608
- conversation_pbx_voicemail_mailbox_uuid = 'conversation_pbx_voicemail_mailbox_uuid_example' # String |
609
-
610
-
611
- begin
612
- #Delete pbx voicemailMailbox
613
- result = api_instance.delete_pbx_voicemail_mailbox(conversation_pbx_voicemail_mailbox_uuid)
614
- p result
615
- rescue UltracartClient::ApiError => e
616
- puts "Exception when calling ConversationApi->delete_pbx_voicemail_mailbox: #{e}"
617
- end
618
- ```
619
-
620
- ### Parameters
621
-
622
- Name | Type | Description | Notes
623
- ------------- | ------------- | ------------- | -------------
624
- **conversation_pbx_voicemail_mailbox_uuid** | **String**| |
625
-
626
- ### Return type
627
-
628
- [**ConversationPbxVoicemailMailboxResponse**](ConversationPbxVoicemailMailboxResponse.md)
629
-
630
- ### Authorization
631
-
632
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
633
-
634
- ### HTTP request headers
635
-
636
- - **Content-Type**: application/json
637
- - **Accept**: application/json
638
-
639
-
640
-
641
- # **get_agent_keep_alive**
642
- > get_agent_keep_alive
643
-
644
- Agent keep alive
645
-
646
- Called periodically by the conversation API to keep the session alive.
647
-
648
- ### Example
649
- ```ruby
650
- # load the gem
651
- require 'ultracart_api'
652
-
653
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
654
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
655
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
656
-
657
-
658
-
659
- begin
660
- #Agent keep alive
661
- api_instance.get_agent_keep_alive
662
- rescue UltracartClient::ApiError => e
663
- puts "Exception when calling ConversationApi->get_agent_keep_alive: #{e}"
664
- end
665
- ```
666
-
667
- ### Parameters
668
- This endpoint does not need any parameter.
669
-
670
- ### Return type
671
-
672
- nil (empty response body)
673
-
674
- ### Authorization
675
-
676
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
677
-
678
- ### HTTP request headers
679
-
680
- - **Content-Type**: application/json
681
- - **Accept**: application/json
682
-
683
-
684
-
685
- # **get_agent_profile**
686
- > ConversationAgentProfileResponse get_agent_profile
687
-
688
- Get agent profile
689
-
690
- Retrieve the agents profile
691
-
692
- ### Example
693
- ```ruby
694
- # load the gem
695
- require 'ultracart_api'
696
-
697
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
698
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
699
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
700
-
701
-
702
-
703
- begin
704
- #Get agent profile
705
- result = api_instance.get_agent_profile
706
- p result
707
- rescue UltracartClient::ApiError => e
708
- puts "Exception when calling ConversationApi->get_agent_profile: #{e}"
709
- end
710
- ```
711
-
712
- ### Parameters
713
- This endpoint does not need any parameter.
714
-
715
- ### Return type
716
-
717
- [**ConversationAgentProfileResponse**](ConversationAgentProfileResponse.md)
718
-
719
- ### Authorization
720
-
721
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
722
-
723
- ### HTTP request headers
724
-
725
- - **Content-Type**: application/json
726
- - **Accept**: application/json
727
-
728
-
729
-
730
- # **get_agent_profiles**
731
- > ConversationAgentProfilesResponse get_agent_profiles
732
-
733
- Get agent profiles
734
-
735
- Retrieve the agents profile
736
-
737
- ### Example
738
- ```ruby
739
- # load the gem
740
- require 'ultracart_api'
741
-
742
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
743
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
744
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
745
-
746
-
747
-
748
- begin
749
- #Get agent profiles
750
- result = api_instance.get_agent_profiles
751
- p result
752
- rescue UltracartClient::ApiError => e
753
- puts "Exception when calling ConversationApi->get_agent_profiles: #{e}"
754
- end
755
- ```
756
-
757
- ### Parameters
758
- This endpoint does not need any parameter.
759
-
760
- ### Return type
761
-
762
- [**ConversationAgentProfilesResponse**](ConversationAgentProfilesResponse.md)
763
-
764
- ### Authorization
765
-
766
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
767
-
768
- ### HTTP request headers
769
-
770
- - **Content-Type**: application/json
771
- - **Accept**: application/json
772
-
773
-
774
-
775
- # **get_agent_websocket_authorization**
776
- > ConversationAgentAuthResponse get_agent_websocket_authorization
777
-
778
- Get agent websocket authorization
779
-
780
- Retrieve a JWT to authorize an agent to make a websocket connection.
781
-
782
- ### Example
783
- ```ruby
784
- # load the gem
785
- require 'ultracart_api'
786
-
787
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
788
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
789
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
790
-
791
-
792
-
793
- begin
794
- #Get agent websocket authorization
795
- result = api_instance.get_agent_websocket_authorization
796
- p result
797
- rescue UltracartClient::ApiError => e
798
- puts "Exception when calling ConversationApi->get_agent_websocket_authorization: #{e}"
799
- end
800
- ```
801
-
802
- ### Parameters
803
- This endpoint does not need any parameter.
804
-
805
- ### Return type
806
-
807
- [**ConversationAgentAuthResponse**](ConversationAgentAuthResponse.md)
808
-
809
- ### Authorization
810
-
811
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
812
-
813
- ### HTTP request headers
814
-
815
- - **Content-Type**: application/json
816
- - **Accept**: application/json
817
-
818
-
819
-
820
- # **get_conversation**
821
- > ConversationResponse get_conversation(conversation_uuid, opts)
822
-
823
- Retrieve a conversation
824
-
825
- Retrieve a conversation including the participants and messages
826
-
827
- ### Example
828
- ```ruby
829
- # load the gem
830
- require 'ultracart_api'
831
-
832
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
833
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
834
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
835
-
836
-
837
- conversation_uuid = 'conversation_uuid_example' # String |
838
-
839
- opts = {
840
- limit: 56 # Integer |
841
- }
842
-
843
- begin
844
- #Retrieve a conversation
845
- result = api_instance.get_conversation(conversation_uuid, opts)
846
- p result
847
- rescue UltracartClient::ApiError => e
848
- puts "Exception when calling ConversationApi->get_conversation: #{e}"
849
- end
850
- ```
851
-
852
- ### Parameters
853
-
854
- Name | Type | Description | Notes
855
- ------------- | ------------- | ------------- | -------------
856
- **conversation_uuid** | **String**| |
857
- **limit** | **Integer**| | [optional]
858
-
859
- ### Return type
860
-
861
- [**ConversationResponse**](ConversationResponse.md)
862
-
863
- ### Authorization
864
-
865
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
866
-
867
- ### HTTP request headers
868
-
869
- - **Content-Type**: application/json
870
- - **Accept**: application/json
871
-
872
-
873
-
874
- # **get_conversation_canned_messages**
875
- > ConversationCannedMessagesResponse get_conversation_canned_messages
876
-
877
- Retrieve a list of canned messages ordered by short_code
878
-
879
- Retrieve a list of canned messages ordered by short_code
880
-
881
- ### Example
882
- ```ruby
883
- # load the gem
884
- require 'ultracart_api'
885
-
886
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
887
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
888
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
889
-
890
-
891
-
892
- begin
893
- #Retrieve a list of canned messages ordered by short_code
894
- result = api_instance.get_conversation_canned_messages
895
- p result
896
- rescue UltracartClient::ApiError => e
897
- puts "Exception when calling ConversationApi->get_conversation_canned_messages: #{e}"
898
- end
899
- ```
900
-
901
- ### Parameters
902
- This endpoint does not need any parameter.
903
-
904
- ### Return type
905
-
906
- [**ConversationCannedMessagesResponse**](ConversationCannedMessagesResponse.md)
907
-
908
- ### Authorization
909
-
910
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
911
-
912
- ### HTTP request headers
913
-
914
- - **Content-Type**: application/json
915
- - **Accept**: application/json
916
-
917
-
918
-
919
- # **get_conversation_context**
920
- > ConversationWebchatContext get_conversation_context(conversation_uuid)
921
-
922
- Get a webchat conversation context
923
-
924
- Get a webchat conversation context
925
-
926
- ### Example
927
- ```ruby
928
- # load the gem
929
- require 'ultracart_api'
930
-
931
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
932
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
933
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
934
-
935
-
936
- conversation_uuid = 'conversation_uuid_example' # String |
937
-
938
-
939
- begin
940
- #Get a webchat conversation context
941
- result = api_instance.get_conversation_context(conversation_uuid)
942
- p result
943
- rescue UltracartClient::ApiError => e
944
- puts "Exception when calling ConversationApi->get_conversation_context: #{e}"
945
- end
946
- ```
947
-
948
- ### Parameters
949
-
950
- Name | Type | Description | Notes
951
- ------------- | ------------- | ------------- | -------------
952
- **conversation_uuid** | **String**| |
953
-
954
- ### Return type
955
-
956
- [**ConversationWebchatContext**](ConversationWebchatContext.md)
957
-
958
- ### Authorization
959
-
960
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
961
-
962
- ### HTTP request headers
963
-
964
- - **Content-Type**: application/json
965
- - **Accept**: application/json
966
-
967
-
968
-
969
- # **get_conversation_department_member_list**
970
- > ConversationDepartmentMembersResponse get_conversation_department_member_list
971
-
972
- Retrieve a list of possible department members
973
-
974
- Retrieve a list of possible department members
975
-
976
- ### Example
977
- ```ruby
978
- # load the gem
979
- require 'ultracart_api'
980
-
981
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
982
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
983
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
984
-
985
-
986
-
987
- begin
988
- #Retrieve a list of possible department members
989
- result = api_instance.get_conversation_department_member_list
990
- p result
991
- rescue UltracartClient::ApiError => e
992
- puts "Exception when calling ConversationApi->get_conversation_department_member_list: #{e}"
993
- end
994
- ```
995
-
996
- ### Parameters
997
- This endpoint does not need any parameter.
998
-
999
- ### Return type
1000
-
1001
- [**ConversationDepartmentMembersResponse**](ConversationDepartmentMembersResponse.md)
1002
-
1003
- ### Authorization
1004
-
1005
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1006
-
1007
- ### HTTP request headers
1008
-
1009
- - **Content-Type**: application/json
1010
- - **Accept**: application/json
1011
-
1012
-
1013
-
1014
- # **get_conversation_departments**
1015
- > ConversationDepartmentsResponse get_conversation_departments
1016
-
1017
- Retrieve a list of departments ordered by name
1018
-
1019
- Retrieve a list of departments ordered by name
1020
-
1021
- ### Example
1022
- ```ruby
1023
- # load the gem
1024
- require 'ultracart_api'
1025
-
1026
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1027
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1028
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1029
-
1030
-
1031
-
1032
- begin
1033
- #Retrieve a list of departments ordered by name
1034
- result = api_instance.get_conversation_departments
1035
- p result
1036
- rescue UltracartClient::ApiError => e
1037
- puts "Exception when calling ConversationApi->get_conversation_departments: #{e}"
1038
- end
1039
- ```
1040
-
1041
- ### Parameters
1042
- This endpoint does not need any parameter.
1043
-
1044
- ### Return type
1045
-
1046
- [**ConversationDepartmentsResponse**](ConversationDepartmentsResponse.md)
1047
-
1048
- ### Authorization
1049
-
1050
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1051
-
1052
- ### HTTP request headers
1053
-
1054
- - **Content-Type**: application/json
1055
- - **Accept**: application/json
1056
-
1057
-
1058
-
1059
- # **get_conversation_engagement**
1060
- > ConversationEngagementResponse get_conversation_engagement(conversation_engagement_oid)
1061
-
1062
- Retrieve an engagement
1063
-
1064
- Retrieve an engagement
1065
-
1066
- ### Example
1067
- ```ruby
1068
- # load the gem
1069
- require 'ultracart_api'
1070
-
1071
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1072
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1073
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1074
-
1075
-
1076
- conversation_engagement_oid = 56 # Integer |
1077
-
1078
-
1079
- begin
1080
- #Retrieve an engagement
1081
- result = api_instance.get_conversation_engagement(conversation_engagement_oid)
1082
- p result
1083
- rescue UltracartClient::ApiError => e
1084
- puts "Exception when calling ConversationApi->get_conversation_engagement: #{e}"
1085
- end
1086
- ```
1087
-
1088
- ### Parameters
1089
-
1090
- Name | Type | Description | Notes
1091
- ------------- | ------------- | ------------- | -------------
1092
- **conversation_engagement_oid** | **Integer**| |
1093
-
1094
- ### Return type
1095
-
1096
- [**ConversationEngagementResponse**](ConversationEngagementResponse.md)
1097
-
1098
- ### Authorization
1099
-
1100
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1101
-
1102
- ### HTTP request headers
1103
-
1104
- - **Content-Type**: application/json
1105
- - **Accept**: application/json
1106
-
1107
-
1108
-
1109
- # **get_conversation_engagements**
1110
- > ConversationEngagementsResponse get_conversation_engagements
1111
-
1112
- Retrieve a list of engagements ordered by name
1113
-
1114
- Retrieve a list of engagements ordered by name
1115
-
1116
- ### Example
1117
- ```ruby
1118
- # load the gem
1119
- require 'ultracart_api'
1120
-
1121
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1122
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1123
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1124
-
1125
-
1126
-
1127
- begin
1128
- #Retrieve a list of engagements ordered by name
1129
- result = api_instance.get_conversation_engagements
1130
- p result
1131
- rescue UltracartClient::ApiError => e
1132
- puts "Exception when calling ConversationApi->get_conversation_engagements: #{e}"
1133
- end
1134
- ```
1135
-
1136
- ### Parameters
1137
- This endpoint does not need any parameter.
1138
-
1139
- ### Return type
1140
-
1141
- [**ConversationEngagementsResponse**](ConversationEngagementsResponse.md)
1142
-
1143
- ### Authorization
1144
-
1145
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1146
-
1147
- ### HTTP request headers
1148
-
1149
- - **Content-Type**: application/json
1150
- - **Accept**: application/json
1151
-
1152
-
1153
-
1154
- # **get_conversation_messages**
1155
- > ConversationMessagesResponse get_conversation_messages(conversation_uuid, since, opts)
1156
-
1157
- Retrieve conversation messages
1158
-
1159
- Retrieve conversation messages since a particular time
1160
-
1161
- ### Example
1162
- ```ruby
1163
- # load the gem
1164
- require 'ultracart_api'
1165
-
1166
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1167
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1168
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1169
-
1170
-
1171
- conversation_uuid = 'conversation_uuid_example' # String |
1172
-
1173
- since = 789 # Integer |
1174
-
1175
- opts = {
1176
- limit: 56 # Integer |
1177
- }
1178
-
1179
- begin
1180
- #Retrieve conversation messages
1181
- result = api_instance.get_conversation_messages(conversation_uuid, since, opts)
1182
- p result
1183
- rescue UltracartClient::ApiError => e
1184
- puts "Exception when calling ConversationApi->get_conversation_messages: #{e}"
1185
- end
1186
- ```
1187
-
1188
- ### Parameters
1189
-
1190
- Name | Type | Description | Notes
1191
- ------------- | ------------- | ------------- | -------------
1192
- **conversation_uuid** | **String**| |
1193
- **since** | **Integer**| |
1194
- **limit** | **Integer**| | [optional]
1195
-
1196
- ### Return type
1197
-
1198
- [**ConversationMessagesResponse**](ConversationMessagesResponse.md)
1199
-
1200
- ### Authorization
1201
-
1202
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1203
-
1204
- ### HTTP request headers
1205
-
1206
- - **Content-Type**: application/json
1207
- - **Accept**: application/json
1208
-
1209
-
1210
-
1211
- # **get_conversation_multimedia_upload_url**
1212
- > ConversationMultimediaUploadUrlResponse get_conversation_multimedia_upload_url(extension)
1213
-
1214
- Get a presigned conversation multimedia upload URL
1215
-
1216
- Get a presigned conversation multimedia upload URL
1217
-
1218
- ### Example
1219
- ```ruby
1220
- # load the gem
1221
- require 'ultracart_api'
1222
-
1223
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1224
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1225
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1226
-
1227
-
1228
- extension = 'extension_example' # String |
1229
-
1230
-
1231
- begin
1232
- #Get a presigned conversation multimedia upload URL
1233
- result = api_instance.get_conversation_multimedia_upload_url(extension)
1234
- p result
1235
- rescue UltracartClient::ApiError => e
1236
- puts "Exception when calling ConversationApi->get_conversation_multimedia_upload_url: #{e}"
1237
- end
1238
- ```
1239
-
1240
- ### Parameters
1241
-
1242
- Name | Type | Description | Notes
1243
- ------------- | ------------- | ------------- | -------------
1244
- **extension** | **String**| |
1245
-
1246
- ### Return type
1247
-
1248
- [**ConversationMultimediaUploadUrlResponse**](ConversationMultimediaUploadUrlResponse.md)
1249
-
1250
- ### Authorization
1251
-
1252
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1253
-
1254
- ### HTTP request headers
1255
-
1256
- - **Content-Type**: application/json
1257
- - **Accept**: application/json
1258
-
1259
-
1260
-
1261
- # **get_conversation_pbx_audio_upload_url**
1262
- > ConversationPbxAudioUploadUrlResponse get_conversation_pbx_audio_upload_url(extension)
1263
-
1264
- Get a pre-signed conversation multimedia upload URL
1265
-
1266
- Get a pre-signed conversation multimedia upload URL
1267
-
1268
- ### Example
1269
- ```ruby
1270
- # load the gem
1271
- require 'ultracart_api'
1272
-
1273
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1274
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1275
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1276
-
1277
-
1278
- extension = 'extension_example' # String |
1279
-
1280
-
1281
- begin
1282
- #Get a pre-signed conversation multimedia upload URL
1283
- result = api_instance.get_conversation_pbx_audio_upload_url(extension)
1284
- p result
1285
- rescue UltracartClient::ApiError => e
1286
- puts "Exception when calling ConversationApi->get_conversation_pbx_audio_upload_url: #{e}"
1287
- end
1288
- ```
1289
-
1290
- ### Parameters
1291
-
1292
- Name | Type | Description | Notes
1293
- ------------- | ------------- | ------------- | -------------
1294
- **extension** | **String**| |
1295
-
1296
- ### Return type
1297
-
1298
- [**ConversationPbxAudioUploadUrlResponse**](ConversationPbxAudioUploadUrlResponse.md)
1299
-
1300
- ### Authorization
1301
-
1302
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1303
-
1304
- ### HTTP request headers
1305
-
1306
- - **Content-Type**: application/json
1307
- - **Accept**: application/json
1308
-
1309
-
1310
-
1311
- # **get_conversation_pbx_customer_snapshot**
1312
- > ConversationPbxCustomerSnapshotResponse get_conversation_pbx_customer_snapshot(pbx_customer_snapshot_request)
1313
-
1314
- Get orders and customer information for a phone number
1315
-
1316
- Retrieves all the orders, auto orders, and customer profile for a given phone number
1317
-
1318
- ### Example
1319
- ```ruby
1320
- # load the gem
1321
- require 'ultracart_api'
1322
-
1323
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1324
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1325
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1326
-
1327
-
1328
- pbx_customer_snapshot_request = UltracartClient::ConversationPbxCustomerSnapshotRequest.new # ConversationPbxCustomerSnapshotRequest | Conversation pbx customer snapshot request
1329
-
1330
-
1331
- begin
1332
- #Get orders and customer information for a phone number
1333
- result = api_instance.get_conversation_pbx_customer_snapshot(pbx_customer_snapshot_request)
1334
- p result
1335
- rescue UltracartClient::ApiError => e
1336
- puts "Exception when calling ConversationApi->get_conversation_pbx_customer_snapshot: #{e}"
1337
- end
1338
- ```
1339
-
1340
- ### Parameters
1341
-
1342
- Name | Type | Description | Notes
1343
- ------------- | ------------- | ------------- | -------------
1344
- **pbx_customer_snapshot_request** | [**ConversationPbxCustomerSnapshotRequest**](ConversationPbxCustomerSnapshotRequest.md)| Conversation pbx customer snapshot request |
1345
-
1346
- ### Return type
1347
-
1348
- [**ConversationPbxCustomerSnapshotResponse**](ConversationPbxCustomerSnapshotResponse.md)
1349
-
1350
- ### Authorization
1351
-
1352
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1353
-
1354
- ### HTTP request headers
1355
-
1356
- - **Content-Type**: application/json
1357
- - **Accept**: application/json
1358
-
1359
-
1360
-
1361
- # **get_conversation_permissions**
1362
- > ConversationPermissionsResponse get_conversation_permissions
1363
-
1364
- Retrieve conversation permissions
1365
-
1366
- Retrieve conversation permissions
1367
-
1368
- ### Example
1369
- ```ruby
1370
- # load the gem
1371
- require 'ultracart_api'
1372
-
1373
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1374
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1375
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1376
-
1377
-
1378
-
1379
- begin
1380
- #Retrieve conversation permissions
1381
- result = api_instance.get_conversation_permissions
1382
- p result
1383
- rescue UltracartClient::ApiError => e
1384
- puts "Exception when calling ConversationApi->get_conversation_permissions: #{e}"
1385
- end
1386
- ```
1387
-
1388
- ### Parameters
1389
- This endpoint does not need any parameter.
1390
-
1391
- ### Return type
1392
-
1393
- [**ConversationPermissionsResponse**](ConversationPermissionsResponse.md)
1394
-
1395
- ### Authorization
1396
-
1397
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1398
-
1399
- ### HTTP request headers
1400
-
1401
- - **Content-Type**: application/json
1402
- - **Accept**: application/json
1403
-
1404
-
1405
-
1406
- # **get_conversation_webchat_queue_statuses**
1407
- > ConversationWebchatQueueStatusesResponse get_conversation_webchat_queue_statuses
1408
-
1409
- Retrieve a conversation webchat queue statuses
1410
-
1411
- Retrieve a conversation webchat queue statuses including agent status and queue entries
1412
-
1413
- ### Example
1414
- ```ruby
1415
- # load the gem
1416
- require 'ultracart_api'
1417
-
1418
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1419
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1420
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1421
-
1422
-
1423
-
1424
- begin
1425
- #Retrieve a conversation webchat queue statuses
1426
- result = api_instance.get_conversation_webchat_queue_statuses
1427
- p result
1428
- rescue UltracartClient::ApiError => e
1429
- puts "Exception when calling ConversationApi->get_conversation_webchat_queue_statuses: #{e}"
1430
- end
1431
- ```
1432
-
1433
- ### Parameters
1434
- This endpoint does not need any parameter.
1435
-
1436
- ### Return type
1437
-
1438
- [**ConversationWebchatQueueStatusesResponse**](ConversationWebchatQueueStatusesResponse.md)
1439
-
1440
- ### Authorization
1441
-
1442
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1443
-
1444
- ### HTTP request headers
1445
-
1446
- - **Content-Type**: application/json
1447
- - **Accept**: application/json
1448
-
1449
-
1450
-
1451
- # **get_conversations**
1452
- > ConversationsResponse get_conversations(opts)
1453
-
1454
- Retrieve a list of conversation summaries newest to oldest
1455
-
1456
- Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
1457
-
1458
- ### Example
1459
- ```ruby
1460
- # load the gem
1461
- require 'ultracart_api'
1462
-
1463
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1464
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1465
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1466
-
1467
-
1468
- opts = {
1469
- medium: 'medium_example', # String |
1470
- before: 'before_example', # String |
1471
- _limit: 100, # Integer | The maximum number of records to return on this one API call. (Max 200)
1472
- _offset: 0 # Integer | Pagination of the record set. Offset is a zero based index.
1473
- }
1474
-
1475
- begin
1476
- #Retrieve a list of conversation summaries newest to oldest
1477
- result = api_instance.get_conversations(opts)
1478
- p result
1479
- rescue UltracartClient::ApiError => e
1480
- puts "Exception when calling ConversationApi->get_conversations: #{e}"
1481
- end
1482
- ```
1483
-
1484
- ### Parameters
1485
-
1486
- Name | Type | Description | Notes
1487
- ------------- | ------------- | ------------- | -------------
1488
- **medium** | **String**| | [optional]
1489
- **before** | **String**| | [optional]
1490
- **_limit** | **Integer**| The maximum number of records to return on this one API call. (Max 200) | [optional] [default to 100]
1491
- **_offset** | **Integer**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
1492
-
1493
- ### Return type
1494
-
1495
- [**ConversationsResponse**](ConversationsResponse.md)
1496
-
1497
- ### Authorization
1498
-
1499
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1500
-
1501
- ### HTTP request headers
1502
-
1503
- - **Content-Type**: application/json
1504
- - **Accept**: application/json
1505
-
1506
-
1507
-
1508
- # **get_conversations_autocomplete**
1509
- > ConversationAutocompleteResponse get_conversations_autocomplete(autocomplete_request)
1510
-
1511
- Retrieve a list of matching terms for a search field
1512
-
1513
- Retrieve a list of matching terms for a search field
1514
-
1515
- ### Example
1516
- ```ruby
1517
- # load the gem
1518
- require 'ultracart_api'
1519
-
1520
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1521
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1522
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1523
-
1524
-
1525
- autocomplete_request = UltracartClient::ConversationAutocompleteRequest.new # ConversationAutocompleteRequest | Autocomplete Request
1526
-
1527
-
1528
- begin
1529
- #Retrieve a list of matching terms for a search field
1530
- result = api_instance.get_conversations_autocomplete(autocomplete_request)
1531
- p result
1532
- rescue UltracartClient::ApiError => e
1533
- puts "Exception when calling ConversationApi->get_conversations_autocomplete: #{e}"
1534
- end
1535
- ```
1536
-
1537
- ### Parameters
1538
-
1539
- Name | Type | Description | Notes
1540
- ------------- | ------------- | ------------- | -------------
1541
- **autocomplete_request** | [**ConversationAutocompleteRequest**](ConversationAutocompleteRequest.md)| Autocomplete Request |
1542
-
1543
- ### Return type
1544
-
1545
- [**ConversationAutocompleteResponse**](ConversationAutocompleteResponse.md)
1546
-
1547
- ### Authorization
1548
-
1549
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1550
-
1551
- ### HTTP request headers
1552
-
1553
- - **Content-Type**: application/json
1554
- - **Accept**: application/json
1555
-
1556
-
1557
-
1558
- # **get_conversations_search**
1559
- > ConversationSearchResponse get_conversations_search(search_request)
1560
-
1561
- Search conversations
1562
-
1563
- Search conversations
1564
-
1565
- ### Example
1566
- ```ruby
1567
- # load the gem
1568
- require 'ultracart_api'
1569
-
1570
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1571
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1572
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1573
-
1574
-
1575
- search_request = UltracartClient::ConversationSearchRequest.new # ConversationSearchRequest | Search Request
1576
-
1577
-
1578
- begin
1579
- #Search conversations
1580
- result = api_instance.get_conversations_search(search_request)
1581
- p result
1582
- rescue UltracartClient::ApiError => e
1583
- puts "Exception when calling ConversationApi->get_conversations_search: #{e}"
1584
- end
1585
- ```
1586
-
1587
- ### Parameters
1588
-
1589
- Name | Type | Description | Notes
1590
- ------------- | ------------- | ------------- | -------------
1591
- **search_request** | [**ConversationSearchRequest**](ConversationSearchRequest.md)| Search Request |
1592
-
1593
- ### Return type
1594
-
1595
- [**ConversationSearchResponse**](ConversationSearchResponse.md)
1596
-
1597
- ### Authorization
1598
-
1599
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1600
-
1601
- ### HTTP request headers
1602
-
1603
- - **Content-Type**: application/json
1604
- - **Accept**: application/json
1605
-
1606
-
1607
-
1608
- # **get_locations_for_engagement**
1609
- > ConversationLocationsResponse get_locations_for_engagement
1610
-
1611
- Get location data for engagement configuration
1612
-
1613
- Get location data for engagement configuration
1614
-
1615
- ### Example
1616
- ```ruby
1617
- # load the gem
1618
- require 'ultracart_api'
1619
-
1620
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1621
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1622
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1623
-
1624
-
1625
-
1626
- begin
1627
- #Get location data for engagement configuration
1628
- result = api_instance.get_locations_for_engagement
1629
- p result
1630
- rescue UltracartClient::ApiError => e
1631
- puts "Exception when calling ConversationApi->get_locations_for_engagement: #{e}"
1632
- end
1633
- ```
1634
-
1635
- ### Parameters
1636
- This endpoint does not need any parameter.
1637
-
1638
- ### Return type
1639
-
1640
- [**ConversationLocationsResponse**](ConversationLocationsResponse.md)
1641
-
1642
- ### Authorization
1643
-
1644
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1645
-
1646
- ### HTTP request headers
1647
-
1648
- - **Content-Type**: application/json
1649
- - **Accept**: application/json
1650
-
1651
-
1652
-
1653
- # **get_pbx_agent**
1654
- > ConversationPbxAgentResponse get_pbx_agent(conversation_pbx_agent_uuid)
1655
-
1656
- Get pbx agent
1657
-
1658
- Retrieve a pbx agent
1659
-
1660
- ### Example
1661
- ```ruby
1662
- # load the gem
1663
- require 'ultracart_api'
1664
-
1665
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1666
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1667
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1668
-
1669
-
1670
- conversation_pbx_agent_uuid = 'conversation_pbx_agent_uuid_example' # String |
1671
-
1672
-
1673
- begin
1674
- #Get pbx agent
1675
- result = api_instance.get_pbx_agent(conversation_pbx_agent_uuid)
1676
- p result
1677
- rescue UltracartClient::ApiError => e
1678
- puts "Exception when calling ConversationApi->get_pbx_agent: #{e}"
1679
- end
1680
- ```
1681
-
1682
- ### Parameters
1683
-
1684
- Name | Type | Description | Notes
1685
- ------------- | ------------- | ------------- | -------------
1686
- **conversation_pbx_agent_uuid** | **String**| |
1687
-
1688
- ### Return type
1689
-
1690
- [**ConversationPbxAgentResponse**](ConversationPbxAgentResponse.md)
1691
-
1692
- ### Authorization
1693
-
1694
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1695
-
1696
- ### HTTP request headers
1697
-
1698
- - **Content-Type**: application/json
1699
- - **Accept**: application/json
1700
-
1701
-
1702
-
1703
- # **get_pbx_agent_voicemail**
1704
- > ConversationPbxVoicemailMessageResponse get_pbx_agent_voicemail(recording_sid)
1705
-
1706
- Get Agent Voicemail
1707
-
1708
- Retrieve pbx agent Voicemail
1709
-
1710
- ### Example
1711
- ```ruby
1712
- # load the gem
1713
- require 'ultracart_api'
1714
-
1715
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1716
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1717
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1718
-
1719
-
1720
- recording_sid = 'recording_sid_example' # String |
1721
-
1722
-
1723
- begin
1724
- #Get Agent Voicemail
1725
- result = api_instance.get_pbx_agent_voicemail(recording_sid)
1726
- p result
1727
- rescue UltracartClient::ApiError => e
1728
- puts "Exception when calling ConversationApi->get_pbx_agent_voicemail: #{e}"
1729
- end
1730
- ```
1731
-
1732
- ### Parameters
1733
-
1734
- Name | Type | Description | Notes
1735
- ------------- | ------------- | ------------- | -------------
1736
- **recording_sid** | **String**| |
1737
-
1738
- ### Return type
1739
-
1740
- [**ConversationPbxVoicemailMessageResponse**](ConversationPbxVoicemailMessageResponse.md)
1741
-
1742
- ### Authorization
1743
-
1744
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1745
-
1746
- ### HTTP request headers
1747
-
1748
- - **Content-Type**: application/json
1749
- - **Accept**: application/json
1750
-
1751
-
1752
-
1753
- # **get_pbx_agent_voicemails**
1754
- > ConversationPbxVoicemailMessageSummariesResponse get_pbx_agent_voicemails
1755
-
1756
- Get Agent Voicemails
1757
-
1758
- Retrieve pbx agent Voicemails
1759
-
1760
- ### Example
1761
- ```ruby
1762
- # load the gem
1763
- require 'ultracart_api'
1764
-
1765
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1766
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1767
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1768
-
1769
-
1770
-
1771
- begin
1772
- #Get Agent Voicemails
1773
- result = api_instance.get_pbx_agent_voicemails
1774
- p result
1775
- rescue UltracartClient::ApiError => e
1776
- puts "Exception when calling ConversationApi->get_pbx_agent_voicemails: #{e}"
1777
- end
1778
- ```
1779
-
1780
- ### Parameters
1781
- This endpoint does not need any parameter.
1782
-
1783
- ### Return type
1784
-
1785
- [**ConversationPbxVoicemailMessageSummariesResponse**](ConversationPbxVoicemailMessageSummariesResponse.md)
1786
-
1787
- ### Authorization
1788
-
1789
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1790
-
1791
- ### HTTP request headers
1792
-
1793
- - **Content-Type**: application/json
1794
- - **Accept**: application/json
1795
-
1796
-
1797
-
1798
- # **get_pbx_agents**
1799
- > ConversationPbxAgentsResponse get_pbx_agents
1800
-
1801
- Get pbx agents
1802
-
1803
- Retrieve pbx agents
1804
-
1805
- ### Example
1806
- ```ruby
1807
- # load the gem
1808
- require 'ultracart_api'
1809
-
1810
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1811
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1812
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1813
-
1814
-
1815
-
1816
- begin
1817
- #Get pbx agents
1818
- result = api_instance.get_pbx_agents
1819
- p result
1820
- rescue UltracartClient::ApiError => e
1821
- puts "Exception when calling ConversationApi->get_pbx_agents: #{e}"
1822
- end
1823
- ```
1824
-
1825
- ### Parameters
1826
- This endpoint does not need any parameter.
1827
-
1828
- ### Return type
1829
-
1830
- [**ConversationPbxAgentsResponse**](ConversationPbxAgentsResponse.md)
1831
-
1832
- ### Authorization
1833
-
1834
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1835
-
1836
- ### HTTP request headers
1837
-
1838
- - **Content-Type**: application/json
1839
- - **Accept**: application/json
1840
-
1841
-
1842
-
1843
- # **get_pbx_audio**
1844
- > ConversationPbxAudioResponse get_pbx_audio(conversation_pbx_audio_uuid)
1845
-
1846
- Get pbx audio
1847
-
1848
- Retrieve a pbx audio
1849
-
1850
- ### Example
1851
- ```ruby
1852
- # load the gem
1853
- require 'ultracart_api'
1854
-
1855
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1856
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1857
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1858
-
1859
-
1860
- conversation_pbx_audio_uuid = 'conversation_pbx_audio_uuid_example' # String |
1861
-
1862
-
1863
- begin
1864
- #Get pbx audio
1865
- result = api_instance.get_pbx_audio(conversation_pbx_audio_uuid)
1866
- p result
1867
- rescue UltracartClient::ApiError => e
1868
- puts "Exception when calling ConversationApi->get_pbx_audio: #{e}"
1869
- end
1870
- ```
1871
-
1872
- ### Parameters
1873
-
1874
- Name | Type | Description | Notes
1875
- ------------- | ------------- | ------------- | -------------
1876
- **conversation_pbx_audio_uuid** | **String**| |
1877
-
1878
- ### Return type
1879
-
1880
- [**ConversationPbxAudioResponse**](ConversationPbxAudioResponse.md)
1881
-
1882
- ### Authorization
1883
-
1884
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1885
-
1886
- ### HTTP request headers
1887
-
1888
- - **Content-Type**: application/json
1889
- - **Accept**: application/json
1890
-
1891
-
1892
-
1893
- # **get_pbx_audio_usage**
1894
- > ConversationPbxAudioUsageResponse get_pbx_audio_usage(conversation_pbx_audio_uuid)
1895
-
1896
- Get pbx audio usage
1897
-
1898
- Retrieve a pbx audio usage
1899
-
1900
- ### Example
1901
- ```ruby
1902
- # load the gem
1903
- require 'ultracart_api'
1904
-
1905
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1906
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1907
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1908
-
1909
-
1910
- conversation_pbx_audio_uuid = 'conversation_pbx_audio_uuid_example' # String |
1911
-
1912
-
1913
- begin
1914
- #Get pbx audio usage
1915
- result = api_instance.get_pbx_audio_usage(conversation_pbx_audio_uuid)
1916
- p result
1917
- rescue UltracartClient::ApiError => e
1918
- puts "Exception when calling ConversationApi->get_pbx_audio_usage: #{e}"
1919
- end
1920
- ```
1921
-
1922
- ### Parameters
1923
-
1924
- Name | Type | Description | Notes
1925
- ------------- | ------------- | ------------- | -------------
1926
- **conversation_pbx_audio_uuid** | **String**| |
1927
-
1928
- ### Return type
1929
-
1930
- [**ConversationPbxAudioUsageResponse**](ConversationPbxAudioUsageResponse.md)
1931
-
1932
- ### Authorization
1933
-
1934
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1935
-
1936
- ### HTTP request headers
1937
-
1938
- - **Content-Type**: application/json
1939
- - **Accept**: application/json
1940
-
1941
-
1942
-
1943
- # **get_pbx_audios**
1944
- > ConversationPbxAudiosResponse get_pbx_audios
1945
-
1946
- Get pbx audios
1947
-
1948
- Retrieve pbx audios
1949
-
1950
- ### Example
1951
- ```ruby
1952
- # load the gem
1953
- require 'ultracart_api'
1954
-
1955
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1956
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1957
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1958
-
1959
-
1960
-
1961
- begin
1962
- #Get pbx audios
1963
- result = api_instance.get_pbx_audios
1964
- p result
1965
- rescue UltracartClient::ApiError => e
1966
- puts "Exception when calling ConversationApi->get_pbx_audios: #{e}"
1967
- end
1968
- ```
1969
-
1970
- ### Parameters
1971
- This endpoint does not need any parameter.
1972
-
1973
- ### Return type
1974
-
1975
- [**ConversationPbxAudiosResponse**](ConversationPbxAudiosResponse.md)
1976
-
1977
- ### Authorization
1978
-
1979
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1980
-
1981
- ### HTTP request headers
1982
-
1983
- - **Content-Type**: application/json
1984
- - **Accept**: application/json
1985
-
1986
-
1987
-
1988
- # **get_pbx_menu**
1989
- > ConversationPbxMenuResponse get_pbx_menu(conversation_pbx_menu_uuid)
1990
-
1991
- Get pbx menu
1992
-
1993
- Retrieve a pbx menu
1994
-
1995
- ### Example
1996
- ```ruby
1997
- # load the gem
1998
- require 'ultracart_api'
1999
-
2000
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
2001
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
2002
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
2003
-
2004
-
2005
- conversation_pbx_menu_uuid = 'conversation_pbx_menu_uuid_example' # String |
2006
-
2007
-
2008
- begin
2009
- #Get pbx menu
2010
- result = api_instance.get_pbx_menu(conversation_pbx_menu_uuid)
2011
- p result
2012
- rescue UltracartClient::ApiError => e
2013
- puts "Exception when calling ConversationApi->get_pbx_menu: #{e}"
2014
- end
2015
- ```
2016
-
2017
- ### Parameters
2018
-
2019
- Name | Type | Description | Notes
2020
- ------------- | ------------- | ------------- | -------------
2021
- **conversation_pbx_menu_uuid** | **String**| |
2022
-
2023
- ### Return type
2024
-
2025
- [**ConversationPbxMenuResponse**](ConversationPbxMenuResponse.md)
2026
-
2027
- ### Authorization
2028
-
2029
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2030
-
2031
- ### HTTP request headers
2032
-
2033
- - **Content-Type**: application/json
2034
- - **Accept**: application/json
2035
-
2036
-
2037
-
2038
- # **get_pbx_menus**
2039
- > ConversationPbxMenusResponse get_pbx_menus
2040
-
2041
- Get pbx menus
2042
-
2043
- Retrieve pbx menus
2044
-
2045
- ### Example
2046
- ```ruby
2047
- # load the gem
2048
- require 'ultracart_api'
2049
-
2050
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
2051
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
2052
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
2053
-
2054
-
2055
-
2056
- begin
2057
- #Get pbx menus
2058
- result = api_instance.get_pbx_menus
2059
- p result
2060
- rescue UltracartClient::ApiError => e
2061
- puts "Exception when calling ConversationApi->get_pbx_menus: #{e}"
2062
- end
2063
- ```
2064
-
2065
- ### Parameters
2066
- This endpoint does not need any parameter.
2067
-
2068
- ### Return type
2069
-
2070
- [**ConversationPbxMenusResponse**](ConversationPbxMenusResponse.md)
2071
-
2072
- ### Authorization
2073
-
2074
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2075
-
2076
- ### HTTP request headers
2077
-
2078
- - **Content-Type**: application/json
2079
- - **Accept**: application/json
2080
-
2081
-
2082
-
2083
- # **get_pbx_phone_number**
2084
- > ConversationPbxPhoneNumberResponse get_pbx_phone_number(conversation_pbx_phone_number_uuid)
2085
-
2086
- Get pbx phoneNumber
2087
-
2088
- Retrieve a pbx phoneNumber
2089
-
2090
- ### Example
2091
- ```ruby
2092
- # load the gem
2093
- require 'ultracart_api'
2094
-
2095
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
2096
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
2097
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
2098
-
2099
-
2100
- conversation_pbx_phone_number_uuid = 'conversation_pbx_phone_number_uuid_example' # String |
2101
-
2102
-
2103
- begin
2104
- #Get pbx phoneNumber
2105
- result = api_instance.get_pbx_phone_number(conversation_pbx_phone_number_uuid)
2106
- p result
2107
- rescue UltracartClient::ApiError => e
2108
- puts "Exception when calling ConversationApi->get_pbx_phone_number: #{e}"
2109
- end
2110
- ```
2111
-
2112
- ### Parameters
2113
-
2114
- Name | Type | Description | Notes
2115
- ------------- | ------------- | ------------- | -------------
2116
- **conversation_pbx_phone_number_uuid** | **String**| |
2117
-
2118
- ### Return type
2119
-
2120
- [**ConversationPbxPhoneNumberResponse**](ConversationPbxPhoneNumberResponse.md)
2121
-
2122
- ### Authorization
2123
-
2124
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2125
-
2126
- ### HTTP request headers
2127
-
2128
- - **Content-Type**: application/json
2129
- - **Accept**: application/json
2130
-
2131
-
2132
-
2133
- # **get_pbx_phone_numbers**
2134
- > ConversationPbxPhoneNumbersResponse get_pbx_phone_numbers
2135
-
2136
- Get pbx phoneNumbers
2137
-
2138
- Retrieve pbx phoneNumbers
2139
-
2140
- ### Example
2141
- ```ruby
2142
- # load the gem
2143
- require 'ultracart_api'
2144
-
2145
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
2146
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
2147
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
2148
-
2149
-
2150
-
2151
- begin
2152
- #Get pbx phoneNumbers
2153
- result = api_instance.get_pbx_phone_numbers
2154
- p result
2155
- rescue UltracartClient::ApiError => e
2156
- puts "Exception when calling ConversationApi->get_pbx_phone_numbers: #{e}"
2157
- end
2158
- ```
2159
-
2160
- ### Parameters
2161
- This endpoint does not need any parameter.
2162
-
2163
- ### Return type
2164
-
2165
- [**ConversationPbxPhoneNumbersResponse**](ConversationPbxPhoneNumbersResponse.md)
2166
-
2167
- ### Authorization
2168
-
2169
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2170
-
2171
- ### HTTP request headers
2172
-
2173
- - **Content-Type**: application/json
2174
- - **Accept**: application/json
2175
-
2176
-
2177
-
2178
- # **get_pbx_queue**
2179
- > ConversationPbxQueueResponse get_pbx_queue(conversation_pbx_queue_uuid)
2180
-
2181
- Get pbx queue
2182
-
2183
- Retrieve a pbx queue
2184
-
2185
- ### Example
2186
- ```ruby
2187
- # load the gem
2188
- require 'ultracart_api'
2189
-
2190
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
2191
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
2192
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
2193
-
2194
-
2195
- conversation_pbx_queue_uuid = 'conversation_pbx_queue_uuid_example' # String |
2196
-
2197
-
2198
- begin
2199
- #Get pbx queue
2200
- result = api_instance.get_pbx_queue(conversation_pbx_queue_uuid)
2201
- p result
2202
- rescue UltracartClient::ApiError => e
2203
- puts "Exception when calling ConversationApi->get_pbx_queue: #{e}"
2204
- end
2205
- ```
2206
-
2207
- ### Parameters
2208
-
2209
- Name | Type | Description | Notes
2210
- ------------- | ------------- | ------------- | -------------
2211
- **conversation_pbx_queue_uuid** | **String**| |
2212
-
2213
- ### Return type
2214
-
2215
- [**ConversationPbxQueueResponse**](ConversationPbxQueueResponse.md)
2216
-
2217
- ### Authorization
2218
-
2219
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2220
-
2221
- ### HTTP request headers
2222
-
2223
- - **Content-Type**: application/json
2224
- - **Accept**: application/json
2225
-
2226
-
2227
-
2228
- # **get_pbx_queue_voicemail**
2229
- > ConversationPbxVoicemailMessageResponse get_pbx_queue_voicemail(queue_uuid, recording_sid)
2230
-
2231
- Get Queue Voicemail
2232
-
2233
- Retrieve pbx queue Voicemail
2234
-
2235
- ### Example
2236
- ```ruby
2237
- # load the gem
2238
- require 'ultracart_api'
2239
-
2240
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
2241
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
2242
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
2243
-
2244
-
2245
- queue_uuid = 'queue_uuid_example' # String |
2246
-
2247
- recording_sid = 'recording_sid_example' # String |
2248
-
2249
-
2250
- begin
2251
- #Get Queue Voicemail
2252
- result = api_instance.get_pbx_queue_voicemail(queue_uuid, recording_sid)
2253
- p result
2254
- rescue UltracartClient::ApiError => e
2255
- puts "Exception when calling ConversationApi->get_pbx_queue_voicemail: #{e}"
2256
- end
2257
- ```
2258
-
2259
- ### Parameters
2260
-
2261
- Name | Type | Description | Notes
2262
- ------------- | ------------- | ------------- | -------------
2263
- **queue_uuid** | **String**| |
2264
- **recording_sid** | **String**| |
2265
-
2266
- ### Return type
2267
-
2268
- [**ConversationPbxVoicemailMessageResponse**](ConversationPbxVoicemailMessageResponse.md)
2269
-
2270
- ### Authorization
2271
-
2272
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2273
-
2274
- ### HTTP request headers
2275
-
2276
- - **Content-Type**: application/json
2277
- - **Accept**: application/json
2278
-
2279
-
2280
-
2281
- # **get_pbx_queue_voicemails**
2282
- > ConversationPbxVoicemailMessageSummariesResponse get_pbx_queue_voicemails(queue_uuid)
2283
-
2284
- Get Queue Voicemails
2285
-
2286
- Retrieve pbx queue voicemails
2287
-
2288
- ### Example
2289
- ```ruby
2290
- # load the gem
2291
- require 'ultracart_api'
2292
-
2293
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
2294
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
2295
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
2296
-
2297
-
2298
- queue_uuid = 'queue_uuid_example' # String |
2299
-
2300
-
2301
- begin
2302
- #Get Queue Voicemails
2303
- result = api_instance.get_pbx_queue_voicemails(queue_uuid)
2304
- p result
2305
- rescue UltracartClient::ApiError => e
2306
- puts "Exception when calling ConversationApi->get_pbx_queue_voicemails: #{e}"
2307
- end
2308
- ```
2309
-
2310
- ### Parameters
2311
-
2312
- Name | Type | Description | Notes
2313
- ------------- | ------------- | ------------- | -------------
2314
- **queue_uuid** | **String**| |
2315
-
2316
- ### Return type
2317
-
2318
- [**ConversationPbxVoicemailMessageSummariesResponse**](ConversationPbxVoicemailMessageSummariesResponse.md)
2319
-
2320
- ### Authorization
2321
-
2322
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2323
-
2324
- ### HTTP request headers
2325
-
2326
- - **Content-Type**: application/json
2327
- - **Accept**: application/json
2328
-
2329
-
2330
-
2331
- # **get_pbx_queues**
2332
- > ConversationPbxQueuesResponse get_pbx_queues
2333
-
2334
- Get pbx queues
2335
-
2336
- Retrieve pbx queues
2337
-
2338
- ### Example
2339
- ```ruby
2340
- # load the gem
2341
- require 'ultracart_api'
2342
-
2343
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
2344
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
2345
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
2346
-
2347
-
2348
-
2349
- begin
2350
- #Get pbx queues
2351
- result = api_instance.get_pbx_queues
2352
- p result
2353
- rescue UltracartClient::ApiError => e
2354
- puts "Exception when calling ConversationApi->get_pbx_queues: #{e}"
2355
- end
2356
- ```
2357
-
2358
- ### Parameters
2359
- This endpoint does not need any parameter.
2360
-
2361
- ### Return type
2362
-
2363
- [**ConversationPbxQueuesResponse**](ConversationPbxQueuesResponse.md)
2364
-
2365
- ### Authorization
2366
-
2367
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2368
-
2369
- ### HTTP request headers
2370
-
2371
- - **Content-Type**: application/json
2372
- - **Accept**: application/json
2373
-
2374
-
2375
-
2376
- # **get_pbx_time_based**
2377
- > ConversationPbxTimeBasedResponse get_pbx_time_based(conversation_pbx_time_based_uuid)
2378
-
2379
- Get pbx timeBased
2380
-
2381
- Retrieve a pbx timeBased
2382
-
2383
- ### Example
2384
- ```ruby
2385
- # load the gem
2386
- require 'ultracart_api'
2387
-
2388
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
2389
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
2390
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
2391
-
2392
-
2393
- conversation_pbx_time_based_uuid = 'conversation_pbx_time_based_uuid_example' # String |
2394
-
2395
-
2396
- begin
2397
- #Get pbx timeBased
2398
- result = api_instance.get_pbx_time_based(conversation_pbx_time_based_uuid)
2399
- p result
2400
- rescue UltracartClient::ApiError => e
2401
- puts "Exception when calling ConversationApi->get_pbx_time_based: #{e}"
2402
- end
2403
- ```
2404
-
2405
- ### Parameters
2406
-
2407
- Name | Type | Description | Notes
2408
- ------------- | ------------- | ------------- | -------------
2409
- **conversation_pbx_time_based_uuid** | **String**| |
2410
-
2411
- ### Return type
2412
-
2413
- [**ConversationPbxTimeBasedResponse**](ConversationPbxTimeBasedResponse.md)
2414
-
2415
- ### Authorization
2416
-
2417
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2418
-
2419
- ### HTTP request headers
2420
-
2421
- - **Content-Type**: application/json
2422
- - **Accept**: application/json
2423
-
2424
-
2425
-
2426
- # **get_pbx_time_baseds**
2427
- > ConversationPbxTimeBasedsResponse get_pbx_time_baseds
2428
-
2429
- Get pbx timeBaseds
2430
-
2431
- Retrieve pbx timeBaseds
2432
-
2433
- ### Example
2434
- ```ruby
2435
- # load the gem
2436
- require 'ultracart_api'
2437
-
2438
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
2439
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
2440
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
2441
-
2442
-
2443
-
2444
- begin
2445
- #Get pbx timeBaseds
2446
- result = api_instance.get_pbx_time_baseds
2447
- p result
2448
- rescue UltracartClient::ApiError => e
2449
- puts "Exception when calling ConversationApi->get_pbx_time_baseds: #{e}"
2450
- end
2451
- ```
2452
-
2453
- ### Parameters
2454
- This endpoint does not need any parameter.
2455
-
2456
- ### Return type
2457
-
2458
- [**ConversationPbxTimeBasedsResponse**](ConversationPbxTimeBasedsResponse.md)
2459
-
2460
- ### Authorization
2461
-
2462
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2463
-
2464
- ### HTTP request headers
2465
-
2466
- - **Content-Type**: application/json
2467
- - **Accept**: application/json
2468
-
2469
-
2470
-
2471
- # **get_pbx_time_range**
2472
- > ConversationPbxTimeRangeResponse get_pbx_time_range(conversation_pbx_time_range_uuid)
2473
-
2474
- Get pbx timeRange
2475
-
2476
- Retrieve a pbx timeRange
2477
-
2478
- ### Example
2479
- ```ruby
2480
- # load the gem
2481
- require 'ultracart_api'
2482
-
2483
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
2484
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
2485
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
2486
-
2487
-
2488
- conversation_pbx_time_range_uuid = 'conversation_pbx_time_range_uuid_example' # String |
2489
-
2490
-
2491
- begin
2492
- #Get pbx timeRange
2493
- result = api_instance.get_pbx_time_range(conversation_pbx_time_range_uuid)
2494
- p result
2495
- rescue UltracartClient::ApiError => e
2496
- puts "Exception when calling ConversationApi->get_pbx_time_range: #{e}"
2497
- end
2498
- ```
2499
-
2500
- ### Parameters
2501
-
2502
- Name | Type | Description | Notes
2503
- ------------- | ------------- | ------------- | -------------
2504
- **conversation_pbx_time_range_uuid** | **String**| |
2505
-
2506
- ### Return type
2507
-
2508
- [**ConversationPbxTimeRangeResponse**](ConversationPbxTimeRangeResponse.md)
2509
-
2510
- ### Authorization
2511
-
2512
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2513
-
2514
- ### HTTP request headers
2515
-
2516
- - **Content-Type**: application/json
2517
- - **Accept**: application/json
2518
-
2519
-
2520
-
2521
- # **get_pbx_time_ranges**
2522
- > ConversationPbxTimeRangesResponse get_pbx_time_ranges
2523
-
2524
- Get pbx timeRanges
2525
-
2526
- Retrieve pbx timeRanges
2527
-
2528
- ### Example
2529
- ```ruby
2530
- # load the gem
2531
- require 'ultracart_api'
2532
-
2533
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
2534
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
2535
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
2536
-
2537
-
2538
-
2539
- begin
2540
- #Get pbx timeRanges
2541
- result = api_instance.get_pbx_time_ranges
2542
- p result
2543
- rescue UltracartClient::ApiError => e
2544
- puts "Exception when calling ConversationApi->get_pbx_time_ranges: #{e}"
2545
- end
2546
- ```
2547
-
2548
- ### Parameters
2549
- This endpoint does not need any parameter.
2550
-
2551
- ### Return type
2552
-
2553
- [**ConversationPbxTimeRangesResponse**](ConversationPbxTimeRangesResponse.md)
2554
-
2555
- ### Authorization
2556
-
2557
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2558
-
2559
- ### HTTP request headers
2560
-
2561
- - **Content-Type**: application/json
2562
- - **Accept**: application/json
2563
-
2564
-
2565
-
2566
- # **get_pbx_voicemail_mailbox**
2567
- > ConversationPbxVoicemailMailboxResponse get_pbx_voicemail_mailbox(conversation_pbx_voicemail_mailbox_uuid)
2568
-
2569
- Get pbx voicemailMailbox
2570
-
2571
- Retrieve a pbx voicemailMailbox
2572
-
2573
- ### Example
2574
- ```ruby
2575
- # load the gem
2576
- require 'ultracart_api'
2577
-
2578
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
2579
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
2580
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
2581
-
2582
-
2583
- conversation_pbx_voicemail_mailbox_uuid = 'conversation_pbx_voicemail_mailbox_uuid_example' # String |
2584
-
2585
-
2586
- begin
2587
- #Get pbx voicemailMailbox
2588
- result = api_instance.get_pbx_voicemail_mailbox(conversation_pbx_voicemail_mailbox_uuid)
2589
- p result
2590
- rescue UltracartClient::ApiError => e
2591
- puts "Exception when calling ConversationApi->get_pbx_voicemail_mailbox: #{e}"
2592
- end
2593
- ```
2594
-
2595
- ### Parameters
2596
-
2597
- Name | Type | Description | Notes
2598
- ------------- | ------------- | ------------- | -------------
2599
- **conversation_pbx_voicemail_mailbox_uuid** | **String**| |
2600
-
2601
- ### Return type
2602
-
2603
- [**ConversationPbxVoicemailMailboxResponse**](ConversationPbxVoicemailMailboxResponse.md)
2604
-
2605
- ### Authorization
2606
-
2607
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2608
-
2609
- ### HTTP request headers
2610
-
2611
- - **Content-Type**: application/json
2612
- - **Accept**: application/json
2613
-
2614
-
2615
-
2616
- # **get_pbx_voicemail_mailboxes**
2617
- > ConversationPbxVoicemailMailboxesResponse get_pbx_voicemail_mailboxes
2618
-
2619
- Get pbx voicemailMailboxes
2620
-
2621
- Retrieve pbx voicemailMailboxes
2622
-
2623
- ### Example
2624
- ```ruby
2625
- # load the gem
2626
- require 'ultracart_api'
2627
-
2628
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
2629
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
2630
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
2631
-
2632
-
2633
-
2634
- begin
2635
- #Get pbx voicemailMailboxes
2636
- result = api_instance.get_pbx_voicemail_mailboxes
2637
- p result
2638
- rescue UltracartClient::ApiError => e
2639
- puts "Exception when calling ConversationApi->get_pbx_voicemail_mailboxes: #{e}"
2640
- end
2641
- ```
2642
-
2643
- ### Parameters
2644
- This endpoint does not need any parameter.
2645
-
2646
- ### Return type
2647
-
2648
- [**ConversationPbxVoicemailMailboxesResponse**](ConversationPbxVoicemailMailboxesResponse.md)
2649
-
2650
- ### Authorization
2651
-
2652
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2653
-
2654
- ### HTTP request headers
2655
-
2656
- - **Content-Type**: application/json
2657
- - **Accept**: application/json
2658
-
2659
-
2660
-
2661
- # **insert_conversation_canned_message**
2662
- > ConversationCannedMessageResponse insert_conversation_canned_message(canned_message)
2663
-
2664
- Insert a canned message
2665
-
2666
- Insert a canned message
2667
-
2668
- ### Example
2669
- ```ruby
2670
- # load the gem
2671
- require 'ultracart_api'
2672
-
2673
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
2674
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
2675
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
2676
-
2677
-
2678
- canned_message = UltracartClient::ConversationCannedMessage.new # ConversationCannedMessage | Canned message
2679
-
2680
-
2681
- begin
2682
- #Insert a canned message
2683
- result = api_instance.insert_conversation_canned_message(canned_message)
2684
- p result
2685
- rescue UltracartClient::ApiError => e
2686
- puts "Exception when calling ConversationApi->insert_conversation_canned_message: #{e}"
2687
- end
2688
- ```
2689
-
2690
- ### Parameters
2691
-
2692
- Name | Type | Description | Notes
2693
- ------------- | ------------- | ------------- | -------------
2694
- **canned_message** | [**ConversationCannedMessage**](ConversationCannedMessage.md)| Canned message |
2695
-
2696
- ### Return type
2697
-
2698
- [**ConversationCannedMessageResponse**](ConversationCannedMessageResponse.md)
2699
-
2700
- ### Authorization
2701
-
2702
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2703
-
2704
- ### HTTP request headers
2705
-
2706
- - **Content-Type**: application/json
2707
- - **Accept**: application/json
2708
-
2709
-
2710
-
2711
- # **insert_conversation_department**
2712
- > ConversationDepartmentResponse insert_conversation_department(department)
2713
-
2714
- Insert a department
2715
-
2716
- Insert a department
2717
-
2718
- ### Example
2719
- ```ruby
2720
- # load the gem
2721
- require 'ultracart_api'
2722
-
2723
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
2724
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
2725
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
2726
-
2727
-
2728
- department = UltracartClient::ConversationDepartment.new # ConversationDepartment | Department
2729
-
2730
-
2731
- begin
2732
- #Insert a department
2733
- result = api_instance.insert_conversation_department(department)
2734
- p result
2735
- rescue UltracartClient::ApiError => e
2736
- puts "Exception when calling ConversationApi->insert_conversation_department: #{e}"
2737
- end
2738
- ```
2739
-
2740
- ### Parameters
2741
-
2742
- Name | Type | Description | Notes
2743
- ------------- | ------------- | ------------- | -------------
2744
- **department** | [**ConversationDepartment**](ConversationDepartment.md)| Department |
2745
-
2746
- ### Return type
2747
-
2748
- [**ConversationDepartmentResponse**](ConversationDepartmentResponse.md)
2749
-
2750
- ### Authorization
2751
-
2752
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2753
-
2754
- ### HTTP request headers
2755
-
2756
- - **Content-Type**: application/json
2757
- - **Accept**: application/json
2758
-
2759
-
2760
-
2761
- # **insert_conversation_engagement**
2762
- > ConversationEngagementResponse insert_conversation_engagement(engagement)
2763
-
2764
- Insert a engagement
2765
-
2766
- Insert a engagement
2767
-
2768
- ### Example
2769
- ```ruby
2770
- # load the gem
2771
- require 'ultracart_api'
2772
-
2773
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
2774
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
2775
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
2776
-
2777
-
2778
- engagement = UltracartClient::ConversationEngagement.new # ConversationEngagement | Engagement
2779
-
2780
-
2781
- begin
2782
- #Insert a engagement
2783
- result = api_instance.insert_conversation_engagement(engagement)
2784
- p result
2785
- rescue UltracartClient::ApiError => e
2786
- puts "Exception when calling ConversationApi->insert_conversation_engagement: #{e}"
2787
- end
2788
- ```
2789
-
2790
- ### Parameters
2791
-
2792
- Name | Type | Description | Notes
2793
- ------------- | ------------- | ------------- | -------------
2794
- **engagement** | [**ConversationEngagement**](ConversationEngagement.md)| Engagement |
2795
-
2796
- ### Return type
2797
-
2798
- [**ConversationEngagementResponse**](ConversationEngagementResponse.md)
2799
-
2800
- ### Authorization
2801
-
2802
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2803
-
2804
- ### HTTP request headers
2805
-
2806
- - **Content-Type**: application/json
2807
- - **Accept**: application/json
2808
-
2809
-
2810
-
2811
- # **insert_pbx_audio**
2812
- > ConversationPbxAudioResponse insert_pbx_audio(pbx_audio)
2813
-
2814
- Insert pbx audio
2815
-
2816
- Insert a pbx audio
2817
-
2818
- ### Example
2819
- ```ruby
2820
- # load the gem
2821
- require 'ultracart_api'
2822
-
2823
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
2824
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
2825
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
2826
-
2827
-
2828
- pbx_audio = UltracartClient::ConversationPbxAudio.new # ConversationPbxAudio | Pbx Audio
2829
-
2830
-
2831
- begin
2832
- #Insert pbx audio
2833
- result = api_instance.insert_pbx_audio(pbx_audio)
2834
- p result
2835
- rescue UltracartClient::ApiError => e
2836
- puts "Exception when calling ConversationApi->insert_pbx_audio: #{e}"
2837
- end
2838
- ```
2839
-
2840
- ### Parameters
2841
-
2842
- Name | Type | Description | Notes
2843
- ------------- | ------------- | ------------- | -------------
2844
- **pbx_audio** | [**ConversationPbxAudio**](ConversationPbxAudio.md)| Pbx Audio |
2845
-
2846
- ### Return type
2847
-
2848
- [**ConversationPbxAudioResponse**](ConversationPbxAudioResponse.md)
2849
-
2850
- ### Authorization
2851
-
2852
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2853
-
2854
- ### HTTP request headers
2855
-
2856
- - **Content-Type**: application/json
2857
- - **Accept**: application/json
2858
-
2859
-
2860
-
2861
- # **insert_pbx_menu**
2862
- > ConversationPbxMenuResponse insert_pbx_menu(pbx_menu)
2863
-
2864
- Insert pbx menu
2865
-
2866
- Insert a pbx menu
2867
-
2868
- ### Example
2869
- ```ruby
2870
- # load the gem
2871
- require 'ultracart_api'
2872
-
2873
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
2874
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
2875
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
2876
-
2877
-
2878
- pbx_menu = UltracartClient::ConversationPbxMenu.new # ConversationPbxMenu | Pbx Menu
2879
-
2880
-
2881
- begin
2882
- #Insert pbx menu
2883
- result = api_instance.insert_pbx_menu(pbx_menu)
2884
- p result
2885
- rescue UltracartClient::ApiError => e
2886
- puts "Exception when calling ConversationApi->insert_pbx_menu: #{e}"
2887
- end
2888
- ```
2889
-
2890
- ### Parameters
2891
-
2892
- Name | Type | Description | Notes
2893
- ------------- | ------------- | ------------- | -------------
2894
- **pbx_menu** | [**ConversationPbxMenu**](ConversationPbxMenu.md)| Pbx Menu |
2895
-
2896
- ### Return type
2897
-
2898
- [**ConversationPbxMenuResponse**](ConversationPbxMenuResponse.md)
2899
-
2900
- ### Authorization
2901
-
2902
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2903
-
2904
- ### HTTP request headers
2905
-
2906
- - **Content-Type**: application/json
2907
- - **Accept**: application/json
2908
-
2909
-
2910
-
2911
- # **insert_pbx_queue**
2912
- > ConversationPbxQueueResponse insert_pbx_queue(pbx_queue)
2913
-
2914
- Insert pbx queue
2915
-
2916
- Insert a pbx queue
2917
-
2918
- ### Example
2919
- ```ruby
2920
- # load the gem
2921
- require 'ultracart_api'
2922
-
2923
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
2924
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
2925
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
2926
-
2927
-
2928
- pbx_queue = UltracartClient::ConversationPbxQueue.new # ConversationPbxQueue | Pbx Queue
2929
-
2930
-
2931
- begin
2932
- #Insert pbx queue
2933
- result = api_instance.insert_pbx_queue(pbx_queue)
2934
- p result
2935
- rescue UltracartClient::ApiError => e
2936
- puts "Exception when calling ConversationApi->insert_pbx_queue: #{e}"
2937
- end
2938
- ```
2939
-
2940
- ### Parameters
2941
-
2942
- Name | Type | Description | Notes
2943
- ------------- | ------------- | ------------- | -------------
2944
- **pbx_queue** | [**ConversationPbxQueue**](ConversationPbxQueue.md)| Pbx Queue |
2945
-
2946
- ### Return type
2947
-
2948
- [**ConversationPbxQueueResponse**](ConversationPbxQueueResponse.md)
2949
-
2950
- ### Authorization
2951
-
2952
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2953
-
2954
- ### HTTP request headers
2955
-
2956
- - **Content-Type**: application/json
2957
- - **Accept**: application/json
2958
-
2959
-
2960
-
2961
- # **insert_pbx_time_based**
2962
- > ConversationPbxTimeBasedResponse insert_pbx_time_based(pbx_time_based)
2963
-
2964
- Insert pbx timeBased
2965
-
2966
- Insert a pbx timeBased
2967
-
2968
- ### Example
2969
- ```ruby
2970
- # load the gem
2971
- require 'ultracart_api'
2972
-
2973
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
2974
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
2975
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
2976
-
2977
-
2978
- pbx_time_based = UltracartClient::ConversationPbxTimeBased.new # ConversationPbxTimeBased | Pbx TimeBased
2979
-
2980
-
2981
- begin
2982
- #Insert pbx timeBased
2983
- result = api_instance.insert_pbx_time_based(pbx_time_based)
2984
- p result
2985
- rescue UltracartClient::ApiError => e
2986
- puts "Exception when calling ConversationApi->insert_pbx_time_based: #{e}"
2987
- end
2988
- ```
2989
-
2990
- ### Parameters
2991
-
2992
- Name | Type | Description | Notes
2993
- ------------- | ------------- | ------------- | -------------
2994
- **pbx_time_based** | [**ConversationPbxTimeBased**](ConversationPbxTimeBased.md)| Pbx TimeBased |
2995
-
2996
- ### Return type
2997
-
2998
- [**ConversationPbxTimeBasedResponse**](ConversationPbxTimeBasedResponse.md)
2999
-
3000
- ### Authorization
3001
-
3002
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3003
-
3004
- ### HTTP request headers
3005
-
3006
- - **Content-Type**: application/json
3007
- - **Accept**: application/json
3008
-
3009
-
3010
-
3011
- # **insert_pbx_time_range**
3012
- > ConversationPbxTimeRangeResponse insert_pbx_time_range(pbx_time_range)
3013
-
3014
- Insert pbx timeRange
3015
-
3016
- Insert a pbx timeRange
3017
-
3018
- ### Example
3019
- ```ruby
3020
- # load the gem
3021
- require 'ultracart_api'
3022
-
3023
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
3024
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
3025
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
3026
-
3027
-
3028
- pbx_time_range = UltracartClient::ConversationPbxTimeRange.new # ConversationPbxTimeRange | Pbx TimeRange
3029
-
3030
-
3031
- begin
3032
- #Insert pbx timeRange
3033
- result = api_instance.insert_pbx_time_range(pbx_time_range)
3034
- p result
3035
- rescue UltracartClient::ApiError => e
3036
- puts "Exception when calling ConversationApi->insert_pbx_time_range: #{e}"
3037
- end
3038
- ```
3039
-
3040
- ### Parameters
3041
-
3042
- Name | Type | Description | Notes
3043
- ------------- | ------------- | ------------- | -------------
3044
- **pbx_time_range** | [**ConversationPbxTimeRange**](ConversationPbxTimeRange.md)| Pbx TimeRange |
3045
-
3046
- ### Return type
3047
-
3048
- [**ConversationPbxTimeRangeResponse**](ConversationPbxTimeRangeResponse.md)
3049
-
3050
- ### Authorization
3051
-
3052
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3053
-
3054
- ### HTTP request headers
3055
-
3056
- - **Content-Type**: application/json
3057
- - **Accept**: application/json
3058
-
3059
-
3060
-
3061
- # **insert_pbx_voicemail_mailbox**
3062
- > ConversationPbxVoicemailMailboxResponse insert_pbx_voicemail_mailbox(pbx_voicemail_mailbox)
3063
-
3064
- Insert pbx voicemailMailbox
3065
-
3066
- Insert a pbx voicemailMailbox
3067
-
3068
- ### Example
3069
- ```ruby
3070
- # load the gem
3071
- require 'ultracart_api'
3072
-
3073
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
3074
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
3075
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
3076
-
3077
-
3078
- pbx_voicemail_mailbox = UltracartClient::ConversationPbxVoicemailMailbox.new # ConversationPbxVoicemailMailbox | Pbx VoicemailMailbox
3079
-
3080
-
3081
- begin
3082
- #Insert pbx voicemailMailbox
3083
- result = api_instance.insert_pbx_voicemail_mailbox(pbx_voicemail_mailbox)
3084
- p result
3085
- rescue UltracartClient::ApiError => e
3086
- puts "Exception when calling ConversationApi->insert_pbx_voicemail_mailbox: #{e}"
3087
- end
3088
- ```
3089
-
3090
- ### Parameters
3091
-
3092
- Name | Type | Description | Notes
3093
- ------------- | ------------- | ------------- | -------------
3094
- **pbx_voicemail_mailbox** | [**ConversationPbxVoicemailMailbox**](ConversationPbxVoicemailMailbox.md)| Pbx VoicemailMailbox |
3095
-
3096
- ### Return type
3097
-
3098
- [**ConversationPbxVoicemailMailboxResponse**](ConversationPbxVoicemailMailboxResponse.md)
3099
-
3100
- ### Authorization
3101
-
3102
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3103
-
3104
- ### HTTP request headers
3105
-
3106
- - **Content-Type**: application/json
3107
- - **Accept**: application/json
3108
-
3109
-
3110
-
3111
- # **join_conversation**
3112
- > join_conversation(conversation_uuid, opts)
3113
-
3114
- Join a conversation
3115
-
3116
- Join a conversation
3117
-
3118
- ### Example
3119
- ```ruby
3120
- # load the gem
3121
- require 'ultracart_api'
3122
-
3123
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
3124
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
3125
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
3126
-
3127
-
3128
- conversation_uuid = 'conversation_uuid_example' # String |
3129
-
3130
- opts = {
3131
- join_request: UltracartClient::ConversationJoinRequest.new # ConversationJoinRequest | Join request
3132
- }
3133
-
3134
- begin
3135
- #Join a conversation
3136
- api_instance.join_conversation(conversation_uuid, opts)
3137
- rescue UltracartClient::ApiError => e
3138
- puts "Exception when calling ConversationApi->join_conversation: #{e}"
3139
- end
3140
- ```
3141
-
3142
- ### Parameters
3143
-
3144
- Name | Type | Description | Notes
3145
- ------------- | ------------- | ------------- | -------------
3146
- **conversation_uuid** | **String**| |
3147
- **join_request** | [**ConversationJoinRequest**](ConversationJoinRequest.md)| Join request | [optional]
3148
-
3149
- ### Return type
3150
-
3151
- nil (empty response body)
3152
-
3153
- ### Authorization
3154
-
3155
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3156
-
3157
- ### HTTP request headers
3158
-
3159
- - **Content-Type**: application/json
3160
- - **Accept**: application/json
3161
-
3162
-
3163
-
3164
- # **leave_conversation**
3165
- > leave_conversation(conversation_uuid)
3166
-
3167
- Leave a conversation
3168
-
3169
- Leave a conversation
3170
-
3171
- ### Example
3172
- ```ruby
3173
- # load the gem
3174
- require 'ultracart_api'
3175
-
3176
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
3177
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
3178
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
3179
-
3180
-
3181
- conversation_uuid = 'conversation_uuid_example' # String |
3182
-
3183
-
3184
- begin
3185
- #Leave a conversation
3186
- api_instance.leave_conversation(conversation_uuid)
3187
- rescue UltracartClient::ApiError => e
3188
- puts "Exception when calling ConversationApi->leave_conversation: #{e}"
3189
- end
3190
- ```
3191
-
3192
- ### Parameters
3193
-
3194
- Name | Type | Description | Notes
3195
- ------------- | ------------- | ------------- | -------------
3196
- **conversation_uuid** | **String**| |
3197
-
3198
- ### Return type
3199
-
3200
- nil (empty response body)
3201
-
3202
- ### Authorization
3203
-
3204
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3205
-
3206
- ### HTTP request headers
3207
-
3208
- - **Content-Type**: application/json
3209
- - **Accept**: application/json
3210
-
3211
-
3212
-
3213
- # **listened_pbx_agent_voicemail**
3214
- > listened_pbx_agent_voicemail(recording_sid)
3215
-
3216
- Listened Agent Voicemail
3217
-
3218
- Listened pbx agent Voicemail
3219
-
3220
- ### Example
3221
- ```ruby
3222
- # load the gem
3223
- require 'ultracart_api'
3224
-
3225
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
3226
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
3227
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
3228
-
3229
-
3230
- recording_sid = 'recording_sid_example' # String |
3231
-
3232
-
3233
- begin
3234
- #Listened Agent Voicemail
3235
- api_instance.listened_pbx_agent_voicemail(recording_sid)
3236
- rescue UltracartClient::ApiError => e
3237
- puts "Exception when calling ConversationApi->listened_pbx_agent_voicemail: #{e}"
3238
- end
3239
- ```
3240
-
3241
- ### Parameters
3242
-
3243
- Name | Type | Description | Notes
3244
- ------------- | ------------- | ------------- | -------------
3245
- **recording_sid** | **String**| |
3246
-
3247
- ### Return type
3248
-
3249
- nil (empty response body)
3250
-
3251
- ### Authorization
3252
-
3253
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3254
-
3255
- ### HTTP request headers
3256
-
3257
- - **Content-Type**: application/json
3258
- - **Accept**: application/json
3259
-
3260
-
3261
-
3262
- # **listened_pbx_queue_voicemail**
3263
- > listened_pbx_queue_voicemail(queue_uuid, recording_sid)
3264
-
3265
- Listened Queue Voicemail
3266
-
3267
- Listened pbx queue Voicemail
3268
-
3269
- ### Example
3270
- ```ruby
3271
- # load the gem
3272
- require 'ultracart_api'
3273
-
3274
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
3275
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
3276
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
3277
-
3278
-
3279
- queue_uuid = 'queue_uuid_example' # String |
3280
-
3281
- recording_sid = 'recording_sid_example' # String |
3282
-
3283
-
3284
- begin
3285
- #Listened Queue Voicemail
3286
- api_instance.listened_pbx_queue_voicemail(queue_uuid, recording_sid)
3287
- rescue UltracartClient::ApiError => e
3288
- puts "Exception when calling ConversationApi->listened_pbx_queue_voicemail: #{e}"
3289
- end
3290
- ```
3291
-
3292
- ### Parameters
3293
-
3294
- Name | Type | Description | Notes
3295
- ------------- | ------------- | ------------- | -------------
3296
- **queue_uuid** | **String**| |
3297
- **recording_sid** | **String**| |
3298
-
3299
- ### Return type
3300
-
3301
- nil (empty response body)
3302
-
3303
- ### Authorization
3304
-
3305
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3306
-
3307
- ### HTTP request headers
3308
-
3309
- - **Content-Type**: application/json
3310
- - **Accept**: application/json
3311
-
3312
-
3313
-
3314
- # **mark_read_conversation**
3315
- > mark_read_conversation(conversation_uuid)
3316
-
3317
- Mark a conversation as read
3318
-
3319
- Mark a conversation as read
3320
-
3321
- ### Example
3322
- ```ruby
3323
- # load the gem
3324
- require 'ultracart_api'
3325
-
3326
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
3327
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
3328
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
3329
-
3330
-
3331
- conversation_uuid = 'conversation_uuid_example' # String |
3332
-
3333
-
3334
- begin
3335
- #Mark a conversation as read
3336
- api_instance.mark_read_conversation(conversation_uuid)
3337
- rescue UltracartClient::ApiError => e
3338
- puts "Exception when calling ConversationApi->mark_read_conversation: #{e}"
3339
- end
3340
- ```
3341
-
3342
- ### Parameters
3343
-
3344
- Name | Type | Description | Notes
3345
- ------------- | ------------- | ------------- | -------------
3346
- **conversation_uuid** | **String**| |
3347
-
3348
- ### Return type
3349
-
3350
- nil (empty response body)
3351
-
3352
- ### Authorization
3353
-
3354
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3355
-
3356
- ### HTTP request headers
3357
-
3358
- - **Content-Type**: application/json
3359
- - **Accept**: application/json
3360
-
3361
-
3362
-
3363
- # **reset_conversation_pbx_queue_statistics**
3364
- > reset_conversation_pbx_queue_statistics(queue_uuid)
3365
-
3366
- reset statistics within the queue
3367
-
3368
- reset statistics within the queue
3369
-
3370
- ### Example
3371
- ```ruby
3372
- # load the gem
3373
- require 'ultracart_api'
3374
-
3375
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
3376
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
3377
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
3378
-
3379
-
3380
- queue_uuid = 'queue_uuid_example' # String |
3381
-
3382
-
3383
- begin
3384
- #reset statistics within the queue
3385
- api_instance.reset_conversation_pbx_queue_statistics(queue_uuid)
3386
- rescue UltracartClient::ApiError => e
3387
- puts "Exception when calling ConversationApi->reset_conversation_pbx_queue_statistics: #{e}"
3388
- end
3389
- ```
3390
-
3391
- ### Parameters
3392
-
3393
- Name | Type | Description | Notes
3394
- ------------- | ------------- | ------------- | -------------
3395
- **queue_uuid** | **String**| |
3396
-
3397
- ### Return type
3398
-
3399
- nil (empty response body)
3400
-
3401
- ### Authorization
3402
-
3403
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3404
-
3405
- ### HTTP request headers
3406
-
3407
- - **Content-Type**: application/json
3408
- - **Accept**: application/json
3409
-
3410
-
3411
-
3412
- # **search_conversation_canned_messages**
3413
- > ConversationCannedMessagesResponse search_conversation_canned_messages(search_request)
3414
-
3415
- Search for canned messages by short_code
3416
-
3417
- Search for canned messages by short_code
3418
-
3419
- ### Example
3420
- ```ruby
3421
- # load the gem
3422
- require 'ultracart_api'
3423
-
3424
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
3425
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
3426
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
3427
-
3428
-
3429
- search_request = UltracartClient::ConversationCannedMessagesSearch.new # ConversationCannedMessagesSearch | Search request
3430
-
3431
-
3432
- begin
3433
- #Search for canned messages by short_code
3434
- result = api_instance.search_conversation_canned_messages(search_request)
3435
- p result
3436
- rescue UltracartClient::ApiError => e
3437
- puts "Exception when calling ConversationApi->search_conversation_canned_messages: #{e}"
3438
- end
3439
- ```
3440
-
3441
- ### Parameters
3442
-
3443
- Name | Type | Description | Notes
3444
- ------------- | ------------- | ------------- | -------------
3445
- **search_request** | [**ConversationCannedMessagesSearch**](ConversationCannedMessagesSearch.md)| Search request |
3446
-
3447
- ### Return type
3448
-
3449
- [**ConversationCannedMessagesResponse**](ConversationCannedMessagesResponse.md)
3450
-
3451
- ### Authorization
3452
-
3453
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3454
-
3455
- ### HTTP request headers
3456
-
3457
- - **Content-Type**: application/json
3458
- - **Accept**: application/json
3459
-
3460
-
3461
-
3462
- # **sms_unsubscribe_conversation**
3463
- > sms_unsubscribe_conversation(conversation_uuid)
3464
-
3465
- Unsubscribe any SMS participants in this conversation
3466
-
3467
- Unsubscribe any SMS participants in this conversation
3468
-
3469
- ### Example
3470
- ```ruby
3471
- # load the gem
3472
- require 'ultracart_api'
3473
-
3474
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
3475
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
3476
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
3477
-
3478
-
3479
- conversation_uuid = 'conversation_uuid_example' # String |
3480
-
3481
-
3482
- begin
3483
- #Unsubscribe any SMS participants in this conversation
3484
- api_instance.sms_unsubscribe_conversation(conversation_uuid)
3485
- rescue UltracartClient::ApiError => e
3486
- puts "Exception when calling ConversationApi->sms_unsubscribe_conversation: #{e}"
3487
- end
3488
- ```
3489
-
3490
- ### Parameters
3491
-
3492
- Name | Type | Description | Notes
3493
- ------------- | ------------- | ------------- | -------------
3494
- **conversation_uuid** | **String**| |
3495
-
3496
- ### Return type
3497
-
3498
- nil (empty response body)
3499
-
3500
- ### Authorization
3501
-
3502
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3503
-
3504
- ### HTTP request headers
3505
-
3506
- - **Content-Type**: application/json
3507
- - **Accept**: application/json
3508
-
3509
-
3510
-
3511
- # **start_conversation**
3512
- > ConversationStartResponse start_conversation(start_request)
3513
-
3514
- Start a conversation
3515
-
3516
- Start a new conversation
3517
-
3518
- ### Example
3519
- ```ruby
3520
- # load the gem
3521
- require 'ultracart_api'
3522
-
3523
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
3524
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
3525
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
3526
-
3527
-
3528
- start_request = UltracartClient::ConversationStartRequest.new # ConversationStartRequest | Start request
3529
-
3530
-
3531
- begin
3532
- #Start a conversation
3533
- result = api_instance.start_conversation(start_request)
3534
- p result
3535
- rescue UltracartClient::ApiError => e
3536
- puts "Exception when calling ConversationApi->start_conversation: #{e}"
3537
- end
3538
- ```
3539
-
3540
- ### Parameters
3541
-
3542
- Name | Type | Description | Notes
3543
- ------------- | ------------- | ------------- | -------------
3544
- **start_request** | [**ConversationStartRequest**](ConversationStartRequest.md)| Start request |
3545
-
3546
- ### Return type
3547
-
3548
- [**ConversationStartResponse**](ConversationStartResponse.md)
3549
-
3550
- ### Authorization
3551
-
3552
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3553
-
3554
- ### HTTP request headers
3555
-
3556
- - **Content-Type**: application/json
3557
- - **Accept**: application/json
3558
-
3559
-
3560
-
3561
- # **update_agent_profile**
3562
- > ConversationAgentProfileResponse update_agent_profile(profile_request)
3563
-
3564
- Update agent profile
3565
-
3566
- Update agent profile
3567
-
3568
- ### Example
3569
- ```ruby
3570
- # load the gem
3571
- require 'ultracart_api'
3572
-
3573
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
3574
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
3575
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
3576
-
3577
-
3578
- profile_request = UltracartClient::ConversationAgentProfile.new # ConversationAgentProfile | Profile request
3579
-
3580
-
3581
- begin
3582
- #Update agent profile
3583
- result = api_instance.update_agent_profile(profile_request)
3584
- p result
3585
- rescue UltracartClient::ApiError => e
3586
- puts "Exception when calling ConversationApi->update_agent_profile: #{e}"
3587
- end
3588
- ```
3589
-
3590
- ### Parameters
3591
-
3592
- Name | Type | Description | Notes
3593
- ------------- | ------------- | ------------- | -------------
3594
- **profile_request** | [**ConversationAgentProfile**](ConversationAgentProfile.md)| Profile request |
3595
-
3596
- ### Return type
3597
-
3598
- [**ConversationAgentProfileResponse**](ConversationAgentProfileResponse.md)
3599
-
3600
- ### Authorization
3601
-
3602
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3603
-
3604
- ### HTTP request headers
3605
-
3606
- - **Content-Type**: application/json
3607
- - **Accept**: application/json
3608
-
3609
-
3610
-
3611
- # **update_conversation_canned_message**
3612
- > ConversationCannedMessageResponse update_conversation_canned_message(conversation_canned_message_oid, canned_message)
3613
-
3614
- Update a canned message
3615
-
3616
- Update a canned message
3617
-
3618
- ### Example
3619
- ```ruby
3620
- # load the gem
3621
- require 'ultracart_api'
3622
-
3623
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
3624
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
3625
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
3626
-
3627
-
3628
- conversation_canned_message_oid = 56 # Integer |
3629
-
3630
- canned_message = UltracartClient::ConversationCannedMessage.new # ConversationCannedMessage | Canned message
3631
-
3632
-
3633
- begin
3634
- #Update a canned message
3635
- result = api_instance.update_conversation_canned_message(conversation_canned_message_oid, canned_message)
3636
- p result
3637
- rescue UltracartClient::ApiError => e
3638
- puts "Exception when calling ConversationApi->update_conversation_canned_message: #{e}"
3639
- end
3640
- ```
3641
-
3642
- ### Parameters
3643
-
3644
- Name | Type | Description | Notes
3645
- ------------- | ------------- | ------------- | -------------
3646
- **conversation_canned_message_oid** | **Integer**| |
3647
- **canned_message** | [**ConversationCannedMessage**](ConversationCannedMessage.md)| Canned message |
3648
-
3649
- ### Return type
3650
-
3651
- [**ConversationCannedMessageResponse**](ConversationCannedMessageResponse.md)
3652
-
3653
- ### Authorization
3654
-
3655
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3656
-
3657
- ### HTTP request headers
3658
-
3659
- - **Content-Type**: application/json
3660
- - **Accept**: application/json
3661
-
3662
-
3663
-
3664
- # **update_conversation_department**
3665
- > ConversationDepartmentResponse update_conversation_department(conversation_department_oid, department)
3666
-
3667
- Update a department
3668
-
3669
- Update a department
3670
-
3671
- ### Example
3672
- ```ruby
3673
- # load the gem
3674
- require 'ultracart_api'
3675
-
3676
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
3677
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
3678
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
3679
-
3680
-
3681
- conversation_department_oid = 56 # Integer |
3682
-
3683
- department = UltracartClient::ConversationDepartment.new # ConversationDepartment | Department
3684
-
3685
-
3686
- begin
3687
- #Update a department
3688
- result = api_instance.update_conversation_department(conversation_department_oid, department)
3689
- p result
3690
- rescue UltracartClient::ApiError => e
3691
- puts "Exception when calling ConversationApi->update_conversation_department: #{e}"
3692
- end
3693
- ```
3694
-
3695
- ### Parameters
3696
-
3697
- Name | Type | Description | Notes
3698
- ------------- | ------------- | ------------- | -------------
3699
- **conversation_department_oid** | **Integer**| |
3700
- **department** | [**ConversationDepartment**](ConversationDepartment.md)| Department |
3701
-
3702
- ### Return type
3703
-
3704
- [**ConversationDepartmentResponse**](ConversationDepartmentResponse.md)
3705
-
3706
- ### Authorization
3707
-
3708
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3709
-
3710
- ### HTTP request headers
3711
-
3712
- - **Content-Type**: application/json
3713
- - **Accept**: application/json
3714
-
3715
-
3716
-
3717
- # **update_conversation_engagement**
3718
- > ConversationEngagementResponse update_conversation_engagement(conversation_engagement_oid, engagement)
3719
-
3720
- Update a engagement
3721
-
3722
- Update a engagement
3723
-
3724
- ### Example
3725
- ```ruby
3726
- # load the gem
3727
- require 'ultracart_api'
3728
-
3729
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
3730
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
3731
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
3732
-
3733
-
3734
- conversation_engagement_oid = 56 # Integer |
3735
-
3736
- engagement = UltracartClient::ConversationEngagement.new # ConversationEngagement | Engagement
3737
-
3738
-
3739
- begin
3740
- #Update a engagement
3741
- result = api_instance.update_conversation_engagement(conversation_engagement_oid, engagement)
3742
- p result
3743
- rescue UltracartClient::ApiError => e
3744
- puts "Exception when calling ConversationApi->update_conversation_engagement: #{e}"
3745
- end
3746
- ```
3747
-
3748
- ### Parameters
3749
-
3750
- Name | Type | Description | Notes
3751
- ------------- | ------------- | ------------- | -------------
3752
- **conversation_engagement_oid** | **Integer**| |
3753
- **engagement** | [**ConversationEngagement**](ConversationEngagement.md)| Engagement |
3754
-
3755
- ### Return type
3756
-
3757
- [**ConversationEngagementResponse**](ConversationEngagementResponse.md)
3758
-
3759
- ### Authorization
3760
-
3761
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3762
-
3763
- ### HTTP request headers
3764
-
3765
- - **Content-Type**: application/json
3766
- - **Accept**: application/json
3767
-
3768
-
3769
-
3770
- # **update_conversation_webchat_queue_status**
3771
- > update_conversation_webchat_queue_status(queue_name, status_request)
3772
-
3773
- Update status within the queue
3774
-
3775
- Update status within the queue
3776
-
3777
- ### Example
3778
- ```ruby
3779
- # load the gem
3780
- require 'ultracart_api'
3781
-
3782
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
3783
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
3784
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
3785
-
3786
-
3787
- queue_name = 'queue_name_example' # String |
3788
-
3789
- status_request = UltracartClient::ConversationWebchatQueueStatusUpdateRequest.new # ConversationWebchatQueueStatusUpdateRequest | Status request
3790
-
3791
-
3792
- begin
3793
- #Update status within the queue
3794
- api_instance.update_conversation_webchat_queue_status(queue_name, status_request)
3795
- rescue UltracartClient::ApiError => e
3796
- puts "Exception when calling ConversationApi->update_conversation_webchat_queue_status: #{e}"
3797
- end
3798
- ```
3799
-
3800
- ### Parameters
3801
-
3802
- Name | Type | Description | Notes
3803
- ------------- | ------------- | ------------- | -------------
3804
- **queue_name** | **String**| |
3805
- **status_request** | [**ConversationWebchatQueueStatusUpdateRequest**](ConversationWebchatQueueStatusUpdateRequest.md)| Status request |
3806
-
3807
- ### Return type
3808
-
3809
- nil (empty response body)
3810
-
3811
- ### Authorization
3812
-
3813
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3814
-
3815
- ### HTTP request headers
3816
-
3817
- - **Content-Type**: application/json
3818
- - **Accept**: application/json
3819
-
3820
-
3821
-
3822
- # **update_pbx_agent**
3823
- > ConversationPbxAgentResponse update_pbx_agent(conversation_pbx_agent_uuid, pbx_agent)
3824
-
3825
- Update pbx agent
3826
-
3827
- Update a pbx agent
3828
-
3829
- ### Example
3830
- ```ruby
3831
- # load the gem
3832
- require 'ultracart_api'
3833
-
3834
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
3835
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
3836
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
3837
-
3838
-
3839
- conversation_pbx_agent_uuid = 'conversation_pbx_agent_uuid_example' # String |
3840
-
3841
- pbx_agent = UltracartClient::ConversationPbxAgent.new # ConversationPbxAgent | Pbx Agent
3842
-
3843
-
3844
- begin
3845
- #Update pbx agent
3846
- result = api_instance.update_pbx_agent(conversation_pbx_agent_uuid, pbx_agent)
3847
- p result
3848
- rescue UltracartClient::ApiError => e
3849
- puts "Exception when calling ConversationApi->update_pbx_agent: #{e}"
3850
- end
3851
- ```
3852
-
3853
- ### Parameters
3854
-
3855
- Name | Type | Description | Notes
3856
- ------------- | ------------- | ------------- | -------------
3857
- **conversation_pbx_agent_uuid** | **String**| |
3858
- **pbx_agent** | [**ConversationPbxAgent**](ConversationPbxAgent.md)| Pbx Agent |
3859
-
3860
- ### Return type
3861
-
3862
- [**ConversationPbxAgentResponse**](ConversationPbxAgentResponse.md)
3863
-
3864
- ### Authorization
3865
-
3866
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3867
-
3868
- ### HTTP request headers
3869
-
3870
- - **Content-Type**: application/json
3871
- - **Accept**: application/json
3872
-
3873
-
3874
-
3875
- # **update_pbx_audio**
3876
- > ConversationPbxAudioResponse update_pbx_audio(conversation_pbx_audio_uuid, pbx_audio)
3877
-
3878
- Update pbx audio
3879
-
3880
- Update a pbx audio
3881
-
3882
- ### Example
3883
- ```ruby
3884
- # load the gem
3885
- require 'ultracart_api'
3886
-
3887
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
3888
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
3889
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
3890
-
3891
-
3892
- conversation_pbx_audio_uuid = 'conversation_pbx_audio_uuid_example' # String |
3893
-
3894
- pbx_audio = UltracartClient::ConversationPbxAudio.new # ConversationPbxAudio | Pbx Audio
3895
-
3896
-
3897
- begin
3898
- #Update pbx audio
3899
- result = api_instance.update_pbx_audio(conversation_pbx_audio_uuid, pbx_audio)
3900
- p result
3901
- rescue UltracartClient::ApiError => e
3902
- puts "Exception when calling ConversationApi->update_pbx_audio: #{e}"
3903
- end
3904
- ```
3905
-
3906
- ### Parameters
3907
-
3908
- Name | Type | Description | Notes
3909
- ------------- | ------------- | ------------- | -------------
3910
- **conversation_pbx_audio_uuid** | **String**| |
3911
- **pbx_audio** | [**ConversationPbxAudio**](ConversationPbxAudio.md)| Pbx Audio |
3912
-
3913
- ### Return type
3914
-
3915
- [**ConversationPbxAudioResponse**](ConversationPbxAudioResponse.md)
3916
-
3917
- ### Authorization
3918
-
3919
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3920
-
3921
- ### HTTP request headers
3922
-
3923
- - **Content-Type**: application/json
3924
- - **Accept**: application/json
3925
-
3926
-
3927
-
3928
- # **update_pbx_menu**
3929
- > ConversationPbxMenuResponse update_pbx_menu(conversation_pbx_menu_uuid, pbx_menu)
3930
-
3931
- Update pbx menu
3932
-
3933
- Update a pbx menu
3934
-
3935
- ### Example
3936
- ```ruby
3937
- # load the gem
3938
- require 'ultracart_api'
3939
-
3940
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
3941
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
3942
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
3943
-
3944
-
3945
- conversation_pbx_menu_uuid = 'conversation_pbx_menu_uuid_example' # String |
3946
-
3947
- pbx_menu = UltracartClient::ConversationPbxMenu.new # ConversationPbxMenu | Pbx Menu
3948
-
3949
-
3950
- begin
3951
- #Update pbx menu
3952
- result = api_instance.update_pbx_menu(conversation_pbx_menu_uuid, pbx_menu)
3953
- p result
3954
- rescue UltracartClient::ApiError => e
3955
- puts "Exception when calling ConversationApi->update_pbx_menu: #{e}"
3956
- end
3957
- ```
3958
-
3959
- ### Parameters
3960
-
3961
- Name | Type | Description | Notes
3962
- ------------- | ------------- | ------------- | -------------
3963
- **conversation_pbx_menu_uuid** | **String**| |
3964
- **pbx_menu** | [**ConversationPbxMenu**](ConversationPbxMenu.md)| Pbx Menu |
3965
-
3966
- ### Return type
3967
-
3968
- [**ConversationPbxMenuResponse**](ConversationPbxMenuResponse.md)
3969
-
3970
- ### Authorization
3971
-
3972
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3973
-
3974
- ### HTTP request headers
3975
-
3976
- - **Content-Type**: application/json
3977
- - **Accept**: application/json
3978
-
3979
-
3980
-
3981
- # **update_pbx_phone_number**
3982
- > ConversationPbxPhoneNumberResponse update_pbx_phone_number(conversation_pbx_phone_number_uuid, pbx_phone_number)
3983
-
3984
- Update pbx phoneNumber
3985
-
3986
- Update a pbx phoneNumber
3987
-
3988
- ### Example
3989
- ```ruby
3990
- # load the gem
3991
- require 'ultracart_api'
3992
-
3993
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
3994
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
3995
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
3996
-
3997
-
3998
- conversation_pbx_phone_number_uuid = 'conversation_pbx_phone_number_uuid_example' # String |
3999
-
4000
- pbx_phone_number = UltracartClient::ConversationPbxPhoneNumber.new # ConversationPbxPhoneNumber | Pbx PhoneNumber
4001
-
4002
-
4003
- begin
4004
- #Update pbx phoneNumber
4005
- result = api_instance.update_pbx_phone_number(conversation_pbx_phone_number_uuid, pbx_phone_number)
4006
- p result
4007
- rescue UltracartClient::ApiError => e
4008
- puts "Exception when calling ConversationApi->update_pbx_phone_number: #{e}"
4009
- end
4010
- ```
4011
-
4012
- ### Parameters
4013
-
4014
- Name | Type | Description | Notes
4015
- ------------- | ------------- | ------------- | -------------
4016
- **conversation_pbx_phone_number_uuid** | **String**| |
4017
- **pbx_phone_number** | [**ConversationPbxPhoneNumber**](ConversationPbxPhoneNumber.md)| Pbx PhoneNumber |
4018
-
4019
- ### Return type
4020
-
4021
- [**ConversationPbxPhoneNumberResponse**](ConversationPbxPhoneNumberResponse.md)
4022
-
4023
- ### Authorization
4024
-
4025
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4026
-
4027
- ### HTTP request headers
4028
-
4029
- - **Content-Type**: application/json
4030
- - **Accept**: application/json
4031
-
4032
-
4033
-
4034
- # **update_pbx_queue**
4035
- > ConversationPbxQueueResponse update_pbx_queue(conversation_pbx_queue_uuid, pbx_queue)
4036
-
4037
- Update pbx queue
4038
-
4039
- Update a pbx queue
4040
-
4041
- ### Example
4042
- ```ruby
4043
- # load the gem
4044
- require 'ultracart_api'
4045
-
4046
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
4047
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
4048
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
4049
-
4050
-
4051
- conversation_pbx_queue_uuid = 'conversation_pbx_queue_uuid_example' # String |
4052
-
4053
- pbx_queue = UltracartClient::ConversationPbxQueue.new # ConversationPbxQueue | Pbx Queue
4054
-
4055
-
4056
- begin
4057
- #Update pbx queue
4058
- result = api_instance.update_pbx_queue(conversation_pbx_queue_uuid, pbx_queue)
4059
- p result
4060
- rescue UltracartClient::ApiError => e
4061
- puts "Exception when calling ConversationApi->update_pbx_queue: #{e}"
4062
- end
4063
- ```
4064
-
4065
- ### Parameters
4066
-
4067
- Name | Type | Description | Notes
4068
- ------------- | ------------- | ------------- | -------------
4069
- **conversation_pbx_queue_uuid** | **String**| |
4070
- **pbx_queue** | [**ConversationPbxQueue**](ConversationPbxQueue.md)| Pbx Queue |
4071
-
4072
- ### Return type
4073
-
4074
- [**ConversationPbxQueueResponse**](ConversationPbxQueueResponse.md)
4075
-
4076
- ### Authorization
4077
-
4078
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4079
-
4080
- ### HTTP request headers
4081
-
4082
- - **Content-Type**: application/json
4083
- - **Accept**: application/json
4084
-
4085
-
4086
-
4087
- # **update_pbx_time_based**
4088
- > ConversationPbxTimeBasedResponse update_pbx_time_based(conversation_pbx_time_based_uuid, pbx_time_based)
4089
-
4090
- Update pbx timeBased
4091
-
4092
- Update a pbx timeBased
4093
-
4094
- ### Example
4095
- ```ruby
4096
- # load the gem
4097
- require 'ultracart_api'
4098
-
4099
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
4100
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
4101
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
4102
-
4103
-
4104
- conversation_pbx_time_based_uuid = 'conversation_pbx_time_based_uuid_example' # String |
4105
-
4106
- pbx_time_based = UltracartClient::ConversationPbxTimeBased.new # ConversationPbxTimeBased | Pbx TimeBased
4107
-
4108
-
4109
- begin
4110
- #Update pbx timeBased
4111
- result = api_instance.update_pbx_time_based(conversation_pbx_time_based_uuid, pbx_time_based)
4112
- p result
4113
- rescue UltracartClient::ApiError => e
4114
- puts "Exception when calling ConversationApi->update_pbx_time_based: #{e}"
4115
- end
4116
- ```
4117
-
4118
- ### Parameters
4119
-
4120
- Name | Type | Description | Notes
4121
- ------------- | ------------- | ------------- | -------------
4122
- **conversation_pbx_time_based_uuid** | **String**| |
4123
- **pbx_time_based** | [**ConversationPbxTimeBased**](ConversationPbxTimeBased.md)| Pbx TimeBased |
4124
-
4125
- ### Return type
4126
-
4127
- [**ConversationPbxTimeBasedResponse**](ConversationPbxTimeBasedResponse.md)
4128
-
4129
- ### Authorization
4130
-
4131
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4132
-
4133
- ### HTTP request headers
4134
-
4135
- - **Content-Type**: application/json
4136
- - **Accept**: application/json
4137
-
4138
-
4139
-
4140
- # **update_pbx_time_range**
4141
- > ConversationPbxTimeRangeResponse update_pbx_time_range(conversation_pbx_time_range_uuid, pbx_time_range)
4142
-
4143
- Update pbx timeRange
4144
-
4145
- Update a pbx timeRange
4146
-
4147
- ### Example
4148
- ```ruby
4149
- # load the gem
4150
- require 'ultracart_api'
4151
-
4152
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
4153
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
4154
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
4155
-
4156
-
4157
- conversation_pbx_time_range_uuid = 'conversation_pbx_time_range_uuid_example' # String |
4158
-
4159
- pbx_time_range = UltracartClient::ConversationPbxTimeRange.new # ConversationPbxTimeRange | Pbx TimeRange
4160
-
4161
-
4162
- begin
4163
- #Update pbx timeRange
4164
- result = api_instance.update_pbx_time_range(conversation_pbx_time_range_uuid, pbx_time_range)
4165
- p result
4166
- rescue UltracartClient::ApiError => e
4167
- puts "Exception when calling ConversationApi->update_pbx_time_range: #{e}"
4168
- end
4169
- ```
4170
-
4171
- ### Parameters
4172
-
4173
- Name | Type | Description | Notes
4174
- ------------- | ------------- | ------------- | -------------
4175
- **conversation_pbx_time_range_uuid** | **String**| |
4176
- **pbx_time_range** | [**ConversationPbxTimeRange**](ConversationPbxTimeRange.md)| Pbx TimeRange |
4177
-
4178
- ### Return type
4179
-
4180
- [**ConversationPbxTimeRangeResponse**](ConversationPbxTimeRangeResponse.md)
4181
-
4182
- ### Authorization
4183
-
4184
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4185
-
4186
- ### HTTP request headers
4187
-
4188
- - **Content-Type**: application/json
4189
- - **Accept**: application/json
4190
-
4191
-
4192
-
4193
- # **update_pbx_voicemail_mailbox**
4194
- > ConversationPbxVoicemailMailboxResponse update_pbx_voicemail_mailbox(conversation_pbx_voicemail_mailbox_uuid, pbx_voicemail_mailbox)
4195
-
4196
- Update pbx voicemailMailbox
4197
-
4198
- Update a pbx voicemailMailbox
4199
-
4200
- ### Example
4201
- ```ruby
4202
- # load the gem
4203
- require 'ultracart_api'
4204
-
4205
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
4206
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
4207
- api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
4208
-
4209
-
4210
- conversation_pbx_voicemail_mailbox_uuid = 'conversation_pbx_voicemail_mailbox_uuid_example' # String |
4211
-
4212
- pbx_voicemail_mailbox = UltracartClient::ConversationPbxVoicemailMailbox.new # ConversationPbxVoicemailMailbox | Pbx VoicemailMailbox
4213
-
4214
-
4215
- begin
4216
- #Update pbx voicemailMailbox
4217
- result = api_instance.update_pbx_voicemail_mailbox(conversation_pbx_voicemail_mailbox_uuid, pbx_voicemail_mailbox)
4218
- p result
4219
- rescue UltracartClient::ApiError => e
4220
- puts "Exception when calling ConversationApi->update_pbx_voicemail_mailbox: #{e}"
4221
- end
4222
- ```
4223
-
4224
- ### Parameters
4225
-
4226
- Name | Type | Description | Notes
4227
- ------------- | ------------- | ------------- | -------------
4228
- **conversation_pbx_voicemail_mailbox_uuid** | **String**| |
4229
- **pbx_voicemail_mailbox** | [**ConversationPbxVoicemailMailbox**](ConversationPbxVoicemailMailbox.md)| Pbx VoicemailMailbox |
4230
-
4231
- ### Return type
4232
-
4233
- [**ConversationPbxVoicemailMailboxResponse**](ConversationPbxVoicemailMailboxResponse.md)
4234
-
4235
- ### Authorization
4236
-
4237
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4238
-
4239
- ### HTTP request headers
4240
-
4241
- - **Content-Type**: application/json
4242
- - **Accept**: application/json
4243
-
4244
-
4245
-