ultracart_api 3.11.13 → 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 (1787) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +9 -7
  3. data/README.md +1166 -1754
  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 -16
  423. data/docs/ItemRestrictionItem.md +22 -10
  424. data/docs/ItemRevguard.md +30 -14
  425. data/docs/ItemReviews.md +34 -17
  426. data/docs/ItemSalesforce.md +20 -9
  427. data/docs/ItemShipping.md +112 -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 -267
  1084. data/lib/ultracart_api/models/item_restriction_item.rb +274 -239
  1085. data/lib/ultracart_api/models/item_revguard.rb +280 -245
  1086. data/lib/ultracart_api/models/item_reviews.rb +300 -276
  1087. data/lib/ultracart_api/models/item_salesforce.rb +230 -195
  1088. data/lib/ultracart_api/models/item_shipping.rb +713 -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 -924
  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 -639
  1316. data/docs/AccountsReceivableRetryTransactionReject.md +0 -9
  1317. data/docs/AutoOrderAddonItem.md +0 -13
  1318. data/docs/AutoOrderAddonItemOption.md +0 -9
  1319. data/docs/AutoOrderConsolidate.md +0 -8
  1320. data/docs/AutoOrderManagement.md +0 -8
  1321. data/docs/CartItemProperty.md +0 -11
  1322. data/docs/CartPaymentHealthBenefitCard.md +0 -13
  1323. data/docs/ChanelPartnerReasonCodesResponse.md +0 -18
  1324. data/docs/ChannelPartner.md +0 -15
  1325. data/docs/ChannelPartnerOrderItemProperty.md +0 -11
  1326. data/docs/ChannelPartnerShipToPreference.md +0 -14
  1327. data/docs/ChannelPartnerShipToPreferenceResponse.md +0 -12
  1328. data/docs/ChannelPartnerShipToPreferencesResponse.md +0 -12
  1329. data/docs/ChannelPartnersResponse.md +0 -12
  1330. data/docs/Conversation.md +0 -28
  1331. data/docs/ConversationAgentAuth.md +0 -22
  1332. data/docs/ConversationAgentAuthResponse.md +0 -12
  1333. data/docs/ConversationAgentProfile.md +0 -19
  1334. data/docs/ConversationAgentProfileResponse.md +0 -12
  1335. data/docs/ConversationAgentProfilesResponse.md +0 -12
  1336. data/docs/ConversationApi.md +0 -4439
  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/ConversationVirtualAgentBudget.md +0 -11
  1423. data/docs/ConversationVirtualAgentBudgetResponse.md +0 -12
  1424. data/docs/ConversationVirtualAgentCapabilities.md +0 -16
  1425. data/docs/ConversationVirtualAgentCapabilitiesResponse.md +0 -12
  1426. data/docs/ConversationWebchatContext.md +0 -15
  1427. data/docs/ConversationWebchatQueueStatus.md +0 -22
  1428. data/docs/ConversationWebchatQueueStatusAgent.md +0 -13
  1429. data/docs/ConversationWebchatQueueStatusQueueEntry.md +0 -15
  1430. data/docs/ConversationWebchatQueueStatusUpdateRequest.md +0 -8
  1431. data/docs/ConversationWebchatQueueStatusesResponse.md +0 -12
  1432. data/docs/ConversationWebsocketMessage.md +0 -31
  1433. data/docs/ConversationsResponse.md +0 -12
  1434. data/docs/CouponFreeItemWithItemPurchaseAndFreeShipping.md +0 -11
  1435. data/docs/CouponMoreLoyaltyCashback.md +0 -8
  1436. data/docs/CouponMoreLoyaltyPoints.md +0 -8
  1437. data/docs/CouponNoDiscount.md +0 -8
  1438. data/docs/CouponPercentMoreLoyaltyCashback.md +0 -8
  1439. data/docs/CouponPercentMoreLoyaltyPoints.md +0 -8
  1440. data/docs/CouponTieredPercentOffSubtotalBasedOnMSRP.md +0 -9
  1441. data/docs/CustomerEDI.md +0 -10
  1442. data/docs/CustomerMagicLinkResponse.md +0 -12
  1443. data/docs/CustomerMergeRequest.md +0 -9
  1444. data/docs/CustomerProperty.md +0 -11
  1445. data/docs/CustomerWishListItem.md +0 -14
  1446. data/docs/CustomerWishListItemResponse.md +0 -12
  1447. data/docs/CustomerWishListItemsResponse.md +0 -12
  1448. data/docs/DatawarehouseApi.md +0 -512
  1449. data/docs/EmailCommseqSequenceTestRequest.md +0 -22
  1450. data/docs/EmailCommseqSequenceTestResponse.md +0 -11
  1451. data/docs/EmailCommseqSmsSendTestRequest.md +0 -10
  1452. data/docs/EmailCommseqSmsSendTestResponse.md +0 -13
  1453. data/docs/EmailPostcardTracking.md +0 -32
  1454. data/docs/EmailPostcardTrackingResponse.md +0 -12
  1455. data/docs/EmailRateLimiter.md +0 -10
  1456. data/docs/EmailRateLimitersResponse.md +0 -12
  1457. data/docs/EmailSmsOrder.md +0 -11
  1458. data/docs/EmailSmsOrdersResponse.md +0 -12
  1459. data/docs/EmailSmsStat.md +0 -37
  1460. data/docs/EmailStatSmsSummaryRequest.md +0 -9
  1461. data/docs/EmailStatSmsSummaryResponse.md +0 -12
  1462. data/docs/FileManagerDirectory.md +0 -20
  1463. data/docs/FileManagerFile.md +0 -29
  1464. data/docs/FileManagerPage.md +0 -15
  1465. data/docs/FileManagerPageResponse.md +0 -12
  1466. data/docs/FileManagerUploadRequest.md +0 -10
  1467. data/docs/FileManagerUploadUrlResponse.md +0 -13
  1468. data/docs/HitPageView.md +0 -18
  1469. data/docs/HitPageViewMetaData.md +0 -9
  1470. data/docs/HitSessionStart.md +0 -24
  1471. data/docs/HitSessionUtm.md +0 -22
  1472. data/docs/ItemDigitalItemPdfMeta.md +0 -18
  1473. data/docs/ItemDigitalItemResponse.md +0 -12
  1474. data/docs/ItemDigitalItemsResponse.md +0 -12
  1475. data/docs/ItemInventorySnapshot.md +0 -13
  1476. data/docs/ItemInventorySnapshotDistributionCenter.md +0 -12
  1477. data/docs/ItemInventorySnapshotResponse.md +0 -12
  1478. data/docs/ItemReview.md +0 -45
  1479. data/docs/ItemReviewResponse.md +0 -12
  1480. data/docs/ItemReviewsResponse.md +0 -12
  1481. data/docs/OrderCurrentStageHistory.md +0 -10
  1482. data/docs/OrderEdiDocument.md +0 -21
  1483. data/docs/OrderEdiDocumentsResponse.md +0 -12
  1484. data/docs/OrderInvoiceResponse.md +0 -12
  1485. data/docs/OrderPaymentCreditCardDualVaulted.md +0 -10
  1486. data/docs/OrderPaymentCreditCardDualVaultedProperty.md +0 -9
  1487. data/docs/OrderPaymentHealthBenefitCard.md +0 -13
  1488. data/docs/OrderPaymentPayPal.md +0 -9
  1489. data/docs/OrderPointOfSale.md +0 -10
  1490. data/docs/OrderReason.md +0 -10
  1491. data/docs/OrderRefundableResponse.md +0 -20
  1492. data/docs/OrderTransactionalMerchantNote.md +0 -11
  1493. data/docs/OrderUtm.md +0 -39
  1494. data/docs/OrderValidationRequest.md +0 -9
  1495. data/docs/OrderValidationResponse.md +0 -10
  1496. data/docs/PointOfSaleLocation.md +0 -17
  1497. data/docs/PointOfSaleReader.md +0 -16
  1498. data/docs/PointOfSaleRegister.md +0 -11
  1499. data/docs/Report.md +0 -18
  1500. data/docs/ReportAuth.md +0 -11
  1501. data/docs/ReportAuthResponse.md +0 -12
  1502. data/docs/ReportDataSet.md +0 -24
  1503. data/docs/ReportDataSetColumn.md +0 -13
  1504. data/docs/ReportDataSetPage.md +0 -17
  1505. data/docs/ReportDataSetPageResponse.md +0 -12
  1506. data/docs/ReportDataSetQuery.md +0 -20
  1507. data/docs/ReportDataSetQueryOrderByColumn.md +0 -9
  1508. data/docs/ReportDataSetResponse.md +0 -12
  1509. data/docs/ReportDataSetRow.md +0 -8
  1510. data/docs/ReportDataSetSchema.md +0 -10
  1511. data/docs/ReportDataSource.md +0 -14
  1512. data/docs/ReportDataSourceSchema.md +0 -11
  1513. data/docs/ReportDryRunQueriesRequest.md +0 -13
  1514. data/docs/ReportDryRunQueriesResponse.md +0 -8
  1515. data/docs/ReportDryRunQueryResult.md +0 -9
  1516. data/docs/ReportExecuteQueriesRequest.md +0 -15
  1517. data/docs/ReportFilter.md +0 -13
  1518. data/docs/ReportFilterConnection.md +0 -10
  1519. data/docs/ReportPage.md +0 -13
  1520. data/docs/ReportPageFilter.md +0 -11
  1521. data/docs/ReportPageVisualization.md +0 -17
  1522. data/docs/ReportPageVisualizationDimension.md +0 -14
  1523. data/docs/ReportPageVisualizationMetric.md +0 -11
  1524. data/docs/ReportResponse.md +0 -12
  1525. data/docs/ReportWebsocketEvent.md +0 -9
  1526. data/docs/ReportsResponse.md +0 -12
  1527. data/docs/RulerValidationRequest.md +0 -8
  1528. data/docs/RulerValidationResponse.md +0 -9
  1529. data/docs/StoreFront.md +0 -18
  1530. data/docs/StoreFrontPageContentAttribute.md +0 -11
  1531. data/docs/StoreFrontsResponse.md +0 -12
  1532. data/docs/WebhookReflow.md +0 -9
  1533. data/docs/WebhookReflowResponse.md +0 -12
  1534. data/docs/WorkflowAgentAuth.md +0 -10
  1535. data/docs/WorkflowAgentAuthResponse.md +0 -12
  1536. data/docs/WorkflowApi.md +0 -620
  1537. data/docs/WorkflowAttachment.md +0 -12
  1538. data/docs/WorkflowAttachmentUploadUrl.md +0 -9
  1539. data/docs/WorkflowAttachmentUploadUrlResponse.md +0 -12
  1540. data/docs/WorkflowGroup.md +0 -9
  1541. data/docs/WorkflowGroupsResponse.md +0 -12
  1542. data/docs/WorkflowNote.md +0 -13
  1543. data/docs/WorkflowTask.md +0 -39
  1544. data/docs/WorkflowTaskHistory.md +0 -11
  1545. data/docs/WorkflowTaskOpenCountResponse.md +0 -12
  1546. data/docs/WorkflowTaskResponse.md +0 -12
  1547. data/docs/WorkflowTaskTagsResponse.md +0 -12
  1548. data/docs/WorkflowTasksRequest.md +0 -27
  1549. data/docs/WorkflowTasksResponse.md +0 -13
  1550. data/docs/WorkflowUser.md +0 -10
  1551. data/docs/WorkflowUserResponse.md +0 -12
  1552. data/docs/WorkflowUsersResponse.md +0 -13
  1553. data/lib/ultracart_api/api/conversation_api.rb +0 -4840
  1554. data/lib/ultracart_api/api/datawarehouse_api.rb +0 -584
  1555. data/lib/ultracart_api/api/workflow_api.rb +0 -693
  1556. data/lib/ultracart_api/models/accounts_receivable_retry_transaction_reject.rb +0 -195
  1557. data/lib/ultracart_api/models/auto_order_addon_item.rb +0 -232
  1558. data/lib/ultracart_api/models/auto_order_addon_item_option.rb +0 -225
  1559. data/lib/ultracart_api/models/auto_order_consolidate.rb +0 -186
  1560. data/lib/ultracart_api/models/auto_order_management.rb +0 -185
  1561. data/lib/ultracart_api/models/cart_item_property.rb +0 -245
  1562. data/lib/ultracart_api/models/cart_payment_health_benefit_card.rb +0 -235
  1563. data/lib/ultracart_api/models/chanel_partner_reason_codes_response.rb +0 -290
  1564. data/lib/ultracart_api/models/channel_partner.rb +0 -255
  1565. data/lib/ultracart_api/models/channel_partner_order_item_property.rb +0 -245
  1566. data/lib/ultracart_api/models/channel_partner_ship_to_preference.rb +0 -262
  1567. data/lib/ultracart_api/models/channel_partner_ship_to_preference_response.rb +0 -221
  1568. data/lib/ultracart_api/models/channel_partner_ship_to_preferences_response.rb +0 -224
  1569. data/lib/ultracart_api/models/channel_partners_response.rb +0 -224
  1570. data/lib/ultracart_api/models/conversation.rb +0 -410
  1571. data/lib/ultracart_api/models/conversation_agent_auth.rb +0 -316
  1572. data/lib/ultracart_api/models/conversation_agent_auth_response.rb +0 -221
  1573. data/lib/ultracart_api/models/conversation_agent_profile.rb +0 -329
  1574. data/lib/ultracart_api/models/conversation_agent_profile_response.rb +0 -221
  1575. data/lib/ultracart_api/models/conversation_agent_profiles_response.rb +0 -223
  1576. data/lib/ultracart_api/models/conversation_autocomplete_request.rb +0 -193
  1577. data/lib/ultracart_api/models/conversation_autocomplete_response.rb +0 -241
  1578. data/lib/ultracart_api/models/conversation_autocomplete_value.rb +0 -193
  1579. data/lib/ultracart_api/models/conversation_canned_message.rb +0 -213
  1580. data/lib/ultracart_api/models/conversation_canned_message_response.rb +0 -221
  1581. data/lib/ultracart_api/models/conversation_canned_messages_response.rb +0 -223
  1582. data/lib/ultracart_api/models/conversation_canned_messages_search.rb +0 -193
  1583. data/lib/ultracart_api/models/conversation_department.rb +0 -222
  1584. data/lib/ultracart_api/models/conversation_department_member.rb +0 -202
  1585. data/lib/ultracart_api/models/conversation_department_members_response.rb +0 -223
  1586. data/lib/ultracart_api/models/conversation_department_response.rb +0 -221
  1587. data/lib/ultracart_api/models/conversation_department_settings.rb +0 -175
  1588. data/lib/ultracart_api/models/conversation_departments_response.rb +0 -223
  1589. data/lib/ultracart_api/models/conversation_engagement.rb +0 -293
  1590. data/lib/ultracart_api/models/conversation_engagement_equation.rb +0 -186
  1591. data/lib/ultracart_api/models/conversation_engagement_equation_function.rb +0 -414
  1592. data/lib/ultracart_api/models/conversation_engagement_equation_group.rb +0 -186
  1593. data/lib/ultracart_api/models/conversation_engagement_response.rb +0 -221
  1594. data/lib/ultracart_api/models/conversation_engagements_response.rb +0 -223
  1595. data/lib/ultracart_api/models/conversation_event_add_coupon.rb +0 -202
  1596. data/lib/ultracart_api/models/conversation_event_add_item.rb +0 -204
  1597. data/lib/ultracart_api/models/conversation_event_queue_position.rb +0 -195
  1598. data/lib/ultracart_api/models/conversation_event_read_message.rb +0 -203
  1599. data/lib/ultracart_api/models/conversation_event_rr_web.rb +0 -273
  1600. data/lib/ultracart_api/models/conversation_event_typing.rb +0 -202
  1601. data/lib/ultracart_api/models/conversation_event_webchat_context.rb +0 -202
  1602. data/lib/ultracart_api/models/conversation_join_request.rb +0 -184
  1603. data/lib/ultracart_api/models/conversation_location_country.rb +0 -204
  1604. data/lib/ultracart_api/models/conversation_location_state_province.rb +0 -193
  1605. data/lib/ultracart_api/models/conversation_locations_response.rb +0 -223
  1606. data/lib/ultracart_api/models/conversation_message.rb +0 -356
  1607. data/lib/ultracart_api/models/conversation_message_translation.rb +0 -193
  1608. data/lib/ultracart_api/models/conversation_message_transport_status.rb +0 -228
  1609. data/lib/ultracart_api/models/conversation_messages_response.rb +0 -223
  1610. data/lib/ultracart_api/models/conversation_multimedia_upload_url.rb +0 -193
  1611. data/lib/ultracart_api/models/conversation_multimedia_upload_url_response.rb +0 -221
  1612. data/lib/ultracart_api/models/conversation_participant.rb +0 -295
  1613. data/lib/ultracart_api/models/conversation_pbx_agent.rb +0 -440
  1614. data/lib/ultracart_api/models/conversation_pbx_agent_response.rb +0 -221
  1615. data/lib/ultracart_api/models/conversation_pbx_agents_response.rb +0 -223
  1616. data/lib/ultracart_api/models/conversation_pbx_audio.rb +0 -365
  1617. data/lib/ultracart_api/models/conversation_pbx_audio_response.rb +0 -221
  1618. data/lib/ultracart_api/models/conversation_pbx_audio_upload_url.rb +0 -193
  1619. data/lib/ultracart_api/models/conversation_pbx_audio_upload_url_response.rb +0 -221
  1620. data/lib/ultracart_api/models/conversation_pbx_audios_response.rb +0 -223
  1621. data/lib/ultracart_api/models/conversation_pbx_customer_snapshot_request.rb +0 -248
  1622. data/lib/ultracart_api/models/conversation_pbx_customer_snapshot_response.rb +0 -245
  1623. data/lib/ultracart_api/models/conversation_pbx_menu.rb +0 -416
  1624. data/lib/ultracart_api/models/conversation_pbx_menu_mapping.rb +0 -269
  1625. data/lib/ultracart_api/models/conversation_pbx_menu_response.rb +0 -221
  1626. data/lib/ultracart_api/models/conversation_pbx_menus_response.rb +0 -223
  1627. data/lib/ultracart_api/models/conversation_pbx_phone_number.rb +0 -324
  1628. data/lib/ultracart_api/models/conversation_pbx_phone_number_response.rb +0 -221
  1629. data/lib/ultracart_api/models/conversation_pbx_phone_numbers_response.rb +0 -223
  1630. data/lib/ultracart_api/models/conversation_pbx_queue.rb +0 -534
  1631. data/lib/ultracart_api/models/conversation_pbx_queue_members.rb +0 -197
  1632. data/lib/ultracart_api/models/conversation_pbx_queue_response.rb +0 -221
  1633. data/lib/ultracart_api/models/conversation_pbx_queues_response.rb +0 -223
  1634. data/lib/ultracart_api/models/conversation_pbx_time_based.rb +0 -211
  1635. data/lib/ultracart_api/models/conversation_pbx_time_based_mapping.rb +0 -299
  1636. data/lib/ultracart_api/models/conversation_pbx_time_based_mapping_config.rb +0 -196
  1637. data/lib/ultracart_api/models/conversation_pbx_time_based_response.rb +0 -221
  1638. data/lib/ultracart_api/models/conversation_pbx_time_baseds_response.rb +0 -223
  1639. data/lib/ultracart_api/models/conversation_pbx_time_range.rb +0 -287
  1640. data/lib/ultracart_api/models/conversation_pbx_time_range_config.rb +0 -235
  1641. data/lib/ultracart_api/models/conversation_pbx_time_range_response.rb +0 -221
  1642. data/lib/ultracart_api/models/conversation_pbx_time_ranges_response.rb +0 -223
  1643. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb +0 -458
  1644. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox_response.rb +0 -221
  1645. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailboxes_response.rb +0 -223
  1646. data/lib/ultracart_api/models/conversation_pbx_voicemail_message.rb +0 -339
  1647. data/lib/ultracart_api/models/conversation_pbx_voicemail_message_response.rb +0 -221
  1648. data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summaries_response.rb +0 -223
  1649. data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summary.rb +0 -309
  1650. data/lib/ultracart_api/models/conversation_permissions.rb +0 -184
  1651. data/lib/ultracart_api/models/conversation_permissions_response.rb +0 -221
  1652. data/lib/ultracart_api/models/conversation_response.rb +0 -221
  1653. data/lib/ultracart_api/models/conversation_search_request.rb +0 -285
  1654. data/lib/ultracart_api/models/conversation_search_response.rb +0 -213
  1655. data/lib/ultracart_api/models/conversation_sentiment.rb +0 -269
  1656. data/lib/ultracart_api/models/conversation_start_request.rb +0 -204
  1657. data/lib/ultracart_api/models/conversation_start_response.rb +0 -184
  1658. data/lib/ultracart_api/models/conversation_summary.rb +0 -369
  1659. data/lib/ultracart_api/models/conversation_twilio_account.rb +0 -195
  1660. data/lib/ultracart_api/models/conversation_virtual_agent_budget.rb +0 -211
  1661. data/lib/ultracart_api/models/conversation_virtual_agent_budget_response.rb +0 -221
  1662. data/lib/ultracart_api/models/conversation_virtual_agent_capabilities.rb +0 -256
  1663. data/lib/ultracart_api/models/conversation_virtual_agent_capabilities_response.rb +0 -221
  1664. data/lib/ultracart_api/models/conversation_webchat_context.rb +0 -254
  1665. data/lib/ultracart_api/models/conversation_webchat_queue_status.rb +0 -315
  1666. data/lib/ultracart_api/models/conversation_webchat_queue_status_agent.rb +0 -266
  1667. data/lib/ultracart_api/models/conversation_webchat_queue_status_queue_entry.rb +0 -248
  1668. data/lib/ultracart_api/models/conversation_webchat_queue_status_update_request.rb +0 -219
  1669. data/lib/ultracart_api/models/conversation_webchat_queue_statuses_response.rb +0 -223
  1670. data/lib/ultracart_api/models/conversation_websocket_message.rb +0 -441
  1671. data/lib/ultracart_api/models/conversations_response.rb +0 -223
  1672. data/lib/ultracart_api/models/coupon_free_item_with_item_purchase_and_free_shipping.rb +0 -219
  1673. data/lib/ultracart_api/models/coupon_more_loyalty_cashback.rb +0 -185
  1674. data/lib/ultracart_api/models/coupon_more_loyalty_points.rb +0 -185
  1675. data/lib/ultracart_api/models/coupon_no_discount.rb +0 -185
  1676. data/lib/ultracart_api/models/coupon_percent_more_loyalty_cashback.rb +0 -185
  1677. data/lib/ultracart_api/models/coupon_percent_more_loyalty_points.rb +0 -185
  1678. data/lib/ultracart_api/models/coupon_tiered_percent_off_subtotal_based_on_msrp.rb +0 -199
  1679. data/lib/ultracart_api/models/customer_edi.rb +0 -205
  1680. data/lib/ultracart_api/models/customer_magic_link_response.rb +0 -222
  1681. data/lib/ultracart_api/models/customer_merge_request.rb +0 -195
  1682. data/lib/ultracart_api/models/customer_property.rb +0 -245
  1683. data/lib/ultracart_api/models/customer_wish_list_item.rb +0 -260
  1684. data/lib/ultracart_api/models/customer_wish_list_item_response.rb +0 -221
  1685. data/lib/ultracart_api/models/email_commseq_sequence_test_request.rb +0 -312
  1686. data/lib/ultracart_api/models/email_commseq_sequence_test_response.rb +0 -212
  1687. data/lib/ultracart_api/models/email_commseq_sms_send_test_request.rb +0 -202
  1688. data/lib/ultracart_api/models/email_commseq_sms_send_test_response.rb +0 -232
  1689. data/lib/ultracart_api/models/email_postcard_tracking.rb +0 -404
  1690. data/lib/ultracart_api/models/email_postcard_tracking_response.rb +0 -221
  1691. data/lib/ultracart_api/models/email_rate_limiter.rb +0 -202
  1692. data/lib/ultracart_api/models/email_rate_limiters_response.rb +0 -223
  1693. data/lib/ultracart_api/models/email_sms_order.rb +0 -214
  1694. data/lib/ultracart_api/models/email_sms_orders_response.rb +0 -223
  1695. data/lib/ultracart_api/models/email_sms_stat.rb +0 -476
  1696. data/lib/ultracart_api/models/email_stat_sms_summary_request.rb +0 -195
  1697. data/lib/ultracart_api/models/email_stat_sms_summary_response.rb +0 -223
  1698. data/lib/ultracart_api/models/file_manager_directory.rb +0 -292
  1699. data/lib/ultracart_api/models/file_manager_file.rb +0 -376
  1700. data/lib/ultracart_api/models/file_manager_page.rb +0 -253
  1701. data/lib/ultracart_api/models/file_manager_page_response.rb +0 -221
  1702. data/lib/ultracart_api/models/file_manager_upload_request.rb +0 -202
  1703. data/lib/ultracart_api/models/file_manager_upload_url_response.rb +0 -230
  1704. data/lib/ultracart_api/models/hit_page_view.rb +0 -276
  1705. data/lib/ultracart_api/models/hit_page_view_meta_data.rb +0 -193
  1706. data/lib/ultracart_api/models/hit_session_start.rb +0 -328
  1707. data/lib/ultracart_api/models/hit_session_utm.rb +0 -310
  1708. data/lib/ultracart_api/models/item_digital_item_pdf_meta.rb +0 -315
  1709. data/lib/ultracart_api/models/item_digital_item_response.rb +0 -221
  1710. data/lib/ultracart_api/models/item_digital_items_response.rb +0 -224
  1711. data/lib/ultracart_api/models/item_inventory_snapshot.rb +0 -231
  1712. data/lib/ultracart_api/models/item_inventory_snapshot_distribution_center.rb +0 -220
  1713. data/lib/ultracart_api/models/item_inventory_snapshot_response.rb +0 -224
  1714. data/lib/ultracart_api/models/item_review.rb +0 -826
  1715. data/lib/ultracart_api/models/item_review_response.rb +0 -221
  1716. data/lib/ultracart_api/models/item_reviews_response.rb +0 -224
  1717. data/lib/ultracart_api/models/order_current_stage_history.rb +0 -251
  1718. data/lib/ultracart_api/models/order_edi_document.rb +0 -337
  1719. data/lib/ultracart_api/models/order_edi_documents_response.rb +0 -224
  1720. data/lib/ultracart_api/models/order_invoice_response.rb +0 -222
  1721. data/lib/ultracart_api/models/order_payment_credit_card_dual_vaulted.rb +0 -204
  1722. data/lib/ultracart_api/models/order_payment_credit_card_dual_vaulted_property.rb +0 -193
  1723. data/lib/ultracart_api/models/order_payment_health_benefit_card.rb +0 -235
  1724. data/lib/ultracart_api/models/order_payment_pay_pal.rb +0 -195
  1725. data/lib/ultracart_api/models/order_point_of_sale.rb +0 -202
  1726. data/lib/ultracart_api/models/order_reason.rb +0 -205
  1727. data/lib/ultracart_api/models/order_refundable_response.rb +0 -310
  1728. data/lib/ultracart_api/models/order_transactional_merchant_note.rb +0 -215
  1729. data/lib/ultracart_api/models/order_utm.rb +0 -464
  1730. data/lib/ultracart_api/models/order_validation_request.rb +0 -196
  1731. data/lib/ultracart_api/models/order_validation_response.rb +0 -209
  1732. data/lib/ultracart_api/models/point_of_sale_location.rb +0 -290
  1733. data/lib/ultracart_api/models/point_of_sale_reader.rb +0 -299
  1734. data/lib/ultracart_api/models/point_of_sale_register.rb +0 -215
  1735. data/lib/ultracart_api/models/report.rb +0 -317
  1736. data/lib/ultracart_api/models/report_auth.rb +0 -212
  1737. data/lib/ultracart_api/models/report_auth_response.rb +0 -221
  1738. data/lib/ultracart_api/models/report_data_set.rb +0 -381
  1739. data/lib/ultracart_api/models/report_data_set_column.rb +0 -229
  1740. data/lib/ultracart_api/models/report_data_set_page.rb +0 -273
  1741. data/lib/ultracart_api/models/report_data_set_page_response.rb +0 -221
  1742. data/lib/ultracart_api/models/report_data_set_query.rb +0 -342
  1743. data/lib/ultracart_api/models/report_data_set_query_order_by_column.rb +0 -193
  1744. data/lib/ultracart_api/models/report_data_set_response.rb +0 -221
  1745. data/lib/ultracart_api/models/report_data_set_row.rb +0 -186
  1746. data/lib/ultracart_api/models/report_data_set_schema.rb +0 -238
  1747. data/lib/ultracart_api/models/report_data_source.rb +0 -242
  1748. data/lib/ultracart_api/models/report_data_source_schema.rb +0 -248
  1749. data/lib/ultracart_api/models/report_dry_run_queries_request.rb +0 -231
  1750. data/lib/ultracart_api/models/report_dry_run_queries_response.rb +0 -186
  1751. data/lib/ultracart_api/models/report_dry_run_query_result.rb +0 -193
  1752. data/lib/ultracart_api/models/report_execute_queries_request.rb +0 -288
  1753. data/lib/ultracart_api/models/report_filter.rb +0 -272
  1754. data/lib/ultracart_api/models/report_filter_connection.rb +0 -203
  1755. data/lib/ultracart_api/models/report_page.rb +0 -237
  1756. data/lib/ultracart_api/models/report_page_filter.rb +0 -214
  1757. data/lib/ultracart_api/models/report_page_visualization.rb +0 -309
  1758. data/lib/ultracart_api/models/report_page_visualization_dimension.rb +0 -244
  1759. data/lib/ultracart_api/models/report_page_visualization_metric.rb +0 -248
  1760. data/lib/ultracart_api/models/report_response.rb +0 -221
  1761. data/lib/ultracart_api/models/report_websocket_event.rb +0 -228
  1762. data/lib/ultracart_api/models/reports_response.rb +0 -223
  1763. data/lib/ultracart_api/models/ruler_validation_request.rb +0 -184
  1764. data/lib/ultracart_api/models/ruler_validation_response.rb +0 -193
  1765. data/lib/ultracart_api/models/store_front.rb +0 -274
  1766. data/lib/ultracart_api/models/store_front_page_content_attribute.rb +0 -245
  1767. data/lib/ultracart_api/models/store_fronts_response.rb +0 -223
  1768. data/lib/ultracart_api/models/webhook_reflow.rb +0 -193
  1769. data/lib/ultracart_api/models/webhook_reflow_response.rb +0 -221
  1770. data/lib/ultracart_api/models/workflow_agent_auth.rb +0 -202
  1771. data/lib/ultracart_api/models/workflow_agent_auth_response.rb +0 -221
  1772. data/lib/ultracart_api/models/workflow_attachment.rb +0 -225
  1773. data/lib/ultracart_api/models/workflow_attachment_upload_url.rb +0 -193
  1774. data/lib/ultracart_api/models/workflow_attachment_upload_url_response.rb +0 -221
  1775. data/lib/ultracart_api/models/workflow_group.rb +0 -195
  1776. data/lib/ultracart_api/models/workflow_groups_response.rb +0 -224
  1777. data/lib/ultracart_api/models/workflow_note.rb +0 -236
  1778. data/lib/ultracart_api/models/workflow_task.rb +0 -574
  1779. data/lib/ultracart_api/models/workflow_task_history.rb +0 -214
  1780. data/lib/ultracart_api/models/workflow_task_open_count_response.rb +0 -222
  1781. data/lib/ultracart_api/models/workflow_task_response.rb +0 -221
  1782. data/lib/ultracart_api/models/workflow_task_tags_response.rb +0 -224
  1783. data/lib/ultracart_api/models/workflow_tasks_request.rb +0 -434
  1784. data/lib/ultracart_api/models/workflow_tasks_response.rb +0 -234
  1785. data/lib/ultracart_api/models/workflow_user.rb +0 -205
  1786. data/lib/ultracart_api/models/workflow_user_response.rb +0 -221
  1787. data/lib/ultracart_api/models/workflow_users_response.rb +0 -234
@@ -1,4840 +0,0 @@
1
- =begin
2
- #UltraCart Rest API V2
3
-
4
- #UltraCart REST API Version 2
5
-
6
- OpenAPI spec version: 2.0.0
7
- Contact: support@ultracart.com
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.4.15-SNAPSHOT
10
-
11
- =end
12
-
13
- require 'addressable/uri'
14
-
15
- module UltracartClient
16
- class ConversationApi
17
- attr_accessor :api_client
18
-
19
- def initialize(api_client = ApiClient.default)
20
- @api_client = api_client
21
- end
22
-
23
- def self.new_using_api_key(simple_key, verify_ssl = true, debugging = false)
24
- api_config = Configuration.new
25
- api_config.api_key_prefix['x-ultracart-simple-key'] = simple_key
26
- api_config.api_version = '2017-03-01'
27
- api_config.verify_ssl = verify_ssl
28
-
29
- api_client = ApiClient.new(api_config)
30
- api_client.config.debugging = debugging
31
-
32
- UltracartClient::ConversationApi.new(api_client)
33
- end
34
-
35
- # Delete a conversation canned message
36
- # Delete a conversation canned message
37
- # @param conversation_canned_message_oid
38
- # @param [Hash] opts the optional parameters
39
- # @return [nil]
40
- def delete_conversation_canned_message(conversation_canned_message_oid, opts = {})
41
- delete_conversation_canned_message_with_http_info(conversation_canned_message_oid, opts)
42
- nil
43
- end
44
-
45
- # Delete a conversation canned message
46
- # Delete a conversation canned message
47
- # @param conversation_canned_message_oid
48
- # @param [Hash] opts the optional parameters
49
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
50
- def delete_conversation_canned_message_with_http_info(conversation_canned_message_oid, opts = {})
51
- if @api_client.config.debugging
52
- @api_client.config.logger.debug 'Calling API: ConversationApi.delete_conversation_canned_message ...'
53
- end
54
- # verify the required parameter 'conversation_canned_message_oid' is set
55
- if @api_client.config.client_side_validation && conversation_canned_message_oid.nil?
56
- fail ArgumentError, "Missing the required parameter 'conversation_canned_message_oid' when calling ConversationApi.delete_conversation_canned_message"
57
- end
58
- # resource path
59
- local_var_path = '/conversation/canned_messages/{conversation_canned_message_oid}'.sub('{' + 'conversation_canned_message_oid' + '}', conversation_canned_message_oid.to_s)
60
-
61
- # query parameters
62
- query_params = {}
63
-
64
- # header parameters
65
- header_params = {}
66
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
67
- # HTTP header 'Accept' (if needed)
68
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
69
- # HTTP header 'Content-Type'
70
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
71
-
72
- # form parameters
73
- form_params = {}
74
-
75
- # http body (model)
76
- post_body = nil
77
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
78
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
79
- :header_params => header_params,
80
- :query_params => query_params,
81
- :form_params => form_params,
82
- :body => post_body,
83
- :auth_names => auth_names)
84
- if @api_client.config.debugging
85
- @api_client.config.logger.debug "API called: ConversationApi#delete_conversation_canned_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
86
- end
87
- return data, status_code, headers
88
- end
89
- # Delete a conversation department
90
- # Delete a conversation department
91
- # @param conversation_department_oid
92
- # @param [Hash] opts the optional parameters
93
- # @return [nil]
94
- def delete_department(conversation_department_oid, opts = {})
95
- delete_department_with_http_info(conversation_department_oid, opts)
96
- nil
97
- end
98
-
99
- # Delete a conversation department
100
- # Delete a conversation department
101
- # @param conversation_department_oid
102
- # @param [Hash] opts the optional parameters
103
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
104
- def delete_department_with_http_info(conversation_department_oid, opts = {})
105
- if @api_client.config.debugging
106
- @api_client.config.logger.debug 'Calling API: ConversationApi.delete_department ...'
107
- end
108
- # verify the required parameter 'conversation_department_oid' is set
109
- if @api_client.config.client_side_validation && conversation_department_oid.nil?
110
- fail ArgumentError, "Missing the required parameter 'conversation_department_oid' when calling ConversationApi.delete_department"
111
- end
112
- # resource path
113
- local_var_path = '/conversation/departments/{conversation_department_oid}'.sub('{' + 'conversation_department_oid' + '}', conversation_department_oid.to_s)
114
-
115
- # query parameters
116
- query_params = {}
117
-
118
- # header parameters
119
- header_params = {}
120
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
121
- # HTTP header 'Accept' (if needed)
122
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
123
- # HTTP header 'Content-Type'
124
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
125
-
126
- # form parameters
127
- form_params = {}
128
-
129
- # http body (model)
130
- post_body = nil
131
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
132
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
133
- :header_params => header_params,
134
- :query_params => query_params,
135
- :form_params => form_params,
136
- :body => post_body,
137
- :auth_names => auth_names)
138
- if @api_client.config.debugging
139
- @api_client.config.logger.debug "API called: ConversationApi#delete_department\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
140
- end
141
- return data, status_code, headers
142
- end
143
- # Delete a conversation engagement
144
- # Delete a conversation engagement
145
- # @param conversation_engagement_oid
146
- # @param [Hash] opts the optional parameters
147
- # @return [nil]
148
- def delete_engagement(conversation_engagement_oid, opts = {})
149
- delete_engagement_with_http_info(conversation_engagement_oid, opts)
150
- nil
151
- end
152
-
153
- # Delete a conversation engagement
154
- # Delete a conversation engagement
155
- # @param conversation_engagement_oid
156
- # @param [Hash] opts the optional parameters
157
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
158
- def delete_engagement_with_http_info(conversation_engagement_oid, opts = {})
159
- if @api_client.config.debugging
160
- @api_client.config.logger.debug 'Calling API: ConversationApi.delete_engagement ...'
161
- end
162
- # verify the required parameter 'conversation_engagement_oid' is set
163
- if @api_client.config.client_side_validation && conversation_engagement_oid.nil?
164
- fail ArgumentError, "Missing the required parameter 'conversation_engagement_oid' when calling ConversationApi.delete_engagement"
165
- end
166
- # resource path
167
- local_var_path = '/conversation/engagements/{conversation_engagement_oid}'.sub('{' + 'conversation_engagement_oid' + '}', conversation_engagement_oid.to_s)
168
-
169
- # query parameters
170
- query_params = {}
171
-
172
- # header parameters
173
- header_params = {}
174
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
175
- # HTTP header 'Accept' (if needed)
176
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
177
- # HTTP header 'Content-Type'
178
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
179
-
180
- # form parameters
181
- form_params = {}
182
-
183
- # http body (model)
184
- post_body = nil
185
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
186
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
187
- :header_params => header_params,
188
- :query_params => query_params,
189
- :form_params => form_params,
190
- :body => post_body,
191
- :auth_names => auth_names)
192
- if @api_client.config.debugging
193
- @api_client.config.logger.debug "API called: ConversationApi#delete_engagement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
194
- end
195
- return data, status_code, headers
196
- end
197
- # Delete Agent Voicemail
198
- # Delete pbx agent Voicemail
199
- # @param recording_sid
200
- # @param [Hash] opts the optional parameters
201
- # @return [nil]
202
- def delete_pbx_agent_voicemail(recording_sid, opts = {})
203
- delete_pbx_agent_voicemail_with_http_info(recording_sid, opts)
204
- nil
205
- end
206
-
207
- # Delete Agent Voicemail
208
- # Delete pbx agent Voicemail
209
- # @param recording_sid
210
- # @param [Hash] opts the optional parameters
211
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
212
- def delete_pbx_agent_voicemail_with_http_info(recording_sid, opts = {})
213
- if @api_client.config.debugging
214
- @api_client.config.logger.debug 'Calling API: ConversationApi.delete_pbx_agent_voicemail ...'
215
- end
216
- # verify the required parameter 'recording_sid' is set
217
- if @api_client.config.client_side_validation && recording_sid.nil?
218
- fail ArgumentError, "Missing the required parameter 'recording_sid' when calling ConversationApi.delete_pbx_agent_voicemail"
219
- end
220
- # resource path
221
- local_var_path = '/conversation/pbx/agent/voicemails/{recording_sid}'.sub('{' + 'recording_sid' + '}', recording_sid.to_s)
222
-
223
- # query parameters
224
- query_params = {}
225
-
226
- # header parameters
227
- header_params = {}
228
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
229
- # HTTP header 'Accept' (if needed)
230
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
231
- # HTTP header 'Content-Type'
232
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
233
-
234
- # form parameters
235
- form_params = {}
236
-
237
- # http body (model)
238
- post_body = nil
239
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
240
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
241
- :header_params => header_params,
242
- :query_params => query_params,
243
- :form_params => form_params,
244
- :body => post_body,
245
- :auth_names => auth_names)
246
- if @api_client.config.debugging
247
- @api_client.config.logger.debug "API called: ConversationApi#delete_pbx_agent_voicemail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
248
- end
249
- return data, status_code, headers
250
- end
251
- # Delete pbx audio
252
- # Delete a pbx audio
253
- # @param conversation_pbx_audio_uuid
254
- # @param [Hash] opts the optional parameters
255
- # @return [ConversationPbxAudioResponse]
256
- def delete_pbx_audio(conversation_pbx_audio_uuid, opts = {})
257
- data, _status_code, _headers = delete_pbx_audio_with_http_info(conversation_pbx_audio_uuid, opts)
258
- data
259
- end
260
-
261
- # Delete pbx audio
262
- # Delete a pbx audio
263
- # @param conversation_pbx_audio_uuid
264
- # @param [Hash] opts the optional parameters
265
- # @return [Array<(ConversationPbxAudioResponse, Fixnum, Hash)>] ConversationPbxAudioResponse data, response status code and response headers
266
- def delete_pbx_audio_with_http_info(conversation_pbx_audio_uuid, opts = {})
267
- if @api_client.config.debugging
268
- @api_client.config.logger.debug 'Calling API: ConversationApi.delete_pbx_audio ...'
269
- end
270
- # verify the required parameter 'conversation_pbx_audio_uuid' is set
271
- if @api_client.config.client_side_validation && conversation_pbx_audio_uuid.nil?
272
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_audio_uuid' when calling ConversationApi.delete_pbx_audio"
273
- end
274
- # resource path
275
- local_var_path = '/conversation/pbx/audio/{conversationPbxAudioUuid}'.sub('{' + 'conversationPbxAudioUuid' + '}', conversation_pbx_audio_uuid.to_s)
276
-
277
- # query parameters
278
- query_params = {}
279
-
280
- # header parameters
281
- header_params = {}
282
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
283
- # HTTP header 'Accept' (if needed)
284
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
285
- # HTTP header 'Content-Type'
286
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
287
-
288
- # form parameters
289
- form_params = {}
290
-
291
- # http body (model)
292
- post_body = nil
293
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
294
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
295
- :header_params => header_params,
296
- :query_params => query_params,
297
- :form_params => form_params,
298
- :body => post_body,
299
- :auth_names => auth_names,
300
- :return_type => 'ConversationPbxAudioResponse')
301
- if @api_client.config.debugging
302
- @api_client.config.logger.debug "API called: ConversationApi#delete_pbx_audio\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
303
- end
304
- return data, status_code, headers
305
- end
306
- # Delete pbx menu
307
- # Delete a pbx menu
308
- # @param conversation_pbx_menu_uuid
309
- # @param [Hash] opts the optional parameters
310
- # @return [ConversationPbxMenuResponse]
311
- def delete_pbx_menu(conversation_pbx_menu_uuid, opts = {})
312
- data, _status_code, _headers = delete_pbx_menu_with_http_info(conversation_pbx_menu_uuid, opts)
313
- data
314
- end
315
-
316
- # Delete pbx menu
317
- # Delete a pbx menu
318
- # @param conversation_pbx_menu_uuid
319
- # @param [Hash] opts the optional parameters
320
- # @return [Array<(ConversationPbxMenuResponse, Fixnum, Hash)>] ConversationPbxMenuResponse data, response status code and response headers
321
- def delete_pbx_menu_with_http_info(conversation_pbx_menu_uuid, opts = {})
322
- if @api_client.config.debugging
323
- @api_client.config.logger.debug 'Calling API: ConversationApi.delete_pbx_menu ...'
324
- end
325
- # verify the required parameter 'conversation_pbx_menu_uuid' is set
326
- if @api_client.config.client_side_validation && conversation_pbx_menu_uuid.nil?
327
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_menu_uuid' when calling ConversationApi.delete_pbx_menu"
328
- end
329
- # resource path
330
- local_var_path = '/conversation/pbx/menu/{conversationPbxMenuUuid}'.sub('{' + 'conversationPbxMenuUuid' + '}', conversation_pbx_menu_uuid.to_s)
331
-
332
- # query parameters
333
- query_params = {}
334
-
335
- # header parameters
336
- header_params = {}
337
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
338
- # HTTP header 'Accept' (if needed)
339
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
340
- # HTTP header 'Content-Type'
341
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
342
-
343
- # form parameters
344
- form_params = {}
345
-
346
- # http body (model)
347
- post_body = nil
348
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
349
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
350
- :header_params => header_params,
351
- :query_params => query_params,
352
- :form_params => form_params,
353
- :body => post_body,
354
- :auth_names => auth_names,
355
- :return_type => 'ConversationPbxMenuResponse')
356
- if @api_client.config.debugging
357
- @api_client.config.logger.debug "API called: ConversationApi#delete_pbx_menu\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
358
- end
359
- return data, status_code, headers
360
- end
361
- # Delete pbx queue
362
- # Delete a pbx queue
363
- # @param conversation_pbx_queue_uuid
364
- # @param [Hash] opts the optional parameters
365
- # @return [ConversationPbxQueueResponse]
366
- def delete_pbx_queue(conversation_pbx_queue_uuid, opts = {})
367
- data, _status_code, _headers = delete_pbx_queue_with_http_info(conversation_pbx_queue_uuid, opts)
368
- data
369
- end
370
-
371
- # Delete pbx queue
372
- # Delete a pbx queue
373
- # @param conversation_pbx_queue_uuid
374
- # @param [Hash] opts the optional parameters
375
- # @return [Array<(ConversationPbxQueueResponse, Fixnum, Hash)>] ConversationPbxQueueResponse data, response status code and response headers
376
- def delete_pbx_queue_with_http_info(conversation_pbx_queue_uuid, opts = {})
377
- if @api_client.config.debugging
378
- @api_client.config.logger.debug 'Calling API: ConversationApi.delete_pbx_queue ...'
379
- end
380
- # verify the required parameter 'conversation_pbx_queue_uuid' is set
381
- if @api_client.config.client_side_validation && conversation_pbx_queue_uuid.nil?
382
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_queue_uuid' when calling ConversationApi.delete_pbx_queue"
383
- end
384
- # resource path
385
- local_var_path = '/conversation/pbx/queue/{conversationPbxQueueUuid}'.sub('{' + 'conversationPbxQueueUuid' + '}', conversation_pbx_queue_uuid.to_s)
386
-
387
- # query parameters
388
- query_params = {}
389
-
390
- # header parameters
391
- header_params = {}
392
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
393
- # HTTP header 'Accept' (if needed)
394
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
395
- # HTTP header 'Content-Type'
396
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
397
-
398
- # form parameters
399
- form_params = {}
400
-
401
- # http body (model)
402
- post_body = nil
403
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
404
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
405
- :header_params => header_params,
406
- :query_params => query_params,
407
- :form_params => form_params,
408
- :body => post_body,
409
- :auth_names => auth_names,
410
- :return_type => 'ConversationPbxQueueResponse')
411
- if @api_client.config.debugging
412
- @api_client.config.logger.debug "API called: ConversationApi#delete_pbx_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
413
- end
414
- return data, status_code, headers
415
- end
416
- # Delete Queue Voicemail
417
- # Delete pbx queue Voicemail
418
- # @param queue_uuid
419
- # @param recording_sid
420
- # @param [Hash] opts the optional parameters
421
- # @return [nil]
422
- def delete_pbx_queue_voicemail(queue_uuid, recording_sid, opts = {})
423
- delete_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid, opts)
424
- nil
425
- end
426
-
427
- # Delete Queue Voicemail
428
- # Delete pbx queue Voicemail
429
- # @param queue_uuid
430
- # @param recording_sid
431
- # @param [Hash] opts the optional parameters
432
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
433
- def delete_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid, opts = {})
434
- if @api_client.config.debugging
435
- @api_client.config.logger.debug 'Calling API: ConversationApi.delete_pbx_queue_voicemail ...'
436
- end
437
- # verify the required parameter 'queue_uuid' is set
438
- if @api_client.config.client_side_validation && queue_uuid.nil?
439
- fail ArgumentError, "Missing the required parameter 'queue_uuid' when calling ConversationApi.delete_pbx_queue_voicemail"
440
- end
441
- # verify the required parameter 'recording_sid' is set
442
- if @api_client.config.client_side_validation && recording_sid.nil?
443
- fail ArgumentError, "Missing the required parameter 'recording_sid' when calling ConversationApi.delete_pbx_queue_voicemail"
444
- end
445
- # resource path
446
- local_var_path = '/conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid}'.sub('{' + 'queue_uuid' + '}', queue_uuid.to_s).sub('{' + 'recording_sid' + '}', recording_sid.to_s)
447
-
448
- # query parameters
449
- query_params = {}
450
-
451
- # header parameters
452
- header_params = {}
453
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
454
- # HTTP header 'Accept' (if needed)
455
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
456
- # HTTP header 'Content-Type'
457
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
458
-
459
- # form parameters
460
- form_params = {}
461
-
462
- # http body (model)
463
- post_body = nil
464
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
465
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
466
- :header_params => header_params,
467
- :query_params => query_params,
468
- :form_params => form_params,
469
- :body => post_body,
470
- :auth_names => auth_names)
471
- if @api_client.config.debugging
472
- @api_client.config.logger.debug "API called: ConversationApi#delete_pbx_queue_voicemail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
473
- end
474
- return data, status_code, headers
475
- end
476
- # Delete pbx timeBased
477
- # Delete a pbx timeBased
478
- # @param conversation_pbx_time_based_uuid
479
- # @param [Hash] opts the optional parameters
480
- # @return [ConversationPbxTimeBasedResponse]
481
- def delete_pbx_time_based(conversation_pbx_time_based_uuid, opts = {})
482
- data, _status_code, _headers = delete_pbx_time_based_with_http_info(conversation_pbx_time_based_uuid, opts)
483
- data
484
- end
485
-
486
- # Delete pbx timeBased
487
- # Delete a pbx timeBased
488
- # @param conversation_pbx_time_based_uuid
489
- # @param [Hash] opts the optional parameters
490
- # @return [Array<(ConversationPbxTimeBasedResponse, Fixnum, Hash)>] ConversationPbxTimeBasedResponse data, response status code and response headers
491
- def delete_pbx_time_based_with_http_info(conversation_pbx_time_based_uuid, opts = {})
492
- if @api_client.config.debugging
493
- @api_client.config.logger.debug 'Calling API: ConversationApi.delete_pbx_time_based ...'
494
- end
495
- # verify the required parameter 'conversation_pbx_time_based_uuid' is set
496
- if @api_client.config.client_side_validation && conversation_pbx_time_based_uuid.nil?
497
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_time_based_uuid' when calling ConversationApi.delete_pbx_time_based"
498
- end
499
- # resource path
500
- local_var_path = '/conversation/pbx/time_based/{conversationPbxTimeBasedUuid}'.sub('{' + 'conversationPbxTimeBasedUuid' + '}', conversation_pbx_time_based_uuid.to_s)
501
-
502
- # query parameters
503
- query_params = {}
504
-
505
- # header parameters
506
- header_params = {}
507
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
508
- # HTTP header 'Accept' (if needed)
509
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
510
- # HTTP header 'Content-Type'
511
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
512
-
513
- # form parameters
514
- form_params = {}
515
-
516
- # http body (model)
517
- post_body = nil
518
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
519
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
520
- :header_params => header_params,
521
- :query_params => query_params,
522
- :form_params => form_params,
523
- :body => post_body,
524
- :auth_names => auth_names,
525
- :return_type => 'ConversationPbxTimeBasedResponse')
526
- if @api_client.config.debugging
527
- @api_client.config.logger.debug "API called: ConversationApi#delete_pbx_time_based\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
528
- end
529
- return data, status_code, headers
530
- end
531
- # Delete pbx timeRange
532
- # Delete a pbx timeRange
533
- # @param conversation_pbx_time_range_uuid
534
- # @param [Hash] opts the optional parameters
535
- # @return [ConversationPbxTimeRangeResponse]
536
- def delete_pbx_time_range(conversation_pbx_time_range_uuid, opts = {})
537
- data, _status_code, _headers = delete_pbx_time_range_with_http_info(conversation_pbx_time_range_uuid, opts)
538
- data
539
- end
540
-
541
- # Delete pbx timeRange
542
- # Delete a pbx timeRange
543
- # @param conversation_pbx_time_range_uuid
544
- # @param [Hash] opts the optional parameters
545
- # @return [Array<(ConversationPbxTimeRangeResponse, Fixnum, Hash)>] ConversationPbxTimeRangeResponse data, response status code and response headers
546
- def delete_pbx_time_range_with_http_info(conversation_pbx_time_range_uuid, opts = {})
547
- if @api_client.config.debugging
548
- @api_client.config.logger.debug 'Calling API: ConversationApi.delete_pbx_time_range ...'
549
- end
550
- # verify the required parameter 'conversation_pbx_time_range_uuid' is set
551
- if @api_client.config.client_side_validation && conversation_pbx_time_range_uuid.nil?
552
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_time_range_uuid' when calling ConversationApi.delete_pbx_time_range"
553
- end
554
- # resource path
555
- local_var_path = '/conversation/pbx/time_range/{conversationPbxTimeRangeUuid}'.sub('{' + 'conversationPbxTimeRangeUuid' + '}', conversation_pbx_time_range_uuid.to_s)
556
-
557
- # query parameters
558
- query_params = {}
559
-
560
- # header parameters
561
- header_params = {}
562
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
563
- # HTTP header 'Accept' (if needed)
564
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
565
- # HTTP header 'Content-Type'
566
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
567
-
568
- # form parameters
569
- form_params = {}
570
-
571
- # http body (model)
572
- post_body = nil
573
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
574
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
575
- :header_params => header_params,
576
- :query_params => query_params,
577
- :form_params => form_params,
578
- :body => post_body,
579
- :auth_names => auth_names,
580
- :return_type => 'ConversationPbxTimeRangeResponse')
581
- if @api_client.config.debugging
582
- @api_client.config.logger.debug "API called: ConversationApi#delete_pbx_time_range\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
583
- end
584
- return data, status_code, headers
585
- end
586
- # Delete pbx voicemailMailbox
587
- # Delete a pbx voicemailMailbox
588
- # @param conversation_pbx_voicemail_mailbox_uuid
589
- # @param [Hash] opts the optional parameters
590
- # @return [ConversationPbxVoicemailMailboxResponse]
591
- def delete_pbx_voicemail_mailbox(conversation_pbx_voicemail_mailbox_uuid, opts = {})
592
- data, _status_code, _headers = delete_pbx_voicemail_mailbox_with_http_info(conversation_pbx_voicemail_mailbox_uuid, opts)
593
- data
594
- end
595
-
596
- # Delete pbx voicemailMailbox
597
- # Delete a pbx voicemailMailbox
598
- # @param conversation_pbx_voicemail_mailbox_uuid
599
- # @param [Hash] opts the optional parameters
600
- # @return [Array<(ConversationPbxVoicemailMailboxResponse, Fixnum, Hash)>] ConversationPbxVoicemailMailboxResponse data, response status code and response headers
601
- def delete_pbx_voicemail_mailbox_with_http_info(conversation_pbx_voicemail_mailbox_uuid, opts = {})
602
- if @api_client.config.debugging
603
- @api_client.config.logger.debug 'Calling API: ConversationApi.delete_pbx_voicemail_mailbox ...'
604
- end
605
- # verify the required parameter 'conversation_pbx_voicemail_mailbox_uuid' is set
606
- if @api_client.config.client_side_validation && conversation_pbx_voicemail_mailbox_uuid.nil?
607
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_voicemail_mailbox_uuid' when calling ConversationApi.delete_pbx_voicemail_mailbox"
608
- end
609
- # resource path
610
- local_var_path = '/conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid}'.sub('{' + 'conversationPbxVoicemailMailboxUuid' + '}', conversation_pbx_voicemail_mailbox_uuid.to_s)
611
-
612
- # query parameters
613
- query_params = {}
614
-
615
- # header parameters
616
- header_params = {}
617
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
618
- # HTTP header 'Accept' (if needed)
619
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
620
- # HTTP header 'Content-Type'
621
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
622
-
623
- # form parameters
624
- form_params = {}
625
-
626
- # http body (model)
627
- post_body = nil
628
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
629
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
630
- :header_params => header_params,
631
- :query_params => query_params,
632
- :form_params => form_params,
633
- :body => post_body,
634
- :auth_names => auth_names,
635
- :return_type => 'ConversationPbxVoicemailMailboxResponse')
636
- if @api_client.config.debugging
637
- @api_client.config.logger.debug "API called: ConversationApi#delete_pbx_voicemail_mailbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
638
- end
639
- return data, status_code, headers
640
- end
641
- # Agent keep alive
642
- # Called periodically by the conversation API to keep the session alive.
643
- # @param [Hash] opts the optional parameters
644
- # @return [nil]
645
- def get_agent_keep_alive(opts = {})
646
- get_agent_keep_alive_with_http_info(opts)
647
- nil
648
- end
649
-
650
- # Agent keep alive
651
- # Called periodically by the conversation API to keep the session alive.
652
- # @param [Hash] opts the optional parameters
653
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
654
- def get_agent_keep_alive_with_http_info(opts = {})
655
- if @api_client.config.debugging
656
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_agent_keep_alive ...'
657
- end
658
- # resource path
659
- local_var_path = '/conversation/agent/keepalive'
660
-
661
- # query parameters
662
- query_params = {}
663
-
664
- # header parameters
665
- header_params = {}
666
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
667
- # HTTP header 'Accept' (if needed)
668
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
669
- # HTTP header 'Content-Type'
670
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
671
-
672
- # form parameters
673
- form_params = {}
674
-
675
- # http body (model)
676
- post_body = nil
677
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
678
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
679
- :header_params => header_params,
680
- :query_params => query_params,
681
- :form_params => form_params,
682
- :body => post_body,
683
- :auth_names => auth_names)
684
- if @api_client.config.debugging
685
- @api_client.config.logger.debug "API called: ConversationApi#get_agent_keep_alive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
686
- end
687
- return data, status_code, headers
688
- end
689
- # Get agent profile
690
- # Retrieve the agents profile
691
- # @param [Hash] opts the optional parameters
692
- # @return [ConversationAgentProfileResponse]
693
- def get_agent_profile(opts = {})
694
- data, _status_code, _headers = get_agent_profile_with_http_info(opts)
695
- data
696
- end
697
-
698
- # Get agent profile
699
- # Retrieve the agents profile
700
- # @param [Hash] opts the optional parameters
701
- # @return [Array<(ConversationAgentProfileResponse, Fixnum, Hash)>] ConversationAgentProfileResponse data, response status code and response headers
702
- def get_agent_profile_with_http_info(opts = {})
703
- if @api_client.config.debugging
704
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_agent_profile ...'
705
- end
706
- # resource path
707
- local_var_path = '/conversation/agent/profile'
708
-
709
- # query parameters
710
- query_params = {}
711
-
712
- # header parameters
713
- header_params = {}
714
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
715
- # HTTP header 'Accept' (if needed)
716
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
717
- # HTTP header 'Content-Type'
718
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
719
-
720
- # form parameters
721
- form_params = {}
722
-
723
- # http body (model)
724
- post_body = nil
725
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
726
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
727
- :header_params => header_params,
728
- :query_params => query_params,
729
- :form_params => form_params,
730
- :body => post_body,
731
- :auth_names => auth_names,
732
- :return_type => 'ConversationAgentProfileResponse')
733
- if @api_client.config.debugging
734
- @api_client.config.logger.debug "API called: ConversationApi#get_agent_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
735
- end
736
- return data, status_code, headers
737
- end
738
- # Get agent profiles
739
- # Retrieve the agents profile
740
- # @param [Hash] opts the optional parameters
741
- # @return [ConversationAgentProfilesResponse]
742
- def get_agent_profiles(opts = {})
743
- data, _status_code, _headers = get_agent_profiles_with_http_info(opts)
744
- data
745
- end
746
-
747
- # Get agent profiles
748
- # Retrieve the agents profile
749
- # @param [Hash] opts the optional parameters
750
- # @return [Array<(ConversationAgentProfilesResponse, Fixnum, Hash)>] ConversationAgentProfilesResponse data, response status code and response headers
751
- def get_agent_profiles_with_http_info(opts = {})
752
- if @api_client.config.debugging
753
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_agent_profiles ...'
754
- end
755
- # resource path
756
- local_var_path = '/conversation/agent/profiles'
757
-
758
- # query parameters
759
- query_params = {}
760
-
761
- # header parameters
762
- header_params = {}
763
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
764
- # HTTP header 'Accept' (if needed)
765
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
766
- # HTTP header 'Content-Type'
767
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
768
-
769
- # form parameters
770
- form_params = {}
771
-
772
- # http body (model)
773
- post_body = nil
774
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
775
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
776
- :header_params => header_params,
777
- :query_params => query_params,
778
- :form_params => form_params,
779
- :body => post_body,
780
- :auth_names => auth_names,
781
- :return_type => 'ConversationAgentProfilesResponse')
782
- if @api_client.config.debugging
783
- @api_client.config.logger.debug "API called: ConversationApi#get_agent_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
784
- end
785
- return data, status_code, headers
786
- end
787
- # Get agent websocket authorization
788
- # Retrieve a JWT to authorize an agent to make a websocket connection.
789
- # @param [Hash] opts the optional parameters
790
- # @return [ConversationAgentAuthResponse]
791
- def get_agent_websocket_authorization(opts = {})
792
- data, _status_code, _headers = get_agent_websocket_authorization_with_http_info(opts)
793
- data
794
- end
795
-
796
- # Get agent websocket authorization
797
- # Retrieve a JWT to authorize an agent to make a websocket connection.
798
- # @param [Hash] opts the optional parameters
799
- # @return [Array<(ConversationAgentAuthResponse, Fixnum, Hash)>] ConversationAgentAuthResponse data, response status code and response headers
800
- def get_agent_websocket_authorization_with_http_info(opts = {})
801
- if @api_client.config.debugging
802
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_agent_websocket_authorization ...'
803
- end
804
- # resource path
805
- local_var_path = '/conversation/agent/auth'
806
-
807
- # query parameters
808
- query_params = {}
809
-
810
- # header parameters
811
- header_params = {}
812
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
813
- # HTTP header 'Accept' (if needed)
814
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
815
- # HTTP header 'Content-Type'
816
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
817
-
818
- # form parameters
819
- form_params = {}
820
-
821
- # http body (model)
822
- post_body = nil
823
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
824
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
825
- :header_params => header_params,
826
- :query_params => query_params,
827
- :form_params => form_params,
828
- :body => post_body,
829
- :auth_names => auth_names,
830
- :return_type => 'ConversationAgentAuthResponse')
831
- if @api_client.config.debugging
832
- @api_client.config.logger.debug "API called: ConversationApi#get_agent_websocket_authorization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
833
- end
834
- return data, status_code, headers
835
- end
836
- # Retrieve a conversation
837
- # Retrieve a conversation including the participants and messages
838
- # @param conversation_uuid
839
- # @param [Hash] opts the optional parameters
840
- # @option opts [Integer] :limit
841
- # @return [ConversationResponse]
842
- def get_conversation(conversation_uuid, opts = {})
843
- data, _status_code, _headers = get_conversation_with_http_info(conversation_uuid, opts)
844
- data
845
- end
846
-
847
- # Retrieve a conversation
848
- # Retrieve a conversation including the participants and messages
849
- # @param conversation_uuid
850
- # @param [Hash] opts the optional parameters
851
- # @option opts [Integer] :limit
852
- # @return [Array<(ConversationResponse, Fixnum, Hash)>] ConversationResponse data, response status code and response headers
853
- def get_conversation_with_http_info(conversation_uuid, opts = {})
854
- if @api_client.config.debugging
855
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation ...'
856
- end
857
- # verify the required parameter 'conversation_uuid' is set
858
- if @api_client.config.client_side_validation && conversation_uuid.nil?
859
- fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.get_conversation"
860
- end
861
- # resource path
862
- local_var_path = '/conversation/conversations/{conversation_uuid}'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.to_s)
863
-
864
- # query parameters
865
- query_params = {}
866
- query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
867
-
868
- # header parameters
869
- header_params = {}
870
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
871
- # HTTP header 'Accept' (if needed)
872
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
873
- # HTTP header 'Content-Type'
874
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
875
-
876
- # form parameters
877
- form_params = {}
878
-
879
- # http body (model)
880
- post_body = nil
881
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
882
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
883
- :header_params => header_params,
884
- :query_params => query_params,
885
- :form_params => form_params,
886
- :body => post_body,
887
- :auth_names => auth_names,
888
- :return_type => 'ConversationResponse')
889
- if @api_client.config.debugging
890
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
891
- end
892
- return data, status_code, headers
893
- end
894
- # Retrieve a list of canned messages ordered by short_code
895
- # Retrieve a list of canned messages ordered by short_code
896
- # @param [Hash] opts the optional parameters
897
- # @return [ConversationCannedMessagesResponse]
898
- def get_conversation_canned_messages(opts = {})
899
- data, _status_code, _headers = get_conversation_canned_messages_with_http_info(opts)
900
- data
901
- end
902
-
903
- # Retrieve a list of canned messages ordered by short_code
904
- # Retrieve a list of canned messages ordered by short_code
905
- # @param [Hash] opts the optional parameters
906
- # @return [Array<(ConversationCannedMessagesResponse, Fixnum, Hash)>] ConversationCannedMessagesResponse data, response status code and response headers
907
- def get_conversation_canned_messages_with_http_info(opts = {})
908
- if @api_client.config.debugging
909
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_canned_messages ...'
910
- end
911
- # resource path
912
- local_var_path = '/conversation/canned_messages'
913
-
914
- # query parameters
915
- query_params = {}
916
-
917
- # header parameters
918
- header_params = {}
919
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
920
- # HTTP header 'Accept' (if needed)
921
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
922
- # HTTP header 'Content-Type'
923
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
924
-
925
- # form parameters
926
- form_params = {}
927
-
928
- # http body (model)
929
- post_body = nil
930
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
931
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
932
- :header_params => header_params,
933
- :query_params => query_params,
934
- :form_params => form_params,
935
- :body => post_body,
936
- :auth_names => auth_names,
937
- :return_type => 'ConversationCannedMessagesResponse')
938
- if @api_client.config.debugging
939
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_canned_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
940
- end
941
- return data, status_code, headers
942
- end
943
- # Get a webchat conversation context
944
- # Get a webchat conversation context
945
- # @param conversation_uuid
946
- # @param [Hash] opts the optional parameters
947
- # @return [ConversationWebchatContext]
948
- def get_conversation_context(conversation_uuid, opts = {})
949
- data, _status_code, _headers = get_conversation_context_with_http_info(conversation_uuid, opts)
950
- data
951
- end
952
-
953
- # Get a webchat conversation context
954
- # Get a webchat conversation context
955
- # @param conversation_uuid
956
- # @param [Hash] opts the optional parameters
957
- # @return [Array<(ConversationWebchatContext, Fixnum, Hash)>] ConversationWebchatContext data, response status code and response headers
958
- def get_conversation_context_with_http_info(conversation_uuid, opts = {})
959
- if @api_client.config.debugging
960
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_context ...'
961
- end
962
- # verify the required parameter 'conversation_uuid' is set
963
- if @api_client.config.client_side_validation && conversation_uuid.nil?
964
- fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.get_conversation_context"
965
- end
966
- # resource path
967
- local_var_path = '/conversation/conversations/{conversation_uuid}/context'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.to_s)
968
-
969
- # query parameters
970
- query_params = {}
971
-
972
- # header parameters
973
- header_params = {}
974
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
975
- # HTTP header 'Accept' (if needed)
976
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
977
- # HTTP header 'Content-Type'
978
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
979
-
980
- # form parameters
981
- form_params = {}
982
-
983
- # http body (model)
984
- post_body = nil
985
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
986
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
987
- :header_params => header_params,
988
- :query_params => query_params,
989
- :form_params => form_params,
990
- :body => post_body,
991
- :auth_names => auth_names,
992
- :return_type => 'ConversationWebchatContext')
993
- if @api_client.config.debugging
994
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_context\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
995
- end
996
- return data, status_code, headers
997
- end
998
- # Retrieve a list of possible department members
999
- # Retrieve a list of possible department members
1000
- # @param [Hash] opts the optional parameters
1001
- # @return [ConversationDepartmentMembersResponse]
1002
- def get_conversation_department_member_list(opts = {})
1003
- data, _status_code, _headers = get_conversation_department_member_list_with_http_info(opts)
1004
- data
1005
- end
1006
-
1007
- # Retrieve a list of possible department members
1008
- # Retrieve a list of possible department members
1009
- # @param [Hash] opts the optional parameters
1010
- # @return [Array<(ConversationDepartmentMembersResponse, Fixnum, Hash)>] ConversationDepartmentMembersResponse data, response status code and response headers
1011
- def get_conversation_department_member_list_with_http_info(opts = {})
1012
- if @api_client.config.debugging
1013
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_department_member_list ...'
1014
- end
1015
- # resource path
1016
- local_var_path = '/conversation/department_members'
1017
-
1018
- # query parameters
1019
- query_params = {}
1020
-
1021
- # header parameters
1022
- header_params = {}
1023
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1024
- # HTTP header 'Accept' (if needed)
1025
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1026
- # HTTP header 'Content-Type'
1027
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1028
-
1029
- # form parameters
1030
- form_params = {}
1031
-
1032
- # http body (model)
1033
- post_body = nil
1034
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1035
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1036
- :header_params => header_params,
1037
- :query_params => query_params,
1038
- :form_params => form_params,
1039
- :body => post_body,
1040
- :auth_names => auth_names,
1041
- :return_type => 'ConversationDepartmentMembersResponse')
1042
- if @api_client.config.debugging
1043
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_department_member_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1044
- end
1045
- return data, status_code, headers
1046
- end
1047
- # Retrieve a list of departments ordered by name
1048
- # Retrieve a list of departments ordered by name
1049
- # @param [Hash] opts the optional parameters
1050
- # @return [ConversationDepartmentsResponse]
1051
- def get_conversation_departments(opts = {})
1052
- data, _status_code, _headers = get_conversation_departments_with_http_info(opts)
1053
- data
1054
- end
1055
-
1056
- # Retrieve a list of departments ordered by name
1057
- # Retrieve a list of departments ordered by name
1058
- # @param [Hash] opts the optional parameters
1059
- # @return [Array<(ConversationDepartmentsResponse, Fixnum, Hash)>] ConversationDepartmentsResponse data, response status code and response headers
1060
- def get_conversation_departments_with_http_info(opts = {})
1061
- if @api_client.config.debugging
1062
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_departments ...'
1063
- end
1064
- # resource path
1065
- local_var_path = '/conversation/departments'
1066
-
1067
- # query parameters
1068
- query_params = {}
1069
-
1070
- # header parameters
1071
- header_params = {}
1072
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1073
- # HTTP header 'Accept' (if needed)
1074
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1075
- # HTTP header 'Content-Type'
1076
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1077
-
1078
- # form parameters
1079
- form_params = {}
1080
-
1081
- # http body (model)
1082
- post_body = nil
1083
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1084
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1085
- :header_params => header_params,
1086
- :query_params => query_params,
1087
- :form_params => form_params,
1088
- :body => post_body,
1089
- :auth_names => auth_names,
1090
- :return_type => 'ConversationDepartmentsResponse')
1091
- if @api_client.config.debugging
1092
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_departments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1093
- end
1094
- return data, status_code, headers
1095
- end
1096
- # Retrieve an engagement
1097
- # Retrieve an engagement
1098
- # @param conversation_engagement_oid
1099
- # @param [Hash] opts the optional parameters
1100
- # @return [ConversationEngagementResponse]
1101
- def get_conversation_engagement(conversation_engagement_oid, opts = {})
1102
- data, _status_code, _headers = get_conversation_engagement_with_http_info(conversation_engagement_oid, opts)
1103
- data
1104
- end
1105
-
1106
- # Retrieve an engagement
1107
- # Retrieve an engagement
1108
- # @param conversation_engagement_oid
1109
- # @param [Hash] opts the optional parameters
1110
- # @return [Array<(ConversationEngagementResponse, Fixnum, Hash)>] ConversationEngagementResponse data, response status code and response headers
1111
- def get_conversation_engagement_with_http_info(conversation_engagement_oid, opts = {})
1112
- if @api_client.config.debugging
1113
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_engagement ...'
1114
- end
1115
- # verify the required parameter 'conversation_engagement_oid' is set
1116
- if @api_client.config.client_side_validation && conversation_engagement_oid.nil?
1117
- fail ArgumentError, "Missing the required parameter 'conversation_engagement_oid' when calling ConversationApi.get_conversation_engagement"
1118
- end
1119
- # resource path
1120
- local_var_path = '/conversation/engagements/{conversation_engagement_oid}'.sub('{' + 'conversation_engagement_oid' + '}', conversation_engagement_oid.to_s)
1121
-
1122
- # query parameters
1123
- query_params = {}
1124
-
1125
- # header parameters
1126
- header_params = {}
1127
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1128
- # HTTP header 'Accept' (if needed)
1129
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1130
- # HTTP header 'Content-Type'
1131
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1132
-
1133
- # form parameters
1134
- form_params = {}
1135
-
1136
- # http body (model)
1137
- post_body = nil
1138
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1139
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1140
- :header_params => header_params,
1141
- :query_params => query_params,
1142
- :form_params => form_params,
1143
- :body => post_body,
1144
- :auth_names => auth_names,
1145
- :return_type => 'ConversationEngagementResponse')
1146
- if @api_client.config.debugging
1147
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_engagement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1148
- end
1149
- return data, status_code, headers
1150
- end
1151
- # Retrieve a list of engagements ordered by name
1152
- # Retrieve a list of engagements ordered by name
1153
- # @param [Hash] opts the optional parameters
1154
- # @return [ConversationEngagementsResponse]
1155
- def get_conversation_engagements(opts = {})
1156
- data, _status_code, _headers = get_conversation_engagements_with_http_info(opts)
1157
- data
1158
- end
1159
-
1160
- # Retrieve a list of engagements ordered by name
1161
- # Retrieve a list of engagements ordered by name
1162
- # @param [Hash] opts the optional parameters
1163
- # @return [Array<(ConversationEngagementsResponse, Fixnum, Hash)>] ConversationEngagementsResponse data, response status code and response headers
1164
- def get_conversation_engagements_with_http_info(opts = {})
1165
- if @api_client.config.debugging
1166
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_engagements ...'
1167
- end
1168
- # resource path
1169
- local_var_path = '/conversation/engagements'
1170
-
1171
- # query parameters
1172
- query_params = {}
1173
-
1174
- # header parameters
1175
- header_params = {}
1176
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1177
- # HTTP header 'Accept' (if needed)
1178
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1179
- # HTTP header 'Content-Type'
1180
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1181
-
1182
- # form parameters
1183
- form_params = {}
1184
-
1185
- # http body (model)
1186
- post_body = nil
1187
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1188
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1189
- :header_params => header_params,
1190
- :query_params => query_params,
1191
- :form_params => form_params,
1192
- :body => post_body,
1193
- :auth_names => auth_names,
1194
- :return_type => 'ConversationEngagementsResponse')
1195
- if @api_client.config.debugging
1196
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_engagements\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1197
- end
1198
- return data, status_code, headers
1199
- end
1200
- # Retrieve conversation messages
1201
- # Retrieve conversation messages since a particular time
1202
- # @param conversation_uuid
1203
- # @param since
1204
- # @param [Hash] opts the optional parameters
1205
- # @option opts [Integer] :limit
1206
- # @return [ConversationMessagesResponse]
1207
- def get_conversation_messages(conversation_uuid, since, opts = {})
1208
- data, _status_code, _headers = get_conversation_messages_with_http_info(conversation_uuid, since, opts)
1209
- data
1210
- end
1211
-
1212
- # Retrieve conversation messages
1213
- # Retrieve conversation messages since a particular time
1214
- # @param conversation_uuid
1215
- # @param since
1216
- # @param [Hash] opts the optional parameters
1217
- # @option opts [Integer] :limit
1218
- # @return [Array<(ConversationMessagesResponse, Fixnum, Hash)>] ConversationMessagesResponse data, response status code and response headers
1219
- def get_conversation_messages_with_http_info(conversation_uuid, since, opts = {})
1220
- if @api_client.config.debugging
1221
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_messages ...'
1222
- end
1223
- # verify the required parameter 'conversation_uuid' is set
1224
- if @api_client.config.client_side_validation && conversation_uuid.nil?
1225
- fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.get_conversation_messages"
1226
- end
1227
- # verify the required parameter 'since' is set
1228
- if @api_client.config.client_side_validation && since.nil?
1229
- fail ArgumentError, "Missing the required parameter 'since' when calling ConversationApi.get_conversation_messages"
1230
- end
1231
- # resource path
1232
- local_var_path = '/conversation/conversations/{conversation_uuid}/messages/{since}'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.to_s).sub('{' + 'since' + '}', since.to_s)
1233
-
1234
- # query parameters
1235
- query_params = {}
1236
- query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
1237
-
1238
- # header parameters
1239
- header_params = {}
1240
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1241
- # HTTP header 'Accept' (if needed)
1242
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1243
- # HTTP header 'Content-Type'
1244
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1245
-
1246
- # form parameters
1247
- form_params = {}
1248
-
1249
- # http body (model)
1250
- post_body = nil
1251
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1252
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1253
- :header_params => header_params,
1254
- :query_params => query_params,
1255
- :form_params => form_params,
1256
- :body => post_body,
1257
- :auth_names => auth_names,
1258
- :return_type => 'ConversationMessagesResponse')
1259
- if @api_client.config.debugging
1260
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1261
- end
1262
- return data, status_code, headers
1263
- end
1264
- # Get a presigned conversation multimedia upload URL
1265
- # Get a presigned conversation multimedia upload URL
1266
- # @param extension
1267
- # @param [Hash] opts the optional parameters
1268
- # @return [ConversationMultimediaUploadUrlResponse]
1269
- def get_conversation_multimedia_upload_url(extension, opts = {})
1270
- data, _status_code, _headers = get_conversation_multimedia_upload_url_with_http_info(extension, opts)
1271
- data
1272
- end
1273
-
1274
- # Get a presigned conversation multimedia upload URL
1275
- # Get a presigned conversation multimedia upload URL
1276
- # @param extension
1277
- # @param [Hash] opts the optional parameters
1278
- # @return [Array<(ConversationMultimediaUploadUrlResponse, Fixnum, Hash)>] ConversationMultimediaUploadUrlResponse data, response status code and response headers
1279
- def get_conversation_multimedia_upload_url_with_http_info(extension, opts = {})
1280
- if @api_client.config.debugging
1281
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_multimedia_upload_url ...'
1282
- end
1283
- # verify the required parameter 'extension' is set
1284
- if @api_client.config.client_side_validation && extension.nil?
1285
- fail ArgumentError, "Missing the required parameter 'extension' when calling ConversationApi.get_conversation_multimedia_upload_url"
1286
- end
1287
- # resource path
1288
- local_var_path = '/conversation/upload_url/{extension}'.sub('{' + 'extension' + '}', extension.to_s)
1289
-
1290
- # query parameters
1291
- query_params = {}
1292
-
1293
- # header parameters
1294
- header_params = {}
1295
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1296
- # HTTP header 'Accept' (if needed)
1297
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1298
- # HTTP header 'Content-Type'
1299
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1300
-
1301
- # form parameters
1302
- form_params = {}
1303
-
1304
- # http body (model)
1305
- post_body = nil
1306
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1307
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1308
- :header_params => header_params,
1309
- :query_params => query_params,
1310
- :form_params => form_params,
1311
- :body => post_body,
1312
- :auth_names => auth_names,
1313
- :return_type => 'ConversationMultimediaUploadUrlResponse')
1314
- if @api_client.config.debugging
1315
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_multimedia_upload_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1316
- end
1317
- return data, status_code, headers
1318
- end
1319
- # Get a pre-signed conversation multimedia upload URL
1320
- # Get a pre-signed conversation multimedia upload URL
1321
- # @param extension
1322
- # @param [Hash] opts the optional parameters
1323
- # @return [ConversationPbxAudioUploadUrlResponse]
1324
- def get_conversation_pbx_audio_upload_url(extension, opts = {})
1325
- data, _status_code, _headers = get_conversation_pbx_audio_upload_url_with_http_info(extension, opts)
1326
- data
1327
- end
1328
-
1329
- # Get a pre-signed conversation multimedia upload URL
1330
- # Get a pre-signed conversation multimedia upload URL
1331
- # @param extension
1332
- # @param [Hash] opts the optional parameters
1333
- # @return [Array<(ConversationPbxAudioUploadUrlResponse, Fixnum, Hash)>] ConversationPbxAudioUploadUrlResponse data, response status code and response headers
1334
- def get_conversation_pbx_audio_upload_url_with_http_info(extension, opts = {})
1335
- if @api_client.config.debugging
1336
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_pbx_audio_upload_url ...'
1337
- end
1338
- # verify the required parameter 'extension' is set
1339
- if @api_client.config.client_side_validation && extension.nil?
1340
- fail ArgumentError, "Missing the required parameter 'extension' when calling ConversationApi.get_conversation_pbx_audio_upload_url"
1341
- end
1342
- # resource path
1343
- local_var_path = '/conversation/pbx/audio/upload_url/{extension}'.sub('{' + 'extension' + '}', extension.to_s)
1344
-
1345
- # query parameters
1346
- query_params = {}
1347
-
1348
- # header parameters
1349
- header_params = {}
1350
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1351
- # HTTP header 'Accept' (if needed)
1352
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1353
- # HTTP header 'Content-Type'
1354
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1355
-
1356
- # form parameters
1357
- form_params = {}
1358
-
1359
- # http body (model)
1360
- post_body = nil
1361
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1362
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1363
- :header_params => header_params,
1364
- :query_params => query_params,
1365
- :form_params => form_params,
1366
- :body => post_body,
1367
- :auth_names => auth_names,
1368
- :return_type => 'ConversationPbxAudioUploadUrlResponse')
1369
- if @api_client.config.debugging
1370
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_pbx_audio_upload_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1371
- end
1372
- return data, status_code, headers
1373
- end
1374
- # Get orders and customer information for a phone number
1375
- # Retrieves all the orders, auto orders, and customer profile for a given phone number
1376
- # @param pbx_customer_snapshot_request Conversation pbx customer snapshot request
1377
- # @param [Hash] opts the optional parameters
1378
- # @return [ConversationPbxCustomerSnapshotResponse]
1379
- def get_conversation_pbx_customer_snapshot(pbx_customer_snapshot_request, opts = {})
1380
- data, _status_code, _headers = get_conversation_pbx_customer_snapshot_with_http_info(pbx_customer_snapshot_request, opts)
1381
- data
1382
- end
1383
-
1384
- # Get orders and customer information for a phone number
1385
- # Retrieves all the orders, auto orders, and customer profile for a given phone number
1386
- # @param pbx_customer_snapshot_request Conversation pbx customer snapshot request
1387
- # @param [Hash] opts the optional parameters
1388
- # @return [Array<(ConversationPbxCustomerSnapshotResponse, Fixnum, Hash)>] ConversationPbxCustomerSnapshotResponse data, response status code and response headers
1389
- def get_conversation_pbx_customer_snapshot_with_http_info(pbx_customer_snapshot_request, opts = {})
1390
- if @api_client.config.debugging
1391
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_pbx_customer_snapshot ...'
1392
- end
1393
- # verify the required parameter 'pbx_customer_snapshot_request' is set
1394
- if @api_client.config.client_side_validation && pbx_customer_snapshot_request.nil?
1395
- fail ArgumentError, "Missing the required parameter 'pbx_customer_snapshot_request' when calling ConversationApi.get_conversation_pbx_customer_snapshot"
1396
- end
1397
- # resource path
1398
- local_var_path = '/conversation/pbx/customer_snapshot'
1399
-
1400
- # query parameters
1401
- query_params = {}
1402
-
1403
- # header parameters
1404
- header_params = {}
1405
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1406
- # HTTP header 'Accept' (if needed)
1407
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1408
- # HTTP header 'Content-Type'
1409
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1410
-
1411
- # form parameters
1412
- form_params = {}
1413
-
1414
- # http body (model)
1415
- post_body = @api_client.object_to_http_body(pbx_customer_snapshot_request)
1416
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1417
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1418
- :header_params => header_params,
1419
- :query_params => query_params,
1420
- :form_params => form_params,
1421
- :body => post_body,
1422
- :auth_names => auth_names,
1423
- :return_type => 'ConversationPbxCustomerSnapshotResponse')
1424
- if @api_client.config.debugging
1425
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_pbx_customer_snapshot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1426
- end
1427
- return data, status_code, headers
1428
- end
1429
- # Retrieve conversation permissions
1430
- # Retrieve conversation permissions
1431
- # @param [Hash] opts the optional parameters
1432
- # @return [ConversationPermissionsResponse]
1433
- def get_conversation_permissions(opts = {})
1434
- data, _status_code, _headers = get_conversation_permissions_with_http_info(opts)
1435
- data
1436
- end
1437
-
1438
- # Retrieve conversation permissions
1439
- # Retrieve conversation permissions
1440
- # @param [Hash] opts the optional parameters
1441
- # @return [Array<(ConversationPermissionsResponse, Fixnum, Hash)>] ConversationPermissionsResponse data, response status code and response headers
1442
- def get_conversation_permissions_with_http_info(opts = {})
1443
- if @api_client.config.debugging
1444
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_permissions ...'
1445
- end
1446
- # resource path
1447
- local_var_path = '/conversation/permissions'
1448
-
1449
- # query parameters
1450
- query_params = {}
1451
-
1452
- # header parameters
1453
- header_params = {}
1454
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1455
- # HTTP header 'Accept' (if needed)
1456
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1457
- # HTTP header 'Content-Type'
1458
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1459
-
1460
- # form parameters
1461
- form_params = {}
1462
-
1463
- # http body (model)
1464
- post_body = nil
1465
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1466
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1467
- :header_params => header_params,
1468
- :query_params => query_params,
1469
- :form_params => form_params,
1470
- :body => post_body,
1471
- :auth_names => auth_names,
1472
- :return_type => 'ConversationPermissionsResponse')
1473
- if @api_client.config.debugging
1474
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1475
- end
1476
- return data, status_code, headers
1477
- end
1478
- # Retrieve a conversation webchat queue statuses
1479
- # Retrieve a conversation webchat queue statuses including agent status and queue entries
1480
- # @param [Hash] opts the optional parameters
1481
- # @return [ConversationWebchatQueueStatusesResponse]
1482
- def get_conversation_webchat_queue_statuses(opts = {})
1483
- data, _status_code, _headers = get_conversation_webchat_queue_statuses_with_http_info(opts)
1484
- data
1485
- end
1486
-
1487
- # Retrieve a conversation webchat queue statuses
1488
- # Retrieve a conversation webchat queue statuses including agent status and queue entries
1489
- # @param [Hash] opts the optional parameters
1490
- # @return [Array<(ConversationWebchatQueueStatusesResponse, Fixnum, Hash)>] ConversationWebchatQueueStatusesResponse data, response status code and response headers
1491
- def get_conversation_webchat_queue_statuses_with_http_info(opts = {})
1492
- if @api_client.config.debugging
1493
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_webchat_queue_statuses ...'
1494
- end
1495
- # resource path
1496
- local_var_path = '/conversation/conversations/queues/statuses'
1497
-
1498
- # query parameters
1499
- query_params = {}
1500
-
1501
- # header parameters
1502
- header_params = {}
1503
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1504
- # HTTP header 'Accept' (if needed)
1505
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1506
- # HTTP header 'Content-Type'
1507
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1508
-
1509
- # form parameters
1510
- form_params = {}
1511
-
1512
- # http body (model)
1513
- post_body = nil
1514
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1515
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1516
- :header_params => header_params,
1517
- :query_params => query_params,
1518
- :form_params => form_params,
1519
- :body => post_body,
1520
- :auth_names => auth_names,
1521
- :return_type => 'ConversationWebchatQueueStatusesResponse')
1522
- if @api_client.config.debugging
1523
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_webchat_queue_statuses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1524
- end
1525
- return data, status_code, headers
1526
- end
1527
- # Retrieve a list of conversation summaries newest to oldest
1528
- # Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
1529
- # @param [Hash] opts the optional parameters
1530
- # @option opts [String] :medium
1531
- # @option opts [String] :before
1532
- # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Max 200) (default to 100)
1533
- # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
1534
- # @return [ConversationsResponse]
1535
- def get_conversations(opts = {})
1536
- data, _status_code, _headers = get_conversations_with_http_info(opts)
1537
- data
1538
- end
1539
-
1540
- # Retrieve a list of conversation summaries newest to oldest
1541
- # Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
1542
- # @param [Hash] opts the optional parameters
1543
- # @option opts [String] :medium
1544
- # @option opts [String] :before
1545
- # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Max 200)
1546
- # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index.
1547
- # @return [Array<(ConversationsResponse, Fixnum, Hash)>] ConversationsResponse data, response status code and response headers
1548
- def get_conversations_with_http_info(opts = {})
1549
- if @api_client.config.debugging
1550
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversations ...'
1551
- end
1552
- # resource path
1553
- local_var_path = '/conversation/conversations'
1554
-
1555
- # query parameters
1556
- query_params = {}
1557
- query_params[:'medium'] = opts[:'medium'] if !opts[:'medium'].nil?
1558
- query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
1559
- query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
1560
- query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
1561
-
1562
- # header parameters
1563
- header_params = {}
1564
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1565
- # HTTP header 'Accept' (if needed)
1566
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1567
- # HTTP header 'Content-Type'
1568
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1569
-
1570
- # form parameters
1571
- form_params = {}
1572
-
1573
- # http body (model)
1574
- post_body = nil
1575
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1576
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1577
- :header_params => header_params,
1578
- :query_params => query_params,
1579
- :form_params => form_params,
1580
- :body => post_body,
1581
- :auth_names => auth_names,
1582
- :return_type => 'ConversationsResponse')
1583
- if @api_client.config.debugging
1584
- @api_client.config.logger.debug "API called: ConversationApi#get_conversations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1585
- end
1586
- return data, status_code, headers
1587
- end
1588
- # Retrieve a list of matching terms for a search field
1589
- # Retrieve a list of matching terms for a search field
1590
- # @param autocomplete_request Autocomplete Request
1591
- # @param [Hash] opts the optional parameters
1592
- # @return [ConversationAutocompleteResponse]
1593
- def get_conversations_autocomplete(autocomplete_request, opts = {})
1594
- data, _status_code, _headers = get_conversations_autocomplete_with_http_info(autocomplete_request, opts)
1595
- data
1596
- end
1597
-
1598
- # Retrieve a list of matching terms for a search field
1599
- # Retrieve a list of matching terms for a search field
1600
- # @param autocomplete_request Autocomplete Request
1601
- # @param [Hash] opts the optional parameters
1602
- # @return [Array<(ConversationAutocompleteResponse, Fixnum, Hash)>] ConversationAutocompleteResponse data, response status code and response headers
1603
- def get_conversations_autocomplete_with_http_info(autocomplete_request, opts = {})
1604
- if @api_client.config.debugging
1605
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversations_autocomplete ...'
1606
- end
1607
- # verify the required parameter 'autocomplete_request' is set
1608
- if @api_client.config.client_side_validation && autocomplete_request.nil?
1609
- fail ArgumentError, "Missing the required parameter 'autocomplete_request' when calling ConversationApi.get_conversations_autocomplete"
1610
- end
1611
- # resource path
1612
- local_var_path = '/conversation/conversations/autocomplete'
1613
-
1614
- # query parameters
1615
- query_params = {}
1616
-
1617
- # header parameters
1618
- header_params = {}
1619
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1620
- # HTTP header 'Accept' (if needed)
1621
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1622
- # HTTP header 'Content-Type'
1623
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1624
-
1625
- # form parameters
1626
- form_params = {}
1627
-
1628
- # http body (model)
1629
- post_body = @api_client.object_to_http_body(autocomplete_request)
1630
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1631
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1632
- :header_params => header_params,
1633
- :query_params => query_params,
1634
- :form_params => form_params,
1635
- :body => post_body,
1636
- :auth_names => auth_names,
1637
- :return_type => 'ConversationAutocompleteResponse')
1638
- if @api_client.config.debugging
1639
- @api_client.config.logger.debug "API called: ConversationApi#get_conversations_autocomplete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1640
- end
1641
- return data, status_code, headers
1642
- end
1643
- # Search conversations
1644
- # Search conversations
1645
- # @param search_request Search Request
1646
- # @param [Hash] opts the optional parameters
1647
- # @return [ConversationSearchResponse]
1648
- def get_conversations_search(search_request, opts = {})
1649
- data, _status_code, _headers = get_conversations_search_with_http_info(search_request, opts)
1650
- data
1651
- end
1652
-
1653
- # Search conversations
1654
- # Search conversations
1655
- # @param search_request Search Request
1656
- # @param [Hash] opts the optional parameters
1657
- # @return [Array<(ConversationSearchResponse, Fixnum, Hash)>] ConversationSearchResponse data, response status code and response headers
1658
- def get_conversations_search_with_http_info(search_request, opts = {})
1659
- if @api_client.config.debugging
1660
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversations_search ...'
1661
- end
1662
- # verify the required parameter 'search_request' is set
1663
- if @api_client.config.client_side_validation && search_request.nil?
1664
- fail ArgumentError, "Missing the required parameter 'search_request' when calling ConversationApi.get_conversations_search"
1665
- end
1666
- # resource path
1667
- local_var_path = '/conversation/conversations/search'
1668
-
1669
- # query parameters
1670
- query_params = {}
1671
-
1672
- # header parameters
1673
- header_params = {}
1674
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1675
- # HTTP header 'Accept' (if needed)
1676
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1677
- # HTTP header 'Content-Type'
1678
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1679
-
1680
- # form parameters
1681
- form_params = {}
1682
-
1683
- # http body (model)
1684
- post_body = @api_client.object_to_http_body(search_request)
1685
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1686
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1687
- :header_params => header_params,
1688
- :query_params => query_params,
1689
- :form_params => form_params,
1690
- :body => post_body,
1691
- :auth_names => auth_names,
1692
- :return_type => 'ConversationSearchResponse')
1693
- if @api_client.config.debugging
1694
- @api_client.config.logger.debug "API called: ConversationApi#get_conversations_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1695
- end
1696
- return data, status_code, headers
1697
- end
1698
- # Get location data for engagement configuration
1699
- # Get location data for engagement configuration
1700
- # @param [Hash] opts the optional parameters
1701
- # @return [ConversationLocationsResponse]
1702
- def get_locations_for_engagement(opts = {})
1703
- data, _status_code, _headers = get_locations_for_engagement_with_http_info(opts)
1704
- data
1705
- end
1706
-
1707
- # Get location data for engagement configuration
1708
- # Get location data for engagement configuration
1709
- # @param [Hash] opts the optional parameters
1710
- # @return [Array<(ConversationLocationsResponse, Fixnum, Hash)>] ConversationLocationsResponse data, response status code and response headers
1711
- def get_locations_for_engagement_with_http_info(opts = {})
1712
- if @api_client.config.debugging
1713
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_locations_for_engagement ...'
1714
- end
1715
- # resource path
1716
- local_var_path = '/conversation/locations'
1717
-
1718
- # query parameters
1719
- query_params = {}
1720
-
1721
- # header parameters
1722
- header_params = {}
1723
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1724
- # HTTP header 'Accept' (if needed)
1725
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1726
- # HTTP header 'Content-Type'
1727
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1728
-
1729
- # form parameters
1730
- form_params = {}
1731
-
1732
- # http body (model)
1733
- post_body = nil
1734
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1735
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1736
- :header_params => header_params,
1737
- :query_params => query_params,
1738
- :form_params => form_params,
1739
- :body => post_body,
1740
- :auth_names => auth_names,
1741
- :return_type => 'ConversationLocationsResponse')
1742
- if @api_client.config.debugging
1743
- @api_client.config.logger.debug "API called: ConversationApi#get_locations_for_engagement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1744
- end
1745
- return data, status_code, headers
1746
- end
1747
- # Get pbx agent
1748
- # Retrieve a pbx agent
1749
- # @param conversation_pbx_agent_uuid
1750
- # @param [Hash] opts the optional parameters
1751
- # @return [ConversationPbxAgentResponse]
1752
- def get_pbx_agent(conversation_pbx_agent_uuid, opts = {})
1753
- data, _status_code, _headers = get_pbx_agent_with_http_info(conversation_pbx_agent_uuid, opts)
1754
- data
1755
- end
1756
-
1757
- # Get pbx agent
1758
- # Retrieve a pbx agent
1759
- # @param conversation_pbx_agent_uuid
1760
- # @param [Hash] opts the optional parameters
1761
- # @return [Array<(ConversationPbxAgentResponse, Fixnum, Hash)>] ConversationPbxAgentResponse data, response status code and response headers
1762
- def get_pbx_agent_with_http_info(conversation_pbx_agent_uuid, opts = {})
1763
- if @api_client.config.debugging
1764
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_agent ...'
1765
- end
1766
- # verify the required parameter 'conversation_pbx_agent_uuid' is set
1767
- if @api_client.config.client_side_validation && conversation_pbx_agent_uuid.nil?
1768
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_agent_uuid' when calling ConversationApi.get_pbx_agent"
1769
- end
1770
- # resource path
1771
- local_var_path = '/conversation/pbx/agent/{conversationPbxAgentUuid}'.sub('{' + 'conversationPbxAgentUuid' + '}', conversation_pbx_agent_uuid.to_s)
1772
-
1773
- # query parameters
1774
- query_params = {}
1775
-
1776
- # header parameters
1777
- header_params = {}
1778
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1779
- # HTTP header 'Accept' (if needed)
1780
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1781
- # HTTP header 'Content-Type'
1782
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1783
-
1784
- # form parameters
1785
- form_params = {}
1786
-
1787
- # http body (model)
1788
- post_body = nil
1789
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1790
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1791
- :header_params => header_params,
1792
- :query_params => query_params,
1793
- :form_params => form_params,
1794
- :body => post_body,
1795
- :auth_names => auth_names,
1796
- :return_type => 'ConversationPbxAgentResponse')
1797
- if @api_client.config.debugging
1798
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_agent\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1799
- end
1800
- return data, status_code, headers
1801
- end
1802
- # Get Agent Voicemail
1803
- # Retrieve pbx agent Voicemail
1804
- # @param recording_sid
1805
- # @param [Hash] opts the optional parameters
1806
- # @return [ConversationPbxVoicemailMessageResponse]
1807
- def get_pbx_agent_voicemail(recording_sid, opts = {})
1808
- data, _status_code, _headers = get_pbx_agent_voicemail_with_http_info(recording_sid, opts)
1809
- data
1810
- end
1811
-
1812
- # Get Agent Voicemail
1813
- # Retrieve pbx agent Voicemail
1814
- # @param recording_sid
1815
- # @param [Hash] opts the optional parameters
1816
- # @return [Array<(ConversationPbxVoicemailMessageResponse, Fixnum, Hash)>] ConversationPbxVoicemailMessageResponse data, response status code and response headers
1817
- def get_pbx_agent_voicemail_with_http_info(recording_sid, opts = {})
1818
- if @api_client.config.debugging
1819
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_agent_voicemail ...'
1820
- end
1821
- # verify the required parameter 'recording_sid' is set
1822
- if @api_client.config.client_side_validation && recording_sid.nil?
1823
- fail ArgumentError, "Missing the required parameter 'recording_sid' when calling ConversationApi.get_pbx_agent_voicemail"
1824
- end
1825
- # resource path
1826
- local_var_path = '/conversation/pbx/agent/voicemails/{recording_sid}'.sub('{' + 'recording_sid' + '}', recording_sid.to_s)
1827
-
1828
- # query parameters
1829
- query_params = {}
1830
-
1831
- # header parameters
1832
- header_params = {}
1833
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1834
- # HTTP header 'Accept' (if needed)
1835
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1836
- # HTTP header 'Content-Type'
1837
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1838
-
1839
- # form parameters
1840
- form_params = {}
1841
-
1842
- # http body (model)
1843
- post_body = nil
1844
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1845
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1846
- :header_params => header_params,
1847
- :query_params => query_params,
1848
- :form_params => form_params,
1849
- :body => post_body,
1850
- :auth_names => auth_names,
1851
- :return_type => 'ConversationPbxVoicemailMessageResponse')
1852
- if @api_client.config.debugging
1853
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_agent_voicemail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1854
- end
1855
- return data, status_code, headers
1856
- end
1857
- # Get Agent Voicemails
1858
- # Retrieve pbx agent Voicemails
1859
- # @param [Hash] opts the optional parameters
1860
- # @return [ConversationPbxVoicemailMessageSummariesResponse]
1861
- def get_pbx_agent_voicemails(opts = {})
1862
- data, _status_code, _headers = get_pbx_agent_voicemails_with_http_info(opts)
1863
- data
1864
- end
1865
-
1866
- # Get Agent Voicemails
1867
- # Retrieve pbx agent Voicemails
1868
- # @param [Hash] opts the optional parameters
1869
- # @return [Array<(ConversationPbxVoicemailMessageSummariesResponse, Fixnum, Hash)>] ConversationPbxVoicemailMessageSummariesResponse data, response status code and response headers
1870
- def get_pbx_agent_voicemails_with_http_info(opts = {})
1871
- if @api_client.config.debugging
1872
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_agent_voicemails ...'
1873
- end
1874
- # resource path
1875
- local_var_path = '/conversation/pbx/agent/voicemails'
1876
-
1877
- # query parameters
1878
- query_params = {}
1879
-
1880
- # header parameters
1881
- header_params = {}
1882
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1883
- # HTTP header 'Accept' (if needed)
1884
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1885
- # HTTP header 'Content-Type'
1886
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1887
-
1888
- # form parameters
1889
- form_params = {}
1890
-
1891
- # http body (model)
1892
- post_body = nil
1893
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1894
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1895
- :header_params => header_params,
1896
- :query_params => query_params,
1897
- :form_params => form_params,
1898
- :body => post_body,
1899
- :auth_names => auth_names,
1900
- :return_type => 'ConversationPbxVoicemailMessageSummariesResponse')
1901
- if @api_client.config.debugging
1902
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_agent_voicemails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1903
- end
1904
- return data, status_code, headers
1905
- end
1906
- # Get pbx agents
1907
- # Retrieve pbx agents
1908
- # @param [Hash] opts the optional parameters
1909
- # @return [ConversationPbxAgentsResponse]
1910
- def get_pbx_agents(opts = {})
1911
- data, _status_code, _headers = get_pbx_agents_with_http_info(opts)
1912
- data
1913
- end
1914
-
1915
- # Get pbx agents
1916
- # Retrieve pbx agents
1917
- # @param [Hash] opts the optional parameters
1918
- # @return [Array<(ConversationPbxAgentsResponse, Fixnum, Hash)>] ConversationPbxAgentsResponse data, response status code and response headers
1919
- def get_pbx_agents_with_http_info(opts = {})
1920
- if @api_client.config.debugging
1921
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_agents ...'
1922
- end
1923
- # resource path
1924
- local_var_path = '/conversation/pbx/agent'
1925
-
1926
- # query parameters
1927
- query_params = {}
1928
-
1929
- # header parameters
1930
- header_params = {}
1931
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1932
- # HTTP header 'Accept' (if needed)
1933
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1934
- # HTTP header 'Content-Type'
1935
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1936
-
1937
- # form parameters
1938
- form_params = {}
1939
-
1940
- # http body (model)
1941
- post_body = nil
1942
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1943
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1944
- :header_params => header_params,
1945
- :query_params => query_params,
1946
- :form_params => form_params,
1947
- :body => post_body,
1948
- :auth_names => auth_names,
1949
- :return_type => 'ConversationPbxAgentsResponse')
1950
- if @api_client.config.debugging
1951
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_agents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1952
- end
1953
- return data, status_code, headers
1954
- end
1955
- # Get pbx audio
1956
- # Retrieve a pbx audio
1957
- # @param conversation_pbx_audio_uuid
1958
- # @param [Hash] opts the optional parameters
1959
- # @return [ConversationPbxAudioResponse]
1960
- def get_pbx_audio(conversation_pbx_audio_uuid, opts = {})
1961
- data, _status_code, _headers = get_pbx_audio_with_http_info(conversation_pbx_audio_uuid, opts)
1962
- data
1963
- end
1964
-
1965
- # Get pbx audio
1966
- # Retrieve a pbx audio
1967
- # @param conversation_pbx_audio_uuid
1968
- # @param [Hash] opts the optional parameters
1969
- # @return [Array<(ConversationPbxAudioResponse, Fixnum, Hash)>] ConversationPbxAudioResponse data, response status code and response headers
1970
- def get_pbx_audio_with_http_info(conversation_pbx_audio_uuid, opts = {})
1971
- if @api_client.config.debugging
1972
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_audio ...'
1973
- end
1974
- # verify the required parameter 'conversation_pbx_audio_uuid' is set
1975
- if @api_client.config.client_side_validation && conversation_pbx_audio_uuid.nil?
1976
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_audio_uuid' when calling ConversationApi.get_pbx_audio"
1977
- end
1978
- # resource path
1979
- local_var_path = '/conversation/pbx/audio/{conversationPbxAudioUuid}'.sub('{' + 'conversationPbxAudioUuid' + '}', conversation_pbx_audio_uuid.to_s)
1980
-
1981
- # query parameters
1982
- query_params = {}
1983
-
1984
- # header parameters
1985
- header_params = {}
1986
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1987
- # HTTP header 'Accept' (if needed)
1988
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1989
- # HTTP header 'Content-Type'
1990
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1991
-
1992
- # form parameters
1993
- form_params = {}
1994
-
1995
- # http body (model)
1996
- post_body = nil
1997
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1998
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1999
- :header_params => header_params,
2000
- :query_params => query_params,
2001
- :form_params => form_params,
2002
- :body => post_body,
2003
- :auth_names => auth_names,
2004
- :return_type => 'ConversationPbxAudioResponse')
2005
- if @api_client.config.debugging
2006
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_audio\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2007
- end
2008
- return data, status_code, headers
2009
- end
2010
- # Get pbx audio usage
2011
- # Retrieve a pbx audio usage
2012
- # @param conversation_pbx_audio_uuid
2013
- # @param [Hash] opts the optional parameters
2014
- # @return [ConversationPbxAudioUsageResponse]
2015
- def get_pbx_audio_usage(conversation_pbx_audio_uuid, opts = {})
2016
- data, _status_code, _headers = get_pbx_audio_usage_with_http_info(conversation_pbx_audio_uuid, opts)
2017
- data
2018
- end
2019
-
2020
- # Get pbx audio usage
2021
- # Retrieve a pbx audio usage
2022
- # @param conversation_pbx_audio_uuid
2023
- # @param [Hash] opts the optional parameters
2024
- # @return [Array<(ConversationPbxAudioUsageResponse, Fixnum, Hash)>] ConversationPbxAudioUsageResponse data, response status code and response headers
2025
- def get_pbx_audio_usage_with_http_info(conversation_pbx_audio_uuid, opts = {})
2026
- if @api_client.config.debugging
2027
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_audio_usage ...'
2028
- end
2029
- # verify the required parameter 'conversation_pbx_audio_uuid' is set
2030
- if @api_client.config.client_side_validation && conversation_pbx_audio_uuid.nil?
2031
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_audio_uuid' when calling ConversationApi.get_pbx_audio_usage"
2032
- end
2033
- # resource path
2034
- local_var_path = '/conversation/pbx/audio/{conversationPbxAudioUuid}/usage'.sub('{' + 'conversationPbxAudioUuid' + '}', conversation_pbx_audio_uuid.to_s)
2035
-
2036
- # query parameters
2037
- query_params = {}
2038
-
2039
- # header parameters
2040
- header_params = {}
2041
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2042
- # HTTP header 'Accept' (if needed)
2043
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2044
- # HTTP header 'Content-Type'
2045
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2046
-
2047
- # form parameters
2048
- form_params = {}
2049
-
2050
- # http body (model)
2051
- post_body = nil
2052
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
2053
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2054
- :header_params => header_params,
2055
- :query_params => query_params,
2056
- :form_params => form_params,
2057
- :body => post_body,
2058
- :auth_names => auth_names,
2059
- :return_type => 'ConversationPbxAudioUsageResponse')
2060
- if @api_client.config.debugging
2061
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_audio_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2062
- end
2063
- return data, status_code, headers
2064
- end
2065
- # Get pbx audios
2066
- # Retrieve pbx audios
2067
- # @param [Hash] opts the optional parameters
2068
- # @return [ConversationPbxAudiosResponse]
2069
- def get_pbx_audios(opts = {})
2070
- data, _status_code, _headers = get_pbx_audios_with_http_info(opts)
2071
- data
2072
- end
2073
-
2074
- # Get pbx audios
2075
- # Retrieve pbx audios
2076
- # @param [Hash] opts the optional parameters
2077
- # @return [Array<(ConversationPbxAudiosResponse, Fixnum, Hash)>] ConversationPbxAudiosResponse data, response status code and response headers
2078
- def get_pbx_audios_with_http_info(opts = {})
2079
- if @api_client.config.debugging
2080
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_audios ...'
2081
- end
2082
- # resource path
2083
- local_var_path = '/conversation/pbx/audio'
2084
-
2085
- # query parameters
2086
- query_params = {}
2087
-
2088
- # header parameters
2089
- header_params = {}
2090
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2091
- # HTTP header 'Accept' (if needed)
2092
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2093
- # HTTP header 'Content-Type'
2094
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2095
-
2096
- # form parameters
2097
- form_params = {}
2098
-
2099
- # http body (model)
2100
- post_body = nil
2101
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
2102
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2103
- :header_params => header_params,
2104
- :query_params => query_params,
2105
- :form_params => form_params,
2106
- :body => post_body,
2107
- :auth_names => auth_names,
2108
- :return_type => 'ConversationPbxAudiosResponse')
2109
- if @api_client.config.debugging
2110
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_audios\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2111
- end
2112
- return data, status_code, headers
2113
- end
2114
- # Get pbx menu
2115
- # Retrieve a pbx menu
2116
- # @param conversation_pbx_menu_uuid
2117
- # @param [Hash] opts the optional parameters
2118
- # @return [ConversationPbxMenuResponse]
2119
- def get_pbx_menu(conversation_pbx_menu_uuid, opts = {})
2120
- data, _status_code, _headers = get_pbx_menu_with_http_info(conversation_pbx_menu_uuid, opts)
2121
- data
2122
- end
2123
-
2124
- # Get pbx menu
2125
- # Retrieve a pbx menu
2126
- # @param conversation_pbx_menu_uuid
2127
- # @param [Hash] opts the optional parameters
2128
- # @return [Array<(ConversationPbxMenuResponse, Fixnum, Hash)>] ConversationPbxMenuResponse data, response status code and response headers
2129
- def get_pbx_menu_with_http_info(conversation_pbx_menu_uuid, opts = {})
2130
- if @api_client.config.debugging
2131
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_menu ...'
2132
- end
2133
- # verify the required parameter 'conversation_pbx_menu_uuid' is set
2134
- if @api_client.config.client_side_validation && conversation_pbx_menu_uuid.nil?
2135
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_menu_uuid' when calling ConversationApi.get_pbx_menu"
2136
- end
2137
- # resource path
2138
- local_var_path = '/conversation/pbx/menu/{conversationPbxMenuUuid}'.sub('{' + 'conversationPbxMenuUuid' + '}', conversation_pbx_menu_uuid.to_s)
2139
-
2140
- # query parameters
2141
- query_params = {}
2142
-
2143
- # header parameters
2144
- header_params = {}
2145
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2146
- # HTTP header 'Accept' (if needed)
2147
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2148
- # HTTP header 'Content-Type'
2149
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2150
-
2151
- # form parameters
2152
- form_params = {}
2153
-
2154
- # http body (model)
2155
- post_body = nil
2156
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
2157
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2158
- :header_params => header_params,
2159
- :query_params => query_params,
2160
- :form_params => form_params,
2161
- :body => post_body,
2162
- :auth_names => auth_names,
2163
- :return_type => 'ConversationPbxMenuResponse')
2164
- if @api_client.config.debugging
2165
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_menu\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2166
- end
2167
- return data, status_code, headers
2168
- end
2169
- # Get pbx menus
2170
- # Retrieve pbx menus
2171
- # @param [Hash] opts the optional parameters
2172
- # @return [ConversationPbxMenusResponse]
2173
- def get_pbx_menus(opts = {})
2174
- data, _status_code, _headers = get_pbx_menus_with_http_info(opts)
2175
- data
2176
- end
2177
-
2178
- # Get pbx menus
2179
- # Retrieve pbx menus
2180
- # @param [Hash] opts the optional parameters
2181
- # @return [Array<(ConversationPbxMenusResponse, Fixnum, Hash)>] ConversationPbxMenusResponse data, response status code and response headers
2182
- def get_pbx_menus_with_http_info(opts = {})
2183
- if @api_client.config.debugging
2184
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_menus ...'
2185
- end
2186
- # resource path
2187
- local_var_path = '/conversation/pbx/menu'
2188
-
2189
- # query parameters
2190
- query_params = {}
2191
-
2192
- # header parameters
2193
- header_params = {}
2194
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2195
- # HTTP header 'Accept' (if needed)
2196
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2197
- # HTTP header 'Content-Type'
2198
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2199
-
2200
- # form parameters
2201
- form_params = {}
2202
-
2203
- # http body (model)
2204
- post_body = nil
2205
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
2206
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2207
- :header_params => header_params,
2208
- :query_params => query_params,
2209
- :form_params => form_params,
2210
- :body => post_body,
2211
- :auth_names => auth_names,
2212
- :return_type => 'ConversationPbxMenusResponse')
2213
- if @api_client.config.debugging
2214
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_menus\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2215
- end
2216
- return data, status_code, headers
2217
- end
2218
- # Get pbx phoneNumber
2219
- # Retrieve a pbx phoneNumber
2220
- # @param conversation_pbx_phone_number_uuid
2221
- # @param [Hash] opts the optional parameters
2222
- # @return [ConversationPbxPhoneNumberResponse]
2223
- def get_pbx_phone_number(conversation_pbx_phone_number_uuid, opts = {})
2224
- data, _status_code, _headers = get_pbx_phone_number_with_http_info(conversation_pbx_phone_number_uuid, opts)
2225
- data
2226
- end
2227
-
2228
- # Get pbx phoneNumber
2229
- # Retrieve a pbx phoneNumber
2230
- # @param conversation_pbx_phone_number_uuid
2231
- # @param [Hash] opts the optional parameters
2232
- # @return [Array<(ConversationPbxPhoneNumberResponse, Fixnum, Hash)>] ConversationPbxPhoneNumberResponse data, response status code and response headers
2233
- def get_pbx_phone_number_with_http_info(conversation_pbx_phone_number_uuid, opts = {})
2234
- if @api_client.config.debugging
2235
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_phone_number ...'
2236
- end
2237
- # verify the required parameter 'conversation_pbx_phone_number_uuid' is set
2238
- if @api_client.config.client_side_validation && conversation_pbx_phone_number_uuid.nil?
2239
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_phone_number_uuid' when calling ConversationApi.get_pbx_phone_number"
2240
- end
2241
- # resource path
2242
- local_var_path = '/conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid}'.sub('{' + 'conversationPbxPhoneNumberUuid' + '}', conversation_pbx_phone_number_uuid.to_s)
2243
-
2244
- # query parameters
2245
- query_params = {}
2246
-
2247
- # header parameters
2248
- header_params = {}
2249
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2250
- # HTTP header 'Accept' (if needed)
2251
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2252
- # HTTP header 'Content-Type'
2253
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2254
-
2255
- # form parameters
2256
- form_params = {}
2257
-
2258
- # http body (model)
2259
- post_body = nil
2260
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
2261
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2262
- :header_params => header_params,
2263
- :query_params => query_params,
2264
- :form_params => form_params,
2265
- :body => post_body,
2266
- :auth_names => auth_names,
2267
- :return_type => 'ConversationPbxPhoneNumberResponse')
2268
- if @api_client.config.debugging
2269
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_phone_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2270
- end
2271
- return data, status_code, headers
2272
- end
2273
- # Get pbx phoneNumbers
2274
- # Retrieve pbx phoneNumbers
2275
- # @param [Hash] opts the optional parameters
2276
- # @return [ConversationPbxPhoneNumbersResponse]
2277
- def get_pbx_phone_numbers(opts = {})
2278
- data, _status_code, _headers = get_pbx_phone_numbers_with_http_info(opts)
2279
- data
2280
- end
2281
-
2282
- # Get pbx phoneNumbers
2283
- # Retrieve pbx phoneNumbers
2284
- # @param [Hash] opts the optional parameters
2285
- # @return [Array<(ConversationPbxPhoneNumbersResponse, Fixnum, Hash)>] ConversationPbxPhoneNumbersResponse data, response status code and response headers
2286
- def get_pbx_phone_numbers_with_http_info(opts = {})
2287
- if @api_client.config.debugging
2288
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_phone_numbers ...'
2289
- end
2290
- # resource path
2291
- local_var_path = '/conversation/pbx/phone_number'
2292
-
2293
- # query parameters
2294
- query_params = {}
2295
-
2296
- # header parameters
2297
- header_params = {}
2298
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2299
- # HTTP header 'Accept' (if needed)
2300
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2301
- # HTTP header 'Content-Type'
2302
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2303
-
2304
- # form parameters
2305
- form_params = {}
2306
-
2307
- # http body (model)
2308
- post_body = nil
2309
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
2310
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2311
- :header_params => header_params,
2312
- :query_params => query_params,
2313
- :form_params => form_params,
2314
- :body => post_body,
2315
- :auth_names => auth_names,
2316
- :return_type => 'ConversationPbxPhoneNumbersResponse')
2317
- if @api_client.config.debugging
2318
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_phone_numbers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2319
- end
2320
- return data, status_code, headers
2321
- end
2322
- # Get pbx queue
2323
- # Retrieve a pbx queue
2324
- # @param conversation_pbx_queue_uuid
2325
- # @param [Hash] opts the optional parameters
2326
- # @return [ConversationPbxQueueResponse]
2327
- def get_pbx_queue(conversation_pbx_queue_uuid, opts = {})
2328
- data, _status_code, _headers = get_pbx_queue_with_http_info(conversation_pbx_queue_uuid, opts)
2329
- data
2330
- end
2331
-
2332
- # Get pbx queue
2333
- # Retrieve a pbx queue
2334
- # @param conversation_pbx_queue_uuid
2335
- # @param [Hash] opts the optional parameters
2336
- # @return [Array<(ConversationPbxQueueResponse, Fixnum, Hash)>] ConversationPbxQueueResponse data, response status code and response headers
2337
- def get_pbx_queue_with_http_info(conversation_pbx_queue_uuid, opts = {})
2338
- if @api_client.config.debugging
2339
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_queue ...'
2340
- end
2341
- # verify the required parameter 'conversation_pbx_queue_uuid' is set
2342
- if @api_client.config.client_side_validation && conversation_pbx_queue_uuid.nil?
2343
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_queue_uuid' when calling ConversationApi.get_pbx_queue"
2344
- end
2345
- # resource path
2346
- local_var_path = '/conversation/pbx/queue/{conversationPbxQueueUuid}'.sub('{' + 'conversationPbxQueueUuid' + '}', conversation_pbx_queue_uuid.to_s)
2347
-
2348
- # query parameters
2349
- query_params = {}
2350
-
2351
- # header parameters
2352
- header_params = {}
2353
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2354
- # HTTP header 'Accept' (if needed)
2355
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2356
- # HTTP header 'Content-Type'
2357
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2358
-
2359
- # form parameters
2360
- form_params = {}
2361
-
2362
- # http body (model)
2363
- post_body = nil
2364
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
2365
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2366
- :header_params => header_params,
2367
- :query_params => query_params,
2368
- :form_params => form_params,
2369
- :body => post_body,
2370
- :auth_names => auth_names,
2371
- :return_type => 'ConversationPbxQueueResponse')
2372
- if @api_client.config.debugging
2373
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2374
- end
2375
- return data, status_code, headers
2376
- end
2377
- # Get Queue Voicemail
2378
- # Retrieve pbx queue Voicemail
2379
- # @param queue_uuid
2380
- # @param recording_sid
2381
- # @param [Hash] opts the optional parameters
2382
- # @return [ConversationPbxVoicemailMessageResponse]
2383
- def get_pbx_queue_voicemail(queue_uuid, recording_sid, opts = {})
2384
- data, _status_code, _headers = get_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid, opts)
2385
- data
2386
- end
2387
-
2388
- # Get Queue Voicemail
2389
- # Retrieve pbx queue Voicemail
2390
- # @param queue_uuid
2391
- # @param recording_sid
2392
- # @param [Hash] opts the optional parameters
2393
- # @return [Array<(ConversationPbxVoicemailMessageResponse, Fixnum, Hash)>] ConversationPbxVoicemailMessageResponse data, response status code and response headers
2394
- def get_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid, opts = {})
2395
- if @api_client.config.debugging
2396
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_queue_voicemail ...'
2397
- end
2398
- # verify the required parameter 'queue_uuid' is set
2399
- if @api_client.config.client_side_validation && queue_uuid.nil?
2400
- fail ArgumentError, "Missing the required parameter 'queue_uuid' when calling ConversationApi.get_pbx_queue_voicemail"
2401
- end
2402
- # verify the required parameter 'recording_sid' is set
2403
- if @api_client.config.client_side_validation && recording_sid.nil?
2404
- fail ArgumentError, "Missing the required parameter 'recording_sid' when calling ConversationApi.get_pbx_queue_voicemail"
2405
- end
2406
- # resource path
2407
- local_var_path = '/conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid}'.sub('{' + 'queue_uuid' + '}', queue_uuid.to_s).sub('{' + 'recording_sid' + '}', recording_sid.to_s)
2408
-
2409
- # query parameters
2410
- query_params = {}
2411
-
2412
- # header parameters
2413
- header_params = {}
2414
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2415
- # HTTP header 'Accept' (if needed)
2416
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2417
- # HTTP header 'Content-Type'
2418
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2419
-
2420
- # form parameters
2421
- form_params = {}
2422
-
2423
- # http body (model)
2424
- post_body = nil
2425
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
2426
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2427
- :header_params => header_params,
2428
- :query_params => query_params,
2429
- :form_params => form_params,
2430
- :body => post_body,
2431
- :auth_names => auth_names,
2432
- :return_type => 'ConversationPbxVoicemailMessageResponse')
2433
- if @api_client.config.debugging
2434
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_queue_voicemail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2435
- end
2436
- return data, status_code, headers
2437
- end
2438
- # Get Queue Voicemails
2439
- # Retrieve pbx queue voicemails
2440
- # @param queue_uuid
2441
- # @param [Hash] opts the optional parameters
2442
- # @return [ConversationPbxVoicemailMessageSummariesResponse]
2443
- def get_pbx_queue_voicemails(queue_uuid, opts = {})
2444
- data, _status_code, _headers = get_pbx_queue_voicemails_with_http_info(queue_uuid, opts)
2445
- data
2446
- end
2447
-
2448
- # Get Queue Voicemails
2449
- # Retrieve pbx queue voicemails
2450
- # @param queue_uuid
2451
- # @param [Hash] opts the optional parameters
2452
- # @return [Array<(ConversationPbxVoicemailMessageSummariesResponse, Fixnum, Hash)>] ConversationPbxVoicemailMessageSummariesResponse data, response status code and response headers
2453
- def get_pbx_queue_voicemails_with_http_info(queue_uuid, opts = {})
2454
- if @api_client.config.debugging
2455
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_queue_voicemails ...'
2456
- end
2457
- # verify the required parameter 'queue_uuid' is set
2458
- if @api_client.config.client_side_validation && queue_uuid.nil?
2459
- fail ArgumentError, "Missing the required parameter 'queue_uuid' when calling ConversationApi.get_pbx_queue_voicemails"
2460
- end
2461
- # resource path
2462
- local_var_path = '/conversation/pbx/queues/{queue_uuid}/voicemails'.sub('{' + 'queue_uuid' + '}', queue_uuid.to_s)
2463
-
2464
- # query parameters
2465
- query_params = {}
2466
-
2467
- # header parameters
2468
- header_params = {}
2469
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2470
- # HTTP header 'Accept' (if needed)
2471
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2472
- # HTTP header 'Content-Type'
2473
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2474
-
2475
- # form parameters
2476
- form_params = {}
2477
-
2478
- # http body (model)
2479
- post_body = nil
2480
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
2481
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2482
- :header_params => header_params,
2483
- :query_params => query_params,
2484
- :form_params => form_params,
2485
- :body => post_body,
2486
- :auth_names => auth_names,
2487
- :return_type => 'ConversationPbxVoicemailMessageSummariesResponse')
2488
- if @api_client.config.debugging
2489
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_queue_voicemails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2490
- end
2491
- return data, status_code, headers
2492
- end
2493
- # Get pbx queues
2494
- # Retrieve pbx queues
2495
- # @param [Hash] opts the optional parameters
2496
- # @return [ConversationPbxQueuesResponse]
2497
- def get_pbx_queues(opts = {})
2498
- data, _status_code, _headers = get_pbx_queues_with_http_info(opts)
2499
- data
2500
- end
2501
-
2502
- # Get pbx queues
2503
- # Retrieve pbx queues
2504
- # @param [Hash] opts the optional parameters
2505
- # @return [Array<(ConversationPbxQueuesResponse, Fixnum, Hash)>] ConversationPbxQueuesResponse data, response status code and response headers
2506
- def get_pbx_queues_with_http_info(opts = {})
2507
- if @api_client.config.debugging
2508
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_queues ...'
2509
- end
2510
- # resource path
2511
- local_var_path = '/conversation/pbx/queue'
2512
-
2513
- # query parameters
2514
- query_params = {}
2515
-
2516
- # header parameters
2517
- header_params = {}
2518
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2519
- # HTTP header 'Accept' (if needed)
2520
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2521
- # HTTP header 'Content-Type'
2522
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2523
-
2524
- # form parameters
2525
- form_params = {}
2526
-
2527
- # http body (model)
2528
- post_body = nil
2529
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
2530
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2531
- :header_params => header_params,
2532
- :query_params => query_params,
2533
- :form_params => form_params,
2534
- :body => post_body,
2535
- :auth_names => auth_names,
2536
- :return_type => 'ConversationPbxQueuesResponse')
2537
- if @api_client.config.debugging
2538
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_queues\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2539
- end
2540
- return data, status_code, headers
2541
- end
2542
- # Get pbx timeBased
2543
- # Retrieve a pbx timeBased
2544
- # @param conversation_pbx_time_based_uuid
2545
- # @param [Hash] opts the optional parameters
2546
- # @return [ConversationPbxTimeBasedResponse]
2547
- def get_pbx_time_based(conversation_pbx_time_based_uuid, opts = {})
2548
- data, _status_code, _headers = get_pbx_time_based_with_http_info(conversation_pbx_time_based_uuid, opts)
2549
- data
2550
- end
2551
-
2552
- # Get pbx timeBased
2553
- # Retrieve a pbx timeBased
2554
- # @param conversation_pbx_time_based_uuid
2555
- # @param [Hash] opts the optional parameters
2556
- # @return [Array<(ConversationPbxTimeBasedResponse, Fixnum, Hash)>] ConversationPbxTimeBasedResponse data, response status code and response headers
2557
- def get_pbx_time_based_with_http_info(conversation_pbx_time_based_uuid, opts = {})
2558
- if @api_client.config.debugging
2559
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_time_based ...'
2560
- end
2561
- # verify the required parameter 'conversation_pbx_time_based_uuid' is set
2562
- if @api_client.config.client_side_validation && conversation_pbx_time_based_uuid.nil?
2563
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_time_based_uuid' when calling ConversationApi.get_pbx_time_based"
2564
- end
2565
- # resource path
2566
- local_var_path = '/conversation/pbx/time_based/{conversationPbxTimeBasedUuid}'.sub('{' + 'conversationPbxTimeBasedUuid' + '}', conversation_pbx_time_based_uuid.to_s)
2567
-
2568
- # query parameters
2569
- query_params = {}
2570
-
2571
- # header parameters
2572
- header_params = {}
2573
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2574
- # HTTP header 'Accept' (if needed)
2575
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2576
- # HTTP header 'Content-Type'
2577
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2578
-
2579
- # form parameters
2580
- form_params = {}
2581
-
2582
- # http body (model)
2583
- post_body = nil
2584
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
2585
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2586
- :header_params => header_params,
2587
- :query_params => query_params,
2588
- :form_params => form_params,
2589
- :body => post_body,
2590
- :auth_names => auth_names,
2591
- :return_type => 'ConversationPbxTimeBasedResponse')
2592
- if @api_client.config.debugging
2593
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_time_based\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2594
- end
2595
- return data, status_code, headers
2596
- end
2597
- # Get pbx timeBaseds
2598
- # Retrieve pbx timeBaseds
2599
- # @param [Hash] opts the optional parameters
2600
- # @return [ConversationPbxTimeBasedsResponse]
2601
- def get_pbx_time_baseds(opts = {})
2602
- data, _status_code, _headers = get_pbx_time_baseds_with_http_info(opts)
2603
- data
2604
- end
2605
-
2606
- # Get pbx timeBaseds
2607
- # Retrieve pbx timeBaseds
2608
- # @param [Hash] opts the optional parameters
2609
- # @return [Array<(ConversationPbxTimeBasedsResponse, Fixnum, Hash)>] ConversationPbxTimeBasedsResponse data, response status code and response headers
2610
- def get_pbx_time_baseds_with_http_info(opts = {})
2611
- if @api_client.config.debugging
2612
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_time_baseds ...'
2613
- end
2614
- # resource path
2615
- local_var_path = '/conversation/pbx/time_based'
2616
-
2617
- # query parameters
2618
- query_params = {}
2619
-
2620
- # header parameters
2621
- header_params = {}
2622
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2623
- # HTTP header 'Accept' (if needed)
2624
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2625
- # HTTP header 'Content-Type'
2626
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2627
-
2628
- # form parameters
2629
- form_params = {}
2630
-
2631
- # http body (model)
2632
- post_body = nil
2633
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
2634
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2635
- :header_params => header_params,
2636
- :query_params => query_params,
2637
- :form_params => form_params,
2638
- :body => post_body,
2639
- :auth_names => auth_names,
2640
- :return_type => 'ConversationPbxTimeBasedsResponse')
2641
- if @api_client.config.debugging
2642
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_time_baseds\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2643
- end
2644
- return data, status_code, headers
2645
- end
2646
- # Get pbx timeRange
2647
- # Retrieve a pbx timeRange
2648
- # @param conversation_pbx_time_range_uuid
2649
- # @param [Hash] opts the optional parameters
2650
- # @return [ConversationPbxTimeRangeResponse]
2651
- def get_pbx_time_range(conversation_pbx_time_range_uuid, opts = {})
2652
- data, _status_code, _headers = get_pbx_time_range_with_http_info(conversation_pbx_time_range_uuid, opts)
2653
- data
2654
- end
2655
-
2656
- # Get pbx timeRange
2657
- # Retrieve a pbx timeRange
2658
- # @param conversation_pbx_time_range_uuid
2659
- # @param [Hash] opts the optional parameters
2660
- # @return [Array<(ConversationPbxTimeRangeResponse, Fixnum, Hash)>] ConversationPbxTimeRangeResponse data, response status code and response headers
2661
- def get_pbx_time_range_with_http_info(conversation_pbx_time_range_uuid, opts = {})
2662
- if @api_client.config.debugging
2663
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_time_range ...'
2664
- end
2665
- # verify the required parameter 'conversation_pbx_time_range_uuid' is set
2666
- if @api_client.config.client_side_validation && conversation_pbx_time_range_uuid.nil?
2667
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_time_range_uuid' when calling ConversationApi.get_pbx_time_range"
2668
- end
2669
- # resource path
2670
- local_var_path = '/conversation/pbx/time_range/{conversationPbxTimeRangeUuid}'.sub('{' + 'conversationPbxTimeRangeUuid' + '}', conversation_pbx_time_range_uuid.to_s)
2671
-
2672
- # query parameters
2673
- query_params = {}
2674
-
2675
- # header parameters
2676
- header_params = {}
2677
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2678
- # HTTP header 'Accept' (if needed)
2679
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2680
- # HTTP header 'Content-Type'
2681
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2682
-
2683
- # form parameters
2684
- form_params = {}
2685
-
2686
- # http body (model)
2687
- post_body = nil
2688
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
2689
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2690
- :header_params => header_params,
2691
- :query_params => query_params,
2692
- :form_params => form_params,
2693
- :body => post_body,
2694
- :auth_names => auth_names,
2695
- :return_type => 'ConversationPbxTimeRangeResponse')
2696
- if @api_client.config.debugging
2697
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_time_range\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2698
- end
2699
- return data, status_code, headers
2700
- end
2701
- # Get pbx timeRanges
2702
- # Retrieve pbx timeRanges
2703
- # @param [Hash] opts the optional parameters
2704
- # @return [ConversationPbxTimeRangesResponse]
2705
- def get_pbx_time_ranges(opts = {})
2706
- data, _status_code, _headers = get_pbx_time_ranges_with_http_info(opts)
2707
- data
2708
- end
2709
-
2710
- # Get pbx timeRanges
2711
- # Retrieve pbx timeRanges
2712
- # @param [Hash] opts the optional parameters
2713
- # @return [Array<(ConversationPbxTimeRangesResponse, Fixnum, Hash)>] ConversationPbxTimeRangesResponse data, response status code and response headers
2714
- def get_pbx_time_ranges_with_http_info(opts = {})
2715
- if @api_client.config.debugging
2716
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_time_ranges ...'
2717
- end
2718
- # resource path
2719
- local_var_path = '/conversation/pbx/time_range'
2720
-
2721
- # query parameters
2722
- query_params = {}
2723
-
2724
- # header parameters
2725
- header_params = {}
2726
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2727
- # HTTP header 'Accept' (if needed)
2728
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2729
- # HTTP header 'Content-Type'
2730
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2731
-
2732
- # form parameters
2733
- form_params = {}
2734
-
2735
- # http body (model)
2736
- post_body = nil
2737
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
2738
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2739
- :header_params => header_params,
2740
- :query_params => query_params,
2741
- :form_params => form_params,
2742
- :body => post_body,
2743
- :auth_names => auth_names,
2744
- :return_type => 'ConversationPbxTimeRangesResponse')
2745
- if @api_client.config.debugging
2746
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_time_ranges\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2747
- end
2748
- return data, status_code, headers
2749
- end
2750
- # Get pbx voicemailMailbox
2751
- # Retrieve a pbx voicemailMailbox
2752
- # @param conversation_pbx_voicemail_mailbox_uuid
2753
- # @param [Hash] opts the optional parameters
2754
- # @return [ConversationPbxVoicemailMailboxResponse]
2755
- def get_pbx_voicemail_mailbox(conversation_pbx_voicemail_mailbox_uuid, opts = {})
2756
- data, _status_code, _headers = get_pbx_voicemail_mailbox_with_http_info(conversation_pbx_voicemail_mailbox_uuid, opts)
2757
- data
2758
- end
2759
-
2760
- # Get pbx voicemailMailbox
2761
- # Retrieve a pbx voicemailMailbox
2762
- # @param conversation_pbx_voicemail_mailbox_uuid
2763
- # @param [Hash] opts the optional parameters
2764
- # @return [Array<(ConversationPbxVoicemailMailboxResponse, Fixnum, Hash)>] ConversationPbxVoicemailMailboxResponse data, response status code and response headers
2765
- def get_pbx_voicemail_mailbox_with_http_info(conversation_pbx_voicemail_mailbox_uuid, opts = {})
2766
- if @api_client.config.debugging
2767
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_voicemail_mailbox ...'
2768
- end
2769
- # verify the required parameter 'conversation_pbx_voicemail_mailbox_uuid' is set
2770
- if @api_client.config.client_side_validation && conversation_pbx_voicemail_mailbox_uuid.nil?
2771
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_voicemail_mailbox_uuid' when calling ConversationApi.get_pbx_voicemail_mailbox"
2772
- end
2773
- # resource path
2774
- local_var_path = '/conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid}'.sub('{' + 'conversationPbxVoicemailMailboxUuid' + '}', conversation_pbx_voicemail_mailbox_uuid.to_s)
2775
-
2776
- # query parameters
2777
- query_params = {}
2778
-
2779
- # header parameters
2780
- header_params = {}
2781
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2782
- # HTTP header 'Accept' (if needed)
2783
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2784
- # HTTP header 'Content-Type'
2785
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2786
-
2787
- # form parameters
2788
- form_params = {}
2789
-
2790
- # http body (model)
2791
- post_body = nil
2792
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
2793
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2794
- :header_params => header_params,
2795
- :query_params => query_params,
2796
- :form_params => form_params,
2797
- :body => post_body,
2798
- :auth_names => auth_names,
2799
- :return_type => 'ConversationPbxVoicemailMailboxResponse')
2800
- if @api_client.config.debugging
2801
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_voicemail_mailbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2802
- end
2803
- return data, status_code, headers
2804
- end
2805
- # Get pbx voicemailMailboxes
2806
- # Retrieve pbx voicemailMailboxes
2807
- # @param [Hash] opts the optional parameters
2808
- # @return [ConversationPbxVoicemailMailboxesResponse]
2809
- def get_pbx_voicemail_mailboxes(opts = {})
2810
- data, _status_code, _headers = get_pbx_voicemail_mailboxes_with_http_info(opts)
2811
- data
2812
- end
2813
-
2814
- # Get pbx voicemailMailboxes
2815
- # Retrieve pbx voicemailMailboxes
2816
- # @param [Hash] opts the optional parameters
2817
- # @return [Array<(ConversationPbxVoicemailMailboxesResponse, Fixnum, Hash)>] ConversationPbxVoicemailMailboxesResponse data, response status code and response headers
2818
- def get_pbx_voicemail_mailboxes_with_http_info(opts = {})
2819
- if @api_client.config.debugging
2820
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_voicemail_mailboxes ...'
2821
- end
2822
- # resource path
2823
- local_var_path = '/conversation/pbx/voicemail_mailbox'
2824
-
2825
- # query parameters
2826
- query_params = {}
2827
-
2828
- # header parameters
2829
- header_params = {}
2830
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2831
- # HTTP header 'Accept' (if needed)
2832
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2833
- # HTTP header 'Content-Type'
2834
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2835
-
2836
- # form parameters
2837
- form_params = {}
2838
-
2839
- # http body (model)
2840
- post_body = nil
2841
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
2842
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2843
- :header_params => header_params,
2844
- :query_params => query_params,
2845
- :form_params => form_params,
2846
- :body => post_body,
2847
- :auth_names => auth_names,
2848
- :return_type => 'ConversationPbxVoicemailMailboxesResponse')
2849
- if @api_client.config.debugging
2850
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_voicemail_mailboxes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2851
- end
2852
- return data, status_code, headers
2853
- end
2854
- # Get virtual agent budget
2855
- # Retrieve virtual agent budget
2856
- # @param [Hash] opts the optional parameters
2857
- # @return [ConversationVirtualAgentBudgetResponse]
2858
- def get_virtual_agent_budget(opts = {})
2859
- data, _status_code, _headers = get_virtual_agent_budget_with_http_info(opts)
2860
- data
2861
- end
2862
-
2863
- # Get virtual agent budget
2864
- # Retrieve virtual agent budget
2865
- # @param [Hash] opts the optional parameters
2866
- # @return [Array<(ConversationVirtualAgentBudgetResponse, Fixnum, Hash)>] ConversationVirtualAgentBudgetResponse data, response status code and response headers
2867
- def get_virtual_agent_budget_with_http_info(opts = {})
2868
- if @api_client.config.debugging
2869
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_virtual_agent_budget ...'
2870
- end
2871
- # resource path
2872
- local_var_path = '/conversation/virtualagent/budget'
2873
-
2874
- # query parameters
2875
- query_params = {}
2876
-
2877
- # header parameters
2878
- header_params = {}
2879
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2880
- # HTTP header 'Accept' (if needed)
2881
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2882
- # HTTP header 'Content-Type'
2883
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2884
-
2885
- # form parameters
2886
- form_params = {}
2887
-
2888
- # http body (model)
2889
- post_body = nil
2890
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
2891
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2892
- :header_params => header_params,
2893
- :query_params => query_params,
2894
- :form_params => form_params,
2895
- :body => post_body,
2896
- :auth_names => auth_names,
2897
- :return_type => 'ConversationVirtualAgentBudgetResponse')
2898
- if @api_client.config.debugging
2899
- @api_client.config.logger.debug "API called: ConversationApi#get_virtual_agent_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2900
- end
2901
- return data, status_code, headers
2902
- end
2903
- # Get virtual agent capabilities
2904
- # Retrieve virtual agent capabilities
2905
- # @param [Hash] opts the optional parameters
2906
- # @return [ConversationVirtualAgentCapabilitiesResponse]
2907
- def get_virtual_agent_capabilities(opts = {})
2908
- data, _status_code, _headers = get_virtual_agent_capabilities_with_http_info(opts)
2909
- data
2910
- end
2911
-
2912
- # Get virtual agent capabilities
2913
- # Retrieve virtual agent capabilities
2914
- # @param [Hash] opts the optional parameters
2915
- # @return [Array<(ConversationVirtualAgentCapabilitiesResponse, Fixnum, Hash)>] ConversationVirtualAgentCapabilitiesResponse data, response status code and response headers
2916
- def get_virtual_agent_capabilities_with_http_info(opts = {})
2917
- if @api_client.config.debugging
2918
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_virtual_agent_capabilities ...'
2919
- end
2920
- # resource path
2921
- local_var_path = '/conversation/virtualagent/capabilities'
2922
-
2923
- # query parameters
2924
- query_params = {}
2925
-
2926
- # header parameters
2927
- header_params = {}
2928
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2929
- # HTTP header 'Accept' (if needed)
2930
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2931
- # HTTP header 'Content-Type'
2932
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2933
-
2934
- # form parameters
2935
- form_params = {}
2936
-
2937
- # http body (model)
2938
- post_body = nil
2939
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
2940
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2941
- :header_params => header_params,
2942
- :query_params => query_params,
2943
- :form_params => form_params,
2944
- :body => post_body,
2945
- :auth_names => auth_names,
2946
- :return_type => 'ConversationVirtualAgentCapabilitiesResponse')
2947
- if @api_client.config.debugging
2948
- @api_client.config.logger.debug "API called: ConversationApi#get_virtual_agent_capabilities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2949
- end
2950
- return data, status_code, headers
2951
- end
2952
- # Insert a canned message
2953
- # Insert a canned message
2954
- # @param canned_message Canned message
2955
- # @param [Hash] opts the optional parameters
2956
- # @return [ConversationCannedMessageResponse]
2957
- def insert_conversation_canned_message(canned_message, opts = {})
2958
- data, _status_code, _headers = insert_conversation_canned_message_with_http_info(canned_message, opts)
2959
- data
2960
- end
2961
-
2962
- # Insert a canned message
2963
- # Insert a canned message
2964
- # @param canned_message Canned message
2965
- # @param [Hash] opts the optional parameters
2966
- # @return [Array<(ConversationCannedMessageResponse, Fixnum, Hash)>] ConversationCannedMessageResponse data, response status code and response headers
2967
- def insert_conversation_canned_message_with_http_info(canned_message, opts = {})
2968
- if @api_client.config.debugging
2969
- @api_client.config.logger.debug 'Calling API: ConversationApi.insert_conversation_canned_message ...'
2970
- end
2971
- # verify the required parameter 'canned_message' is set
2972
- if @api_client.config.client_side_validation && canned_message.nil?
2973
- fail ArgumentError, "Missing the required parameter 'canned_message' when calling ConversationApi.insert_conversation_canned_message"
2974
- end
2975
- # resource path
2976
- local_var_path = '/conversation/canned_messages'
2977
-
2978
- # query parameters
2979
- query_params = {}
2980
-
2981
- # header parameters
2982
- header_params = {}
2983
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2984
- # HTTP header 'Accept' (if needed)
2985
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2986
- # HTTP header 'Content-Type'
2987
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2988
-
2989
- # form parameters
2990
- form_params = {}
2991
-
2992
- # http body (model)
2993
- post_body = @api_client.object_to_http_body(canned_message)
2994
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
2995
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2996
- :header_params => header_params,
2997
- :query_params => query_params,
2998
- :form_params => form_params,
2999
- :body => post_body,
3000
- :auth_names => auth_names,
3001
- :return_type => 'ConversationCannedMessageResponse')
3002
- if @api_client.config.debugging
3003
- @api_client.config.logger.debug "API called: ConversationApi#insert_conversation_canned_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3004
- end
3005
- return data, status_code, headers
3006
- end
3007
- # Insert a department
3008
- # Insert a department
3009
- # @param department Department
3010
- # @param [Hash] opts the optional parameters
3011
- # @return [ConversationDepartmentResponse]
3012
- def insert_conversation_department(department, opts = {})
3013
- data, _status_code, _headers = insert_conversation_department_with_http_info(department, opts)
3014
- data
3015
- end
3016
-
3017
- # Insert a department
3018
- # Insert a department
3019
- # @param department Department
3020
- # @param [Hash] opts the optional parameters
3021
- # @return [Array<(ConversationDepartmentResponse, Fixnum, Hash)>] ConversationDepartmentResponse data, response status code and response headers
3022
- def insert_conversation_department_with_http_info(department, opts = {})
3023
- if @api_client.config.debugging
3024
- @api_client.config.logger.debug 'Calling API: ConversationApi.insert_conversation_department ...'
3025
- end
3026
- # verify the required parameter 'department' is set
3027
- if @api_client.config.client_side_validation && department.nil?
3028
- fail ArgumentError, "Missing the required parameter 'department' when calling ConversationApi.insert_conversation_department"
3029
- end
3030
- # resource path
3031
- local_var_path = '/conversation/departments'
3032
-
3033
- # query parameters
3034
- query_params = {}
3035
-
3036
- # header parameters
3037
- header_params = {}
3038
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3039
- # HTTP header 'Accept' (if needed)
3040
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3041
- # HTTP header 'Content-Type'
3042
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3043
-
3044
- # form parameters
3045
- form_params = {}
3046
-
3047
- # http body (model)
3048
- post_body = @api_client.object_to_http_body(department)
3049
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3050
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
3051
- :header_params => header_params,
3052
- :query_params => query_params,
3053
- :form_params => form_params,
3054
- :body => post_body,
3055
- :auth_names => auth_names,
3056
- :return_type => 'ConversationDepartmentResponse')
3057
- if @api_client.config.debugging
3058
- @api_client.config.logger.debug "API called: ConversationApi#insert_conversation_department\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3059
- end
3060
- return data, status_code, headers
3061
- end
3062
- # Insert a engagement
3063
- # Insert a engagement
3064
- # @param engagement Engagement
3065
- # @param [Hash] opts the optional parameters
3066
- # @return [ConversationEngagementResponse]
3067
- def insert_conversation_engagement(engagement, opts = {})
3068
- data, _status_code, _headers = insert_conversation_engagement_with_http_info(engagement, opts)
3069
- data
3070
- end
3071
-
3072
- # Insert a engagement
3073
- # Insert a engagement
3074
- # @param engagement Engagement
3075
- # @param [Hash] opts the optional parameters
3076
- # @return [Array<(ConversationEngagementResponse, Fixnum, Hash)>] ConversationEngagementResponse data, response status code and response headers
3077
- def insert_conversation_engagement_with_http_info(engagement, opts = {})
3078
- if @api_client.config.debugging
3079
- @api_client.config.logger.debug 'Calling API: ConversationApi.insert_conversation_engagement ...'
3080
- end
3081
- # verify the required parameter 'engagement' is set
3082
- if @api_client.config.client_side_validation && engagement.nil?
3083
- fail ArgumentError, "Missing the required parameter 'engagement' when calling ConversationApi.insert_conversation_engagement"
3084
- end
3085
- # resource path
3086
- local_var_path = '/conversation/engagements'
3087
-
3088
- # query parameters
3089
- query_params = {}
3090
-
3091
- # header parameters
3092
- header_params = {}
3093
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3094
- # HTTP header 'Accept' (if needed)
3095
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3096
- # HTTP header 'Content-Type'
3097
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3098
-
3099
- # form parameters
3100
- form_params = {}
3101
-
3102
- # http body (model)
3103
- post_body = @api_client.object_to_http_body(engagement)
3104
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3105
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
3106
- :header_params => header_params,
3107
- :query_params => query_params,
3108
- :form_params => form_params,
3109
- :body => post_body,
3110
- :auth_names => auth_names,
3111
- :return_type => 'ConversationEngagementResponse')
3112
- if @api_client.config.debugging
3113
- @api_client.config.logger.debug "API called: ConversationApi#insert_conversation_engagement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3114
- end
3115
- return data, status_code, headers
3116
- end
3117
- # Insert pbx audio
3118
- # Insert a pbx audio
3119
- # @param pbx_audio Pbx Audio
3120
- # @param [Hash] opts the optional parameters
3121
- # @return [ConversationPbxAudioResponse]
3122
- def insert_pbx_audio(pbx_audio, opts = {})
3123
- data, _status_code, _headers = insert_pbx_audio_with_http_info(pbx_audio, opts)
3124
- data
3125
- end
3126
-
3127
- # Insert pbx audio
3128
- # Insert a pbx audio
3129
- # @param pbx_audio Pbx Audio
3130
- # @param [Hash] opts the optional parameters
3131
- # @return [Array<(ConversationPbxAudioResponse, Fixnum, Hash)>] ConversationPbxAudioResponse data, response status code and response headers
3132
- def insert_pbx_audio_with_http_info(pbx_audio, opts = {})
3133
- if @api_client.config.debugging
3134
- @api_client.config.logger.debug 'Calling API: ConversationApi.insert_pbx_audio ...'
3135
- end
3136
- # verify the required parameter 'pbx_audio' is set
3137
- if @api_client.config.client_side_validation && pbx_audio.nil?
3138
- fail ArgumentError, "Missing the required parameter 'pbx_audio' when calling ConversationApi.insert_pbx_audio"
3139
- end
3140
- # resource path
3141
- local_var_path = '/conversation/pbx/audio'
3142
-
3143
- # query parameters
3144
- query_params = {}
3145
-
3146
- # header parameters
3147
- header_params = {}
3148
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3149
- # HTTP header 'Accept' (if needed)
3150
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3151
- # HTTP header 'Content-Type'
3152
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3153
-
3154
- # form parameters
3155
- form_params = {}
3156
-
3157
- # http body (model)
3158
- post_body = @api_client.object_to_http_body(pbx_audio)
3159
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3160
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
3161
- :header_params => header_params,
3162
- :query_params => query_params,
3163
- :form_params => form_params,
3164
- :body => post_body,
3165
- :auth_names => auth_names,
3166
- :return_type => 'ConversationPbxAudioResponse')
3167
- if @api_client.config.debugging
3168
- @api_client.config.logger.debug "API called: ConversationApi#insert_pbx_audio\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3169
- end
3170
- return data, status_code, headers
3171
- end
3172
- # Insert pbx menu
3173
- # Insert a pbx menu
3174
- # @param pbx_menu Pbx Menu
3175
- # @param [Hash] opts the optional parameters
3176
- # @return [ConversationPbxMenuResponse]
3177
- def insert_pbx_menu(pbx_menu, opts = {})
3178
- data, _status_code, _headers = insert_pbx_menu_with_http_info(pbx_menu, opts)
3179
- data
3180
- end
3181
-
3182
- # Insert pbx menu
3183
- # Insert a pbx menu
3184
- # @param pbx_menu Pbx Menu
3185
- # @param [Hash] opts the optional parameters
3186
- # @return [Array<(ConversationPbxMenuResponse, Fixnum, Hash)>] ConversationPbxMenuResponse data, response status code and response headers
3187
- def insert_pbx_menu_with_http_info(pbx_menu, opts = {})
3188
- if @api_client.config.debugging
3189
- @api_client.config.logger.debug 'Calling API: ConversationApi.insert_pbx_menu ...'
3190
- end
3191
- # verify the required parameter 'pbx_menu' is set
3192
- if @api_client.config.client_side_validation && pbx_menu.nil?
3193
- fail ArgumentError, "Missing the required parameter 'pbx_menu' when calling ConversationApi.insert_pbx_menu"
3194
- end
3195
- # resource path
3196
- local_var_path = '/conversation/pbx/menu'
3197
-
3198
- # query parameters
3199
- query_params = {}
3200
-
3201
- # header parameters
3202
- header_params = {}
3203
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3204
- # HTTP header 'Accept' (if needed)
3205
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3206
- # HTTP header 'Content-Type'
3207
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3208
-
3209
- # form parameters
3210
- form_params = {}
3211
-
3212
- # http body (model)
3213
- post_body = @api_client.object_to_http_body(pbx_menu)
3214
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3215
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
3216
- :header_params => header_params,
3217
- :query_params => query_params,
3218
- :form_params => form_params,
3219
- :body => post_body,
3220
- :auth_names => auth_names,
3221
- :return_type => 'ConversationPbxMenuResponse')
3222
- if @api_client.config.debugging
3223
- @api_client.config.logger.debug "API called: ConversationApi#insert_pbx_menu\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3224
- end
3225
- return data, status_code, headers
3226
- end
3227
- # Insert pbx queue
3228
- # Insert a pbx queue
3229
- # @param pbx_queue Pbx Queue
3230
- # @param [Hash] opts the optional parameters
3231
- # @return [ConversationPbxQueueResponse]
3232
- def insert_pbx_queue(pbx_queue, opts = {})
3233
- data, _status_code, _headers = insert_pbx_queue_with_http_info(pbx_queue, opts)
3234
- data
3235
- end
3236
-
3237
- # Insert pbx queue
3238
- # Insert a pbx queue
3239
- # @param pbx_queue Pbx Queue
3240
- # @param [Hash] opts the optional parameters
3241
- # @return [Array<(ConversationPbxQueueResponse, Fixnum, Hash)>] ConversationPbxQueueResponse data, response status code and response headers
3242
- def insert_pbx_queue_with_http_info(pbx_queue, opts = {})
3243
- if @api_client.config.debugging
3244
- @api_client.config.logger.debug 'Calling API: ConversationApi.insert_pbx_queue ...'
3245
- end
3246
- # verify the required parameter 'pbx_queue' is set
3247
- if @api_client.config.client_side_validation && pbx_queue.nil?
3248
- fail ArgumentError, "Missing the required parameter 'pbx_queue' when calling ConversationApi.insert_pbx_queue"
3249
- end
3250
- # resource path
3251
- local_var_path = '/conversation/pbx/queue'
3252
-
3253
- # query parameters
3254
- query_params = {}
3255
-
3256
- # header parameters
3257
- header_params = {}
3258
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3259
- # HTTP header 'Accept' (if needed)
3260
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3261
- # HTTP header 'Content-Type'
3262
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3263
-
3264
- # form parameters
3265
- form_params = {}
3266
-
3267
- # http body (model)
3268
- post_body = @api_client.object_to_http_body(pbx_queue)
3269
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3270
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
3271
- :header_params => header_params,
3272
- :query_params => query_params,
3273
- :form_params => form_params,
3274
- :body => post_body,
3275
- :auth_names => auth_names,
3276
- :return_type => 'ConversationPbxQueueResponse')
3277
- if @api_client.config.debugging
3278
- @api_client.config.logger.debug "API called: ConversationApi#insert_pbx_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3279
- end
3280
- return data, status_code, headers
3281
- end
3282
- # Insert pbx timeBased
3283
- # Insert a pbx timeBased
3284
- # @param pbx_time_based Pbx TimeBased
3285
- # @param [Hash] opts the optional parameters
3286
- # @return [ConversationPbxTimeBasedResponse]
3287
- def insert_pbx_time_based(pbx_time_based, opts = {})
3288
- data, _status_code, _headers = insert_pbx_time_based_with_http_info(pbx_time_based, opts)
3289
- data
3290
- end
3291
-
3292
- # Insert pbx timeBased
3293
- # Insert a pbx timeBased
3294
- # @param pbx_time_based Pbx TimeBased
3295
- # @param [Hash] opts the optional parameters
3296
- # @return [Array<(ConversationPbxTimeBasedResponse, Fixnum, Hash)>] ConversationPbxTimeBasedResponse data, response status code and response headers
3297
- def insert_pbx_time_based_with_http_info(pbx_time_based, opts = {})
3298
- if @api_client.config.debugging
3299
- @api_client.config.logger.debug 'Calling API: ConversationApi.insert_pbx_time_based ...'
3300
- end
3301
- # verify the required parameter 'pbx_time_based' is set
3302
- if @api_client.config.client_side_validation && pbx_time_based.nil?
3303
- fail ArgumentError, "Missing the required parameter 'pbx_time_based' when calling ConversationApi.insert_pbx_time_based"
3304
- end
3305
- # resource path
3306
- local_var_path = '/conversation/pbx/time_based'
3307
-
3308
- # query parameters
3309
- query_params = {}
3310
-
3311
- # header parameters
3312
- header_params = {}
3313
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3314
- # HTTP header 'Accept' (if needed)
3315
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3316
- # HTTP header 'Content-Type'
3317
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3318
-
3319
- # form parameters
3320
- form_params = {}
3321
-
3322
- # http body (model)
3323
- post_body = @api_client.object_to_http_body(pbx_time_based)
3324
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3325
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
3326
- :header_params => header_params,
3327
- :query_params => query_params,
3328
- :form_params => form_params,
3329
- :body => post_body,
3330
- :auth_names => auth_names,
3331
- :return_type => 'ConversationPbxTimeBasedResponse')
3332
- if @api_client.config.debugging
3333
- @api_client.config.logger.debug "API called: ConversationApi#insert_pbx_time_based\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3334
- end
3335
- return data, status_code, headers
3336
- end
3337
- # Insert pbx timeRange
3338
- # Insert a pbx timeRange
3339
- # @param pbx_time_range Pbx TimeRange
3340
- # @param [Hash] opts the optional parameters
3341
- # @return [ConversationPbxTimeRangeResponse]
3342
- def insert_pbx_time_range(pbx_time_range, opts = {})
3343
- data, _status_code, _headers = insert_pbx_time_range_with_http_info(pbx_time_range, opts)
3344
- data
3345
- end
3346
-
3347
- # Insert pbx timeRange
3348
- # Insert a pbx timeRange
3349
- # @param pbx_time_range Pbx TimeRange
3350
- # @param [Hash] opts the optional parameters
3351
- # @return [Array<(ConversationPbxTimeRangeResponse, Fixnum, Hash)>] ConversationPbxTimeRangeResponse data, response status code and response headers
3352
- def insert_pbx_time_range_with_http_info(pbx_time_range, opts = {})
3353
- if @api_client.config.debugging
3354
- @api_client.config.logger.debug 'Calling API: ConversationApi.insert_pbx_time_range ...'
3355
- end
3356
- # verify the required parameter 'pbx_time_range' is set
3357
- if @api_client.config.client_side_validation && pbx_time_range.nil?
3358
- fail ArgumentError, "Missing the required parameter 'pbx_time_range' when calling ConversationApi.insert_pbx_time_range"
3359
- end
3360
- # resource path
3361
- local_var_path = '/conversation/pbx/time_range'
3362
-
3363
- # query parameters
3364
- query_params = {}
3365
-
3366
- # header parameters
3367
- header_params = {}
3368
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3369
- # HTTP header 'Accept' (if needed)
3370
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3371
- # HTTP header 'Content-Type'
3372
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3373
-
3374
- # form parameters
3375
- form_params = {}
3376
-
3377
- # http body (model)
3378
- post_body = @api_client.object_to_http_body(pbx_time_range)
3379
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3380
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
3381
- :header_params => header_params,
3382
- :query_params => query_params,
3383
- :form_params => form_params,
3384
- :body => post_body,
3385
- :auth_names => auth_names,
3386
- :return_type => 'ConversationPbxTimeRangeResponse')
3387
- if @api_client.config.debugging
3388
- @api_client.config.logger.debug "API called: ConversationApi#insert_pbx_time_range\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3389
- end
3390
- return data, status_code, headers
3391
- end
3392
- # Insert pbx voicemailMailbox
3393
- # Insert a pbx voicemailMailbox
3394
- # @param pbx_voicemail_mailbox Pbx VoicemailMailbox
3395
- # @param [Hash] opts the optional parameters
3396
- # @return [ConversationPbxVoicemailMailboxResponse]
3397
- def insert_pbx_voicemail_mailbox(pbx_voicemail_mailbox, opts = {})
3398
- data, _status_code, _headers = insert_pbx_voicemail_mailbox_with_http_info(pbx_voicemail_mailbox, opts)
3399
- data
3400
- end
3401
-
3402
- # Insert pbx voicemailMailbox
3403
- # Insert a pbx voicemailMailbox
3404
- # @param pbx_voicemail_mailbox Pbx VoicemailMailbox
3405
- # @param [Hash] opts the optional parameters
3406
- # @return [Array<(ConversationPbxVoicemailMailboxResponse, Fixnum, Hash)>] ConversationPbxVoicemailMailboxResponse data, response status code and response headers
3407
- def insert_pbx_voicemail_mailbox_with_http_info(pbx_voicemail_mailbox, opts = {})
3408
- if @api_client.config.debugging
3409
- @api_client.config.logger.debug 'Calling API: ConversationApi.insert_pbx_voicemail_mailbox ...'
3410
- end
3411
- # verify the required parameter 'pbx_voicemail_mailbox' is set
3412
- if @api_client.config.client_side_validation && pbx_voicemail_mailbox.nil?
3413
- fail ArgumentError, "Missing the required parameter 'pbx_voicemail_mailbox' when calling ConversationApi.insert_pbx_voicemail_mailbox"
3414
- end
3415
- # resource path
3416
- local_var_path = '/conversation/pbx/voicemail_mailbox'
3417
-
3418
- # query parameters
3419
- query_params = {}
3420
-
3421
- # header parameters
3422
- header_params = {}
3423
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3424
- # HTTP header 'Accept' (if needed)
3425
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3426
- # HTTP header 'Content-Type'
3427
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3428
-
3429
- # form parameters
3430
- form_params = {}
3431
-
3432
- # http body (model)
3433
- post_body = @api_client.object_to_http_body(pbx_voicemail_mailbox)
3434
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3435
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
3436
- :header_params => header_params,
3437
- :query_params => query_params,
3438
- :form_params => form_params,
3439
- :body => post_body,
3440
- :auth_names => auth_names,
3441
- :return_type => 'ConversationPbxVoicemailMailboxResponse')
3442
- if @api_client.config.debugging
3443
- @api_client.config.logger.debug "API called: ConversationApi#insert_pbx_voicemail_mailbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3444
- end
3445
- return data, status_code, headers
3446
- end
3447
- # Join a conversation
3448
- # Join a conversation
3449
- # @param conversation_uuid
3450
- # @param [Hash] opts the optional parameters
3451
- # @option opts [ConversationJoinRequest] :join_request Join request
3452
- # @return [nil]
3453
- def join_conversation(conversation_uuid, opts = {})
3454
- join_conversation_with_http_info(conversation_uuid, opts)
3455
- nil
3456
- end
3457
-
3458
- # Join a conversation
3459
- # Join a conversation
3460
- # @param conversation_uuid
3461
- # @param [Hash] opts the optional parameters
3462
- # @option opts [ConversationJoinRequest] :join_request Join request
3463
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
3464
- def join_conversation_with_http_info(conversation_uuid, opts = {})
3465
- if @api_client.config.debugging
3466
- @api_client.config.logger.debug 'Calling API: ConversationApi.join_conversation ...'
3467
- end
3468
- # verify the required parameter 'conversation_uuid' is set
3469
- if @api_client.config.client_side_validation && conversation_uuid.nil?
3470
- fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.join_conversation"
3471
- end
3472
- # resource path
3473
- local_var_path = '/conversation/conversations/{conversation_uuid}/join'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.to_s)
3474
-
3475
- # query parameters
3476
- query_params = {}
3477
-
3478
- # header parameters
3479
- header_params = {}
3480
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3481
- # HTTP header 'Accept' (if needed)
3482
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3483
- # HTTP header 'Content-Type'
3484
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3485
-
3486
- # form parameters
3487
- form_params = {}
3488
-
3489
- # http body (model)
3490
- post_body = @api_client.object_to_http_body(opts[:'join_request'])
3491
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3492
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
3493
- :header_params => header_params,
3494
- :query_params => query_params,
3495
- :form_params => form_params,
3496
- :body => post_body,
3497
- :auth_names => auth_names)
3498
- if @api_client.config.debugging
3499
- @api_client.config.logger.debug "API called: ConversationApi#join_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3500
- end
3501
- return data, status_code, headers
3502
- end
3503
- # Leave a conversation
3504
- # Leave a conversation
3505
- # @param conversation_uuid
3506
- # @param [Hash] opts the optional parameters
3507
- # @return [nil]
3508
- def leave_conversation(conversation_uuid, opts = {})
3509
- leave_conversation_with_http_info(conversation_uuid, opts)
3510
- nil
3511
- end
3512
-
3513
- # Leave a conversation
3514
- # Leave a conversation
3515
- # @param conversation_uuid
3516
- # @param [Hash] opts the optional parameters
3517
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
3518
- def leave_conversation_with_http_info(conversation_uuid, opts = {})
3519
- if @api_client.config.debugging
3520
- @api_client.config.logger.debug 'Calling API: ConversationApi.leave_conversation ...'
3521
- end
3522
- # verify the required parameter 'conversation_uuid' is set
3523
- if @api_client.config.client_side_validation && conversation_uuid.nil?
3524
- fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.leave_conversation"
3525
- end
3526
- # resource path
3527
- local_var_path = '/conversation/conversations/{conversation_uuid}/leave'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.to_s)
3528
-
3529
- # query parameters
3530
- query_params = {}
3531
-
3532
- # header parameters
3533
- header_params = {}
3534
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3535
- # HTTP header 'Accept' (if needed)
3536
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3537
- # HTTP header 'Content-Type'
3538
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3539
-
3540
- # form parameters
3541
- form_params = {}
3542
-
3543
- # http body (model)
3544
- post_body = nil
3545
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3546
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
3547
- :header_params => header_params,
3548
- :query_params => query_params,
3549
- :form_params => form_params,
3550
- :body => post_body,
3551
- :auth_names => auth_names)
3552
- if @api_client.config.debugging
3553
- @api_client.config.logger.debug "API called: ConversationApi#leave_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3554
- end
3555
- return data, status_code, headers
3556
- end
3557
- # Listened Agent Voicemail
3558
- # Listened pbx agent Voicemail
3559
- # @param recording_sid
3560
- # @param [Hash] opts the optional parameters
3561
- # @return [nil]
3562
- def listened_pbx_agent_voicemail(recording_sid, opts = {})
3563
- listened_pbx_agent_voicemail_with_http_info(recording_sid, opts)
3564
- nil
3565
- end
3566
-
3567
- # Listened Agent Voicemail
3568
- # Listened pbx agent Voicemail
3569
- # @param recording_sid
3570
- # @param [Hash] opts the optional parameters
3571
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
3572
- def listened_pbx_agent_voicemail_with_http_info(recording_sid, opts = {})
3573
- if @api_client.config.debugging
3574
- @api_client.config.logger.debug 'Calling API: ConversationApi.listened_pbx_agent_voicemail ...'
3575
- end
3576
- # verify the required parameter 'recording_sid' is set
3577
- if @api_client.config.client_side_validation && recording_sid.nil?
3578
- fail ArgumentError, "Missing the required parameter 'recording_sid' when calling ConversationApi.listened_pbx_agent_voicemail"
3579
- end
3580
- # resource path
3581
- local_var_path = '/conversation/pbx/agent/voicemails/{recording_sid}/listened'.sub('{' + 'recording_sid' + '}', recording_sid.to_s)
3582
-
3583
- # query parameters
3584
- query_params = {}
3585
-
3586
- # header parameters
3587
- header_params = {}
3588
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3589
- # HTTP header 'Accept' (if needed)
3590
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3591
- # HTTP header 'Content-Type'
3592
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3593
-
3594
- # form parameters
3595
- form_params = {}
3596
-
3597
- # http body (model)
3598
- post_body = nil
3599
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3600
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
3601
- :header_params => header_params,
3602
- :query_params => query_params,
3603
- :form_params => form_params,
3604
- :body => post_body,
3605
- :auth_names => auth_names)
3606
- if @api_client.config.debugging
3607
- @api_client.config.logger.debug "API called: ConversationApi#listened_pbx_agent_voicemail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3608
- end
3609
- return data, status_code, headers
3610
- end
3611
- # Listened Queue Voicemail
3612
- # Listened pbx queue Voicemail
3613
- # @param queue_uuid
3614
- # @param recording_sid
3615
- # @param [Hash] opts the optional parameters
3616
- # @return [nil]
3617
- def listened_pbx_queue_voicemail(queue_uuid, recording_sid, opts = {})
3618
- listened_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid, opts)
3619
- nil
3620
- end
3621
-
3622
- # Listened Queue Voicemail
3623
- # Listened pbx queue Voicemail
3624
- # @param queue_uuid
3625
- # @param recording_sid
3626
- # @param [Hash] opts the optional parameters
3627
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
3628
- def listened_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid, opts = {})
3629
- if @api_client.config.debugging
3630
- @api_client.config.logger.debug 'Calling API: ConversationApi.listened_pbx_queue_voicemail ...'
3631
- end
3632
- # verify the required parameter 'queue_uuid' is set
3633
- if @api_client.config.client_side_validation && queue_uuid.nil?
3634
- fail ArgumentError, "Missing the required parameter 'queue_uuid' when calling ConversationApi.listened_pbx_queue_voicemail"
3635
- end
3636
- # verify the required parameter 'recording_sid' is set
3637
- if @api_client.config.client_side_validation && recording_sid.nil?
3638
- fail ArgumentError, "Missing the required parameter 'recording_sid' when calling ConversationApi.listened_pbx_queue_voicemail"
3639
- end
3640
- # resource path
3641
- local_var_path = '/conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid}/listened'.sub('{' + 'queue_uuid' + '}', queue_uuid.to_s).sub('{' + 'recording_sid' + '}', recording_sid.to_s)
3642
-
3643
- # query parameters
3644
- query_params = {}
3645
-
3646
- # header parameters
3647
- header_params = {}
3648
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3649
- # HTTP header 'Accept' (if needed)
3650
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3651
- # HTTP header 'Content-Type'
3652
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3653
-
3654
- # form parameters
3655
- form_params = {}
3656
-
3657
- # http body (model)
3658
- post_body = nil
3659
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3660
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
3661
- :header_params => header_params,
3662
- :query_params => query_params,
3663
- :form_params => form_params,
3664
- :body => post_body,
3665
- :auth_names => auth_names)
3666
- if @api_client.config.debugging
3667
- @api_client.config.logger.debug "API called: ConversationApi#listened_pbx_queue_voicemail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3668
- end
3669
- return data, status_code, headers
3670
- end
3671
- # Mark a conversation as read
3672
- # Mark a conversation as read
3673
- # @param conversation_uuid
3674
- # @param [Hash] opts the optional parameters
3675
- # @return [nil]
3676
- def mark_read_conversation(conversation_uuid, opts = {})
3677
- mark_read_conversation_with_http_info(conversation_uuid, opts)
3678
- nil
3679
- end
3680
-
3681
- # Mark a conversation as read
3682
- # Mark a conversation as read
3683
- # @param conversation_uuid
3684
- # @param [Hash] opts the optional parameters
3685
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
3686
- def mark_read_conversation_with_http_info(conversation_uuid, opts = {})
3687
- if @api_client.config.debugging
3688
- @api_client.config.logger.debug 'Calling API: ConversationApi.mark_read_conversation ...'
3689
- end
3690
- # verify the required parameter 'conversation_uuid' is set
3691
- if @api_client.config.client_side_validation && conversation_uuid.nil?
3692
- fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.mark_read_conversation"
3693
- end
3694
- # resource path
3695
- local_var_path = '/conversation/conversations/{conversation_uuid}/markread'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.to_s)
3696
-
3697
- # query parameters
3698
- query_params = {}
3699
-
3700
- # header parameters
3701
- header_params = {}
3702
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3703
- # HTTP header 'Accept' (if needed)
3704
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3705
- # HTTP header 'Content-Type'
3706
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3707
-
3708
- # form parameters
3709
- form_params = {}
3710
-
3711
- # http body (model)
3712
- post_body = nil
3713
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3714
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
3715
- :header_params => header_params,
3716
- :query_params => query_params,
3717
- :form_params => form_params,
3718
- :body => post_body,
3719
- :auth_names => auth_names)
3720
- if @api_client.config.debugging
3721
- @api_client.config.logger.debug "API called: ConversationApi#mark_read_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3722
- end
3723
- return data, status_code, headers
3724
- end
3725
- # reset statistics within the queue
3726
- # reset statistics within the queue
3727
- # @param queue_uuid
3728
- # @param [Hash] opts the optional parameters
3729
- # @return [nil]
3730
- def reset_conversation_pbx_queue_statistics(queue_uuid, opts = {})
3731
- reset_conversation_pbx_queue_statistics_with_http_info(queue_uuid, opts)
3732
- nil
3733
- end
3734
-
3735
- # reset statistics within the queue
3736
- # reset statistics within the queue
3737
- # @param queue_uuid
3738
- # @param [Hash] opts the optional parameters
3739
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
3740
- def reset_conversation_pbx_queue_statistics_with_http_info(queue_uuid, opts = {})
3741
- if @api_client.config.debugging
3742
- @api_client.config.logger.debug 'Calling API: ConversationApi.reset_conversation_pbx_queue_statistics ...'
3743
- end
3744
- # verify the required parameter 'queue_uuid' is set
3745
- if @api_client.config.client_side_validation && queue_uuid.nil?
3746
- fail ArgumentError, "Missing the required parameter 'queue_uuid' when calling ConversationApi.reset_conversation_pbx_queue_statistics"
3747
- end
3748
- # resource path
3749
- local_var_path = '/conversation/pbx/queues/{queue_uuid}/reset_statistics'.sub('{' + 'queue_uuid' + '}', queue_uuid.to_s)
3750
-
3751
- # query parameters
3752
- query_params = {}
3753
-
3754
- # header parameters
3755
- header_params = {}
3756
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3757
- # HTTP header 'Accept' (if needed)
3758
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3759
- # HTTP header 'Content-Type'
3760
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3761
-
3762
- # form parameters
3763
- form_params = {}
3764
-
3765
- # http body (model)
3766
- post_body = nil
3767
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3768
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
3769
- :header_params => header_params,
3770
- :query_params => query_params,
3771
- :form_params => form_params,
3772
- :body => post_body,
3773
- :auth_names => auth_names)
3774
- if @api_client.config.debugging
3775
- @api_client.config.logger.debug "API called: ConversationApi#reset_conversation_pbx_queue_statistics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3776
- end
3777
- return data, status_code, headers
3778
- end
3779
- # Search for canned messages by short_code
3780
- # Search for canned messages by short_code
3781
- # @param search_request Search request
3782
- # @param [Hash] opts the optional parameters
3783
- # @return [ConversationCannedMessagesResponse]
3784
- def search_conversation_canned_messages(search_request, opts = {})
3785
- data, _status_code, _headers = search_conversation_canned_messages_with_http_info(search_request, opts)
3786
- data
3787
- end
3788
-
3789
- # Search for canned messages by short_code
3790
- # Search for canned messages by short_code
3791
- # @param search_request Search request
3792
- # @param [Hash] opts the optional parameters
3793
- # @return [Array<(ConversationCannedMessagesResponse, Fixnum, Hash)>] ConversationCannedMessagesResponse data, response status code and response headers
3794
- def search_conversation_canned_messages_with_http_info(search_request, opts = {})
3795
- if @api_client.config.debugging
3796
- @api_client.config.logger.debug 'Calling API: ConversationApi.search_conversation_canned_messages ...'
3797
- end
3798
- # verify the required parameter 'search_request' is set
3799
- if @api_client.config.client_side_validation && search_request.nil?
3800
- fail ArgumentError, "Missing the required parameter 'search_request' when calling ConversationApi.search_conversation_canned_messages"
3801
- end
3802
- # resource path
3803
- local_var_path = '/conversation/canned_messages/search'
3804
-
3805
- # query parameters
3806
- query_params = {}
3807
-
3808
- # header parameters
3809
- header_params = {}
3810
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3811
- # HTTP header 'Accept' (if needed)
3812
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3813
- # HTTP header 'Content-Type'
3814
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3815
-
3816
- # form parameters
3817
- form_params = {}
3818
-
3819
- # http body (model)
3820
- post_body = @api_client.object_to_http_body(search_request)
3821
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3822
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
3823
- :header_params => header_params,
3824
- :query_params => query_params,
3825
- :form_params => form_params,
3826
- :body => post_body,
3827
- :auth_names => auth_names,
3828
- :return_type => 'ConversationCannedMessagesResponse')
3829
- if @api_client.config.debugging
3830
- @api_client.config.logger.debug "API called: ConversationApi#search_conversation_canned_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3831
- end
3832
- return data, status_code, headers
3833
- end
3834
- # Unsubscribe any SMS participants in this conversation
3835
- # Unsubscribe any SMS participants in this conversation
3836
- # @param conversation_uuid
3837
- # @param [Hash] opts the optional parameters
3838
- # @return [nil]
3839
- def sms_unsubscribe_conversation(conversation_uuid, opts = {})
3840
- sms_unsubscribe_conversation_with_http_info(conversation_uuid, opts)
3841
- nil
3842
- end
3843
-
3844
- # Unsubscribe any SMS participants in this conversation
3845
- # Unsubscribe any SMS participants in this conversation
3846
- # @param conversation_uuid
3847
- # @param [Hash] opts the optional parameters
3848
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
3849
- def sms_unsubscribe_conversation_with_http_info(conversation_uuid, opts = {})
3850
- if @api_client.config.debugging
3851
- @api_client.config.logger.debug 'Calling API: ConversationApi.sms_unsubscribe_conversation ...'
3852
- end
3853
- # verify the required parameter 'conversation_uuid' is set
3854
- if @api_client.config.client_side_validation && conversation_uuid.nil?
3855
- fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.sms_unsubscribe_conversation"
3856
- end
3857
- # resource path
3858
- local_var_path = '/conversation/conversations/{conversation_uuid}/sms_unsubscribe'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.to_s)
3859
-
3860
- # query parameters
3861
- query_params = {}
3862
-
3863
- # header parameters
3864
- header_params = {}
3865
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3866
- # HTTP header 'Accept' (if needed)
3867
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3868
- # HTTP header 'Content-Type'
3869
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3870
-
3871
- # form parameters
3872
- form_params = {}
3873
-
3874
- # http body (model)
3875
- post_body = nil
3876
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3877
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
3878
- :header_params => header_params,
3879
- :query_params => query_params,
3880
- :form_params => form_params,
3881
- :body => post_body,
3882
- :auth_names => auth_names)
3883
- if @api_client.config.debugging
3884
- @api_client.config.logger.debug "API called: ConversationApi#sms_unsubscribe_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3885
- end
3886
- return data, status_code, headers
3887
- end
3888
- # Start a conversation
3889
- # Start a new conversation
3890
- # @param start_request Start request
3891
- # @param [Hash] opts the optional parameters
3892
- # @return [ConversationStartResponse]
3893
- def start_conversation(start_request, opts = {})
3894
- data, _status_code, _headers = start_conversation_with_http_info(start_request, opts)
3895
- data
3896
- end
3897
-
3898
- # Start a conversation
3899
- # Start a new conversation
3900
- # @param start_request Start request
3901
- # @param [Hash] opts the optional parameters
3902
- # @return [Array<(ConversationStartResponse, Fixnum, Hash)>] ConversationStartResponse data, response status code and response headers
3903
- def start_conversation_with_http_info(start_request, opts = {})
3904
- if @api_client.config.debugging
3905
- @api_client.config.logger.debug 'Calling API: ConversationApi.start_conversation ...'
3906
- end
3907
- # verify the required parameter 'start_request' is set
3908
- if @api_client.config.client_side_validation && start_request.nil?
3909
- fail ArgumentError, "Missing the required parameter 'start_request' when calling ConversationApi.start_conversation"
3910
- end
3911
- # resource path
3912
- local_var_path = '/conversation/conversations'
3913
-
3914
- # query parameters
3915
- query_params = {}
3916
-
3917
- # header parameters
3918
- header_params = {}
3919
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3920
- # HTTP header 'Accept' (if needed)
3921
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3922
- # HTTP header 'Content-Type'
3923
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3924
-
3925
- # form parameters
3926
- form_params = {}
3927
-
3928
- # http body (model)
3929
- post_body = @api_client.object_to_http_body(start_request)
3930
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3931
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
3932
- :header_params => header_params,
3933
- :query_params => query_params,
3934
- :form_params => form_params,
3935
- :body => post_body,
3936
- :auth_names => auth_names,
3937
- :return_type => 'ConversationStartResponse')
3938
- if @api_client.config.debugging
3939
- @api_client.config.logger.debug "API called: ConversationApi#start_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3940
- end
3941
- return data, status_code, headers
3942
- end
3943
- # Update agent profile
3944
- # Update agent profile
3945
- # @param profile_request Profile request
3946
- # @param [Hash] opts the optional parameters
3947
- # @return [ConversationAgentProfileResponse]
3948
- def update_agent_profile(profile_request, opts = {})
3949
- data, _status_code, _headers = update_agent_profile_with_http_info(profile_request, opts)
3950
- data
3951
- end
3952
-
3953
- # Update agent profile
3954
- # Update agent profile
3955
- # @param profile_request Profile request
3956
- # @param [Hash] opts the optional parameters
3957
- # @return [Array<(ConversationAgentProfileResponse, Fixnum, Hash)>] ConversationAgentProfileResponse data, response status code and response headers
3958
- def update_agent_profile_with_http_info(profile_request, opts = {})
3959
- if @api_client.config.debugging
3960
- @api_client.config.logger.debug 'Calling API: ConversationApi.update_agent_profile ...'
3961
- end
3962
- # verify the required parameter 'profile_request' is set
3963
- if @api_client.config.client_side_validation && profile_request.nil?
3964
- fail ArgumentError, "Missing the required parameter 'profile_request' when calling ConversationApi.update_agent_profile"
3965
- end
3966
- # resource path
3967
- local_var_path = '/conversation/agent/profile'
3968
-
3969
- # query parameters
3970
- query_params = {}
3971
-
3972
- # header parameters
3973
- header_params = {}
3974
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3975
- # HTTP header 'Accept' (if needed)
3976
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3977
- # HTTP header 'Content-Type'
3978
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3979
-
3980
- # form parameters
3981
- form_params = {}
3982
-
3983
- # http body (model)
3984
- post_body = @api_client.object_to_http_body(profile_request)
3985
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3986
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
3987
- :header_params => header_params,
3988
- :query_params => query_params,
3989
- :form_params => form_params,
3990
- :body => post_body,
3991
- :auth_names => auth_names,
3992
- :return_type => 'ConversationAgentProfileResponse')
3993
- if @api_client.config.debugging
3994
- @api_client.config.logger.debug "API called: ConversationApi#update_agent_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3995
- end
3996
- return data, status_code, headers
3997
- end
3998
- # Update a canned message
3999
- # Update a canned message
4000
- # @param conversation_canned_message_oid
4001
- # @param canned_message Canned message
4002
- # @param [Hash] opts the optional parameters
4003
- # @return [ConversationCannedMessageResponse]
4004
- def update_conversation_canned_message(conversation_canned_message_oid, canned_message, opts = {})
4005
- data, _status_code, _headers = update_conversation_canned_message_with_http_info(conversation_canned_message_oid, canned_message, opts)
4006
- data
4007
- end
4008
-
4009
- # Update a canned message
4010
- # Update a canned message
4011
- # @param conversation_canned_message_oid
4012
- # @param canned_message Canned message
4013
- # @param [Hash] opts the optional parameters
4014
- # @return [Array<(ConversationCannedMessageResponse, Fixnum, Hash)>] ConversationCannedMessageResponse data, response status code and response headers
4015
- def update_conversation_canned_message_with_http_info(conversation_canned_message_oid, canned_message, opts = {})
4016
- if @api_client.config.debugging
4017
- @api_client.config.logger.debug 'Calling API: ConversationApi.update_conversation_canned_message ...'
4018
- end
4019
- # verify the required parameter 'conversation_canned_message_oid' is set
4020
- if @api_client.config.client_side_validation && conversation_canned_message_oid.nil?
4021
- fail ArgumentError, "Missing the required parameter 'conversation_canned_message_oid' when calling ConversationApi.update_conversation_canned_message"
4022
- end
4023
- # verify the required parameter 'canned_message' is set
4024
- if @api_client.config.client_side_validation && canned_message.nil?
4025
- fail ArgumentError, "Missing the required parameter 'canned_message' when calling ConversationApi.update_conversation_canned_message"
4026
- end
4027
- # resource path
4028
- local_var_path = '/conversation/canned_messages/{conversation_canned_message_oid}'.sub('{' + 'conversation_canned_message_oid' + '}', conversation_canned_message_oid.to_s)
4029
-
4030
- # query parameters
4031
- query_params = {}
4032
-
4033
- # header parameters
4034
- header_params = {}
4035
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
4036
- # HTTP header 'Accept' (if needed)
4037
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4038
- # HTTP header 'Content-Type'
4039
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4040
-
4041
- # form parameters
4042
- form_params = {}
4043
-
4044
- # http body (model)
4045
- post_body = @api_client.object_to_http_body(canned_message)
4046
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
4047
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4048
- :header_params => header_params,
4049
- :query_params => query_params,
4050
- :form_params => form_params,
4051
- :body => post_body,
4052
- :auth_names => auth_names,
4053
- :return_type => 'ConversationCannedMessageResponse')
4054
- if @api_client.config.debugging
4055
- @api_client.config.logger.debug "API called: ConversationApi#update_conversation_canned_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4056
- end
4057
- return data, status_code, headers
4058
- end
4059
- # Update a department
4060
- # Update a department
4061
- # @param conversation_department_oid
4062
- # @param department Department
4063
- # @param [Hash] opts the optional parameters
4064
- # @return [ConversationDepartmentResponse]
4065
- def update_conversation_department(conversation_department_oid, department, opts = {})
4066
- data, _status_code, _headers = update_conversation_department_with_http_info(conversation_department_oid, department, opts)
4067
- data
4068
- end
4069
-
4070
- # Update a department
4071
- # Update a department
4072
- # @param conversation_department_oid
4073
- # @param department Department
4074
- # @param [Hash] opts the optional parameters
4075
- # @return [Array<(ConversationDepartmentResponse, Fixnum, Hash)>] ConversationDepartmentResponse data, response status code and response headers
4076
- def update_conversation_department_with_http_info(conversation_department_oid, department, opts = {})
4077
- if @api_client.config.debugging
4078
- @api_client.config.logger.debug 'Calling API: ConversationApi.update_conversation_department ...'
4079
- end
4080
- # verify the required parameter 'conversation_department_oid' is set
4081
- if @api_client.config.client_side_validation && conversation_department_oid.nil?
4082
- fail ArgumentError, "Missing the required parameter 'conversation_department_oid' when calling ConversationApi.update_conversation_department"
4083
- end
4084
- # verify the required parameter 'department' is set
4085
- if @api_client.config.client_side_validation && department.nil?
4086
- fail ArgumentError, "Missing the required parameter 'department' when calling ConversationApi.update_conversation_department"
4087
- end
4088
- # resource path
4089
- local_var_path = '/conversation/departments/{conversation_department_oid}'.sub('{' + 'conversation_department_oid' + '}', conversation_department_oid.to_s)
4090
-
4091
- # query parameters
4092
- query_params = {}
4093
-
4094
- # header parameters
4095
- header_params = {}
4096
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
4097
- # HTTP header 'Accept' (if needed)
4098
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4099
- # HTTP header 'Content-Type'
4100
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4101
-
4102
- # form parameters
4103
- form_params = {}
4104
-
4105
- # http body (model)
4106
- post_body = @api_client.object_to_http_body(department)
4107
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
4108
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4109
- :header_params => header_params,
4110
- :query_params => query_params,
4111
- :form_params => form_params,
4112
- :body => post_body,
4113
- :auth_names => auth_names,
4114
- :return_type => 'ConversationDepartmentResponse')
4115
- if @api_client.config.debugging
4116
- @api_client.config.logger.debug "API called: ConversationApi#update_conversation_department\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4117
- end
4118
- return data, status_code, headers
4119
- end
4120
- # Update a engagement
4121
- # Update a engagement
4122
- # @param conversation_engagement_oid
4123
- # @param engagement Engagement
4124
- # @param [Hash] opts the optional parameters
4125
- # @return [ConversationEngagementResponse]
4126
- def update_conversation_engagement(conversation_engagement_oid, engagement, opts = {})
4127
- data, _status_code, _headers = update_conversation_engagement_with_http_info(conversation_engagement_oid, engagement, opts)
4128
- data
4129
- end
4130
-
4131
- # Update a engagement
4132
- # Update a engagement
4133
- # @param conversation_engagement_oid
4134
- # @param engagement Engagement
4135
- # @param [Hash] opts the optional parameters
4136
- # @return [Array<(ConversationEngagementResponse, Fixnum, Hash)>] ConversationEngagementResponse data, response status code and response headers
4137
- def update_conversation_engagement_with_http_info(conversation_engagement_oid, engagement, opts = {})
4138
- if @api_client.config.debugging
4139
- @api_client.config.logger.debug 'Calling API: ConversationApi.update_conversation_engagement ...'
4140
- end
4141
- # verify the required parameter 'conversation_engagement_oid' is set
4142
- if @api_client.config.client_side_validation && conversation_engagement_oid.nil?
4143
- fail ArgumentError, "Missing the required parameter 'conversation_engagement_oid' when calling ConversationApi.update_conversation_engagement"
4144
- end
4145
- # verify the required parameter 'engagement' is set
4146
- if @api_client.config.client_side_validation && engagement.nil?
4147
- fail ArgumentError, "Missing the required parameter 'engagement' when calling ConversationApi.update_conversation_engagement"
4148
- end
4149
- # resource path
4150
- local_var_path = '/conversation/engagements/{conversation_engagement_oid}'.sub('{' + 'conversation_engagement_oid' + '}', conversation_engagement_oid.to_s)
4151
-
4152
- # query parameters
4153
- query_params = {}
4154
-
4155
- # header parameters
4156
- header_params = {}
4157
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
4158
- # HTTP header 'Accept' (if needed)
4159
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4160
- # HTTP header 'Content-Type'
4161
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4162
-
4163
- # form parameters
4164
- form_params = {}
4165
-
4166
- # http body (model)
4167
- post_body = @api_client.object_to_http_body(engagement)
4168
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
4169
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4170
- :header_params => header_params,
4171
- :query_params => query_params,
4172
- :form_params => form_params,
4173
- :body => post_body,
4174
- :auth_names => auth_names,
4175
- :return_type => 'ConversationEngagementResponse')
4176
- if @api_client.config.debugging
4177
- @api_client.config.logger.debug "API called: ConversationApi#update_conversation_engagement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4178
- end
4179
- return data, status_code, headers
4180
- end
4181
- # Update status within the queue
4182
- # Update status within the queue
4183
- # @param queue_name
4184
- # @param status_request Status request
4185
- # @param [Hash] opts the optional parameters
4186
- # @return [nil]
4187
- def update_conversation_webchat_queue_status(queue_name, status_request, opts = {})
4188
- update_conversation_webchat_queue_status_with_http_info(queue_name, status_request, opts)
4189
- nil
4190
- end
4191
-
4192
- # Update status within the queue
4193
- # Update status within the queue
4194
- # @param queue_name
4195
- # @param status_request Status request
4196
- # @param [Hash] opts the optional parameters
4197
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
4198
- def update_conversation_webchat_queue_status_with_http_info(queue_name, status_request, opts = {})
4199
- if @api_client.config.debugging
4200
- @api_client.config.logger.debug 'Calling API: ConversationApi.update_conversation_webchat_queue_status ...'
4201
- end
4202
- # verify the required parameter 'queue_name' is set
4203
- if @api_client.config.client_side_validation && queue_name.nil?
4204
- fail ArgumentError, "Missing the required parameter 'queue_name' when calling ConversationApi.update_conversation_webchat_queue_status"
4205
- end
4206
- # verify the required parameter 'status_request' is set
4207
- if @api_client.config.client_side_validation && status_request.nil?
4208
- fail ArgumentError, "Missing the required parameter 'status_request' when calling ConversationApi.update_conversation_webchat_queue_status"
4209
- end
4210
- # resource path
4211
- local_var_path = '/conversation/conversations/queues/{queue_name}/status'.sub('{' + 'queue_name' + '}', queue_name.to_s)
4212
-
4213
- # query parameters
4214
- query_params = {}
4215
-
4216
- # header parameters
4217
- header_params = {}
4218
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
4219
- # HTTP header 'Accept' (if needed)
4220
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4221
- # HTTP header 'Content-Type'
4222
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4223
-
4224
- # form parameters
4225
- form_params = {}
4226
-
4227
- # http body (model)
4228
- post_body = @api_client.object_to_http_body(status_request)
4229
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
4230
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4231
- :header_params => header_params,
4232
- :query_params => query_params,
4233
- :form_params => form_params,
4234
- :body => post_body,
4235
- :auth_names => auth_names)
4236
- if @api_client.config.debugging
4237
- @api_client.config.logger.debug "API called: ConversationApi#update_conversation_webchat_queue_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4238
- end
4239
- return data, status_code, headers
4240
- end
4241
- # Update pbx agent
4242
- # Update a pbx agent
4243
- # @param conversation_pbx_agent_uuid
4244
- # @param pbx_agent Pbx Agent
4245
- # @param [Hash] opts the optional parameters
4246
- # @return [ConversationPbxAgentResponse]
4247
- def update_pbx_agent(conversation_pbx_agent_uuid, pbx_agent, opts = {})
4248
- data, _status_code, _headers = update_pbx_agent_with_http_info(conversation_pbx_agent_uuid, pbx_agent, opts)
4249
- data
4250
- end
4251
-
4252
- # Update pbx agent
4253
- # Update a pbx agent
4254
- # @param conversation_pbx_agent_uuid
4255
- # @param pbx_agent Pbx Agent
4256
- # @param [Hash] opts the optional parameters
4257
- # @return [Array<(ConversationPbxAgentResponse, Fixnum, Hash)>] ConversationPbxAgentResponse data, response status code and response headers
4258
- def update_pbx_agent_with_http_info(conversation_pbx_agent_uuid, pbx_agent, opts = {})
4259
- if @api_client.config.debugging
4260
- @api_client.config.logger.debug 'Calling API: ConversationApi.update_pbx_agent ...'
4261
- end
4262
- # verify the required parameter 'conversation_pbx_agent_uuid' is set
4263
- if @api_client.config.client_side_validation && conversation_pbx_agent_uuid.nil?
4264
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_agent_uuid' when calling ConversationApi.update_pbx_agent"
4265
- end
4266
- # verify the required parameter 'pbx_agent' is set
4267
- if @api_client.config.client_side_validation && pbx_agent.nil?
4268
- fail ArgumentError, "Missing the required parameter 'pbx_agent' when calling ConversationApi.update_pbx_agent"
4269
- end
4270
- # resource path
4271
- local_var_path = '/conversation/pbx/agent/{conversationPbxAgentUuid}'.sub('{' + 'conversationPbxAgentUuid' + '}', conversation_pbx_agent_uuid.to_s)
4272
-
4273
- # query parameters
4274
- query_params = {}
4275
-
4276
- # header parameters
4277
- header_params = {}
4278
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
4279
- # HTTP header 'Accept' (if needed)
4280
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4281
- # HTTP header 'Content-Type'
4282
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4283
-
4284
- # form parameters
4285
- form_params = {}
4286
-
4287
- # http body (model)
4288
- post_body = @api_client.object_to_http_body(pbx_agent)
4289
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
4290
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4291
- :header_params => header_params,
4292
- :query_params => query_params,
4293
- :form_params => form_params,
4294
- :body => post_body,
4295
- :auth_names => auth_names,
4296
- :return_type => 'ConversationPbxAgentResponse')
4297
- if @api_client.config.debugging
4298
- @api_client.config.logger.debug "API called: ConversationApi#update_pbx_agent\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4299
- end
4300
- return data, status_code, headers
4301
- end
4302
- # Update pbx audio
4303
- # Update a pbx audio
4304
- # @param conversation_pbx_audio_uuid
4305
- # @param pbx_audio Pbx Audio
4306
- # @param [Hash] opts the optional parameters
4307
- # @return [ConversationPbxAudioResponse]
4308
- def update_pbx_audio(conversation_pbx_audio_uuid, pbx_audio, opts = {})
4309
- data, _status_code, _headers = update_pbx_audio_with_http_info(conversation_pbx_audio_uuid, pbx_audio, opts)
4310
- data
4311
- end
4312
-
4313
- # Update pbx audio
4314
- # Update a pbx audio
4315
- # @param conversation_pbx_audio_uuid
4316
- # @param pbx_audio Pbx Audio
4317
- # @param [Hash] opts the optional parameters
4318
- # @return [Array<(ConversationPbxAudioResponse, Fixnum, Hash)>] ConversationPbxAudioResponse data, response status code and response headers
4319
- def update_pbx_audio_with_http_info(conversation_pbx_audio_uuid, pbx_audio, opts = {})
4320
- if @api_client.config.debugging
4321
- @api_client.config.logger.debug 'Calling API: ConversationApi.update_pbx_audio ...'
4322
- end
4323
- # verify the required parameter 'conversation_pbx_audio_uuid' is set
4324
- if @api_client.config.client_side_validation && conversation_pbx_audio_uuid.nil?
4325
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_audio_uuid' when calling ConversationApi.update_pbx_audio"
4326
- end
4327
- # verify the required parameter 'pbx_audio' is set
4328
- if @api_client.config.client_side_validation && pbx_audio.nil?
4329
- fail ArgumentError, "Missing the required parameter 'pbx_audio' when calling ConversationApi.update_pbx_audio"
4330
- end
4331
- # resource path
4332
- local_var_path = '/conversation/pbx/audio/{conversationPbxAudioUuid}'.sub('{' + 'conversationPbxAudioUuid' + '}', conversation_pbx_audio_uuid.to_s)
4333
-
4334
- # query parameters
4335
- query_params = {}
4336
-
4337
- # header parameters
4338
- header_params = {}
4339
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
4340
- # HTTP header 'Accept' (if needed)
4341
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4342
- # HTTP header 'Content-Type'
4343
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4344
-
4345
- # form parameters
4346
- form_params = {}
4347
-
4348
- # http body (model)
4349
- post_body = @api_client.object_to_http_body(pbx_audio)
4350
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
4351
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4352
- :header_params => header_params,
4353
- :query_params => query_params,
4354
- :form_params => form_params,
4355
- :body => post_body,
4356
- :auth_names => auth_names,
4357
- :return_type => 'ConversationPbxAudioResponse')
4358
- if @api_client.config.debugging
4359
- @api_client.config.logger.debug "API called: ConversationApi#update_pbx_audio\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4360
- end
4361
- return data, status_code, headers
4362
- end
4363
- # Update pbx menu
4364
- # Update a pbx menu
4365
- # @param conversation_pbx_menu_uuid
4366
- # @param pbx_menu Pbx Menu
4367
- # @param [Hash] opts the optional parameters
4368
- # @return [ConversationPbxMenuResponse]
4369
- def update_pbx_menu(conversation_pbx_menu_uuid, pbx_menu, opts = {})
4370
- data, _status_code, _headers = update_pbx_menu_with_http_info(conversation_pbx_menu_uuid, pbx_menu, opts)
4371
- data
4372
- end
4373
-
4374
- # Update pbx menu
4375
- # Update a pbx menu
4376
- # @param conversation_pbx_menu_uuid
4377
- # @param pbx_menu Pbx Menu
4378
- # @param [Hash] opts the optional parameters
4379
- # @return [Array<(ConversationPbxMenuResponse, Fixnum, Hash)>] ConversationPbxMenuResponse data, response status code and response headers
4380
- def update_pbx_menu_with_http_info(conversation_pbx_menu_uuid, pbx_menu, opts = {})
4381
- if @api_client.config.debugging
4382
- @api_client.config.logger.debug 'Calling API: ConversationApi.update_pbx_menu ...'
4383
- end
4384
- # verify the required parameter 'conversation_pbx_menu_uuid' is set
4385
- if @api_client.config.client_side_validation && conversation_pbx_menu_uuid.nil?
4386
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_menu_uuid' when calling ConversationApi.update_pbx_menu"
4387
- end
4388
- # verify the required parameter 'pbx_menu' is set
4389
- if @api_client.config.client_side_validation && pbx_menu.nil?
4390
- fail ArgumentError, "Missing the required parameter 'pbx_menu' when calling ConversationApi.update_pbx_menu"
4391
- end
4392
- # resource path
4393
- local_var_path = '/conversation/pbx/menu/{conversationPbxMenuUuid}'.sub('{' + 'conversationPbxMenuUuid' + '}', conversation_pbx_menu_uuid.to_s)
4394
-
4395
- # query parameters
4396
- query_params = {}
4397
-
4398
- # header parameters
4399
- header_params = {}
4400
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
4401
- # HTTP header 'Accept' (if needed)
4402
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4403
- # HTTP header 'Content-Type'
4404
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4405
-
4406
- # form parameters
4407
- form_params = {}
4408
-
4409
- # http body (model)
4410
- post_body = @api_client.object_to_http_body(pbx_menu)
4411
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
4412
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4413
- :header_params => header_params,
4414
- :query_params => query_params,
4415
- :form_params => form_params,
4416
- :body => post_body,
4417
- :auth_names => auth_names,
4418
- :return_type => 'ConversationPbxMenuResponse')
4419
- if @api_client.config.debugging
4420
- @api_client.config.logger.debug "API called: ConversationApi#update_pbx_menu\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4421
- end
4422
- return data, status_code, headers
4423
- end
4424
- # Update pbx phoneNumber
4425
- # Update a pbx phoneNumber
4426
- # @param conversation_pbx_phone_number_uuid
4427
- # @param pbx_phone_number Pbx PhoneNumber
4428
- # @param [Hash] opts the optional parameters
4429
- # @return [ConversationPbxPhoneNumberResponse]
4430
- def update_pbx_phone_number(conversation_pbx_phone_number_uuid, pbx_phone_number, opts = {})
4431
- data, _status_code, _headers = update_pbx_phone_number_with_http_info(conversation_pbx_phone_number_uuid, pbx_phone_number, opts)
4432
- data
4433
- end
4434
-
4435
- # Update pbx phoneNumber
4436
- # Update a pbx phoneNumber
4437
- # @param conversation_pbx_phone_number_uuid
4438
- # @param pbx_phone_number Pbx PhoneNumber
4439
- # @param [Hash] opts the optional parameters
4440
- # @return [Array<(ConversationPbxPhoneNumberResponse, Fixnum, Hash)>] ConversationPbxPhoneNumberResponse data, response status code and response headers
4441
- def update_pbx_phone_number_with_http_info(conversation_pbx_phone_number_uuid, pbx_phone_number, opts = {})
4442
- if @api_client.config.debugging
4443
- @api_client.config.logger.debug 'Calling API: ConversationApi.update_pbx_phone_number ...'
4444
- end
4445
- # verify the required parameter 'conversation_pbx_phone_number_uuid' is set
4446
- if @api_client.config.client_side_validation && conversation_pbx_phone_number_uuid.nil?
4447
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_phone_number_uuid' when calling ConversationApi.update_pbx_phone_number"
4448
- end
4449
- # verify the required parameter 'pbx_phone_number' is set
4450
- if @api_client.config.client_side_validation && pbx_phone_number.nil?
4451
- fail ArgumentError, "Missing the required parameter 'pbx_phone_number' when calling ConversationApi.update_pbx_phone_number"
4452
- end
4453
- # resource path
4454
- local_var_path = '/conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid}'.sub('{' + 'conversationPbxPhoneNumberUuid' + '}', conversation_pbx_phone_number_uuid.to_s)
4455
-
4456
- # query parameters
4457
- query_params = {}
4458
-
4459
- # header parameters
4460
- header_params = {}
4461
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
4462
- # HTTP header 'Accept' (if needed)
4463
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4464
- # HTTP header 'Content-Type'
4465
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4466
-
4467
- # form parameters
4468
- form_params = {}
4469
-
4470
- # http body (model)
4471
- post_body = @api_client.object_to_http_body(pbx_phone_number)
4472
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
4473
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4474
- :header_params => header_params,
4475
- :query_params => query_params,
4476
- :form_params => form_params,
4477
- :body => post_body,
4478
- :auth_names => auth_names,
4479
- :return_type => 'ConversationPbxPhoneNumberResponse')
4480
- if @api_client.config.debugging
4481
- @api_client.config.logger.debug "API called: ConversationApi#update_pbx_phone_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4482
- end
4483
- return data, status_code, headers
4484
- end
4485
- # Update pbx queue
4486
- # Update a pbx queue
4487
- # @param conversation_pbx_queue_uuid
4488
- # @param pbx_queue Pbx Queue
4489
- # @param [Hash] opts the optional parameters
4490
- # @return [ConversationPbxQueueResponse]
4491
- def update_pbx_queue(conversation_pbx_queue_uuid, pbx_queue, opts = {})
4492
- data, _status_code, _headers = update_pbx_queue_with_http_info(conversation_pbx_queue_uuid, pbx_queue, opts)
4493
- data
4494
- end
4495
-
4496
- # Update pbx queue
4497
- # Update a pbx queue
4498
- # @param conversation_pbx_queue_uuid
4499
- # @param pbx_queue Pbx Queue
4500
- # @param [Hash] opts the optional parameters
4501
- # @return [Array<(ConversationPbxQueueResponse, Fixnum, Hash)>] ConversationPbxQueueResponse data, response status code and response headers
4502
- def update_pbx_queue_with_http_info(conversation_pbx_queue_uuid, pbx_queue, opts = {})
4503
- if @api_client.config.debugging
4504
- @api_client.config.logger.debug 'Calling API: ConversationApi.update_pbx_queue ...'
4505
- end
4506
- # verify the required parameter 'conversation_pbx_queue_uuid' is set
4507
- if @api_client.config.client_side_validation && conversation_pbx_queue_uuid.nil?
4508
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_queue_uuid' when calling ConversationApi.update_pbx_queue"
4509
- end
4510
- # verify the required parameter 'pbx_queue' is set
4511
- if @api_client.config.client_side_validation && pbx_queue.nil?
4512
- fail ArgumentError, "Missing the required parameter 'pbx_queue' when calling ConversationApi.update_pbx_queue"
4513
- end
4514
- # resource path
4515
- local_var_path = '/conversation/pbx/queue/{conversationPbxQueueUuid}'.sub('{' + 'conversationPbxQueueUuid' + '}', conversation_pbx_queue_uuid.to_s)
4516
-
4517
- # query parameters
4518
- query_params = {}
4519
-
4520
- # header parameters
4521
- header_params = {}
4522
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
4523
- # HTTP header 'Accept' (if needed)
4524
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4525
- # HTTP header 'Content-Type'
4526
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4527
-
4528
- # form parameters
4529
- form_params = {}
4530
-
4531
- # http body (model)
4532
- post_body = @api_client.object_to_http_body(pbx_queue)
4533
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
4534
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4535
- :header_params => header_params,
4536
- :query_params => query_params,
4537
- :form_params => form_params,
4538
- :body => post_body,
4539
- :auth_names => auth_names,
4540
- :return_type => 'ConversationPbxQueueResponse')
4541
- if @api_client.config.debugging
4542
- @api_client.config.logger.debug "API called: ConversationApi#update_pbx_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4543
- end
4544
- return data, status_code, headers
4545
- end
4546
- # Update pbx timeBased
4547
- # Update a pbx timeBased
4548
- # @param conversation_pbx_time_based_uuid
4549
- # @param pbx_time_based Pbx TimeBased
4550
- # @param [Hash] opts the optional parameters
4551
- # @return [ConversationPbxTimeBasedResponse]
4552
- def update_pbx_time_based(conversation_pbx_time_based_uuid, pbx_time_based, opts = {})
4553
- data, _status_code, _headers = update_pbx_time_based_with_http_info(conversation_pbx_time_based_uuid, pbx_time_based, opts)
4554
- data
4555
- end
4556
-
4557
- # Update pbx timeBased
4558
- # Update a pbx timeBased
4559
- # @param conversation_pbx_time_based_uuid
4560
- # @param pbx_time_based Pbx TimeBased
4561
- # @param [Hash] opts the optional parameters
4562
- # @return [Array<(ConversationPbxTimeBasedResponse, Fixnum, Hash)>] ConversationPbxTimeBasedResponse data, response status code and response headers
4563
- def update_pbx_time_based_with_http_info(conversation_pbx_time_based_uuid, pbx_time_based, opts = {})
4564
- if @api_client.config.debugging
4565
- @api_client.config.logger.debug 'Calling API: ConversationApi.update_pbx_time_based ...'
4566
- end
4567
- # verify the required parameter 'conversation_pbx_time_based_uuid' is set
4568
- if @api_client.config.client_side_validation && conversation_pbx_time_based_uuid.nil?
4569
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_time_based_uuid' when calling ConversationApi.update_pbx_time_based"
4570
- end
4571
- # verify the required parameter 'pbx_time_based' is set
4572
- if @api_client.config.client_side_validation && pbx_time_based.nil?
4573
- fail ArgumentError, "Missing the required parameter 'pbx_time_based' when calling ConversationApi.update_pbx_time_based"
4574
- end
4575
- # resource path
4576
- local_var_path = '/conversation/pbx/time_based/{conversationPbxTimeBasedUuid}'.sub('{' + 'conversationPbxTimeBasedUuid' + '}', conversation_pbx_time_based_uuid.to_s)
4577
-
4578
- # query parameters
4579
- query_params = {}
4580
-
4581
- # header parameters
4582
- header_params = {}
4583
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
4584
- # HTTP header 'Accept' (if needed)
4585
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4586
- # HTTP header 'Content-Type'
4587
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4588
-
4589
- # form parameters
4590
- form_params = {}
4591
-
4592
- # http body (model)
4593
- post_body = @api_client.object_to_http_body(pbx_time_based)
4594
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
4595
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4596
- :header_params => header_params,
4597
- :query_params => query_params,
4598
- :form_params => form_params,
4599
- :body => post_body,
4600
- :auth_names => auth_names,
4601
- :return_type => 'ConversationPbxTimeBasedResponse')
4602
- if @api_client.config.debugging
4603
- @api_client.config.logger.debug "API called: ConversationApi#update_pbx_time_based\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4604
- end
4605
- return data, status_code, headers
4606
- end
4607
- # Update pbx timeRange
4608
- # Update a pbx timeRange
4609
- # @param conversation_pbx_time_range_uuid
4610
- # @param pbx_time_range Pbx TimeRange
4611
- # @param [Hash] opts the optional parameters
4612
- # @return [ConversationPbxTimeRangeResponse]
4613
- def update_pbx_time_range(conversation_pbx_time_range_uuid, pbx_time_range, opts = {})
4614
- data, _status_code, _headers = update_pbx_time_range_with_http_info(conversation_pbx_time_range_uuid, pbx_time_range, opts)
4615
- data
4616
- end
4617
-
4618
- # Update pbx timeRange
4619
- # Update a pbx timeRange
4620
- # @param conversation_pbx_time_range_uuid
4621
- # @param pbx_time_range Pbx TimeRange
4622
- # @param [Hash] opts the optional parameters
4623
- # @return [Array<(ConversationPbxTimeRangeResponse, Fixnum, Hash)>] ConversationPbxTimeRangeResponse data, response status code and response headers
4624
- def update_pbx_time_range_with_http_info(conversation_pbx_time_range_uuid, pbx_time_range, opts = {})
4625
- if @api_client.config.debugging
4626
- @api_client.config.logger.debug 'Calling API: ConversationApi.update_pbx_time_range ...'
4627
- end
4628
- # verify the required parameter 'conversation_pbx_time_range_uuid' is set
4629
- if @api_client.config.client_side_validation && conversation_pbx_time_range_uuid.nil?
4630
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_time_range_uuid' when calling ConversationApi.update_pbx_time_range"
4631
- end
4632
- # verify the required parameter 'pbx_time_range' is set
4633
- if @api_client.config.client_side_validation && pbx_time_range.nil?
4634
- fail ArgumentError, "Missing the required parameter 'pbx_time_range' when calling ConversationApi.update_pbx_time_range"
4635
- end
4636
- # resource path
4637
- local_var_path = '/conversation/pbx/time_range/{conversationPbxTimeRangeUuid}'.sub('{' + 'conversationPbxTimeRangeUuid' + '}', conversation_pbx_time_range_uuid.to_s)
4638
-
4639
- # query parameters
4640
- query_params = {}
4641
-
4642
- # header parameters
4643
- header_params = {}
4644
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
4645
- # HTTP header 'Accept' (if needed)
4646
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4647
- # HTTP header 'Content-Type'
4648
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4649
-
4650
- # form parameters
4651
- form_params = {}
4652
-
4653
- # http body (model)
4654
- post_body = @api_client.object_to_http_body(pbx_time_range)
4655
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
4656
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4657
- :header_params => header_params,
4658
- :query_params => query_params,
4659
- :form_params => form_params,
4660
- :body => post_body,
4661
- :auth_names => auth_names,
4662
- :return_type => 'ConversationPbxTimeRangeResponse')
4663
- if @api_client.config.debugging
4664
- @api_client.config.logger.debug "API called: ConversationApi#update_pbx_time_range\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4665
- end
4666
- return data, status_code, headers
4667
- end
4668
- # Update pbx voicemailMailbox
4669
- # Update a pbx voicemailMailbox
4670
- # @param conversation_pbx_voicemail_mailbox_uuid
4671
- # @param pbx_voicemail_mailbox Pbx VoicemailMailbox
4672
- # @param [Hash] opts the optional parameters
4673
- # @return [ConversationPbxVoicemailMailboxResponse]
4674
- def update_pbx_voicemail_mailbox(conversation_pbx_voicemail_mailbox_uuid, pbx_voicemail_mailbox, opts = {})
4675
- data, _status_code, _headers = update_pbx_voicemail_mailbox_with_http_info(conversation_pbx_voicemail_mailbox_uuid, pbx_voicemail_mailbox, opts)
4676
- data
4677
- end
4678
-
4679
- # Update pbx voicemailMailbox
4680
- # Update a pbx voicemailMailbox
4681
- # @param conversation_pbx_voicemail_mailbox_uuid
4682
- # @param pbx_voicemail_mailbox Pbx VoicemailMailbox
4683
- # @param [Hash] opts the optional parameters
4684
- # @return [Array<(ConversationPbxVoicemailMailboxResponse, Fixnum, Hash)>] ConversationPbxVoicemailMailboxResponse data, response status code and response headers
4685
- def update_pbx_voicemail_mailbox_with_http_info(conversation_pbx_voicemail_mailbox_uuid, pbx_voicemail_mailbox, opts = {})
4686
- if @api_client.config.debugging
4687
- @api_client.config.logger.debug 'Calling API: ConversationApi.update_pbx_voicemail_mailbox ...'
4688
- end
4689
- # verify the required parameter 'conversation_pbx_voicemail_mailbox_uuid' is set
4690
- if @api_client.config.client_side_validation && conversation_pbx_voicemail_mailbox_uuid.nil?
4691
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_voicemail_mailbox_uuid' when calling ConversationApi.update_pbx_voicemail_mailbox"
4692
- end
4693
- # verify the required parameter 'pbx_voicemail_mailbox' is set
4694
- if @api_client.config.client_side_validation && pbx_voicemail_mailbox.nil?
4695
- fail ArgumentError, "Missing the required parameter 'pbx_voicemail_mailbox' when calling ConversationApi.update_pbx_voicemail_mailbox"
4696
- end
4697
- # resource path
4698
- local_var_path = '/conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid}'.sub('{' + 'conversationPbxVoicemailMailboxUuid' + '}', conversation_pbx_voicemail_mailbox_uuid.to_s)
4699
-
4700
- # query parameters
4701
- query_params = {}
4702
-
4703
- # header parameters
4704
- header_params = {}
4705
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
4706
- # HTTP header 'Accept' (if needed)
4707
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4708
- # HTTP header 'Content-Type'
4709
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4710
-
4711
- # form parameters
4712
- form_params = {}
4713
-
4714
- # http body (model)
4715
- post_body = @api_client.object_to_http_body(pbx_voicemail_mailbox)
4716
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
4717
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4718
- :header_params => header_params,
4719
- :query_params => query_params,
4720
- :form_params => form_params,
4721
- :body => post_body,
4722
- :auth_names => auth_names,
4723
- :return_type => 'ConversationPbxVoicemailMailboxResponse')
4724
- if @api_client.config.debugging
4725
- @api_client.config.logger.debug "API called: ConversationApi#update_pbx_voicemail_mailbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4726
- end
4727
- return data, status_code, headers
4728
- end
4729
- # Update virtual agent budget
4730
- # Update virtual agent budget
4731
- # @param virtual_agent_budget Virtual Agent Budget
4732
- # @param [Hash] opts the optional parameters
4733
- # @return [ConversationVirtualAgentBudgetResponse]
4734
- def update_virtual_agent_budget(virtual_agent_budget, opts = {})
4735
- data, _status_code, _headers = update_virtual_agent_budget_with_http_info(virtual_agent_budget, opts)
4736
- data
4737
- end
4738
-
4739
- # Update virtual agent budget
4740
- # Update virtual agent budget
4741
- # @param virtual_agent_budget Virtual Agent Budget
4742
- # @param [Hash] opts the optional parameters
4743
- # @return [Array<(ConversationVirtualAgentBudgetResponse, Fixnum, Hash)>] ConversationVirtualAgentBudgetResponse data, response status code and response headers
4744
- def update_virtual_agent_budget_with_http_info(virtual_agent_budget, opts = {})
4745
- if @api_client.config.debugging
4746
- @api_client.config.logger.debug 'Calling API: ConversationApi.update_virtual_agent_budget ...'
4747
- end
4748
- # verify the required parameter 'virtual_agent_budget' is set
4749
- if @api_client.config.client_side_validation && virtual_agent_budget.nil?
4750
- fail ArgumentError, "Missing the required parameter 'virtual_agent_budget' when calling ConversationApi.update_virtual_agent_budget"
4751
- end
4752
- # resource path
4753
- local_var_path = '/conversation/virtualagent/budget'
4754
-
4755
- # query parameters
4756
- query_params = {}
4757
-
4758
- # header parameters
4759
- header_params = {}
4760
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
4761
- # HTTP header 'Accept' (if needed)
4762
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4763
- # HTTP header 'Content-Type'
4764
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4765
-
4766
- # form parameters
4767
- form_params = {}
4768
-
4769
- # http body (model)
4770
- post_body = @api_client.object_to_http_body(virtual_agent_budget)
4771
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
4772
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4773
- :header_params => header_params,
4774
- :query_params => query_params,
4775
- :form_params => form_params,
4776
- :body => post_body,
4777
- :auth_names => auth_names,
4778
- :return_type => 'ConversationVirtualAgentBudgetResponse')
4779
- if @api_client.config.debugging
4780
- @api_client.config.logger.debug "API called: ConversationApi#update_virtual_agent_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4781
- end
4782
- return data, status_code, headers
4783
- end
4784
- # Update virtual agent capabilities
4785
- # Update virtual agent capabilities
4786
- # @param virtual_agent_capabilities Virtual Agent Capabilities
4787
- # @param [Hash] opts the optional parameters
4788
- # @return [ConversationVirtualAgentCapabilitiesResponse]
4789
- def update_virtual_agent_capabilities(virtual_agent_capabilities, opts = {})
4790
- data, _status_code, _headers = update_virtual_agent_capabilities_with_http_info(virtual_agent_capabilities, opts)
4791
- data
4792
- end
4793
-
4794
- # Update virtual agent capabilities
4795
- # Update virtual agent capabilities
4796
- # @param virtual_agent_capabilities Virtual Agent Capabilities
4797
- # @param [Hash] opts the optional parameters
4798
- # @return [Array<(ConversationVirtualAgentCapabilitiesResponse, Fixnum, Hash)>] ConversationVirtualAgentCapabilitiesResponse data, response status code and response headers
4799
- def update_virtual_agent_capabilities_with_http_info(virtual_agent_capabilities, opts = {})
4800
- if @api_client.config.debugging
4801
- @api_client.config.logger.debug 'Calling API: ConversationApi.update_virtual_agent_capabilities ...'
4802
- end
4803
- # verify the required parameter 'virtual_agent_capabilities' is set
4804
- if @api_client.config.client_side_validation && virtual_agent_capabilities.nil?
4805
- fail ArgumentError, "Missing the required parameter 'virtual_agent_capabilities' when calling ConversationApi.update_virtual_agent_capabilities"
4806
- end
4807
- # resource path
4808
- local_var_path = '/conversation/virtualagent/capabilities'
4809
-
4810
- # query parameters
4811
- query_params = {}
4812
-
4813
- # header parameters
4814
- header_params = {}
4815
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
4816
- # HTTP header 'Accept' (if needed)
4817
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4818
- # HTTP header 'Content-Type'
4819
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4820
-
4821
- # form parameters
4822
- form_params = {}
4823
-
4824
- # http body (model)
4825
- post_body = @api_client.object_to_http_body(virtual_agent_capabilities)
4826
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
4827
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4828
- :header_params => header_params,
4829
- :query_params => query_params,
4830
- :form_params => form_params,
4831
- :body => post_body,
4832
- :auth_names => auth_names,
4833
- :return_type => 'ConversationVirtualAgentCapabilitiesResponse')
4834
- if @api_client.config.debugging
4835
- @api_client.config.logger.debug "API called: ConversationApi#update_virtual_agent_capabilities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4836
- end
4837
- return data, status_code, headers
4838
- end
4839
- end
4840
- end