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