ultra_cart_rest_api_v2 3.10.184 → 3.10.185

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 (898) hide show
  1. package/README.md +77 -1
  2. package/docs/ConversationApi.md +2439 -313
  3. package/docs/ConversationPbxAgent.md +16 -0
  4. package/docs/ConversationPbxAgentResponse.md +12 -0
  5. package/docs/ConversationPbxAgentsResponse.md +12 -0
  6. package/docs/ConversationPbxAudio.md +16 -0
  7. package/docs/ConversationPbxAudioResponse.md +12 -0
  8. package/docs/ConversationPbxAudiosResponse.md +12 -0
  9. package/docs/ConversationPbxCustomerSnapshotRequest.md +15 -0
  10. package/docs/ConversationPbxCustomerSnapshotResponse.md +14 -0
  11. package/docs/ConversationPbxMenu.md +17 -0
  12. package/docs/ConversationPbxMenuMapping.md +11 -0
  13. package/docs/ConversationPbxMenuResponse.md +12 -0
  14. package/docs/ConversationPbxMenusResponse.md +12 -0
  15. package/docs/ConversationPbxPhoneNumber.md +12 -0
  16. package/docs/ConversationPbxPhoneNumberResponse.md +12 -0
  17. package/docs/ConversationPbxPhoneNumbersResponse.md +12 -0
  18. package/docs/ConversationPbxQueue.md +25 -0
  19. package/docs/ConversationPbxQueueMembers.md +9 -0
  20. package/docs/ConversationPbxQueueResponse.md +12 -0
  21. package/docs/ConversationPbxQueuesResponse.md +12 -0
  22. package/docs/ConversationPbxTimeBased.md +11 -0
  23. package/docs/ConversationPbxTimeBasedMapping.md +11 -0
  24. package/docs/ConversationPbxTimeBasedMappingConfig.md +9 -0
  25. package/docs/ConversationPbxTimeBasedResponse.md +12 -0
  26. package/docs/ConversationPbxTimeBasedsResponse.md +12 -0
  27. package/docs/ConversationPbxTimeRange.md +12 -0
  28. package/docs/ConversationPbxTimeRangeConfig.md +13 -0
  29. package/docs/ConversationPbxTimeRangeResponse.md +12 -0
  30. package/docs/ConversationPbxTimeRangesResponse.md +12 -0
  31. package/docs/ConversationPbxVoicemailMailbox.md +18 -0
  32. package/docs/ConversationPbxVoicemailMailboxResponse.md +12 -0
  33. package/docs/ConversationPbxVoicemailMailboxesResponse.md +12 -0
  34. package/docs/WorkflowApi.md +46 -0
  35. package/docs/WorkflowTaskTagsResponse.md +12 -0
  36. package/package.json +1 -1
  37. package/src/ApiClient.js +1 -1
  38. package/src/com.ultracart.admin.v2/AffiliateApi.js +1 -1
  39. package/src/com.ultracart.admin.v2/AutoOrderApi.js +1 -1
  40. package/src/com.ultracart.admin.v2/ChannelPartnerApi.js +1 -1
  41. package/src/com.ultracart.admin.v2/ChargebackApi.js +1 -1
  42. package/src/com.ultracart.admin.v2/CheckoutApi.js +1 -1
  43. package/src/com.ultracart.admin.v2/ConversationApi.js +2476 -477
  44. package/src/com.ultracart.admin.v2/CouponApi.js +1 -1
  45. package/src/com.ultracart.admin.v2/CustomerApi.js +1 -1
  46. package/src/com.ultracart.admin.v2/DatawarehouseApi.js +1 -1
  47. package/src/com.ultracart.admin.v2/FulfillmentApi.js +1 -1
  48. package/src/com.ultracart.admin.v2/GiftCertificateApi.js +1 -1
  49. package/src/com.ultracart.admin.v2/IntegrationLogApi.js +1 -1
  50. package/src/com.ultracart.admin.v2/ItemApi.js +1 -1
  51. package/src/com.ultracart.admin.v2/OauthApi.js +1 -1
  52. package/src/com.ultracart.admin.v2/OrderApi.js +1 -1
  53. package/src/com.ultracart.admin.v2/SsoApi.js +1 -1
  54. package/src/com.ultracart.admin.v2/StorefrontApi.js +1 -1
  55. package/src/com.ultracart.admin.v2/TaxApi.js +1 -1
  56. package/src/com.ultracart.admin.v2/UserApi.js +1 -1
  57. package/src/com.ultracart.admin.v2/WebhookApi.js +1 -1
  58. package/src/com.ultracart.admin.v2/WorkflowApi.js +46 -5
  59. package/src/com.ultracart.admin.v2.models/AccountsReceivableRetryConfig.js +1 -1
  60. package/src/com.ultracart.admin.v2.models/AccountsReceivableRetryConfigResponse.js +1 -1
  61. package/src/com.ultracart.admin.v2.models/AccountsReceivableRetryDayActivity.js +1 -1
  62. package/src/com.ultracart.admin.v2.models/AccountsReceivableRetryStatAccount.js +1 -1
  63. package/src/com.ultracart.admin.v2.models/AccountsReceivableRetryStatMetrics.js +1 -1
  64. package/src/com.ultracart.admin.v2.models/AccountsReceivableRetryStatRevenue.js +1 -1
  65. package/src/com.ultracart.admin.v2.models/AccountsReceivableRetryStatsResponse.js +1 -1
  66. package/src/com.ultracart.admin.v2.models/AccountsReceivableRetryTransactionReject.js +1 -1
  67. package/src/com.ultracart.admin.v2.models/Activity.js +1 -1
  68. package/src/com.ultracart.admin.v2.models/AddLibraryItemRequest.js +1 -1
  69. package/src/com.ultracart.admin.v2.models/AdjustInternalCertificateRequest.js +1 -1
  70. package/src/com.ultracart.admin.v2.models/AdjustInternalCertificateResponse.js +1 -1
  71. package/src/com.ultracart.admin.v2.models/AffiliateClick.js +1 -1
  72. package/src/com.ultracart.admin.v2.models/AffiliateClickQuery.js +1 -1
  73. package/src/com.ultracart.admin.v2.models/AffiliateClicksResponse.js +1 -1
  74. package/src/com.ultracart.admin.v2.models/AffiliateLedger.js +1 -1
  75. package/src/com.ultracart.admin.v2.models/AffiliateLedgerQuery.js +1 -1
  76. package/src/com.ultracart.admin.v2.models/AffiliateLedgersResponse.js +1 -1
  77. package/src/com.ultracart.admin.v2.models/AffiliateLink.js +1 -1
  78. package/src/com.ultracart.admin.v2.models/ApiUserApplicationProfile.js +1 -1
  79. package/src/com.ultracart.admin.v2.models/ApplyLibraryItemRequest.js +1 -1
  80. package/src/com.ultracart.admin.v2.models/ApplyLibraryItemResponse.js +1 -1
  81. package/src/com.ultracart.admin.v2.models/AutoOrder.js +1 -1
  82. package/src/com.ultracart.admin.v2.models/AutoOrderAddonItem.js +1 -1
  83. package/src/com.ultracart.admin.v2.models/AutoOrderAddonItemOption.js +1 -1
  84. package/src/com.ultracart.admin.v2.models/AutoOrderItem.js +1 -1
  85. package/src/com.ultracart.admin.v2.models/AutoOrderItemFutureSchedule.js +1 -1
  86. package/src/com.ultracart.admin.v2.models/AutoOrderItemOption.js +1 -1
  87. package/src/com.ultracart.admin.v2.models/AutoOrderItemSimpleSchedule.js +1 -1
  88. package/src/com.ultracart.admin.v2.models/AutoOrderLog.js +1 -1
  89. package/src/com.ultracart.admin.v2.models/AutoOrderManagement.js +1 -1
  90. package/src/com.ultracart.admin.v2.models/AutoOrderQuery.js +1 -1
  91. package/src/com.ultracart.admin.v2.models/AutoOrderQueryBatch.js +1 -1
  92. package/src/com.ultracart.admin.v2.models/AutoOrderResponse.js +1 -1
  93. package/src/com.ultracart.admin.v2.models/AutoOrdersRequest.js +1 -1
  94. package/src/com.ultracart.admin.v2.models/AutoOrdersResponse.js +1 -1
  95. package/src/com.ultracart.admin.v2.models/AvalaraConfig.js +1 -1
  96. package/src/com.ultracart.admin.v2.models/BaseResponse.js +1 -1
  97. package/src/com.ultracart.admin.v2.models/Browser.js +1 -1
  98. package/src/com.ultracart.admin.v2.models/BrowserDevice.js +1 -1
  99. package/src/com.ultracart.admin.v2.models/BrowserOS.js +1 -1
  100. package/src/com.ultracart.admin.v2.models/BrowserUserAgent.js +1 -1
  101. package/src/com.ultracart.admin.v2.models/Cart.js +1 -1
  102. package/src/com.ultracart.admin.v2.models/CartAffiliate.js +1 -1
  103. package/src/com.ultracart.admin.v2.models/CartAffirmCheckoutResponse.js +1 -1
  104. package/src/com.ultracart.admin.v2.models/CartBilling.js +1 -1
  105. package/src/com.ultracart.admin.v2.models/CartBuysafe.js +1 -1
  106. package/src/com.ultracart.admin.v2.models/CartCheckout.js +1 -1
  107. package/src/com.ultracart.admin.v2.models/CartCoupon.js +1 -1
  108. package/src/com.ultracart.admin.v2.models/CartCurrencyConversion.js +1 -1
  109. package/src/com.ultracart.admin.v2.models/CartCustomerProfile.js +1 -1
  110. package/src/com.ultracart.admin.v2.models/CartCustomerProfileAddress.js +1 -1
  111. package/src/com.ultracart.admin.v2.models/CartCustomerProfileCreditCard.js +1 -1
  112. package/src/com.ultracart.admin.v2.models/CartFinalizeOrderRequest.js +1 -1
  113. package/src/com.ultracart.admin.v2.models/CartFinalizeOrderRequestOptions.js +1 -1
  114. package/src/com.ultracart.admin.v2.models/CartFinalizeOrderResponse.js +1 -1
  115. package/src/com.ultracart.admin.v2.models/CartGift.js +1 -1
  116. package/src/com.ultracart.admin.v2.models/CartGiftCertificate.js +1 -1
  117. package/src/com.ultracart.admin.v2.models/CartItem.js +1 -1
  118. package/src/com.ultracart.admin.v2.models/CartItemAttribute.js +1 -1
  119. package/src/com.ultracart.admin.v2.models/CartItemMultimedia.js +1 -1
  120. package/src/com.ultracart.admin.v2.models/CartItemMultimediaThumbnail.js +1 -1
  121. package/src/com.ultracart.admin.v2.models/CartItemOption.js +1 -1
  122. package/src/com.ultracart.admin.v2.models/CartItemOptionValue.js +1 -1
  123. package/src/com.ultracart.admin.v2.models/CartItemPhysical.js +1 -1
  124. package/src/com.ultracart.admin.v2.models/CartItemProperty.js +1 -1
  125. package/src/com.ultracart.admin.v2.models/CartItemVariationSelection.js +1 -1
  126. package/src/com.ultracart.admin.v2.models/CartKitComponentOption.js +1 -1
  127. package/src/com.ultracart.admin.v2.models/CartMarketing.js +1 -1
  128. package/src/com.ultracart.admin.v2.models/CartPayment.js +1 -1
  129. package/src/com.ultracart.admin.v2.models/CartPaymentAffirm.js +1 -1
  130. package/src/com.ultracart.admin.v2.models/CartPaymentAmazon.js +1 -1
  131. package/src/com.ultracart.admin.v2.models/CartPaymentCheck.js +1 -1
  132. package/src/com.ultracart.admin.v2.models/CartPaymentCreditCard.js +1 -1
  133. package/src/com.ultracart.admin.v2.models/CartPaymentHealthBenefitCard.js +1 -1
  134. package/src/com.ultracart.admin.v2.models/CartPaymentPurchaseOrder.js +1 -1
  135. package/src/com.ultracart.admin.v2.models/CartProfileLoginRequest.js +1 -1
  136. package/src/com.ultracart.admin.v2.models/CartProfileLoginResponse.js +1 -1
  137. package/src/com.ultracart.admin.v2.models/CartProfileRegisterRequest.js +1 -1
  138. package/src/com.ultracart.admin.v2.models/CartProfileRegisterResponse.js +1 -1
  139. package/src/com.ultracart.admin.v2.models/CartProperty.js +1 -1
  140. package/src/com.ultracart.admin.v2.models/CartResponse.js +1 -1
  141. package/src/com.ultracart.admin.v2.models/CartSettings.js +1 -1
  142. package/src/com.ultracart.admin.v2.models/CartSettingsBilling.js +1 -1
  143. package/src/com.ultracart.admin.v2.models/CartSettingsGift.js +1 -1
  144. package/src/com.ultracart.admin.v2.models/CartSettingsGiftWrap.js +1 -1
  145. package/src/com.ultracart.admin.v2.models/CartSettingsPayment.js +1 -1
  146. package/src/com.ultracart.admin.v2.models/CartSettingsPaymentAmazon.js +1 -1
  147. package/src/com.ultracart.admin.v2.models/CartSettingsPaymentCreditCard.js +1 -1
  148. package/src/com.ultracart.admin.v2.models/CartSettingsPaymentPayPal.js +1 -1
  149. package/src/com.ultracart.admin.v2.models/CartSettingsProvince.js +1 -1
  150. package/src/com.ultracart.admin.v2.models/CartSettingsShipping.js +1 -1
  151. package/src/com.ultracart.admin.v2.models/CartSettingsShippingCalendar.js +1 -1
  152. package/src/com.ultracart.admin.v2.models/CartSettingsShippingEstimate.js +1 -1
  153. package/src/com.ultracart.admin.v2.models/CartSettingsTaxes.js +1 -1
  154. package/src/com.ultracart.admin.v2.models/CartSettingsTerms.js +1 -1
  155. package/src/com.ultracart.admin.v2.models/CartShipping.js +1 -1
  156. package/src/com.ultracart.admin.v2.models/CartSummary.js +1 -1
  157. package/src/com.ultracart.admin.v2.models/CartTaxes.js +1 -1
  158. package/src/com.ultracart.admin.v2.models/CartUpsellAfter.js +1 -1
  159. package/src/com.ultracart.admin.v2.models/CartValidationRequest.js +1 -1
  160. package/src/com.ultracart.admin.v2.models/CartValidationResponse.js +1 -1
  161. package/src/com.ultracart.admin.v2.models/ChannelPartner.js +1 -1
  162. package/src/com.ultracart.admin.v2.models/ChannelPartnerCancelResponse.js +1 -1
  163. package/src/com.ultracart.admin.v2.models/ChannelPartnerEstimateShippingResponse.js +1 -1
  164. package/src/com.ultracart.admin.v2.models/ChannelPartnerEstimateTaxResponse.js +1 -1
  165. package/src/com.ultracart.admin.v2.models/ChannelPartnerImportResponse.js +1 -1
  166. package/src/com.ultracart.admin.v2.models/ChannelPartnerOrder.js +1 -1
  167. package/src/com.ultracart.admin.v2.models/ChannelPartnerOrderItem.js +1 -1
  168. package/src/com.ultracart.admin.v2.models/ChannelPartnerOrderItemOption.js +1 -1
  169. package/src/com.ultracart.admin.v2.models/ChannelPartnerOrderTransaction.js +1 -1
  170. package/src/com.ultracart.admin.v2.models/ChannelPartnerOrderTransactionDetail.js +1 -1
  171. package/src/com.ultracart.admin.v2.models/ChannelPartnerShipToPreference.js +1 -1
  172. package/src/com.ultracart.admin.v2.models/ChannelPartnerShipToPreferenceResponse.js +1 -1
  173. package/src/com.ultracart.admin.v2.models/ChannelPartnerShipToPreferencesResponse.js +1 -1
  174. package/src/com.ultracart.admin.v2.models/ChannelPartnerShippingEstimate.js +1 -1
  175. package/src/com.ultracart.admin.v2.models/ChannelPartnersResponse.js +1 -1
  176. package/src/com.ultracart.admin.v2.models/ChargebackDispute.js +1 -1
  177. package/src/com.ultracart.admin.v2.models/ChargebackDisputeResponse.js +1 -1
  178. package/src/com.ultracart.admin.v2.models/ChargebackDisputesResponse.js +1 -1
  179. package/src/com.ultracart.admin.v2.models/CheckoutAllowedCountriesResponse.js +1 -1
  180. package/src/com.ultracart.admin.v2.models/CheckoutHandoffRequest.js +1 -1
  181. package/src/com.ultracart.admin.v2.models/CheckoutHandoffResponse.js +1 -1
  182. package/src/com.ultracart.admin.v2.models/CheckoutSetupBrowserKeyRequest.js +1 -1
  183. package/src/com.ultracart.admin.v2.models/CheckoutSetupBrowserKeyResponse.js +1 -1
  184. package/src/com.ultracart.admin.v2.models/CheckoutStateProvinceResponse.js +1 -1
  185. package/src/com.ultracart.admin.v2.models/CityStateZip.js +1 -1
  186. package/src/com.ultracart.admin.v2.models/Conversation.js +1 -1
  187. package/src/com.ultracart.admin.v2.models/ConversationAgentAuth.js +1 -1
  188. package/src/com.ultracart.admin.v2.models/ConversationAgentAuthResponse.js +1 -1
  189. package/src/com.ultracart.admin.v2.models/ConversationAgentProfile.js +1 -1
  190. package/src/com.ultracart.admin.v2.models/ConversationAgentProfileResponse.js +1 -1
  191. package/src/com.ultracart.admin.v2.models/ConversationAutocompleteRequest.js +1 -1
  192. package/src/com.ultracart.admin.v2.models/ConversationAutocompleteResponse.js +1 -1
  193. package/src/com.ultracart.admin.v2.models/ConversationAutocompleteValue.js +1 -1
  194. package/src/com.ultracart.admin.v2.models/ConversationCannedMessage.js +1 -1
  195. package/src/com.ultracart.admin.v2.models/ConversationCannedMessageResponse.js +1 -1
  196. package/src/com.ultracart.admin.v2.models/ConversationCannedMessagesResponse.js +1 -1
  197. package/src/com.ultracart.admin.v2.models/ConversationCannedMessagesSearch.js +1 -1
  198. package/src/com.ultracart.admin.v2.models/ConversationDepartment.js +1 -1
  199. package/src/com.ultracart.admin.v2.models/ConversationDepartmentMember.js +1 -1
  200. package/src/com.ultracart.admin.v2.models/ConversationDepartmentMembersResponse.js +1 -1
  201. package/src/com.ultracart.admin.v2.models/ConversationDepartmentResponse.js +1 -1
  202. package/src/com.ultracart.admin.v2.models/ConversationDepartmentSettings.js +1 -1
  203. package/src/com.ultracart.admin.v2.models/ConversationDepartmentsResponse.js +1 -1
  204. package/src/com.ultracart.admin.v2.models/ConversationEngagement.js +1 -1
  205. package/src/com.ultracart.admin.v2.models/ConversationEngagementEquation.js +1 -1
  206. package/src/com.ultracart.admin.v2.models/ConversationEngagementEquationFunction.js +1 -1
  207. package/src/com.ultracart.admin.v2.models/ConversationEngagementEquationGroup.js +1 -1
  208. package/src/com.ultracart.admin.v2.models/ConversationEngagementResponse.js +1 -1
  209. package/src/com.ultracart.admin.v2.models/ConversationEngagementsResponse.js +1 -1
  210. package/src/com.ultracart.admin.v2.models/ConversationEventAddCoupon.js +1 -1
  211. package/src/com.ultracart.admin.v2.models/ConversationEventAddItem.js +1 -1
  212. package/src/com.ultracart.admin.v2.models/ConversationEventQueuePosition.js +1 -1
  213. package/src/com.ultracart.admin.v2.models/ConversationEventRRWeb.js +1 -1
  214. package/src/com.ultracart.admin.v2.models/ConversationEventReadMessage.js +1 -1
  215. package/src/com.ultracart.admin.v2.models/ConversationEventTyping.js +1 -1
  216. package/src/com.ultracart.admin.v2.models/ConversationEventWebchatContext.js +1 -1
  217. package/src/com.ultracart.admin.v2.models/ConversationJoinRequest.js +1 -1
  218. package/src/com.ultracart.admin.v2.models/ConversationLocationCountry.js +1 -1
  219. package/src/com.ultracart.admin.v2.models/ConversationLocationStateProvince.js +1 -1
  220. package/src/com.ultracart.admin.v2.models/ConversationLocationsResponse.js +1 -1
  221. package/src/com.ultracart.admin.v2.models/ConversationMessage.js +1 -1
  222. package/src/com.ultracart.admin.v2.models/ConversationMessageTranslation.js +1 -1
  223. package/src/com.ultracart.admin.v2.models/ConversationMessageTransportStatus.js +1 -1
  224. package/src/com.ultracart.admin.v2.models/ConversationMessagesResponse.js +1 -1
  225. package/src/com.ultracart.admin.v2.models/ConversationMultimediaUploadUrl.js +1 -1
  226. package/src/com.ultracart.admin.v2.models/ConversationMultimediaUploadUrlResponse.js +1 -1
  227. package/src/com.ultracart.admin.v2.models/ConversationParticipant.js +1 -1
  228. package/src/com.ultracart.admin.v2.models/ConversationPbxAgent.js +136 -0
  229. package/src/com.ultracart.admin.v2.models/ConversationPbxAgentResponse.js +100 -0
  230. package/src/com.ultracart.admin.v2.models/ConversationPbxAgentsResponse.js +100 -0
  231. package/src/com.ultracart.admin.v2.models/ConversationPbxAudio.js +136 -0
  232. package/src/com.ultracart.admin.v2.models/ConversationPbxAudioResponse.js +100 -0
  233. package/src/com.ultracart.admin.v2.models/ConversationPbxAudiosResponse.js +100 -0
  234. package/src/com.ultracart.admin.v2.models/ConversationPbxCustomerSnapshotRequest.js +121 -0
  235. package/src/com.ultracart.admin.v2.models/ConversationPbxCustomerSnapshotResponse.js +114 -0
  236. package/src/com.ultracart.admin.v2.models/ConversationPbxMenu.js +144 -0
  237. package/src/com.ultracart.admin.v2.models/ConversationPbxMenuMapping.js +96 -0
  238. package/src/com.ultracart.admin.v2.models/ConversationPbxMenuResponse.js +100 -0
  239. package/src/com.ultracart.admin.v2.models/ConversationPbxMenusResponse.js +100 -0
  240. package/src/com.ultracart.admin.v2.models/ConversationPbxPhoneNumber.js +104 -0
  241. package/src/com.ultracart.admin.v2.models/ConversationPbxPhoneNumberResponse.js +100 -0
  242. package/src/com.ultracart.admin.v2.models/ConversationPbxPhoneNumbersResponse.js +100 -0
  243. package/src/com.ultracart.admin.v2.models/ConversationPbxQueue.js +207 -0
  244. package/src/com.ultracart.admin.v2.models/ConversationPbxQueueMembers.js +78 -0
  245. package/src/com.ultracart.admin.v2.models/ConversationPbxQueueResponse.js +100 -0
  246. package/src/com.ultracart.admin.v2.models/ConversationPbxQueuesResponse.js +100 -0
  247. package/src/com.ultracart.admin.v2.models/ConversationPbxTimeBased.js +92 -0
  248. package/src/com.ultracart.admin.v2.models/ConversationPbxTimeBasedMapping.js +96 -0
  249. package/src/com.ultracart.admin.v2.models/ConversationPbxTimeBasedMappingConfig.js +79 -0
  250. package/src/com.ultracart.admin.v2.models/ConversationPbxTimeBasedResponse.js +100 -0
  251. package/src/com.ultracart.admin.v2.models/ConversationPbxTimeBasedsResponse.js +100 -0
  252. package/src/com.ultracart.admin.v2.models/ConversationPbxTimeRange.js +104 -0
  253. package/src/com.ultracart.admin.v2.models/ConversationPbxTimeRangeConfig.js +112 -0
  254. package/src/com.ultracart.admin.v2.models/ConversationPbxTimeRangeResponse.js +100 -0
  255. package/src/com.ultracart.admin.v2.models/ConversationPbxTimeRangesResponse.js +100 -0
  256. package/src/com.ultracart.admin.v2.models/ConversationPbxVoicemailMailbox.js +152 -0
  257. package/src/com.ultracart.admin.v2.models/ConversationPbxVoicemailMailboxResponse.js +100 -0
  258. package/src/com.ultracart.admin.v2.models/ConversationPbxVoicemailMailboxesResponse.js +100 -0
  259. package/src/com.ultracart.admin.v2.models/ConversationPermissions.js +1 -1
  260. package/src/com.ultracart.admin.v2.models/ConversationPermissionsResponse.js +1 -1
  261. package/src/com.ultracart.admin.v2.models/ConversationResponse.js +1 -1
  262. package/src/com.ultracart.admin.v2.models/ConversationSearchRequest.js +1 -1
  263. package/src/com.ultracart.admin.v2.models/ConversationSearchResponse.js +1 -1
  264. package/src/com.ultracart.admin.v2.models/ConversationSentiment.js +1 -1
  265. package/src/com.ultracart.admin.v2.models/ConversationStartRequest.js +1 -1
  266. package/src/com.ultracart.admin.v2.models/ConversationStartResponse.js +1 -1
  267. package/src/com.ultracart.admin.v2.models/ConversationSummary.js +1 -1
  268. package/src/com.ultracart.admin.v2.models/ConversationTwilioAccount.js +1 -1
  269. package/src/com.ultracart.admin.v2.models/ConversationWebchatContext.js +1 -1
  270. package/src/com.ultracart.admin.v2.models/ConversationWebchatQueueStatus.js +1 -1
  271. package/src/com.ultracart.admin.v2.models/ConversationWebchatQueueStatusAgent.js +1 -1
  272. package/src/com.ultracart.admin.v2.models/ConversationWebchatQueueStatusQueueEntry.js +1 -1
  273. package/src/com.ultracart.admin.v2.models/ConversationWebchatQueueStatusUpdateRequest.js +1 -1
  274. package/src/com.ultracart.admin.v2.models/ConversationWebchatQueueStatusesResponse.js +1 -1
  275. package/src/com.ultracart.admin.v2.models/ConversationWebsocketMessage.js +1 -1
  276. package/src/com.ultracart.admin.v2.models/ConversationsResponse.js +1 -1
  277. package/src/com.ultracart.admin.v2.models/CountriesResponse.js +1 -1
  278. package/src/com.ultracart.admin.v2.models/Country.js +1 -1
  279. package/src/com.ultracart.admin.v2.models/Coupon.js +1 -1
  280. package/src/com.ultracart.admin.v2.models/CouponAmountOffItems.js +1 -1
  281. package/src/com.ultracart.admin.v2.models/CouponAmountOffShipping.js +1 -1
  282. package/src/com.ultracart.admin.v2.models/CouponAmountOffShippingWithItemsPurchase.js +1 -1
  283. package/src/com.ultracart.admin.v2.models/CouponAmountOffSubtotal.js +1 -1
  284. package/src/com.ultracart.admin.v2.models/CouponAmountOffSubtotalAndShipping.js +1 -1
  285. package/src/com.ultracart.admin.v2.models/CouponAmountOffSubtotalFreeShippingWithPurchase.js +1 -1
  286. package/src/com.ultracart.admin.v2.models/CouponAmountOffSubtotalWithBlockPurchase.js +1 -1
  287. package/src/com.ultracart.admin.v2.models/CouponAmountOffSubtotalWithItemsPurchase.js +1 -1
  288. package/src/com.ultracart.admin.v2.models/CouponAmountOffSubtotalWithPurchase.js +1 -1
  289. package/src/com.ultracart.admin.v2.models/CouponAmountShippingWithSubtotal.js +1 -1
  290. package/src/com.ultracart.admin.v2.models/CouponAutoApplyCondition.js +1 -1
  291. package/src/com.ultracart.admin.v2.models/CouponAutoApplyConditions.js +1 -1
  292. package/src/com.ultracart.admin.v2.models/CouponAutomaticallyApplyCouponCodes.js +1 -1
  293. package/src/com.ultracart.admin.v2.models/CouponBuyOneGetOneLimit.js +1 -1
  294. package/src/com.ultracart.admin.v2.models/CouponCodesRequest.js +1 -1
  295. package/src/com.ultracart.admin.v2.models/CouponCodesResponse.js +1 -1
  296. package/src/com.ultracart.admin.v2.models/CouponDeletesRequest.js +1 -1
  297. package/src/com.ultracart.admin.v2.models/CouponDiscountItemWithItemPurchase.js +1 -1
  298. package/src/com.ultracart.admin.v2.models/CouponDiscountItems.js +1 -1
  299. package/src/com.ultracart.admin.v2.models/CouponEditorValues.js +1 -1
  300. package/src/com.ultracart.admin.v2.models/CouponExistsResponse.js +1 -1
  301. package/src/com.ultracart.admin.v2.models/CouponFreeItemAndShippingWithSubtotal.js +1 -1
  302. package/src/com.ultracart.admin.v2.models/CouponFreeItemWithItemPurchase.js +1 -1
  303. package/src/com.ultracart.admin.v2.models/CouponFreeItemWithItemPurchaseAndFreeShipping.js +1 -1
  304. package/src/com.ultracart.admin.v2.models/CouponFreeItemWithSubtotal.js +1 -1
  305. package/src/com.ultracart.admin.v2.models/CouponFreeItemsWithItemPurchase.js +1 -1
  306. package/src/com.ultracart.admin.v2.models/CouponFreeItemsWithMixMatchPurchase.js +1 -1
  307. package/src/com.ultracart.admin.v2.models/CouponFreeShipping.js +1 -1
  308. package/src/com.ultracart.admin.v2.models/CouponFreeShippingSpecificItems.js +1 -1
  309. package/src/com.ultracart.admin.v2.models/CouponFreeShippingWithItemsPurchase.js +1 -1
  310. package/src/com.ultracart.admin.v2.models/CouponFreeShippingWithSubtotal.js +1 -1
  311. package/src/com.ultracart.admin.v2.models/CouponItemSearchResult.js +1 -1
  312. package/src/com.ultracart.admin.v2.models/CouponItemSearchResultsResponse.js +1 -1
  313. package/src/com.ultracart.admin.v2.models/CouponMoreLoyaltyCashback.js +1 -1
  314. package/src/com.ultracart.admin.v2.models/CouponMoreLoyaltyPoints.js +1 -1
  315. package/src/com.ultracart.admin.v2.models/CouponMultipleAmountsOffItems.js +1 -1
  316. package/src/com.ultracart.admin.v2.models/CouponNoDiscount.js +1 -1
  317. package/src/com.ultracart.admin.v2.models/CouponPercentMoreLoyaltyCashback.js +1 -1
  318. package/src/com.ultracart.admin.v2.models/CouponPercentMoreLoyaltyPoints.js +1 -1
  319. package/src/com.ultracart.admin.v2.models/CouponPercentOffItemWithItemsQuantityPurchase.js +1 -1
  320. package/src/com.ultracart.admin.v2.models/CouponPercentOffItems.js +1 -1
  321. package/src/com.ultracart.admin.v2.models/CouponPercentOffItemsAndFreeShipping.js +1 -1
  322. package/src/com.ultracart.admin.v2.models/CouponPercentOffItemsWithItemsPurchase.js +1 -1
  323. package/src/com.ultracart.admin.v2.models/CouponPercentOffMsrpItems.js +1 -1
  324. package/src/com.ultracart.admin.v2.models/CouponPercentOffRetailPriceItems.js +1 -1
  325. package/src/com.ultracart.admin.v2.models/CouponPercentOffShipping.js +1 -1
  326. package/src/com.ultracart.admin.v2.models/CouponPercentOffSubtotal.js +1 -1
  327. package/src/com.ultracart.admin.v2.models/CouponPercentOffSubtotalAndFreeShipping.js +1 -1
  328. package/src/com.ultracart.admin.v2.models/CouponPercentOffSubtotalLimit.js +1 -1
  329. package/src/com.ultracart.admin.v2.models/CouponPercentOffSubtotalWithItemsPurchase.js +1 -1
  330. package/src/com.ultracart.admin.v2.models/CouponPercentOffSubtotalWithSubtotal.js +1 -1
  331. package/src/com.ultracart.admin.v2.models/CouponQuery.js +1 -1
  332. package/src/com.ultracart.admin.v2.models/CouponResponse.js +1 -1
  333. package/src/com.ultracart.admin.v2.models/CouponRestriction.js +1 -1
  334. package/src/com.ultracart.admin.v2.models/CouponTierAmount.js +1 -1
  335. package/src/com.ultracart.admin.v2.models/CouponTierItemDiscount.js +1 -1
  336. package/src/com.ultracart.admin.v2.models/CouponTierPercent.js +1 -1
  337. package/src/com.ultracart.admin.v2.models/CouponTierQuantityAmount.js +1 -1
  338. package/src/com.ultracart.admin.v2.models/CouponTierQuantityPercent.js +1 -1
  339. package/src/com.ultracart.admin.v2.models/CouponTieredAmountOffItems.js +1 -1
  340. package/src/com.ultracart.admin.v2.models/CouponTieredAmountOffSubtotal.js +1 -1
  341. package/src/com.ultracart.admin.v2.models/CouponTieredPercentOffItems.js +1 -1
  342. package/src/com.ultracart.admin.v2.models/CouponTieredPercentOffShipping.js +1 -1
  343. package/src/com.ultracart.admin.v2.models/CouponTieredPercentOffSubtotal.js +1 -1
  344. package/src/com.ultracart.admin.v2.models/CouponTieredPercentOffSubtotalBasedOnMSRP.js +1 -1
  345. package/src/com.ultracart.admin.v2.models/CouponType.js +1 -1
  346. package/src/com.ultracart.admin.v2.models/CouponsRequest.js +1 -1
  347. package/src/com.ultracart.admin.v2.models/CouponsResponse.js +1 -1
  348. package/src/com.ultracart.admin.v2.models/Currency.js +1 -1
  349. package/src/com.ultracart.admin.v2.models/Customer.js +1 -1
  350. package/src/com.ultracart.admin.v2.models/CustomerActivity.js +1 -1
  351. package/src/com.ultracart.admin.v2.models/CustomerAffiliate.js +1 -1
  352. package/src/com.ultracart.admin.v2.models/CustomerAttachment.js +1 -1
  353. package/src/com.ultracart.admin.v2.models/CustomerBilling.js +1 -1
  354. package/src/com.ultracart.admin.v2.models/CustomerCard.js +1 -1
  355. package/src/com.ultracart.admin.v2.models/CustomerEDI.js +1 -1
  356. package/src/com.ultracart.admin.v2.models/CustomerEditorValues.js +1 -1
  357. package/src/com.ultracart.admin.v2.models/CustomerEmail.js +1 -1
  358. package/src/com.ultracart.admin.v2.models/CustomerEmailListChanges.js +1 -1
  359. package/src/com.ultracart.admin.v2.models/CustomerLoyalty.js +1 -1
  360. package/src/com.ultracart.admin.v2.models/CustomerLoyaltyLedger.js +1 -1
  361. package/src/com.ultracart.admin.v2.models/CustomerLoyaltyRedemption.js +1 -1
  362. package/src/com.ultracart.admin.v2.models/CustomerMagicLinkResponse.js +1 -1
  363. package/src/com.ultracart.admin.v2.models/CustomerMergeRequest.js +1 -1
  364. package/src/com.ultracart.admin.v2.models/CustomerOrdersSummary.js +1 -1
  365. package/src/com.ultracart.admin.v2.models/CustomerPricingTier.js +1 -1
  366. package/src/com.ultracart.admin.v2.models/CustomerPrivacy.js +1 -1
  367. package/src/com.ultracart.admin.v2.models/CustomerProperty.js +1 -1
  368. package/src/com.ultracart.admin.v2.models/CustomerQuery.js +1 -1
  369. package/src/com.ultracart.admin.v2.models/CustomerQuotesSummary.js +1 -1
  370. package/src/com.ultracart.admin.v2.models/CustomerResponse.js +1 -1
  371. package/src/com.ultracart.admin.v2.models/CustomerReviewer.js +1 -1
  372. package/src/com.ultracart.admin.v2.models/CustomerShipping.js +1 -1
  373. package/src/com.ultracart.admin.v2.models/CustomerSoftwareEntitlement.js +1 -1
  374. package/src/com.ultracart.admin.v2.models/CustomerStoreCredit.js +1 -1
  375. package/src/com.ultracart.admin.v2.models/CustomerStoreCreditAddRequest.js +1 -1
  376. package/src/com.ultracart.admin.v2.models/CustomerStoreCreditLedgerEntry.js +1 -1
  377. package/src/com.ultracart.admin.v2.models/CustomerStoreCreditResponse.js +1 -1
  378. package/src/com.ultracart.admin.v2.models/CustomerTag.js +1 -1
  379. package/src/com.ultracart.admin.v2.models/CustomerTaxCodes.js +1 -1
  380. package/src/com.ultracart.admin.v2.models/CustomerWishListItem.js +1 -1
  381. package/src/com.ultracart.admin.v2.models/CustomerWishListItemResponse.js +1 -1
  382. package/src/com.ultracart.admin.v2.models/CustomerWishListItemsResponse.js +1 -1
  383. package/src/com.ultracart.admin.v2.models/CustomersResponse.js +1 -1
  384. package/src/com.ultracart.admin.v2.models/DataTablesServerSideResponse.js +1 -1
  385. package/src/com.ultracart.admin.v2.models/Distance.js +1 -1
  386. package/src/com.ultracart.admin.v2.models/DistributionCenter.js +1 -1
  387. package/src/com.ultracart.admin.v2.models/DistributionCentersResponse.js +1 -1
  388. package/src/com.ultracart.admin.v2.models/EmailBaseTemplateListResponse.js +1 -1
  389. package/src/com.ultracart.admin.v2.models/EmailCampaign.js +1 -1
  390. package/src/com.ultracart.admin.v2.models/EmailCampaignFolder.js +1 -1
  391. package/src/com.ultracart.admin.v2.models/EmailCampaignFolderResponse.js +1 -1
  392. package/src/com.ultracart.admin.v2.models/EmailCampaignFoldersResponse.js +1 -1
  393. package/src/com.ultracart.admin.v2.models/EmailCampaignResponse.js +1 -1
  394. package/src/com.ultracart.admin.v2.models/EmailCampaignsResponse.js +1 -1
  395. package/src/com.ultracart.admin.v2.models/EmailClick.js +1 -1
  396. package/src/com.ultracart.admin.v2.models/EmailClicksResponse.js +1 -1
  397. package/src/com.ultracart.admin.v2.models/EmailCommseq.js +1 -1
  398. package/src/com.ultracart.admin.v2.models/EmailCommseqEmail.js +1 -1
  399. package/src/com.ultracart.admin.v2.models/EmailCommseqEmailResponse.js +1 -1
  400. package/src/com.ultracart.admin.v2.models/EmailCommseqEmailSendTestRequest.js +1 -1
  401. package/src/com.ultracart.admin.v2.models/EmailCommseqEmailSendTestResponse.js +1 -1
  402. package/src/com.ultracart.admin.v2.models/EmailCommseqEmailsRequest.js +1 -1
  403. package/src/com.ultracart.admin.v2.models/EmailCommseqEmailsResponse.js +1 -1
  404. package/src/com.ultracart.admin.v2.models/EmailCommseqPostcard.js +1 -1
  405. package/src/com.ultracart.admin.v2.models/EmailCommseqPostcardResponse.js +1 -1
  406. package/src/com.ultracart.admin.v2.models/EmailCommseqPostcardSendTestRequest.js +1 -1
  407. package/src/com.ultracart.admin.v2.models/EmailCommseqPostcardSendTestResponse.js +1 -1
  408. package/src/com.ultracart.admin.v2.models/EmailCommseqPostcardsRequest.js +1 -1
  409. package/src/com.ultracart.admin.v2.models/EmailCommseqPostcardsResponse.js +1 -1
  410. package/src/com.ultracart.admin.v2.models/EmailCommseqResponse.js +1 -1
  411. package/src/com.ultracart.admin.v2.models/EmailCommseqSequenceTestRequest.js +1 -1
  412. package/src/com.ultracart.admin.v2.models/EmailCommseqSequenceTestResponse.js +1 -1
  413. package/src/com.ultracart.admin.v2.models/EmailCommseqSmsSendTestRequest.js +1 -1
  414. package/src/com.ultracart.admin.v2.models/EmailCommseqSmsSendTestResponse.js +1 -1
  415. package/src/com.ultracart.admin.v2.models/EmailCommseqStat.js +1 -1
  416. package/src/com.ultracart.admin.v2.models/EmailCommseqStatResponse.js +1 -1
  417. package/src/com.ultracart.admin.v2.models/EmailCommseqStep.js +1 -1
  418. package/src/com.ultracart.admin.v2.models/EmailCommseqStepLog.js +1 -1
  419. package/src/com.ultracart.admin.v2.models/EmailCommseqStepLogsResponse.js +1 -1
  420. package/src/com.ultracart.admin.v2.models/EmailCommseqWebhookSendTestRequest.js +1 -1
  421. package/src/com.ultracart.admin.v2.models/EmailCommseqWebhookSendTestResponse.js +1 -1
  422. package/src/com.ultracart.admin.v2.models/EmailCommseqsResponse.js +1 -1
  423. package/src/com.ultracart.admin.v2.models/EmailCustomer.js +1 -1
  424. package/src/com.ultracart.admin.v2.models/EmailCustomerEditorUrlResponse.js +1 -1
  425. package/src/com.ultracart.admin.v2.models/EmailCustomersResponse.js +1 -1
  426. package/src/com.ultracart.admin.v2.models/EmailDashboardActivity.js +1 -1
  427. package/src/com.ultracart.admin.v2.models/EmailDashboardActivityResponse.js +1 -1
  428. package/src/com.ultracart.admin.v2.models/EmailDashboardStatsResponse.js +1 -1
  429. package/src/com.ultracart.admin.v2.models/EmailDomain.js +1 -1
  430. package/src/com.ultracart.admin.v2.models/EmailEditorTokenResponse.js +1 -1
  431. package/src/com.ultracart.admin.v2.models/EmailFlow.js +1 -1
  432. package/src/com.ultracart.admin.v2.models/EmailFlowBackPopulateRequest.js +1 -1
  433. package/src/com.ultracart.admin.v2.models/EmailFlowBackPopulateResponse.js +1 -1
  434. package/src/com.ultracart.admin.v2.models/EmailFlowFolder.js +1 -1
  435. package/src/com.ultracart.admin.v2.models/EmailFlowFolderResponse.js +1 -1
  436. package/src/com.ultracart.admin.v2.models/EmailFlowFoldersResponse.js +1 -1
  437. package/src/com.ultracart.admin.v2.models/EmailFlowResponse.js +1 -1
  438. package/src/com.ultracart.admin.v2.models/EmailFlowsResponse.js +1 -1
  439. package/src/com.ultracart.admin.v2.models/EmailGlobalSettings.js +1 -1
  440. package/src/com.ultracart.admin.v2.models/EmailGlobalSettingsResponse.js +1 -1
  441. package/src/com.ultracart.admin.v2.models/EmailGlobalUnsubscribeRequest.js +1 -1
  442. package/src/com.ultracart.admin.v2.models/EmailGlobalUnsubscribeResponse.js +1 -1
  443. package/src/com.ultracart.admin.v2.models/EmailHistogramPropertyNamesResponse.js +1 -1
  444. package/src/com.ultracart.admin.v2.models/EmailHistogramPropertyValuesResponse.js +1 -1
  445. package/src/com.ultracart.admin.v2.models/EmailList.js +1 -1
  446. package/src/com.ultracart.admin.v2.models/EmailListArchiveResponse.js +1 -1
  447. package/src/com.ultracart.admin.v2.models/EmailListCustomer.js +1 -1
  448. package/src/com.ultracart.admin.v2.models/EmailListCustomersResponse.js +1 -1
  449. package/src/com.ultracart.admin.v2.models/EmailListResponse.js +1 -1
  450. package/src/com.ultracart.admin.v2.models/EmailListSegmentFolder.js +1 -1
  451. package/src/com.ultracart.admin.v2.models/EmailListSegmentFolderResponse.js +1 -1
  452. package/src/com.ultracart.admin.v2.models/EmailListSegmentFoldersResponse.js +1 -1
  453. package/src/com.ultracart.admin.v2.models/EmailListSegmentMembership.js +1 -1
  454. package/src/com.ultracart.admin.v2.models/EmailListSegmentUsedBy.js +1 -1
  455. package/src/com.ultracart.admin.v2.models/EmailListSubscribeResponse.js +1 -1
  456. package/src/com.ultracart.admin.v2.models/EmailListsResponse.js +1 -1
  457. package/src/com.ultracart.admin.v2.models/EmailOrder.js +1 -1
  458. package/src/com.ultracart.admin.v2.models/EmailOrdersResponse.js +1 -1
  459. package/src/com.ultracart.admin.v2.models/EmailPerformance.js +1 -1
  460. package/src/com.ultracart.admin.v2.models/EmailPerformanceCustomerHistogram.js +1 -1
  461. package/src/com.ultracart.admin.v2.models/EmailPerformanceCustomerHistogramPeriod.js +1 -1
  462. package/src/com.ultracart.admin.v2.models/EmailPerformanceDaily.js +1 -1
  463. package/src/com.ultracart.admin.v2.models/EmailPerformanceResponse.js +1 -1
  464. package/src/com.ultracart.admin.v2.models/EmailPlan.js +1 -1
  465. package/src/com.ultracart.admin.v2.models/EmailPlanAdditional.js +1 -1
  466. package/src/com.ultracart.admin.v2.models/EmailPlanResponse.js +1 -1
  467. package/src/com.ultracart.admin.v2.models/EmailPostcardStat.js +1 -1
  468. package/src/com.ultracart.admin.v2.models/EmailPostcardTracking.js +1 -1
  469. package/src/com.ultracart.admin.v2.models/EmailPostcardTrackingResponse.js +1 -1
  470. package/src/com.ultracart.admin.v2.models/EmailSegment.js +1 -1
  471. package/src/com.ultracart.admin.v2.models/EmailSegmentArchiveResponse.js +1 -1
  472. package/src/com.ultracart.admin.v2.models/EmailSegmentCustomer.js +1 -1
  473. package/src/com.ultracart.admin.v2.models/EmailSegmentCustomersResponse.js +1 -1
  474. package/src/com.ultracart.admin.v2.models/EmailSegmentDownloadPrepareResponse.js +1 -1
  475. package/src/com.ultracart.admin.v2.models/EmailSegmentResponse.js +1 -1
  476. package/src/com.ultracart.admin.v2.models/EmailSegmentsResponse.js +1 -1
  477. package/src/com.ultracart.admin.v2.models/EmailSendingDomainResponse.js +1 -1
  478. package/src/com.ultracart.admin.v2.models/EmailSendingDomainsResponse.js +1 -1
  479. package/src/com.ultracart.admin.v2.models/EmailSettings.js +1 -1
  480. package/src/com.ultracart.admin.v2.models/EmailSettingsResponse.js +1 -1
  481. package/src/com.ultracart.admin.v2.models/EmailSmsOrder.js +1 -1
  482. package/src/com.ultracart.admin.v2.models/EmailSmsOrdersResponse.js +1 -1
  483. package/src/com.ultracart.admin.v2.models/EmailSmsStat.js +1 -1
  484. package/src/com.ultracart.admin.v2.models/EmailStat.js +1 -1
  485. package/src/com.ultracart.admin.v2.models/EmailStatPostcardSummaryRequest.js +1 -1
  486. package/src/com.ultracart.admin.v2.models/EmailStatPostcardSummaryResponse.js +1 -1
  487. package/src/com.ultracart.admin.v2.models/EmailStatSmsSummaryRequest.js +1 -1
  488. package/src/com.ultracart.admin.v2.models/EmailStatSmsSummaryResponse.js +1 -1
  489. package/src/com.ultracart.admin.v2.models/EmailStatSummaryRequest.js +1 -1
  490. package/src/com.ultracart.admin.v2.models/EmailStatSummaryResponse.js +1 -1
  491. package/src/com.ultracart.admin.v2.models/EmailStepStat.js +1 -1
  492. package/src/com.ultracart.admin.v2.models/EmailStepStatRequest.js +1 -1
  493. package/src/com.ultracart.admin.v2.models/EmailStepStatResponse.js +1 -1
  494. package/src/com.ultracart.admin.v2.models/EmailStepWaitingRequest.js +1 -1
  495. package/src/com.ultracart.admin.v2.models/EmailStepWaitingResponse.js +1 -1
  496. package/src/com.ultracart.admin.v2.models/EmailTemplate.js +1 -1
  497. package/src/com.ultracart.admin.v2.models/EmailTemplatesResponse.js +1 -1
  498. package/src/com.ultracart.admin.v2.models/EmailThirdPartyList.js +1 -1
  499. package/src/com.ultracart.admin.v2.models/EmailThirdPartyListImportRequest.js +1 -1
  500. package/src/com.ultracart.admin.v2.models/EmailThirdPartyProvider.js +1 -1
  501. package/src/com.ultracart.admin.v2.models/EmailThirdPartyProvidersResponse.js +1 -1
  502. package/src/com.ultracart.admin.v2.models/EmailThirdPartyTag.js +1 -1
  503. package/src/com.ultracart.admin.v2.models/EmailVerifyTokenRequest.js +1 -1
  504. package/src/com.ultracart.admin.v2.models/EmailVerifyTokenResponse.js +1 -1
  505. package/src/com.ultracart.admin.v2.models/EmailVerifyTokenValidateRequest.js +1 -1
  506. package/src/com.ultracart.admin.v2.models/EmailVerifyTokenValidateResponse.js +1 -1
  507. package/src/com.ultracart.admin.v2.models/EmailWebhookEditorValuesResponse.js +1 -1
  508. package/src/com.ultracart.admin.v2.models/Error.js +1 -1
  509. package/src/com.ultracart.admin.v2.models/ErrorResponse.js +1 -1
  510. package/src/com.ultracart.admin.v2.models/Experiment.js +1 -1
  511. package/src/com.ultracart.admin.v2.models/ExperimentResponse.js +1 -1
  512. package/src/com.ultracart.admin.v2.models/ExperimentVariation.js +1 -1
  513. package/src/com.ultracart.admin.v2.models/ExperimentVariationStat.js +1 -1
  514. package/src/com.ultracart.admin.v2.models/ExperimentsResponse.js +1 -1
  515. package/src/com.ultracart.admin.v2.models/FileManagerDirectory.js +1 -1
  516. package/src/com.ultracart.admin.v2.models/FileManagerFile.js +1 -1
  517. package/src/com.ultracart.admin.v2.models/FileManagerPage.js +1 -1
  518. package/src/com.ultracart.admin.v2.models/FileManagerPageResponse.js +1 -1
  519. package/src/com.ultracart.admin.v2.models/FileManagerUploadRequest.js +1 -1
  520. package/src/com.ultracart.admin.v2.models/FileManagerUploadUrlResponse.js +1 -1
  521. package/src/com.ultracart.admin.v2.models/FulfillmentInventory.js +1 -1
  522. package/src/com.ultracart.admin.v2.models/FulfillmentShipment.js +1 -1
  523. package/src/com.ultracart.admin.v2.models/GeoPoint.js +1 -1
  524. package/src/com.ultracart.admin.v2.models/GeocodeRequest.js +1 -1
  525. package/src/com.ultracart.admin.v2.models/GeocodeResponse.js +1 -1
  526. package/src/com.ultracart.admin.v2.models/GiftCertificate.js +1 -1
  527. package/src/com.ultracart.admin.v2.models/GiftCertificateCreateRequest.js +1 -1
  528. package/src/com.ultracart.admin.v2.models/GiftCertificateLedgerEntry.js +1 -1
  529. package/src/com.ultracart.admin.v2.models/GiftCertificateQuery.js +1 -1
  530. package/src/com.ultracart.admin.v2.models/GiftCertificateResponse.js +1 -1
  531. package/src/com.ultracart.admin.v2.models/GiftCertificatesResponse.js +1 -1
  532. package/src/com.ultracart.admin.v2.models/Group.js +1 -1
  533. package/src/com.ultracart.admin.v2.models/GroupResponse.js +1 -1
  534. package/src/com.ultracart.admin.v2.models/GroupUserMembership.js +1 -1
  535. package/src/com.ultracart.admin.v2.models/GroupsResponse.js +1 -1
  536. package/src/com.ultracart.admin.v2.models/HTTPHeader.js +1 -1
  537. package/src/com.ultracart.admin.v2.models/HitPageView.js +1 -1
  538. package/src/com.ultracart.admin.v2.models/HitPageViewMetaData.js +1 -1
  539. package/src/com.ultracart.admin.v2.models/HitSessionStart.js +1 -1
  540. package/src/com.ultracart.admin.v2.models/HitSessionUtm.js +1 -1
  541. package/src/com.ultracart.admin.v2.models/IntegrationLog.js +1 -1
  542. package/src/com.ultracart.admin.v2.models/IntegrationLogFile.js +1 -1
  543. package/src/com.ultracart.admin.v2.models/IntegrationLogLog.js +1 -1
  544. package/src/com.ultracart.admin.v2.models/IntegrationLogQueryFilterValues.js +1 -1
  545. package/src/com.ultracart.admin.v2.models/IntegrationLogQueryRequest.js +1 -1
  546. package/src/com.ultracart.admin.v2.models/IntegrationLogQueryResponse.js +1 -1
  547. package/src/com.ultracart.admin.v2.models/IntegrationLogResponse.js +1 -1
  548. package/src/com.ultracart.admin.v2.models/IntegrationLogSummary.js +1 -1
  549. package/src/com.ultracart.admin.v2.models/IntegrationLogSummaryQueryRequest.js +1 -1
  550. package/src/com.ultracart.admin.v2.models/IntegrationLogSummaryQueryResponse.js +1 -1
  551. package/src/com.ultracart.admin.v2.models/Item.js +1 -1
  552. package/src/com.ultracart.admin.v2.models/ItemAccounting.js +1 -1
  553. package/src/com.ultracart.admin.v2.models/ItemAmember.js +1 -1
  554. package/src/com.ultracart.admin.v2.models/ItemAutoOrder.js +1 -1
  555. package/src/com.ultracart.admin.v2.models/ItemAutoOrderStep.js +1 -1
  556. package/src/com.ultracart.admin.v2.models/ItemAutoOrderStepArbitraryUnitCostSchedule.js +1 -1
  557. package/src/com.ultracart.admin.v2.models/ItemAutoOrderStepGrandfatherPricing.js +1 -1
  558. package/src/com.ultracart.admin.v2.models/ItemCCBill.js +1 -1
  559. package/src/com.ultracart.admin.v2.models/ItemChannelPartnerMapping.js +1 -1
  560. package/src/com.ultracart.admin.v2.models/ItemChargeback.js +1 -1
  561. package/src/com.ultracart.admin.v2.models/ItemChargebackAddendum.js +1 -1
  562. package/src/com.ultracart.admin.v2.models/ItemChargebackAdjustmentRequest.js +1 -1
  563. package/src/com.ultracart.admin.v2.models/ItemCheckout.js +1 -1
  564. package/src/com.ultracart.admin.v2.models/ItemContent.js +1 -1
  565. package/src/com.ultracart.admin.v2.models/ItemContentAssignment.js +1 -1
  566. package/src/com.ultracart.admin.v2.models/ItemContentAttribute.js +1 -1
  567. package/src/com.ultracart.admin.v2.models/ItemContentMultimedia.js +1 -1
  568. package/src/com.ultracart.admin.v2.models/ItemContentMultimediaThumbnail.js +1 -1
  569. package/src/com.ultracart.admin.v2.models/ItemDigitalDelivery.js +1 -1
  570. package/src/com.ultracart.admin.v2.models/ItemDigitalItem.js +1 -1
  571. package/src/com.ultracart.admin.v2.models/ItemDigitalItemPdfMeta.js +1 -1
  572. package/src/com.ultracart.admin.v2.models/ItemDigitalItemResponse.js +1 -1
  573. package/src/com.ultracart.admin.v2.models/ItemDigitalItemsResponse.js +1 -1
  574. package/src/com.ultracart.admin.v2.models/ItemEbay.js +1 -1
  575. package/src/com.ultracart.admin.v2.models/ItemEbayCategorySpecific.js +1 -1
  576. package/src/com.ultracart.admin.v2.models/ItemEbayMarketListing.js +1 -1
  577. package/src/com.ultracart.admin.v2.models/ItemEbayMarketPlaceAnalysis.js +1 -1
  578. package/src/com.ultracart.admin.v2.models/ItemEmailNotifications.js +1 -1
  579. package/src/com.ultracart.admin.v2.models/ItemEnrollment123.js +1 -1
  580. package/src/com.ultracart.admin.v2.models/ItemFulfillmentAddon.js +1 -1
  581. package/src/com.ultracart.admin.v2.models/ItemGiftCertificate.js +1 -1
  582. package/src/com.ultracart.admin.v2.models/ItemGoogleProductSearch.js +1 -1
  583. package/src/com.ultracart.admin.v2.models/ItemIdentifiers.js +1 -1
  584. package/src/com.ultracart.admin.v2.models/ItemInstantPaymentNotification.js +1 -1
  585. package/src/com.ultracart.admin.v2.models/ItemInstantPaymentNotifications.js +1 -1
  586. package/src/com.ultracart.admin.v2.models/ItemInternal.js +1 -1
  587. package/src/com.ultracart.admin.v2.models/ItemKitComponent.js +1 -1
  588. package/src/com.ultracart.admin.v2.models/ItemKitDefinition.js +1 -1
  589. package/src/com.ultracart.admin.v2.models/ItemOption.js +1 -1
  590. package/src/com.ultracart.admin.v2.models/ItemOptionValue.js +1 -1
  591. package/src/com.ultracart.admin.v2.models/ItemOptionValueAdditionalItem.js +1 -1
  592. package/src/com.ultracart.admin.v2.models/ItemOptionValueDigitalItem.js +1 -1
  593. package/src/com.ultracart.admin.v2.models/ItemPaymentProcessing.js +1 -1
  594. package/src/com.ultracart.admin.v2.models/ItemPhysical.js +1 -1
  595. package/src/com.ultracart.admin.v2.models/ItemPricing.js +1 -1
  596. package/src/com.ultracart.admin.v2.models/ItemPricingTier.js +1 -1
  597. package/src/com.ultracart.admin.v2.models/ItemPricingTierDiscount.js +1 -1
  598. package/src/com.ultracart.admin.v2.models/ItemPricingTierLimit.js +1 -1
  599. package/src/com.ultracart.admin.v2.models/ItemProperty.js +1 -1
  600. package/src/com.ultracart.admin.v2.models/ItemRealtimePricing.js +1 -1
  601. package/src/com.ultracart.admin.v2.models/ItemRelated.js +1 -1
  602. package/src/com.ultracart.admin.v2.models/ItemRelatedItem.js +1 -1
  603. package/src/com.ultracart.admin.v2.models/ItemReporting.js +1 -1
  604. package/src/com.ultracart.admin.v2.models/ItemResponse.js +1 -1
  605. package/src/com.ultracart.admin.v2.models/ItemRestriction.js +1 -1
  606. package/src/com.ultracart.admin.v2.models/ItemRestrictionItem.js +1 -1
  607. package/src/com.ultracart.admin.v2.models/ItemRevguard.js +1 -1
  608. package/src/com.ultracart.admin.v2.models/ItemReview.js +1 -1
  609. package/src/com.ultracart.admin.v2.models/ItemReviewResponse.js +1 -1
  610. package/src/com.ultracart.admin.v2.models/ItemReviews.js +1 -1
  611. package/src/com.ultracart.admin.v2.models/ItemReviewsResponse.js +1 -1
  612. package/src/com.ultracart.admin.v2.models/ItemSalesforce.js +1 -1
  613. package/src/com.ultracart.admin.v2.models/ItemShipping.js +1 -1
  614. package/src/com.ultracart.admin.v2.models/ItemShippingCase.js +1 -1
  615. package/src/com.ultracart.admin.v2.models/ItemShippingDestinationMarkup.js +1 -1
  616. package/src/com.ultracart.admin.v2.models/ItemShippingDestinationRestriction.js +1 -1
  617. package/src/com.ultracart.admin.v2.models/ItemShippingDistributionCenter.js +1 -1
  618. package/src/com.ultracart.admin.v2.models/ItemShippingMethod.js +1 -1
  619. package/src/com.ultracart.admin.v2.models/ItemShippingPackageRequirement.js +1 -1
  620. package/src/com.ultracart.admin.v2.models/ItemTag.js +1 -1
  621. package/src/com.ultracart.admin.v2.models/ItemTags.js +1 -1
  622. package/src/com.ultracart.admin.v2.models/ItemTax.js +1 -1
  623. package/src/com.ultracart.admin.v2.models/ItemTaxExemption.js +1 -1
  624. package/src/com.ultracart.admin.v2.models/ItemThirdPartyEmailMarketing.js +1 -1
  625. package/src/com.ultracart.admin.v2.models/ItemVariantItem.js +1 -1
  626. package/src/com.ultracart.admin.v2.models/ItemVariation.js +1 -1
  627. package/src/com.ultracart.admin.v2.models/ItemVariationOption.js +1 -1
  628. package/src/com.ultracart.admin.v2.models/ItemWishlistMember.js +1 -1
  629. package/src/com.ultracart.admin.v2.models/ItemsRequest.js +1 -1
  630. package/src/com.ultracart.admin.v2.models/ItemsResponse.js +1 -1
  631. package/src/com.ultracart.admin.v2.models/KeyValue.js +1 -1
  632. package/src/com.ultracart.admin.v2.models/LibraryFilterValues.js +1 -1
  633. package/src/com.ultracart.admin.v2.models/LibraryFilterValuesResponse.js +1 -1
  634. package/src/com.ultracart.admin.v2.models/LibraryItem.js +1 -1
  635. package/src/com.ultracart.admin.v2.models/LibraryItemAccount.js +1 -1
  636. package/src/com.ultracart.admin.v2.models/LibraryItemAsset.js +1 -1
  637. package/src/com.ultracart.admin.v2.models/LibraryItemAttribute.js +1 -1
  638. package/src/com.ultracart.admin.v2.models/LibraryItemEmail.js +1 -1
  639. package/src/com.ultracart.admin.v2.models/LibraryItemPublishedMeta.js +1 -1
  640. package/src/com.ultracart.admin.v2.models/LibraryItemPurchasedMeta.js +1 -1
  641. package/src/com.ultracart.admin.v2.models/LibraryItemQuery.js +1 -1
  642. package/src/com.ultracart.admin.v2.models/LibraryItemResponse.js +1 -1
  643. package/src/com.ultracart.admin.v2.models/LibraryItemScreenshot.js +1 -1
  644. package/src/com.ultracart.admin.v2.models/LibraryItemsResponse.js +1 -1
  645. package/src/com.ultracart.admin.v2.models/LinkedAccount.js +1 -1
  646. package/src/com.ultracart.admin.v2.models/ListSegmentMembership.js +1 -1
  647. package/src/com.ultracart.admin.v2.models/LookupRequest.js +1 -1
  648. package/src/com.ultracart.admin.v2.models/LookupResponse.js +1 -1
  649. package/src/com.ultracart.admin.v2.models/Mailgun.js +1 -1
  650. package/src/com.ultracart.admin.v2.models/Metric.js +1 -1
  651. package/src/com.ultracart.admin.v2.models/Notification.js +1 -1
  652. package/src/com.ultracart.admin.v2.models/OauthRevokeSuccessResponse.js +1 -1
  653. package/src/com.ultracart.admin.v2.models/OauthTokenResponse.js +1 -1
  654. package/src/com.ultracart.admin.v2.models/Order.js +1 -1
  655. package/src/com.ultracart.admin.v2.models/OrderAffiliate.js +1 -1
  656. package/src/com.ultracart.admin.v2.models/OrderAffiliateLedger.js +1 -1
  657. package/src/com.ultracart.admin.v2.models/OrderAutoOrder.js +1 -1
  658. package/src/com.ultracart.admin.v2.models/OrderBilling.js +1 -1
  659. package/src/com.ultracart.admin.v2.models/OrderBuysafe.js +1 -1
  660. package/src/com.ultracart.admin.v2.models/OrderByTokenQuery.js +1 -1
  661. package/src/com.ultracart.admin.v2.models/OrderChannelPartner.js +1 -1
  662. package/src/com.ultracart.admin.v2.models/OrderCheckout.js +1 -1
  663. package/src/com.ultracart.admin.v2.models/OrderCoupon.js +1 -1
  664. package/src/com.ultracart.admin.v2.models/OrderDigitalItem.js +1 -1
  665. package/src/com.ultracart.admin.v2.models/OrderDigitalOrder.js +1 -1
  666. package/src/com.ultracart.admin.v2.models/OrderEdi.js +1 -1
  667. package/src/com.ultracart.admin.v2.models/OrderEdiDocument.js +1 -1
  668. package/src/com.ultracart.admin.v2.models/OrderEdiDocumentsResponse.js +1 -1
  669. package/src/com.ultracart.admin.v2.models/OrderFormat.js +1 -1
  670. package/src/com.ultracart.admin.v2.models/OrderFormatResponse.js +1 -1
  671. package/src/com.ultracart.admin.v2.models/OrderFraudScore.js +1 -1
  672. package/src/com.ultracart.admin.v2.models/OrderGift.js +1 -1
  673. package/src/com.ultracart.admin.v2.models/OrderGiftCertificate.js +1 -1
  674. package/src/com.ultracart.admin.v2.models/OrderInternal.js +1 -1
  675. package/src/com.ultracart.admin.v2.models/OrderInvoiceResponse.js +1 -1
  676. package/src/com.ultracart.admin.v2.models/OrderItem.js +1 -1
  677. package/src/com.ultracart.admin.v2.models/OrderItemEdi.js +1 -1
  678. package/src/com.ultracart.admin.v2.models/OrderItemEdiIdentification.js +1 -1
  679. package/src/com.ultracart.admin.v2.models/OrderItemEdiLot.js +1 -1
  680. package/src/com.ultracart.admin.v2.models/OrderItemOption.js +1 -1
  681. package/src/com.ultracart.admin.v2.models/OrderItemOptionFileAttachment.js +1 -1
  682. package/src/com.ultracart.admin.v2.models/OrderItemProperty.js +1 -1
  683. package/src/com.ultracart.admin.v2.models/OrderItemTag.js +1 -1
  684. package/src/com.ultracart.admin.v2.models/OrderLinkedShipment.js +1 -1
  685. package/src/com.ultracart.admin.v2.models/OrderMarketing.js +1 -1
  686. package/src/com.ultracart.admin.v2.models/OrderPackingSlipResponse.js +1 -1
  687. package/src/com.ultracart.admin.v2.models/OrderPayment.js +1 -1
  688. package/src/com.ultracart.admin.v2.models/OrderPaymentCheck.js +1 -1
  689. package/src/com.ultracart.admin.v2.models/OrderPaymentCreditCard.js +1 -1
  690. package/src/com.ultracart.admin.v2.models/OrderPaymentCreditCardDualVaulted.js +1 -1
  691. package/src/com.ultracart.admin.v2.models/OrderPaymentCreditCardDualVaultedProperty.js +1 -1
  692. package/src/com.ultracart.admin.v2.models/OrderPaymentECheck.js +1 -1
  693. package/src/com.ultracart.admin.v2.models/OrderPaymentHealthBenefitCard.js +1 -1
  694. package/src/com.ultracart.admin.v2.models/OrderPaymentInsurance.js +1 -1
  695. package/src/com.ultracart.admin.v2.models/OrderPaymentPurchaseOrder.js +1 -1
  696. package/src/com.ultracart.admin.v2.models/OrderPaymentTransaction.js +1 -1
  697. package/src/com.ultracart.admin.v2.models/OrderPaymentTransactionDetail.js +1 -1
  698. package/src/com.ultracart.admin.v2.models/OrderPointOfSale.js +1 -1
  699. package/src/com.ultracart.admin.v2.models/OrderProcessPaymentRequest.js +1 -1
  700. package/src/com.ultracart.admin.v2.models/OrderProcessPaymentResponse.js +1 -1
  701. package/src/com.ultracart.admin.v2.models/OrderProperty.js +1 -1
  702. package/src/com.ultracart.admin.v2.models/OrderQuery.js +1 -1
  703. package/src/com.ultracart.admin.v2.models/OrderQueryBatch.js +1 -1
  704. package/src/com.ultracart.admin.v2.models/OrderQuote.js +1 -1
  705. package/src/com.ultracart.admin.v2.models/OrderReason.js +1 -1
  706. package/src/com.ultracart.admin.v2.models/OrderRefundableResponse.js +1 -1
  707. package/src/com.ultracart.admin.v2.models/OrderReplacement.js +1 -1
  708. package/src/com.ultracart.admin.v2.models/OrderReplacementItem.js +1 -1
  709. package/src/com.ultracart.admin.v2.models/OrderReplacementResponse.js +1 -1
  710. package/src/com.ultracart.admin.v2.models/OrderResponse.js +1 -1
  711. package/src/com.ultracart.admin.v2.models/OrderSalesforce.js +1 -1
  712. package/src/com.ultracart.admin.v2.models/OrderShipping.js +1 -1
  713. package/src/com.ultracart.admin.v2.models/OrderSummary.js +1 -1
  714. package/src/com.ultracart.admin.v2.models/OrderTag.js +1 -1
  715. package/src/com.ultracart.admin.v2.models/OrderTaxes.js +1 -1
  716. package/src/com.ultracart.admin.v2.models/OrderTokenResponse.js +1 -1
  717. package/src/com.ultracart.admin.v2.models/OrderTrackingNumberDetail.js +1 -1
  718. package/src/com.ultracart.admin.v2.models/OrderTrackingNumberDetails.js +1 -1
  719. package/src/com.ultracart.admin.v2.models/OrderTransactionalMerchantNote.js +1 -1
  720. package/src/com.ultracart.admin.v2.models/OrderUtm.js +1 -1
  721. package/src/com.ultracart.admin.v2.models/OrderValidationRequest.js +1 -1
  722. package/src/com.ultracart.admin.v2.models/OrderValidationResponse.js +1 -1
  723. package/src/com.ultracart.admin.v2.models/OrdersResponse.js +1 -1
  724. package/src/com.ultracart.admin.v2.models/Permission.js +1 -1
  725. package/src/com.ultracart.admin.v2.models/PointOfSaleLocation.js +1 -1
  726. package/src/com.ultracart.admin.v2.models/PointOfSaleReader.js +1 -1
  727. package/src/com.ultracart.admin.v2.models/PointOfSaleRegister.js +1 -1
  728. package/src/com.ultracart.admin.v2.models/PricingTier.js +1 -1
  729. package/src/com.ultracart.admin.v2.models/PricingTierNotification.js +1 -1
  730. package/src/com.ultracart.admin.v2.models/PricingTiersResponse.js +1 -1
  731. package/src/com.ultracart.admin.v2.models/Property.js +1 -1
  732. package/src/com.ultracart.admin.v2.models/PublishLibraryItemRequest.js +1 -1
  733. package/src/com.ultracart.admin.v2.models/RegisterAffiliateClickRequest.js +1 -1
  734. package/src/com.ultracart.admin.v2.models/RegisterAffiliateClickResponse.js +1 -1
  735. package/src/com.ultracart.admin.v2.models/Report.js +1 -1
  736. package/src/com.ultracart.admin.v2.models/ReportAuth.js +1 -1
  737. package/src/com.ultracart.admin.v2.models/ReportAuthResponse.js +1 -1
  738. package/src/com.ultracart.admin.v2.models/ReportDataSet.js +1 -1
  739. package/src/com.ultracart.admin.v2.models/ReportDataSetColumn.js +1 -1
  740. package/src/com.ultracart.admin.v2.models/ReportDataSetPage.js +1 -1
  741. package/src/com.ultracart.admin.v2.models/ReportDataSetPageResponse.js +1 -1
  742. package/src/com.ultracart.admin.v2.models/ReportDataSetQuery.js +1 -1
  743. package/src/com.ultracart.admin.v2.models/ReportDataSetQueryOrderByColumn.js +1 -1
  744. package/src/com.ultracart.admin.v2.models/ReportDataSetResponse.js +1 -1
  745. package/src/com.ultracart.admin.v2.models/ReportDataSetRow.js +1 -1
  746. package/src/com.ultracart.admin.v2.models/ReportDataSetSchema.js +1 -1
  747. package/src/com.ultracart.admin.v2.models/ReportDataSource.js +1 -1
  748. package/src/com.ultracart.admin.v2.models/ReportDataSourceSchema.js +1 -1
  749. package/src/com.ultracart.admin.v2.models/ReportDryRunQueriesRequest.js +1 -1
  750. package/src/com.ultracart.admin.v2.models/ReportDryRunQueriesResponse.js +1 -1
  751. package/src/com.ultracart.admin.v2.models/ReportDryRunQueryResult.js +1 -1
  752. package/src/com.ultracart.admin.v2.models/ReportExecuteQueriesRequest.js +1 -1
  753. package/src/com.ultracart.admin.v2.models/ReportFilter.js +1 -1
  754. package/src/com.ultracart.admin.v2.models/ReportFilterConnection.js +1 -1
  755. package/src/com.ultracart.admin.v2.models/ReportPage.js +1 -1
  756. package/src/com.ultracart.admin.v2.models/ReportPageFilter.js +1 -1
  757. package/src/com.ultracart.admin.v2.models/ReportPageVisualization.js +1 -1
  758. package/src/com.ultracart.admin.v2.models/ReportPageVisualizationDimension.js +1 -1
  759. package/src/com.ultracart.admin.v2.models/ReportPageVisualizationMetric.js +1 -1
  760. package/src/com.ultracart.admin.v2.models/ReportResponse.js +1 -1
  761. package/src/com.ultracart.admin.v2.models/ReportWebsocketEvent.js +1 -1
  762. package/src/com.ultracart.admin.v2.models/ReportsResponse.js +1 -1
  763. package/src/com.ultracart.admin.v2.models/ResponseMetadata.js +1 -1
  764. package/src/com.ultracart.admin.v2.models/ResultSet.js +1 -1
  765. package/src/com.ultracart.admin.v2.models/RulerValidationRequest.js +1 -1
  766. package/src/com.ultracart.admin.v2.models/RulerValidationResponse.js +1 -1
  767. package/src/com.ultracart.admin.v2.models/ScreenRecording.js +1 -1
  768. package/src/com.ultracart.admin.v2.models/ScreenRecordingAdPlatform.js +1 -1
  769. package/src/com.ultracart.admin.v2.models/ScreenRecordingFilter.js +1 -1
  770. package/src/com.ultracart.admin.v2.models/ScreenRecordingFilterGeoDistance.js +1 -1
  771. package/src/com.ultracart.admin.v2.models/ScreenRecordingFilterIpSearch.js +1 -1
  772. package/src/com.ultracart.admin.v2.models/ScreenRecordingFilterPageView.js +1 -1
  773. package/src/com.ultracart.admin.v2.models/ScreenRecordingFilterPageViewEvent.js +1 -1
  774. package/src/com.ultracart.admin.v2.models/ScreenRecordingFilterPageViewEventParam.js +1 -1
  775. package/src/com.ultracart.admin.v2.models/ScreenRecordingFilterPageViewParam.js +1 -1
  776. package/src/com.ultracart.admin.v2.models/ScreenRecordingFilterPageViewReferrerParam.js +1 -1
  777. package/src/com.ultracart.admin.v2.models/ScreenRecordingFilterRangeBigDecimal.js +1 -1
  778. package/src/com.ultracart.admin.v2.models/ScreenRecordingFilterRangeDate.js +1 -1
  779. package/src/com.ultracart.admin.v2.models/ScreenRecordingFilterRangeInteger.js +1 -1
  780. package/src/com.ultracart.admin.v2.models/ScreenRecordingFilterStringSearch.js +1 -1
  781. package/src/com.ultracart.admin.v2.models/ScreenRecordingFilterValues.js +1 -1
  782. package/src/com.ultracart.admin.v2.models/ScreenRecordingFilterValuesEvent.js +1 -1
  783. package/src/com.ultracart.admin.v2.models/ScreenRecordingFilterValuesEventParams.js +1 -1
  784. package/src/com.ultracart.admin.v2.models/ScreenRecordingFilterValuesPageParam.js +1 -1
  785. package/src/com.ultracart.admin.v2.models/ScreenRecordingFilterValuesPageView.js +1 -1
  786. package/src/com.ultracart.admin.v2.models/ScreenRecordingHeatmap.js +1 -1
  787. package/src/com.ultracart.admin.v2.models/ScreenRecordingHeatmapIndexRequest.js +1 -1
  788. package/src/com.ultracart.admin.v2.models/ScreenRecordingHeatmapIndexResponse.js +1 -1
  789. package/src/com.ultracart.admin.v2.models/ScreenRecordingHeatmapRequest.js +1 -1
  790. package/src/com.ultracart.admin.v2.models/ScreenRecordingHeatmapReset.js +1 -1
  791. package/src/com.ultracart.admin.v2.models/ScreenRecordingHeatmapResponse.js +1 -1
  792. package/src/com.ultracart.admin.v2.models/ScreenRecordingHeatmapUrl.js +1 -1
  793. package/src/com.ultracart.admin.v2.models/ScreenRecordingMerchantNotesRequest.js +1 -1
  794. package/src/com.ultracart.admin.v2.models/ScreenRecordingMultifield.js +1 -1
  795. package/src/com.ultracart.admin.v2.models/ScreenRecordingPageView.js +1 -1
  796. package/src/com.ultracart.admin.v2.models/ScreenRecordingPageViewDataResponse.js +1 -1
  797. package/src/com.ultracart.admin.v2.models/ScreenRecordingPageViewEvent.js +1 -1
  798. package/src/com.ultracart.admin.v2.models/ScreenRecordingPageViewEventParameter.js +1 -1
  799. package/src/com.ultracart.admin.v2.models/ScreenRecordingPageViewParameter.js +1 -1
  800. package/src/com.ultracart.admin.v2.models/ScreenRecordingQueryRequest.js +1 -1
  801. package/src/com.ultracart.admin.v2.models/ScreenRecordingQueryResponse.js +1 -1
  802. package/src/com.ultracart.admin.v2.models/ScreenRecordingResponse.js +1 -1
  803. package/src/com.ultracart.admin.v2.models/ScreenRecordingSegment.js +1 -1
  804. package/src/com.ultracart.admin.v2.models/ScreenRecordingSegmentResponse.js +1 -1
  805. package/src/com.ultracart.admin.v2.models/ScreenRecordingSegmentsResponse.js +1 -1
  806. package/src/com.ultracart.admin.v2.models/ScreenRecordingSettings.js +1 -1
  807. package/src/com.ultracart.admin.v2.models/ScreenRecordingSettingsResponse.js +1 -1
  808. package/src/com.ultracart.admin.v2.models/ScreenRecordingStoreFront.js +1 -1
  809. package/src/com.ultracart.admin.v2.models/ScreenRecordingTagsRequest.js +1 -1
  810. package/src/com.ultracart.admin.v2.models/ScreenRecordingTagsResponse.js +1 -1
  811. package/src/com.ultracart.admin.v2.models/ScreenRecordingUserAgent.js +1 -1
  812. package/src/com.ultracart.admin.v2.models/ScreenRecordingUserAgentDevice.js +1 -1
  813. package/src/com.ultracart.admin.v2.models/ScreenRecordingUserAgentOS.js +1 -1
  814. package/src/com.ultracart.admin.v2.models/ScreenRecordingUserProperty.js +1 -1
  815. package/src/com.ultracart.admin.v2.models/ScreenshotsResponse.js +1 -1
  816. package/src/com.ultracart.admin.v2.models/SelfConfig.js +1 -1
  817. package/src/com.ultracart.admin.v2.models/SimpleValue.js +1 -1
  818. package/src/com.ultracart.admin.v2.models/SingleSignOnAuthorizeRequest.js +1 -1
  819. package/src/com.ultracart.admin.v2.models/SingleSignOnAuthorizeResponse.js +1 -1
  820. package/src/com.ultracart.admin.v2.models/SingleSignOnTokenRequest.js +1 -1
  821. package/src/com.ultracart.admin.v2.models/SingleSignOnTokenResponse.js +1 -1
  822. package/src/com.ultracart.admin.v2.models/SovosConfig.js +1 -1
  823. package/src/com.ultracart.admin.v2.models/StateProvince.js +1 -1
  824. package/src/com.ultracart.admin.v2.models/StepWaiting.js +1 -1
  825. package/src/com.ultracart.admin.v2.models/StoreFront.js +1 -1
  826. package/src/com.ultracart.admin.v2.models/StoreFrontsResponse.js +1 -1
  827. package/src/com.ultracart.admin.v2.models/TaxCity.js +1 -1
  828. package/src/com.ultracart.admin.v2.models/TaxCountry.js +1 -1
  829. package/src/com.ultracart.admin.v2.models/TaxCountryCode.js +1 -1
  830. package/src/com.ultracart.admin.v2.models/TaxCounty.js +1 -1
  831. package/src/com.ultracart.admin.v2.models/TaxJarConfig.js +1 -1
  832. package/src/com.ultracart.admin.v2.models/TaxPostalCode.js +1 -1
  833. package/src/com.ultracart.admin.v2.models/TaxProviderActivateResult.js +1 -1
  834. package/src/com.ultracart.admin.v2.models/TaxProviderAvalara.js +1 -1
  835. package/src/com.ultracart.admin.v2.models/TaxProviderAvalaraCompaniesResult.js +1 -1
  836. package/src/com.ultracart.admin.v2.models/TaxProviderAvalaraCompany.js +1 -1
  837. package/src/com.ultracart.admin.v2.models/TaxProviderSelf.js +1 -1
  838. package/src/com.ultracart.admin.v2.models/TaxProviderSelfCountriesResponse.js +1 -1
  839. package/src/com.ultracart.admin.v2.models/TaxProviderSelfRegionsResponse.js +1 -1
  840. package/src/com.ultracart.admin.v2.models/TaxProviderSovos.js +1 -1
  841. package/src/com.ultracart.admin.v2.models/TaxProviderTaxJar.js +1 -1
  842. package/src/com.ultracart.admin.v2.models/TaxProviderTestResult.js +1 -1
  843. package/src/com.ultracart.admin.v2.models/TaxProviderUltraCart.js +1 -1
  844. package/src/com.ultracart.admin.v2.models/TaxProviderUltraCartState.js +1 -1
  845. package/src/com.ultracart.admin.v2.models/TaxProvidersResponse.js +1 -1
  846. package/src/com.ultracart.admin.v2.models/TaxState.js +1 -1
  847. package/src/com.ultracart.admin.v2.models/TaxStateCode.js +1 -1
  848. package/src/com.ultracart.admin.v2.models/TempMultimedia.js +1 -1
  849. package/src/com.ultracart.admin.v2.models/TempMultimediaResponse.js +1 -1
  850. package/src/com.ultracart.admin.v2.models/ThumbnailParametersRequest.js +1 -1
  851. package/src/com.ultracart.admin.v2.models/ThumbnailParametersResponse.js +1 -1
  852. package/src/com.ultracart.admin.v2.models/TransactionEmail.js +1 -1
  853. package/src/com.ultracart.admin.v2.models/TransactionEmailListResponse.js +1 -1
  854. package/src/com.ultracart.admin.v2.models/TransactionEmailOption.js +1 -1
  855. package/src/com.ultracart.admin.v2.models/TransactionEmailResponse.js +1 -1
  856. package/src/com.ultracart.admin.v2.models/Twilio.js +1 -1
  857. package/src/com.ultracart.admin.v2.models/TwilioResponse.js +1 -1
  858. package/src/com.ultracart.admin.v2.models/TwiliosResponse.js +1 -1
  859. package/src/com.ultracart.admin.v2.models/UltraCartConfig.js +1 -1
  860. package/src/com.ultracart.admin.v2.models/UploadCouponCodesRequest.js +1 -1
  861. package/src/com.ultracart.admin.v2.models/UploadCouponCodesResponse.js +1 -1
  862. package/src/com.ultracart.admin.v2.models/User.js +1 -1
  863. package/src/com.ultracart.admin.v2.models/UserGroupMembership.js +1 -1
  864. package/src/com.ultracart.admin.v2.models/UserLogin.js +1 -1
  865. package/src/com.ultracart.admin.v2.models/UserLoginsResponse.js +1 -1
  866. package/src/com.ultracart.admin.v2.models/UserResponse.js +1 -1
  867. package/src/com.ultracart.admin.v2.models/UsersResponse.js +1 -1
  868. package/src/com.ultracart.admin.v2.models/VerificationRecord.js +1 -1
  869. package/src/com.ultracart.admin.v2.models/Warning.js +1 -1
  870. package/src/com.ultracart.admin.v2.models/Webhook.js +1 -1
  871. package/src/com.ultracart.admin.v2.models/WebhookEventCategory.js +1 -1
  872. package/src/com.ultracart.admin.v2.models/WebhookEventSubscription.js +1 -1
  873. package/src/com.ultracart.admin.v2.models/WebhookLog.js +1 -1
  874. package/src/com.ultracart.admin.v2.models/WebhookLogResponse.js +1 -1
  875. package/src/com.ultracart.admin.v2.models/WebhookLogSummariesResponse.js +1 -1
  876. package/src/com.ultracart.admin.v2.models/WebhookLogSummary.js +1 -1
  877. package/src/com.ultracart.admin.v2.models/WebhookResponse.js +1 -1
  878. package/src/com.ultracart.admin.v2.models/WebhookSampleRequest.js +1 -1
  879. package/src/com.ultracart.admin.v2.models/WebhookSampleRequestResponse.js +1 -1
  880. package/src/com.ultracart.admin.v2.models/WebhooksResponse.js +1 -1
  881. package/src/com.ultracart.admin.v2.models/Weight.js +1 -1
  882. package/src/com.ultracart.admin.v2.models/WorkflowAttachment.js +1 -1
  883. package/src/com.ultracart.admin.v2.models/WorkflowAttachmentUploadUrl.js +1 -1
  884. package/src/com.ultracart.admin.v2.models/WorkflowAttachmentUploadUrlResponse.js +1 -1
  885. package/src/com.ultracart.admin.v2.models/WorkflowGroup.js +1 -1
  886. package/src/com.ultracart.admin.v2.models/WorkflowGroupsResponse.js +1 -1
  887. package/src/com.ultracart.admin.v2.models/WorkflowNote.js +1 -1
  888. package/src/com.ultracart.admin.v2.models/WorkflowTask.js +1 -1
  889. package/src/com.ultracart.admin.v2.models/WorkflowTaskHistory.js +1 -1
  890. package/src/com.ultracart.admin.v2.models/WorkflowTaskResponse.js +1 -1
  891. package/src/com.ultracart.admin.v2.models/WorkflowTaskTagsResponse.js +101 -0
  892. package/src/com.ultracart.admin.v2.models/WorkflowTasksRequest.js +1 -1
  893. package/src/com.ultracart.admin.v2.models/WorkflowTasksResponse.js +1 -1
  894. package/src/com.ultracart.admin.v2.models/WorkflowUser.js +1 -1
  895. package/src/com.ultracart.admin.v2.models/WorkflowUserResponse.js +1 -1
  896. package/src/com.ultracart.admin.v2.models/WorkflowUsersResponse.js +1 -1
  897. package/src/index.js +164 -4
  898. package/uc_tag.sh +1 -1
@@ -7,6 +7,14 @@ Method | HTTP request | Description
7
7
  [**deleteConversationCannedMessage**](ConversationApi.md#deleteConversationCannedMessage) | **DELETE** /conversation/canned_messages/{conversation_canned_message_oid} | Delete a conversation canned message
8
8
  [**deleteDepartment**](ConversationApi.md#deleteDepartment) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department
9
9
  [**deleteEngagement**](ConversationApi.md#deleteEngagement) | **DELETE** /conversation/engagements/{conversation_engagement_oid} | Delete a conversation engagement
10
+ [**deletePbxAgent**](ConversationApi.md#deletePbxAgent) | **DELETE** /conversation/pbx/agent/{conversationPbxAgentUuid} | Delete pbx agent
11
+ [**deletePbxAudio**](ConversationApi.md#deletePbxAudio) | **DELETE** /conversation/pbx/audio/{conversationPbxAudioUuid} | Delete pbx audio
12
+ [**deletePbxMenu**](ConversationApi.md#deletePbxMenu) | **DELETE** /conversation/pbx/menu/{conversationPbxMenuUuid} | Delete pbx menu
13
+ [**deletePbxPhoneNumber**](ConversationApi.md#deletePbxPhoneNumber) | **DELETE** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Delete pbx phoneNumber
14
+ [**deletePbxQueue**](ConversationApi.md#deletePbxQueue) | **DELETE** /conversation/pbx/queue/{conversationPbxQueueUuid} | Delete pbx queue
15
+ [**deletePbxTimeBased**](ConversationApi.md#deletePbxTimeBased) | **DELETE** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Delete pbx timeBased
16
+ [**deletePbxTimeRange**](ConversationApi.md#deletePbxTimeRange) | **DELETE** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Delete pbx timeRange
17
+ [**deletePbxVoicemailMailbox**](ConversationApi.md#deletePbxVoicemailMailbox) | **DELETE** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Delete pbx voicemailMailbox
10
18
  [**getAgentKeepAlive**](ConversationApi.md#getAgentKeepAlive) | **GET** /conversation/agent/keepalive | Agent keep alive
11
19
  [**getAgentProfile**](ConversationApi.md#getAgentProfile) | **GET** /conversation/agent/profile | Get agent profile
12
20
  [**getAgentWebsocketAuthorization**](ConversationApi.md#getAgentWebsocketAuthorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
@@ -19,15 +27,41 @@ Method | HTTP request | Description
19
27
  [**getConversationEngagements**](ConversationApi.md#getConversationEngagements) | **GET** /conversation/engagements | Retrieve a list of engagements ordered by name
20
28
  [**getConversationMessages**](ConversationApi.md#getConversationMessages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
21
29
  [**getConversationMultimediaUploadUrl**](ConversationApi.md#getConversationMultimediaUploadUrl) | **GET** /conversation/upload_url/{extension} | Get a presigned conversation multimedia upload URL
30
+ [**getConversationPbxAudioUploadUrl**](ConversationApi.md#getConversationPbxAudioUploadUrl) | **GET** /conversation/pbx/audio/upload_url/{extension} | Get a pre-signed conversation multimedia upload URL
31
+ [**getConversationPbxCustomerSnapshot**](ConversationApi.md#getConversationPbxCustomerSnapshot) | **POST** /conversation/pbx/customer_snapshot | Get orders and customer information for a phone number
22
32
  [**getConversationPermissions**](ConversationApi.md#getConversationPermissions) | **GET** /conversation/permissions | Retrieve conversation permissions
23
33
  [**getConversationWebchatQueueStatuses**](ConversationApi.md#getConversationWebchatQueueStatuses) | **GET** /conversation/conversations/queues/statuses | Retrieve a conversation webchat queue statuses
24
34
  [**getConversations**](ConversationApi.md#getConversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
25
35
  [**getConversationsAutocomplete**](ConversationApi.md#getConversationsAutocomplete) | **POST** /conversation/conversations/autocomplete | Retrieve a list of matching terms for a search field
26
36
  [**getConversationsSearch**](ConversationApi.md#getConversationsSearch) | **POST** /conversation/conversations/search | Search conversations
27
37
  [**getLocationsForEngagement**](ConversationApi.md#getLocationsForEngagement) | **POST** /conversation/locations | Get location data for engagement configuration
38
+ [**getPbxAgent**](ConversationApi.md#getPbxAgent) | **GET** /conversation/pbx/agent/{conversationPbxAgentUuid} | Get pbx agent
39
+ [**getPbxAgents**](ConversationApi.md#getPbxAgents) | **GET** /conversation/pbx/agent | Get pbx agents
40
+ [**getPbxAudio**](ConversationApi.md#getPbxAudio) | **GET** /conversation/pbx/audio/{conversationPbxAudioUuid} | Get pbx audio
41
+ [**getPbxAudios**](ConversationApi.md#getPbxAudios) | **GET** /conversation/pbx/audio | Get pbx audios
42
+ [**getPbxMenu**](ConversationApi.md#getPbxMenu) | **GET** /conversation/pbx/menu/{conversationPbxMenuUuid} | Get pbx menu
43
+ [**getPbxMenus**](ConversationApi.md#getPbxMenus) | **GET** /conversation/pbx/menu | Get pbx menus
44
+ [**getPbxPhoneNumber**](ConversationApi.md#getPbxPhoneNumber) | **GET** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Get pbx phoneNumber
45
+ [**getPbxPhoneNumbers**](ConversationApi.md#getPbxPhoneNumbers) | **GET** /conversation/pbx/phone_number | Get pbx phoneNumbers
46
+ [**getPbxQueue**](ConversationApi.md#getPbxQueue) | **GET** /conversation/pbx/queue/{conversationPbxQueueUuid} | Get pbx queue
47
+ [**getPbxQueues**](ConversationApi.md#getPbxQueues) | **GET** /conversation/pbx/queue | Get pbx queues
48
+ [**getPbxTimeBased**](ConversationApi.md#getPbxTimeBased) | **GET** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Get pbx timeBased
49
+ [**getPbxTimeBaseds**](ConversationApi.md#getPbxTimeBaseds) | **GET** /conversation/pbx/time_based | Get pbx timeBaseds
50
+ [**getPbxTimeRange**](ConversationApi.md#getPbxTimeRange) | **GET** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Get pbx timeRange
51
+ [**getPbxTimeRanges**](ConversationApi.md#getPbxTimeRanges) | **GET** /conversation/pbx/time_range | Get pbx timeRanges
52
+ [**getPbxVoicemailMailbox**](ConversationApi.md#getPbxVoicemailMailbox) | **GET** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Get pbx voicemailMailbox
53
+ [**getPbxVoicemailMailboxes**](ConversationApi.md#getPbxVoicemailMailboxes) | **GET** /conversation/pbx/voicemail_mailbox | Get pbx voicemailMailboxes
28
54
  [**insertConversationCannedMessage**](ConversationApi.md#insertConversationCannedMessage) | **POST** /conversation/canned_messages | Insert a canned message
29
55
  [**insertConversationDepartment**](ConversationApi.md#insertConversationDepartment) | **POST** /conversation/departments | Insert a department
30
56
  [**insertConversationEngagement**](ConversationApi.md#insertConversationEngagement) | **POST** /conversation/engagements | Insert a engagement
57
+ [**insertPbxAgent**](ConversationApi.md#insertPbxAgent) | **POST** /conversation/pbx/agent | Insert pbx agent
58
+ [**insertPbxAudio**](ConversationApi.md#insertPbxAudio) | **POST** /conversation/pbx/audio | Insert pbx audio
59
+ [**insertPbxMenu**](ConversationApi.md#insertPbxMenu) | **POST** /conversation/pbx/menu | Insert pbx menu
60
+ [**insertPbxPhoneNumber**](ConversationApi.md#insertPbxPhoneNumber) | **POST** /conversation/pbx/phone_number | Insert pbx phoneNumber
61
+ [**insertPbxQueue**](ConversationApi.md#insertPbxQueue) | **POST** /conversation/pbx/queue | Insert pbx queue
62
+ [**insertPbxTimeBased**](ConversationApi.md#insertPbxTimeBased) | **POST** /conversation/pbx/time_based | Insert pbx timeBased
63
+ [**insertPbxTimeRange**](ConversationApi.md#insertPbxTimeRange) | **POST** /conversation/pbx/time_range | Insert pbx timeRange
64
+ [**insertPbxVoicemailMailbox**](ConversationApi.md#insertPbxVoicemailMailbox) | **POST** /conversation/pbx/voicemail_mailbox | Insert pbx voicemailMailbox
31
65
  [**joinConversation**](ConversationApi.md#joinConversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
32
66
  [**leaveConversation**](ConversationApi.md#leaveConversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
33
67
  [**markReadConversation**](ConversationApi.md#markReadConversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
@@ -39,6 +73,14 @@ Method | HTTP request | Description
39
73
  [**updateConversationDepartment**](ConversationApi.md#updateConversationDepartment) | **PUT** /conversation/departments/{conversation_department_oid} | Update a department
40
74
  [**updateConversationEngagement**](ConversationApi.md#updateConversationEngagement) | **PUT** /conversation/engagements/{conversation_engagement_oid} | Update a engagement
41
75
  [**updateConversationWebchatQueueStatus**](ConversationApi.md#updateConversationWebchatQueueStatus) | **PUT** /conversation/conversations/queues/{queue_name}/status | Update status within the queue
76
+ [**updatePbxAgent**](ConversationApi.md#updatePbxAgent) | **PUT** /conversation/pbx/agent/{conversationPbxAgentUuid} | Update pbx agent
77
+ [**updatePbxAudio**](ConversationApi.md#updatePbxAudio) | **PUT** /conversation/pbx/audio/{conversationPbxAudioUuid} | Update pbx audio
78
+ [**updatePbxMenu**](ConversationApi.md#updatePbxMenu) | **PUT** /conversation/pbx/menu/{conversationPbxMenuUuid} | Update pbx menu
79
+ [**updatePbxPhoneNumber**](ConversationApi.md#updatePbxPhoneNumber) | **PUT** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Update pbx phoneNumber
80
+ [**updatePbxQueue**](ConversationApi.md#updatePbxQueue) | **PUT** /conversation/pbx/queue/{conversationPbxQueueUuid} | Update pbx queue
81
+ [**updatePbxTimeBased**](ConversationApi.md#updatePbxTimeBased) | **PUT** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Update pbx timeBased
82
+ [**updatePbxTimeRange**](ConversationApi.md#updatePbxTimeRange) | **PUT** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Update pbx timeRange
83
+ [**updatePbxVoicemailMailbox**](ConversationApi.md#updatePbxVoicemailMailbox) | **PUT** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Update pbx voicemailMailbox
42
84
 
43
85
 
44
86
  <a name="deleteConversationCannedMessage"></a>
@@ -186,6 +228,406 @@ null (empty response body)
186
228
 
187
229
  [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
188
230
 
231
+ ### HTTP request headers
232
+
233
+ - **Content-Type**: application/json
234
+ - **Accept**: application/json
235
+
236
+ <a name="deletePbxAgent"></a>
237
+ # **deletePbxAgent**
238
+ > ConversationPbxAgentResponse deletePbxAgent(conversationPbxAgentUuid)
239
+
240
+ Delete pbx agent
241
+
242
+ Delete a pbx agent
243
+
244
+ ### Example
245
+ ```javascript
246
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
247
+
248
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
249
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
250
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
251
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
252
+
253
+
254
+ var conversationPbxAgentUuid = "conversationPbxAgentUuid_example"; // String |
255
+
256
+
257
+ var callback = function(error, data, response) {
258
+ if (error) {
259
+ console.error(error);
260
+ } else {
261
+ console.log('API called successfully. Returned data: ' + data);
262
+ }
263
+ };
264
+ apiInstance.deletePbxAgent(conversationPbxAgentUuid, callback);
265
+ ```
266
+
267
+ ### Parameters
268
+
269
+ Name | Type | Description | Notes
270
+ ------------- | ------------- | ------------- | -------------
271
+ **conversationPbxAgentUuid** | **String**| |
272
+
273
+ ### Return type
274
+
275
+ [**ConversationPbxAgentResponse**](ConversationPbxAgentResponse.md)
276
+
277
+ ### Authorization
278
+
279
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
280
+
281
+ ### HTTP request headers
282
+
283
+ - **Content-Type**: application/json
284
+ - **Accept**: application/json
285
+
286
+ <a name="deletePbxAudio"></a>
287
+ # **deletePbxAudio**
288
+ > ConversationPbxAudioResponse deletePbxAudio(conversationPbxAudioUuid)
289
+
290
+ Delete pbx audio
291
+
292
+ Delete a pbx audio
293
+
294
+ ### Example
295
+ ```javascript
296
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
297
+
298
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
299
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
300
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
301
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
302
+
303
+
304
+ var conversationPbxAudioUuid = "conversationPbxAudioUuid_example"; // String |
305
+
306
+
307
+ var callback = function(error, data, response) {
308
+ if (error) {
309
+ console.error(error);
310
+ } else {
311
+ console.log('API called successfully. Returned data: ' + data);
312
+ }
313
+ };
314
+ apiInstance.deletePbxAudio(conversationPbxAudioUuid, callback);
315
+ ```
316
+
317
+ ### Parameters
318
+
319
+ Name | Type | Description | Notes
320
+ ------------- | ------------- | ------------- | -------------
321
+ **conversationPbxAudioUuid** | **String**| |
322
+
323
+ ### Return type
324
+
325
+ [**ConversationPbxAudioResponse**](ConversationPbxAudioResponse.md)
326
+
327
+ ### Authorization
328
+
329
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
330
+
331
+ ### HTTP request headers
332
+
333
+ - **Content-Type**: application/json
334
+ - **Accept**: application/json
335
+
336
+ <a name="deletePbxMenu"></a>
337
+ # **deletePbxMenu**
338
+ > ConversationPbxMenuResponse deletePbxMenu(conversationPbxMenuUuid)
339
+
340
+ Delete pbx menu
341
+
342
+ Delete a pbx menu
343
+
344
+ ### Example
345
+ ```javascript
346
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
347
+
348
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
349
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
350
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
351
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
352
+
353
+
354
+ var conversationPbxMenuUuid = "conversationPbxMenuUuid_example"; // String |
355
+
356
+
357
+ var callback = function(error, data, response) {
358
+ if (error) {
359
+ console.error(error);
360
+ } else {
361
+ console.log('API called successfully. Returned data: ' + data);
362
+ }
363
+ };
364
+ apiInstance.deletePbxMenu(conversationPbxMenuUuid, callback);
365
+ ```
366
+
367
+ ### Parameters
368
+
369
+ Name | Type | Description | Notes
370
+ ------------- | ------------- | ------------- | -------------
371
+ **conversationPbxMenuUuid** | **String**| |
372
+
373
+ ### Return type
374
+
375
+ [**ConversationPbxMenuResponse**](ConversationPbxMenuResponse.md)
376
+
377
+ ### Authorization
378
+
379
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
380
+
381
+ ### HTTP request headers
382
+
383
+ - **Content-Type**: application/json
384
+ - **Accept**: application/json
385
+
386
+ <a name="deletePbxPhoneNumber"></a>
387
+ # **deletePbxPhoneNumber**
388
+ > ConversationPbxPhoneNumberResponse deletePbxPhoneNumber(conversationPbxPhoneNumberUuid)
389
+
390
+ Delete pbx phoneNumber
391
+
392
+ Delete a pbx phoneNumber
393
+
394
+ ### Example
395
+ ```javascript
396
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
397
+
398
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
399
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
400
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
401
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
402
+
403
+
404
+ var conversationPbxPhoneNumberUuid = "conversationPbxPhoneNumberUuid_example"; // String |
405
+
406
+
407
+ var callback = function(error, data, response) {
408
+ if (error) {
409
+ console.error(error);
410
+ } else {
411
+ console.log('API called successfully. Returned data: ' + data);
412
+ }
413
+ };
414
+ apiInstance.deletePbxPhoneNumber(conversationPbxPhoneNumberUuid, callback);
415
+ ```
416
+
417
+ ### Parameters
418
+
419
+ Name | Type | Description | Notes
420
+ ------------- | ------------- | ------------- | -------------
421
+ **conversationPbxPhoneNumberUuid** | **String**| |
422
+
423
+ ### Return type
424
+
425
+ [**ConversationPbxPhoneNumberResponse**](ConversationPbxPhoneNumberResponse.md)
426
+
427
+ ### Authorization
428
+
429
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
430
+
431
+ ### HTTP request headers
432
+
433
+ - **Content-Type**: application/json
434
+ - **Accept**: application/json
435
+
436
+ <a name="deletePbxQueue"></a>
437
+ # **deletePbxQueue**
438
+ > ConversationPbxQueueResponse deletePbxQueue(conversationPbxQueueUuid)
439
+
440
+ Delete pbx queue
441
+
442
+ Delete a pbx queue
443
+
444
+ ### Example
445
+ ```javascript
446
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
447
+
448
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
449
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
450
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
451
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
452
+
453
+
454
+ var conversationPbxQueueUuid = "conversationPbxQueueUuid_example"; // String |
455
+
456
+
457
+ var callback = function(error, data, response) {
458
+ if (error) {
459
+ console.error(error);
460
+ } else {
461
+ console.log('API called successfully. Returned data: ' + data);
462
+ }
463
+ };
464
+ apiInstance.deletePbxQueue(conversationPbxQueueUuid, callback);
465
+ ```
466
+
467
+ ### Parameters
468
+
469
+ Name | Type | Description | Notes
470
+ ------------- | ------------- | ------------- | -------------
471
+ **conversationPbxQueueUuid** | **String**| |
472
+
473
+ ### Return type
474
+
475
+ [**ConversationPbxQueueResponse**](ConversationPbxQueueResponse.md)
476
+
477
+ ### Authorization
478
+
479
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
480
+
481
+ ### HTTP request headers
482
+
483
+ - **Content-Type**: application/json
484
+ - **Accept**: application/json
485
+
486
+ <a name="deletePbxTimeBased"></a>
487
+ # **deletePbxTimeBased**
488
+ > ConversationPbxTimeBasedResponse deletePbxTimeBased(conversationPbxTimeBasedUuid)
489
+
490
+ Delete pbx timeBased
491
+
492
+ Delete a pbx timeBased
493
+
494
+ ### Example
495
+ ```javascript
496
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
497
+
498
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
499
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
500
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
501
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
502
+
503
+
504
+ var conversationPbxTimeBasedUuid = "conversationPbxTimeBasedUuid_example"; // String |
505
+
506
+
507
+ var callback = function(error, data, response) {
508
+ if (error) {
509
+ console.error(error);
510
+ } else {
511
+ console.log('API called successfully. Returned data: ' + data);
512
+ }
513
+ };
514
+ apiInstance.deletePbxTimeBased(conversationPbxTimeBasedUuid, callback);
515
+ ```
516
+
517
+ ### Parameters
518
+
519
+ Name | Type | Description | Notes
520
+ ------------- | ------------- | ------------- | -------------
521
+ **conversationPbxTimeBasedUuid** | **String**| |
522
+
523
+ ### Return type
524
+
525
+ [**ConversationPbxTimeBasedResponse**](ConversationPbxTimeBasedResponse.md)
526
+
527
+ ### Authorization
528
+
529
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
530
+
531
+ ### HTTP request headers
532
+
533
+ - **Content-Type**: application/json
534
+ - **Accept**: application/json
535
+
536
+ <a name="deletePbxTimeRange"></a>
537
+ # **deletePbxTimeRange**
538
+ > ConversationPbxTimeRangeResponse deletePbxTimeRange(conversationPbxTimeRangeUuid)
539
+
540
+ Delete pbx timeRange
541
+
542
+ Delete a pbx timeRange
543
+
544
+ ### Example
545
+ ```javascript
546
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
547
+
548
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
549
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
550
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
551
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
552
+
553
+
554
+ var conversationPbxTimeRangeUuid = "conversationPbxTimeRangeUuid_example"; // String |
555
+
556
+
557
+ var callback = function(error, data, response) {
558
+ if (error) {
559
+ console.error(error);
560
+ } else {
561
+ console.log('API called successfully. Returned data: ' + data);
562
+ }
563
+ };
564
+ apiInstance.deletePbxTimeRange(conversationPbxTimeRangeUuid, callback);
565
+ ```
566
+
567
+ ### Parameters
568
+
569
+ Name | Type | Description | Notes
570
+ ------------- | ------------- | ------------- | -------------
571
+ **conversationPbxTimeRangeUuid** | **String**| |
572
+
573
+ ### Return type
574
+
575
+ [**ConversationPbxTimeRangeResponse**](ConversationPbxTimeRangeResponse.md)
576
+
577
+ ### Authorization
578
+
579
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
580
+
581
+ ### HTTP request headers
582
+
583
+ - **Content-Type**: application/json
584
+ - **Accept**: application/json
585
+
586
+ <a name="deletePbxVoicemailMailbox"></a>
587
+ # **deletePbxVoicemailMailbox**
588
+ > ConversationPbxVoicemailMailboxResponse deletePbxVoicemailMailbox(conversationPbxVoicemailMailboxUuid)
589
+
590
+ Delete pbx voicemailMailbox
591
+
592
+ Delete a pbx voicemailMailbox
593
+
594
+ ### Example
595
+ ```javascript
596
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
597
+
598
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
599
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
600
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
601
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
602
+
603
+
604
+ var conversationPbxVoicemailMailboxUuid = "conversationPbxVoicemailMailboxUuid_example"; // String |
605
+
606
+
607
+ var callback = function(error, data, response) {
608
+ if (error) {
609
+ console.error(error);
610
+ } else {
611
+ console.log('API called successfully. Returned data: ' + data);
612
+ }
613
+ };
614
+ apiInstance.deletePbxVoicemailMailbox(conversationPbxVoicemailMailboxUuid, callback);
615
+ ```
616
+
617
+ ### Parameters
618
+
619
+ Name | Type | Description | Notes
620
+ ------------- | ------------- | ------------- | -------------
621
+ **conversationPbxVoicemailMailboxUuid** | **String**| |
622
+
623
+ ### Return type
624
+
625
+ [**ConversationPbxVoicemailMailboxResponse**](ConversationPbxVoicemailMailboxResponse.md)
626
+
627
+ ### Authorization
628
+
629
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
630
+
189
631
  ### HTTP request headers
190
632
 
191
633
  - **Content-Type**: application/json
@@ -195,9 +637,1642 @@ null (empty response body)
195
637
  # **getAgentKeepAlive**
196
638
  > getAgentKeepAlive()
197
639
 
198
- Agent keep alive
640
+ Agent keep alive
641
+
642
+ Called periodically by the conversation API to keep the session alive.
643
+
644
+ ### Example
645
+ ```javascript
646
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
647
+
648
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
649
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
650
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
651
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
652
+
653
+
654
+
655
+ var callback = function(error, data, response) {
656
+ if (error) {
657
+ console.error(error);
658
+ } else {
659
+ console.log('API called successfully.');
660
+ }
661
+ };
662
+ apiInstance.getAgentKeepAlive(callback);
663
+ ```
664
+
665
+ ### Parameters
666
+ This endpoint does not need any parameter.
667
+
668
+ ### Return type
669
+
670
+ null (empty response body)
671
+
672
+ ### Authorization
673
+
674
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
675
+
676
+ ### HTTP request headers
677
+
678
+ - **Content-Type**: application/json
679
+ - **Accept**: application/json
680
+
681
+ <a name="getAgentProfile"></a>
682
+ # **getAgentProfile**
683
+ > ConversationAgentProfileResponse getAgentProfile()
684
+
685
+ Get agent profile
686
+
687
+ Retrieve the agents profile
688
+
689
+ ### Example
690
+ ```javascript
691
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
692
+
693
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
694
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
695
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
696
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
697
+
698
+
699
+
700
+ var callback = function(error, data, response) {
701
+ if (error) {
702
+ console.error(error);
703
+ } else {
704
+ console.log('API called successfully. Returned data: ' + data);
705
+ }
706
+ };
707
+ apiInstance.getAgentProfile(callback);
708
+ ```
709
+
710
+ ### Parameters
711
+ This endpoint does not need any parameter.
712
+
713
+ ### Return type
714
+
715
+ [**ConversationAgentProfileResponse**](ConversationAgentProfileResponse.md)
716
+
717
+ ### Authorization
718
+
719
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
720
+
721
+ ### HTTP request headers
722
+
723
+ - **Content-Type**: application/json
724
+ - **Accept**: application/json
725
+
726
+ <a name="getAgentWebsocketAuthorization"></a>
727
+ # **getAgentWebsocketAuthorization**
728
+ > ConversationAgentAuthResponse getAgentWebsocketAuthorization()
729
+
730
+ Get agent websocket authorization
731
+
732
+ Retrieve a JWT to authorize an agent to make a websocket connection.
733
+
734
+ ### Example
735
+ ```javascript
736
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
737
+
738
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
739
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
740
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
741
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
742
+
743
+
744
+
745
+ var callback = function(error, data, response) {
746
+ if (error) {
747
+ console.error(error);
748
+ } else {
749
+ console.log('API called successfully. Returned data: ' + data);
750
+ }
751
+ };
752
+ apiInstance.getAgentWebsocketAuthorization(callback);
753
+ ```
754
+
755
+ ### Parameters
756
+ This endpoint does not need any parameter.
757
+
758
+ ### Return type
759
+
760
+ [**ConversationAgentAuthResponse**](ConversationAgentAuthResponse.md)
761
+
762
+ ### Authorization
763
+
764
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
765
+
766
+ ### HTTP request headers
767
+
768
+ - **Content-Type**: application/json
769
+ - **Accept**: application/json
770
+
771
+ <a name="getConversation"></a>
772
+ # **getConversation**
773
+ > ConversationResponse getConversation(conversation_uuid, opts)
774
+
775
+ Retrieve a conversation
776
+
777
+ Retrieve a conversation including the participants and messages
778
+
779
+ ### Example
780
+ ```javascript
781
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
782
+
783
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
784
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
785
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
786
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
787
+
788
+
789
+ var conversation_uuid = "conversation_uuid_example"; // String |
790
+
791
+ var opts = {
792
+ 'limit': 56 // Number |
793
+ };
794
+
795
+ var callback = function(error, data, response) {
796
+ if (error) {
797
+ console.error(error);
798
+ } else {
799
+ console.log('API called successfully. Returned data: ' + data);
800
+ }
801
+ };
802
+ apiInstance.getConversation(conversation_uuid, opts, callback);
803
+ ```
804
+
805
+ ### Parameters
806
+
807
+ Name | Type | Description | Notes
808
+ ------------- | ------------- | ------------- | -------------
809
+ **conversation_uuid** | **String**| |
810
+ **limit** | **Number**| | [optional]
811
+
812
+ ### Return type
813
+
814
+ [**ConversationResponse**](ConversationResponse.md)
815
+
816
+ ### Authorization
817
+
818
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
819
+
820
+ ### HTTP request headers
821
+
822
+ - **Content-Type**: application/json
823
+ - **Accept**: application/json
824
+
825
+ <a name="getConversationCannedMessages"></a>
826
+ # **getConversationCannedMessages**
827
+ > ConversationCannedMessagesResponse getConversationCannedMessages()
828
+
829
+ Retrieve a list of canned messages ordered by short_code
830
+
831
+ Retrieve a list of canned messages ordered by short_code
832
+
833
+ ### Example
834
+ ```javascript
835
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
836
+
837
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
838
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
839
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
840
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
841
+
842
+
843
+
844
+ var callback = function(error, data, response) {
845
+ if (error) {
846
+ console.error(error);
847
+ } else {
848
+ console.log('API called successfully. Returned data: ' + data);
849
+ }
850
+ };
851
+ apiInstance.getConversationCannedMessages(callback);
852
+ ```
853
+
854
+ ### Parameters
855
+ This endpoint does not need any parameter.
856
+
857
+ ### Return type
858
+
859
+ [**ConversationCannedMessagesResponse**](ConversationCannedMessagesResponse.md)
860
+
861
+ ### Authorization
862
+
863
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
864
+
865
+ ### HTTP request headers
866
+
867
+ - **Content-Type**: application/json
868
+ - **Accept**: application/json
869
+
870
+ <a name="getConversationContext"></a>
871
+ # **getConversationContext**
872
+ > ConversationWebchatContext getConversationContext(conversation_uuid)
873
+
874
+ Get a webchat conversation context
875
+
876
+ Get a webchat conversation context
877
+
878
+ ### Example
879
+ ```javascript
880
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
881
+
882
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
883
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
884
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
885
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
886
+
887
+
888
+ var conversation_uuid = "conversation_uuid_example"; // String |
889
+
890
+
891
+ var callback = function(error, data, response) {
892
+ if (error) {
893
+ console.error(error);
894
+ } else {
895
+ console.log('API called successfully. Returned data: ' + data);
896
+ }
897
+ };
898
+ apiInstance.getConversationContext(conversation_uuid, callback);
899
+ ```
900
+
901
+ ### Parameters
902
+
903
+ Name | Type | Description | Notes
904
+ ------------- | ------------- | ------------- | -------------
905
+ **conversation_uuid** | **String**| |
906
+
907
+ ### Return type
908
+
909
+ [**ConversationWebchatContext**](ConversationWebchatContext.md)
910
+
911
+ ### Authorization
912
+
913
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
914
+
915
+ ### HTTP request headers
916
+
917
+ - **Content-Type**: application/json
918
+ - **Accept**: application/json
919
+
920
+ <a name="getConversationDepartmentMemberList"></a>
921
+ # **getConversationDepartmentMemberList**
922
+ > ConversationDepartmentMembersResponse getConversationDepartmentMemberList()
923
+
924
+ Retrieve a list of possible department members
925
+
926
+ Retrieve a list of possible department members
927
+
928
+ ### Example
929
+ ```javascript
930
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
931
+
932
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
933
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
934
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
935
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
936
+
937
+
938
+
939
+ var callback = function(error, data, response) {
940
+ if (error) {
941
+ console.error(error);
942
+ } else {
943
+ console.log('API called successfully. Returned data: ' + data);
944
+ }
945
+ };
946
+ apiInstance.getConversationDepartmentMemberList(callback);
947
+ ```
948
+
949
+ ### Parameters
950
+ This endpoint does not need any parameter.
951
+
952
+ ### Return type
953
+
954
+ [**ConversationDepartmentMembersResponse**](ConversationDepartmentMembersResponse.md)
955
+
956
+ ### Authorization
957
+
958
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
959
+
960
+ ### HTTP request headers
961
+
962
+ - **Content-Type**: application/json
963
+ - **Accept**: application/json
964
+
965
+ <a name="getConversationDepartments"></a>
966
+ # **getConversationDepartments**
967
+ > ConversationDepartmentsResponse getConversationDepartments()
968
+
969
+ Retrieve a list of departments ordered by name
970
+
971
+ Retrieve a list of departments ordered by name
972
+
973
+ ### Example
974
+ ```javascript
975
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
976
+
977
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
978
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
979
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
980
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
981
+
982
+
983
+
984
+ var callback = function(error, data, response) {
985
+ if (error) {
986
+ console.error(error);
987
+ } else {
988
+ console.log('API called successfully. Returned data: ' + data);
989
+ }
990
+ };
991
+ apiInstance.getConversationDepartments(callback);
992
+ ```
993
+
994
+ ### Parameters
995
+ This endpoint does not need any parameter.
996
+
997
+ ### Return type
998
+
999
+ [**ConversationDepartmentsResponse**](ConversationDepartmentsResponse.md)
1000
+
1001
+ ### Authorization
1002
+
1003
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1004
+
1005
+ ### HTTP request headers
1006
+
1007
+ - **Content-Type**: application/json
1008
+ - **Accept**: application/json
1009
+
1010
+ <a name="getConversationEngagement"></a>
1011
+ # **getConversationEngagement**
1012
+ > ConversationEngagementResponse getConversationEngagement(conversation_engagement_oid)
1013
+
1014
+ Retrieve an engagement
1015
+
1016
+ Retrieve an engagement
1017
+
1018
+ ### Example
1019
+ ```javascript
1020
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
1021
+
1022
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1023
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
1024
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1025
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
1026
+
1027
+
1028
+ var conversation_engagement_oid = 56; // Number |
1029
+
1030
+
1031
+ var callback = function(error, data, response) {
1032
+ if (error) {
1033
+ console.error(error);
1034
+ } else {
1035
+ console.log('API called successfully. Returned data: ' + data);
1036
+ }
1037
+ };
1038
+ apiInstance.getConversationEngagement(conversation_engagement_oid, callback);
1039
+ ```
1040
+
1041
+ ### Parameters
1042
+
1043
+ Name | Type | Description | Notes
1044
+ ------------- | ------------- | ------------- | -------------
1045
+ **conversation_engagement_oid** | **Number**| |
1046
+
1047
+ ### Return type
1048
+
1049
+ [**ConversationEngagementResponse**](ConversationEngagementResponse.md)
1050
+
1051
+ ### Authorization
1052
+
1053
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1054
+
1055
+ ### HTTP request headers
1056
+
1057
+ - **Content-Type**: application/json
1058
+ - **Accept**: application/json
1059
+
1060
+ <a name="getConversationEngagements"></a>
1061
+ # **getConversationEngagements**
1062
+ > ConversationEngagementsResponse getConversationEngagements()
1063
+
1064
+ Retrieve a list of engagements ordered by name
1065
+
1066
+ Retrieve a list of engagements ordered by name
1067
+
1068
+ ### Example
1069
+ ```javascript
1070
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
1071
+
1072
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1073
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
1074
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1075
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
1076
+
1077
+
1078
+
1079
+ var callback = function(error, data, response) {
1080
+ if (error) {
1081
+ console.error(error);
1082
+ } else {
1083
+ console.log('API called successfully. Returned data: ' + data);
1084
+ }
1085
+ };
1086
+ apiInstance.getConversationEngagements(callback);
1087
+ ```
1088
+
1089
+ ### Parameters
1090
+ This endpoint does not need any parameter.
1091
+
1092
+ ### Return type
1093
+
1094
+ [**ConversationEngagementsResponse**](ConversationEngagementsResponse.md)
1095
+
1096
+ ### Authorization
1097
+
1098
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1099
+
1100
+ ### HTTP request headers
1101
+
1102
+ - **Content-Type**: application/json
1103
+ - **Accept**: application/json
1104
+
1105
+ <a name="getConversationMessages"></a>
1106
+ # **getConversationMessages**
1107
+ > ConversationMessagesResponse getConversationMessages(conversation_uuid, since, opts)
1108
+
1109
+ Retrieve conversation messages
1110
+
1111
+ Retrieve conversation messages since a particular time
1112
+
1113
+ ### Example
1114
+ ```javascript
1115
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
1116
+
1117
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1118
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
1119
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1120
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
1121
+
1122
+
1123
+ var conversation_uuid = "conversation_uuid_example"; // String |
1124
+
1125
+ var since = 789; // Number |
1126
+
1127
+ var opts = {
1128
+ 'limit': 56 // Number |
1129
+ };
1130
+
1131
+ var callback = function(error, data, response) {
1132
+ if (error) {
1133
+ console.error(error);
1134
+ } else {
1135
+ console.log('API called successfully. Returned data: ' + data);
1136
+ }
1137
+ };
1138
+ apiInstance.getConversationMessages(conversation_uuid, since, opts, callback);
1139
+ ```
1140
+
1141
+ ### Parameters
1142
+
1143
+ Name | Type | Description | Notes
1144
+ ------------- | ------------- | ------------- | -------------
1145
+ **conversation_uuid** | **String**| |
1146
+ **since** | **Number**| |
1147
+ **limit** | **Number**| | [optional]
1148
+
1149
+ ### Return type
1150
+
1151
+ [**ConversationMessagesResponse**](ConversationMessagesResponse.md)
1152
+
1153
+ ### Authorization
1154
+
1155
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1156
+
1157
+ ### HTTP request headers
1158
+
1159
+ - **Content-Type**: application/json
1160
+ - **Accept**: application/json
1161
+
1162
+ <a name="getConversationMultimediaUploadUrl"></a>
1163
+ # **getConversationMultimediaUploadUrl**
1164
+ > ConversationMultimediaUploadUrlResponse getConversationMultimediaUploadUrl(extension)
1165
+
1166
+ Get a presigned conversation multimedia upload URL
1167
+
1168
+ Get a presigned conversation multimedia upload URL
1169
+
1170
+ ### Example
1171
+ ```javascript
1172
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
1173
+
1174
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1175
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
1176
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1177
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
1178
+
1179
+
1180
+ var extension = "extension_example"; // String |
1181
+
1182
+
1183
+ var callback = function(error, data, response) {
1184
+ if (error) {
1185
+ console.error(error);
1186
+ } else {
1187
+ console.log('API called successfully. Returned data: ' + data);
1188
+ }
1189
+ };
1190
+ apiInstance.getConversationMultimediaUploadUrl(extension, callback);
1191
+ ```
1192
+
1193
+ ### Parameters
1194
+
1195
+ Name | Type | Description | Notes
1196
+ ------------- | ------------- | ------------- | -------------
1197
+ **extension** | **String**| |
1198
+
1199
+ ### Return type
1200
+
1201
+ [**ConversationMultimediaUploadUrlResponse**](ConversationMultimediaUploadUrlResponse.md)
1202
+
1203
+ ### Authorization
1204
+
1205
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1206
+
1207
+ ### HTTP request headers
1208
+
1209
+ - **Content-Type**: application/json
1210
+ - **Accept**: application/json
1211
+
1212
+ <a name="getConversationPbxAudioUploadUrl"></a>
1213
+ # **getConversationPbxAudioUploadUrl**
1214
+ > ConversationMultimediaUploadUrlResponse getConversationPbxAudioUploadUrl(extension)
1215
+
1216
+ Get a pre-signed conversation multimedia upload URL
1217
+
1218
+ Get a pre-signed conversation multimedia upload URL
1219
+
1220
+ ### Example
1221
+ ```javascript
1222
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
1223
+
1224
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1225
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
1226
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1227
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
1228
+
1229
+
1230
+ var extension = "extension_example"; // String |
1231
+
1232
+
1233
+ var callback = function(error, data, response) {
1234
+ if (error) {
1235
+ console.error(error);
1236
+ } else {
1237
+ console.log('API called successfully. Returned data: ' + data);
1238
+ }
1239
+ };
1240
+ apiInstance.getConversationPbxAudioUploadUrl(extension, callback);
1241
+ ```
1242
+
1243
+ ### Parameters
1244
+
1245
+ Name | Type | Description | Notes
1246
+ ------------- | ------------- | ------------- | -------------
1247
+ **extension** | **String**| |
1248
+
1249
+ ### Return type
1250
+
1251
+ [**ConversationMultimediaUploadUrlResponse**](ConversationMultimediaUploadUrlResponse.md)
1252
+
1253
+ ### Authorization
1254
+
1255
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1256
+
1257
+ ### HTTP request headers
1258
+
1259
+ - **Content-Type**: application/json
1260
+ - **Accept**: application/json
1261
+
1262
+ <a name="getConversationPbxCustomerSnapshot"></a>
1263
+ # **getConversationPbxCustomerSnapshot**
1264
+ > ConversationPbxCustomerSnapshotResponse getConversationPbxCustomerSnapshot(pbx_customer_snapshot_request)
1265
+
1266
+ Get orders and customer information for a phone number
1267
+
1268
+ Retrieves all the orders, auto orders, and customer profile for a given phone number
1269
+
1270
+ ### Example
1271
+ ```javascript
1272
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
1273
+
1274
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1275
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
1276
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1277
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
1278
+
1279
+
1280
+ var pbx_customer_snapshot_request = new UltraCartRestApiV2.ConversationPbxCustomerSnapshotRequest(); // ConversationPbxCustomerSnapshotRequest | Conversation pbx customer snapshot request
1281
+
1282
+
1283
+ var callback = function(error, data, response) {
1284
+ if (error) {
1285
+ console.error(error);
1286
+ } else {
1287
+ console.log('API called successfully. Returned data: ' + data);
1288
+ }
1289
+ };
1290
+ apiInstance.getConversationPbxCustomerSnapshot(pbx_customer_snapshot_request, callback);
1291
+ ```
1292
+
1293
+ ### Parameters
1294
+
1295
+ Name | Type | Description | Notes
1296
+ ------------- | ------------- | ------------- | -------------
1297
+ **pbx_customer_snapshot_request** | [**ConversationPbxCustomerSnapshotRequest**](ConversationPbxCustomerSnapshotRequest.md)| Conversation pbx customer snapshot request |
1298
+
1299
+ ### Return type
1300
+
1301
+ [**ConversationPbxCustomerSnapshotResponse**](ConversationPbxCustomerSnapshotResponse.md)
1302
+
1303
+ ### Authorization
1304
+
1305
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1306
+
1307
+ ### HTTP request headers
1308
+
1309
+ - **Content-Type**: application/json
1310
+ - **Accept**: application/json
1311
+
1312
+ <a name="getConversationPermissions"></a>
1313
+ # **getConversationPermissions**
1314
+ > ConversationPermissionsResponse getConversationPermissions()
1315
+
1316
+ Retrieve conversation permissions
1317
+
1318
+ Retrieve conversation permissions
1319
+
1320
+ ### Example
1321
+ ```javascript
1322
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
1323
+
1324
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1325
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
1326
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1327
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
1328
+
1329
+
1330
+
1331
+ var callback = function(error, data, response) {
1332
+ if (error) {
1333
+ console.error(error);
1334
+ } else {
1335
+ console.log('API called successfully. Returned data: ' + data);
1336
+ }
1337
+ };
1338
+ apiInstance.getConversationPermissions(callback);
1339
+ ```
1340
+
1341
+ ### Parameters
1342
+ This endpoint does not need any parameter.
1343
+
1344
+ ### Return type
1345
+
1346
+ [**ConversationPermissionsResponse**](ConversationPermissionsResponse.md)
1347
+
1348
+ ### Authorization
1349
+
1350
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1351
+
1352
+ ### HTTP request headers
1353
+
1354
+ - **Content-Type**: application/json
1355
+ - **Accept**: application/json
1356
+
1357
+ <a name="getConversationWebchatQueueStatuses"></a>
1358
+ # **getConversationWebchatQueueStatuses**
1359
+ > ConversationWebchatQueueStatusesResponse getConversationWebchatQueueStatuses()
1360
+
1361
+ Retrieve a conversation webchat queue statuses
1362
+
1363
+ Retrieve a conversation webchat queue statuses including agent status and queue entries
1364
+
1365
+ ### Example
1366
+ ```javascript
1367
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
1368
+
1369
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1370
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
1371
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1372
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
1373
+
1374
+
1375
+
1376
+ var callback = function(error, data, response) {
1377
+ if (error) {
1378
+ console.error(error);
1379
+ } else {
1380
+ console.log('API called successfully. Returned data: ' + data);
1381
+ }
1382
+ };
1383
+ apiInstance.getConversationWebchatQueueStatuses(callback);
1384
+ ```
1385
+
1386
+ ### Parameters
1387
+ This endpoint does not need any parameter.
1388
+
1389
+ ### Return type
1390
+
1391
+ [**ConversationWebchatQueueStatusesResponse**](ConversationWebchatQueueStatusesResponse.md)
1392
+
1393
+ ### Authorization
1394
+
1395
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1396
+
1397
+ ### HTTP request headers
1398
+
1399
+ - **Content-Type**: application/json
1400
+ - **Accept**: application/json
1401
+
1402
+ <a name="getConversations"></a>
1403
+ # **getConversations**
1404
+ > ConversationsResponse getConversations(opts)
1405
+
1406
+ Retrieve a list of conversation summaries newest to oldest
1407
+
1408
+ Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
1409
+
1410
+ ### Example
1411
+ ```javascript
1412
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
1413
+
1414
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1415
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
1416
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1417
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
1418
+
1419
+
1420
+ var opts = {
1421
+ 'medium': "medium_example", // String |
1422
+ 'before': "before_example", // String |
1423
+ '_limit': 100, // Number | The maximum number of records to return on this one API call. (Max 200)
1424
+ '_offset': 0 // Number | Pagination of the record set. Offset is a zero based index.
1425
+ };
1426
+
1427
+ var callback = function(error, data, response) {
1428
+ if (error) {
1429
+ console.error(error);
1430
+ } else {
1431
+ console.log('API called successfully. Returned data: ' + data);
1432
+ }
1433
+ };
1434
+ apiInstance.getConversations(opts, callback);
1435
+ ```
1436
+
1437
+ ### Parameters
1438
+
1439
+ Name | Type | Description | Notes
1440
+ ------------- | ------------- | ------------- | -------------
1441
+ **medium** | **String**| | [optional]
1442
+ **before** | **String**| | [optional]
1443
+ **_limit** | **Number**| The maximum number of records to return on this one API call. (Max 200) | [optional] [default to 100]
1444
+ **_offset** | **Number**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
1445
+
1446
+ ### Return type
1447
+
1448
+ [**ConversationsResponse**](ConversationsResponse.md)
1449
+
1450
+ ### Authorization
1451
+
1452
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1453
+
1454
+ ### HTTP request headers
1455
+
1456
+ - **Content-Type**: application/json
1457
+ - **Accept**: application/json
1458
+
1459
+ <a name="getConversationsAutocomplete"></a>
1460
+ # **getConversationsAutocomplete**
1461
+ > ConversationAutocompleteResponse getConversationsAutocomplete(autocomplete_request)
1462
+
1463
+ Retrieve a list of matching terms for a search field
1464
+
1465
+ Retrieve a list of matching terms for a search field
1466
+
1467
+ ### Example
1468
+ ```javascript
1469
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
1470
+
1471
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1472
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
1473
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1474
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
1475
+
1476
+
1477
+ var autocomplete_request = new UltraCartRestApiV2.ConversationAutocompleteRequest(); // ConversationAutocompleteRequest | Autocomplete Request
1478
+
1479
+
1480
+ var callback = function(error, data, response) {
1481
+ if (error) {
1482
+ console.error(error);
1483
+ } else {
1484
+ console.log('API called successfully. Returned data: ' + data);
1485
+ }
1486
+ };
1487
+ apiInstance.getConversationsAutocomplete(autocomplete_request, callback);
1488
+ ```
1489
+
1490
+ ### Parameters
1491
+
1492
+ Name | Type | Description | Notes
1493
+ ------------- | ------------- | ------------- | -------------
1494
+ **autocomplete_request** | [**ConversationAutocompleteRequest**](ConversationAutocompleteRequest.md)| Autocomplete Request |
1495
+
1496
+ ### Return type
1497
+
1498
+ [**ConversationAutocompleteResponse**](ConversationAutocompleteResponse.md)
1499
+
1500
+ ### Authorization
1501
+
1502
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1503
+
1504
+ ### HTTP request headers
1505
+
1506
+ - **Content-Type**: application/json
1507
+ - **Accept**: application/json
1508
+
1509
+ <a name="getConversationsSearch"></a>
1510
+ # **getConversationsSearch**
1511
+ > ConversationSearchResponse getConversationsSearch(search_request)
1512
+
1513
+ Search conversations
1514
+
1515
+ Search conversations
1516
+
1517
+ ### Example
1518
+ ```javascript
1519
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
1520
+
1521
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1522
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
1523
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1524
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
1525
+
1526
+
1527
+ var search_request = new UltraCartRestApiV2.ConversationSearchRequest(); // ConversationSearchRequest | Search Request
1528
+
1529
+
1530
+ var callback = function(error, data, response) {
1531
+ if (error) {
1532
+ console.error(error);
1533
+ } else {
1534
+ console.log('API called successfully. Returned data: ' + data);
1535
+ }
1536
+ };
1537
+ apiInstance.getConversationsSearch(search_request, callback);
1538
+ ```
1539
+
1540
+ ### Parameters
1541
+
1542
+ Name | Type | Description | Notes
1543
+ ------------- | ------------- | ------------- | -------------
1544
+ **search_request** | [**ConversationSearchRequest**](ConversationSearchRequest.md)| Search Request |
1545
+
1546
+ ### Return type
1547
+
1548
+ [**ConversationSearchResponse**](ConversationSearchResponse.md)
1549
+
1550
+ ### Authorization
1551
+
1552
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1553
+
1554
+ ### HTTP request headers
1555
+
1556
+ - **Content-Type**: application/json
1557
+ - **Accept**: application/json
1558
+
1559
+ <a name="getLocationsForEngagement"></a>
1560
+ # **getLocationsForEngagement**
1561
+ > ConversationLocationsResponse getLocationsForEngagement()
1562
+
1563
+ Get location data for engagement configuration
1564
+
1565
+ Get location data for engagement configuration
1566
+
1567
+ ### Example
1568
+ ```javascript
1569
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
1570
+
1571
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1572
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
1573
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1574
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
1575
+
1576
+
1577
+
1578
+ var callback = function(error, data, response) {
1579
+ if (error) {
1580
+ console.error(error);
1581
+ } else {
1582
+ console.log('API called successfully. Returned data: ' + data);
1583
+ }
1584
+ };
1585
+ apiInstance.getLocationsForEngagement(callback);
1586
+ ```
1587
+
1588
+ ### Parameters
1589
+ This endpoint does not need any parameter.
1590
+
1591
+ ### Return type
1592
+
1593
+ [**ConversationLocationsResponse**](ConversationLocationsResponse.md)
1594
+
1595
+ ### Authorization
1596
+
1597
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1598
+
1599
+ ### HTTP request headers
1600
+
1601
+ - **Content-Type**: application/json
1602
+ - **Accept**: application/json
1603
+
1604
+ <a name="getPbxAgent"></a>
1605
+ # **getPbxAgent**
1606
+ > ConversationPbxAgentResponse getPbxAgent(conversationPbxAgentUuid)
1607
+
1608
+ Get pbx agent
1609
+
1610
+ Retrieve a pbx agent
1611
+
1612
+ ### Example
1613
+ ```javascript
1614
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
1615
+
1616
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1617
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
1618
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1619
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
1620
+
1621
+
1622
+ var conversationPbxAgentUuid = "conversationPbxAgentUuid_example"; // String |
1623
+
1624
+
1625
+ var callback = function(error, data, response) {
1626
+ if (error) {
1627
+ console.error(error);
1628
+ } else {
1629
+ console.log('API called successfully. Returned data: ' + data);
1630
+ }
1631
+ };
1632
+ apiInstance.getPbxAgent(conversationPbxAgentUuid, callback);
1633
+ ```
1634
+
1635
+ ### Parameters
1636
+
1637
+ Name | Type | Description | Notes
1638
+ ------------- | ------------- | ------------- | -------------
1639
+ **conversationPbxAgentUuid** | **String**| |
1640
+
1641
+ ### Return type
1642
+
1643
+ [**ConversationPbxAgentResponse**](ConversationPbxAgentResponse.md)
1644
+
1645
+ ### Authorization
1646
+
1647
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1648
+
1649
+ ### HTTP request headers
1650
+
1651
+ - **Content-Type**: application/json
1652
+ - **Accept**: application/json
1653
+
1654
+ <a name="getPbxAgents"></a>
1655
+ # **getPbxAgents**
1656
+ > ConversationPbxAgentsResponse getPbxAgents()
1657
+
1658
+ Get pbx agents
1659
+
1660
+ Retrieve pbx agents
1661
+
1662
+ ### Example
1663
+ ```javascript
1664
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
1665
+
1666
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1667
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
1668
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1669
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
1670
+
1671
+
1672
+
1673
+ var callback = function(error, data, response) {
1674
+ if (error) {
1675
+ console.error(error);
1676
+ } else {
1677
+ console.log('API called successfully. Returned data: ' + data);
1678
+ }
1679
+ };
1680
+ apiInstance.getPbxAgents(callback);
1681
+ ```
1682
+
1683
+ ### Parameters
1684
+ This endpoint does not need any parameter.
1685
+
1686
+ ### Return type
1687
+
1688
+ [**ConversationPbxAgentsResponse**](ConversationPbxAgentsResponse.md)
1689
+
1690
+ ### Authorization
1691
+
1692
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1693
+
1694
+ ### HTTP request headers
1695
+
1696
+ - **Content-Type**: application/json
1697
+ - **Accept**: application/json
1698
+
1699
+ <a name="getPbxAudio"></a>
1700
+ # **getPbxAudio**
1701
+ > ConversationPbxAudioResponse getPbxAudio(conversationPbxAudioUuid)
1702
+
1703
+ Get pbx audio
1704
+
1705
+ Retrieve a pbx audio
1706
+
1707
+ ### Example
1708
+ ```javascript
1709
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
1710
+
1711
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1712
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
1713
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1714
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
1715
+
1716
+
1717
+ var conversationPbxAudioUuid = "conversationPbxAudioUuid_example"; // String |
1718
+
1719
+
1720
+ var callback = function(error, data, response) {
1721
+ if (error) {
1722
+ console.error(error);
1723
+ } else {
1724
+ console.log('API called successfully. Returned data: ' + data);
1725
+ }
1726
+ };
1727
+ apiInstance.getPbxAudio(conversationPbxAudioUuid, callback);
1728
+ ```
1729
+
1730
+ ### Parameters
1731
+
1732
+ Name | Type | Description | Notes
1733
+ ------------- | ------------- | ------------- | -------------
1734
+ **conversationPbxAudioUuid** | **String**| |
1735
+
1736
+ ### Return type
1737
+
1738
+ [**ConversationPbxAudioResponse**](ConversationPbxAudioResponse.md)
1739
+
1740
+ ### Authorization
1741
+
1742
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1743
+
1744
+ ### HTTP request headers
1745
+
1746
+ - **Content-Type**: application/json
1747
+ - **Accept**: application/json
1748
+
1749
+ <a name="getPbxAudios"></a>
1750
+ # **getPbxAudios**
1751
+ > ConversationPbxAudiosResponse getPbxAudios()
1752
+
1753
+ Get pbx audios
1754
+
1755
+ Retrieve pbx audios
1756
+
1757
+ ### Example
1758
+ ```javascript
1759
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
1760
+
1761
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1762
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
1763
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1764
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
1765
+
1766
+
1767
+
1768
+ var callback = function(error, data, response) {
1769
+ if (error) {
1770
+ console.error(error);
1771
+ } else {
1772
+ console.log('API called successfully. Returned data: ' + data);
1773
+ }
1774
+ };
1775
+ apiInstance.getPbxAudios(callback);
1776
+ ```
1777
+
1778
+ ### Parameters
1779
+ This endpoint does not need any parameter.
1780
+
1781
+ ### Return type
1782
+
1783
+ [**ConversationPbxAudiosResponse**](ConversationPbxAudiosResponse.md)
1784
+
1785
+ ### Authorization
1786
+
1787
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1788
+
1789
+ ### HTTP request headers
1790
+
1791
+ - **Content-Type**: application/json
1792
+ - **Accept**: application/json
1793
+
1794
+ <a name="getPbxMenu"></a>
1795
+ # **getPbxMenu**
1796
+ > ConversationPbxMenuResponse getPbxMenu(conversationPbxMenuUuid)
1797
+
1798
+ Get pbx menu
1799
+
1800
+ Retrieve a pbx menu
1801
+
1802
+ ### Example
1803
+ ```javascript
1804
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
1805
+
1806
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1807
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
1808
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1809
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
1810
+
1811
+
1812
+ var conversationPbxMenuUuid = "conversationPbxMenuUuid_example"; // String |
1813
+
1814
+
1815
+ var callback = function(error, data, response) {
1816
+ if (error) {
1817
+ console.error(error);
1818
+ } else {
1819
+ console.log('API called successfully. Returned data: ' + data);
1820
+ }
1821
+ };
1822
+ apiInstance.getPbxMenu(conversationPbxMenuUuid, callback);
1823
+ ```
1824
+
1825
+ ### Parameters
1826
+
1827
+ Name | Type | Description | Notes
1828
+ ------------- | ------------- | ------------- | -------------
1829
+ **conversationPbxMenuUuid** | **String**| |
1830
+
1831
+ ### Return type
1832
+
1833
+ [**ConversationPbxMenuResponse**](ConversationPbxMenuResponse.md)
1834
+
1835
+ ### Authorization
1836
+
1837
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1838
+
1839
+ ### HTTP request headers
1840
+
1841
+ - **Content-Type**: application/json
1842
+ - **Accept**: application/json
1843
+
1844
+ <a name="getPbxMenus"></a>
1845
+ # **getPbxMenus**
1846
+ > ConversationPbxMenusResponse getPbxMenus()
1847
+
1848
+ Get pbx menus
1849
+
1850
+ Retrieve pbx menus
1851
+
1852
+ ### Example
1853
+ ```javascript
1854
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
1855
+
1856
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1857
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
1858
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1859
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
1860
+
1861
+
1862
+
1863
+ var callback = function(error, data, response) {
1864
+ if (error) {
1865
+ console.error(error);
1866
+ } else {
1867
+ console.log('API called successfully. Returned data: ' + data);
1868
+ }
1869
+ };
1870
+ apiInstance.getPbxMenus(callback);
1871
+ ```
1872
+
1873
+ ### Parameters
1874
+ This endpoint does not need any parameter.
1875
+
1876
+ ### Return type
1877
+
1878
+ [**ConversationPbxMenusResponse**](ConversationPbxMenusResponse.md)
1879
+
1880
+ ### Authorization
1881
+
1882
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1883
+
1884
+ ### HTTP request headers
1885
+
1886
+ - **Content-Type**: application/json
1887
+ - **Accept**: application/json
1888
+
1889
+ <a name="getPbxPhoneNumber"></a>
1890
+ # **getPbxPhoneNumber**
1891
+ > ConversationPbxPhoneNumberResponse getPbxPhoneNumber(conversationPbxPhoneNumberUuid)
1892
+
1893
+ Get pbx phoneNumber
1894
+
1895
+ Retrieve a pbx phoneNumber
1896
+
1897
+ ### Example
1898
+ ```javascript
1899
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
1900
+
1901
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1902
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
1903
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1904
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
1905
+
1906
+
1907
+ var conversationPbxPhoneNumberUuid = "conversationPbxPhoneNumberUuid_example"; // String |
1908
+
1909
+
1910
+ var callback = function(error, data, response) {
1911
+ if (error) {
1912
+ console.error(error);
1913
+ } else {
1914
+ console.log('API called successfully. Returned data: ' + data);
1915
+ }
1916
+ };
1917
+ apiInstance.getPbxPhoneNumber(conversationPbxPhoneNumberUuid, callback);
1918
+ ```
1919
+
1920
+ ### Parameters
1921
+
1922
+ Name | Type | Description | Notes
1923
+ ------------- | ------------- | ------------- | -------------
1924
+ **conversationPbxPhoneNumberUuid** | **String**| |
1925
+
1926
+ ### Return type
1927
+
1928
+ [**ConversationPbxPhoneNumberResponse**](ConversationPbxPhoneNumberResponse.md)
1929
+
1930
+ ### Authorization
1931
+
1932
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1933
+
1934
+ ### HTTP request headers
1935
+
1936
+ - **Content-Type**: application/json
1937
+ - **Accept**: application/json
1938
+
1939
+ <a name="getPbxPhoneNumbers"></a>
1940
+ # **getPbxPhoneNumbers**
1941
+ > ConversationPbxPhoneNumbersResponse getPbxPhoneNumbers()
1942
+
1943
+ Get pbx phoneNumbers
1944
+
1945
+ Retrieve pbx phoneNumbers
1946
+
1947
+ ### Example
1948
+ ```javascript
1949
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
1950
+
1951
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1952
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
1953
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1954
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
1955
+
1956
+
1957
+
1958
+ var callback = function(error, data, response) {
1959
+ if (error) {
1960
+ console.error(error);
1961
+ } else {
1962
+ console.log('API called successfully. Returned data: ' + data);
1963
+ }
1964
+ };
1965
+ apiInstance.getPbxPhoneNumbers(callback);
1966
+ ```
1967
+
1968
+ ### Parameters
1969
+ This endpoint does not need any parameter.
1970
+
1971
+ ### Return type
1972
+
1973
+ [**ConversationPbxPhoneNumbersResponse**](ConversationPbxPhoneNumbersResponse.md)
1974
+
1975
+ ### Authorization
1976
+
1977
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1978
+
1979
+ ### HTTP request headers
1980
+
1981
+ - **Content-Type**: application/json
1982
+ - **Accept**: application/json
1983
+
1984
+ <a name="getPbxQueue"></a>
1985
+ # **getPbxQueue**
1986
+ > ConversationPbxQueueResponse getPbxQueue(conversationPbxQueueUuid)
1987
+
1988
+ Get pbx queue
1989
+
1990
+ Retrieve a pbx queue
1991
+
1992
+ ### Example
1993
+ ```javascript
1994
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
1995
+
1996
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1997
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
1998
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1999
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
2000
+
2001
+
2002
+ var conversationPbxQueueUuid = "conversationPbxQueueUuid_example"; // String |
2003
+
2004
+
2005
+ var callback = function(error, data, response) {
2006
+ if (error) {
2007
+ console.error(error);
2008
+ } else {
2009
+ console.log('API called successfully. Returned data: ' + data);
2010
+ }
2011
+ };
2012
+ apiInstance.getPbxQueue(conversationPbxQueueUuid, callback);
2013
+ ```
2014
+
2015
+ ### Parameters
2016
+
2017
+ Name | Type | Description | Notes
2018
+ ------------- | ------------- | ------------- | -------------
2019
+ **conversationPbxQueueUuid** | **String**| |
2020
+
2021
+ ### Return type
2022
+
2023
+ [**ConversationPbxQueueResponse**](ConversationPbxQueueResponse.md)
2024
+
2025
+ ### Authorization
2026
+
2027
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2028
+
2029
+ ### HTTP request headers
2030
+
2031
+ - **Content-Type**: application/json
2032
+ - **Accept**: application/json
2033
+
2034
+ <a name="getPbxQueues"></a>
2035
+ # **getPbxQueues**
2036
+ > ConversationPbxQueuesResponse getPbxQueues()
2037
+
2038
+ Get pbx queues
2039
+
2040
+ Retrieve pbx queues
2041
+
2042
+ ### Example
2043
+ ```javascript
2044
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
2045
+
2046
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
2047
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
2048
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
2049
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
2050
+
2051
+
2052
+
2053
+ var callback = function(error, data, response) {
2054
+ if (error) {
2055
+ console.error(error);
2056
+ } else {
2057
+ console.log('API called successfully. Returned data: ' + data);
2058
+ }
2059
+ };
2060
+ apiInstance.getPbxQueues(callback);
2061
+ ```
2062
+
2063
+ ### Parameters
2064
+ This endpoint does not need any parameter.
2065
+
2066
+ ### Return type
2067
+
2068
+ [**ConversationPbxQueuesResponse**](ConversationPbxQueuesResponse.md)
2069
+
2070
+ ### Authorization
2071
+
2072
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2073
+
2074
+ ### HTTP request headers
2075
+
2076
+ - **Content-Type**: application/json
2077
+ - **Accept**: application/json
2078
+
2079
+ <a name="getPbxTimeBased"></a>
2080
+ # **getPbxTimeBased**
2081
+ > ConversationPbxTimeBasedResponse getPbxTimeBased(conversationPbxTimeBasedUuid)
2082
+
2083
+ Get pbx timeBased
2084
+
2085
+ Retrieve a pbx timeBased
2086
+
2087
+ ### Example
2088
+ ```javascript
2089
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
2090
+
2091
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
2092
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
2093
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
2094
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
2095
+
2096
+
2097
+ var conversationPbxTimeBasedUuid = "conversationPbxTimeBasedUuid_example"; // String |
2098
+
2099
+
2100
+ var callback = function(error, data, response) {
2101
+ if (error) {
2102
+ console.error(error);
2103
+ } else {
2104
+ console.log('API called successfully. Returned data: ' + data);
2105
+ }
2106
+ };
2107
+ apiInstance.getPbxTimeBased(conversationPbxTimeBasedUuid, callback);
2108
+ ```
2109
+
2110
+ ### Parameters
2111
+
2112
+ Name | Type | Description | Notes
2113
+ ------------- | ------------- | ------------- | -------------
2114
+ **conversationPbxTimeBasedUuid** | **String**| |
2115
+
2116
+ ### Return type
2117
+
2118
+ [**ConversationPbxTimeBasedResponse**](ConversationPbxTimeBasedResponse.md)
2119
+
2120
+ ### Authorization
2121
+
2122
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2123
+
2124
+ ### HTTP request headers
2125
+
2126
+ - **Content-Type**: application/json
2127
+ - **Accept**: application/json
2128
+
2129
+ <a name="getPbxTimeBaseds"></a>
2130
+ # **getPbxTimeBaseds**
2131
+ > ConversationPbxTimeBasedsResponse getPbxTimeBaseds()
2132
+
2133
+ Get pbx timeBaseds
2134
+
2135
+ Retrieve pbx timeBaseds
2136
+
2137
+ ### Example
2138
+ ```javascript
2139
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
2140
+
2141
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
2142
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
2143
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
2144
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
2145
+
2146
+
2147
+
2148
+ var callback = function(error, data, response) {
2149
+ if (error) {
2150
+ console.error(error);
2151
+ } else {
2152
+ console.log('API called successfully. Returned data: ' + data);
2153
+ }
2154
+ };
2155
+ apiInstance.getPbxTimeBaseds(callback);
2156
+ ```
2157
+
2158
+ ### Parameters
2159
+ This endpoint does not need any parameter.
2160
+
2161
+ ### Return type
2162
+
2163
+ [**ConversationPbxTimeBasedsResponse**](ConversationPbxTimeBasedsResponse.md)
2164
+
2165
+ ### Authorization
2166
+
2167
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2168
+
2169
+ ### HTTP request headers
2170
+
2171
+ - **Content-Type**: application/json
2172
+ - **Accept**: application/json
2173
+
2174
+ <a name="getPbxTimeRange"></a>
2175
+ # **getPbxTimeRange**
2176
+ > ConversationPbxTimeRangeResponse getPbxTimeRange(conversationPbxTimeRangeUuid)
2177
+
2178
+ Get pbx timeRange
2179
+
2180
+ Retrieve a pbx timeRange
2181
+
2182
+ ### Example
2183
+ ```javascript
2184
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
2185
+
2186
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
2187
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
2188
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
2189
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
2190
+
2191
+
2192
+ var conversationPbxTimeRangeUuid = "conversationPbxTimeRangeUuid_example"; // String |
2193
+
2194
+
2195
+ var callback = function(error, data, response) {
2196
+ if (error) {
2197
+ console.error(error);
2198
+ } else {
2199
+ console.log('API called successfully. Returned data: ' + data);
2200
+ }
2201
+ };
2202
+ apiInstance.getPbxTimeRange(conversationPbxTimeRangeUuid, callback);
2203
+ ```
2204
+
2205
+ ### Parameters
2206
+
2207
+ Name | Type | Description | Notes
2208
+ ------------- | ------------- | ------------- | -------------
2209
+ **conversationPbxTimeRangeUuid** | **String**| |
2210
+
2211
+ ### Return type
2212
+
2213
+ [**ConversationPbxTimeRangeResponse**](ConversationPbxTimeRangeResponse.md)
2214
+
2215
+ ### Authorization
2216
+
2217
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2218
+
2219
+ ### HTTP request headers
2220
+
2221
+ - **Content-Type**: application/json
2222
+ - **Accept**: application/json
2223
+
2224
+ <a name="getPbxTimeRanges"></a>
2225
+ # **getPbxTimeRanges**
2226
+ > ConversationPbxTimeRangesResponse getPbxTimeRanges()
2227
+
2228
+ Get pbx timeRanges
2229
+
2230
+ Retrieve pbx timeRanges
2231
+
2232
+ ### Example
2233
+ ```javascript
2234
+ var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
2235
+
2236
+ // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
2237
+ var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
2238
+ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
2239
+ var apiInstance = new UltraCartRestApiV2.ConversationApi();
2240
+
2241
+
2242
+
2243
+ var callback = function(error, data, response) {
2244
+ if (error) {
2245
+ console.error(error);
2246
+ } else {
2247
+ console.log('API called successfully. Returned data: ' + data);
2248
+ }
2249
+ };
2250
+ apiInstance.getPbxTimeRanges(callback);
2251
+ ```
2252
+
2253
+ ### Parameters
2254
+ This endpoint does not need any parameter.
2255
+
2256
+ ### Return type
2257
+
2258
+ [**ConversationPbxTimeRangesResponse**](ConversationPbxTimeRangesResponse.md)
2259
+
2260
+ ### Authorization
2261
+
2262
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
199
2263
 
200
- Called periodically by the conversation API to keep the session alive.
2264
+ ### HTTP request headers
2265
+
2266
+ - **Content-Type**: application/json
2267
+ - **Accept**: application/json
2268
+
2269
+ <a name="getPbxVoicemailMailbox"></a>
2270
+ # **getPbxVoicemailMailbox**
2271
+ > ConversationPbxVoicemailMailboxResponse getPbxVoicemailMailbox(conversationPbxVoicemailMailboxUuid)
2272
+
2273
+ Get pbx voicemailMailbox
2274
+
2275
+ Retrieve a pbx voicemailMailbox
201
2276
 
202
2277
  ### Example
203
2278
  ```javascript
@@ -209,23 +2284,28 @@ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
209
2284
  var apiInstance = new UltraCartRestApiV2.ConversationApi();
210
2285
 
211
2286
 
2287
+ var conversationPbxVoicemailMailboxUuid = "conversationPbxVoicemailMailboxUuid_example"; // String |
2288
+
212
2289
 
213
2290
  var callback = function(error, data, response) {
214
2291
  if (error) {
215
2292
  console.error(error);
216
2293
  } else {
217
- console.log('API called successfully.');
2294
+ console.log('API called successfully. Returned data: ' + data);
218
2295
  }
219
2296
  };
220
- apiInstance.getAgentKeepAlive(callback);
2297
+ apiInstance.getPbxVoicemailMailbox(conversationPbxVoicemailMailboxUuid, callback);
221
2298
  ```
222
2299
 
223
2300
  ### Parameters
224
- This endpoint does not need any parameter.
2301
+
2302
+ Name | Type | Description | Notes
2303
+ ------------- | ------------- | ------------- | -------------
2304
+ **conversationPbxVoicemailMailboxUuid** | **String**| |
225
2305
 
226
2306
  ### Return type
227
2307
 
228
- null (empty response body)
2308
+ [**ConversationPbxVoicemailMailboxResponse**](ConversationPbxVoicemailMailboxResponse.md)
229
2309
 
230
2310
  ### Authorization
231
2311
 
@@ -236,13 +2316,13 @@ null (empty response body)
236
2316
  - **Content-Type**: application/json
237
2317
  - **Accept**: application/json
238
2318
 
239
- <a name="getAgentProfile"></a>
240
- # **getAgentProfile**
241
- > ConversationAgentProfileResponse getAgentProfile()
2319
+ <a name="getPbxVoicemailMailboxes"></a>
2320
+ # **getPbxVoicemailMailboxes**
2321
+ > ConversationPbxVoicemailMailboxesResponse getPbxVoicemailMailboxes()
242
2322
 
243
- Get agent profile
2323
+ Get pbx voicemailMailboxes
244
2324
 
245
- Retrieve the agents profile
2325
+ Retrieve pbx voicemailMailboxes
246
2326
 
247
2327
  ### Example
248
2328
  ```javascript
@@ -262,7 +2342,7 @@ var callback = function(error, data, response) {
262
2342
  console.log('API called successfully. Returned data: ' + data);
263
2343
  }
264
2344
  };
265
- apiInstance.getAgentProfile(callback);
2345
+ apiInstance.getPbxVoicemailMailboxes(callback);
266
2346
  ```
267
2347
 
268
2348
  ### Parameters
@@ -270,7 +2350,7 @@ This endpoint does not need any parameter.
270
2350
 
271
2351
  ### Return type
272
2352
 
273
- [**ConversationAgentProfileResponse**](ConversationAgentProfileResponse.md)
2353
+ [**ConversationPbxVoicemailMailboxesResponse**](ConversationPbxVoicemailMailboxesResponse.md)
274
2354
 
275
2355
  ### Authorization
276
2356
 
@@ -281,13 +2361,13 @@ This endpoint does not need any parameter.
281
2361
  - **Content-Type**: application/json
282
2362
  - **Accept**: application/json
283
2363
 
284
- <a name="getAgentWebsocketAuthorization"></a>
285
- # **getAgentWebsocketAuthorization**
286
- > ConversationAgentAuthResponse getAgentWebsocketAuthorization()
2364
+ <a name="insertConversationCannedMessage"></a>
2365
+ # **insertConversationCannedMessage**
2366
+ > ConversationCannedMessageResponse insertConversationCannedMessage(canned_message)
287
2367
 
288
- Get agent websocket authorization
2368
+ Insert a canned message
289
2369
 
290
- Retrieve a JWT to authorize an agent to make a websocket connection.
2370
+ Insert a canned message
291
2371
 
292
2372
  ### Example
293
2373
  ```javascript
@@ -299,6 +2379,8 @@ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
299
2379
  var apiInstance = new UltraCartRestApiV2.ConversationApi();
300
2380
 
301
2381
 
2382
+ var canned_message = new UltraCartRestApiV2.ConversationCannedMessage(); // ConversationCannedMessage | Canned message
2383
+
302
2384
 
303
2385
  var callback = function(error, data, response) {
304
2386
  if (error) {
@@ -307,15 +2389,18 @@ var callback = function(error, data, response) {
307
2389
  console.log('API called successfully. Returned data: ' + data);
308
2390
  }
309
2391
  };
310
- apiInstance.getAgentWebsocketAuthorization(callback);
2392
+ apiInstance.insertConversationCannedMessage(canned_message, callback);
311
2393
  ```
312
2394
 
313
2395
  ### Parameters
314
- This endpoint does not need any parameter.
2396
+
2397
+ Name | Type | Description | Notes
2398
+ ------------- | ------------- | ------------- | -------------
2399
+ **canned_message** | [**ConversationCannedMessage**](ConversationCannedMessage.md)| Canned message |
315
2400
 
316
2401
  ### Return type
317
2402
 
318
- [**ConversationAgentAuthResponse**](ConversationAgentAuthResponse.md)
2403
+ [**ConversationCannedMessageResponse**](ConversationCannedMessageResponse.md)
319
2404
 
320
2405
  ### Authorization
321
2406
 
@@ -326,13 +2411,13 @@ This endpoint does not need any parameter.
326
2411
  - **Content-Type**: application/json
327
2412
  - **Accept**: application/json
328
2413
 
329
- <a name="getConversation"></a>
330
- # **getConversation**
331
- > ConversationResponse getConversation(conversation_uuid, opts)
2414
+ <a name="insertConversationDepartment"></a>
2415
+ # **insertConversationDepartment**
2416
+ > ConversationDepartmentResponse insertConversationDepartment(department)
332
2417
 
333
- Retrieve a conversation
2418
+ Insert a department
334
2419
 
335
- Retrieve a conversation including the participants and messages
2420
+ Insert a department
336
2421
 
337
2422
  ### Example
338
2423
  ```javascript
@@ -344,11 +2429,8 @@ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
344
2429
  var apiInstance = new UltraCartRestApiV2.ConversationApi();
345
2430
 
346
2431
 
347
- var conversation_uuid = "conversation_uuid_example"; // String |
2432
+ var department = new UltraCartRestApiV2.ConversationDepartment(); // ConversationDepartment | Department
348
2433
 
349
- var opts = {
350
- 'limit': 56 // Number |
351
- };
352
2434
 
353
2435
  var callback = function(error, data, response) {
354
2436
  if (error) {
@@ -357,19 +2439,18 @@ var callback = function(error, data, response) {
357
2439
  console.log('API called successfully. Returned data: ' + data);
358
2440
  }
359
2441
  };
360
- apiInstance.getConversation(conversation_uuid, opts, callback);
2442
+ apiInstance.insertConversationDepartment(department, callback);
361
2443
  ```
362
2444
 
363
2445
  ### Parameters
364
2446
 
365
2447
  Name | Type | Description | Notes
366
2448
  ------------- | ------------- | ------------- | -------------
367
- **conversation_uuid** | **String**| |
368
- **limit** | **Number**| | [optional]
2449
+ **department** | [**ConversationDepartment**](ConversationDepartment.md)| Department |
369
2450
 
370
2451
  ### Return type
371
2452
 
372
- [**ConversationResponse**](ConversationResponse.md)
2453
+ [**ConversationDepartmentResponse**](ConversationDepartmentResponse.md)
373
2454
 
374
2455
  ### Authorization
375
2456
 
@@ -380,13 +2461,13 @@ Name | Type | Description | Notes
380
2461
  - **Content-Type**: application/json
381
2462
  - **Accept**: application/json
382
2463
 
383
- <a name="getConversationCannedMessages"></a>
384
- # **getConversationCannedMessages**
385
- > ConversationCannedMessagesResponse getConversationCannedMessages()
2464
+ <a name="insertConversationEngagement"></a>
2465
+ # **insertConversationEngagement**
2466
+ > ConversationEngagementResponse insertConversationEngagement(engagement)
386
2467
 
387
- Retrieve a list of canned messages ordered by short_code
2468
+ Insert a engagement
388
2469
 
389
- Retrieve a list of canned messages ordered by short_code
2470
+ Insert a engagement
390
2471
 
391
2472
  ### Example
392
2473
  ```javascript
@@ -398,6 +2479,8 @@ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
398
2479
  var apiInstance = new UltraCartRestApiV2.ConversationApi();
399
2480
 
400
2481
 
2482
+ var engagement = new UltraCartRestApiV2.ConversationEngagement(); // ConversationEngagement | Engagement
2483
+
401
2484
 
402
2485
  var callback = function(error, data, response) {
403
2486
  if (error) {
@@ -406,15 +2489,18 @@ var callback = function(error, data, response) {
406
2489
  console.log('API called successfully. Returned data: ' + data);
407
2490
  }
408
2491
  };
409
- apiInstance.getConversationCannedMessages(callback);
2492
+ apiInstance.insertConversationEngagement(engagement, callback);
410
2493
  ```
411
2494
 
412
2495
  ### Parameters
413
- This endpoint does not need any parameter.
2496
+
2497
+ Name | Type | Description | Notes
2498
+ ------------- | ------------- | ------------- | -------------
2499
+ **engagement** | [**ConversationEngagement**](ConversationEngagement.md)| Engagement |
414
2500
 
415
2501
  ### Return type
416
2502
 
417
- [**ConversationCannedMessagesResponse**](ConversationCannedMessagesResponse.md)
2503
+ [**ConversationEngagementResponse**](ConversationEngagementResponse.md)
418
2504
 
419
2505
  ### Authorization
420
2506
 
@@ -425,13 +2511,13 @@ This endpoint does not need any parameter.
425
2511
  - **Content-Type**: application/json
426
2512
  - **Accept**: application/json
427
2513
 
428
- <a name="getConversationContext"></a>
429
- # **getConversationContext**
430
- > ConversationWebchatContext getConversationContext(conversation_uuid)
2514
+ <a name="insertPbxAgent"></a>
2515
+ # **insertPbxAgent**
2516
+ > ConversationPbxAgentResponse insertPbxAgent(pbx_agent)
431
2517
 
432
- Get a webchat conversation context
2518
+ Insert pbx agent
433
2519
 
434
- Get a webchat conversation context
2520
+ Insert a pbx agent
435
2521
 
436
2522
  ### Example
437
2523
  ```javascript
@@ -443,7 +2529,7 @@ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
443
2529
  var apiInstance = new UltraCartRestApiV2.ConversationApi();
444
2530
 
445
2531
 
446
- var conversation_uuid = "conversation_uuid_example"; // String |
2532
+ var pbx_agent = new UltraCartRestApiV2.ConversationPbxAgent(); // ConversationPbxAgent | Pbx Agent
447
2533
 
448
2534
 
449
2535
  var callback = function(error, data, response) {
@@ -453,18 +2539,18 @@ var callback = function(error, data, response) {
453
2539
  console.log('API called successfully. Returned data: ' + data);
454
2540
  }
455
2541
  };
456
- apiInstance.getConversationContext(conversation_uuid, callback);
2542
+ apiInstance.insertPbxAgent(pbx_agent, callback);
457
2543
  ```
458
2544
 
459
2545
  ### Parameters
460
2546
 
461
2547
  Name | Type | Description | Notes
462
2548
  ------------- | ------------- | ------------- | -------------
463
- **conversation_uuid** | **String**| |
2549
+ **pbx_agent** | [**ConversationPbxAgent**](ConversationPbxAgent.md)| Pbx Agent |
464
2550
 
465
2551
  ### Return type
466
2552
 
467
- [**ConversationWebchatContext**](ConversationWebchatContext.md)
2553
+ [**ConversationPbxAgentResponse**](ConversationPbxAgentResponse.md)
468
2554
 
469
2555
  ### Authorization
470
2556
 
@@ -475,13 +2561,13 @@ Name | Type | Description | Notes
475
2561
  - **Content-Type**: application/json
476
2562
  - **Accept**: application/json
477
2563
 
478
- <a name="getConversationDepartmentMemberList"></a>
479
- # **getConversationDepartmentMemberList**
480
- > ConversationDepartmentMembersResponse getConversationDepartmentMemberList()
2564
+ <a name="insertPbxAudio"></a>
2565
+ # **insertPbxAudio**
2566
+ > ConversationPbxAudioResponse insertPbxAudio(pbx_audio)
481
2567
 
482
- Retrieve a list of possible department members
2568
+ Insert pbx audio
483
2569
 
484
- Retrieve a list of possible department members
2570
+ Insert a pbx audio
485
2571
 
486
2572
  ### Example
487
2573
  ```javascript
@@ -493,6 +2579,8 @@ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
493
2579
  var apiInstance = new UltraCartRestApiV2.ConversationApi();
494
2580
 
495
2581
 
2582
+ var pbx_audio = new UltraCartRestApiV2.ConversationPbxAudio(); // ConversationPbxAudio | Pbx Audio
2583
+
496
2584
 
497
2585
  var callback = function(error, data, response) {
498
2586
  if (error) {
@@ -501,15 +2589,18 @@ var callback = function(error, data, response) {
501
2589
  console.log('API called successfully. Returned data: ' + data);
502
2590
  }
503
2591
  };
504
- apiInstance.getConversationDepartmentMemberList(callback);
2592
+ apiInstance.insertPbxAudio(pbx_audio, callback);
505
2593
  ```
506
2594
 
507
2595
  ### Parameters
508
- This endpoint does not need any parameter.
2596
+
2597
+ Name | Type | Description | Notes
2598
+ ------------- | ------------- | ------------- | -------------
2599
+ **pbx_audio** | [**ConversationPbxAudio**](ConversationPbxAudio.md)| Pbx Audio |
509
2600
 
510
2601
  ### Return type
511
2602
 
512
- [**ConversationDepartmentMembersResponse**](ConversationDepartmentMembersResponse.md)
2603
+ [**ConversationPbxAudioResponse**](ConversationPbxAudioResponse.md)
513
2604
 
514
2605
  ### Authorization
515
2606
 
@@ -520,13 +2611,13 @@ This endpoint does not need any parameter.
520
2611
  - **Content-Type**: application/json
521
2612
  - **Accept**: application/json
522
2613
 
523
- <a name="getConversationDepartments"></a>
524
- # **getConversationDepartments**
525
- > ConversationDepartmentsResponse getConversationDepartments()
2614
+ <a name="insertPbxMenu"></a>
2615
+ # **insertPbxMenu**
2616
+ > ConversationPbxMenuResponse insertPbxMenu(pbx_menu)
526
2617
 
527
- Retrieve a list of departments ordered by name
2618
+ Insert pbx menu
528
2619
 
529
- Retrieve a list of departments ordered by name
2620
+ Insert a pbx menu
530
2621
 
531
2622
  ### Example
532
2623
  ```javascript
@@ -538,6 +2629,8 @@ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
538
2629
  var apiInstance = new UltraCartRestApiV2.ConversationApi();
539
2630
 
540
2631
 
2632
+ var pbx_menu = new UltraCartRestApiV2.ConversationPbxMenu(); // ConversationPbxMenu | Pbx Menu
2633
+
541
2634
 
542
2635
  var callback = function(error, data, response) {
543
2636
  if (error) {
@@ -546,15 +2639,18 @@ var callback = function(error, data, response) {
546
2639
  console.log('API called successfully. Returned data: ' + data);
547
2640
  }
548
2641
  };
549
- apiInstance.getConversationDepartments(callback);
2642
+ apiInstance.insertPbxMenu(pbx_menu, callback);
550
2643
  ```
551
2644
 
552
2645
  ### Parameters
553
- This endpoint does not need any parameter.
2646
+
2647
+ Name | Type | Description | Notes
2648
+ ------------- | ------------- | ------------- | -------------
2649
+ **pbx_menu** | [**ConversationPbxMenu**](ConversationPbxMenu.md)| Pbx Menu |
554
2650
 
555
2651
  ### Return type
556
2652
 
557
- [**ConversationDepartmentsResponse**](ConversationDepartmentsResponse.md)
2653
+ [**ConversationPbxMenuResponse**](ConversationPbxMenuResponse.md)
558
2654
 
559
2655
  ### Authorization
560
2656
 
@@ -565,13 +2661,13 @@ This endpoint does not need any parameter.
565
2661
  - **Content-Type**: application/json
566
2662
  - **Accept**: application/json
567
2663
 
568
- <a name="getConversationEngagement"></a>
569
- # **getConversationEngagement**
570
- > ConversationEngagementResponse getConversationEngagement(conversation_engagement_oid)
2664
+ <a name="insertPbxPhoneNumber"></a>
2665
+ # **insertPbxPhoneNumber**
2666
+ > ConversationPbxPhoneNumberResponse insertPbxPhoneNumber(pbx_phoneNumber)
571
2667
 
572
- Retrieve an engagement
2668
+ Insert pbx phoneNumber
573
2669
 
574
- Retrieve an engagement
2670
+ Insert a pbx phoneNumber
575
2671
 
576
2672
  ### Example
577
2673
  ```javascript
@@ -583,7 +2679,7 @@ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
583
2679
  var apiInstance = new UltraCartRestApiV2.ConversationApi();
584
2680
 
585
2681
 
586
- var conversation_engagement_oid = 56; // Number |
2682
+ var pbx_phoneNumber = new UltraCartRestApiV2.ConversationPbxPhoneNumber(); // ConversationPbxPhoneNumber | Pbx PhoneNumber
587
2683
 
588
2684
 
589
2685
  var callback = function(error, data, response) {
@@ -593,18 +2689,18 @@ var callback = function(error, data, response) {
593
2689
  console.log('API called successfully. Returned data: ' + data);
594
2690
  }
595
2691
  };
596
- apiInstance.getConversationEngagement(conversation_engagement_oid, callback);
2692
+ apiInstance.insertPbxPhoneNumber(pbx_phoneNumber, callback);
597
2693
  ```
598
2694
 
599
2695
  ### Parameters
600
2696
 
601
2697
  Name | Type | Description | Notes
602
2698
  ------------- | ------------- | ------------- | -------------
603
- **conversation_engagement_oid** | **Number**| |
2699
+ **pbx_phoneNumber** | [**ConversationPbxPhoneNumber**](ConversationPbxPhoneNumber.md)| Pbx PhoneNumber |
604
2700
 
605
2701
  ### Return type
606
2702
 
607
- [**ConversationEngagementResponse**](ConversationEngagementResponse.md)
2703
+ [**ConversationPbxPhoneNumberResponse**](ConversationPbxPhoneNumberResponse.md)
608
2704
 
609
2705
  ### Authorization
610
2706
 
@@ -615,13 +2711,13 @@ Name | Type | Description | Notes
615
2711
  - **Content-Type**: application/json
616
2712
  - **Accept**: application/json
617
2713
 
618
- <a name="getConversationEngagements"></a>
619
- # **getConversationEngagements**
620
- > ConversationEngagementsResponse getConversationEngagements()
2714
+ <a name="insertPbxQueue"></a>
2715
+ # **insertPbxQueue**
2716
+ > ConversationPbxQueueResponse insertPbxQueue(pbx_queue)
621
2717
 
622
- Retrieve a list of engagements ordered by name
2718
+ Insert pbx queue
623
2719
 
624
- Retrieve a list of engagements ordered by name
2720
+ Insert a pbx queue
625
2721
 
626
2722
  ### Example
627
2723
  ```javascript
@@ -633,6 +2729,8 @@ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
633
2729
  var apiInstance = new UltraCartRestApiV2.ConversationApi();
634
2730
 
635
2731
 
2732
+ var pbx_queue = new UltraCartRestApiV2.ConversationPbxQueue(); // ConversationPbxQueue | Pbx Queue
2733
+
636
2734
 
637
2735
  var callback = function(error, data, response) {
638
2736
  if (error) {
@@ -641,15 +2739,18 @@ var callback = function(error, data, response) {
641
2739
  console.log('API called successfully. Returned data: ' + data);
642
2740
  }
643
2741
  };
644
- apiInstance.getConversationEngagements(callback);
2742
+ apiInstance.insertPbxQueue(pbx_queue, callback);
645
2743
  ```
646
2744
 
647
2745
  ### Parameters
648
- This endpoint does not need any parameter.
2746
+
2747
+ Name | Type | Description | Notes
2748
+ ------------- | ------------- | ------------- | -------------
2749
+ **pbx_queue** | [**ConversationPbxQueue**](ConversationPbxQueue.md)| Pbx Queue |
649
2750
 
650
2751
  ### Return type
651
2752
 
652
- [**ConversationEngagementsResponse**](ConversationEngagementsResponse.md)
2753
+ [**ConversationPbxQueueResponse**](ConversationPbxQueueResponse.md)
653
2754
 
654
2755
  ### Authorization
655
2756
 
@@ -660,13 +2761,13 @@ This endpoint does not need any parameter.
660
2761
  - **Content-Type**: application/json
661
2762
  - **Accept**: application/json
662
2763
 
663
- <a name="getConversationMessages"></a>
664
- # **getConversationMessages**
665
- > ConversationMessagesResponse getConversationMessages(conversation_uuid, since, opts)
2764
+ <a name="insertPbxTimeBased"></a>
2765
+ # **insertPbxTimeBased**
2766
+ > ConversationPbxTimeBasedResponse insertPbxTimeBased(pbx_timeBased)
666
2767
 
667
- Retrieve conversation messages
2768
+ Insert pbx timeBased
668
2769
 
669
- Retrieve conversation messages since a particular time
2770
+ Insert a pbx timeBased
670
2771
 
671
2772
  ### Example
672
2773
  ```javascript
@@ -678,13 +2779,8 @@ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
678
2779
  var apiInstance = new UltraCartRestApiV2.ConversationApi();
679
2780
 
680
2781
 
681
- var conversation_uuid = "conversation_uuid_example"; // String |
682
-
683
- var since = 789; // Number |
2782
+ var pbx_timeBased = new UltraCartRestApiV2.ConversationPbxTimeBased(); // ConversationPbxTimeBased | Pbx TimeBased
684
2783
 
685
- var opts = {
686
- 'limit': 56 // Number |
687
- };
688
2784
 
689
2785
  var callback = function(error, data, response) {
690
2786
  if (error) {
@@ -693,20 +2789,18 @@ var callback = function(error, data, response) {
693
2789
  console.log('API called successfully. Returned data: ' + data);
694
2790
  }
695
2791
  };
696
- apiInstance.getConversationMessages(conversation_uuid, since, opts, callback);
2792
+ apiInstance.insertPbxTimeBased(pbx_timeBased, callback);
697
2793
  ```
698
2794
 
699
2795
  ### Parameters
700
2796
 
701
2797
  Name | Type | Description | Notes
702
2798
  ------------- | ------------- | ------------- | -------------
703
- **conversation_uuid** | **String**| |
704
- **since** | **Number**| |
705
- **limit** | **Number**| | [optional]
2799
+ **pbx_timeBased** | [**ConversationPbxTimeBased**](ConversationPbxTimeBased.md)| Pbx TimeBased |
706
2800
 
707
2801
  ### Return type
708
2802
 
709
- [**ConversationMessagesResponse**](ConversationMessagesResponse.md)
2803
+ [**ConversationPbxTimeBasedResponse**](ConversationPbxTimeBasedResponse.md)
710
2804
 
711
2805
  ### Authorization
712
2806
 
@@ -717,13 +2811,13 @@ Name | Type | Description | Notes
717
2811
  - **Content-Type**: application/json
718
2812
  - **Accept**: application/json
719
2813
 
720
- <a name="getConversationMultimediaUploadUrl"></a>
721
- # **getConversationMultimediaUploadUrl**
722
- > ConversationMultimediaUploadUrlResponse getConversationMultimediaUploadUrl(extension)
2814
+ <a name="insertPbxTimeRange"></a>
2815
+ # **insertPbxTimeRange**
2816
+ > ConversationPbxTimeRangeResponse insertPbxTimeRange(pbx_timeRange)
723
2817
 
724
- Get a presigned conversation multimedia upload URL
2818
+ Insert pbx timeRange
725
2819
 
726
- Get a presigned conversation multimedia upload URL
2820
+ Insert a pbx timeRange
727
2821
 
728
2822
  ### Example
729
2823
  ```javascript
@@ -735,7 +2829,7 @@ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
735
2829
  var apiInstance = new UltraCartRestApiV2.ConversationApi();
736
2830
 
737
2831
 
738
- var extension = "extension_example"; // String |
2832
+ var pbx_timeRange = new UltraCartRestApiV2.ConversationPbxTimeRange(); // ConversationPbxTimeRange | Pbx TimeRange
739
2833
 
740
2834
 
741
2835
  var callback = function(error, data, response) {
@@ -745,18 +2839,18 @@ var callback = function(error, data, response) {
745
2839
  console.log('API called successfully. Returned data: ' + data);
746
2840
  }
747
2841
  };
748
- apiInstance.getConversationMultimediaUploadUrl(extension, callback);
2842
+ apiInstance.insertPbxTimeRange(pbx_timeRange, callback);
749
2843
  ```
750
2844
 
751
2845
  ### Parameters
752
2846
 
753
2847
  Name | Type | Description | Notes
754
2848
  ------------- | ------------- | ------------- | -------------
755
- **extension** | **String**| |
2849
+ **pbx_timeRange** | [**ConversationPbxTimeRange**](ConversationPbxTimeRange.md)| Pbx TimeRange |
756
2850
 
757
2851
  ### Return type
758
2852
 
759
- [**ConversationMultimediaUploadUrlResponse**](ConversationMultimediaUploadUrlResponse.md)
2853
+ [**ConversationPbxTimeRangeResponse**](ConversationPbxTimeRangeResponse.md)
760
2854
 
761
2855
  ### Authorization
762
2856
 
@@ -767,13 +2861,13 @@ Name | Type | Description | Notes
767
2861
  - **Content-Type**: application/json
768
2862
  - **Accept**: application/json
769
2863
 
770
- <a name="getConversationPermissions"></a>
771
- # **getConversationPermissions**
772
- > ConversationPermissionsResponse getConversationPermissions()
2864
+ <a name="insertPbxVoicemailMailbox"></a>
2865
+ # **insertPbxVoicemailMailbox**
2866
+ > ConversationPbxVoicemailMailboxResponse insertPbxVoicemailMailbox(pbx_voicemailMailbox)
773
2867
 
774
- Retrieve conversation permissions
2868
+ Insert pbx voicemailMailbox
775
2869
 
776
- Retrieve conversation permissions
2870
+ Insert a pbx voicemailMailbox
777
2871
 
778
2872
  ### Example
779
2873
  ```javascript
@@ -785,6 +2879,8 @@ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
785
2879
  var apiInstance = new UltraCartRestApiV2.ConversationApi();
786
2880
 
787
2881
 
2882
+ var pbx_voicemailMailbox = new UltraCartRestApiV2.ConversationPbxVoicemailMailbox(); // ConversationPbxVoicemailMailbox | Pbx VoicemailMailbox
2883
+
788
2884
 
789
2885
  var callback = function(error, data, response) {
790
2886
  if (error) {
@@ -793,15 +2889,18 @@ var callback = function(error, data, response) {
793
2889
  console.log('API called successfully. Returned data: ' + data);
794
2890
  }
795
2891
  };
796
- apiInstance.getConversationPermissions(callback);
2892
+ apiInstance.insertPbxVoicemailMailbox(pbx_voicemailMailbox, callback);
797
2893
  ```
798
2894
 
799
2895
  ### Parameters
800
- This endpoint does not need any parameter.
2896
+
2897
+ Name | Type | Description | Notes
2898
+ ------------- | ------------- | ------------- | -------------
2899
+ **pbx_voicemailMailbox** | [**ConversationPbxVoicemailMailbox**](ConversationPbxVoicemailMailbox.md)| Pbx VoicemailMailbox |
801
2900
 
802
2901
  ### Return type
803
2902
 
804
- [**ConversationPermissionsResponse**](ConversationPermissionsResponse.md)
2903
+ [**ConversationPbxVoicemailMailboxResponse**](ConversationPbxVoicemailMailboxResponse.md)
805
2904
 
806
2905
  ### Authorization
807
2906
 
@@ -812,13 +2911,13 @@ This endpoint does not need any parameter.
812
2911
  - **Content-Type**: application/json
813
2912
  - **Accept**: application/json
814
2913
 
815
- <a name="getConversationWebchatQueueStatuses"></a>
816
- # **getConversationWebchatQueueStatuses**
817
- > ConversationWebchatQueueStatusesResponse getConversationWebchatQueueStatuses()
2914
+ <a name="joinConversation"></a>
2915
+ # **joinConversation**
2916
+ > joinConversation(conversation_uuid, opts)
818
2917
 
819
- Retrieve a conversation webchat queue statuses
2918
+ Join a conversation
820
2919
 
821
- Retrieve a conversation webchat queue statuses including agent status and queue entries
2920
+ Join a conversation
822
2921
 
823
2922
  ### Example
824
2923
  ```javascript
@@ -830,23 +2929,32 @@ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
830
2929
  var apiInstance = new UltraCartRestApiV2.ConversationApi();
831
2930
 
832
2931
 
2932
+ var conversation_uuid = "conversation_uuid_example"; // String |
2933
+
2934
+ var opts = {
2935
+ 'join_request': new UltraCartRestApiV2.ConversationJoinRequest() // ConversationJoinRequest | Join request
2936
+ };
833
2937
 
834
2938
  var callback = function(error, data, response) {
835
2939
  if (error) {
836
2940
  console.error(error);
837
2941
  } else {
838
- console.log('API called successfully. Returned data: ' + data);
2942
+ console.log('API called successfully.');
839
2943
  }
840
2944
  };
841
- apiInstance.getConversationWebchatQueueStatuses(callback);
2945
+ apiInstance.joinConversation(conversation_uuid, opts, callback);
842
2946
  ```
843
2947
 
844
2948
  ### Parameters
845
- This endpoint does not need any parameter.
2949
+
2950
+ Name | Type | Description | Notes
2951
+ ------------- | ------------- | ------------- | -------------
2952
+ **conversation_uuid** | **String**| |
2953
+ **join_request** | [**ConversationJoinRequest**](ConversationJoinRequest.md)| Join request | [optional]
846
2954
 
847
2955
  ### Return type
848
2956
 
849
- [**ConversationWebchatQueueStatusesResponse**](ConversationWebchatQueueStatusesResponse.md)
2957
+ null (empty response body)
850
2958
 
851
2959
  ### Authorization
852
2960
 
@@ -857,13 +2965,13 @@ This endpoint does not need any parameter.
857
2965
  - **Content-Type**: application/json
858
2966
  - **Accept**: application/json
859
2967
 
860
- <a name="getConversations"></a>
861
- # **getConversations**
862
- > ConversationsResponse getConversations(opts)
2968
+ <a name="leaveConversation"></a>
2969
+ # **leaveConversation**
2970
+ > leaveConversation(conversation_uuid)
863
2971
 
864
- Retrieve a list of conversation summaries newest to oldest
2972
+ Leave a conversation
865
2973
 
866
- Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
2974
+ Leave a conversation
867
2975
 
868
2976
  ### Example
869
2977
  ```javascript
@@ -875,35 +2983,28 @@ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
875
2983
  var apiInstance = new UltraCartRestApiV2.ConversationApi();
876
2984
 
877
2985
 
878
- var opts = {
879
- 'medium': "medium_example", // String |
880
- 'before': "before_example", // String |
881
- '_limit': 100, // Number | The maximum number of records to return on this one API call. (Max 200)
882
- '_offset': 0 // Number | Pagination of the record set. Offset is a zero based index.
883
- };
2986
+ var conversation_uuid = "conversation_uuid_example"; // String |
2987
+
884
2988
 
885
2989
  var callback = function(error, data, response) {
886
2990
  if (error) {
887
2991
  console.error(error);
888
2992
  } else {
889
- console.log('API called successfully. Returned data: ' + data);
2993
+ console.log('API called successfully.');
890
2994
  }
891
2995
  };
892
- apiInstance.getConversations(opts, callback);
2996
+ apiInstance.leaveConversation(conversation_uuid, callback);
893
2997
  ```
894
2998
 
895
2999
  ### Parameters
896
3000
 
897
3001
  Name | Type | Description | Notes
898
3002
  ------------- | ------------- | ------------- | -------------
899
- **medium** | **String**| | [optional]
900
- **before** | **String**| | [optional]
901
- **_limit** | **Number**| The maximum number of records to return on this one API call. (Max 200) | [optional] [default to 100]
902
- **_offset** | **Number**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
3003
+ **conversation_uuid** | **String**| |
903
3004
 
904
3005
  ### Return type
905
3006
 
906
- [**ConversationsResponse**](ConversationsResponse.md)
3007
+ null (empty response body)
907
3008
 
908
3009
  ### Authorization
909
3010
 
@@ -914,13 +3015,13 @@ Name | Type | Description | Notes
914
3015
  - **Content-Type**: application/json
915
3016
  - **Accept**: application/json
916
3017
 
917
- <a name="getConversationsAutocomplete"></a>
918
- # **getConversationsAutocomplete**
919
- > ConversationAutocompleteResponse getConversationsAutocomplete(autocomplete_request)
3018
+ <a name="markReadConversation"></a>
3019
+ # **markReadConversation**
3020
+ > markReadConversation(conversation_uuid)
920
3021
 
921
- Retrieve a list of matching terms for a search field
3022
+ Mark a conversation as read
922
3023
 
923
- Retrieve a list of matching terms for a search field
3024
+ Mark a conversation as read
924
3025
 
925
3026
  ### Example
926
3027
  ```javascript
@@ -932,28 +3033,28 @@ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
932
3033
  var apiInstance = new UltraCartRestApiV2.ConversationApi();
933
3034
 
934
3035
 
935
- var autocomplete_request = new UltraCartRestApiV2.ConversationAutocompleteRequest(); // ConversationAutocompleteRequest | Autocomplete Request
3036
+ var conversation_uuid = "conversation_uuid_example"; // String |
936
3037
 
937
3038
 
938
3039
  var callback = function(error, data, response) {
939
3040
  if (error) {
940
3041
  console.error(error);
941
3042
  } else {
942
- console.log('API called successfully. Returned data: ' + data);
3043
+ console.log('API called successfully.');
943
3044
  }
944
3045
  };
945
- apiInstance.getConversationsAutocomplete(autocomplete_request, callback);
3046
+ apiInstance.markReadConversation(conversation_uuid, callback);
946
3047
  ```
947
3048
 
948
3049
  ### Parameters
949
3050
 
950
3051
  Name | Type | Description | Notes
951
3052
  ------------- | ------------- | ------------- | -------------
952
- **autocomplete_request** | [**ConversationAutocompleteRequest**](ConversationAutocompleteRequest.md)| Autocomplete Request |
3053
+ **conversation_uuid** | **String**| |
953
3054
 
954
3055
  ### Return type
955
3056
 
956
- [**ConversationAutocompleteResponse**](ConversationAutocompleteResponse.md)
3057
+ null (empty response body)
957
3058
 
958
3059
  ### Authorization
959
3060
 
@@ -964,13 +3065,13 @@ Name | Type | Description | Notes
964
3065
  - **Content-Type**: application/json
965
3066
  - **Accept**: application/json
966
3067
 
967
- <a name="getConversationsSearch"></a>
968
- # **getConversationsSearch**
969
- > ConversationSearchResponse getConversationsSearch(search_request)
3068
+ <a name="searchConversationCannedMessages"></a>
3069
+ # **searchConversationCannedMessages**
3070
+ > ConversationCannedMessagesResponse searchConversationCannedMessages(search_request)
970
3071
 
971
- Search conversations
3072
+ Search for canned messages by short_code
972
3073
 
973
- Search conversations
3074
+ Search for canned messages by short_code
974
3075
 
975
3076
  ### Example
976
3077
  ```javascript
@@ -982,7 +3083,7 @@ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
982
3083
  var apiInstance = new UltraCartRestApiV2.ConversationApi();
983
3084
 
984
3085
 
985
- var search_request = new UltraCartRestApiV2.ConversationSearchRequest(); // ConversationSearchRequest | Search Request
3086
+ var search_request = new UltraCartRestApiV2.ConversationCannedMessagesSearch(); // ConversationCannedMessagesSearch | Search request
986
3087
 
987
3088
 
988
3089
  var callback = function(error, data, response) {
@@ -992,18 +3093,18 @@ var callback = function(error, data, response) {
992
3093
  console.log('API called successfully. Returned data: ' + data);
993
3094
  }
994
3095
  };
995
- apiInstance.getConversationsSearch(search_request, callback);
3096
+ apiInstance.searchConversationCannedMessages(search_request, callback);
996
3097
  ```
997
3098
 
998
3099
  ### Parameters
999
3100
 
1000
3101
  Name | Type | Description | Notes
1001
3102
  ------------- | ------------- | ------------- | -------------
1002
- **search_request** | [**ConversationSearchRequest**](ConversationSearchRequest.md)| Search Request |
3103
+ **search_request** | [**ConversationCannedMessagesSearch**](ConversationCannedMessagesSearch.md)| Search request |
1003
3104
 
1004
3105
  ### Return type
1005
3106
 
1006
- [**ConversationSearchResponse**](ConversationSearchResponse.md)
3107
+ [**ConversationCannedMessagesResponse**](ConversationCannedMessagesResponse.md)
1007
3108
 
1008
3109
  ### Authorization
1009
3110
 
@@ -1014,13 +3115,13 @@ Name | Type | Description | Notes
1014
3115
  - **Content-Type**: application/json
1015
3116
  - **Accept**: application/json
1016
3117
 
1017
- <a name="getLocationsForEngagement"></a>
1018
- # **getLocationsForEngagement**
1019
- > ConversationLocationsResponse getLocationsForEngagement()
3118
+ <a name="smsUnsubscribeConversation"></a>
3119
+ # **smsUnsubscribeConversation**
3120
+ > smsUnsubscribeConversation(conversation_uuid)
1020
3121
 
1021
- Get location data for engagement configuration
3122
+ Unsubscribe any SMS participants in this conversation
1022
3123
 
1023
- Get location data for engagement configuration
3124
+ Unsubscribe any SMS participants in this conversation
1024
3125
 
1025
3126
  ### Example
1026
3127
  ```javascript
@@ -1032,23 +3133,28 @@ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1032
3133
  var apiInstance = new UltraCartRestApiV2.ConversationApi();
1033
3134
 
1034
3135
 
3136
+ var conversation_uuid = "conversation_uuid_example"; // String |
3137
+
1035
3138
 
1036
3139
  var callback = function(error, data, response) {
1037
3140
  if (error) {
1038
3141
  console.error(error);
1039
3142
  } else {
1040
- console.log('API called successfully. Returned data: ' + data);
3143
+ console.log('API called successfully.');
1041
3144
  }
1042
3145
  };
1043
- apiInstance.getLocationsForEngagement(callback);
3146
+ apiInstance.smsUnsubscribeConversation(conversation_uuid, callback);
1044
3147
  ```
1045
3148
 
1046
3149
  ### Parameters
1047
- This endpoint does not need any parameter.
3150
+
3151
+ Name | Type | Description | Notes
3152
+ ------------- | ------------- | ------------- | -------------
3153
+ **conversation_uuid** | **String**| |
1048
3154
 
1049
3155
  ### Return type
1050
3156
 
1051
- [**ConversationLocationsResponse**](ConversationLocationsResponse.md)
3157
+ null (empty response body)
1052
3158
 
1053
3159
  ### Authorization
1054
3160
 
@@ -1059,13 +3165,13 @@ This endpoint does not need any parameter.
1059
3165
  - **Content-Type**: application/json
1060
3166
  - **Accept**: application/json
1061
3167
 
1062
- <a name="insertConversationCannedMessage"></a>
1063
- # **insertConversationCannedMessage**
1064
- > ConversationCannedMessageResponse insertConversationCannedMessage(canned_message)
3168
+ <a name="startConversation"></a>
3169
+ # **startConversation**
3170
+ > ConversationStartResponse startConversation(start_request)
1065
3171
 
1066
- Insert a canned message
3172
+ Start a conversation
1067
3173
 
1068
- Insert a canned message
3174
+ Start a new conversation
1069
3175
 
1070
3176
  ### Example
1071
3177
  ```javascript
@@ -1077,7 +3183,7 @@ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1077
3183
  var apiInstance = new UltraCartRestApiV2.ConversationApi();
1078
3184
 
1079
3185
 
1080
- var canned_message = new UltraCartRestApiV2.ConversationCannedMessage(); // ConversationCannedMessage | Canned message
3186
+ var start_request = new UltraCartRestApiV2.ConversationStartRequest(); // ConversationStartRequest | Start request
1081
3187
 
1082
3188
 
1083
3189
  var callback = function(error, data, response) {
@@ -1087,18 +3193,18 @@ var callback = function(error, data, response) {
1087
3193
  console.log('API called successfully. Returned data: ' + data);
1088
3194
  }
1089
3195
  };
1090
- apiInstance.insertConversationCannedMessage(canned_message, callback);
3196
+ apiInstance.startConversation(start_request, callback);
1091
3197
  ```
1092
3198
 
1093
3199
  ### Parameters
1094
3200
 
1095
3201
  Name | Type | Description | Notes
1096
3202
  ------------- | ------------- | ------------- | -------------
1097
- **canned_message** | [**ConversationCannedMessage**](ConversationCannedMessage.md)| Canned message |
3203
+ **start_request** | [**ConversationStartRequest**](ConversationStartRequest.md)| Start request |
1098
3204
 
1099
3205
  ### Return type
1100
3206
 
1101
- [**ConversationCannedMessageResponse**](ConversationCannedMessageResponse.md)
3207
+ [**ConversationStartResponse**](ConversationStartResponse.md)
1102
3208
 
1103
3209
  ### Authorization
1104
3210
 
@@ -1109,13 +3215,13 @@ Name | Type | Description | Notes
1109
3215
  - **Content-Type**: application/json
1110
3216
  - **Accept**: application/json
1111
3217
 
1112
- <a name="insertConversationDepartment"></a>
1113
- # **insertConversationDepartment**
1114
- > ConversationDepartmentResponse insertConversationDepartment(department)
3218
+ <a name="updateAgentProfile"></a>
3219
+ # **updateAgentProfile**
3220
+ > ConversationAgentProfileResponse updateAgentProfile(profile_request)
1115
3221
 
1116
- Insert a department
3222
+ Update agent profile
1117
3223
 
1118
- Insert a department
3224
+ Update agent profile
1119
3225
 
1120
3226
  ### Example
1121
3227
  ```javascript
@@ -1127,7 +3233,7 @@ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1127
3233
  var apiInstance = new UltraCartRestApiV2.ConversationApi();
1128
3234
 
1129
3235
 
1130
- var department = new UltraCartRestApiV2.ConversationDepartment(); // ConversationDepartment | Department
3236
+ var profile_request = new UltraCartRestApiV2.ConversationAgentProfile(); // ConversationAgentProfile | Profile request
1131
3237
 
1132
3238
 
1133
3239
  var callback = function(error, data, response) {
@@ -1137,18 +3243,18 @@ var callback = function(error, data, response) {
1137
3243
  console.log('API called successfully. Returned data: ' + data);
1138
3244
  }
1139
3245
  };
1140
- apiInstance.insertConversationDepartment(department, callback);
3246
+ apiInstance.updateAgentProfile(profile_request, callback);
1141
3247
  ```
1142
3248
 
1143
3249
  ### Parameters
1144
3250
 
1145
3251
  Name | Type | Description | Notes
1146
3252
  ------------- | ------------- | ------------- | -------------
1147
- **department** | [**ConversationDepartment**](ConversationDepartment.md)| Department |
3253
+ **profile_request** | [**ConversationAgentProfile**](ConversationAgentProfile.md)| Profile request |
1148
3254
 
1149
3255
  ### Return type
1150
3256
 
1151
- [**ConversationDepartmentResponse**](ConversationDepartmentResponse.md)
3257
+ [**ConversationAgentProfileResponse**](ConversationAgentProfileResponse.md)
1152
3258
 
1153
3259
  ### Authorization
1154
3260
 
@@ -1159,13 +3265,13 @@ Name | Type | Description | Notes
1159
3265
  - **Content-Type**: application/json
1160
3266
  - **Accept**: application/json
1161
3267
 
1162
- <a name="insertConversationEngagement"></a>
1163
- # **insertConversationEngagement**
1164
- > ConversationEngagementResponse insertConversationEngagement(engagement)
3268
+ <a name="updateConversationCannedMessage"></a>
3269
+ # **updateConversationCannedMessage**
3270
+ > ConversationCannedMessageResponse updateConversationCannedMessage(conversation_canned_message_oid, canned_message)
1165
3271
 
1166
- Insert a engagement
3272
+ Update a canned message
1167
3273
 
1168
- Insert a engagement
3274
+ Update a canned message
1169
3275
 
1170
3276
  ### Example
1171
3277
  ```javascript
@@ -1177,7 +3283,9 @@ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1177
3283
  var apiInstance = new UltraCartRestApiV2.ConversationApi();
1178
3284
 
1179
3285
 
1180
- var engagement = new UltraCartRestApiV2.ConversationEngagement(); // ConversationEngagement | Engagement
3286
+ var conversation_canned_message_oid = 56; // Number |
3287
+
3288
+ var canned_message = new UltraCartRestApiV2.ConversationCannedMessage(); // ConversationCannedMessage | Canned message
1181
3289
 
1182
3290
 
1183
3291
  var callback = function(error, data, response) {
@@ -1187,18 +3295,19 @@ var callback = function(error, data, response) {
1187
3295
  console.log('API called successfully. Returned data: ' + data);
1188
3296
  }
1189
3297
  };
1190
- apiInstance.insertConversationEngagement(engagement, callback);
3298
+ apiInstance.updateConversationCannedMessage(conversation_canned_message_oid, canned_message, callback);
1191
3299
  ```
1192
3300
 
1193
3301
  ### Parameters
1194
3302
 
1195
3303
  Name | Type | Description | Notes
1196
3304
  ------------- | ------------- | ------------- | -------------
1197
- **engagement** | [**ConversationEngagement**](ConversationEngagement.md)| Engagement |
3305
+ **conversation_canned_message_oid** | **Number**| |
3306
+ **canned_message** | [**ConversationCannedMessage**](ConversationCannedMessage.md)| Canned message |
1198
3307
 
1199
3308
  ### Return type
1200
3309
 
1201
- [**ConversationEngagementResponse**](ConversationEngagementResponse.md)
3310
+ [**ConversationCannedMessageResponse**](ConversationCannedMessageResponse.md)
1202
3311
 
1203
3312
  ### Authorization
1204
3313
 
@@ -1209,13 +3318,13 @@ Name | Type | Description | Notes
1209
3318
  - **Content-Type**: application/json
1210
3319
  - **Accept**: application/json
1211
3320
 
1212
- <a name="joinConversation"></a>
1213
- # **joinConversation**
1214
- > joinConversation(conversation_uuid, opts)
3321
+ <a name="updateConversationDepartment"></a>
3322
+ # **updateConversationDepartment**
3323
+ > ConversationDepartmentResponse updateConversationDepartment(conversation_department_oid, department)
1215
3324
 
1216
- Join a conversation
3325
+ Update a department
1217
3326
 
1218
- Join a conversation
3327
+ Update a department
1219
3328
 
1220
3329
  ### Example
1221
3330
  ```javascript
@@ -1227,32 +3336,31 @@ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1227
3336
  var apiInstance = new UltraCartRestApiV2.ConversationApi();
1228
3337
 
1229
3338
 
1230
- var conversation_uuid = "conversation_uuid_example"; // String |
3339
+ var conversation_department_oid = 56; // Number |
3340
+
3341
+ var department = new UltraCartRestApiV2.ConversationDepartment(); // ConversationDepartment | Department
1231
3342
 
1232
- var opts = {
1233
- 'join_request': new UltraCartRestApiV2.ConversationJoinRequest() // ConversationJoinRequest | Join request
1234
- };
1235
3343
 
1236
3344
  var callback = function(error, data, response) {
1237
3345
  if (error) {
1238
3346
  console.error(error);
1239
3347
  } else {
1240
- console.log('API called successfully.');
3348
+ console.log('API called successfully. Returned data: ' + data);
1241
3349
  }
1242
3350
  };
1243
- apiInstance.joinConversation(conversation_uuid, opts, callback);
3351
+ apiInstance.updateConversationDepartment(conversation_department_oid, department, callback);
1244
3352
  ```
1245
3353
 
1246
3354
  ### Parameters
1247
3355
 
1248
3356
  Name | Type | Description | Notes
1249
3357
  ------------- | ------------- | ------------- | -------------
1250
- **conversation_uuid** | **String**| |
1251
- **join_request** | [**ConversationJoinRequest**](ConversationJoinRequest.md)| Join request | [optional]
3358
+ **conversation_department_oid** | **Number**| |
3359
+ **department** | [**ConversationDepartment**](ConversationDepartment.md)| Department |
1252
3360
 
1253
3361
  ### Return type
1254
3362
 
1255
- null (empty response body)
3363
+ [**ConversationDepartmentResponse**](ConversationDepartmentResponse.md)
1256
3364
 
1257
3365
  ### Authorization
1258
3366
 
@@ -1263,13 +3371,13 @@ null (empty response body)
1263
3371
  - **Content-Type**: application/json
1264
3372
  - **Accept**: application/json
1265
3373
 
1266
- <a name="leaveConversation"></a>
1267
- # **leaveConversation**
1268
- > leaveConversation(conversation_uuid)
3374
+ <a name="updateConversationEngagement"></a>
3375
+ # **updateConversationEngagement**
3376
+ > ConversationEngagementResponse updateConversationEngagement(conversation_engagement_oid, engagement)
1269
3377
 
1270
- Leave a conversation
3378
+ Update a engagement
1271
3379
 
1272
- Leave a conversation
3380
+ Update a engagement
1273
3381
 
1274
3382
  ### Example
1275
3383
  ```javascript
@@ -1281,28 +3389,31 @@ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1281
3389
  var apiInstance = new UltraCartRestApiV2.ConversationApi();
1282
3390
 
1283
3391
 
1284
- var conversation_uuid = "conversation_uuid_example"; // String |
3392
+ var conversation_engagement_oid = 56; // Number |
3393
+
3394
+ var engagement = new UltraCartRestApiV2.ConversationEngagement(); // ConversationEngagement | Engagement
1285
3395
 
1286
3396
 
1287
3397
  var callback = function(error, data, response) {
1288
3398
  if (error) {
1289
3399
  console.error(error);
1290
3400
  } else {
1291
- console.log('API called successfully.');
3401
+ console.log('API called successfully. Returned data: ' + data);
1292
3402
  }
1293
3403
  };
1294
- apiInstance.leaveConversation(conversation_uuid, callback);
3404
+ apiInstance.updateConversationEngagement(conversation_engagement_oid, engagement, callback);
1295
3405
  ```
1296
3406
 
1297
3407
  ### Parameters
1298
3408
 
1299
3409
  Name | Type | Description | Notes
1300
3410
  ------------- | ------------- | ------------- | -------------
1301
- **conversation_uuid** | **String**| |
3411
+ **conversation_engagement_oid** | **Number**| |
3412
+ **engagement** | [**ConversationEngagement**](ConversationEngagement.md)| Engagement |
1302
3413
 
1303
3414
  ### Return type
1304
3415
 
1305
- null (empty response body)
3416
+ [**ConversationEngagementResponse**](ConversationEngagementResponse.md)
1306
3417
 
1307
3418
  ### Authorization
1308
3419
 
@@ -1313,13 +3424,13 @@ null (empty response body)
1313
3424
  - **Content-Type**: application/json
1314
3425
  - **Accept**: application/json
1315
3426
 
1316
- <a name="markReadConversation"></a>
1317
- # **markReadConversation**
1318
- > markReadConversation(conversation_uuid)
3427
+ <a name="updateConversationWebchatQueueStatus"></a>
3428
+ # **updateConversationWebchatQueueStatus**
3429
+ > updateConversationWebchatQueueStatus(queue_name, status_request)
1319
3430
 
1320
- Mark a conversation as read
3431
+ Update status within the queue
1321
3432
 
1322
- Mark a conversation as read
3433
+ Update status within the queue
1323
3434
 
1324
3435
  ### Example
1325
3436
  ```javascript
@@ -1331,7 +3442,9 @@ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1331
3442
  var apiInstance = new UltraCartRestApiV2.ConversationApi();
1332
3443
 
1333
3444
 
1334
- var conversation_uuid = "conversation_uuid_example"; // String |
3445
+ var queue_name = "queue_name_example"; // String |
3446
+
3447
+ var status_request = new UltraCartRestApiV2.ConversationWebchatQueueStatusUpdateRequest(); // ConversationWebchatQueueStatusUpdateRequest | Status request
1335
3448
 
1336
3449
 
1337
3450
  var callback = function(error, data, response) {
@@ -1341,14 +3454,15 @@ var callback = function(error, data, response) {
1341
3454
  console.log('API called successfully.');
1342
3455
  }
1343
3456
  };
1344
- apiInstance.markReadConversation(conversation_uuid, callback);
3457
+ apiInstance.updateConversationWebchatQueueStatus(queue_name, status_request, callback);
1345
3458
  ```
1346
3459
 
1347
3460
  ### Parameters
1348
3461
 
1349
3462
  Name | Type | Description | Notes
1350
3463
  ------------- | ------------- | ------------- | -------------
1351
- **conversation_uuid** | **String**| |
3464
+ **queue_name** | **String**| |
3465
+ **status_request** | [**ConversationWebchatQueueStatusUpdateRequest**](ConversationWebchatQueueStatusUpdateRequest.md)| Status request |
1352
3466
 
1353
3467
  ### Return type
1354
3468
 
@@ -1363,13 +3477,13 @@ null (empty response body)
1363
3477
  - **Content-Type**: application/json
1364
3478
  - **Accept**: application/json
1365
3479
 
1366
- <a name="searchConversationCannedMessages"></a>
1367
- # **searchConversationCannedMessages**
1368
- > ConversationCannedMessagesResponse searchConversationCannedMessages(search_request)
3480
+ <a name="updatePbxAgent"></a>
3481
+ # **updatePbxAgent**
3482
+ > ConversationPbxAgentResponse updatePbxAgent(conversationPbxAgentUuid, pbx_agent)
1369
3483
 
1370
- Search for canned messages by short_code
3484
+ Update pbx agent
1371
3485
 
1372
- Search for canned messages by short_code
3486
+ Update a pbx agent
1373
3487
 
1374
3488
  ### Example
1375
3489
  ```javascript
@@ -1381,7 +3495,9 @@ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1381
3495
  var apiInstance = new UltraCartRestApiV2.ConversationApi();
1382
3496
 
1383
3497
 
1384
- var search_request = new UltraCartRestApiV2.ConversationCannedMessagesSearch(); // ConversationCannedMessagesSearch | Search request
3498
+ var conversationPbxAgentUuid = "conversationPbxAgentUuid_example"; // String |
3499
+
3500
+ var pbx_agent = new UltraCartRestApiV2.ConversationPbxAgent(); // ConversationPbxAgent | Pbx Agent
1385
3501
 
1386
3502
 
1387
3503
  var callback = function(error, data, response) {
@@ -1391,18 +3507,19 @@ var callback = function(error, data, response) {
1391
3507
  console.log('API called successfully. Returned data: ' + data);
1392
3508
  }
1393
3509
  };
1394
- apiInstance.searchConversationCannedMessages(search_request, callback);
3510
+ apiInstance.updatePbxAgent(conversationPbxAgentUuid, pbx_agent, callback);
1395
3511
  ```
1396
3512
 
1397
3513
  ### Parameters
1398
3514
 
1399
3515
  Name | Type | Description | Notes
1400
3516
  ------------- | ------------- | ------------- | -------------
1401
- **search_request** | [**ConversationCannedMessagesSearch**](ConversationCannedMessagesSearch.md)| Search request |
3517
+ **conversationPbxAgentUuid** | **String**| |
3518
+ **pbx_agent** | [**ConversationPbxAgent**](ConversationPbxAgent.md)| Pbx Agent |
1402
3519
 
1403
3520
  ### Return type
1404
3521
 
1405
- [**ConversationCannedMessagesResponse**](ConversationCannedMessagesResponse.md)
3522
+ [**ConversationPbxAgentResponse**](ConversationPbxAgentResponse.md)
1406
3523
 
1407
3524
  ### Authorization
1408
3525
 
@@ -1413,13 +3530,13 @@ Name | Type | Description | Notes
1413
3530
  - **Content-Type**: application/json
1414
3531
  - **Accept**: application/json
1415
3532
 
1416
- <a name="smsUnsubscribeConversation"></a>
1417
- # **smsUnsubscribeConversation**
1418
- > smsUnsubscribeConversation(conversation_uuid)
3533
+ <a name="updatePbxAudio"></a>
3534
+ # **updatePbxAudio**
3535
+ > ConversationPbxAudioResponse updatePbxAudio(conversationPbxAudioUuid, pbx_audio)
1419
3536
 
1420
- Unsubscribe any SMS participants in this conversation
3537
+ Update pbx audio
1421
3538
 
1422
- Unsubscribe any SMS participants in this conversation
3539
+ Update a pbx audio
1423
3540
 
1424
3541
  ### Example
1425
3542
  ```javascript
@@ -1431,28 +3548,31 @@ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1431
3548
  var apiInstance = new UltraCartRestApiV2.ConversationApi();
1432
3549
 
1433
3550
 
1434
- var conversation_uuid = "conversation_uuid_example"; // String |
3551
+ var conversationPbxAudioUuid = "conversationPbxAudioUuid_example"; // String |
3552
+
3553
+ var pbx_audio = new UltraCartRestApiV2.ConversationPbxAudio(); // ConversationPbxAudio | Pbx Audio
1435
3554
 
1436
3555
 
1437
3556
  var callback = function(error, data, response) {
1438
3557
  if (error) {
1439
3558
  console.error(error);
1440
3559
  } else {
1441
- console.log('API called successfully.');
3560
+ console.log('API called successfully. Returned data: ' + data);
1442
3561
  }
1443
3562
  };
1444
- apiInstance.smsUnsubscribeConversation(conversation_uuid, callback);
3563
+ apiInstance.updatePbxAudio(conversationPbxAudioUuid, pbx_audio, callback);
1445
3564
  ```
1446
3565
 
1447
3566
  ### Parameters
1448
3567
 
1449
3568
  Name | Type | Description | Notes
1450
3569
  ------------- | ------------- | ------------- | -------------
1451
- **conversation_uuid** | **String**| |
3570
+ **conversationPbxAudioUuid** | **String**| |
3571
+ **pbx_audio** | [**ConversationPbxAudio**](ConversationPbxAudio.md)| Pbx Audio |
1452
3572
 
1453
3573
  ### Return type
1454
3574
 
1455
- null (empty response body)
3575
+ [**ConversationPbxAudioResponse**](ConversationPbxAudioResponse.md)
1456
3576
 
1457
3577
  ### Authorization
1458
3578
 
@@ -1463,13 +3583,13 @@ null (empty response body)
1463
3583
  - **Content-Type**: application/json
1464
3584
  - **Accept**: application/json
1465
3585
 
1466
- <a name="startConversation"></a>
1467
- # **startConversation**
1468
- > ConversationStartResponse startConversation(start_request)
3586
+ <a name="updatePbxMenu"></a>
3587
+ # **updatePbxMenu**
3588
+ > ConversationPbxMenuResponse updatePbxMenu(conversationPbxMenuUuid, pbx_menu)
1469
3589
 
1470
- Start a conversation
3590
+ Update pbx menu
1471
3591
 
1472
- Start a new conversation
3592
+ Update a pbx menu
1473
3593
 
1474
3594
  ### Example
1475
3595
  ```javascript
@@ -1481,7 +3601,9 @@ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1481
3601
  var apiInstance = new UltraCartRestApiV2.ConversationApi();
1482
3602
 
1483
3603
 
1484
- var start_request = new UltraCartRestApiV2.ConversationStartRequest(); // ConversationStartRequest | Start request
3604
+ var conversationPbxMenuUuid = "conversationPbxMenuUuid_example"; // String |
3605
+
3606
+ var pbx_menu = new UltraCartRestApiV2.ConversationPbxMenu(); // ConversationPbxMenu | Pbx Menu
1485
3607
 
1486
3608
 
1487
3609
  var callback = function(error, data, response) {
@@ -1491,18 +3613,19 @@ var callback = function(error, data, response) {
1491
3613
  console.log('API called successfully. Returned data: ' + data);
1492
3614
  }
1493
3615
  };
1494
- apiInstance.startConversation(start_request, callback);
3616
+ apiInstance.updatePbxMenu(conversationPbxMenuUuid, pbx_menu, callback);
1495
3617
  ```
1496
3618
 
1497
3619
  ### Parameters
1498
3620
 
1499
3621
  Name | Type | Description | Notes
1500
3622
  ------------- | ------------- | ------------- | -------------
1501
- **start_request** | [**ConversationStartRequest**](ConversationStartRequest.md)| Start request |
3623
+ **conversationPbxMenuUuid** | **String**| |
3624
+ **pbx_menu** | [**ConversationPbxMenu**](ConversationPbxMenu.md)| Pbx Menu |
1502
3625
 
1503
3626
  ### Return type
1504
3627
 
1505
- [**ConversationStartResponse**](ConversationStartResponse.md)
3628
+ [**ConversationPbxMenuResponse**](ConversationPbxMenuResponse.md)
1506
3629
 
1507
3630
  ### Authorization
1508
3631
 
@@ -1513,13 +3636,13 @@ Name | Type | Description | Notes
1513
3636
  - **Content-Type**: application/json
1514
3637
  - **Accept**: application/json
1515
3638
 
1516
- <a name="updateAgentProfile"></a>
1517
- # **updateAgentProfile**
1518
- > ConversationAgentProfileResponse updateAgentProfile(profile_request)
3639
+ <a name="updatePbxPhoneNumber"></a>
3640
+ # **updatePbxPhoneNumber**
3641
+ > ConversationPbxPhoneNumberResponse updatePbxPhoneNumber(conversationPbxPhoneNumberUuid, pbx_phoneNumber)
1519
3642
 
1520
- Update agent profile
3643
+ Update pbx phoneNumber
1521
3644
 
1522
- Update agent profile
3645
+ Update a pbx phoneNumber
1523
3646
 
1524
3647
  ### Example
1525
3648
  ```javascript
@@ -1531,7 +3654,9 @@ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1531
3654
  var apiInstance = new UltraCartRestApiV2.ConversationApi();
1532
3655
 
1533
3656
 
1534
- var profile_request = new UltraCartRestApiV2.ConversationAgentProfile(); // ConversationAgentProfile | Profile request
3657
+ var conversationPbxPhoneNumberUuid = "conversationPbxPhoneNumberUuid_example"; // String |
3658
+
3659
+ var pbx_phoneNumber = new UltraCartRestApiV2.ConversationPbxPhoneNumber(); // ConversationPbxPhoneNumber | Pbx PhoneNumber
1535
3660
 
1536
3661
 
1537
3662
  var callback = function(error, data, response) {
@@ -1541,18 +3666,19 @@ var callback = function(error, data, response) {
1541
3666
  console.log('API called successfully. Returned data: ' + data);
1542
3667
  }
1543
3668
  };
1544
- apiInstance.updateAgentProfile(profile_request, callback);
3669
+ apiInstance.updatePbxPhoneNumber(conversationPbxPhoneNumberUuid, pbx_phoneNumber, callback);
1545
3670
  ```
1546
3671
 
1547
3672
  ### Parameters
1548
3673
 
1549
3674
  Name | Type | Description | Notes
1550
3675
  ------------- | ------------- | ------------- | -------------
1551
- **profile_request** | [**ConversationAgentProfile**](ConversationAgentProfile.md)| Profile request |
3676
+ **conversationPbxPhoneNumberUuid** | **String**| |
3677
+ **pbx_phoneNumber** | [**ConversationPbxPhoneNumber**](ConversationPbxPhoneNumber.md)| Pbx PhoneNumber |
1552
3678
 
1553
3679
  ### Return type
1554
3680
 
1555
- [**ConversationAgentProfileResponse**](ConversationAgentProfileResponse.md)
3681
+ [**ConversationPbxPhoneNumberResponse**](ConversationPbxPhoneNumberResponse.md)
1556
3682
 
1557
3683
  ### Authorization
1558
3684
 
@@ -1563,13 +3689,13 @@ Name | Type | Description | Notes
1563
3689
  - **Content-Type**: application/json
1564
3690
  - **Accept**: application/json
1565
3691
 
1566
- <a name="updateConversationCannedMessage"></a>
1567
- # **updateConversationCannedMessage**
1568
- > ConversationCannedMessageResponse updateConversationCannedMessage(conversation_canned_message_oid, canned_message)
3692
+ <a name="updatePbxQueue"></a>
3693
+ # **updatePbxQueue**
3694
+ > ConversationPbxQueueResponse updatePbxQueue(conversationPbxQueueUuid, pbx_queue)
1569
3695
 
1570
- Update a canned message
3696
+ Update pbx queue
1571
3697
 
1572
- Update a canned message
3698
+ Update a pbx queue
1573
3699
 
1574
3700
  ### Example
1575
3701
  ```javascript
@@ -1581,9 +3707,9 @@ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1581
3707
  var apiInstance = new UltraCartRestApiV2.ConversationApi();
1582
3708
 
1583
3709
 
1584
- var conversation_canned_message_oid = 56; // Number |
3710
+ var conversationPbxQueueUuid = "conversationPbxQueueUuid_example"; // String |
1585
3711
 
1586
- var canned_message = new UltraCartRestApiV2.ConversationCannedMessage(); // ConversationCannedMessage | Canned message
3712
+ var pbx_queue = new UltraCartRestApiV2.ConversationPbxQueue(); // ConversationPbxQueue | Pbx Queue
1587
3713
 
1588
3714
 
1589
3715
  var callback = function(error, data, response) {
@@ -1593,19 +3719,19 @@ var callback = function(error, data, response) {
1593
3719
  console.log('API called successfully. Returned data: ' + data);
1594
3720
  }
1595
3721
  };
1596
- apiInstance.updateConversationCannedMessage(conversation_canned_message_oid, canned_message, callback);
3722
+ apiInstance.updatePbxQueue(conversationPbxQueueUuid, pbx_queue, callback);
1597
3723
  ```
1598
3724
 
1599
3725
  ### Parameters
1600
3726
 
1601
3727
  Name | Type | Description | Notes
1602
3728
  ------------- | ------------- | ------------- | -------------
1603
- **conversation_canned_message_oid** | **Number**| |
1604
- **canned_message** | [**ConversationCannedMessage**](ConversationCannedMessage.md)| Canned message |
3729
+ **conversationPbxQueueUuid** | **String**| |
3730
+ **pbx_queue** | [**ConversationPbxQueue**](ConversationPbxQueue.md)| Pbx Queue |
1605
3731
 
1606
3732
  ### Return type
1607
3733
 
1608
- [**ConversationCannedMessageResponse**](ConversationCannedMessageResponse.md)
3734
+ [**ConversationPbxQueueResponse**](ConversationPbxQueueResponse.md)
1609
3735
 
1610
3736
  ### Authorization
1611
3737
 
@@ -1616,13 +3742,13 @@ Name | Type | Description | Notes
1616
3742
  - **Content-Type**: application/json
1617
3743
  - **Accept**: application/json
1618
3744
 
1619
- <a name="updateConversationDepartment"></a>
1620
- # **updateConversationDepartment**
1621
- > ConversationDepartmentResponse updateConversationDepartment(conversation_department_oid, department)
3745
+ <a name="updatePbxTimeBased"></a>
3746
+ # **updatePbxTimeBased**
3747
+ > ConversationPbxTimeBasedResponse updatePbxTimeBased(conversationPbxTimeBasedUuid, pbx_timeBased)
1622
3748
 
1623
- Update a department
3749
+ Update pbx timeBased
1624
3750
 
1625
- Update a department
3751
+ Update a pbx timeBased
1626
3752
 
1627
3753
  ### Example
1628
3754
  ```javascript
@@ -1634,9 +3760,9 @@ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1634
3760
  var apiInstance = new UltraCartRestApiV2.ConversationApi();
1635
3761
 
1636
3762
 
1637
- var conversation_department_oid = 56; // Number |
3763
+ var conversationPbxTimeBasedUuid = "conversationPbxTimeBasedUuid_example"; // String |
1638
3764
 
1639
- var department = new UltraCartRestApiV2.ConversationDepartment(); // ConversationDepartment | Department
3765
+ var pbx_timeBased = new UltraCartRestApiV2.ConversationPbxTimeBased(); // ConversationPbxTimeBased | Pbx TimeBased
1640
3766
 
1641
3767
 
1642
3768
  var callback = function(error, data, response) {
@@ -1646,19 +3772,19 @@ var callback = function(error, data, response) {
1646
3772
  console.log('API called successfully. Returned data: ' + data);
1647
3773
  }
1648
3774
  };
1649
- apiInstance.updateConversationDepartment(conversation_department_oid, department, callback);
3775
+ apiInstance.updatePbxTimeBased(conversationPbxTimeBasedUuid, pbx_timeBased, callback);
1650
3776
  ```
1651
3777
 
1652
3778
  ### Parameters
1653
3779
 
1654
3780
  Name | Type | Description | Notes
1655
3781
  ------------- | ------------- | ------------- | -------------
1656
- **conversation_department_oid** | **Number**| |
1657
- **department** | [**ConversationDepartment**](ConversationDepartment.md)| Department |
3782
+ **conversationPbxTimeBasedUuid** | **String**| |
3783
+ **pbx_timeBased** | [**ConversationPbxTimeBased**](ConversationPbxTimeBased.md)| Pbx TimeBased |
1658
3784
 
1659
3785
  ### Return type
1660
3786
 
1661
- [**ConversationDepartmentResponse**](ConversationDepartmentResponse.md)
3787
+ [**ConversationPbxTimeBasedResponse**](ConversationPbxTimeBasedResponse.md)
1662
3788
 
1663
3789
  ### Authorization
1664
3790
 
@@ -1669,13 +3795,13 @@ Name | Type | Description | Notes
1669
3795
  - **Content-Type**: application/json
1670
3796
  - **Accept**: application/json
1671
3797
 
1672
- <a name="updateConversationEngagement"></a>
1673
- # **updateConversationEngagement**
1674
- > ConversationEngagementResponse updateConversationEngagement(conversation_engagement_oid, engagement)
3798
+ <a name="updatePbxTimeRange"></a>
3799
+ # **updatePbxTimeRange**
3800
+ > ConversationPbxTimeRangeResponse updatePbxTimeRange(conversationPbxTimeRangeUuid, pbx_timeRange)
1675
3801
 
1676
- Update a engagement
3802
+ Update pbx timeRange
1677
3803
 
1678
- Update a engagement
3804
+ Update a pbx timeRange
1679
3805
 
1680
3806
  ### Example
1681
3807
  ```javascript
@@ -1687,9 +3813,9 @@ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1687
3813
  var apiInstance = new UltraCartRestApiV2.ConversationApi();
1688
3814
 
1689
3815
 
1690
- var conversation_engagement_oid = 56; // Number |
3816
+ var conversationPbxTimeRangeUuid = "conversationPbxTimeRangeUuid_example"; // String |
1691
3817
 
1692
- var engagement = new UltraCartRestApiV2.ConversationEngagement(); // ConversationEngagement | Engagement
3818
+ var pbx_timeRange = new UltraCartRestApiV2.ConversationPbxTimeRange(); // ConversationPbxTimeRange | Pbx TimeRange
1693
3819
 
1694
3820
 
1695
3821
  var callback = function(error, data, response) {
@@ -1699,19 +3825,19 @@ var callback = function(error, data, response) {
1699
3825
  console.log('API called successfully. Returned data: ' + data);
1700
3826
  }
1701
3827
  };
1702
- apiInstance.updateConversationEngagement(conversation_engagement_oid, engagement, callback);
3828
+ apiInstance.updatePbxTimeRange(conversationPbxTimeRangeUuid, pbx_timeRange, callback);
1703
3829
  ```
1704
3830
 
1705
3831
  ### Parameters
1706
3832
 
1707
3833
  Name | Type | Description | Notes
1708
3834
  ------------- | ------------- | ------------- | -------------
1709
- **conversation_engagement_oid** | **Number**| |
1710
- **engagement** | [**ConversationEngagement**](ConversationEngagement.md)| Engagement |
3835
+ **conversationPbxTimeRangeUuid** | **String**| |
3836
+ **pbx_timeRange** | [**ConversationPbxTimeRange**](ConversationPbxTimeRange.md)| Pbx TimeRange |
1711
3837
 
1712
3838
  ### Return type
1713
3839
 
1714
- [**ConversationEngagementResponse**](ConversationEngagementResponse.md)
3840
+ [**ConversationPbxTimeRangeResponse**](ConversationPbxTimeRangeResponse.md)
1715
3841
 
1716
3842
  ### Authorization
1717
3843
 
@@ -1722,13 +3848,13 @@ Name | Type | Description | Notes
1722
3848
  - **Content-Type**: application/json
1723
3849
  - **Accept**: application/json
1724
3850
 
1725
- <a name="updateConversationWebchatQueueStatus"></a>
1726
- # **updateConversationWebchatQueueStatus**
1727
- > updateConversationWebchatQueueStatus(queue_name, status_request)
3851
+ <a name="updatePbxVoicemailMailbox"></a>
3852
+ # **updatePbxVoicemailMailbox**
3853
+ > ConversationPbxVoicemailMailboxResponse updatePbxVoicemailMailbox(conversationPbxVoicemailMailboxUuid, pbx_voicemailMailbox)
1728
3854
 
1729
- Update status within the queue
3855
+ Update pbx voicemailMailbox
1730
3856
 
1731
- Update status within the queue
3857
+ Update a pbx voicemailMailbox
1732
3858
 
1733
3859
  ### Example
1734
3860
  ```javascript
@@ -1740,31 +3866,31 @@ UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
1740
3866
  var apiInstance = new UltraCartRestApiV2.ConversationApi();
1741
3867
 
1742
3868
 
1743
- var queue_name = "queue_name_example"; // String |
3869
+ var conversationPbxVoicemailMailboxUuid = "conversationPbxVoicemailMailboxUuid_example"; // String |
1744
3870
 
1745
- var status_request = new UltraCartRestApiV2.ConversationWebchatQueueStatusUpdateRequest(); // ConversationWebchatQueueStatusUpdateRequest | Status request
3871
+ var pbx_voicemailMailbox = new UltraCartRestApiV2.ConversationPbxVoicemailMailbox(); // ConversationPbxVoicemailMailbox | Pbx VoicemailMailbox
1746
3872
 
1747
3873
 
1748
3874
  var callback = function(error, data, response) {
1749
3875
  if (error) {
1750
3876
  console.error(error);
1751
3877
  } else {
1752
- console.log('API called successfully.');
3878
+ console.log('API called successfully. Returned data: ' + data);
1753
3879
  }
1754
3880
  };
1755
- apiInstance.updateConversationWebchatQueueStatus(queue_name, status_request, callback);
3881
+ apiInstance.updatePbxVoicemailMailbox(conversationPbxVoicemailMailboxUuid, pbx_voicemailMailbox, callback);
1756
3882
  ```
1757
3883
 
1758
3884
  ### Parameters
1759
3885
 
1760
3886
  Name | Type | Description | Notes
1761
3887
  ------------- | ------------- | ------------- | -------------
1762
- **queue_name** | **String**| |
1763
- **status_request** | [**ConversationWebchatQueueStatusUpdateRequest**](ConversationWebchatQueueStatusUpdateRequest.md)| Status request |
3888
+ **conversationPbxVoicemailMailboxUuid** | **String**| |
3889
+ **pbx_voicemailMailbox** | [**ConversationPbxVoicemailMailbox**](ConversationPbxVoicemailMailbox.md)| Pbx VoicemailMailbox |
1764
3890
 
1765
3891
  ### Return type
1766
3892
 
1767
- null (empty response body)
3893
+ [**ConversationPbxVoicemailMailboxResponse**](ConversationPbxVoicemailMailboxResponse.md)
1768
3894
 
1769
3895
  ### Authorization
1770
3896