ultracart_api 3.11.10 → 4.0.32.rc

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