ultracart_api 3.10.221 → 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 (1767) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +9 -7
  3. data/README.md +1166 -1713
  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 -617
  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 -578
  104. data/docs/ChannelPartnerCancelResponse.md +26 -12
  105. data/docs/ChannelPartnerEstimateShippingResponse.md +26 -12
  106. data/docs/ChannelPartnerEstimateTaxResponse.md +26 -12
  107. data/docs/ChannelPartnerImportResponse.md +30 -14
  108. data/docs/ChannelPartnerOrder.md +176 -98
  109. data/docs/ChannelPartnerOrderItem.md +30 -14
  110. data/docs/ChannelPartnerOrderItemOption.md +20 -9
  111. data/docs/ChannelPartnerOrderTransaction.md +20 -9
  112. data/docs/ChannelPartnerOrderTransactionDetail.md +20 -9
  113. data/docs/ChannelPartnerShippingEstimate.md +20 -9
  114. data/docs/ChargebackApi.md +420 -301
  115. data/docs/ChargebackDispute.md +62 -30
  116. data/docs/ChargebackDisputeResponse.md +26 -12
  117. data/docs/ChargebackDisputesResponse.md +26 -12
  118. data/docs/CheckoutAllowedCountriesResponse.md +18 -8
  119. data/docs/CheckoutApi.md +1566 -1023
  120. data/docs/CheckoutHandoffRequest.md +32 -15
  121. data/docs/CheckoutHandoffResponse.md +22 -10
  122. data/docs/CheckoutSetupBrowserKeyRequest.md +18 -8
  123. data/docs/CheckoutSetupBrowserKeyResponse.md +18 -8
  124. data/docs/CheckoutStateProvinceResponse.md +18 -8
  125. data/docs/CityStateZip.md +26 -12
  126. data/docs/CountriesResponse.md +18 -8
  127. data/docs/Country.md +20 -9
  128. data/docs/Coupon.md +136 -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 -36
  209. data/docs/CustomerQuotesSummary.md +24 -11
  210. data/docs/CustomerResponse.md +26 -12
  211. data/docs/CustomerReviewer.md +36 -17
  212. data/docs/CustomerShipping.md +50 -24
  213. data/docs/CustomerSoftwareEntitlement.md +32 -15
  214. data/docs/CustomerStoreCredit.md +28 -13
  215. data/docs/CustomerStoreCreditAddRequest.md +24 -11
  216. data/docs/CustomerStoreCreditLedgerEntry.md +30 -14
  217. data/docs/CustomerStoreCreditResponse.md +26 -12
  218. data/docs/CustomerTag.md +18 -8
  219. data/docs/CustomerTaxCodes.md +26 -12
  220. data/docs/CustomersResponse.md +26 -12
  221. data/docs/DataTablesServerSideResponse.md +24 -11
  222. data/docs/Distance.md +20 -9
  223. data/docs/DistributionCenter.md +86 -57
  224. data/docs/DistributionCentersResponse.md +26 -12
  225. data/docs/EmailBaseTemplateListResponse.md +18 -8
  226. data/docs/EmailCampaign.md +64 -33
  227. data/docs/EmailCampaignFolder.md +26 -12
  228. data/docs/EmailCampaignFolderResponse.md +26 -12
  229. data/docs/EmailCampaignFoldersResponse.md +26 -12
  230. data/docs/EmailCampaignResponse.md +26 -12
  231. data/docs/EmailCampaignsResponse.md +26 -12
  232. data/docs/EmailClick.md +20 -9
  233. data/docs/EmailClicksResponse.md +26 -12
  234. data/docs/EmailCommseq.md +24 -11
  235. data/docs/EmailCommseqEmail.md +68 -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 -12
  411. data/docs/ItemPhysical.md +24 -11
  412. data/docs/ItemPricing.md +52 -25
  413. data/docs/ItemPricingTier.md +26 -12
  414. data/docs/ItemPricingTierDiscount.md +20 -9
  415. data/docs/ItemPricingTierLimit.md +22 -12
  416. data/docs/ItemProperty.md +22 -10
  417. data/docs/ItemRealtimePricing.md +22 -10
  418. data/docs/ItemRelated.md +22 -10
  419. data/docs/ItemRelatedItem.md +22 -10
  420. data/docs/ItemReporting.md +20 -9
  421. data/docs/ItemResponse.md +26 -12
  422. data/docs/ItemRestriction.md +32 -15
  423. data/docs/ItemRestrictionItem.md +22 -10
  424. data/docs/ItemRevguard.md +30 -14
  425. data/docs/ItemReviews.md +34 -17
  426. data/docs/ItemSalesforce.md +20 -9
  427. data/docs/ItemShipping.md +112 -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 -45
  470. data/docs/OrderAffiliate.md +22 -10
  471. data/docs/OrderAffiliateLedger.md +34 -16
  472. data/docs/OrderApi.md +1856 -1522
  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 -72
  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 -26
  501. data/docs/OrderPaymentCheck.md +18 -8
  502. data/docs/OrderPaymentCreditCard.md +38 -19
  503. data/docs/OrderPaymentECheck.md +36 -17
  504. data/docs/OrderPaymentInsurance.md +24 -11
  505. data/docs/OrderPaymentPurchaseOrder.md +18 -8
  506. data/docs/OrderPaymentTransaction.md +24 -12
  507. data/docs/OrderPaymentTransactionDetail.md +22 -10
  508. data/docs/OrderProcessPaymentRequest.md +20 -9
  509. data/docs/OrderProcessPaymentResponse.md +26 -12
  510. data/docs/OrderProperty.md +24 -11
  511. data/docs/OrderQuery.md +94 -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 -29
  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 -447
  644. data/docs/WebhookEventCategory.md +26 -12
  645. data/docs/WebhookEventSubscription.md +34 -17
  646. data/docs/WebhookLog.md +38 -19
  647. data/docs/WebhookLogResponse.md +26 -12
  648. data/docs/WebhookLogSummariesResponse.md +26 -12
  649. data/docs/WebhookLogSummary.md +22 -10
  650. data/docs/WebhookResponse.md +26 -12
  651. data/docs/WebhookSampleRequest.md +24 -11
  652. data/docs/WebhookSampleRequestResponse.md +26 -12
  653. data/docs/WebhooksResponse.md +26 -12
  654. data/docs/Weight.md +20 -9
  655. data/git_push.sh +57 -55
  656. data/lib/ultracart_api/api/affiliate_api.rb +191 -164
  657. data/lib/ultracart_api/api/auto_order_api.rb +672 -706
  658. data/lib/ultracart_api/api/channel_partner_api.rb +370 -664
  659. data/lib/ultracart_api/api/chargeback_api.rb +410 -356
  660. data/lib/ultracart_api/api/checkout_api.rb +1341 -1111
  661. data/lib/ultracart_api/api/coupon_api.rb +1390 -1161
  662. data/lib/ultracart_api/api/customer_api.rb +1292 -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 -1703
  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 -514
  674. data/lib/ultracart_api/api_client.rb +399 -400
  675. data/lib/ultracart_api/api_error.rb +57 -38
  676. data/lib/ultracart_api/configuration.rb +302 -229
  677. data/lib/ultracart_api/models/accounts_receivable_retry_config.rb +364 -341
  678. data/lib/ultracart_api/models/accounts_receivable_retry_config_response.rb +287 -252
  679. data/lib/ultracart_api/models/accounts_receivable_retry_day_activity.rb +240 -205
  680. data/lib/ultracart_api/models/accounts_receivable_retry_stat_account.rb +250 -215
  681. data/lib/ultracart_api/models/accounts_receivable_retry_stat_metrics.rb +309 -274
  682. data/lib/ultracart_api/models/accounts_receivable_retry_stat_revenue.rb +228 -193
  683. data/lib/ultracart_api/models/accounts_receivable_retry_stats_response.rb +267 -232
  684. data/lib/ultracart_api/models/activity.rb +264 -247
  685. data/lib/ultracart_api/models/add_library_item_request.rb +324 -289
  686. data/lib/ultracart_api/models/adjust_internal_certificate_request.rb +270 -235
  687. data/lib/ultracart_api/models/adjust_internal_certificate_response.rb +267 -232
  688. data/lib/ultracart_api/models/affiliate_click.rb +319 -304
  689. data/lib/ultracart_api/models/affiliate_click_query.rb +270 -235
  690. data/lib/ultracart_api/models/affiliate_clicks_response.rb +259 -224
  691. data/lib/ultracart_api/models/affiliate_ledger.rb +431 -396
  692. data/lib/ultracart_api/models/affiliate_ledger_query.rb +270 -235
  693. data/lib/ultracart_api/models/affiliate_ledgers_response.rb +259 -224
  694. data/lib/ultracart_api/models/affiliate_link.rb +408 -373
  695. data/lib/ultracart_api/models/api_user_application_profile.rb +260 -225
  696. data/lib/ultracart_api/models/apply_library_item_request.rb +250 -215
  697. data/lib/ultracart_api/models/apply_library_item_response.rb +319 -284
  698. data/lib/ultracart_api/models/auto_order.rb +469 -485
  699. data/lib/ultracart_api/models/auto_order_item.rb +487 -492
  700. data/lib/ultracart_api/models/auto_order_item_future_schedule.rb +250 -215
  701. data/lib/ultracart_api/models/auto_order_item_option.rb +260 -225
  702. data/lib/ultracart_api/models/auto_order_item_simple_schedule.rb +274 -239
  703. data/lib/ultracart_api/models/auto_order_log.rb +230 -195
  704. data/lib/ultracart_api/models/auto_order_query.rb +480 -445
  705. data/lib/ultracart_api/models/auto_order_query_batch.rb +222 -187
  706. data/lib/ultracart_api/models/auto_order_response.rb +256 -221
  707. data/lib/ultracart_api/models/auto_orders_request.rb +222 -187
  708. data/lib/ultracart_api/models/auto_orders_response.rb +258 -223
  709. data/lib/ultracart_api/models/avalara_config.rb +340 -305
  710. data/lib/ultracart_api/models/base_response.rb +247 -212
  711. data/lib/ultracart_api/models/browser.rb +237 -202
  712. data/lib/ultracart_api/models/browser_device.rb +219 -184
  713. data/lib/ultracart_api/models/browser_os.rb +255 -220
  714. data/lib/ultracart_api/models/browser_user_agent.rb +246 -211
  715. data/lib/ultracart_api/models/cart.rb +506 -471
  716. data/lib/ultracart_api/models/cart_affiliate.rb +245 -210
  717. data/lib/ultracart_api/models/cart_affirm_checkout_response.rb +232 -197
  718. data/lib/ultracart_api/models/cart_billing.rb +572 -587
  719. data/lib/ultracart_api/models/cart_buysafe.rb +269 -234
  720. data/lib/ultracart_api/models/cart_checkout.rb +500 -550
  721. data/lib/ultracart_api/models/cart_coupon.rb +220 -185
  722. data/lib/ultracart_api/models/cart_currency_conversion.rb +232 -197
  723. data/lib/ultracart_api/models/cart_customer_profile.rb +438 -413
  724. data/lib/ultracart_api/models/cart_customer_profile_address.rb +350 -315
  725. data/lib/ultracart_api/models/cart_customer_profile_credit_card.rb +304 -269
  726. data/lib/ultracart_api/models/cart_finalize_order_request.rb +228 -193
  727. data/lib/ultracart_api/models/cart_finalize_order_request_options.rb +355 -320
  728. data/lib/ultracart_api/models/cart_finalize_order_response.rb +260 -225
  729. data/lib/ultracart_api/models/cart_gift.rb +313 -278
  730. data/lib/ultracart_api/models/cart_gift_certificate.rb +238 -203
  731. data/lib/ultracart_api/models/cart_item.rb +504 -481
  732. data/lib/ultracart_api/models/cart_item_attribute.rb +240 -205
  733. data/lib/ultracart_api/models/cart_item_multimedia.rb +336 -301
  734. data/lib/ultracart_api/models/cart_item_multimedia_thumbnail.rb +260 -225
  735. data/lib/ultracart_api/models/cart_item_option.rb +378 -343
  736. data/lib/ultracart_api/models/cart_item_option_value.rb +258 -223
  737. data/lib/ultracart_api/models/cart_item_physical.rb +246 -211
  738. data/lib/ultracart_api/models/cart_item_variation_selection.rb +230 -195
  739. data/lib/ultracart_api/models/cart_kit_component_option.rb +398 -363
  740. data/lib/ultracart_api/models/cart_marketing.rb +230 -205
  741. data/lib/ultracart_api/models/cart_payment.rb +275 -249
  742. data/lib/ultracart_api/models/cart_payment_affirm.rb +220 -185
  743. data/lib/ultracart_api/models/cart_payment_amazon.rb +220 -185
  744. data/lib/ultracart_api/models/cart_payment_check.rb +220 -185
  745. data/lib/ultracart_api/models/cart_payment_credit_card.rb +300 -265
  746. data/lib/ultracart_api/models/cart_payment_purchase_order.rb +220 -185
  747. data/lib/ultracart_api/models/cart_profile_login_request.rb +239 -204
  748. data/lib/ultracart_api/models/cart_profile_login_response.rb +231 -196
  749. data/lib/ultracart_api/models/cart_profile_register_request.rb +229 -194
  750. data/lib/ultracart_api/models/cart_profile_register_response.rb +231 -196
  751. data/lib/ultracart_api/models/cart_property.rb +280 -245
  752. data/lib/ultracart_api/models/cart_response.rb +231 -196
  753. data/lib/ultracart_api/models/cart_settings.rb +264 -229
  754. data/lib/ultracart_api/models/cart_settings_billing.rb +222 -187
  755. data/lib/ultracart_api/models/cart_settings_gift.rb +251 -216
  756. data/lib/ultracart_api/models/cart_settings_gift_wrap.rb +239 -204
  757. data/lib/ultracart_api/models/cart_settings_payment.rb +337 -302
  758. data/lib/ultracart_api/models/cart_settings_payment_amazon.rb +240 -205
  759. data/lib/ultracart_api/models/cart_settings_payment_credit_card.rb +242 -217
  760. data/lib/ultracart_api/models/cart_settings_payment_pay_pal.rb +260 -225
  761. data/lib/ultracart_api/models/cart_settings_province.rb +228 -193
  762. data/lib/ultracart_api/models/cart_settings_shipping.rb +262 -227
  763. data/lib/ultracart_api/models/cart_settings_shipping_calendar.rb +264 -229
  764. data/lib/ultracart_api/models/cart_settings_shipping_estimate.rb +345 -310
  765. data/lib/ultracart_api/models/cart_settings_taxes.rb +221 -186
  766. data/lib/ultracart_api/models/cart_settings_terms.rb +230 -195
  767. data/lib/ultracart_api/models/cart_shipping.rb +625 -590
  768. data/lib/ultracart_api/models/cart_summary.rb +354 -356
  769. data/lib/ultracart_api/models/cart_taxes.rb +255 -220
  770. data/lib/ultracart_api/models/cart_upsell_after.rb +255 -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 -1703
  778. data/lib/ultracart_api/models/channel_partner_order_item.rb +331 -296
  779. data/lib/ultracart_api/models/channel_partner_order_item_option.rb +230 -195
  780. data/lib/ultracart_api/models/channel_partner_order_transaction.rb +232 -197
  781. data/lib/ultracart_api/models/channel_partner_order_transaction_detail.rb +230 -195
  782. data/lib/ultracart_api/models/channel_partner_shipping_estimate.rb +230 -195
  783. data/lib/ultracart_api/models/chargeback_dispute.rb +649 -614
  784. data/lib/ultracart_api/models/chargeback_dispute_response.rb +256 -221
  785. data/lib/ultracart_api/models/chargeback_disputes_response.rb +258 -223
  786. data/lib/ultracart_api/models/checkout_allowed_countries_response.rb +221 -186
  787. data/lib/ultracart_api/models/checkout_handoff_request.rb +323 -288
  788. data/lib/ultracart_api/models/checkout_handoff_response.rb +241 -206
  789. data/lib/ultracart_api/models/checkout_setup_browser_key_request.rb +222 -187
  790. data/lib/ultracart_api/models/checkout_setup_browser_key_response.rb +220 -185
  791. data/lib/ultracart_api/models/checkout_state_province_response.rb +221 -186
  792. data/lib/ultracart_api/models/city_state_zip.rb +255 -220
  793. data/lib/ultracart_api/models/countries_response.rb +221 -186
  794. data/lib/ultracart_api/models/country.rb +260 -225
  795. data/lib/ultracart_api/models/coupon.rb +864 -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 -754
  874. data/lib/ultracart_api/models/customer_quotes_summary.rb +250 -215
  875. data/lib/ultracart_api/models/customer_response.rb +256 -221
  876. data/lib/ultracart_api/models/customer_reviewer.rb +310 -275
  877. data/lib/ultracart_api/models/customer_shipping.rb +575 -540
  878. data/lib/ultracart_api/models/customer_software_entitlement.rb +365 -330
  879. data/lib/ultracart_api/models/customer_store_credit.rb +274 -239
  880. data/lib/ultracart_api/models/customer_store_credit_add_request.rb +250 -215
  881. data/lib/ultracart_api/models/customer_store_credit_ledger_entry.rb +295 -260
  882. data/lib/ultracart_api/models/customer_store_credit_response.rb +256 -221
  883. data/lib/ultracart_api/models/customer_tag.rb +235 -200
  884. data/lib/ultracart_api/models/customer_tax_codes.rb +260 -225
  885. data/lib/ultracart_api/models/customers_response.rb +258 -223
  886. data/lib/ultracart_api/models/data_tables_server_side_response.rb +248 -213
  887. data/lib/ultracart_api/models/distance.rb +264 -229
  888. data/lib/ultracart_api/models/distribution_center.rb +559 -674
  889. data/lib/ultracart_api/models/distribution_centers_response.rb +258 -223
  890. data/lib/ultracart_api/models/email_base_template_list_response.rb +221 -186
  891. data/lib/ultracart_api/models/email_campaign.rb +467 -452
  892. data/lib/ultracart_api/models/email_campaign_folder.rb +275 -240
  893. data/lib/ultracart_api/models/email_campaign_folder_response.rb +256 -221
  894. data/lib/ultracart_api/models/email_campaign_folders_response.rb +258 -223
  895. data/lib/ultracart_api/models/email_campaign_response.rb +256 -221
  896. data/lib/ultracart_api/models/email_campaigns_response.rb +258 -223
  897. data/lib/ultracart_api/models/email_click.rb +230 -195
  898. data/lib/ultracart_api/models/email_clicks_response.rb +258 -223
  899. data/lib/ultracart_api/models/email_commseq.rb +252 -217
  900. data/lib/ultracart_api/models/email_commseq_email.rb +470 -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 -229
  1072. data/lib/ultracart_api/models/item_physical.rb +246 -211
  1073. data/lib/ultracart_api/models/item_pricing.rb +422 -387
  1074. data/lib/ultracart_api/models/item_pricing_tier.rb +261 -226
  1075. data/lib/ultracart_api/models/item_pricing_tier_discount.rb +230 -195
  1076. data/lib/ultracart_api/models/item_pricing_tier_limit.rb +240 -227
  1077. data/lib/ultracart_api/models/item_property.rb +270 -235
  1078. data/lib/ultracart_api/models/item_realtime_pricing.rb +240 -205
  1079. data/lib/ultracart_api/models/item_related.rb +242 -207
  1080. data/lib/ultracart_api/models/item_related_item.rb +274 -239
  1081. data/lib/ultracart_api/models/item_reporting.rb +232 -197
  1082. data/lib/ultracart_api/models/item_response.rb +256 -221
  1083. data/lib/ultracart_api/models/item_restriction.rb +292 -257
  1084. data/lib/ultracart_api/models/item_restriction_item.rb +274 -239
  1085. data/lib/ultracart_api/models/item_revguard.rb +280 -245
  1086. data/lib/ultracart_api/models/item_reviews.rb +300 -276
  1087. data/lib/ultracart_api/models/item_salesforce.rb +230 -195
  1088. data/lib/ultracart_api/models/item_shipping.rb +713 -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 -610
  1130. data/lib/ultracart_api/models/order_affiliate.rb +242 -207
  1131. data/lib/ultracart_api/models/order_affiliate_ledger.rb +334 -299
  1132. data/lib/ultracart_api/models/order_auto_order.rb +448 -413
  1133. data/lib/ultracart_api/models/order_billing.rb +597 -612
  1134. data/lib/ultracart_api/models/order_buysafe.rb +268 -233
  1135. data/lib/ultracart_api/models/order_by_token_query.rb +220 -185
  1136. data/lib/ultracart_api/models/order_channel_partner.rb +335 -300
  1137. data/lib/ultracart_api/models/order_checkout.rb +469 -509
  1138. data/lib/ultracart_api/models/order_coupon.rb +290 -255
  1139. data/lib/ultracart_api/models/order_digital_item.rb +290 -255
  1140. data/lib/ultracart_api/models/order_digital_order.rb +262 -227
  1141. data/lib/ultracart_api/models/order_edi.rb +265 -230
  1142. data/lib/ultracart_api/models/order_format.rb +404 -369
  1143. data/lib/ultracart_api/models/order_format_response.rb +232 -197
  1144. data/lib/ultracart_api/models/order_fraud_score.rb +444 -409
  1145. data/lib/ultracart_api/models/order_gift.rb +351 -316
  1146. data/lib/ultracart_api/models/order_gift_certificate.rb +239 -204
  1147. data/lib/ultracart_api/models/order_internal.rb +275 -252
  1148. data/lib/ultracart_api/models/order_item.rb +889 -1019
  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 -406
  1160. data/lib/ultracart_api/models/order_payment_check.rb +220 -185
  1161. data/lib/ultracart_api/models/order_payment_credit_card.rb +354 -328
  1162. data/lib/ultracart_api/models/order_payment_e_check.rb +476 -441
  1163. data/lib/ultracart_api/models/order_payment_insurance.rb +250 -215
  1164. data/lib/ultracart_api/models/order_payment_purchase_order.rb +220 -185
  1165. data/lib/ultracart_api/models/order_payment_transaction.rb +252 -227
  1166. data/lib/ultracart_api/models/order_payment_transaction_detail.rb +240 -205
  1167. data/lib/ultracart_api/models/order_process_payment_request.rb +230 -195
  1168. data/lib/ultracart_api/models/order_process_payment_response.rb +256 -221
  1169. data/lib/ultracart_api/models/order_property.rb +280 -245
  1170. data/lib/ultracart_api/models/order_query.rb +826 -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 -373
  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/webhook_sample_request.rb +252 -217
  1306. data/lib/ultracart_api/models/webhook_sample_request_response.rb +256 -221
  1307. data/lib/ultracart_api/models/webhooks_response.rb +258 -223
  1308. data/lib/ultracart_api/models/weight.rb +264 -229
  1309. data/lib/ultracart_api/version.rb +15 -15
  1310. data/lib/ultracart_api.rb +689 -915
  1311. data/spec/api_client_spec.rb +226 -243
  1312. data/spec/configuration_spec.rb +42 -42
  1313. data/spec/spec_helper.rb +111 -111
  1314. data/ultracart_api.gemspec +38 -46
  1315. metadata +5 -617
  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/ChannelPartner.md +0 -15
  1324. data/docs/ChannelPartnerShipToPreference.md +0 -14
  1325. data/docs/ChannelPartnerShipToPreferenceResponse.md +0 -12
  1326. data/docs/ChannelPartnerShipToPreferencesResponse.md +0 -12
  1327. data/docs/ChannelPartnersResponse.md +0 -12
  1328. data/docs/Conversation.md +0 -26
  1329. data/docs/ConversationAgentAuth.md +0 -22
  1330. data/docs/ConversationAgentAuthResponse.md +0 -12
  1331. data/docs/ConversationAgentProfile.md +0 -14
  1332. data/docs/ConversationAgentProfileResponse.md +0 -12
  1333. data/docs/ConversationApi.md +0 -4199
  1334. data/docs/ConversationAutocompleteRequest.md +0 -9
  1335. data/docs/ConversationAutocompleteResponse.md +0 -14
  1336. data/docs/ConversationAutocompleteValue.md +0 -9
  1337. data/docs/ConversationCannedMessage.md +0 -11
  1338. data/docs/ConversationCannedMessageResponse.md +0 -12
  1339. data/docs/ConversationCannedMessagesResponse.md +0 -12
  1340. data/docs/ConversationCannedMessagesSearch.md +0 -9
  1341. data/docs/ConversationDepartment.md +0 -12
  1342. data/docs/ConversationDepartmentMember.md +0 -10
  1343. data/docs/ConversationDepartmentMembersResponse.md +0 -12
  1344. data/docs/ConversationDepartmentResponse.md +0 -12
  1345. data/docs/ConversationDepartmentSettings.md +0 -7
  1346. data/docs/ConversationDepartmentsResponse.md +0 -12
  1347. data/docs/ConversationEngagement.md +0 -16
  1348. data/docs/ConversationEngagementEquation.md +0 -8
  1349. data/docs/ConversationEngagementEquationFunction.md +0 -21
  1350. data/docs/ConversationEngagementEquationGroup.md +0 -8
  1351. data/docs/ConversationEngagementResponse.md +0 -12
  1352. data/docs/ConversationEngagementsResponse.md +0 -12
  1353. data/docs/ConversationEventAddCoupon.md +0 -10
  1354. data/docs/ConversationEventAddItem.md +0 -10
  1355. data/docs/ConversationEventQueuePosition.md +0 -9
  1356. data/docs/ConversationEventRRWeb.md +0 -14
  1357. data/docs/ConversationEventReadMessage.md +0 -10
  1358. data/docs/ConversationEventTyping.md +0 -10
  1359. data/docs/ConversationEventWebchatContext.md +0 -10
  1360. data/docs/ConversationJoinRequest.md +0 -8
  1361. data/docs/ConversationLocationCountry.md +0 -10
  1362. data/docs/ConversationLocationStateProvince.md +0 -9
  1363. data/docs/ConversationLocationsResponse.md +0 -12
  1364. data/docs/ConversationMessage.md +0 -22
  1365. data/docs/ConversationMessageTranslation.md +0 -9
  1366. data/docs/ConversationMessageTransportStatus.md +0 -9
  1367. data/docs/ConversationMessagesResponse.md +0 -12
  1368. data/docs/ConversationMultimediaUploadUrl.md +0 -9
  1369. data/docs/ConversationMultimediaUploadUrlResponse.md +0 -12
  1370. data/docs/ConversationParticipant.md +0 -20
  1371. data/docs/ConversationPbxAgent.md +0 -23
  1372. data/docs/ConversationPbxAgentResponse.md +0 -12
  1373. data/docs/ConversationPbxAgentsResponse.md +0 -12
  1374. data/docs/ConversationPbxAudio.md +0 -17
  1375. data/docs/ConversationPbxAudioResponse.md +0 -12
  1376. data/docs/ConversationPbxAudioUploadUrl.md +0 -9
  1377. data/docs/ConversationPbxAudioUploadUrlResponse.md +0 -12
  1378. data/docs/ConversationPbxAudioUsageResponse.md +0 -14
  1379. data/docs/ConversationPbxAudiosResponse.md +0 -12
  1380. data/docs/ConversationPbxCustomerSnapshotRequest.md +0 -15
  1381. data/docs/ConversationPbxCustomerSnapshotResponse.md +0 -14
  1382. data/docs/ConversationPbxMenu.md +0 -18
  1383. data/docs/ConversationPbxMenuMapping.md +0 -11
  1384. data/docs/ConversationPbxMenuResponse.md +0 -12
  1385. data/docs/ConversationPbxMenusResponse.md +0 -12
  1386. data/docs/ConversationPbxPhoneNumber.md +0 -12
  1387. data/docs/ConversationPbxPhoneNumberResponse.md +0 -12
  1388. data/docs/ConversationPbxPhoneNumbersResponse.md +0 -12
  1389. data/docs/ConversationPbxQueue.md +0 -28
  1390. data/docs/ConversationPbxQueueMembers.md +0 -9
  1391. data/docs/ConversationPbxQueueResponse.md +0 -12
  1392. data/docs/ConversationPbxQueuesResponse.md +0 -12
  1393. data/docs/ConversationPbxTimeBased.md +0 -11
  1394. data/docs/ConversationPbxTimeBasedMapping.md +0 -11
  1395. data/docs/ConversationPbxTimeBasedMappingConfig.md +0 -9
  1396. data/docs/ConversationPbxTimeBasedResponse.md +0 -12
  1397. data/docs/ConversationPbxTimeBasedsResponse.md +0 -12
  1398. data/docs/ConversationPbxTimeRange.md +0 -12
  1399. data/docs/ConversationPbxTimeRangeConfig.md +0 -13
  1400. data/docs/ConversationPbxTimeRangeResponse.md +0 -12
  1401. data/docs/ConversationPbxTimeRangesResponse.md +0 -12
  1402. data/docs/ConversationPbxVoicemailMailbox.md +0 -19
  1403. data/docs/ConversationPbxVoicemailMailboxResponse.md +0 -12
  1404. data/docs/ConversationPbxVoicemailMailboxesResponse.md +0 -12
  1405. data/docs/ConversationPbxVoicemailMessage.md +0 -20
  1406. data/docs/ConversationPbxVoicemailMessageResponse.md +0 -12
  1407. data/docs/ConversationPbxVoicemailMessageSummariesResponse.md +0 -12
  1408. data/docs/ConversationPbxVoicemailMessageSummary.md +0 -17
  1409. data/docs/ConversationPermissions.md +0 -8
  1410. data/docs/ConversationPermissionsResponse.md +0 -12
  1411. data/docs/ConversationResponse.md +0 -12
  1412. data/docs/ConversationSearchRequest.md +0 -19
  1413. data/docs/ConversationSearchResponse.md +0 -11
  1414. data/docs/ConversationSentiment.md +0 -13
  1415. data/docs/ConversationStartRequest.md +0 -10
  1416. data/docs/ConversationStartResponse.md +0 -8
  1417. data/docs/ConversationSummary.md +0 -24
  1418. data/docs/ConversationTwilioAccount.md +0 -9
  1419. data/docs/ConversationWebchatContext.md +0 -15
  1420. data/docs/ConversationWebchatQueueStatus.md +0 -22
  1421. data/docs/ConversationWebchatQueueStatusAgent.md +0 -13
  1422. data/docs/ConversationWebchatQueueStatusQueueEntry.md +0 -15
  1423. data/docs/ConversationWebchatQueueStatusUpdateRequest.md +0 -8
  1424. data/docs/ConversationWebchatQueueStatusesResponse.md +0 -12
  1425. data/docs/ConversationWebsocketMessage.md +0 -31
  1426. data/docs/ConversationsResponse.md +0 -12
  1427. data/docs/CouponFreeItemWithItemPurchaseAndFreeShipping.md +0 -11
  1428. data/docs/CouponMoreLoyaltyCashback.md +0 -8
  1429. data/docs/CouponMoreLoyaltyPoints.md +0 -8
  1430. data/docs/CouponNoDiscount.md +0 -8
  1431. data/docs/CouponPercentMoreLoyaltyCashback.md +0 -8
  1432. data/docs/CouponPercentMoreLoyaltyPoints.md +0 -8
  1433. data/docs/CouponTieredPercentOffSubtotalBasedOnMSRP.md +0 -9
  1434. data/docs/CustomerEDI.md +0 -10
  1435. data/docs/CustomerMagicLinkResponse.md +0 -12
  1436. data/docs/CustomerMergeRequest.md +0 -9
  1437. data/docs/CustomerProperty.md +0 -11
  1438. data/docs/CustomerWishListItem.md +0 -14
  1439. data/docs/CustomerWishListItemResponse.md +0 -12
  1440. data/docs/CustomerWishListItemsResponse.md +0 -12
  1441. data/docs/DatawarehouseApi.md +0 -512
  1442. data/docs/EmailCommseqSequenceTestRequest.md +0 -22
  1443. data/docs/EmailCommseqSequenceTestResponse.md +0 -11
  1444. data/docs/EmailCommseqSmsSendTestRequest.md +0 -10
  1445. data/docs/EmailCommseqSmsSendTestResponse.md +0 -13
  1446. data/docs/EmailPostcardTracking.md +0 -32
  1447. data/docs/EmailPostcardTrackingResponse.md +0 -12
  1448. data/docs/EmailRateLimiter.md +0 -10
  1449. data/docs/EmailRateLimitersResponse.md +0 -12
  1450. data/docs/EmailSmsOrder.md +0 -11
  1451. data/docs/EmailSmsOrdersResponse.md +0 -12
  1452. data/docs/EmailSmsStat.md +0 -37
  1453. data/docs/EmailStatSmsSummaryRequest.md +0 -9
  1454. data/docs/EmailStatSmsSummaryResponse.md +0 -12
  1455. data/docs/FileManagerDirectory.md +0 -20
  1456. data/docs/FileManagerFile.md +0 -29
  1457. data/docs/FileManagerPage.md +0 -15
  1458. data/docs/FileManagerPageResponse.md +0 -12
  1459. data/docs/FileManagerUploadRequest.md +0 -10
  1460. data/docs/FileManagerUploadUrlResponse.md +0 -13
  1461. data/docs/HitPageView.md +0 -18
  1462. data/docs/HitPageViewMetaData.md +0 -9
  1463. data/docs/HitSessionStart.md +0 -24
  1464. data/docs/HitSessionUtm.md +0 -22
  1465. data/docs/ItemDigitalItemPdfMeta.md +0 -18
  1466. data/docs/ItemDigitalItemResponse.md +0 -12
  1467. data/docs/ItemDigitalItemsResponse.md +0 -12
  1468. data/docs/ItemInventorySnapshot.md +0 -13
  1469. data/docs/ItemInventorySnapshotDistributionCenter.md +0 -12
  1470. data/docs/ItemInventorySnapshotResponse.md +0 -12
  1471. data/docs/ItemReview.md +0 -44
  1472. data/docs/ItemReviewResponse.md +0 -12
  1473. data/docs/ItemReviewsResponse.md +0 -12
  1474. data/docs/OrderEdiDocument.md +0 -21
  1475. data/docs/OrderEdiDocumentsResponse.md +0 -12
  1476. data/docs/OrderInvoiceResponse.md +0 -12
  1477. data/docs/OrderPaymentCreditCardDualVaulted.md +0 -10
  1478. data/docs/OrderPaymentCreditCardDualVaultedProperty.md +0 -9
  1479. data/docs/OrderPaymentHealthBenefitCard.md +0 -13
  1480. data/docs/OrderPointOfSale.md +0 -10
  1481. data/docs/OrderReason.md +0 -10
  1482. data/docs/OrderRefundableResponse.md +0 -20
  1483. data/docs/OrderTransactionalMerchantNote.md +0 -11
  1484. data/docs/OrderUtm.md +0 -39
  1485. data/docs/OrderValidationRequest.md +0 -9
  1486. data/docs/OrderValidationResponse.md +0 -10
  1487. data/docs/PointOfSaleLocation.md +0 -17
  1488. data/docs/PointOfSaleReader.md +0 -16
  1489. data/docs/PointOfSaleRegister.md +0 -11
  1490. data/docs/Report.md +0 -18
  1491. data/docs/ReportAuth.md +0 -11
  1492. data/docs/ReportAuthResponse.md +0 -12
  1493. data/docs/ReportDataSet.md +0 -24
  1494. data/docs/ReportDataSetColumn.md +0 -13
  1495. data/docs/ReportDataSetPage.md +0 -17
  1496. data/docs/ReportDataSetPageResponse.md +0 -12
  1497. data/docs/ReportDataSetQuery.md +0 -20
  1498. data/docs/ReportDataSetQueryOrderByColumn.md +0 -9
  1499. data/docs/ReportDataSetResponse.md +0 -12
  1500. data/docs/ReportDataSetRow.md +0 -8
  1501. data/docs/ReportDataSetSchema.md +0 -10
  1502. data/docs/ReportDataSource.md +0 -14
  1503. data/docs/ReportDataSourceSchema.md +0 -11
  1504. data/docs/ReportDryRunQueriesRequest.md +0 -13
  1505. data/docs/ReportDryRunQueriesResponse.md +0 -8
  1506. data/docs/ReportDryRunQueryResult.md +0 -9
  1507. data/docs/ReportExecuteQueriesRequest.md +0 -15
  1508. data/docs/ReportFilter.md +0 -13
  1509. data/docs/ReportFilterConnection.md +0 -10
  1510. data/docs/ReportPage.md +0 -13
  1511. data/docs/ReportPageFilter.md +0 -11
  1512. data/docs/ReportPageVisualization.md +0 -17
  1513. data/docs/ReportPageVisualizationDimension.md +0 -14
  1514. data/docs/ReportPageVisualizationMetric.md +0 -11
  1515. data/docs/ReportResponse.md +0 -12
  1516. data/docs/ReportWebsocketEvent.md +0 -9
  1517. data/docs/ReportsResponse.md +0 -12
  1518. data/docs/RulerValidationRequest.md +0 -8
  1519. data/docs/RulerValidationResponse.md +0 -9
  1520. data/docs/StoreFront.md +0 -18
  1521. data/docs/StoreFrontPageContentAttribute.md +0 -11
  1522. data/docs/StoreFrontsResponse.md +0 -12
  1523. data/docs/WorkflowAgentAuth.md +0 -10
  1524. data/docs/WorkflowAgentAuthResponse.md +0 -12
  1525. data/docs/WorkflowApi.md +0 -620
  1526. data/docs/WorkflowAttachment.md +0 -12
  1527. data/docs/WorkflowAttachmentUploadUrl.md +0 -9
  1528. data/docs/WorkflowAttachmentUploadUrlResponse.md +0 -12
  1529. data/docs/WorkflowGroup.md +0 -9
  1530. data/docs/WorkflowGroupsResponse.md +0 -12
  1531. data/docs/WorkflowNote.md +0 -13
  1532. data/docs/WorkflowTask.md +0 -39
  1533. data/docs/WorkflowTaskHistory.md +0 -11
  1534. data/docs/WorkflowTaskOpenCountResponse.md +0 -12
  1535. data/docs/WorkflowTaskResponse.md +0 -12
  1536. data/docs/WorkflowTaskTagsResponse.md +0 -12
  1537. data/docs/WorkflowTasksRequest.md +0 -27
  1538. data/docs/WorkflowTasksResponse.md +0 -13
  1539. data/docs/WorkflowUser.md +0 -10
  1540. data/docs/WorkflowUserResponse.md +0 -12
  1541. data/docs/WorkflowUsersResponse.md +0 -13
  1542. data/lib/ultracart_api/api/conversation_api.rb +0 -4583
  1543. data/lib/ultracart_api/api/datawarehouse_api.rb +0 -584
  1544. data/lib/ultracart_api/api/workflow_api.rb +0 -693
  1545. data/lib/ultracart_api/models/accounts_receivable_retry_transaction_reject.rb +0 -195
  1546. data/lib/ultracart_api/models/auto_order_addon_item.rb +0 -232
  1547. data/lib/ultracart_api/models/auto_order_addon_item_option.rb +0 -225
  1548. data/lib/ultracart_api/models/auto_order_consolidate.rb +0 -186
  1549. data/lib/ultracart_api/models/auto_order_management.rb +0 -185
  1550. data/lib/ultracart_api/models/cart_item_property.rb +0 -245
  1551. data/lib/ultracart_api/models/cart_payment_health_benefit_card.rb +0 -235
  1552. data/lib/ultracart_api/models/channel_partner.rb +0 -255
  1553. data/lib/ultracart_api/models/channel_partner_ship_to_preference.rb +0 -262
  1554. data/lib/ultracart_api/models/channel_partner_ship_to_preference_response.rb +0 -221
  1555. data/lib/ultracart_api/models/channel_partner_ship_to_preferences_response.rb +0 -224
  1556. data/lib/ultracart_api/models/channel_partners_response.rb +0 -224
  1557. data/lib/ultracart_api/models/conversation.rb +0 -390
  1558. data/lib/ultracart_api/models/conversation_agent_auth.rb +0 -316
  1559. data/lib/ultracart_api/models/conversation_agent_auth_response.rb +0 -221
  1560. data/lib/ultracart_api/models/conversation_agent_profile.rb +0 -279
  1561. data/lib/ultracart_api/models/conversation_agent_profile_response.rb +0 -221
  1562. data/lib/ultracart_api/models/conversation_autocomplete_request.rb +0 -193
  1563. data/lib/ultracart_api/models/conversation_autocomplete_response.rb +0 -241
  1564. data/lib/ultracart_api/models/conversation_autocomplete_value.rb +0 -193
  1565. data/lib/ultracart_api/models/conversation_canned_message.rb +0 -213
  1566. data/lib/ultracart_api/models/conversation_canned_message_response.rb +0 -221
  1567. data/lib/ultracart_api/models/conversation_canned_messages_response.rb +0 -223
  1568. data/lib/ultracart_api/models/conversation_canned_messages_search.rb +0 -193
  1569. data/lib/ultracart_api/models/conversation_department.rb +0 -222
  1570. data/lib/ultracart_api/models/conversation_department_member.rb +0 -202
  1571. data/lib/ultracart_api/models/conversation_department_members_response.rb +0 -223
  1572. data/lib/ultracart_api/models/conversation_department_response.rb +0 -221
  1573. data/lib/ultracart_api/models/conversation_department_settings.rb +0 -175
  1574. data/lib/ultracart_api/models/conversation_departments_response.rb +0 -223
  1575. data/lib/ultracart_api/models/conversation_engagement.rb +0 -293
  1576. data/lib/ultracart_api/models/conversation_engagement_equation.rb +0 -186
  1577. data/lib/ultracart_api/models/conversation_engagement_equation_function.rb +0 -414
  1578. data/lib/ultracart_api/models/conversation_engagement_equation_group.rb +0 -186
  1579. data/lib/ultracart_api/models/conversation_engagement_response.rb +0 -221
  1580. data/lib/ultracart_api/models/conversation_engagements_response.rb +0 -223
  1581. data/lib/ultracart_api/models/conversation_event_add_coupon.rb +0 -202
  1582. data/lib/ultracart_api/models/conversation_event_add_item.rb +0 -204
  1583. data/lib/ultracart_api/models/conversation_event_queue_position.rb +0 -195
  1584. data/lib/ultracart_api/models/conversation_event_read_message.rb +0 -203
  1585. data/lib/ultracart_api/models/conversation_event_rr_web.rb +0 -273
  1586. data/lib/ultracart_api/models/conversation_event_typing.rb +0 -202
  1587. data/lib/ultracart_api/models/conversation_event_webchat_context.rb +0 -202
  1588. data/lib/ultracart_api/models/conversation_join_request.rb +0 -184
  1589. data/lib/ultracart_api/models/conversation_location_country.rb +0 -204
  1590. data/lib/ultracart_api/models/conversation_location_state_province.rb +0 -193
  1591. data/lib/ultracart_api/models/conversation_locations_response.rb +0 -223
  1592. data/lib/ultracart_api/models/conversation_message.rb +0 -356
  1593. data/lib/ultracart_api/models/conversation_message_translation.rb +0 -193
  1594. data/lib/ultracart_api/models/conversation_message_transport_status.rb +0 -228
  1595. data/lib/ultracart_api/models/conversation_messages_response.rb +0 -223
  1596. data/lib/ultracart_api/models/conversation_multimedia_upload_url.rb +0 -193
  1597. data/lib/ultracart_api/models/conversation_multimedia_upload_url_response.rb +0 -221
  1598. data/lib/ultracart_api/models/conversation_participant.rb +0 -295
  1599. data/lib/ultracart_api/models/conversation_pbx_agent.rb +0 -440
  1600. data/lib/ultracart_api/models/conversation_pbx_agent_response.rb +0 -221
  1601. data/lib/ultracart_api/models/conversation_pbx_agents_response.rb +0 -223
  1602. data/lib/ultracart_api/models/conversation_pbx_audio.rb +0 -365
  1603. data/lib/ultracart_api/models/conversation_pbx_audio_response.rb +0 -221
  1604. data/lib/ultracart_api/models/conversation_pbx_audio_upload_url.rb +0 -193
  1605. data/lib/ultracart_api/models/conversation_pbx_audio_upload_url_response.rb +0 -221
  1606. data/lib/ultracart_api/models/conversation_pbx_audio_usage_response.rb +0 -245
  1607. data/lib/ultracart_api/models/conversation_pbx_audios_response.rb +0 -223
  1608. data/lib/ultracart_api/models/conversation_pbx_customer_snapshot_request.rb +0 -248
  1609. data/lib/ultracart_api/models/conversation_pbx_customer_snapshot_response.rb +0 -245
  1610. data/lib/ultracart_api/models/conversation_pbx_menu.rb +0 -416
  1611. data/lib/ultracart_api/models/conversation_pbx_menu_mapping.rb +0 -269
  1612. data/lib/ultracart_api/models/conversation_pbx_menu_response.rb +0 -221
  1613. data/lib/ultracart_api/models/conversation_pbx_menus_response.rb +0 -223
  1614. data/lib/ultracart_api/models/conversation_pbx_phone_number.rb +0 -324
  1615. data/lib/ultracart_api/models/conversation_pbx_phone_number_response.rb +0 -221
  1616. data/lib/ultracart_api/models/conversation_pbx_phone_numbers_response.rb +0 -223
  1617. data/lib/ultracart_api/models/conversation_pbx_queue.rb +0 -534
  1618. data/lib/ultracart_api/models/conversation_pbx_queue_members.rb +0 -197
  1619. data/lib/ultracart_api/models/conversation_pbx_queue_response.rb +0 -221
  1620. data/lib/ultracart_api/models/conversation_pbx_queues_response.rb +0 -223
  1621. data/lib/ultracart_api/models/conversation_pbx_time_based.rb +0 -211
  1622. data/lib/ultracart_api/models/conversation_pbx_time_based_mapping.rb +0 -299
  1623. data/lib/ultracart_api/models/conversation_pbx_time_based_mapping_config.rb +0 -196
  1624. data/lib/ultracart_api/models/conversation_pbx_time_based_response.rb +0 -221
  1625. data/lib/ultracart_api/models/conversation_pbx_time_baseds_response.rb +0 -223
  1626. data/lib/ultracart_api/models/conversation_pbx_time_range.rb +0 -287
  1627. data/lib/ultracart_api/models/conversation_pbx_time_range_config.rb +0 -235
  1628. data/lib/ultracart_api/models/conversation_pbx_time_range_response.rb +0 -221
  1629. data/lib/ultracart_api/models/conversation_pbx_time_ranges_response.rb +0 -223
  1630. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox.rb +0 -458
  1631. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailbox_response.rb +0 -221
  1632. data/lib/ultracart_api/models/conversation_pbx_voicemail_mailboxes_response.rb +0 -223
  1633. data/lib/ultracart_api/models/conversation_pbx_voicemail_message.rb +0 -339
  1634. data/lib/ultracart_api/models/conversation_pbx_voicemail_message_response.rb +0 -221
  1635. data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summaries_response.rb +0 -223
  1636. data/lib/ultracart_api/models/conversation_pbx_voicemail_message_summary.rb +0 -309
  1637. data/lib/ultracart_api/models/conversation_permissions.rb +0 -184
  1638. data/lib/ultracart_api/models/conversation_permissions_response.rb +0 -221
  1639. data/lib/ultracart_api/models/conversation_response.rb +0 -221
  1640. data/lib/ultracart_api/models/conversation_search_request.rb +0 -285
  1641. data/lib/ultracart_api/models/conversation_search_response.rb +0 -213
  1642. data/lib/ultracart_api/models/conversation_sentiment.rb +0 -269
  1643. data/lib/ultracart_api/models/conversation_start_request.rb +0 -204
  1644. data/lib/ultracart_api/models/conversation_start_response.rb +0 -184
  1645. data/lib/ultracart_api/models/conversation_summary.rb +0 -369
  1646. data/lib/ultracart_api/models/conversation_twilio_account.rb +0 -195
  1647. data/lib/ultracart_api/models/conversation_webchat_context.rb +0 -254
  1648. data/lib/ultracart_api/models/conversation_webchat_queue_status.rb +0 -315
  1649. data/lib/ultracart_api/models/conversation_webchat_queue_status_agent.rb +0 -266
  1650. data/lib/ultracart_api/models/conversation_webchat_queue_status_queue_entry.rb +0 -248
  1651. data/lib/ultracart_api/models/conversation_webchat_queue_status_update_request.rb +0 -219
  1652. data/lib/ultracart_api/models/conversation_webchat_queue_statuses_response.rb +0 -223
  1653. data/lib/ultracart_api/models/conversation_websocket_message.rb +0 -441
  1654. data/lib/ultracart_api/models/conversations_response.rb +0 -223
  1655. data/lib/ultracart_api/models/coupon_free_item_with_item_purchase_and_free_shipping.rb +0 -219
  1656. data/lib/ultracart_api/models/coupon_more_loyalty_cashback.rb +0 -185
  1657. data/lib/ultracart_api/models/coupon_more_loyalty_points.rb +0 -185
  1658. data/lib/ultracart_api/models/coupon_no_discount.rb +0 -185
  1659. data/lib/ultracart_api/models/coupon_percent_more_loyalty_cashback.rb +0 -185
  1660. data/lib/ultracart_api/models/coupon_percent_more_loyalty_points.rb +0 -185
  1661. data/lib/ultracart_api/models/coupon_tiered_percent_off_subtotal_based_on_msrp.rb +0 -199
  1662. data/lib/ultracart_api/models/customer_edi.rb +0 -205
  1663. data/lib/ultracart_api/models/customer_magic_link_response.rb +0 -222
  1664. data/lib/ultracart_api/models/customer_merge_request.rb +0 -195
  1665. data/lib/ultracart_api/models/customer_property.rb +0 -245
  1666. data/lib/ultracart_api/models/customer_wish_list_item.rb +0 -260
  1667. data/lib/ultracart_api/models/customer_wish_list_item_response.rb +0 -221
  1668. data/lib/ultracart_api/models/customer_wish_list_items_response.rb +0 -223
  1669. data/lib/ultracart_api/models/email_commseq_sequence_test_request.rb +0 -312
  1670. data/lib/ultracart_api/models/email_commseq_sequence_test_response.rb +0 -212
  1671. data/lib/ultracart_api/models/email_commseq_sms_send_test_request.rb +0 -202
  1672. data/lib/ultracart_api/models/email_commseq_sms_send_test_response.rb +0 -232
  1673. data/lib/ultracart_api/models/email_postcard_tracking.rb +0 -404
  1674. data/lib/ultracart_api/models/email_postcard_tracking_response.rb +0 -221
  1675. data/lib/ultracart_api/models/email_rate_limiter.rb +0 -202
  1676. data/lib/ultracart_api/models/email_rate_limiters_response.rb +0 -223
  1677. data/lib/ultracart_api/models/email_sms_order.rb +0 -214
  1678. data/lib/ultracart_api/models/email_sms_orders_response.rb +0 -223
  1679. data/lib/ultracart_api/models/email_sms_stat.rb +0 -476
  1680. data/lib/ultracart_api/models/email_stat_sms_summary_request.rb +0 -195
  1681. data/lib/ultracart_api/models/email_stat_sms_summary_response.rb +0 -223
  1682. data/lib/ultracart_api/models/file_manager_directory.rb +0 -292
  1683. data/lib/ultracart_api/models/file_manager_file.rb +0 -376
  1684. data/lib/ultracart_api/models/file_manager_page.rb +0 -253
  1685. data/lib/ultracart_api/models/file_manager_page_response.rb +0 -221
  1686. data/lib/ultracart_api/models/file_manager_upload_request.rb +0 -202
  1687. data/lib/ultracart_api/models/file_manager_upload_url_response.rb +0 -230
  1688. data/lib/ultracart_api/models/hit_page_view.rb +0 -276
  1689. data/lib/ultracart_api/models/hit_page_view_meta_data.rb +0 -193
  1690. data/lib/ultracart_api/models/hit_session_start.rb +0 -328
  1691. data/lib/ultracart_api/models/hit_session_utm.rb +0 -310
  1692. data/lib/ultracart_api/models/item_digital_item_pdf_meta.rb +0 -315
  1693. data/lib/ultracart_api/models/item_digital_item_response.rb +0 -221
  1694. data/lib/ultracart_api/models/item_digital_items_response.rb +0 -224
  1695. data/lib/ultracart_api/models/item_inventory_snapshot.rb +0 -231
  1696. data/lib/ultracart_api/models/item_inventory_snapshot_distribution_center.rb +0 -220
  1697. data/lib/ultracart_api/models/item_inventory_snapshot_response.rb +0 -224
  1698. data/lib/ultracart_api/models/item_review.rb +0 -801
  1699. data/lib/ultracart_api/models/item_review_response.rb +0 -221
  1700. data/lib/ultracart_api/models/item_reviews_response.rb +0 -224
  1701. data/lib/ultracart_api/models/order_edi_document.rb +0 -337
  1702. data/lib/ultracart_api/models/order_edi_documents_response.rb +0 -224
  1703. data/lib/ultracart_api/models/order_invoice_response.rb +0 -222
  1704. data/lib/ultracart_api/models/order_payment_credit_card_dual_vaulted.rb +0 -204
  1705. data/lib/ultracart_api/models/order_payment_credit_card_dual_vaulted_property.rb +0 -193
  1706. data/lib/ultracart_api/models/order_payment_health_benefit_card.rb +0 -235
  1707. data/lib/ultracart_api/models/order_point_of_sale.rb +0 -202
  1708. data/lib/ultracart_api/models/order_reason.rb +0 -205
  1709. data/lib/ultracart_api/models/order_refundable_response.rb +0 -310
  1710. data/lib/ultracart_api/models/order_transactional_merchant_note.rb +0 -215
  1711. data/lib/ultracart_api/models/order_utm.rb +0 -464
  1712. data/lib/ultracart_api/models/order_validation_request.rb +0 -196
  1713. data/lib/ultracart_api/models/order_validation_response.rb +0 -209
  1714. data/lib/ultracart_api/models/point_of_sale_location.rb +0 -290
  1715. data/lib/ultracart_api/models/point_of_sale_reader.rb +0 -299
  1716. data/lib/ultracart_api/models/point_of_sale_register.rb +0 -215
  1717. data/lib/ultracart_api/models/report.rb +0 -317
  1718. data/lib/ultracart_api/models/report_auth.rb +0 -212
  1719. data/lib/ultracart_api/models/report_auth_response.rb +0 -221
  1720. data/lib/ultracart_api/models/report_data_set.rb +0 -381
  1721. data/lib/ultracart_api/models/report_data_set_column.rb +0 -229
  1722. data/lib/ultracart_api/models/report_data_set_page.rb +0 -273
  1723. data/lib/ultracart_api/models/report_data_set_page_response.rb +0 -221
  1724. data/lib/ultracart_api/models/report_data_set_query.rb +0 -342
  1725. data/lib/ultracart_api/models/report_data_set_query_order_by_column.rb +0 -193
  1726. data/lib/ultracart_api/models/report_data_set_response.rb +0 -221
  1727. data/lib/ultracart_api/models/report_data_set_row.rb +0 -186
  1728. data/lib/ultracart_api/models/report_data_set_schema.rb +0 -238
  1729. data/lib/ultracart_api/models/report_data_source.rb +0 -242
  1730. data/lib/ultracart_api/models/report_data_source_schema.rb +0 -248
  1731. data/lib/ultracart_api/models/report_dry_run_queries_request.rb +0 -231
  1732. data/lib/ultracart_api/models/report_dry_run_queries_response.rb +0 -186
  1733. data/lib/ultracart_api/models/report_dry_run_query_result.rb +0 -193
  1734. data/lib/ultracart_api/models/report_execute_queries_request.rb +0 -288
  1735. data/lib/ultracart_api/models/report_filter.rb +0 -272
  1736. data/lib/ultracart_api/models/report_filter_connection.rb +0 -203
  1737. data/lib/ultracart_api/models/report_page.rb +0 -237
  1738. data/lib/ultracart_api/models/report_page_filter.rb +0 -214
  1739. data/lib/ultracart_api/models/report_page_visualization.rb +0 -309
  1740. data/lib/ultracart_api/models/report_page_visualization_dimension.rb +0 -244
  1741. data/lib/ultracart_api/models/report_page_visualization_metric.rb +0 -248
  1742. data/lib/ultracart_api/models/report_response.rb +0 -221
  1743. data/lib/ultracart_api/models/report_websocket_event.rb +0 -228
  1744. data/lib/ultracart_api/models/reports_response.rb +0 -223
  1745. data/lib/ultracart_api/models/ruler_validation_request.rb +0 -184
  1746. data/lib/ultracart_api/models/ruler_validation_response.rb +0 -193
  1747. data/lib/ultracart_api/models/store_front.rb +0 -274
  1748. data/lib/ultracart_api/models/store_front_page_content_attribute.rb +0 -245
  1749. data/lib/ultracart_api/models/store_fronts_response.rb +0 -223
  1750. data/lib/ultracart_api/models/workflow_agent_auth.rb +0 -202
  1751. data/lib/ultracart_api/models/workflow_agent_auth_response.rb +0 -221
  1752. data/lib/ultracart_api/models/workflow_attachment.rb +0 -225
  1753. data/lib/ultracart_api/models/workflow_attachment_upload_url.rb +0 -193
  1754. data/lib/ultracart_api/models/workflow_attachment_upload_url_response.rb +0 -221
  1755. data/lib/ultracart_api/models/workflow_group.rb +0 -195
  1756. data/lib/ultracart_api/models/workflow_groups_response.rb +0 -224
  1757. data/lib/ultracart_api/models/workflow_note.rb +0 -236
  1758. data/lib/ultracart_api/models/workflow_task.rb +0 -574
  1759. data/lib/ultracart_api/models/workflow_task_history.rb +0 -214
  1760. data/lib/ultracart_api/models/workflow_task_open_count_response.rb +0 -222
  1761. data/lib/ultracart_api/models/workflow_task_response.rb +0 -221
  1762. data/lib/ultracart_api/models/workflow_task_tags_response.rb +0 -224
  1763. data/lib/ultracart_api/models/workflow_tasks_request.rb +0 -434
  1764. data/lib/ultracart_api/models/workflow_tasks_response.rb +0 -234
  1765. data/lib/ultracart_api/models/workflow_user.rb +0 -205
  1766. data/lib/ultracart_api/models/workflow_user_response.rb +0 -221
  1767. data/lib/ultracart_api/models/workflow_users_response.rb +0 -234
@@ -1,4583 +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 websocket authorization
739
- # Retrieve a JWT to authorize an agent to make a websocket connection.
740
- # @param [Hash] opts the optional parameters
741
- # @return [ConversationAgentAuthResponse]
742
- def get_agent_websocket_authorization(opts = {})
743
- data, _status_code, _headers = get_agent_websocket_authorization_with_http_info(opts)
744
- data
745
- end
746
-
747
- # Get agent websocket authorization
748
- # Retrieve a JWT to authorize an agent to make a websocket connection.
749
- # @param [Hash] opts the optional parameters
750
- # @return [Array<(ConversationAgentAuthResponse, Fixnum, Hash)>] ConversationAgentAuthResponse data, response status code and response headers
751
- def get_agent_websocket_authorization_with_http_info(opts = {})
752
- if @api_client.config.debugging
753
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_agent_websocket_authorization ...'
754
- end
755
- # resource path
756
- local_var_path = '/conversation/agent/auth'
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(:PUT, 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 => 'ConversationAgentAuthResponse')
782
- if @api_client.config.debugging
783
- @api_client.config.logger.debug "API called: ConversationApi#get_agent_websocket_authorization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
784
- end
785
- return data, status_code, headers
786
- end
787
- # Retrieve a conversation
788
- # Retrieve a conversation including the participants and messages
789
- # @param conversation_uuid
790
- # @param [Hash] opts the optional parameters
791
- # @option opts [Integer] :limit
792
- # @return [ConversationResponse]
793
- def get_conversation(conversation_uuid, opts = {})
794
- data, _status_code, _headers = get_conversation_with_http_info(conversation_uuid, opts)
795
- data
796
- end
797
-
798
- # Retrieve a conversation
799
- # Retrieve a conversation including the participants and messages
800
- # @param conversation_uuid
801
- # @param [Hash] opts the optional parameters
802
- # @option opts [Integer] :limit
803
- # @return [Array<(ConversationResponse, Fixnum, Hash)>] ConversationResponse data, response status code and response headers
804
- def get_conversation_with_http_info(conversation_uuid, opts = {})
805
- if @api_client.config.debugging
806
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation ...'
807
- end
808
- # verify the required parameter 'conversation_uuid' is set
809
- if @api_client.config.client_side_validation && conversation_uuid.nil?
810
- fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.get_conversation"
811
- end
812
- # resource path
813
- local_var_path = '/conversation/conversations/{conversation_uuid}'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.to_s)
814
-
815
- # query parameters
816
- query_params = {}
817
- query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
818
-
819
- # header parameters
820
- header_params = {}
821
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
822
- # HTTP header 'Accept' (if needed)
823
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
824
- # HTTP header 'Content-Type'
825
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
826
-
827
- # form parameters
828
- form_params = {}
829
-
830
- # http body (model)
831
- post_body = nil
832
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
833
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
834
- :header_params => header_params,
835
- :query_params => query_params,
836
- :form_params => form_params,
837
- :body => post_body,
838
- :auth_names => auth_names,
839
- :return_type => 'ConversationResponse')
840
- if @api_client.config.debugging
841
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
842
- end
843
- return data, status_code, headers
844
- end
845
- # Retrieve a list of canned messages ordered by short_code
846
- # Retrieve a list of canned messages ordered by short_code
847
- # @param [Hash] opts the optional parameters
848
- # @return [ConversationCannedMessagesResponse]
849
- def get_conversation_canned_messages(opts = {})
850
- data, _status_code, _headers = get_conversation_canned_messages_with_http_info(opts)
851
- data
852
- end
853
-
854
- # Retrieve a list of canned messages ordered by short_code
855
- # Retrieve a list of canned messages ordered by short_code
856
- # @param [Hash] opts the optional parameters
857
- # @return [Array<(ConversationCannedMessagesResponse, Fixnum, Hash)>] ConversationCannedMessagesResponse data, response status code and response headers
858
- def get_conversation_canned_messages_with_http_info(opts = {})
859
- if @api_client.config.debugging
860
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_canned_messages ...'
861
- end
862
- # resource path
863
- local_var_path = '/conversation/canned_messages'
864
-
865
- # query parameters
866
- query_params = {}
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 => 'ConversationCannedMessagesResponse')
889
- if @api_client.config.debugging
890
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_canned_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
891
- end
892
- return data, status_code, headers
893
- end
894
- # Get a webchat conversation context
895
- # Get a webchat conversation context
896
- # @param conversation_uuid
897
- # @param [Hash] opts the optional parameters
898
- # @return [ConversationWebchatContext]
899
- def get_conversation_context(conversation_uuid, opts = {})
900
- data, _status_code, _headers = get_conversation_context_with_http_info(conversation_uuid, opts)
901
- data
902
- end
903
-
904
- # Get a webchat conversation context
905
- # Get a webchat conversation context
906
- # @param conversation_uuid
907
- # @param [Hash] opts the optional parameters
908
- # @return [Array<(ConversationWebchatContext, Fixnum, Hash)>] ConversationWebchatContext data, response status code and response headers
909
- def get_conversation_context_with_http_info(conversation_uuid, opts = {})
910
- if @api_client.config.debugging
911
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_context ...'
912
- end
913
- # verify the required parameter 'conversation_uuid' is set
914
- if @api_client.config.client_side_validation && conversation_uuid.nil?
915
- fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.get_conversation_context"
916
- end
917
- # resource path
918
- local_var_path = '/conversation/conversations/{conversation_uuid}/context'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.to_s)
919
-
920
- # query parameters
921
- query_params = {}
922
-
923
- # header parameters
924
- header_params = {}
925
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
926
- # HTTP header 'Accept' (if needed)
927
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
928
- # HTTP header 'Content-Type'
929
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
930
-
931
- # form parameters
932
- form_params = {}
933
-
934
- # http body (model)
935
- post_body = nil
936
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
937
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
938
- :header_params => header_params,
939
- :query_params => query_params,
940
- :form_params => form_params,
941
- :body => post_body,
942
- :auth_names => auth_names,
943
- :return_type => 'ConversationWebchatContext')
944
- if @api_client.config.debugging
945
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_context\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
946
- end
947
- return data, status_code, headers
948
- end
949
- # Retrieve a list of possible department members
950
- # Retrieve a list of possible department members
951
- # @param [Hash] opts the optional parameters
952
- # @return [ConversationDepartmentMembersResponse]
953
- def get_conversation_department_member_list(opts = {})
954
- data, _status_code, _headers = get_conversation_department_member_list_with_http_info(opts)
955
- data
956
- end
957
-
958
- # Retrieve a list of possible department members
959
- # Retrieve a list of possible department members
960
- # @param [Hash] opts the optional parameters
961
- # @return [Array<(ConversationDepartmentMembersResponse, Fixnum, Hash)>] ConversationDepartmentMembersResponse data, response status code and response headers
962
- def get_conversation_department_member_list_with_http_info(opts = {})
963
- if @api_client.config.debugging
964
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_department_member_list ...'
965
- end
966
- # resource path
967
- local_var_path = '/conversation/department_members'
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(:GET, 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 => 'ConversationDepartmentMembersResponse')
993
- if @api_client.config.debugging
994
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_department_member_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
995
- end
996
- return data, status_code, headers
997
- end
998
- # Retrieve a list of departments ordered by name
999
- # Retrieve a list of departments ordered by name
1000
- # @param [Hash] opts the optional parameters
1001
- # @return [ConversationDepartmentsResponse]
1002
- def get_conversation_departments(opts = {})
1003
- data, _status_code, _headers = get_conversation_departments_with_http_info(opts)
1004
- data
1005
- end
1006
-
1007
- # Retrieve a list of departments ordered by name
1008
- # Retrieve a list of departments ordered by name
1009
- # @param [Hash] opts the optional parameters
1010
- # @return [Array<(ConversationDepartmentsResponse, Fixnum, Hash)>] ConversationDepartmentsResponse data, response status code and response headers
1011
- def get_conversation_departments_with_http_info(opts = {})
1012
- if @api_client.config.debugging
1013
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_departments ...'
1014
- end
1015
- # resource path
1016
- local_var_path = '/conversation/departments'
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 => 'ConversationDepartmentsResponse')
1042
- if @api_client.config.debugging
1043
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_departments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1044
- end
1045
- return data, status_code, headers
1046
- end
1047
- # Retrieve an engagement
1048
- # Retrieve an engagement
1049
- # @param conversation_engagement_oid
1050
- # @param [Hash] opts the optional parameters
1051
- # @return [ConversationEngagementResponse]
1052
- def get_conversation_engagement(conversation_engagement_oid, opts = {})
1053
- data, _status_code, _headers = get_conversation_engagement_with_http_info(conversation_engagement_oid, opts)
1054
- data
1055
- end
1056
-
1057
- # Retrieve an engagement
1058
- # Retrieve an engagement
1059
- # @param conversation_engagement_oid
1060
- # @param [Hash] opts the optional parameters
1061
- # @return [Array<(ConversationEngagementResponse, Fixnum, Hash)>] ConversationEngagementResponse data, response status code and response headers
1062
- def get_conversation_engagement_with_http_info(conversation_engagement_oid, opts = {})
1063
- if @api_client.config.debugging
1064
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_engagement ...'
1065
- end
1066
- # verify the required parameter 'conversation_engagement_oid' is set
1067
- if @api_client.config.client_side_validation && conversation_engagement_oid.nil?
1068
- fail ArgumentError, "Missing the required parameter 'conversation_engagement_oid' when calling ConversationApi.get_conversation_engagement"
1069
- end
1070
- # resource path
1071
- local_var_path = '/conversation/engagements/{conversation_engagement_oid}'.sub('{' + 'conversation_engagement_oid' + '}', conversation_engagement_oid.to_s)
1072
-
1073
- # query parameters
1074
- query_params = {}
1075
-
1076
- # header parameters
1077
- header_params = {}
1078
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1079
- # HTTP header 'Accept' (if needed)
1080
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1081
- # HTTP header 'Content-Type'
1082
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1083
-
1084
- # form parameters
1085
- form_params = {}
1086
-
1087
- # http body (model)
1088
- post_body = nil
1089
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1090
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1091
- :header_params => header_params,
1092
- :query_params => query_params,
1093
- :form_params => form_params,
1094
- :body => post_body,
1095
- :auth_names => auth_names,
1096
- :return_type => 'ConversationEngagementResponse')
1097
- if @api_client.config.debugging
1098
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_engagement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1099
- end
1100
- return data, status_code, headers
1101
- end
1102
- # Retrieve a list of engagements ordered by name
1103
- # Retrieve a list of engagements ordered by name
1104
- # @param [Hash] opts the optional parameters
1105
- # @return [ConversationEngagementsResponse]
1106
- def get_conversation_engagements(opts = {})
1107
- data, _status_code, _headers = get_conversation_engagements_with_http_info(opts)
1108
- data
1109
- end
1110
-
1111
- # Retrieve a list of engagements ordered by name
1112
- # Retrieve a list of engagements ordered by name
1113
- # @param [Hash] opts the optional parameters
1114
- # @return [Array<(ConversationEngagementsResponse, Fixnum, Hash)>] ConversationEngagementsResponse data, response status code and response headers
1115
- def get_conversation_engagements_with_http_info(opts = {})
1116
- if @api_client.config.debugging
1117
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_engagements ...'
1118
- end
1119
- # resource path
1120
- local_var_path = '/conversation/engagements'
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 => 'ConversationEngagementsResponse')
1146
- if @api_client.config.debugging
1147
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_engagements\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1148
- end
1149
- return data, status_code, headers
1150
- end
1151
- # Retrieve conversation messages
1152
- # Retrieve conversation messages since a particular time
1153
- # @param conversation_uuid
1154
- # @param since
1155
- # @param [Hash] opts the optional parameters
1156
- # @option opts [Integer] :limit
1157
- # @return [ConversationMessagesResponse]
1158
- def get_conversation_messages(conversation_uuid, since, opts = {})
1159
- data, _status_code, _headers = get_conversation_messages_with_http_info(conversation_uuid, since, opts)
1160
- data
1161
- end
1162
-
1163
- # Retrieve conversation messages
1164
- # Retrieve conversation messages since a particular time
1165
- # @param conversation_uuid
1166
- # @param since
1167
- # @param [Hash] opts the optional parameters
1168
- # @option opts [Integer] :limit
1169
- # @return [Array<(ConversationMessagesResponse, Fixnum, Hash)>] ConversationMessagesResponse data, response status code and response headers
1170
- def get_conversation_messages_with_http_info(conversation_uuid, since, opts = {})
1171
- if @api_client.config.debugging
1172
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_messages ...'
1173
- end
1174
- # verify the required parameter 'conversation_uuid' is set
1175
- if @api_client.config.client_side_validation && conversation_uuid.nil?
1176
- fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.get_conversation_messages"
1177
- end
1178
- # verify the required parameter 'since' is set
1179
- if @api_client.config.client_side_validation && since.nil?
1180
- fail ArgumentError, "Missing the required parameter 'since' when calling ConversationApi.get_conversation_messages"
1181
- end
1182
- # resource path
1183
- local_var_path = '/conversation/conversations/{conversation_uuid}/messages/{since}'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.to_s).sub('{' + 'since' + '}', since.to_s)
1184
-
1185
- # query parameters
1186
- query_params = {}
1187
- query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
1188
-
1189
- # header parameters
1190
- header_params = {}
1191
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1192
- # HTTP header 'Accept' (if needed)
1193
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1194
- # HTTP header 'Content-Type'
1195
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1196
-
1197
- # form parameters
1198
- form_params = {}
1199
-
1200
- # http body (model)
1201
- post_body = nil
1202
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1203
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1204
- :header_params => header_params,
1205
- :query_params => query_params,
1206
- :form_params => form_params,
1207
- :body => post_body,
1208
- :auth_names => auth_names,
1209
- :return_type => 'ConversationMessagesResponse')
1210
- if @api_client.config.debugging
1211
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1212
- end
1213
- return data, status_code, headers
1214
- end
1215
- # Get a presigned conversation multimedia upload URL
1216
- # Get a presigned conversation multimedia upload URL
1217
- # @param extension
1218
- # @param [Hash] opts the optional parameters
1219
- # @return [ConversationMultimediaUploadUrlResponse]
1220
- def get_conversation_multimedia_upload_url(extension, opts = {})
1221
- data, _status_code, _headers = get_conversation_multimedia_upload_url_with_http_info(extension, opts)
1222
- data
1223
- end
1224
-
1225
- # Get a presigned conversation multimedia upload URL
1226
- # Get a presigned conversation multimedia upload URL
1227
- # @param extension
1228
- # @param [Hash] opts the optional parameters
1229
- # @return [Array<(ConversationMultimediaUploadUrlResponse, Fixnum, Hash)>] ConversationMultimediaUploadUrlResponse data, response status code and response headers
1230
- def get_conversation_multimedia_upload_url_with_http_info(extension, opts = {})
1231
- if @api_client.config.debugging
1232
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_multimedia_upload_url ...'
1233
- end
1234
- # verify the required parameter 'extension' is set
1235
- if @api_client.config.client_side_validation && extension.nil?
1236
- fail ArgumentError, "Missing the required parameter 'extension' when calling ConversationApi.get_conversation_multimedia_upload_url"
1237
- end
1238
- # resource path
1239
- local_var_path = '/conversation/upload_url/{extension}'.sub('{' + 'extension' + '}', extension.to_s)
1240
-
1241
- # query parameters
1242
- query_params = {}
1243
-
1244
- # header parameters
1245
- header_params = {}
1246
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1247
- # HTTP header 'Accept' (if needed)
1248
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1249
- # HTTP header 'Content-Type'
1250
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1251
-
1252
- # form parameters
1253
- form_params = {}
1254
-
1255
- # http body (model)
1256
- post_body = nil
1257
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1258
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1259
- :header_params => header_params,
1260
- :query_params => query_params,
1261
- :form_params => form_params,
1262
- :body => post_body,
1263
- :auth_names => auth_names,
1264
- :return_type => 'ConversationMultimediaUploadUrlResponse')
1265
- if @api_client.config.debugging
1266
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_multimedia_upload_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1267
- end
1268
- return data, status_code, headers
1269
- end
1270
- # Get a pre-signed conversation multimedia upload URL
1271
- # Get a pre-signed conversation multimedia upload URL
1272
- # @param extension
1273
- # @param [Hash] opts the optional parameters
1274
- # @return [ConversationPbxAudioUploadUrlResponse]
1275
- def get_conversation_pbx_audio_upload_url(extension, opts = {})
1276
- data, _status_code, _headers = get_conversation_pbx_audio_upload_url_with_http_info(extension, opts)
1277
- data
1278
- end
1279
-
1280
- # Get a pre-signed conversation multimedia upload URL
1281
- # Get a pre-signed conversation multimedia upload URL
1282
- # @param extension
1283
- # @param [Hash] opts the optional parameters
1284
- # @return [Array<(ConversationPbxAudioUploadUrlResponse, Fixnum, Hash)>] ConversationPbxAudioUploadUrlResponse data, response status code and response headers
1285
- def get_conversation_pbx_audio_upload_url_with_http_info(extension, opts = {})
1286
- if @api_client.config.debugging
1287
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_pbx_audio_upload_url ...'
1288
- end
1289
- # verify the required parameter 'extension' is set
1290
- if @api_client.config.client_side_validation && extension.nil?
1291
- fail ArgumentError, "Missing the required parameter 'extension' when calling ConversationApi.get_conversation_pbx_audio_upload_url"
1292
- end
1293
- # resource path
1294
- local_var_path = '/conversation/pbx/audio/upload_url/{extension}'.sub('{' + 'extension' + '}', extension.to_s)
1295
-
1296
- # query parameters
1297
- query_params = {}
1298
-
1299
- # header parameters
1300
- header_params = {}
1301
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1302
- # HTTP header 'Accept' (if needed)
1303
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1304
- # HTTP header 'Content-Type'
1305
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1306
-
1307
- # form parameters
1308
- form_params = {}
1309
-
1310
- # http body (model)
1311
- post_body = nil
1312
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1313
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1314
- :header_params => header_params,
1315
- :query_params => query_params,
1316
- :form_params => form_params,
1317
- :body => post_body,
1318
- :auth_names => auth_names,
1319
- :return_type => 'ConversationPbxAudioUploadUrlResponse')
1320
- if @api_client.config.debugging
1321
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_pbx_audio_upload_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1322
- end
1323
- return data, status_code, headers
1324
- end
1325
- # Get orders and customer information for a phone number
1326
- # Retrieves all the orders, auto orders, and customer profile for a given phone number
1327
- # @param pbx_customer_snapshot_request Conversation pbx customer snapshot request
1328
- # @param [Hash] opts the optional parameters
1329
- # @return [ConversationPbxCustomerSnapshotResponse]
1330
- def get_conversation_pbx_customer_snapshot(pbx_customer_snapshot_request, opts = {})
1331
- data, _status_code, _headers = get_conversation_pbx_customer_snapshot_with_http_info(pbx_customer_snapshot_request, opts)
1332
- data
1333
- end
1334
-
1335
- # Get orders and customer information for a phone number
1336
- # Retrieves all the orders, auto orders, and customer profile for a given phone number
1337
- # @param pbx_customer_snapshot_request Conversation pbx customer snapshot request
1338
- # @param [Hash] opts the optional parameters
1339
- # @return [Array<(ConversationPbxCustomerSnapshotResponse, Fixnum, Hash)>] ConversationPbxCustomerSnapshotResponse data, response status code and response headers
1340
- def get_conversation_pbx_customer_snapshot_with_http_info(pbx_customer_snapshot_request, opts = {})
1341
- if @api_client.config.debugging
1342
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_pbx_customer_snapshot ...'
1343
- end
1344
- # verify the required parameter 'pbx_customer_snapshot_request' is set
1345
- if @api_client.config.client_side_validation && pbx_customer_snapshot_request.nil?
1346
- fail ArgumentError, "Missing the required parameter 'pbx_customer_snapshot_request' when calling ConversationApi.get_conversation_pbx_customer_snapshot"
1347
- end
1348
- # resource path
1349
- local_var_path = '/conversation/pbx/customer_snapshot'
1350
-
1351
- # query parameters
1352
- query_params = {}
1353
-
1354
- # header parameters
1355
- header_params = {}
1356
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1357
- # HTTP header 'Accept' (if needed)
1358
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1359
- # HTTP header 'Content-Type'
1360
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1361
-
1362
- # form parameters
1363
- form_params = {}
1364
-
1365
- # http body (model)
1366
- post_body = @api_client.object_to_http_body(pbx_customer_snapshot_request)
1367
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1368
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1369
- :header_params => header_params,
1370
- :query_params => query_params,
1371
- :form_params => form_params,
1372
- :body => post_body,
1373
- :auth_names => auth_names,
1374
- :return_type => 'ConversationPbxCustomerSnapshotResponse')
1375
- if @api_client.config.debugging
1376
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_pbx_customer_snapshot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1377
- end
1378
- return data, status_code, headers
1379
- end
1380
- # Retrieve conversation permissions
1381
- # Retrieve conversation permissions
1382
- # @param [Hash] opts the optional parameters
1383
- # @return [ConversationPermissionsResponse]
1384
- def get_conversation_permissions(opts = {})
1385
- data, _status_code, _headers = get_conversation_permissions_with_http_info(opts)
1386
- data
1387
- end
1388
-
1389
- # Retrieve conversation permissions
1390
- # Retrieve conversation permissions
1391
- # @param [Hash] opts the optional parameters
1392
- # @return [Array<(ConversationPermissionsResponse, Fixnum, Hash)>] ConversationPermissionsResponse data, response status code and response headers
1393
- def get_conversation_permissions_with_http_info(opts = {})
1394
- if @api_client.config.debugging
1395
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_permissions ...'
1396
- end
1397
- # resource path
1398
- local_var_path = '/conversation/permissions'
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 = nil
1416
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1417
- data, status_code, headers = @api_client.call_api(:GET, 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 => 'ConversationPermissionsResponse')
1424
- if @api_client.config.debugging
1425
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1426
- end
1427
- return data, status_code, headers
1428
- end
1429
- # Retrieve a conversation webchat queue statuses
1430
- # Retrieve a conversation webchat queue statuses including agent status and queue entries
1431
- # @param [Hash] opts the optional parameters
1432
- # @return [ConversationWebchatQueueStatusesResponse]
1433
- def get_conversation_webchat_queue_statuses(opts = {})
1434
- data, _status_code, _headers = get_conversation_webchat_queue_statuses_with_http_info(opts)
1435
- data
1436
- end
1437
-
1438
- # Retrieve a conversation webchat queue statuses
1439
- # Retrieve a conversation webchat queue statuses including agent status and queue entries
1440
- # @param [Hash] opts the optional parameters
1441
- # @return [Array<(ConversationWebchatQueueStatusesResponse, Fixnum, Hash)>] ConversationWebchatQueueStatusesResponse data, response status code and response headers
1442
- def get_conversation_webchat_queue_statuses_with_http_info(opts = {})
1443
- if @api_client.config.debugging
1444
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_webchat_queue_statuses ...'
1445
- end
1446
- # resource path
1447
- local_var_path = '/conversation/conversations/queues/statuses'
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 => 'ConversationWebchatQueueStatusesResponse')
1473
- if @api_client.config.debugging
1474
- @api_client.config.logger.debug "API called: ConversationApi#get_conversation_webchat_queue_statuses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1475
- end
1476
- return data, status_code, headers
1477
- end
1478
- # Retrieve a list of conversation summaries newest to oldest
1479
- # Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
1480
- # @param [Hash] opts the optional parameters
1481
- # @option opts [String] :medium
1482
- # @option opts [String] :before
1483
- # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Max 200) (default to 100)
1484
- # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
1485
- # @return [ConversationsResponse]
1486
- def get_conversations(opts = {})
1487
- data, _status_code, _headers = get_conversations_with_http_info(opts)
1488
- data
1489
- end
1490
-
1491
- # Retrieve a list of conversation summaries newest to oldest
1492
- # Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
1493
- # @param [Hash] opts the optional parameters
1494
- # @option opts [String] :medium
1495
- # @option opts [String] :before
1496
- # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Max 200)
1497
- # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index.
1498
- # @return [Array<(ConversationsResponse, Fixnum, Hash)>] ConversationsResponse data, response status code and response headers
1499
- def get_conversations_with_http_info(opts = {})
1500
- if @api_client.config.debugging
1501
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversations ...'
1502
- end
1503
- # resource path
1504
- local_var_path = '/conversation/conversations'
1505
-
1506
- # query parameters
1507
- query_params = {}
1508
- query_params[:'medium'] = opts[:'medium'] if !opts[:'medium'].nil?
1509
- query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
1510
- query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
1511
- query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
1512
-
1513
- # header parameters
1514
- header_params = {}
1515
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1516
- # HTTP header 'Accept' (if needed)
1517
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1518
- # HTTP header 'Content-Type'
1519
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1520
-
1521
- # form parameters
1522
- form_params = {}
1523
-
1524
- # http body (model)
1525
- post_body = nil
1526
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1527
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1528
- :header_params => header_params,
1529
- :query_params => query_params,
1530
- :form_params => form_params,
1531
- :body => post_body,
1532
- :auth_names => auth_names,
1533
- :return_type => 'ConversationsResponse')
1534
- if @api_client.config.debugging
1535
- @api_client.config.logger.debug "API called: ConversationApi#get_conversations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1536
- end
1537
- return data, status_code, headers
1538
- end
1539
- # Retrieve a list of matching terms for a search field
1540
- # Retrieve a list of matching terms for a search field
1541
- # @param autocomplete_request Autocomplete Request
1542
- # @param [Hash] opts the optional parameters
1543
- # @return [ConversationAutocompleteResponse]
1544
- def get_conversations_autocomplete(autocomplete_request, opts = {})
1545
- data, _status_code, _headers = get_conversations_autocomplete_with_http_info(autocomplete_request, opts)
1546
- data
1547
- end
1548
-
1549
- # Retrieve a list of matching terms for a search field
1550
- # Retrieve a list of matching terms for a search field
1551
- # @param autocomplete_request Autocomplete Request
1552
- # @param [Hash] opts the optional parameters
1553
- # @return [Array<(ConversationAutocompleteResponse, Fixnum, Hash)>] ConversationAutocompleteResponse data, response status code and response headers
1554
- def get_conversations_autocomplete_with_http_info(autocomplete_request, opts = {})
1555
- if @api_client.config.debugging
1556
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversations_autocomplete ...'
1557
- end
1558
- # verify the required parameter 'autocomplete_request' is set
1559
- if @api_client.config.client_side_validation && autocomplete_request.nil?
1560
- fail ArgumentError, "Missing the required parameter 'autocomplete_request' when calling ConversationApi.get_conversations_autocomplete"
1561
- end
1562
- # resource path
1563
- local_var_path = '/conversation/conversations/autocomplete'
1564
-
1565
- # query parameters
1566
- query_params = {}
1567
-
1568
- # header parameters
1569
- header_params = {}
1570
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1571
- # HTTP header 'Accept' (if needed)
1572
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1573
- # HTTP header 'Content-Type'
1574
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1575
-
1576
- # form parameters
1577
- form_params = {}
1578
-
1579
- # http body (model)
1580
- post_body = @api_client.object_to_http_body(autocomplete_request)
1581
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1582
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1583
- :header_params => header_params,
1584
- :query_params => query_params,
1585
- :form_params => form_params,
1586
- :body => post_body,
1587
- :auth_names => auth_names,
1588
- :return_type => 'ConversationAutocompleteResponse')
1589
- if @api_client.config.debugging
1590
- @api_client.config.logger.debug "API called: ConversationApi#get_conversations_autocomplete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1591
- end
1592
- return data, status_code, headers
1593
- end
1594
- # Search conversations
1595
- # Search conversations
1596
- # @param search_request Search Request
1597
- # @param [Hash] opts the optional parameters
1598
- # @return [ConversationSearchResponse]
1599
- def get_conversations_search(search_request, opts = {})
1600
- data, _status_code, _headers = get_conversations_search_with_http_info(search_request, opts)
1601
- data
1602
- end
1603
-
1604
- # Search conversations
1605
- # Search conversations
1606
- # @param search_request Search Request
1607
- # @param [Hash] opts the optional parameters
1608
- # @return [Array<(ConversationSearchResponse, Fixnum, Hash)>] ConversationSearchResponse data, response status code and response headers
1609
- def get_conversations_search_with_http_info(search_request, opts = {})
1610
- if @api_client.config.debugging
1611
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversations_search ...'
1612
- end
1613
- # verify the required parameter 'search_request' is set
1614
- if @api_client.config.client_side_validation && search_request.nil?
1615
- fail ArgumentError, "Missing the required parameter 'search_request' when calling ConversationApi.get_conversations_search"
1616
- end
1617
- # resource path
1618
- local_var_path = '/conversation/conversations/search'
1619
-
1620
- # query parameters
1621
- query_params = {}
1622
-
1623
- # header parameters
1624
- header_params = {}
1625
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1626
- # HTTP header 'Accept' (if needed)
1627
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1628
- # HTTP header 'Content-Type'
1629
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1630
-
1631
- # form parameters
1632
- form_params = {}
1633
-
1634
- # http body (model)
1635
- post_body = @api_client.object_to_http_body(search_request)
1636
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1637
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1638
- :header_params => header_params,
1639
- :query_params => query_params,
1640
- :form_params => form_params,
1641
- :body => post_body,
1642
- :auth_names => auth_names,
1643
- :return_type => 'ConversationSearchResponse')
1644
- if @api_client.config.debugging
1645
- @api_client.config.logger.debug "API called: ConversationApi#get_conversations_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1646
- end
1647
- return data, status_code, headers
1648
- end
1649
- # Get location data for engagement configuration
1650
- # Get location data for engagement configuration
1651
- # @param [Hash] opts the optional parameters
1652
- # @return [ConversationLocationsResponse]
1653
- def get_locations_for_engagement(opts = {})
1654
- data, _status_code, _headers = get_locations_for_engagement_with_http_info(opts)
1655
- data
1656
- end
1657
-
1658
- # Get location data for engagement configuration
1659
- # Get location data for engagement configuration
1660
- # @param [Hash] opts the optional parameters
1661
- # @return [Array<(ConversationLocationsResponse, Fixnum, Hash)>] ConversationLocationsResponse data, response status code and response headers
1662
- def get_locations_for_engagement_with_http_info(opts = {})
1663
- if @api_client.config.debugging
1664
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_locations_for_engagement ...'
1665
- end
1666
- # resource path
1667
- local_var_path = '/conversation/locations'
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 = nil
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 => 'ConversationLocationsResponse')
1693
- if @api_client.config.debugging
1694
- @api_client.config.logger.debug "API called: ConversationApi#get_locations_for_engagement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1695
- end
1696
- return data, status_code, headers
1697
- end
1698
- # Get pbx agent
1699
- # Retrieve a pbx agent
1700
- # @param conversation_pbx_agent_uuid
1701
- # @param [Hash] opts the optional parameters
1702
- # @return [ConversationPbxAgentResponse]
1703
- def get_pbx_agent(conversation_pbx_agent_uuid, opts = {})
1704
- data, _status_code, _headers = get_pbx_agent_with_http_info(conversation_pbx_agent_uuid, opts)
1705
- data
1706
- end
1707
-
1708
- # Get pbx agent
1709
- # Retrieve a pbx agent
1710
- # @param conversation_pbx_agent_uuid
1711
- # @param [Hash] opts the optional parameters
1712
- # @return [Array<(ConversationPbxAgentResponse, Fixnum, Hash)>] ConversationPbxAgentResponse data, response status code and response headers
1713
- def get_pbx_agent_with_http_info(conversation_pbx_agent_uuid, opts = {})
1714
- if @api_client.config.debugging
1715
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_agent ...'
1716
- end
1717
- # verify the required parameter 'conversation_pbx_agent_uuid' is set
1718
- if @api_client.config.client_side_validation && conversation_pbx_agent_uuid.nil?
1719
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_agent_uuid' when calling ConversationApi.get_pbx_agent"
1720
- end
1721
- # resource path
1722
- local_var_path = '/conversation/pbx/agent/{conversationPbxAgentUuid}'.sub('{' + 'conversationPbxAgentUuid' + '}', conversation_pbx_agent_uuid.to_s)
1723
-
1724
- # query parameters
1725
- query_params = {}
1726
-
1727
- # header parameters
1728
- header_params = {}
1729
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1730
- # HTTP header 'Accept' (if needed)
1731
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1732
- # HTTP header 'Content-Type'
1733
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1734
-
1735
- # form parameters
1736
- form_params = {}
1737
-
1738
- # http body (model)
1739
- post_body = nil
1740
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1741
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1742
- :header_params => header_params,
1743
- :query_params => query_params,
1744
- :form_params => form_params,
1745
- :body => post_body,
1746
- :auth_names => auth_names,
1747
- :return_type => 'ConversationPbxAgentResponse')
1748
- if @api_client.config.debugging
1749
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_agent\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1750
- end
1751
- return data, status_code, headers
1752
- end
1753
- # Get Agent Voicemail
1754
- # Retrieve pbx agent Voicemail
1755
- # @param recording_sid
1756
- # @param [Hash] opts the optional parameters
1757
- # @return [ConversationPbxVoicemailMessageResponse]
1758
- def get_pbx_agent_voicemail(recording_sid, opts = {})
1759
- data, _status_code, _headers = get_pbx_agent_voicemail_with_http_info(recording_sid, opts)
1760
- data
1761
- end
1762
-
1763
- # Get Agent Voicemail
1764
- # Retrieve pbx agent Voicemail
1765
- # @param recording_sid
1766
- # @param [Hash] opts the optional parameters
1767
- # @return [Array<(ConversationPbxVoicemailMessageResponse, Fixnum, Hash)>] ConversationPbxVoicemailMessageResponse data, response status code and response headers
1768
- def get_pbx_agent_voicemail_with_http_info(recording_sid, opts = {})
1769
- if @api_client.config.debugging
1770
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_agent_voicemail ...'
1771
- end
1772
- # verify the required parameter 'recording_sid' is set
1773
- if @api_client.config.client_side_validation && recording_sid.nil?
1774
- fail ArgumentError, "Missing the required parameter 'recording_sid' when calling ConversationApi.get_pbx_agent_voicemail"
1775
- end
1776
- # resource path
1777
- local_var_path = '/conversation/pbx/agent/voicemails/{recording_sid}'.sub('{' + 'recording_sid' + '}', recording_sid.to_s)
1778
-
1779
- # query parameters
1780
- query_params = {}
1781
-
1782
- # header parameters
1783
- header_params = {}
1784
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1785
- # HTTP header 'Accept' (if needed)
1786
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1787
- # HTTP header 'Content-Type'
1788
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1789
-
1790
- # form parameters
1791
- form_params = {}
1792
-
1793
- # http body (model)
1794
- post_body = nil
1795
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1796
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1797
- :header_params => header_params,
1798
- :query_params => query_params,
1799
- :form_params => form_params,
1800
- :body => post_body,
1801
- :auth_names => auth_names,
1802
- :return_type => 'ConversationPbxVoicemailMessageResponse')
1803
- if @api_client.config.debugging
1804
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_agent_voicemail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1805
- end
1806
- return data, status_code, headers
1807
- end
1808
- # Get Agent Voicemails
1809
- # Retrieve pbx agent Voicemails
1810
- # @param [Hash] opts the optional parameters
1811
- # @return [ConversationPbxVoicemailMessageSummariesResponse]
1812
- def get_pbx_agent_voicemails(opts = {})
1813
- data, _status_code, _headers = get_pbx_agent_voicemails_with_http_info(opts)
1814
- data
1815
- end
1816
-
1817
- # Get Agent Voicemails
1818
- # Retrieve pbx agent Voicemails
1819
- # @param [Hash] opts the optional parameters
1820
- # @return [Array<(ConversationPbxVoicemailMessageSummariesResponse, Fixnum, Hash)>] ConversationPbxVoicemailMessageSummariesResponse data, response status code and response headers
1821
- def get_pbx_agent_voicemails_with_http_info(opts = {})
1822
- if @api_client.config.debugging
1823
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_agent_voicemails ...'
1824
- end
1825
- # resource path
1826
- local_var_path = '/conversation/pbx/agent/voicemails'
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 => 'ConversationPbxVoicemailMessageSummariesResponse')
1852
- if @api_client.config.debugging
1853
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_agent_voicemails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1854
- end
1855
- return data, status_code, headers
1856
- end
1857
- # Get pbx agents
1858
- # Retrieve pbx agents
1859
- # @param [Hash] opts the optional parameters
1860
- # @return [ConversationPbxAgentsResponse]
1861
- def get_pbx_agents(opts = {})
1862
- data, _status_code, _headers = get_pbx_agents_with_http_info(opts)
1863
- data
1864
- end
1865
-
1866
- # Get pbx agents
1867
- # Retrieve pbx agents
1868
- # @param [Hash] opts the optional parameters
1869
- # @return [Array<(ConversationPbxAgentsResponse, Fixnum, Hash)>] ConversationPbxAgentsResponse data, response status code and response headers
1870
- def get_pbx_agents_with_http_info(opts = {})
1871
- if @api_client.config.debugging
1872
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_agents ...'
1873
- end
1874
- # resource path
1875
- local_var_path = '/conversation/pbx/agent'
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 => 'ConversationPbxAgentsResponse')
1901
- if @api_client.config.debugging
1902
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_agents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1903
- end
1904
- return data, status_code, headers
1905
- end
1906
- # Get pbx audio
1907
- # Retrieve a pbx audio
1908
- # @param conversation_pbx_audio_uuid
1909
- # @param [Hash] opts the optional parameters
1910
- # @return [ConversationPbxAudioResponse]
1911
- def get_pbx_audio(conversation_pbx_audio_uuid, opts = {})
1912
- data, _status_code, _headers = get_pbx_audio_with_http_info(conversation_pbx_audio_uuid, opts)
1913
- data
1914
- end
1915
-
1916
- # Get pbx audio
1917
- # Retrieve a pbx audio
1918
- # @param conversation_pbx_audio_uuid
1919
- # @param [Hash] opts the optional parameters
1920
- # @return [Array<(ConversationPbxAudioResponse, Fixnum, Hash)>] ConversationPbxAudioResponse data, response status code and response headers
1921
- def get_pbx_audio_with_http_info(conversation_pbx_audio_uuid, opts = {})
1922
- if @api_client.config.debugging
1923
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_audio ...'
1924
- end
1925
- # verify the required parameter 'conversation_pbx_audio_uuid' is set
1926
- if @api_client.config.client_side_validation && conversation_pbx_audio_uuid.nil?
1927
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_audio_uuid' when calling ConversationApi.get_pbx_audio"
1928
- end
1929
- # resource path
1930
- local_var_path = '/conversation/pbx/audio/{conversationPbxAudioUuid}'.sub('{' + 'conversationPbxAudioUuid' + '}', conversation_pbx_audio_uuid.to_s)
1931
-
1932
- # query parameters
1933
- query_params = {}
1934
-
1935
- # header parameters
1936
- header_params = {}
1937
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1938
- # HTTP header 'Accept' (if needed)
1939
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1940
- # HTTP header 'Content-Type'
1941
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1942
-
1943
- # form parameters
1944
- form_params = {}
1945
-
1946
- # http body (model)
1947
- post_body = nil
1948
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1949
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1950
- :header_params => header_params,
1951
- :query_params => query_params,
1952
- :form_params => form_params,
1953
- :body => post_body,
1954
- :auth_names => auth_names,
1955
- :return_type => 'ConversationPbxAudioResponse')
1956
- if @api_client.config.debugging
1957
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_audio\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1958
- end
1959
- return data, status_code, headers
1960
- end
1961
- # Get pbx audio usage
1962
- # Retrieve a pbx audio usage
1963
- # @param conversation_pbx_audio_uuid
1964
- # @param [Hash] opts the optional parameters
1965
- # @return [ConversationPbxAudioUsageResponse]
1966
- def get_pbx_audio_usage(conversation_pbx_audio_uuid, opts = {})
1967
- data, _status_code, _headers = get_pbx_audio_usage_with_http_info(conversation_pbx_audio_uuid, opts)
1968
- data
1969
- end
1970
-
1971
- # Get pbx audio usage
1972
- # Retrieve a pbx audio usage
1973
- # @param conversation_pbx_audio_uuid
1974
- # @param [Hash] opts the optional parameters
1975
- # @return [Array<(ConversationPbxAudioUsageResponse, Fixnum, Hash)>] ConversationPbxAudioUsageResponse data, response status code and response headers
1976
- def get_pbx_audio_usage_with_http_info(conversation_pbx_audio_uuid, opts = {})
1977
- if @api_client.config.debugging
1978
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_audio_usage ...'
1979
- end
1980
- # verify the required parameter 'conversation_pbx_audio_uuid' is set
1981
- if @api_client.config.client_side_validation && conversation_pbx_audio_uuid.nil?
1982
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_audio_uuid' when calling ConversationApi.get_pbx_audio_usage"
1983
- end
1984
- # resource path
1985
- local_var_path = '/conversation/pbx/audio/{conversationPbxAudioUuid}/usage'.sub('{' + 'conversationPbxAudioUuid' + '}', conversation_pbx_audio_uuid.to_s)
1986
-
1987
- # query parameters
1988
- query_params = {}
1989
-
1990
- # header parameters
1991
- header_params = {}
1992
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1993
- # HTTP header 'Accept' (if needed)
1994
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1995
- # HTTP header 'Content-Type'
1996
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1997
-
1998
- # form parameters
1999
- form_params = {}
2000
-
2001
- # http body (model)
2002
- post_body = nil
2003
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
2004
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2005
- :header_params => header_params,
2006
- :query_params => query_params,
2007
- :form_params => form_params,
2008
- :body => post_body,
2009
- :auth_names => auth_names,
2010
- :return_type => 'ConversationPbxAudioUsageResponse')
2011
- if @api_client.config.debugging
2012
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_audio_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2013
- end
2014
- return data, status_code, headers
2015
- end
2016
- # Get pbx audios
2017
- # Retrieve pbx audios
2018
- # @param [Hash] opts the optional parameters
2019
- # @return [ConversationPbxAudiosResponse]
2020
- def get_pbx_audios(opts = {})
2021
- data, _status_code, _headers = get_pbx_audios_with_http_info(opts)
2022
- data
2023
- end
2024
-
2025
- # Get pbx audios
2026
- # Retrieve pbx audios
2027
- # @param [Hash] opts the optional parameters
2028
- # @return [Array<(ConversationPbxAudiosResponse, Fixnum, Hash)>] ConversationPbxAudiosResponse data, response status code and response headers
2029
- def get_pbx_audios_with_http_info(opts = {})
2030
- if @api_client.config.debugging
2031
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_audios ...'
2032
- end
2033
- # resource path
2034
- local_var_path = '/conversation/pbx/audio'
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 => 'ConversationPbxAudiosResponse')
2060
- if @api_client.config.debugging
2061
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_audios\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2062
- end
2063
- return data, status_code, headers
2064
- end
2065
- # Get pbx menu
2066
- # Retrieve a pbx menu
2067
- # @param conversation_pbx_menu_uuid
2068
- # @param [Hash] opts the optional parameters
2069
- # @return [ConversationPbxMenuResponse]
2070
- def get_pbx_menu(conversation_pbx_menu_uuid, opts = {})
2071
- data, _status_code, _headers = get_pbx_menu_with_http_info(conversation_pbx_menu_uuid, opts)
2072
- data
2073
- end
2074
-
2075
- # Get pbx menu
2076
- # Retrieve a pbx menu
2077
- # @param conversation_pbx_menu_uuid
2078
- # @param [Hash] opts the optional parameters
2079
- # @return [Array<(ConversationPbxMenuResponse, Fixnum, Hash)>] ConversationPbxMenuResponse data, response status code and response headers
2080
- def get_pbx_menu_with_http_info(conversation_pbx_menu_uuid, opts = {})
2081
- if @api_client.config.debugging
2082
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_menu ...'
2083
- end
2084
- # verify the required parameter 'conversation_pbx_menu_uuid' is set
2085
- if @api_client.config.client_side_validation && conversation_pbx_menu_uuid.nil?
2086
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_menu_uuid' when calling ConversationApi.get_pbx_menu"
2087
- end
2088
- # resource path
2089
- local_var_path = '/conversation/pbx/menu/{conversationPbxMenuUuid}'.sub('{' + 'conversationPbxMenuUuid' + '}', conversation_pbx_menu_uuid.to_s)
2090
-
2091
- # query parameters
2092
- query_params = {}
2093
-
2094
- # header parameters
2095
- header_params = {}
2096
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2097
- # HTTP header 'Accept' (if needed)
2098
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2099
- # HTTP header 'Content-Type'
2100
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2101
-
2102
- # form parameters
2103
- form_params = {}
2104
-
2105
- # http body (model)
2106
- post_body = nil
2107
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
2108
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2109
- :header_params => header_params,
2110
- :query_params => query_params,
2111
- :form_params => form_params,
2112
- :body => post_body,
2113
- :auth_names => auth_names,
2114
- :return_type => 'ConversationPbxMenuResponse')
2115
- if @api_client.config.debugging
2116
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_menu\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2117
- end
2118
- return data, status_code, headers
2119
- end
2120
- # Get pbx menus
2121
- # Retrieve pbx menus
2122
- # @param [Hash] opts the optional parameters
2123
- # @return [ConversationPbxMenusResponse]
2124
- def get_pbx_menus(opts = {})
2125
- data, _status_code, _headers = get_pbx_menus_with_http_info(opts)
2126
- data
2127
- end
2128
-
2129
- # Get pbx menus
2130
- # Retrieve pbx menus
2131
- # @param [Hash] opts the optional parameters
2132
- # @return [Array<(ConversationPbxMenusResponse, Fixnum, Hash)>] ConversationPbxMenusResponse data, response status code and response headers
2133
- def get_pbx_menus_with_http_info(opts = {})
2134
- if @api_client.config.debugging
2135
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_menus ...'
2136
- end
2137
- # resource path
2138
- local_var_path = '/conversation/pbx/menu'
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 => 'ConversationPbxMenusResponse')
2164
- if @api_client.config.debugging
2165
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_menus\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2166
- end
2167
- return data, status_code, headers
2168
- end
2169
- # Get pbx phoneNumber
2170
- # Retrieve a pbx phoneNumber
2171
- # @param conversation_pbx_phone_number_uuid
2172
- # @param [Hash] opts the optional parameters
2173
- # @return [ConversationPbxPhoneNumberResponse]
2174
- def get_pbx_phone_number(conversation_pbx_phone_number_uuid, opts = {})
2175
- data, _status_code, _headers = get_pbx_phone_number_with_http_info(conversation_pbx_phone_number_uuid, opts)
2176
- data
2177
- end
2178
-
2179
- # Get pbx phoneNumber
2180
- # Retrieve a pbx phoneNumber
2181
- # @param conversation_pbx_phone_number_uuid
2182
- # @param [Hash] opts the optional parameters
2183
- # @return [Array<(ConversationPbxPhoneNumberResponse, Fixnum, Hash)>] ConversationPbxPhoneNumberResponse data, response status code and response headers
2184
- def get_pbx_phone_number_with_http_info(conversation_pbx_phone_number_uuid, opts = {})
2185
- if @api_client.config.debugging
2186
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_phone_number ...'
2187
- end
2188
- # verify the required parameter 'conversation_pbx_phone_number_uuid' is set
2189
- if @api_client.config.client_side_validation && conversation_pbx_phone_number_uuid.nil?
2190
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_phone_number_uuid' when calling ConversationApi.get_pbx_phone_number"
2191
- end
2192
- # resource path
2193
- local_var_path = '/conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid}'.sub('{' + 'conversationPbxPhoneNumberUuid' + '}', conversation_pbx_phone_number_uuid.to_s)
2194
-
2195
- # query parameters
2196
- query_params = {}
2197
-
2198
- # header parameters
2199
- header_params = {}
2200
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2201
- # HTTP header 'Accept' (if needed)
2202
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2203
- # HTTP header 'Content-Type'
2204
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2205
-
2206
- # form parameters
2207
- form_params = {}
2208
-
2209
- # http body (model)
2210
- post_body = nil
2211
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
2212
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2213
- :header_params => header_params,
2214
- :query_params => query_params,
2215
- :form_params => form_params,
2216
- :body => post_body,
2217
- :auth_names => auth_names,
2218
- :return_type => 'ConversationPbxPhoneNumberResponse')
2219
- if @api_client.config.debugging
2220
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_phone_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2221
- end
2222
- return data, status_code, headers
2223
- end
2224
- # Get pbx phoneNumbers
2225
- # Retrieve pbx phoneNumbers
2226
- # @param [Hash] opts the optional parameters
2227
- # @return [ConversationPbxPhoneNumbersResponse]
2228
- def get_pbx_phone_numbers(opts = {})
2229
- data, _status_code, _headers = get_pbx_phone_numbers_with_http_info(opts)
2230
- data
2231
- end
2232
-
2233
- # Get pbx phoneNumbers
2234
- # Retrieve pbx phoneNumbers
2235
- # @param [Hash] opts the optional parameters
2236
- # @return [Array<(ConversationPbxPhoneNumbersResponse, Fixnum, Hash)>] ConversationPbxPhoneNumbersResponse data, response status code and response headers
2237
- def get_pbx_phone_numbers_with_http_info(opts = {})
2238
- if @api_client.config.debugging
2239
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_phone_numbers ...'
2240
- end
2241
- # resource path
2242
- local_var_path = '/conversation/pbx/phone_number'
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 => 'ConversationPbxPhoneNumbersResponse')
2268
- if @api_client.config.debugging
2269
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_phone_numbers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2270
- end
2271
- return data, status_code, headers
2272
- end
2273
- # Get pbx queue
2274
- # Retrieve a pbx queue
2275
- # @param conversation_pbx_queue_uuid
2276
- # @param [Hash] opts the optional parameters
2277
- # @return [ConversationPbxQueueResponse]
2278
- def get_pbx_queue(conversation_pbx_queue_uuid, opts = {})
2279
- data, _status_code, _headers = get_pbx_queue_with_http_info(conversation_pbx_queue_uuid, opts)
2280
- data
2281
- end
2282
-
2283
- # Get pbx queue
2284
- # Retrieve a pbx queue
2285
- # @param conversation_pbx_queue_uuid
2286
- # @param [Hash] opts the optional parameters
2287
- # @return [Array<(ConversationPbxQueueResponse, Fixnum, Hash)>] ConversationPbxQueueResponse data, response status code and response headers
2288
- def get_pbx_queue_with_http_info(conversation_pbx_queue_uuid, opts = {})
2289
- if @api_client.config.debugging
2290
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_queue ...'
2291
- end
2292
- # verify the required parameter 'conversation_pbx_queue_uuid' is set
2293
- if @api_client.config.client_side_validation && conversation_pbx_queue_uuid.nil?
2294
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_queue_uuid' when calling ConversationApi.get_pbx_queue"
2295
- end
2296
- # resource path
2297
- local_var_path = '/conversation/pbx/queue/{conversationPbxQueueUuid}'.sub('{' + 'conversationPbxQueueUuid' + '}', conversation_pbx_queue_uuid.to_s)
2298
-
2299
- # query parameters
2300
- query_params = {}
2301
-
2302
- # header parameters
2303
- header_params = {}
2304
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2305
- # HTTP header 'Accept' (if needed)
2306
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2307
- # HTTP header 'Content-Type'
2308
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2309
-
2310
- # form parameters
2311
- form_params = {}
2312
-
2313
- # http body (model)
2314
- post_body = nil
2315
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
2316
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2317
- :header_params => header_params,
2318
- :query_params => query_params,
2319
- :form_params => form_params,
2320
- :body => post_body,
2321
- :auth_names => auth_names,
2322
- :return_type => 'ConversationPbxQueueResponse')
2323
- if @api_client.config.debugging
2324
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2325
- end
2326
- return data, status_code, headers
2327
- end
2328
- # Get Queue Voicemail
2329
- # Retrieve pbx queue Voicemail
2330
- # @param queue_uuid
2331
- # @param recording_sid
2332
- # @param [Hash] opts the optional parameters
2333
- # @return [ConversationPbxVoicemailMessageResponse]
2334
- def get_pbx_queue_voicemail(queue_uuid, recording_sid, opts = {})
2335
- data, _status_code, _headers = get_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid, opts)
2336
- data
2337
- end
2338
-
2339
- # Get Queue Voicemail
2340
- # Retrieve pbx queue Voicemail
2341
- # @param queue_uuid
2342
- # @param recording_sid
2343
- # @param [Hash] opts the optional parameters
2344
- # @return [Array<(ConversationPbxVoicemailMessageResponse, Fixnum, Hash)>] ConversationPbxVoicemailMessageResponse data, response status code and response headers
2345
- def get_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid, opts = {})
2346
- if @api_client.config.debugging
2347
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_queue_voicemail ...'
2348
- end
2349
- # verify the required parameter 'queue_uuid' is set
2350
- if @api_client.config.client_side_validation && queue_uuid.nil?
2351
- fail ArgumentError, "Missing the required parameter 'queue_uuid' when calling ConversationApi.get_pbx_queue_voicemail"
2352
- end
2353
- # verify the required parameter 'recording_sid' is set
2354
- if @api_client.config.client_side_validation && recording_sid.nil?
2355
- fail ArgumentError, "Missing the required parameter 'recording_sid' when calling ConversationApi.get_pbx_queue_voicemail"
2356
- end
2357
- # resource path
2358
- 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)
2359
-
2360
- # query parameters
2361
- query_params = {}
2362
-
2363
- # header parameters
2364
- header_params = {}
2365
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2366
- # HTTP header 'Accept' (if needed)
2367
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2368
- # HTTP header 'Content-Type'
2369
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2370
-
2371
- # form parameters
2372
- form_params = {}
2373
-
2374
- # http body (model)
2375
- post_body = nil
2376
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
2377
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2378
- :header_params => header_params,
2379
- :query_params => query_params,
2380
- :form_params => form_params,
2381
- :body => post_body,
2382
- :auth_names => auth_names,
2383
- :return_type => 'ConversationPbxVoicemailMessageResponse')
2384
- if @api_client.config.debugging
2385
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_queue_voicemail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2386
- end
2387
- return data, status_code, headers
2388
- end
2389
- # Get Queue Voicemails
2390
- # Retrieve pbx queue voicemails
2391
- # @param queue_uuid
2392
- # @param [Hash] opts the optional parameters
2393
- # @return [ConversationPbxVoicemailMessageSummariesResponse]
2394
- def get_pbx_queue_voicemails(queue_uuid, opts = {})
2395
- data, _status_code, _headers = get_pbx_queue_voicemails_with_http_info(queue_uuid, opts)
2396
- data
2397
- end
2398
-
2399
- # Get Queue Voicemails
2400
- # Retrieve pbx queue voicemails
2401
- # @param queue_uuid
2402
- # @param [Hash] opts the optional parameters
2403
- # @return [Array<(ConversationPbxVoicemailMessageSummariesResponse, Fixnum, Hash)>] ConversationPbxVoicemailMessageSummariesResponse data, response status code and response headers
2404
- def get_pbx_queue_voicemails_with_http_info(queue_uuid, opts = {})
2405
- if @api_client.config.debugging
2406
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_queue_voicemails ...'
2407
- end
2408
- # verify the required parameter 'queue_uuid' is set
2409
- if @api_client.config.client_side_validation && queue_uuid.nil?
2410
- fail ArgumentError, "Missing the required parameter 'queue_uuid' when calling ConversationApi.get_pbx_queue_voicemails"
2411
- end
2412
- # resource path
2413
- local_var_path = '/conversation/pbx/queues/{queue_uuid}/voicemails'.sub('{' + 'queue_uuid' + '}', queue_uuid.to_s)
2414
-
2415
- # query parameters
2416
- query_params = {}
2417
-
2418
- # header parameters
2419
- header_params = {}
2420
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2421
- # HTTP header 'Accept' (if needed)
2422
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2423
- # HTTP header 'Content-Type'
2424
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2425
-
2426
- # form parameters
2427
- form_params = {}
2428
-
2429
- # http body (model)
2430
- post_body = nil
2431
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
2432
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2433
- :header_params => header_params,
2434
- :query_params => query_params,
2435
- :form_params => form_params,
2436
- :body => post_body,
2437
- :auth_names => auth_names,
2438
- :return_type => 'ConversationPbxVoicemailMessageSummariesResponse')
2439
- if @api_client.config.debugging
2440
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_queue_voicemails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2441
- end
2442
- return data, status_code, headers
2443
- end
2444
- # Get pbx queues
2445
- # Retrieve pbx queues
2446
- # @param [Hash] opts the optional parameters
2447
- # @return [ConversationPbxQueuesResponse]
2448
- def get_pbx_queues(opts = {})
2449
- data, _status_code, _headers = get_pbx_queues_with_http_info(opts)
2450
- data
2451
- end
2452
-
2453
- # Get pbx queues
2454
- # Retrieve pbx queues
2455
- # @param [Hash] opts the optional parameters
2456
- # @return [Array<(ConversationPbxQueuesResponse, Fixnum, Hash)>] ConversationPbxQueuesResponse data, response status code and response headers
2457
- def get_pbx_queues_with_http_info(opts = {})
2458
- if @api_client.config.debugging
2459
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_queues ...'
2460
- end
2461
- # resource path
2462
- local_var_path = '/conversation/pbx/queue'
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 => 'ConversationPbxQueuesResponse')
2488
- if @api_client.config.debugging
2489
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_queues\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2490
- end
2491
- return data, status_code, headers
2492
- end
2493
- # Get pbx timeBased
2494
- # Retrieve a pbx timeBased
2495
- # @param conversation_pbx_time_based_uuid
2496
- # @param [Hash] opts the optional parameters
2497
- # @return [ConversationPbxTimeBasedResponse]
2498
- def get_pbx_time_based(conversation_pbx_time_based_uuid, opts = {})
2499
- data, _status_code, _headers = get_pbx_time_based_with_http_info(conversation_pbx_time_based_uuid, opts)
2500
- data
2501
- end
2502
-
2503
- # Get pbx timeBased
2504
- # Retrieve a pbx timeBased
2505
- # @param conversation_pbx_time_based_uuid
2506
- # @param [Hash] opts the optional parameters
2507
- # @return [Array<(ConversationPbxTimeBasedResponse, Fixnum, Hash)>] ConversationPbxTimeBasedResponse data, response status code and response headers
2508
- def get_pbx_time_based_with_http_info(conversation_pbx_time_based_uuid, opts = {})
2509
- if @api_client.config.debugging
2510
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_time_based ...'
2511
- end
2512
- # verify the required parameter 'conversation_pbx_time_based_uuid' is set
2513
- if @api_client.config.client_side_validation && conversation_pbx_time_based_uuid.nil?
2514
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_time_based_uuid' when calling ConversationApi.get_pbx_time_based"
2515
- end
2516
- # resource path
2517
- local_var_path = '/conversation/pbx/time_based/{conversationPbxTimeBasedUuid}'.sub('{' + 'conversationPbxTimeBasedUuid' + '}', conversation_pbx_time_based_uuid.to_s)
2518
-
2519
- # query parameters
2520
- query_params = {}
2521
-
2522
- # header parameters
2523
- header_params = {}
2524
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2525
- # HTTP header 'Accept' (if needed)
2526
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2527
- # HTTP header 'Content-Type'
2528
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2529
-
2530
- # form parameters
2531
- form_params = {}
2532
-
2533
- # http body (model)
2534
- post_body = nil
2535
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
2536
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2537
- :header_params => header_params,
2538
- :query_params => query_params,
2539
- :form_params => form_params,
2540
- :body => post_body,
2541
- :auth_names => auth_names,
2542
- :return_type => 'ConversationPbxTimeBasedResponse')
2543
- if @api_client.config.debugging
2544
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_time_based\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2545
- end
2546
- return data, status_code, headers
2547
- end
2548
- # Get pbx timeBaseds
2549
- # Retrieve pbx timeBaseds
2550
- # @param [Hash] opts the optional parameters
2551
- # @return [ConversationPbxTimeBasedsResponse]
2552
- def get_pbx_time_baseds(opts = {})
2553
- data, _status_code, _headers = get_pbx_time_baseds_with_http_info(opts)
2554
- data
2555
- end
2556
-
2557
- # Get pbx timeBaseds
2558
- # Retrieve pbx timeBaseds
2559
- # @param [Hash] opts the optional parameters
2560
- # @return [Array<(ConversationPbxTimeBasedsResponse, Fixnum, Hash)>] ConversationPbxTimeBasedsResponse data, response status code and response headers
2561
- def get_pbx_time_baseds_with_http_info(opts = {})
2562
- if @api_client.config.debugging
2563
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_time_baseds ...'
2564
- end
2565
- # resource path
2566
- local_var_path = '/conversation/pbx/time_based'
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 => 'ConversationPbxTimeBasedsResponse')
2592
- if @api_client.config.debugging
2593
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_time_baseds\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2594
- end
2595
- return data, status_code, headers
2596
- end
2597
- # Get pbx timeRange
2598
- # Retrieve a pbx timeRange
2599
- # @param conversation_pbx_time_range_uuid
2600
- # @param [Hash] opts the optional parameters
2601
- # @return [ConversationPbxTimeRangeResponse]
2602
- def get_pbx_time_range(conversation_pbx_time_range_uuid, opts = {})
2603
- data, _status_code, _headers = get_pbx_time_range_with_http_info(conversation_pbx_time_range_uuid, opts)
2604
- data
2605
- end
2606
-
2607
- # Get pbx timeRange
2608
- # Retrieve a pbx timeRange
2609
- # @param conversation_pbx_time_range_uuid
2610
- # @param [Hash] opts the optional parameters
2611
- # @return [Array<(ConversationPbxTimeRangeResponse, Fixnum, Hash)>] ConversationPbxTimeRangeResponse data, response status code and response headers
2612
- def get_pbx_time_range_with_http_info(conversation_pbx_time_range_uuid, opts = {})
2613
- if @api_client.config.debugging
2614
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_time_range ...'
2615
- end
2616
- # verify the required parameter 'conversation_pbx_time_range_uuid' is set
2617
- if @api_client.config.client_side_validation && conversation_pbx_time_range_uuid.nil?
2618
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_time_range_uuid' when calling ConversationApi.get_pbx_time_range"
2619
- end
2620
- # resource path
2621
- local_var_path = '/conversation/pbx/time_range/{conversationPbxTimeRangeUuid}'.sub('{' + 'conversationPbxTimeRangeUuid' + '}', conversation_pbx_time_range_uuid.to_s)
2622
-
2623
- # query parameters
2624
- query_params = {}
2625
-
2626
- # header parameters
2627
- header_params = {}
2628
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2629
- # HTTP header 'Accept' (if needed)
2630
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2631
- # HTTP header 'Content-Type'
2632
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2633
-
2634
- # form parameters
2635
- form_params = {}
2636
-
2637
- # http body (model)
2638
- post_body = nil
2639
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
2640
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2641
- :header_params => header_params,
2642
- :query_params => query_params,
2643
- :form_params => form_params,
2644
- :body => post_body,
2645
- :auth_names => auth_names,
2646
- :return_type => 'ConversationPbxTimeRangeResponse')
2647
- if @api_client.config.debugging
2648
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_time_range\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2649
- end
2650
- return data, status_code, headers
2651
- end
2652
- # Get pbx timeRanges
2653
- # Retrieve pbx timeRanges
2654
- # @param [Hash] opts the optional parameters
2655
- # @return [ConversationPbxTimeRangesResponse]
2656
- def get_pbx_time_ranges(opts = {})
2657
- data, _status_code, _headers = get_pbx_time_ranges_with_http_info(opts)
2658
- data
2659
- end
2660
-
2661
- # Get pbx timeRanges
2662
- # Retrieve pbx timeRanges
2663
- # @param [Hash] opts the optional parameters
2664
- # @return [Array<(ConversationPbxTimeRangesResponse, Fixnum, Hash)>] ConversationPbxTimeRangesResponse data, response status code and response headers
2665
- def get_pbx_time_ranges_with_http_info(opts = {})
2666
- if @api_client.config.debugging
2667
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_time_ranges ...'
2668
- end
2669
- # resource path
2670
- local_var_path = '/conversation/pbx/time_range'
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 => 'ConversationPbxTimeRangesResponse')
2696
- if @api_client.config.debugging
2697
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_time_ranges\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2698
- end
2699
- return data, status_code, headers
2700
- end
2701
- # Get pbx voicemailMailbox
2702
- # Retrieve a pbx voicemailMailbox
2703
- # @param conversation_pbx_voicemail_mailbox_uuid
2704
- # @param [Hash] opts the optional parameters
2705
- # @return [ConversationPbxVoicemailMailboxResponse]
2706
- def get_pbx_voicemail_mailbox(conversation_pbx_voicemail_mailbox_uuid, opts = {})
2707
- data, _status_code, _headers = get_pbx_voicemail_mailbox_with_http_info(conversation_pbx_voicemail_mailbox_uuid, opts)
2708
- data
2709
- end
2710
-
2711
- # Get pbx voicemailMailbox
2712
- # Retrieve a pbx voicemailMailbox
2713
- # @param conversation_pbx_voicemail_mailbox_uuid
2714
- # @param [Hash] opts the optional parameters
2715
- # @return [Array<(ConversationPbxVoicemailMailboxResponse, Fixnum, Hash)>] ConversationPbxVoicemailMailboxResponse data, response status code and response headers
2716
- def get_pbx_voicemail_mailbox_with_http_info(conversation_pbx_voicemail_mailbox_uuid, opts = {})
2717
- if @api_client.config.debugging
2718
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_voicemail_mailbox ...'
2719
- end
2720
- # verify the required parameter 'conversation_pbx_voicemail_mailbox_uuid' is set
2721
- if @api_client.config.client_side_validation && conversation_pbx_voicemail_mailbox_uuid.nil?
2722
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_voicemail_mailbox_uuid' when calling ConversationApi.get_pbx_voicemail_mailbox"
2723
- end
2724
- # resource path
2725
- local_var_path = '/conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid}'.sub('{' + 'conversationPbxVoicemailMailboxUuid' + '}', conversation_pbx_voicemail_mailbox_uuid.to_s)
2726
-
2727
- # query parameters
2728
- query_params = {}
2729
-
2730
- # header parameters
2731
- header_params = {}
2732
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2733
- # HTTP header 'Accept' (if needed)
2734
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2735
- # HTTP header 'Content-Type'
2736
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2737
-
2738
- # form parameters
2739
- form_params = {}
2740
-
2741
- # http body (model)
2742
- post_body = nil
2743
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
2744
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2745
- :header_params => header_params,
2746
- :query_params => query_params,
2747
- :form_params => form_params,
2748
- :body => post_body,
2749
- :auth_names => auth_names,
2750
- :return_type => 'ConversationPbxVoicemailMailboxResponse')
2751
- if @api_client.config.debugging
2752
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_voicemail_mailbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2753
- end
2754
- return data, status_code, headers
2755
- end
2756
- # Get pbx voicemailMailboxes
2757
- # Retrieve pbx voicemailMailboxes
2758
- # @param [Hash] opts the optional parameters
2759
- # @return [ConversationPbxVoicemailMailboxesResponse]
2760
- def get_pbx_voicemail_mailboxes(opts = {})
2761
- data, _status_code, _headers = get_pbx_voicemail_mailboxes_with_http_info(opts)
2762
- data
2763
- end
2764
-
2765
- # Get pbx voicemailMailboxes
2766
- # Retrieve pbx voicemailMailboxes
2767
- # @param [Hash] opts the optional parameters
2768
- # @return [Array<(ConversationPbxVoicemailMailboxesResponse, Fixnum, Hash)>] ConversationPbxVoicemailMailboxesResponse data, response status code and response headers
2769
- def get_pbx_voicemail_mailboxes_with_http_info(opts = {})
2770
- if @api_client.config.debugging
2771
- @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_voicemail_mailboxes ...'
2772
- end
2773
- # resource path
2774
- local_var_path = '/conversation/pbx/voicemail_mailbox'
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 => 'ConversationPbxVoicemailMailboxesResponse')
2800
- if @api_client.config.debugging
2801
- @api_client.config.logger.debug "API called: ConversationApi#get_pbx_voicemail_mailboxes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2802
- end
2803
- return data, status_code, headers
2804
- end
2805
- # Insert a canned message
2806
- # Insert a canned message
2807
- # @param canned_message Canned message
2808
- # @param [Hash] opts the optional parameters
2809
- # @return [ConversationCannedMessageResponse]
2810
- def insert_conversation_canned_message(canned_message, opts = {})
2811
- data, _status_code, _headers = insert_conversation_canned_message_with_http_info(canned_message, opts)
2812
- data
2813
- end
2814
-
2815
- # Insert a canned message
2816
- # Insert a canned message
2817
- # @param canned_message Canned message
2818
- # @param [Hash] opts the optional parameters
2819
- # @return [Array<(ConversationCannedMessageResponse, Fixnum, Hash)>] ConversationCannedMessageResponse data, response status code and response headers
2820
- def insert_conversation_canned_message_with_http_info(canned_message, opts = {})
2821
- if @api_client.config.debugging
2822
- @api_client.config.logger.debug 'Calling API: ConversationApi.insert_conversation_canned_message ...'
2823
- end
2824
- # verify the required parameter 'canned_message' is set
2825
- if @api_client.config.client_side_validation && canned_message.nil?
2826
- fail ArgumentError, "Missing the required parameter 'canned_message' when calling ConversationApi.insert_conversation_canned_message"
2827
- end
2828
- # resource path
2829
- local_var_path = '/conversation/canned_messages'
2830
-
2831
- # query parameters
2832
- query_params = {}
2833
-
2834
- # header parameters
2835
- header_params = {}
2836
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2837
- # HTTP header 'Accept' (if needed)
2838
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2839
- # HTTP header 'Content-Type'
2840
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2841
-
2842
- # form parameters
2843
- form_params = {}
2844
-
2845
- # http body (model)
2846
- post_body = @api_client.object_to_http_body(canned_message)
2847
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
2848
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2849
- :header_params => header_params,
2850
- :query_params => query_params,
2851
- :form_params => form_params,
2852
- :body => post_body,
2853
- :auth_names => auth_names,
2854
- :return_type => 'ConversationCannedMessageResponse')
2855
- if @api_client.config.debugging
2856
- @api_client.config.logger.debug "API called: ConversationApi#insert_conversation_canned_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2857
- end
2858
- return data, status_code, headers
2859
- end
2860
- # Insert a department
2861
- # Insert a department
2862
- # @param department Department
2863
- # @param [Hash] opts the optional parameters
2864
- # @return [ConversationDepartmentResponse]
2865
- def insert_conversation_department(department, opts = {})
2866
- data, _status_code, _headers = insert_conversation_department_with_http_info(department, opts)
2867
- data
2868
- end
2869
-
2870
- # Insert a department
2871
- # Insert a department
2872
- # @param department Department
2873
- # @param [Hash] opts the optional parameters
2874
- # @return [Array<(ConversationDepartmentResponse, Fixnum, Hash)>] ConversationDepartmentResponse data, response status code and response headers
2875
- def insert_conversation_department_with_http_info(department, opts = {})
2876
- if @api_client.config.debugging
2877
- @api_client.config.logger.debug 'Calling API: ConversationApi.insert_conversation_department ...'
2878
- end
2879
- # verify the required parameter 'department' is set
2880
- if @api_client.config.client_side_validation && department.nil?
2881
- fail ArgumentError, "Missing the required parameter 'department' when calling ConversationApi.insert_conversation_department"
2882
- end
2883
- # resource path
2884
- local_var_path = '/conversation/departments'
2885
-
2886
- # query parameters
2887
- query_params = {}
2888
-
2889
- # header parameters
2890
- header_params = {}
2891
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2892
- # HTTP header 'Accept' (if needed)
2893
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2894
- # HTTP header 'Content-Type'
2895
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2896
-
2897
- # form parameters
2898
- form_params = {}
2899
-
2900
- # http body (model)
2901
- post_body = @api_client.object_to_http_body(department)
2902
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
2903
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2904
- :header_params => header_params,
2905
- :query_params => query_params,
2906
- :form_params => form_params,
2907
- :body => post_body,
2908
- :auth_names => auth_names,
2909
- :return_type => 'ConversationDepartmentResponse')
2910
- if @api_client.config.debugging
2911
- @api_client.config.logger.debug "API called: ConversationApi#insert_conversation_department\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2912
- end
2913
- return data, status_code, headers
2914
- end
2915
- # Insert a engagement
2916
- # Insert a engagement
2917
- # @param engagement Engagement
2918
- # @param [Hash] opts the optional parameters
2919
- # @return [ConversationEngagementResponse]
2920
- def insert_conversation_engagement(engagement, opts = {})
2921
- data, _status_code, _headers = insert_conversation_engagement_with_http_info(engagement, opts)
2922
- data
2923
- end
2924
-
2925
- # Insert a engagement
2926
- # Insert a engagement
2927
- # @param engagement Engagement
2928
- # @param [Hash] opts the optional parameters
2929
- # @return [Array<(ConversationEngagementResponse, Fixnum, Hash)>] ConversationEngagementResponse data, response status code and response headers
2930
- def insert_conversation_engagement_with_http_info(engagement, opts = {})
2931
- if @api_client.config.debugging
2932
- @api_client.config.logger.debug 'Calling API: ConversationApi.insert_conversation_engagement ...'
2933
- end
2934
- # verify the required parameter 'engagement' is set
2935
- if @api_client.config.client_side_validation && engagement.nil?
2936
- fail ArgumentError, "Missing the required parameter 'engagement' when calling ConversationApi.insert_conversation_engagement"
2937
- end
2938
- # resource path
2939
- local_var_path = '/conversation/engagements'
2940
-
2941
- # query parameters
2942
- query_params = {}
2943
-
2944
- # header parameters
2945
- header_params = {}
2946
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2947
- # HTTP header 'Accept' (if needed)
2948
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2949
- # HTTP header 'Content-Type'
2950
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2951
-
2952
- # form parameters
2953
- form_params = {}
2954
-
2955
- # http body (model)
2956
- post_body = @api_client.object_to_http_body(engagement)
2957
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
2958
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2959
- :header_params => header_params,
2960
- :query_params => query_params,
2961
- :form_params => form_params,
2962
- :body => post_body,
2963
- :auth_names => auth_names,
2964
- :return_type => 'ConversationEngagementResponse')
2965
- if @api_client.config.debugging
2966
- @api_client.config.logger.debug "API called: ConversationApi#insert_conversation_engagement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2967
- end
2968
- return data, status_code, headers
2969
- end
2970
- # Insert pbx audio
2971
- # Insert a pbx audio
2972
- # @param pbx_audio Pbx Audio
2973
- # @param [Hash] opts the optional parameters
2974
- # @return [ConversationPbxAudioResponse]
2975
- def insert_pbx_audio(pbx_audio, opts = {})
2976
- data, _status_code, _headers = insert_pbx_audio_with_http_info(pbx_audio, opts)
2977
- data
2978
- end
2979
-
2980
- # Insert pbx audio
2981
- # Insert a pbx audio
2982
- # @param pbx_audio Pbx Audio
2983
- # @param [Hash] opts the optional parameters
2984
- # @return [Array<(ConversationPbxAudioResponse, Fixnum, Hash)>] ConversationPbxAudioResponse data, response status code and response headers
2985
- def insert_pbx_audio_with_http_info(pbx_audio, opts = {})
2986
- if @api_client.config.debugging
2987
- @api_client.config.logger.debug 'Calling API: ConversationApi.insert_pbx_audio ...'
2988
- end
2989
- # verify the required parameter 'pbx_audio' is set
2990
- if @api_client.config.client_side_validation && pbx_audio.nil?
2991
- fail ArgumentError, "Missing the required parameter 'pbx_audio' when calling ConversationApi.insert_pbx_audio"
2992
- end
2993
- # resource path
2994
- local_var_path = '/conversation/pbx/audio'
2995
-
2996
- # query parameters
2997
- query_params = {}
2998
-
2999
- # header parameters
3000
- header_params = {}
3001
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3002
- # HTTP header 'Accept' (if needed)
3003
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3004
- # HTTP header 'Content-Type'
3005
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3006
-
3007
- # form parameters
3008
- form_params = {}
3009
-
3010
- # http body (model)
3011
- post_body = @api_client.object_to_http_body(pbx_audio)
3012
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3013
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
3014
- :header_params => header_params,
3015
- :query_params => query_params,
3016
- :form_params => form_params,
3017
- :body => post_body,
3018
- :auth_names => auth_names,
3019
- :return_type => 'ConversationPbxAudioResponse')
3020
- if @api_client.config.debugging
3021
- @api_client.config.logger.debug "API called: ConversationApi#insert_pbx_audio\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3022
- end
3023
- return data, status_code, headers
3024
- end
3025
- # Insert pbx menu
3026
- # Insert a pbx menu
3027
- # @param pbx_menu Pbx Menu
3028
- # @param [Hash] opts the optional parameters
3029
- # @return [ConversationPbxMenuResponse]
3030
- def insert_pbx_menu(pbx_menu, opts = {})
3031
- data, _status_code, _headers = insert_pbx_menu_with_http_info(pbx_menu, opts)
3032
- data
3033
- end
3034
-
3035
- # Insert pbx menu
3036
- # Insert a pbx menu
3037
- # @param pbx_menu Pbx Menu
3038
- # @param [Hash] opts the optional parameters
3039
- # @return [Array<(ConversationPbxMenuResponse, Fixnum, Hash)>] ConversationPbxMenuResponse data, response status code and response headers
3040
- def insert_pbx_menu_with_http_info(pbx_menu, opts = {})
3041
- if @api_client.config.debugging
3042
- @api_client.config.logger.debug 'Calling API: ConversationApi.insert_pbx_menu ...'
3043
- end
3044
- # verify the required parameter 'pbx_menu' is set
3045
- if @api_client.config.client_side_validation && pbx_menu.nil?
3046
- fail ArgumentError, "Missing the required parameter 'pbx_menu' when calling ConversationApi.insert_pbx_menu"
3047
- end
3048
- # resource path
3049
- local_var_path = '/conversation/pbx/menu'
3050
-
3051
- # query parameters
3052
- query_params = {}
3053
-
3054
- # header parameters
3055
- header_params = {}
3056
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3057
- # HTTP header 'Accept' (if needed)
3058
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3059
- # HTTP header 'Content-Type'
3060
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3061
-
3062
- # form parameters
3063
- form_params = {}
3064
-
3065
- # http body (model)
3066
- post_body = @api_client.object_to_http_body(pbx_menu)
3067
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3068
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
3069
- :header_params => header_params,
3070
- :query_params => query_params,
3071
- :form_params => form_params,
3072
- :body => post_body,
3073
- :auth_names => auth_names,
3074
- :return_type => 'ConversationPbxMenuResponse')
3075
- if @api_client.config.debugging
3076
- @api_client.config.logger.debug "API called: ConversationApi#insert_pbx_menu\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3077
- end
3078
- return data, status_code, headers
3079
- end
3080
- # Insert pbx queue
3081
- # Insert a pbx queue
3082
- # @param pbx_queue Pbx Queue
3083
- # @param [Hash] opts the optional parameters
3084
- # @return [ConversationPbxQueueResponse]
3085
- def insert_pbx_queue(pbx_queue, opts = {})
3086
- data, _status_code, _headers = insert_pbx_queue_with_http_info(pbx_queue, opts)
3087
- data
3088
- end
3089
-
3090
- # Insert pbx queue
3091
- # Insert a pbx queue
3092
- # @param pbx_queue Pbx Queue
3093
- # @param [Hash] opts the optional parameters
3094
- # @return [Array<(ConversationPbxQueueResponse, Fixnum, Hash)>] ConversationPbxQueueResponse data, response status code and response headers
3095
- def insert_pbx_queue_with_http_info(pbx_queue, opts = {})
3096
- if @api_client.config.debugging
3097
- @api_client.config.logger.debug 'Calling API: ConversationApi.insert_pbx_queue ...'
3098
- end
3099
- # verify the required parameter 'pbx_queue' is set
3100
- if @api_client.config.client_side_validation && pbx_queue.nil?
3101
- fail ArgumentError, "Missing the required parameter 'pbx_queue' when calling ConversationApi.insert_pbx_queue"
3102
- end
3103
- # resource path
3104
- local_var_path = '/conversation/pbx/queue'
3105
-
3106
- # query parameters
3107
- query_params = {}
3108
-
3109
- # header parameters
3110
- header_params = {}
3111
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3112
- # HTTP header 'Accept' (if needed)
3113
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3114
- # HTTP header 'Content-Type'
3115
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3116
-
3117
- # form parameters
3118
- form_params = {}
3119
-
3120
- # http body (model)
3121
- post_body = @api_client.object_to_http_body(pbx_queue)
3122
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3123
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
3124
- :header_params => header_params,
3125
- :query_params => query_params,
3126
- :form_params => form_params,
3127
- :body => post_body,
3128
- :auth_names => auth_names,
3129
- :return_type => 'ConversationPbxQueueResponse')
3130
- if @api_client.config.debugging
3131
- @api_client.config.logger.debug "API called: ConversationApi#insert_pbx_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3132
- end
3133
- return data, status_code, headers
3134
- end
3135
- # Insert pbx timeBased
3136
- # Insert a pbx timeBased
3137
- # @param pbx_time_based Pbx TimeBased
3138
- # @param [Hash] opts the optional parameters
3139
- # @return [ConversationPbxTimeBasedResponse]
3140
- def insert_pbx_time_based(pbx_time_based, opts = {})
3141
- data, _status_code, _headers = insert_pbx_time_based_with_http_info(pbx_time_based, opts)
3142
- data
3143
- end
3144
-
3145
- # Insert pbx timeBased
3146
- # Insert a pbx timeBased
3147
- # @param pbx_time_based Pbx TimeBased
3148
- # @param [Hash] opts the optional parameters
3149
- # @return [Array<(ConversationPbxTimeBasedResponse, Fixnum, Hash)>] ConversationPbxTimeBasedResponse data, response status code and response headers
3150
- def insert_pbx_time_based_with_http_info(pbx_time_based, opts = {})
3151
- if @api_client.config.debugging
3152
- @api_client.config.logger.debug 'Calling API: ConversationApi.insert_pbx_time_based ...'
3153
- end
3154
- # verify the required parameter 'pbx_time_based' is set
3155
- if @api_client.config.client_side_validation && pbx_time_based.nil?
3156
- fail ArgumentError, "Missing the required parameter 'pbx_time_based' when calling ConversationApi.insert_pbx_time_based"
3157
- end
3158
- # resource path
3159
- local_var_path = '/conversation/pbx/time_based'
3160
-
3161
- # query parameters
3162
- query_params = {}
3163
-
3164
- # header parameters
3165
- header_params = {}
3166
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3167
- # HTTP header 'Accept' (if needed)
3168
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3169
- # HTTP header 'Content-Type'
3170
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3171
-
3172
- # form parameters
3173
- form_params = {}
3174
-
3175
- # http body (model)
3176
- post_body = @api_client.object_to_http_body(pbx_time_based)
3177
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3178
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
3179
- :header_params => header_params,
3180
- :query_params => query_params,
3181
- :form_params => form_params,
3182
- :body => post_body,
3183
- :auth_names => auth_names,
3184
- :return_type => 'ConversationPbxTimeBasedResponse')
3185
- if @api_client.config.debugging
3186
- @api_client.config.logger.debug "API called: ConversationApi#insert_pbx_time_based\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3187
- end
3188
- return data, status_code, headers
3189
- end
3190
- # Insert pbx timeRange
3191
- # Insert a pbx timeRange
3192
- # @param pbx_time_range Pbx TimeRange
3193
- # @param [Hash] opts the optional parameters
3194
- # @return [ConversationPbxTimeRangeResponse]
3195
- def insert_pbx_time_range(pbx_time_range, opts = {})
3196
- data, _status_code, _headers = insert_pbx_time_range_with_http_info(pbx_time_range, opts)
3197
- data
3198
- end
3199
-
3200
- # Insert pbx timeRange
3201
- # Insert a pbx timeRange
3202
- # @param pbx_time_range Pbx TimeRange
3203
- # @param [Hash] opts the optional parameters
3204
- # @return [Array<(ConversationPbxTimeRangeResponse, Fixnum, Hash)>] ConversationPbxTimeRangeResponse data, response status code and response headers
3205
- def insert_pbx_time_range_with_http_info(pbx_time_range, opts = {})
3206
- if @api_client.config.debugging
3207
- @api_client.config.logger.debug 'Calling API: ConversationApi.insert_pbx_time_range ...'
3208
- end
3209
- # verify the required parameter 'pbx_time_range' is set
3210
- if @api_client.config.client_side_validation && pbx_time_range.nil?
3211
- fail ArgumentError, "Missing the required parameter 'pbx_time_range' when calling ConversationApi.insert_pbx_time_range"
3212
- end
3213
- # resource path
3214
- local_var_path = '/conversation/pbx/time_range'
3215
-
3216
- # query parameters
3217
- query_params = {}
3218
-
3219
- # header parameters
3220
- header_params = {}
3221
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3222
- # HTTP header 'Accept' (if needed)
3223
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3224
- # HTTP header 'Content-Type'
3225
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3226
-
3227
- # form parameters
3228
- form_params = {}
3229
-
3230
- # http body (model)
3231
- post_body = @api_client.object_to_http_body(pbx_time_range)
3232
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3233
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
3234
- :header_params => header_params,
3235
- :query_params => query_params,
3236
- :form_params => form_params,
3237
- :body => post_body,
3238
- :auth_names => auth_names,
3239
- :return_type => 'ConversationPbxTimeRangeResponse')
3240
- if @api_client.config.debugging
3241
- @api_client.config.logger.debug "API called: ConversationApi#insert_pbx_time_range\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3242
- end
3243
- return data, status_code, headers
3244
- end
3245
- # Insert pbx voicemailMailbox
3246
- # Insert a pbx voicemailMailbox
3247
- # @param pbx_voicemail_mailbox Pbx VoicemailMailbox
3248
- # @param [Hash] opts the optional parameters
3249
- # @return [ConversationPbxVoicemailMailboxResponse]
3250
- def insert_pbx_voicemail_mailbox(pbx_voicemail_mailbox, opts = {})
3251
- data, _status_code, _headers = insert_pbx_voicemail_mailbox_with_http_info(pbx_voicemail_mailbox, opts)
3252
- data
3253
- end
3254
-
3255
- # Insert pbx voicemailMailbox
3256
- # Insert a pbx voicemailMailbox
3257
- # @param pbx_voicemail_mailbox Pbx VoicemailMailbox
3258
- # @param [Hash] opts the optional parameters
3259
- # @return [Array<(ConversationPbxVoicemailMailboxResponse, Fixnum, Hash)>] ConversationPbxVoicemailMailboxResponse data, response status code and response headers
3260
- def insert_pbx_voicemail_mailbox_with_http_info(pbx_voicemail_mailbox, opts = {})
3261
- if @api_client.config.debugging
3262
- @api_client.config.logger.debug 'Calling API: ConversationApi.insert_pbx_voicemail_mailbox ...'
3263
- end
3264
- # verify the required parameter 'pbx_voicemail_mailbox' is set
3265
- if @api_client.config.client_side_validation && pbx_voicemail_mailbox.nil?
3266
- fail ArgumentError, "Missing the required parameter 'pbx_voicemail_mailbox' when calling ConversationApi.insert_pbx_voicemail_mailbox"
3267
- end
3268
- # resource path
3269
- local_var_path = '/conversation/pbx/voicemail_mailbox'
3270
-
3271
- # query parameters
3272
- query_params = {}
3273
-
3274
- # header parameters
3275
- header_params = {}
3276
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3277
- # HTTP header 'Accept' (if needed)
3278
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3279
- # HTTP header 'Content-Type'
3280
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3281
-
3282
- # form parameters
3283
- form_params = {}
3284
-
3285
- # http body (model)
3286
- post_body = @api_client.object_to_http_body(pbx_voicemail_mailbox)
3287
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3288
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
3289
- :header_params => header_params,
3290
- :query_params => query_params,
3291
- :form_params => form_params,
3292
- :body => post_body,
3293
- :auth_names => auth_names,
3294
- :return_type => 'ConversationPbxVoicemailMailboxResponse')
3295
- if @api_client.config.debugging
3296
- @api_client.config.logger.debug "API called: ConversationApi#insert_pbx_voicemail_mailbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3297
- end
3298
- return data, status_code, headers
3299
- end
3300
- # Join a conversation
3301
- # Join a conversation
3302
- # @param conversation_uuid
3303
- # @param [Hash] opts the optional parameters
3304
- # @option opts [ConversationJoinRequest] :join_request Join request
3305
- # @return [nil]
3306
- def join_conversation(conversation_uuid, opts = {})
3307
- join_conversation_with_http_info(conversation_uuid, opts)
3308
- nil
3309
- end
3310
-
3311
- # Join a conversation
3312
- # Join a conversation
3313
- # @param conversation_uuid
3314
- # @param [Hash] opts the optional parameters
3315
- # @option opts [ConversationJoinRequest] :join_request Join request
3316
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
3317
- def join_conversation_with_http_info(conversation_uuid, opts = {})
3318
- if @api_client.config.debugging
3319
- @api_client.config.logger.debug 'Calling API: ConversationApi.join_conversation ...'
3320
- end
3321
- # verify the required parameter 'conversation_uuid' is set
3322
- if @api_client.config.client_side_validation && conversation_uuid.nil?
3323
- fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.join_conversation"
3324
- end
3325
- # resource path
3326
- local_var_path = '/conversation/conversations/{conversation_uuid}/join'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.to_s)
3327
-
3328
- # query parameters
3329
- query_params = {}
3330
-
3331
- # header parameters
3332
- header_params = {}
3333
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3334
- # HTTP header 'Accept' (if needed)
3335
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3336
- # HTTP header 'Content-Type'
3337
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3338
-
3339
- # form parameters
3340
- form_params = {}
3341
-
3342
- # http body (model)
3343
- post_body = @api_client.object_to_http_body(opts[:'join_request'])
3344
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3345
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
3346
- :header_params => header_params,
3347
- :query_params => query_params,
3348
- :form_params => form_params,
3349
- :body => post_body,
3350
- :auth_names => auth_names)
3351
- if @api_client.config.debugging
3352
- @api_client.config.logger.debug "API called: ConversationApi#join_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3353
- end
3354
- return data, status_code, headers
3355
- end
3356
- # Leave a conversation
3357
- # Leave a conversation
3358
- # @param conversation_uuid
3359
- # @param [Hash] opts the optional parameters
3360
- # @return [nil]
3361
- def leave_conversation(conversation_uuid, opts = {})
3362
- leave_conversation_with_http_info(conversation_uuid, opts)
3363
- nil
3364
- end
3365
-
3366
- # Leave a conversation
3367
- # Leave a conversation
3368
- # @param conversation_uuid
3369
- # @param [Hash] opts the optional parameters
3370
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
3371
- def leave_conversation_with_http_info(conversation_uuid, opts = {})
3372
- if @api_client.config.debugging
3373
- @api_client.config.logger.debug 'Calling API: ConversationApi.leave_conversation ...'
3374
- end
3375
- # verify the required parameter 'conversation_uuid' is set
3376
- if @api_client.config.client_side_validation && conversation_uuid.nil?
3377
- fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.leave_conversation"
3378
- end
3379
- # resource path
3380
- local_var_path = '/conversation/conversations/{conversation_uuid}/leave'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.to_s)
3381
-
3382
- # query parameters
3383
- query_params = {}
3384
-
3385
- # header parameters
3386
- header_params = {}
3387
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3388
- # HTTP header 'Accept' (if needed)
3389
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3390
- # HTTP header 'Content-Type'
3391
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3392
-
3393
- # form parameters
3394
- form_params = {}
3395
-
3396
- # http body (model)
3397
- post_body = nil
3398
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3399
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
3400
- :header_params => header_params,
3401
- :query_params => query_params,
3402
- :form_params => form_params,
3403
- :body => post_body,
3404
- :auth_names => auth_names)
3405
- if @api_client.config.debugging
3406
- @api_client.config.logger.debug "API called: ConversationApi#leave_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3407
- end
3408
- return data, status_code, headers
3409
- end
3410
- # Listened Agent Voicemail
3411
- # Listened pbx agent Voicemail
3412
- # @param recording_sid
3413
- # @param [Hash] opts the optional parameters
3414
- # @return [nil]
3415
- def listened_pbx_agent_voicemail(recording_sid, opts = {})
3416
- listened_pbx_agent_voicemail_with_http_info(recording_sid, opts)
3417
- nil
3418
- end
3419
-
3420
- # Listened Agent Voicemail
3421
- # Listened pbx agent Voicemail
3422
- # @param recording_sid
3423
- # @param [Hash] opts the optional parameters
3424
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
3425
- def listened_pbx_agent_voicemail_with_http_info(recording_sid, opts = {})
3426
- if @api_client.config.debugging
3427
- @api_client.config.logger.debug 'Calling API: ConversationApi.listened_pbx_agent_voicemail ...'
3428
- end
3429
- # verify the required parameter 'recording_sid' is set
3430
- if @api_client.config.client_side_validation && recording_sid.nil?
3431
- fail ArgumentError, "Missing the required parameter 'recording_sid' when calling ConversationApi.listened_pbx_agent_voicemail"
3432
- end
3433
- # resource path
3434
- local_var_path = '/conversation/pbx/agent/voicemails/{recording_sid}/listened'.sub('{' + 'recording_sid' + '}', recording_sid.to_s)
3435
-
3436
- # query parameters
3437
- query_params = {}
3438
-
3439
- # header parameters
3440
- header_params = {}
3441
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3442
- # HTTP header 'Accept' (if needed)
3443
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3444
- # HTTP header 'Content-Type'
3445
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3446
-
3447
- # form parameters
3448
- form_params = {}
3449
-
3450
- # http body (model)
3451
- post_body = nil
3452
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3453
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
3454
- :header_params => header_params,
3455
- :query_params => query_params,
3456
- :form_params => form_params,
3457
- :body => post_body,
3458
- :auth_names => auth_names)
3459
- if @api_client.config.debugging
3460
- @api_client.config.logger.debug "API called: ConversationApi#listened_pbx_agent_voicemail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3461
- end
3462
- return data, status_code, headers
3463
- end
3464
- # Listened Queue Voicemail
3465
- # Listened pbx queue Voicemail
3466
- # @param queue_uuid
3467
- # @param recording_sid
3468
- # @param [Hash] opts the optional parameters
3469
- # @return [nil]
3470
- def listened_pbx_queue_voicemail(queue_uuid, recording_sid, opts = {})
3471
- listened_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid, opts)
3472
- nil
3473
- end
3474
-
3475
- # Listened Queue Voicemail
3476
- # Listened pbx queue Voicemail
3477
- # @param queue_uuid
3478
- # @param recording_sid
3479
- # @param [Hash] opts the optional parameters
3480
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
3481
- def listened_pbx_queue_voicemail_with_http_info(queue_uuid, recording_sid, opts = {})
3482
- if @api_client.config.debugging
3483
- @api_client.config.logger.debug 'Calling API: ConversationApi.listened_pbx_queue_voicemail ...'
3484
- end
3485
- # verify the required parameter 'queue_uuid' is set
3486
- if @api_client.config.client_side_validation && queue_uuid.nil?
3487
- fail ArgumentError, "Missing the required parameter 'queue_uuid' when calling ConversationApi.listened_pbx_queue_voicemail"
3488
- end
3489
- # verify the required parameter 'recording_sid' is set
3490
- if @api_client.config.client_side_validation && recording_sid.nil?
3491
- fail ArgumentError, "Missing the required parameter 'recording_sid' when calling ConversationApi.listened_pbx_queue_voicemail"
3492
- end
3493
- # resource path
3494
- 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)
3495
-
3496
- # query parameters
3497
- query_params = {}
3498
-
3499
- # header parameters
3500
- header_params = {}
3501
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3502
- # HTTP header 'Accept' (if needed)
3503
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3504
- # HTTP header 'Content-Type'
3505
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3506
-
3507
- # form parameters
3508
- form_params = {}
3509
-
3510
- # http body (model)
3511
- post_body = nil
3512
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3513
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
3514
- :header_params => header_params,
3515
- :query_params => query_params,
3516
- :form_params => form_params,
3517
- :body => post_body,
3518
- :auth_names => auth_names)
3519
- if @api_client.config.debugging
3520
- @api_client.config.logger.debug "API called: ConversationApi#listened_pbx_queue_voicemail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3521
- end
3522
- return data, status_code, headers
3523
- end
3524
- # Mark a conversation as read
3525
- # Mark a conversation as read
3526
- # @param conversation_uuid
3527
- # @param [Hash] opts the optional parameters
3528
- # @return [nil]
3529
- def mark_read_conversation(conversation_uuid, opts = {})
3530
- mark_read_conversation_with_http_info(conversation_uuid, opts)
3531
- nil
3532
- end
3533
-
3534
- # Mark a conversation as read
3535
- # Mark a conversation as read
3536
- # @param conversation_uuid
3537
- # @param [Hash] opts the optional parameters
3538
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
3539
- def mark_read_conversation_with_http_info(conversation_uuid, opts = {})
3540
- if @api_client.config.debugging
3541
- @api_client.config.logger.debug 'Calling API: ConversationApi.mark_read_conversation ...'
3542
- end
3543
- # verify the required parameter 'conversation_uuid' is set
3544
- if @api_client.config.client_side_validation && conversation_uuid.nil?
3545
- fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.mark_read_conversation"
3546
- end
3547
- # resource path
3548
- local_var_path = '/conversation/conversations/{conversation_uuid}/markread'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.to_s)
3549
-
3550
- # query parameters
3551
- query_params = {}
3552
-
3553
- # header parameters
3554
- header_params = {}
3555
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3556
- # HTTP header 'Accept' (if needed)
3557
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3558
- # HTTP header 'Content-Type'
3559
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3560
-
3561
- # form parameters
3562
- form_params = {}
3563
-
3564
- # http body (model)
3565
- post_body = nil
3566
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3567
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
3568
- :header_params => header_params,
3569
- :query_params => query_params,
3570
- :form_params => form_params,
3571
- :body => post_body,
3572
- :auth_names => auth_names)
3573
- if @api_client.config.debugging
3574
- @api_client.config.logger.debug "API called: ConversationApi#mark_read_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3575
- end
3576
- return data, status_code, headers
3577
- end
3578
- # reset statistics within the queue
3579
- # reset statistics within the queue
3580
- # @param queue_uuid
3581
- # @param [Hash] opts the optional parameters
3582
- # @return [nil]
3583
- def reset_conversation_pbx_queue_statistics(queue_uuid, opts = {})
3584
- reset_conversation_pbx_queue_statistics_with_http_info(queue_uuid, opts)
3585
- nil
3586
- end
3587
-
3588
- # reset statistics within the queue
3589
- # reset statistics within the queue
3590
- # @param queue_uuid
3591
- # @param [Hash] opts the optional parameters
3592
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
3593
- def reset_conversation_pbx_queue_statistics_with_http_info(queue_uuid, opts = {})
3594
- if @api_client.config.debugging
3595
- @api_client.config.logger.debug 'Calling API: ConversationApi.reset_conversation_pbx_queue_statistics ...'
3596
- end
3597
- # verify the required parameter 'queue_uuid' is set
3598
- if @api_client.config.client_side_validation && queue_uuid.nil?
3599
- fail ArgumentError, "Missing the required parameter 'queue_uuid' when calling ConversationApi.reset_conversation_pbx_queue_statistics"
3600
- end
3601
- # resource path
3602
- local_var_path = '/conversation/pbx/queues/{queue_uuid}/reset_statistics'.sub('{' + 'queue_uuid' + '}', queue_uuid.to_s)
3603
-
3604
- # query parameters
3605
- query_params = {}
3606
-
3607
- # header parameters
3608
- header_params = {}
3609
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3610
- # HTTP header 'Accept' (if needed)
3611
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3612
- # HTTP header 'Content-Type'
3613
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3614
-
3615
- # form parameters
3616
- form_params = {}
3617
-
3618
- # http body (model)
3619
- post_body = nil
3620
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3621
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
3622
- :header_params => header_params,
3623
- :query_params => query_params,
3624
- :form_params => form_params,
3625
- :body => post_body,
3626
- :auth_names => auth_names)
3627
- if @api_client.config.debugging
3628
- @api_client.config.logger.debug "API called: ConversationApi#reset_conversation_pbx_queue_statistics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3629
- end
3630
- return data, status_code, headers
3631
- end
3632
- # Search for canned messages by short_code
3633
- # Search for canned messages by short_code
3634
- # @param search_request Search request
3635
- # @param [Hash] opts the optional parameters
3636
- # @return [ConversationCannedMessagesResponse]
3637
- def search_conversation_canned_messages(search_request, opts = {})
3638
- data, _status_code, _headers = search_conversation_canned_messages_with_http_info(search_request, opts)
3639
- data
3640
- end
3641
-
3642
- # Search for canned messages by short_code
3643
- # Search for canned messages by short_code
3644
- # @param search_request Search request
3645
- # @param [Hash] opts the optional parameters
3646
- # @return [Array<(ConversationCannedMessagesResponse, Fixnum, Hash)>] ConversationCannedMessagesResponse data, response status code and response headers
3647
- def search_conversation_canned_messages_with_http_info(search_request, opts = {})
3648
- if @api_client.config.debugging
3649
- @api_client.config.logger.debug 'Calling API: ConversationApi.search_conversation_canned_messages ...'
3650
- end
3651
- # verify the required parameter 'search_request' is set
3652
- if @api_client.config.client_side_validation && search_request.nil?
3653
- fail ArgumentError, "Missing the required parameter 'search_request' when calling ConversationApi.search_conversation_canned_messages"
3654
- end
3655
- # resource path
3656
- local_var_path = '/conversation/canned_messages/search'
3657
-
3658
- # query parameters
3659
- query_params = {}
3660
-
3661
- # header parameters
3662
- header_params = {}
3663
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3664
- # HTTP header 'Accept' (if needed)
3665
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3666
- # HTTP header 'Content-Type'
3667
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3668
-
3669
- # form parameters
3670
- form_params = {}
3671
-
3672
- # http body (model)
3673
- post_body = @api_client.object_to_http_body(search_request)
3674
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3675
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
3676
- :header_params => header_params,
3677
- :query_params => query_params,
3678
- :form_params => form_params,
3679
- :body => post_body,
3680
- :auth_names => auth_names,
3681
- :return_type => 'ConversationCannedMessagesResponse')
3682
- if @api_client.config.debugging
3683
- @api_client.config.logger.debug "API called: ConversationApi#search_conversation_canned_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3684
- end
3685
- return data, status_code, headers
3686
- end
3687
- # Unsubscribe any SMS participants in this conversation
3688
- # Unsubscribe any SMS participants in this conversation
3689
- # @param conversation_uuid
3690
- # @param [Hash] opts the optional parameters
3691
- # @return [nil]
3692
- def sms_unsubscribe_conversation(conversation_uuid, opts = {})
3693
- sms_unsubscribe_conversation_with_http_info(conversation_uuid, opts)
3694
- nil
3695
- end
3696
-
3697
- # Unsubscribe any SMS participants in this conversation
3698
- # Unsubscribe any SMS participants in this conversation
3699
- # @param conversation_uuid
3700
- # @param [Hash] opts the optional parameters
3701
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
3702
- def sms_unsubscribe_conversation_with_http_info(conversation_uuid, opts = {})
3703
- if @api_client.config.debugging
3704
- @api_client.config.logger.debug 'Calling API: ConversationApi.sms_unsubscribe_conversation ...'
3705
- end
3706
- # verify the required parameter 'conversation_uuid' is set
3707
- if @api_client.config.client_side_validation && conversation_uuid.nil?
3708
- fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.sms_unsubscribe_conversation"
3709
- end
3710
- # resource path
3711
- local_var_path = '/conversation/conversations/{conversation_uuid}/sms_unsubscribe'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.to_s)
3712
-
3713
- # query parameters
3714
- query_params = {}
3715
-
3716
- # header parameters
3717
- header_params = {}
3718
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3719
- # HTTP header 'Accept' (if needed)
3720
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3721
- # HTTP header 'Content-Type'
3722
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3723
-
3724
- # form parameters
3725
- form_params = {}
3726
-
3727
- # http body (model)
3728
- post_body = nil
3729
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3730
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
3731
- :header_params => header_params,
3732
- :query_params => query_params,
3733
- :form_params => form_params,
3734
- :body => post_body,
3735
- :auth_names => auth_names)
3736
- if @api_client.config.debugging
3737
- @api_client.config.logger.debug "API called: ConversationApi#sms_unsubscribe_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3738
- end
3739
- return data, status_code, headers
3740
- end
3741
- # Start a conversation
3742
- # Start a new conversation
3743
- # @param start_request Start request
3744
- # @param [Hash] opts the optional parameters
3745
- # @return [ConversationStartResponse]
3746
- def start_conversation(start_request, opts = {})
3747
- data, _status_code, _headers = start_conversation_with_http_info(start_request, opts)
3748
- data
3749
- end
3750
-
3751
- # Start a conversation
3752
- # Start a new conversation
3753
- # @param start_request Start request
3754
- # @param [Hash] opts the optional parameters
3755
- # @return [Array<(ConversationStartResponse, Fixnum, Hash)>] ConversationStartResponse data, response status code and response headers
3756
- def start_conversation_with_http_info(start_request, opts = {})
3757
- if @api_client.config.debugging
3758
- @api_client.config.logger.debug 'Calling API: ConversationApi.start_conversation ...'
3759
- end
3760
- # verify the required parameter 'start_request' is set
3761
- if @api_client.config.client_side_validation && start_request.nil?
3762
- fail ArgumentError, "Missing the required parameter 'start_request' when calling ConversationApi.start_conversation"
3763
- end
3764
- # resource path
3765
- local_var_path = '/conversation/conversations'
3766
-
3767
- # query parameters
3768
- query_params = {}
3769
-
3770
- # header parameters
3771
- header_params = {}
3772
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3773
- # HTTP header 'Accept' (if needed)
3774
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3775
- # HTTP header 'Content-Type'
3776
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3777
-
3778
- # form parameters
3779
- form_params = {}
3780
-
3781
- # http body (model)
3782
- post_body = @api_client.object_to_http_body(start_request)
3783
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3784
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
3785
- :header_params => header_params,
3786
- :query_params => query_params,
3787
- :form_params => form_params,
3788
- :body => post_body,
3789
- :auth_names => auth_names,
3790
- :return_type => 'ConversationStartResponse')
3791
- if @api_client.config.debugging
3792
- @api_client.config.logger.debug "API called: ConversationApi#start_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3793
- end
3794
- return data, status_code, headers
3795
- end
3796
- # Update agent profile
3797
- # Update agent profile
3798
- # @param profile_request Profile request
3799
- # @param [Hash] opts the optional parameters
3800
- # @return [ConversationAgentProfileResponse]
3801
- def update_agent_profile(profile_request, opts = {})
3802
- data, _status_code, _headers = update_agent_profile_with_http_info(profile_request, opts)
3803
- data
3804
- end
3805
-
3806
- # Update agent profile
3807
- # Update agent profile
3808
- # @param profile_request Profile request
3809
- # @param [Hash] opts the optional parameters
3810
- # @return [Array<(ConversationAgentProfileResponse, Fixnum, Hash)>] ConversationAgentProfileResponse data, response status code and response headers
3811
- def update_agent_profile_with_http_info(profile_request, opts = {})
3812
- if @api_client.config.debugging
3813
- @api_client.config.logger.debug 'Calling API: ConversationApi.update_agent_profile ...'
3814
- end
3815
- # verify the required parameter 'profile_request' is set
3816
- if @api_client.config.client_side_validation && profile_request.nil?
3817
- fail ArgumentError, "Missing the required parameter 'profile_request' when calling ConversationApi.update_agent_profile"
3818
- end
3819
- # resource path
3820
- local_var_path = '/conversation/agent/profile'
3821
-
3822
- # query parameters
3823
- query_params = {}
3824
-
3825
- # header parameters
3826
- header_params = {}
3827
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3828
- # HTTP header 'Accept' (if needed)
3829
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3830
- # HTTP header 'Content-Type'
3831
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3832
-
3833
- # form parameters
3834
- form_params = {}
3835
-
3836
- # http body (model)
3837
- post_body = @api_client.object_to_http_body(profile_request)
3838
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3839
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
3840
- :header_params => header_params,
3841
- :query_params => query_params,
3842
- :form_params => form_params,
3843
- :body => post_body,
3844
- :auth_names => auth_names,
3845
- :return_type => 'ConversationAgentProfileResponse')
3846
- if @api_client.config.debugging
3847
- @api_client.config.logger.debug "API called: ConversationApi#update_agent_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3848
- end
3849
- return data, status_code, headers
3850
- end
3851
- # Update a canned message
3852
- # Update a canned message
3853
- # @param conversation_canned_message_oid
3854
- # @param canned_message Canned message
3855
- # @param [Hash] opts the optional parameters
3856
- # @return [ConversationCannedMessageResponse]
3857
- def update_conversation_canned_message(conversation_canned_message_oid, canned_message, opts = {})
3858
- data, _status_code, _headers = update_conversation_canned_message_with_http_info(conversation_canned_message_oid, canned_message, opts)
3859
- data
3860
- end
3861
-
3862
- # Update a canned message
3863
- # Update a canned message
3864
- # @param conversation_canned_message_oid
3865
- # @param canned_message Canned message
3866
- # @param [Hash] opts the optional parameters
3867
- # @return [Array<(ConversationCannedMessageResponse, Fixnum, Hash)>] ConversationCannedMessageResponse data, response status code and response headers
3868
- def update_conversation_canned_message_with_http_info(conversation_canned_message_oid, canned_message, opts = {})
3869
- if @api_client.config.debugging
3870
- @api_client.config.logger.debug 'Calling API: ConversationApi.update_conversation_canned_message ...'
3871
- end
3872
- # verify the required parameter 'conversation_canned_message_oid' is set
3873
- if @api_client.config.client_side_validation && conversation_canned_message_oid.nil?
3874
- fail ArgumentError, "Missing the required parameter 'conversation_canned_message_oid' when calling ConversationApi.update_conversation_canned_message"
3875
- end
3876
- # verify the required parameter 'canned_message' is set
3877
- if @api_client.config.client_side_validation && canned_message.nil?
3878
- fail ArgumentError, "Missing the required parameter 'canned_message' when calling ConversationApi.update_conversation_canned_message"
3879
- end
3880
- # resource path
3881
- local_var_path = '/conversation/canned_messages/{conversation_canned_message_oid}'.sub('{' + 'conversation_canned_message_oid' + '}', conversation_canned_message_oid.to_s)
3882
-
3883
- # query parameters
3884
- query_params = {}
3885
-
3886
- # header parameters
3887
- header_params = {}
3888
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3889
- # HTTP header 'Accept' (if needed)
3890
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3891
- # HTTP header 'Content-Type'
3892
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3893
-
3894
- # form parameters
3895
- form_params = {}
3896
-
3897
- # http body (model)
3898
- post_body = @api_client.object_to_http_body(canned_message)
3899
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3900
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
3901
- :header_params => header_params,
3902
- :query_params => query_params,
3903
- :form_params => form_params,
3904
- :body => post_body,
3905
- :auth_names => auth_names,
3906
- :return_type => 'ConversationCannedMessageResponse')
3907
- if @api_client.config.debugging
3908
- @api_client.config.logger.debug "API called: ConversationApi#update_conversation_canned_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3909
- end
3910
- return data, status_code, headers
3911
- end
3912
- # Update a department
3913
- # Update a department
3914
- # @param conversation_department_oid
3915
- # @param department Department
3916
- # @param [Hash] opts the optional parameters
3917
- # @return [ConversationDepartmentResponse]
3918
- def update_conversation_department(conversation_department_oid, department, opts = {})
3919
- data, _status_code, _headers = update_conversation_department_with_http_info(conversation_department_oid, department, opts)
3920
- data
3921
- end
3922
-
3923
- # Update a department
3924
- # Update a department
3925
- # @param conversation_department_oid
3926
- # @param department Department
3927
- # @param [Hash] opts the optional parameters
3928
- # @return [Array<(ConversationDepartmentResponse, Fixnum, Hash)>] ConversationDepartmentResponse data, response status code and response headers
3929
- def update_conversation_department_with_http_info(conversation_department_oid, department, opts = {})
3930
- if @api_client.config.debugging
3931
- @api_client.config.logger.debug 'Calling API: ConversationApi.update_conversation_department ...'
3932
- end
3933
- # verify the required parameter 'conversation_department_oid' is set
3934
- if @api_client.config.client_side_validation && conversation_department_oid.nil?
3935
- fail ArgumentError, "Missing the required parameter 'conversation_department_oid' when calling ConversationApi.update_conversation_department"
3936
- end
3937
- # verify the required parameter 'department' is set
3938
- if @api_client.config.client_side_validation && department.nil?
3939
- fail ArgumentError, "Missing the required parameter 'department' when calling ConversationApi.update_conversation_department"
3940
- end
3941
- # resource path
3942
- local_var_path = '/conversation/departments/{conversation_department_oid}'.sub('{' + 'conversation_department_oid' + '}', conversation_department_oid.to_s)
3943
-
3944
- # query parameters
3945
- query_params = {}
3946
-
3947
- # header parameters
3948
- header_params = {}
3949
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3950
- # HTTP header 'Accept' (if needed)
3951
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3952
- # HTTP header 'Content-Type'
3953
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3954
-
3955
- # form parameters
3956
- form_params = {}
3957
-
3958
- # http body (model)
3959
- post_body = @api_client.object_to_http_body(department)
3960
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
3961
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
3962
- :header_params => header_params,
3963
- :query_params => query_params,
3964
- :form_params => form_params,
3965
- :body => post_body,
3966
- :auth_names => auth_names,
3967
- :return_type => 'ConversationDepartmentResponse')
3968
- if @api_client.config.debugging
3969
- @api_client.config.logger.debug "API called: ConversationApi#update_conversation_department\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3970
- end
3971
- return data, status_code, headers
3972
- end
3973
- # Update a engagement
3974
- # Update a engagement
3975
- # @param conversation_engagement_oid
3976
- # @param engagement Engagement
3977
- # @param [Hash] opts the optional parameters
3978
- # @return [ConversationEngagementResponse]
3979
- def update_conversation_engagement(conversation_engagement_oid, engagement, opts = {})
3980
- data, _status_code, _headers = update_conversation_engagement_with_http_info(conversation_engagement_oid, engagement, opts)
3981
- data
3982
- end
3983
-
3984
- # Update a engagement
3985
- # Update a engagement
3986
- # @param conversation_engagement_oid
3987
- # @param engagement Engagement
3988
- # @param [Hash] opts the optional parameters
3989
- # @return [Array<(ConversationEngagementResponse, Fixnum, Hash)>] ConversationEngagementResponse data, response status code and response headers
3990
- def update_conversation_engagement_with_http_info(conversation_engagement_oid, engagement, opts = {})
3991
- if @api_client.config.debugging
3992
- @api_client.config.logger.debug 'Calling API: ConversationApi.update_conversation_engagement ...'
3993
- end
3994
- # verify the required parameter 'conversation_engagement_oid' is set
3995
- if @api_client.config.client_side_validation && conversation_engagement_oid.nil?
3996
- fail ArgumentError, "Missing the required parameter 'conversation_engagement_oid' when calling ConversationApi.update_conversation_engagement"
3997
- end
3998
- # verify the required parameter 'engagement' is set
3999
- if @api_client.config.client_side_validation && engagement.nil?
4000
- fail ArgumentError, "Missing the required parameter 'engagement' when calling ConversationApi.update_conversation_engagement"
4001
- end
4002
- # resource path
4003
- local_var_path = '/conversation/engagements/{conversation_engagement_oid}'.sub('{' + 'conversation_engagement_oid' + '}', conversation_engagement_oid.to_s)
4004
-
4005
- # query parameters
4006
- query_params = {}
4007
-
4008
- # header parameters
4009
- header_params = {}
4010
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
4011
- # HTTP header 'Accept' (if needed)
4012
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4013
- # HTTP header 'Content-Type'
4014
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4015
-
4016
- # form parameters
4017
- form_params = {}
4018
-
4019
- # http body (model)
4020
- post_body = @api_client.object_to_http_body(engagement)
4021
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
4022
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4023
- :header_params => header_params,
4024
- :query_params => query_params,
4025
- :form_params => form_params,
4026
- :body => post_body,
4027
- :auth_names => auth_names,
4028
- :return_type => 'ConversationEngagementResponse')
4029
- if @api_client.config.debugging
4030
- @api_client.config.logger.debug "API called: ConversationApi#update_conversation_engagement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4031
- end
4032
- return data, status_code, headers
4033
- end
4034
- # Update status within the queue
4035
- # Update status within the queue
4036
- # @param queue_name
4037
- # @param status_request Status request
4038
- # @param [Hash] opts the optional parameters
4039
- # @return [nil]
4040
- def update_conversation_webchat_queue_status(queue_name, status_request, opts = {})
4041
- update_conversation_webchat_queue_status_with_http_info(queue_name, status_request, opts)
4042
- nil
4043
- end
4044
-
4045
- # Update status within the queue
4046
- # Update status within the queue
4047
- # @param queue_name
4048
- # @param status_request Status request
4049
- # @param [Hash] opts the optional parameters
4050
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
4051
- def update_conversation_webchat_queue_status_with_http_info(queue_name, status_request, opts = {})
4052
- if @api_client.config.debugging
4053
- @api_client.config.logger.debug 'Calling API: ConversationApi.update_conversation_webchat_queue_status ...'
4054
- end
4055
- # verify the required parameter 'queue_name' is set
4056
- if @api_client.config.client_side_validation && queue_name.nil?
4057
- fail ArgumentError, "Missing the required parameter 'queue_name' when calling ConversationApi.update_conversation_webchat_queue_status"
4058
- end
4059
- # verify the required parameter 'status_request' is set
4060
- if @api_client.config.client_side_validation && status_request.nil?
4061
- fail ArgumentError, "Missing the required parameter 'status_request' when calling ConversationApi.update_conversation_webchat_queue_status"
4062
- end
4063
- # resource path
4064
- local_var_path = '/conversation/conversations/queues/{queue_name}/status'.sub('{' + 'queue_name' + '}', queue_name.to_s)
4065
-
4066
- # query parameters
4067
- query_params = {}
4068
-
4069
- # header parameters
4070
- header_params = {}
4071
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
4072
- # HTTP header 'Accept' (if needed)
4073
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4074
- # HTTP header 'Content-Type'
4075
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4076
-
4077
- # form parameters
4078
- form_params = {}
4079
-
4080
- # http body (model)
4081
- post_body = @api_client.object_to_http_body(status_request)
4082
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
4083
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4084
- :header_params => header_params,
4085
- :query_params => query_params,
4086
- :form_params => form_params,
4087
- :body => post_body,
4088
- :auth_names => auth_names)
4089
- if @api_client.config.debugging
4090
- @api_client.config.logger.debug "API called: ConversationApi#update_conversation_webchat_queue_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4091
- end
4092
- return data, status_code, headers
4093
- end
4094
- # Update pbx agent
4095
- # Update a pbx agent
4096
- # @param conversation_pbx_agent_uuid
4097
- # @param pbx_agent Pbx Agent
4098
- # @param [Hash] opts the optional parameters
4099
- # @return [ConversationPbxAgentResponse]
4100
- def update_pbx_agent(conversation_pbx_agent_uuid, pbx_agent, opts = {})
4101
- data, _status_code, _headers = update_pbx_agent_with_http_info(conversation_pbx_agent_uuid, pbx_agent, opts)
4102
- data
4103
- end
4104
-
4105
- # Update pbx agent
4106
- # Update a pbx agent
4107
- # @param conversation_pbx_agent_uuid
4108
- # @param pbx_agent Pbx Agent
4109
- # @param [Hash] opts the optional parameters
4110
- # @return [Array<(ConversationPbxAgentResponse, Fixnum, Hash)>] ConversationPbxAgentResponse data, response status code and response headers
4111
- def update_pbx_agent_with_http_info(conversation_pbx_agent_uuid, pbx_agent, opts = {})
4112
- if @api_client.config.debugging
4113
- @api_client.config.logger.debug 'Calling API: ConversationApi.update_pbx_agent ...'
4114
- end
4115
- # verify the required parameter 'conversation_pbx_agent_uuid' is set
4116
- if @api_client.config.client_side_validation && conversation_pbx_agent_uuid.nil?
4117
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_agent_uuid' when calling ConversationApi.update_pbx_agent"
4118
- end
4119
- # verify the required parameter 'pbx_agent' is set
4120
- if @api_client.config.client_side_validation && pbx_agent.nil?
4121
- fail ArgumentError, "Missing the required parameter 'pbx_agent' when calling ConversationApi.update_pbx_agent"
4122
- end
4123
- # resource path
4124
- local_var_path = '/conversation/pbx/agent/{conversationPbxAgentUuid}'.sub('{' + 'conversationPbxAgentUuid' + '}', conversation_pbx_agent_uuid.to_s)
4125
-
4126
- # query parameters
4127
- query_params = {}
4128
-
4129
- # header parameters
4130
- header_params = {}
4131
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
4132
- # HTTP header 'Accept' (if needed)
4133
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4134
- # HTTP header 'Content-Type'
4135
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4136
-
4137
- # form parameters
4138
- form_params = {}
4139
-
4140
- # http body (model)
4141
- post_body = @api_client.object_to_http_body(pbx_agent)
4142
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
4143
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4144
- :header_params => header_params,
4145
- :query_params => query_params,
4146
- :form_params => form_params,
4147
- :body => post_body,
4148
- :auth_names => auth_names,
4149
- :return_type => 'ConversationPbxAgentResponse')
4150
- if @api_client.config.debugging
4151
- @api_client.config.logger.debug "API called: ConversationApi#update_pbx_agent\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4152
- end
4153
- return data, status_code, headers
4154
- end
4155
- # Update pbx audio
4156
- # Update a pbx audio
4157
- # @param conversation_pbx_audio_uuid
4158
- # @param pbx_audio Pbx Audio
4159
- # @param [Hash] opts the optional parameters
4160
- # @return [ConversationPbxAudioResponse]
4161
- def update_pbx_audio(conversation_pbx_audio_uuid, pbx_audio, opts = {})
4162
- data, _status_code, _headers = update_pbx_audio_with_http_info(conversation_pbx_audio_uuid, pbx_audio, opts)
4163
- data
4164
- end
4165
-
4166
- # Update pbx audio
4167
- # Update a pbx audio
4168
- # @param conversation_pbx_audio_uuid
4169
- # @param pbx_audio Pbx Audio
4170
- # @param [Hash] opts the optional parameters
4171
- # @return [Array<(ConversationPbxAudioResponse, Fixnum, Hash)>] ConversationPbxAudioResponse data, response status code and response headers
4172
- def update_pbx_audio_with_http_info(conversation_pbx_audio_uuid, pbx_audio, opts = {})
4173
- if @api_client.config.debugging
4174
- @api_client.config.logger.debug 'Calling API: ConversationApi.update_pbx_audio ...'
4175
- end
4176
- # verify the required parameter 'conversation_pbx_audio_uuid' is set
4177
- if @api_client.config.client_side_validation && conversation_pbx_audio_uuid.nil?
4178
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_audio_uuid' when calling ConversationApi.update_pbx_audio"
4179
- end
4180
- # verify the required parameter 'pbx_audio' is set
4181
- if @api_client.config.client_side_validation && pbx_audio.nil?
4182
- fail ArgumentError, "Missing the required parameter 'pbx_audio' when calling ConversationApi.update_pbx_audio"
4183
- end
4184
- # resource path
4185
- local_var_path = '/conversation/pbx/audio/{conversationPbxAudioUuid}'.sub('{' + 'conversationPbxAudioUuid' + '}', conversation_pbx_audio_uuid.to_s)
4186
-
4187
- # query parameters
4188
- query_params = {}
4189
-
4190
- # header parameters
4191
- header_params = {}
4192
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
4193
- # HTTP header 'Accept' (if needed)
4194
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4195
- # HTTP header 'Content-Type'
4196
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4197
-
4198
- # form parameters
4199
- form_params = {}
4200
-
4201
- # http body (model)
4202
- post_body = @api_client.object_to_http_body(pbx_audio)
4203
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
4204
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4205
- :header_params => header_params,
4206
- :query_params => query_params,
4207
- :form_params => form_params,
4208
- :body => post_body,
4209
- :auth_names => auth_names,
4210
- :return_type => 'ConversationPbxAudioResponse')
4211
- if @api_client.config.debugging
4212
- @api_client.config.logger.debug "API called: ConversationApi#update_pbx_audio\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4213
- end
4214
- return data, status_code, headers
4215
- end
4216
- # Update pbx menu
4217
- # Update a pbx menu
4218
- # @param conversation_pbx_menu_uuid
4219
- # @param pbx_menu Pbx Menu
4220
- # @param [Hash] opts the optional parameters
4221
- # @return [ConversationPbxMenuResponse]
4222
- def update_pbx_menu(conversation_pbx_menu_uuid, pbx_menu, opts = {})
4223
- data, _status_code, _headers = update_pbx_menu_with_http_info(conversation_pbx_menu_uuid, pbx_menu, opts)
4224
- data
4225
- end
4226
-
4227
- # Update pbx menu
4228
- # Update a pbx menu
4229
- # @param conversation_pbx_menu_uuid
4230
- # @param pbx_menu Pbx Menu
4231
- # @param [Hash] opts the optional parameters
4232
- # @return [Array<(ConversationPbxMenuResponse, Fixnum, Hash)>] ConversationPbxMenuResponse data, response status code and response headers
4233
- def update_pbx_menu_with_http_info(conversation_pbx_menu_uuid, pbx_menu, opts = {})
4234
- if @api_client.config.debugging
4235
- @api_client.config.logger.debug 'Calling API: ConversationApi.update_pbx_menu ...'
4236
- end
4237
- # verify the required parameter 'conversation_pbx_menu_uuid' is set
4238
- if @api_client.config.client_side_validation && conversation_pbx_menu_uuid.nil?
4239
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_menu_uuid' when calling ConversationApi.update_pbx_menu"
4240
- end
4241
- # verify the required parameter 'pbx_menu' is set
4242
- if @api_client.config.client_side_validation && pbx_menu.nil?
4243
- fail ArgumentError, "Missing the required parameter 'pbx_menu' when calling ConversationApi.update_pbx_menu"
4244
- end
4245
- # resource path
4246
- local_var_path = '/conversation/pbx/menu/{conversationPbxMenuUuid}'.sub('{' + 'conversationPbxMenuUuid' + '}', conversation_pbx_menu_uuid.to_s)
4247
-
4248
- # query parameters
4249
- query_params = {}
4250
-
4251
- # header parameters
4252
- header_params = {}
4253
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
4254
- # HTTP header 'Accept' (if needed)
4255
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4256
- # HTTP header 'Content-Type'
4257
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4258
-
4259
- # form parameters
4260
- form_params = {}
4261
-
4262
- # http body (model)
4263
- post_body = @api_client.object_to_http_body(pbx_menu)
4264
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
4265
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4266
- :header_params => header_params,
4267
- :query_params => query_params,
4268
- :form_params => form_params,
4269
- :body => post_body,
4270
- :auth_names => auth_names,
4271
- :return_type => 'ConversationPbxMenuResponse')
4272
- if @api_client.config.debugging
4273
- @api_client.config.logger.debug "API called: ConversationApi#update_pbx_menu\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4274
- end
4275
- return data, status_code, headers
4276
- end
4277
- # Update pbx phoneNumber
4278
- # Update a pbx phoneNumber
4279
- # @param conversation_pbx_phone_number_uuid
4280
- # @param pbx_phone_number Pbx PhoneNumber
4281
- # @param [Hash] opts the optional parameters
4282
- # @return [ConversationPbxPhoneNumberResponse]
4283
- def update_pbx_phone_number(conversation_pbx_phone_number_uuid, pbx_phone_number, opts = {})
4284
- data, _status_code, _headers = update_pbx_phone_number_with_http_info(conversation_pbx_phone_number_uuid, pbx_phone_number, opts)
4285
- data
4286
- end
4287
-
4288
- # Update pbx phoneNumber
4289
- # Update a pbx phoneNumber
4290
- # @param conversation_pbx_phone_number_uuid
4291
- # @param pbx_phone_number Pbx PhoneNumber
4292
- # @param [Hash] opts the optional parameters
4293
- # @return [Array<(ConversationPbxPhoneNumberResponse, Fixnum, Hash)>] ConversationPbxPhoneNumberResponse data, response status code and response headers
4294
- def update_pbx_phone_number_with_http_info(conversation_pbx_phone_number_uuid, pbx_phone_number, opts = {})
4295
- if @api_client.config.debugging
4296
- @api_client.config.logger.debug 'Calling API: ConversationApi.update_pbx_phone_number ...'
4297
- end
4298
- # verify the required parameter 'conversation_pbx_phone_number_uuid' is set
4299
- if @api_client.config.client_side_validation && conversation_pbx_phone_number_uuid.nil?
4300
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_phone_number_uuid' when calling ConversationApi.update_pbx_phone_number"
4301
- end
4302
- # verify the required parameter 'pbx_phone_number' is set
4303
- if @api_client.config.client_side_validation && pbx_phone_number.nil?
4304
- fail ArgumentError, "Missing the required parameter 'pbx_phone_number' when calling ConversationApi.update_pbx_phone_number"
4305
- end
4306
- # resource path
4307
- local_var_path = '/conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid}'.sub('{' + 'conversationPbxPhoneNumberUuid' + '}', conversation_pbx_phone_number_uuid.to_s)
4308
-
4309
- # query parameters
4310
- query_params = {}
4311
-
4312
- # header parameters
4313
- header_params = {}
4314
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
4315
- # HTTP header 'Accept' (if needed)
4316
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4317
- # HTTP header 'Content-Type'
4318
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4319
-
4320
- # form parameters
4321
- form_params = {}
4322
-
4323
- # http body (model)
4324
- post_body = @api_client.object_to_http_body(pbx_phone_number)
4325
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
4326
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4327
- :header_params => header_params,
4328
- :query_params => query_params,
4329
- :form_params => form_params,
4330
- :body => post_body,
4331
- :auth_names => auth_names,
4332
- :return_type => 'ConversationPbxPhoneNumberResponse')
4333
- if @api_client.config.debugging
4334
- @api_client.config.logger.debug "API called: ConversationApi#update_pbx_phone_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4335
- end
4336
- return data, status_code, headers
4337
- end
4338
- # Update pbx queue
4339
- # Update a pbx queue
4340
- # @param conversation_pbx_queue_uuid
4341
- # @param pbx_queue Pbx Queue
4342
- # @param [Hash] opts the optional parameters
4343
- # @return [ConversationPbxQueueResponse]
4344
- def update_pbx_queue(conversation_pbx_queue_uuid, pbx_queue, opts = {})
4345
- data, _status_code, _headers = update_pbx_queue_with_http_info(conversation_pbx_queue_uuid, pbx_queue, opts)
4346
- data
4347
- end
4348
-
4349
- # Update pbx queue
4350
- # Update a pbx queue
4351
- # @param conversation_pbx_queue_uuid
4352
- # @param pbx_queue Pbx Queue
4353
- # @param [Hash] opts the optional parameters
4354
- # @return [Array<(ConversationPbxQueueResponse, Fixnum, Hash)>] ConversationPbxQueueResponse data, response status code and response headers
4355
- def update_pbx_queue_with_http_info(conversation_pbx_queue_uuid, pbx_queue, opts = {})
4356
- if @api_client.config.debugging
4357
- @api_client.config.logger.debug 'Calling API: ConversationApi.update_pbx_queue ...'
4358
- end
4359
- # verify the required parameter 'conversation_pbx_queue_uuid' is set
4360
- if @api_client.config.client_side_validation && conversation_pbx_queue_uuid.nil?
4361
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_queue_uuid' when calling ConversationApi.update_pbx_queue"
4362
- end
4363
- # verify the required parameter 'pbx_queue' is set
4364
- if @api_client.config.client_side_validation && pbx_queue.nil?
4365
- fail ArgumentError, "Missing the required parameter 'pbx_queue' when calling ConversationApi.update_pbx_queue"
4366
- end
4367
- # resource path
4368
- local_var_path = '/conversation/pbx/queue/{conversationPbxQueueUuid}'.sub('{' + 'conversationPbxQueueUuid' + '}', conversation_pbx_queue_uuid.to_s)
4369
-
4370
- # query parameters
4371
- query_params = {}
4372
-
4373
- # header parameters
4374
- header_params = {}
4375
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
4376
- # HTTP header 'Accept' (if needed)
4377
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4378
- # HTTP header 'Content-Type'
4379
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4380
-
4381
- # form parameters
4382
- form_params = {}
4383
-
4384
- # http body (model)
4385
- post_body = @api_client.object_to_http_body(pbx_queue)
4386
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
4387
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4388
- :header_params => header_params,
4389
- :query_params => query_params,
4390
- :form_params => form_params,
4391
- :body => post_body,
4392
- :auth_names => auth_names,
4393
- :return_type => 'ConversationPbxQueueResponse')
4394
- if @api_client.config.debugging
4395
- @api_client.config.logger.debug "API called: ConversationApi#update_pbx_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4396
- end
4397
- return data, status_code, headers
4398
- end
4399
- # Update pbx timeBased
4400
- # Update a pbx timeBased
4401
- # @param conversation_pbx_time_based_uuid
4402
- # @param pbx_time_based Pbx TimeBased
4403
- # @param [Hash] opts the optional parameters
4404
- # @return [ConversationPbxTimeBasedResponse]
4405
- def update_pbx_time_based(conversation_pbx_time_based_uuid, pbx_time_based, opts = {})
4406
- data, _status_code, _headers = update_pbx_time_based_with_http_info(conversation_pbx_time_based_uuid, pbx_time_based, opts)
4407
- data
4408
- end
4409
-
4410
- # Update pbx timeBased
4411
- # Update a pbx timeBased
4412
- # @param conversation_pbx_time_based_uuid
4413
- # @param pbx_time_based Pbx TimeBased
4414
- # @param [Hash] opts the optional parameters
4415
- # @return [Array<(ConversationPbxTimeBasedResponse, Fixnum, Hash)>] ConversationPbxTimeBasedResponse data, response status code and response headers
4416
- def update_pbx_time_based_with_http_info(conversation_pbx_time_based_uuid, pbx_time_based, opts = {})
4417
- if @api_client.config.debugging
4418
- @api_client.config.logger.debug 'Calling API: ConversationApi.update_pbx_time_based ...'
4419
- end
4420
- # verify the required parameter 'conversation_pbx_time_based_uuid' is set
4421
- if @api_client.config.client_side_validation && conversation_pbx_time_based_uuid.nil?
4422
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_time_based_uuid' when calling ConversationApi.update_pbx_time_based"
4423
- end
4424
- # verify the required parameter 'pbx_time_based' is set
4425
- if @api_client.config.client_side_validation && pbx_time_based.nil?
4426
- fail ArgumentError, "Missing the required parameter 'pbx_time_based' when calling ConversationApi.update_pbx_time_based"
4427
- end
4428
- # resource path
4429
- local_var_path = '/conversation/pbx/time_based/{conversationPbxTimeBasedUuid}'.sub('{' + 'conversationPbxTimeBasedUuid' + '}', conversation_pbx_time_based_uuid.to_s)
4430
-
4431
- # query parameters
4432
- query_params = {}
4433
-
4434
- # header parameters
4435
- header_params = {}
4436
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
4437
- # HTTP header 'Accept' (if needed)
4438
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4439
- # HTTP header 'Content-Type'
4440
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4441
-
4442
- # form parameters
4443
- form_params = {}
4444
-
4445
- # http body (model)
4446
- post_body = @api_client.object_to_http_body(pbx_time_based)
4447
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
4448
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4449
- :header_params => header_params,
4450
- :query_params => query_params,
4451
- :form_params => form_params,
4452
- :body => post_body,
4453
- :auth_names => auth_names,
4454
- :return_type => 'ConversationPbxTimeBasedResponse')
4455
- if @api_client.config.debugging
4456
- @api_client.config.logger.debug "API called: ConversationApi#update_pbx_time_based\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4457
- end
4458
- return data, status_code, headers
4459
- end
4460
- # Update pbx timeRange
4461
- # Update a pbx timeRange
4462
- # @param conversation_pbx_time_range_uuid
4463
- # @param pbx_time_range Pbx TimeRange
4464
- # @param [Hash] opts the optional parameters
4465
- # @return [ConversationPbxTimeRangeResponse]
4466
- def update_pbx_time_range(conversation_pbx_time_range_uuid, pbx_time_range, opts = {})
4467
- data, _status_code, _headers = update_pbx_time_range_with_http_info(conversation_pbx_time_range_uuid, pbx_time_range, opts)
4468
- data
4469
- end
4470
-
4471
- # Update pbx timeRange
4472
- # Update a pbx timeRange
4473
- # @param conversation_pbx_time_range_uuid
4474
- # @param pbx_time_range Pbx TimeRange
4475
- # @param [Hash] opts the optional parameters
4476
- # @return [Array<(ConversationPbxTimeRangeResponse, Fixnum, Hash)>] ConversationPbxTimeRangeResponse data, response status code and response headers
4477
- def update_pbx_time_range_with_http_info(conversation_pbx_time_range_uuid, pbx_time_range, opts = {})
4478
- if @api_client.config.debugging
4479
- @api_client.config.logger.debug 'Calling API: ConversationApi.update_pbx_time_range ...'
4480
- end
4481
- # verify the required parameter 'conversation_pbx_time_range_uuid' is set
4482
- if @api_client.config.client_side_validation && conversation_pbx_time_range_uuid.nil?
4483
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_time_range_uuid' when calling ConversationApi.update_pbx_time_range"
4484
- end
4485
- # verify the required parameter 'pbx_time_range' is set
4486
- if @api_client.config.client_side_validation && pbx_time_range.nil?
4487
- fail ArgumentError, "Missing the required parameter 'pbx_time_range' when calling ConversationApi.update_pbx_time_range"
4488
- end
4489
- # resource path
4490
- local_var_path = '/conversation/pbx/time_range/{conversationPbxTimeRangeUuid}'.sub('{' + 'conversationPbxTimeRangeUuid' + '}', conversation_pbx_time_range_uuid.to_s)
4491
-
4492
- # query parameters
4493
- query_params = {}
4494
-
4495
- # header parameters
4496
- header_params = {}
4497
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
4498
- # HTTP header 'Accept' (if needed)
4499
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4500
- # HTTP header 'Content-Type'
4501
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4502
-
4503
- # form parameters
4504
- form_params = {}
4505
-
4506
- # http body (model)
4507
- post_body = @api_client.object_to_http_body(pbx_time_range)
4508
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
4509
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4510
- :header_params => header_params,
4511
- :query_params => query_params,
4512
- :form_params => form_params,
4513
- :body => post_body,
4514
- :auth_names => auth_names,
4515
- :return_type => 'ConversationPbxTimeRangeResponse')
4516
- if @api_client.config.debugging
4517
- @api_client.config.logger.debug "API called: ConversationApi#update_pbx_time_range\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4518
- end
4519
- return data, status_code, headers
4520
- end
4521
- # Update pbx voicemailMailbox
4522
- # Update a pbx voicemailMailbox
4523
- # @param conversation_pbx_voicemail_mailbox_uuid
4524
- # @param pbx_voicemail_mailbox Pbx VoicemailMailbox
4525
- # @param [Hash] opts the optional parameters
4526
- # @return [ConversationPbxVoicemailMailboxResponse]
4527
- def update_pbx_voicemail_mailbox(conversation_pbx_voicemail_mailbox_uuid, pbx_voicemail_mailbox, opts = {})
4528
- data, _status_code, _headers = update_pbx_voicemail_mailbox_with_http_info(conversation_pbx_voicemail_mailbox_uuid, pbx_voicemail_mailbox, opts)
4529
- data
4530
- end
4531
-
4532
- # Update pbx voicemailMailbox
4533
- # Update a pbx voicemailMailbox
4534
- # @param conversation_pbx_voicemail_mailbox_uuid
4535
- # @param pbx_voicemail_mailbox Pbx VoicemailMailbox
4536
- # @param [Hash] opts the optional parameters
4537
- # @return [Array<(ConversationPbxVoicemailMailboxResponse, Fixnum, Hash)>] ConversationPbxVoicemailMailboxResponse data, response status code and response headers
4538
- def update_pbx_voicemail_mailbox_with_http_info(conversation_pbx_voicemail_mailbox_uuid, pbx_voicemail_mailbox, opts = {})
4539
- if @api_client.config.debugging
4540
- @api_client.config.logger.debug 'Calling API: ConversationApi.update_pbx_voicemail_mailbox ...'
4541
- end
4542
- # verify the required parameter 'conversation_pbx_voicemail_mailbox_uuid' is set
4543
- if @api_client.config.client_side_validation && conversation_pbx_voicemail_mailbox_uuid.nil?
4544
- fail ArgumentError, "Missing the required parameter 'conversation_pbx_voicemail_mailbox_uuid' when calling ConversationApi.update_pbx_voicemail_mailbox"
4545
- end
4546
- # verify the required parameter 'pbx_voicemail_mailbox' is set
4547
- if @api_client.config.client_side_validation && pbx_voicemail_mailbox.nil?
4548
- fail ArgumentError, "Missing the required parameter 'pbx_voicemail_mailbox' when calling ConversationApi.update_pbx_voicemail_mailbox"
4549
- end
4550
- # resource path
4551
- local_var_path = '/conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid}'.sub('{' + 'conversationPbxVoicemailMailboxUuid' + '}', conversation_pbx_voicemail_mailbox_uuid.to_s)
4552
-
4553
- # query parameters
4554
- query_params = {}
4555
-
4556
- # header parameters
4557
- header_params = {}
4558
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
4559
- # HTTP header 'Accept' (if needed)
4560
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4561
- # HTTP header 'Content-Type'
4562
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4563
-
4564
- # form parameters
4565
- form_params = {}
4566
-
4567
- # http body (model)
4568
- post_body = @api_client.object_to_http_body(pbx_voicemail_mailbox)
4569
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
4570
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4571
- :header_params => header_params,
4572
- :query_params => query_params,
4573
- :form_params => form_params,
4574
- :body => post_body,
4575
- :auth_names => auth_names,
4576
- :return_type => 'ConversationPbxVoicemailMailboxResponse')
4577
- if @api_client.config.debugging
4578
- @api_client.config.logger.debug "API called: ConversationApi#update_pbx_voicemail_mailbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4579
- end
4580
- return data, status_code, headers
4581
- end
4582
- end
4583
- end