@connectedxm/admin-sdk 1.0.0
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.
- package/.openapi-generator/FILES +1106 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/AdminApi.ts +488 -0
- package/README.md +1962 -0
- package/api.ts +113404 -0
- package/base.ts +62 -0
- package/common.ts +126 -0
- package/configuration.ts +121 -0
- package/dist/AdminApi.d.ts +173 -0
- package/dist/AdminApi.js +193 -0
- package/dist/api.d.ts +60747 -0
- package/dist/api.js +81981 -0
- package/dist/base.d.ts +42 -0
- package/dist/base.js +46 -0
- package/dist/common.d.ts +34 -0
- package/dist/common.js +138 -0
- package/dist/configuration.d.ts +98 -0
- package/dist/configuration.js +44 -0
- package/dist/esm/AdminApi.d.ts +173 -0
- package/dist/esm/AdminApi.js +189 -0
- package/dist/esm/api.d.ts +60747 -0
- package/dist/esm/api.js +81393 -0
- package/dist/esm/base.d.ts +42 -0
- package/dist/esm/base.js +41 -0
- package/dist/esm/common.d.ts +34 -0
- package/dist/esm/common.js +125 -0
- package/dist/esm/configuration.d.ts +98 -0
- package/dist/esm/configuration.js +40 -0
- package/dist/esm/index.d.ts +8 -0
- package/dist/esm/index.js +13 -0
- package/dist/index.d.ts +8 -0
- package/dist/index.js +32 -0
- package/docs/APILog.md +46 -0
- package/docs/Account.md +52 -0
- package/docs/AccountAccess.md +14 -0
- package/docs/AccountAddress.md +22 -0
- package/docs/AccountAddressCreateInputs.md +32 -0
- package/docs/AccountAddressUpdateInputs.md +34 -0
- package/docs/AccountAttribute.md +24 -0
- package/docs/AccountAttributeCount.md +20 -0
- package/docs/AccountAttributeCreateInputs.md +38 -0
- package/docs/AccountAttributeUpdateInputs.md +34 -0
- package/docs/AccountAttributeValue.md +22 -0
- package/docs/AccountCreateInputs.md +68 -0
- package/docs/AccountUpdateInputs.md +70 -0
- package/docs/AccountsAddressesApi.md +296 -0
- package/docs/AccountsApi.md +903 -0
- package/docs/AccountsFollowersApi.md +181 -0
- package/docs/AccountsFollowingApi.md +181 -0
- package/docs/AccountsGroupsApi.md +181 -0
- package/docs/AccountsInterestsApi.md +181 -0
- package/docs/AccountsInvitationsApi.md +172 -0
- package/docs/AccountsLeadsApi.md +246 -0
- package/docs/AccountsTiersApi.md +248 -0
- package/docs/ActivationCompletion.md +24 -0
- package/docs/ActivationTranslation.md +32 -0
- package/docs/ActivitiesApi.md +528 -0
- package/docs/ActivitiesScheduleApi.md +114 -0
- package/docs/Activity.md +32 -0
- package/docs/ActivityCreateInputs.md +40 -0
- package/docs/ActivityEntityInputs.md +26 -0
- package/docs/ActivityEntityType.md +14 -0
- package/docs/ActivityPreference.md +12 -0
- package/docs/ActivityStatus.md +14 -0
- package/docs/ActivityUpdateInputs.md +38 -0
- package/docs/AddAccountGroup200Response.md +24 -0
- package/docs/AdminNotification.md +28 -0
- package/docs/AdminNotificationPreferences.md +30 -0
- package/docs/AdminNotificationPreferencesUpdateInputs.md +30 -0
- package/docs/AdminNotificationSource.md +12 -0
- package/docs/AdminNotificationType.md +12 -0
- package/docs/Advertisement.md +30 -0
- package/docs/AdvertisementClick.md +34 -0
- package/docs/AdvertisementCount.md +22 -0
- package/docs/AdvertisementCreateInputs.md +42 -0
- package/docs/AdvertisementCreateInputsWeight.md +18 -0
- package/docs/AdvertisementType.md +10 -0
- package/docs/AdvertisementUpdateInputs.md +42 -0
- package/docs/AdvertisementView.md +34 -0
- package/docs/AdvertisementsApi.md +409 -0
- package/docs/Announcement.md +48 -0
- package/docs/AnnouncementCount.md +22 -0
- package/docs/AnnouncementCreateInputs.md +48 -0
- package/docs/AnnouncementFilters.md +32 -0
- package/docs/AnnouncementTranslation.md +32 -0
- package/docs/AnnouncementTranslationUpdateInputs.md +22 -0
- package/docs/AnnouncementUpdateInputs.md +32 -0
- package/docs/AnnouncementsApi.md +468 -0
- package/docs/AnnouncementsScheduleApi.md +114 -0
- package/docs/ApiLogsApi.md +141 -0
- package/docs/AttachSearchListInputs.md +20 -0
- package/docs/AttendeeEventPackageCreateInputs.md +22 -0
- package/docs/AttendeeEventPackageUpdateInputs.md +22 -0
- package/docs/AttendeePackage.md +24 -0
- package/docs/AuthLayout.md +10 -0
- package/docs/AuthSession.md +26 -0
- package/docs/AuthSessionsApi.md +120 -0
- package/docs/AuthorizeNetActivationFormParams.md +28 -0
- package/docs/BadgeFieldTransformation.md +10 -0
- package/docs/BadgeFieldType.md +20 -0
- package/docs/BarChartSummaryData.md +26 -0
- package/docs/BarChartSummaryDataDataInner.md +22 -0
- package/docs/BaseAPILog.md +46 -0
- package/docs/BaseAccount.md +56 -0
- package/docs/BaseAccountAddress.md +36 -0
- package/docs/BaseAccountAttribute.md +40 -0
- package/docs/BaseAccountAttributeValue.md +26 -0
- package/docs/BaseAccountInvitation.md +22 -0
- package/docs/BaseActivationCompletion.md +30 -0
- package/docs/BaseActivity.md +54 -0
- package/docs/BaseActivityCount.md +22 -0
- package/docs/BaseActivityEntity.md +38 -0
- package/docs/BaseActivityEntityInput.md +26 -0
- package/docs/BaseAdminNotification.md +40 -0
- package/docs/BaseAdvertisement.md +44 -0
- package/docs/BaseAnnouncement.md +54 -0
- package/docs/BaseAttendeePackage.md +30 -0
- package/docs/BaseBenefit.md +38 -0
- package/docs/BaseBooking.md +36 -0
- package/docs/BaseBookingPlace.md +38 -0
- package/docs/BaseBookingSpace.md +48 -0
- package/docs/BaseBookingSpaceAvailability.md +26 -0
- package/docs/BaseBookingSpaceBlackout.md +24 -0
- package/docs/BaseChannel.md +44 -0
- package/docs/BaseChannelContent.md +58 -0
- package/docs/BaseChannelContentGuest.md +66 -0
- package/docs/BaseChannelContentLike.md +24 -0
- package/docs/BaseChannelCount.md +20 -0
- package/docs/BaseChannelSubscriber.md +36 -0
- package/docs/BaseCoupon.md +64 -0
- package/docs/BaseCouponRegistration.md +20 -0
- package/docs/BaseDashboard.md +32 -0
- package/docs/BaseDashboardWidget.md +30 -0
- package/docs/BaseEmailReceipt.md +38 -0
- package/docs/BaseEvent.md +86 -0
- package/docs/BaseEventActivation.md +36 -0
- package/docs/BaseEventAddOn.md +48 -0
- package/docs/BaseEventAttendee.md +30 -0
- package/docs/BaseEventEmail.md +30 -0
- package/docs/BaseEventMediaItem.md +38 -0
- package/docs/BaseEventOnSite.md +28 -0
- package/docs/BaseEventOnSiteBadgeField.md +44 -0
- package/docs/BaseEventPackage.md +40 -0
- package/docs/BaseEventPackagePass.md +26 -0
- package/docs/BaseEventPage.md +30 -0
- package/docs/BaseEventPass.md +60 -0
- package/docs/BaseEventPassAttendee.md +20 -0
- package/docs/BaseEventPassAttendeeAccount.md +26 -0
- package/docs/BaseEventPassTransfer.md +24 -0
- package/docs/BaseEventPassType.md +74 -0
- package/docs/BaseEventPassTypePriceSchedule.md +34 -0
- package/docs/BaseEventPassTypeRefundSchedule.md +32 -0
- package/docs/BaseEventRoomType.md +38 -0
- package/docs/BaseEventRoomTypeAddOnDetails.md +34 -0
- package/docs/BaseEventRoomTypePassTypeDetails.md +44 -0
- package/docs/BaseEventRoomTypeReservation.md +34 -0
- package/docs/BaseEventSession.md +66 -0
- package/docs/BaseEventSessionAccess.md +30 -0
- package/docs/BaseEventSessionLocation.md +36 -0
- package/docs/BaseEventSessionQuestion.md +64 -0
- package/docs/BaseEventSessionQuestionChoice.md +36 -0
- package/docs/BaseEventSessionQuestionChoiceSubQuestion.md +26 -0
- package/docs/BaseEventSessionQuestionChoiceSubQuestions.md +18 -0
- package/docs/BaseEventSessionQuestionResponse.md +26 -0
- package/docs/BaseEventSessionQuestionResponseChange.md +34 -0
- package/docs/BaseEventSessionSection.md +30 -0
- package/docs/BaseEventSessionSectionQuestion.md +28 -0
- package/docs/BaseEventSpeaker.md +44 -0
- package/docs/BaseEventSponsorship.md +32 -0
- package/docs/BaseEventSponsorshipLevel.md +28 -0
- package/docs/BaseEventTrack.md +28 -0
- package/docs/BaseFaq.md +28 -0
- package/docs/BaseFaqSection.md +26 -0
- package/docs/BaseFile.md +36 -0
- package/docs/BaseGroup.md +42 -0
- package/docs/BaseGroupCount.md +20 -0
- package/docs/BaseGroupInvitation.md +26 -0
- package/docs/BaseGroupMembership.md +30 -0
- package/docs/BaseGroupRequest.md +26 -0
- package/docs/BaseImage.md +30 -0
- package/docs/BaseImport.md +30 -0
- package/docs/BaseImportItem.md +34 -0
- package/docs/BaseIntegration.md +28 -0
- package/docs/BaseInterest.md +28 -0
- package/docs/BaseInvoice.md +36 -0
- package/docs/BaseInvoiceLineItem.md +38 -0
- package/docs/BaseLead.md +30 -0
- package/docs/BaseLeadShareAccount.md +22 -0
- package/docs/BaseLevel.md +36 -0
- package/docs/BaseLike.md +22 -0
- package/docs/BaseLinkPreview.md +36 -0
- package/docs/BaseLogin.md +42 -0
- package/docs/BaseMatch.md +28 -0
- package/docs/BaseMatchPass.md +30 -0
- package/docs/BaseMatchPassAccessesInner.md +20 -0
- package/docs/BaseMeeting.md +24 -0
- package/docs/BaseMeetingLink.md +28 -0
- package/docs/BaseMeetingRecording.md +42 -0
- package/docs/BaseMeetingSessionParticipant.md +44 -0
- package/docs/BaseNotification.md +36 -0
- package/docs/BaseOrganization.md +36 -0
- package/docs/BaseOrganizationModule.md +30 -0
- package/docs/BasePassAddOn.md +26 -0
- package/docs/BasePassAddOnPass.md +22 -0
- package/docs/BasePassAddOnPassAttendee.md +20 -0
- package/docs/BasePayment.md +74 -0
- package/docs/BasePaymentIntegration.md +26 -0
- package/docs/BasePaymentLineItem.md +62 -0
- package/docs/BasePreset.md +26 -0
- package/docs/BasePushDevice.md +46 -0
- package/docs/BaseRegistrationBypass.md +34 -0
- package/docs/BaseRegistrationFollowup.md +30 -0
- package/docs/BaseRegistrationFollowupQuestion.md +28 -0
- package/docs/BaseRegistrationQuestion.md +64 -0
- package/docs/BaseRegistrationQuestionChoice.md +36 -0
- package/docs/BaseRegistrationQuestionChoiceCount.md +20 -0
- package/docs/BaseRegistrationQuestionChoiceQuestion.md +22 -0
- package/docs/BaseRegistrationQuestionChoiceSubQuestion.md +26 -0
- package/docs/BaseRegistrationQuestionChoiceSubQuestions.md +18 -0
- package/docs/BaseRegistrationQuestionChoiceSubQuestionsOneOfInner.md +20 -0
- package/docs/BaseRegistrationQuestionResponse.md +26 -0
- package/docs/BaseRegistrationQuestionResponseChange.md +34 -0
- package/docs/BaseRegistrationSection.md +30 -0
- package/docs/BaseRegistrationSectionCount.md +20 -0
- package/docs/BaseRegistrationSectionQuestion.md +28 -0
- package/docs/BaseRoom.md +26 -0
- package/docs/BaseRound.md +26 -0
- package/docs/BaseRoundEvent.md +24 -0
- package/docs/BaseSchedule.md +26 -0
- package/docs/BaseSearchList.md +24 -0
- package/docs/BaseSearchListValue.md +26 -0
- package/docs/BaseSeries.md +36 -0
- package/docs/BaseSideEffect.md +38 -0
- package/docs/BaseStandardReport.md +34 -0
- package/docs/BaseStreamInput.md +42 -0
- package/docs/BaseStreamSession.md +34 -0
- package/docs/BaseStreamSessionSubscription.md +32 -0
- package/docs/BaseSupportTicket.md +30 -0
- package/docs/BaseSupportTicketActivityLog.md +52 -0
- package/docs/BaseSupportTicketMessage.md +34 -0
- package/docs/BaseSupportTicketNote.md +26 -0
- package/docs/BaseSupportTicketViewer.md +32 -0
- package/docs/BaseSurvey.md +32 -0
- package/docs/BaseSurveyQuestion.md +60 -0
- package/docs/BaseSurveyQuestionChoice.md +36 -0
- package/docs/BaseSurveyQuestionChoiceSubQuestion.md +26 -0
- package/docs/BaseSurveyQuestionChoiceSubQuestions.md +18 -0
- package/docs/BaseSurveyQuestionResponse.md +26 -0
- package/docs/BaseSurveyQuestionResponseChange.md +34 -0
- package/docs/BaseSurveySection.md +30 -0
- package/docs/BaseSurveySectionQuestion.md +28 -0
- package/docs/BaseSurveySubmission.md +26 -0
- package/docs/BaseTaxIntegrationLog.md +30 -0
- package/docs/BaseTeamMember.md +38 -0
- package/docs/BaseThread.md +34 -0
- package/docs/BaseThreadCircle.md +28 -0
- package/docs/BaseThreadCircleAccount.md +24 -0
- package/docs/BaseThreadMember.md +30 -0
- package/docs/BaseThreadMessage.md +32 -0
- package/docs/BaseThreadMessageEntity.md +34 -0
- package/docs/BaseThreadMessageReaction.md +26 -0
- package/docs/BaseTier.md +36 -0
- package/docs/BaseTransfer.md +26 -0
- package/docs/BaseTransferLog.md +28 -0
- package/docs/BaseUser.md +32 -0
- package/docs/BaseVideo.md +40 -0
- package/docs/BaseWebSocketConnection.md +34 -0
- package/docs/BaseWebhook.md +26 -0
- package/docs/Benefit.md +34 -0
- package/docs/BenefitClick.md +32 -0
- package/docs/BenefitCount.md +20 -0
- package/docs/BenefitCreateInputs.md +40 -0
- package/docs/BenefitTranslation.md +30 -0
- package/docs/BenefitTranslationUpdateInputs.md +22 -0
- package/docs/BenefitUpdateInputs.md +40 -0
- package/docs/BenefitsApi.md +348 -0
- package/docs/Booking.md +24 -0
- package/docs/BookingCreateInputs.md +26 -0
- package/docs/BookingPlace.md +32 -0
- package/docs/BookingPlaceCreateInputs.md +44 -0
- package/docs/BookingPlaceTranslation.md +30 -0
- package/docs/BookingPlaceTranslationUpdateInputs.md +22 -0
- package/docs/BookingPlaceUpdateInputs.md +44 -0
- package/docs/BookingSlot.md +22 -0
- package/docs/BookingSpace.md +26 -0
- package/docs/BookingSpaceAvailability.md +22 -0
- package/docs/BookingSpaceAvailabilityCreateInputs.md +24 -0
- package/docs/BookingSpaceAvailabilityUpdateInputs.md +24 -0
- package/docs/BookingSpaceBlackout.md +22 -0
- package/docs/BookingSpaceBlackoutCreateInputs.md +22 -0
- package/docs/BookingSpaceBlackoutUpdateInputs.md +22 -0
- package/docs/BookingSpaceCreateInputs.md +48 -0
- package/docs/BookingSpaceTranslation.md +30 -0
- package/docs/BookingSpaceTranslationUpdateInputs.md +22 -0
- package/docs/BookingSpaceUpdateInputs.md +46 -0
- package/docs/BookingUpdateInputs.md +24 -0
- package/docs/BookingsApi.md +1049 -0
- package/docs/BookingsAvailabilitiesApi.md +186 -0
- package/docs/BookingsBlackoutsApi.md +186 -0
- package/docs/BookingsPlacesApi.md +168 -0
- package/docs/BookingsSpacesApi.md +177 -0
- package/docs/BraintreeActivationFormParams.md +28 -0
- package/docs/Channel.md +38 -0
- package/docs/ChannelCollectionCreateInputs.md +22 -0
- package/docs/ChannelCollectionTranslationUpdateInputs.md +22 -0
- package/docs/ChannelCollectionUpdateInputs.md +22 -0
- package/docs/ChannelContent.md +40 -0
- package/docs/ChannelContentCount.md +22 -0
- package/docs/ChannelContentCreateInputs.md +54 -0
- package/docs/ChannelContentGuestCreateInputs.md +54 -0
- package/docs/ChannelContentGuestTranslation.md +32 -0
- package/docs/ChannelContentGuestTranslationUpdateInputs.md +24 -0
- package/docs/ChannelContentGuestUpdateInputs.md +54 -0
- package/docs/ChannelContentLike.md +24 -0
- package/docs/ChannelContentTranslation.md +44 -0
- package/docs/ChannelContentTranslationUpdateInputs.md +30 -0
- package/docs/ChannelContentUpdateInputs.md +56 -0
- package/docs/ChannelCount.md +22 -0
- package/docs/ChannelCreateInputs.md +50 -0
- package/docs/ChannelFormat.md +12 -0
- package/docs/ChannelSubscriberUpdateInputs.md +22 -0
- package/docs/ChannelTranslation.md +30 -0
- package/docs/ChannelTranslationUpdateInputs.md +22 -0
- package/docs/ChannelUpdateInputs.md +50 -0
- package/docs/ChannelsApi.md +1729 -0
- package/docs/CloneOptions.md +76 -0
- package/docs/ContentGuestType.md +12 -0
- package/docs/ContentStatus.md +10 -0
- package/docs/CountChartSummaryData.md +26 -0
- package/docs/Coupon.md +32 -0
- package/docs/CouponCount.md +24 -0
- package/docs/CreateAccount200Response.md +24 -0
- package/docs/CreateAccountAddress200Response.md +24 -0
- package/docs/CreateAccountInvitations200Response.md +24 -0
- package/docs/CreateActivity200Response.md +24 -0
- package/docs/CreateAdvertisement200Response.md +24 -0
- package/docs/CreateAnnouncement200Response.md +24 -0
- package/docs/CreateBenefit200Response.md +24 -0
- package/docs/CreateBooking200Response.md +24 -0
- package/docs/CreateBookingPlace200Response.md +24 -0
- package/docs/CreateBookingSpace200Response.md +24 -0
- package/docs/CreateChannel200Response.md +24 -0
- package/docs/CreateCustomModule200Response.md +24 -0
- package/docs/CreateDashboard200Response.md +24 -0
- package/docs/CreateEvent200Response.md +24 -0
- package/docs/CreateEventAddOn200Response.md +24 -0
- package/docs/CreateEventAttendee200Response.md +24 -0
- package/docs/CreateEventCoupon200Response.md +24 -0
- package/docs/CreateEventCouponVariants200Response.md +24 -0
- package/docs/CreateEventFaqSection200Response.md +24 -0
- package/docs/CreateEventFaqSectionQuestion200Response.md +24 -0
- package/docs/CreateEventMatch200Response.md +24 -0
- package/docs/CreateEventPackage200Response.md +24 -0
- package/docs/CreateEventPage200Response.md +24 -0
- package/docs/CreateEventPass200Response.md +24 -0
- package/docs/CreateEventPassType200Response.md +24 -0
- package/docs/CreateEventRoomType200Response.md +24 -0
- package/docs/CreateEventRound200Response.md +24 -0
- package/docs/CreateEventSession200Response.md +24 -0
- package/docs/CreateEventSpeaker200Response.md +24 -0
- package/docs/CreateEventTrack200Response.md +24 -0
- package/docs/CreateGroup200Response.md +24 -0
- package/docs/CreateImage200Response.md +24 -0
- package/docs/CreateIntegration200Response.md +24 -0
- package/docs/CreateInterest200Response.md +24 -0
- package/docs/CreateInvoice200Response.md +24 -0
- package/docs/CreateLevel200Response.md +24 -0
- package/docs/CreateMeeting200Response.md +24 -0
- package/docs/CreateMeetingLink200Response.md +24 -0
- package/docs/CreateOrganizationWebhook200Response.md +24 -0
- package/docs/CreatePreset200Response.md +24 -0
- package/docs/CreateRoom200Response.md +24 -0
- package/docs/CreateSearchList200Response.md +24 -0
- package/docs/CreateSelfApiKey200Response.md +24 -0
- package/docs/CreateSeries200Response.md +24 -0
- package/docs/CreateStreamInput200Response.md +24 -0
- package/docs/CreateSupportTicket200Response.md +24 -0
- package/docs/CreateSurvey200Response.md +24 -0
- package/docs/CreateSurveySection200Response.md +24 -0
- package/docs/CreateThread200Response.md +24 -0
- package/docs/CreateThreadCircle200Response.md +24 -0
- package/docs/CreateThreadMessage200Response.md +24 -0
- package/docs/CreateTier200Response.md +24 -0
- package/docs/Currency.md +8 -0
- package/docs/CustomModule.md +34 -0
- package/docs/CustomModuleCreateInputs.md +30 -0
- package/docs/CustomModulePosition.md +10 -0
- package/docs/CustomModuleTranslation.md +28 -0
- package/docs/CustomModuleTranslationUpdateInputs.md +22 -0
- package/docs/CustomModuleUpdateInputs.md +32 -0
- package/docs/CustomReport.md +46 -0
- package/docs/CustomReportCreateInputs.md +26 -0
- package/docs/CustomReportUpdateInputs.md +26 -0
- package/docs/Dashboard.md +20 -0
- package/docs/DashboardCreateInputs.md +22 -0
- package/docs/DashboardUpdateInputs.md +20 -0
- package/docs/DashboardWidgetCreateInputs.md +26 -0
- package/docs/DashboardWidgetEndpoint.md +32 -0
- package/docs/DashboardWidgetEndpointDefaultSize.md +22 -0
- package/docs/DashboardWidgetUpdateInputs.md +26 -0
- package/docs/DashboardsApi.md +284 -0
- package/docs/DashboardsWidgetsApi.md +232 -0
- package/docs/DayOfWeek.md +20 -0
- package/docs/DefaultAuthAction.md +10 -0
- package/docs/DelegateRole.md +10 -0
- package/docs/DomainDetails.md +20 -0
- package/docs/EmailReceipt.md +24 -0
- package/docs/EmailReceiptStatus.md +16 -0
- package/docs/EmailReceiptsApi.md +123 -0
- package/docs/EntityUseCode.md +24 -0
- package/docs/Event.md +94 -0
- package/docs/EventActivation.md +34 -0
- package/docs/EventActivationCompletionCreateInputs.md +22 -0
- package/docs/EventActivationCompletionUpdateInputs.md +20 -0
- package/docs/EventActivationCreateInputs.md +44 -0
- package/docs/EventActivationTranslation.md +26 -0
- package/docs/EventActivationTranslationUpdateInputs.md +24 -0
- package/docs/EventActivationType.md +12 -0
- package/docs/EventActivationUpdateInputs.md +40 -0
- package/docs/EventAddOn.md +30 -0
- package/docs/EventAddOnCount.md +20 -0
- package/docs/EventAddOnCreateInputs.md +40 -0
- package/docs/EventAddOnTranslation.md +30 -0
- package/docs/EventAddOnTranslationUpdateInputs.md +24 -0
- package/docs/EventAddOnUpdateInputs.md +40 -0
- package/docs/EventAgendaVisibility.md +12 -0
- package/docs/EventAnnouncementFilters.md +30 -0
- package/docs/EventAttendee.md +28 -0
- package/docs/EventAttendeeCount.md +22 -0
- package/docs/EventAttendeePackageCreateInputs.md +22 -0
- package/docs/EventAttendeePackageUpdateInputs.md +22 -0
- package/docs/EventBadgeFieldUpdateInputs.md +34 -0
- package/docs/EventCouponCreateInputs.md +54 -0
- package/docs/EventCouponUpdateInputs.md +54 -0
- package/docs/EventCreateInputs.md +130 -0
- package/docs/EventCreateInputsPassLimitPerAccount.md +18 -0
- package/docs/EventCreateInputsSplitPaymentPercentage.md +18 -0
- package/docs/EventEmail.md +22 -0
- package/docs/EventEmailTranslation.md +28 -0
- package/docs/EventEmailTranslationUpdateInputs.md +20 -0
- package/docs/EventEmailType.md +12 -0
- package/docs/EventEmailUpdateInputs.md +26 -0
- package/docs/EventFaqSectionCreateInputs.md +24 -0
- package/docs/EventFaqSectionQuestionCreateInputs.md +28 -0
- package/docs/EventFaqSectionQuestionTranslationUpdateInputs.md +22 -0
- package/docs/EventFaqSectionQuestionUpdateInputs.md +28 -0
- package/docs/EventFaqSectionTranslationUpdateInputs.md +20 -0
- package/docs/EventFaqSectionUpdateInputs.md +24 -0
- package/docs/EventFollowupCreateInputs.md +26 -0
- package/docs/EventFollowupTranslationUpdateInputs.md +24 -0
- package/docs/EventFollowupUpdateInputs.md +26 -0
- package/docs/EventMediaItem.md +24 -0
- package/docs/EventMediaItemCreateInputs.md +30 -0
- package/docs/EventMediaItemUpdateInputs.md +24 -0
- package/docs/EventOnSite.md +20 -0
- package/docs/EventOnSiteBadgeField.md +20 -0
- package/docs/EventPackage.md +24 -0
- package/docs/EventPackageCreateInputs.md +36 -0
- package/docs/EventPackagePass.md +22 -0
- package/docs/EventPackagePassCreateInputs.md +22 -0
- package/docs/EventPackagePassUpdateInputs.md +22 -0
- package/docs/EventPackageTranslation.md +26 -0
- package/docs/EventPackageTranslationUpdateInputs.md +22 -0
- package/docs/EventPackageUpdateInputs.md +36 -0
- package/docs/EventPage.md +24 -0
- package/docs/EventPageCreateInputs.md +30 -0
- package/docs/EventPageTranslation.md +32 -0
- package/docs/EventPageTranslationUpdateInputs.md +24 -0
- package/docs/EventPageUpdateInputs.md +30 -0
- package/docs/EventPass.md +30 -0
- package/docs/EventPassCreateInputs.md +26 -0
- package/docs/EventPassType.md +34 -0
- package/docs/EventPassTypeCount.md +20 -0
- package/docs/EventPassTypeTranslation.md +32 -0
- package/docs/EventPassUpdateInputs.md +28 -0
- package/docs/EventQuestionChoiceCreateInputs.md +28 -0
- package/docs/EventQuestionChoiceTranslationUpdateInputs.md +24 -0
- package/docs/EventQuestionChoiceUpdateInputs.md +28 -0
- package/docs/EventQuestionCreateInputs.md +66 -0
- package/docs/EventQuestionTranslationUpdateInputs.md +24 -0
- package/docs/EventQuestionUpdateInputs.md +58 -0
- package/docs/EventRegistrationBypassCreateInputs.md +26 -0
- package/docs/EventRegistrationBypassUpdateInputs.md +26 -0
- package/docs/EventReportDateType.md +14 -0
- package/docs/EventRoomType.md +52 -0
- package/docs/EventRoomTypeAddOnDetails.md +22 -0
- package/docs/EventRoomTypeAddOnDetailsUpdateInputs.md +30 -0
- package/docs/EventRoomTypeCount.md +20 -0
- package/docs/EventRoomTypeCreateInputs.md +54 -0
- package/docs/EventRoomTypePassTypeDetails.md +22 -0
- package/docs/EventRoomTypePassTypeDetailsUpdateInputs.md +40 -0
- package/docs/EventRoomTypeReservation.md +26 -0
- package/docs/EventRoomTypeReservationCreateInputs.md +28 -0
- package/docs/EventRoomTypeReservationPassesInner.md +26 -0
- package/docs/EventRoomTypeReservationPassesInnerAttendee.md +22 -0
- package/docs/EventRoomTypeReservationUpdateInputs.md +26 -0
- package/docs/EventRoomTypeTranslation.md +30 -0
- package/docs/EventRoomTypeTranslationUpdateInputs.md +22 -0
- package/docs/EventRoomTypeUpdateInputs.md +54 -0
- package/docs/EventSectionCreateInputs.md +26 -0
- package/docs/EventSectionTranslationUpdateInputs.md +24 -0
- package/docs/EventSectionUpdateInputs.md +26 -0
- package/docs/EventSession.md +34 -0
- package/docs/EventSessionAccess.md +24 -0
- package/docs/EventSessionAccessUpdateInputs.md +20 -0
- package/docs/EventSessionCreateInputs.md +64 -0
- package/docs/EventSessionLocation.md +24 -0
- package/docs/EventSessionLocationCreateInputs.md +36 -0
- package/docs/EventSessionLocationTranslation.md +30 -0
- package/docs/EventSessionLocationTranslationUpdateInputs.md +22 -0
- package/docs/EventSessionLocationUpdateInputs.md +36 -0
- package/docs/EventSessionQuestion.md +30 -0
- package/docs/EventSessionQuestionChoice.md +28 -0
- package/docs/EventSessionQuestionChoiceCreateInputs.md +28 -0
- package/docs/EventSessionQuestionChoiceSubQuestion.md +24 -0
- package/docs/EventSessionQuestionChoiceTranslation.md +32 -0
- package/docs/EventSessionQuestionChoiceTranslationUpdateInputs.md +24 -0
- package/docs/EventSessionQuestionChoiceUpdateInputs.md +28 -0
- package/docs/EventSessionQuestionCount.md +20 -0
- package/docs/EventSessionQuestionCreateInputs.md +68 -0
- package/docs/EventSessionQuestionResponse.md +24 -0
- package/docs/EventSessionQuestionResponseChange.md +22 -0
- package/docs/EventSessionQuestionTranslation.md +32 -0
- package/docs/EventSessionQuestionTranslationUpdateInputs.md +24 -0
- package/docs/EventSessionQuestionType.md +30 -0
- package/docs/EventSessionQuestionUpdateInputs.md +60 -0
- package/docs/EventSessionSection.md +24 -0
- package/docs/EventSessionSectionCreateInputs.md +24 -0
- package/docs/EventSessionSectionQuestion.md +22 -0
- package/docs/EventSessionSectionTranslation.md +30 -0
- package/docs/EventSessionSectionTranslationUpdateInputs.md +24 -0
- package/docs/EventSessionSectionUpdateInputs.md +26 -0
- package/docs/EventSessionTranslation.md +36 -0
- package/docs/EventSessionTranslationUpdateInputs.md +26 -0
- package/docs/EventSessionUpdateInputs.md +64 -0
- package/docs/EventSource.md +12 -0
- package/docs/EventSpeaker.md +44 -0
- package/docs/EventSpeakerCreateInputs.md +58 -0
- package/docs/EventSpeakerTranslation.md +30 -0
- package/docs/EventSpeakerTranslationUpdateInputs.md +22 -0
- package/docs/EventSpeakerUpdateInputs.md +58 -0
- package/docs/EventSponsorship.md +22 -0
- package/docs/EventSponsorshipCreateInputs.md +32 -0
- package/docs/EventSponsorshipLevel.md +26 -0
- package/docs/EventSponsorshipLevelCreateInputs.md +28 -0
- package/docs/EventSponsorshipLevelTranslation.md +30 -0
- package/docs/EventSponsorshipLevelTranslationUpdateInputs.md +22 -0
- package/docs/EventSponsorshipLevelUpdateInputs.md +28 -0
- package/docs/EventSponsorshipTranslation.md +30 -0
- package/docs/EventSponsorshipTranslationUpdateInputs.md +22 -0
- package/docs/EventSponsorshipUpdateInputs.md +32 -0
- package/docs/EventTrack.md +24 -0
- package/docs/EventTrackCount.md +20 -0
- package/docs/EventTrackCreateInputs.md +26 -0
- package/docs/EventTrackTranslation.md +30 -0
- package/docs/EventTrackTranslationUpdateInputs.md +22 -0
- package/docs/EventTrackUpdateInputs.md +26 -0
- package/docs/EventTranslation.md +38 -0
- package/docs/EventTranslationUpdateInputs.md +28 -0
- package/docs/EventType.md +12 -0
- package/docs/EventUpdateInputs.md +130 -0
- package/docs/EventVariantCouponCreateInputs.md +20 -0
- package/docs/EventVariantCouponSyncInputs.md +20 -0
- package/docs/EventsAccessApi.md +181 -0
- package/docs/EventsActivationsApi.md +600 -0
- package/docs/EventsAddonsApi.md +738 -0
- package/docs/EventsApi.md +593 -0
- package/docs/EventsAttendeesApi.md +696 -0
- package/docs/EventsAttendeesPackagesApi.md +314 -0
- package/docs/EventsAttendeesReservationsApi.md +561 -0
- package/docs/EventsBenefitsApi.md +117 -0
- package/docs/EventsBypassApi.md +296 -0
- package/docs/EventsCohostsApi.md +181 -0
- package/docs/EventsCouponsApi.md +673 -0
- package/docs/EventsEmailsApi.md +121 -0
- package/docs/EventsFaqsApi.md +658 -0
- package/docs/EventsFollowupsApi.md +1156 -0
- package/docs/EventsMatchesApi.md +1022 -0
- package/docs/EventsMediaApi.md +482 -0
- package/docs/EventsOnSiteApi.md +344 -0
- package/docs/EventsPackagesApi.md +296 -0
- package/docs/EventsPackagesPassesApi.md +311 -0
- package/docs/EventsPagesApi.md +479 -0
- package/docs/EventsPassesApi.md +1743 -0
- package/docs/EventsPasstypesApi.md +1058 -0
- package/docs/EventsPasstypesPriceschedulesApi.md +311 -0
- package/docs/EventsPasstypesRefundschedulesApi.md +311 -0
- package/docs/EventsQuestionsApi.md +1333 -0
- package/docs/EventsRoomsApi.md +537 -0
- package/docs/EventsRoomtypesApi.md +746 -0
- package/docs/EventsSectionsApi.md +1156 -0
- package/docs/EventsSessionsAccessesApi.md +208 -0
- package/docs/EventsSessionsApi.md +1348 -0
- package/docs/EventsSessionsLocationsApi.md +479 -0
- package/docs/EventsSessionsMatchesApi.md +1018 -0
- package/docs/EventsSessionsQuestionsApi.md +1216 -0
- package/docs/EventsSessionsSectionsApi.md +628 -0
- package/docs/EventsSpeakersApi.md +479 -0
- package/docs/EventsSponsorsApi.md +245 -0
- package/docs/EventsSponsorshiplevelsApi.md +351 -0
- package/docs/EventsSponsorshipsApi.md +369 -0
- package/docs/EventsTemplatesApi.md +68 -0
- package/docs/EventsTracksApi.md +662 -0
- package/docs/ExportStatus.md +12 -0
- package/docs/Faq.md +32 -0
- package/docs/FaqSection.md +28 -0
- package/docs/FaqSectionTranslation.md +28 -0
- package/docs/FaqTranslation.md +30 -0
- package/docs/FileSource.md +12 -0
- package/docs/FileUpdateInputs.md +24 -0
- package/docs/FilesApi.md +231 -0
- package/docs/GetAPILog200Response.md +24 -0
- package/docs/GetAPILogs200Response.md +26 -0
- package/docs/GetAccountActivities200Response.md +26 -0
- package/docs/GetAccountAddress200Response.md +24 -0
- package/docs/GetAccountEvents200Response.md +26 -0
- package/docs/GetAccountGroups200Response.md +26 -0
- package/docs/GetAccountInterests200Response.md +26 -0
- package/docs/GetAccountInvitations200Response.md +26 -0
- package/docs/GetAccountLead200Response.md +24 -0
- package/docs/GetAccountLeads200Response.md +26 -0
- package/docs/GetAccountLevels200Response.md +26 -0
- package/docs/GetAccountLikes200Response.md +26 -0
- package/docs/GetAccountPayments200Response.md +26 -0
- package/docs/GetAccountThreads200Response.md +26 -0
- package/docs/GetAccountTiers200Response.md +26 -0
- package/docs/GetAccounts200Response.md +26 -0
- package/docs/GetAdvertisements200Response.md +26 -0
- package/docs/GetAnnouncements200Response.md +26 -0
- package/docs/GetAuthSession200Response.md +24 -0
- package/docs/GetBenefitClicks200Response.md +26 -0
- package/docs/GetBenefits200Response.md +26 -0
- package/docs/GetBookingPlaceBookings200Response.md +26 -0
- package/docs/GetBookingPlaces200Response.md +26 -0
- package/docs/GetBookingSpaces200Response.md +26 -0
- package/docs/GetChannelContent200Response.md +24 -0
- package/docs/GetChannelContents200Response.md +26 -0
- package/docs/GetChannels200Response.md +26 -0
- package/docs/GetCustomModules200Response.md +26 -0
- package/docs/GetCustomReport200Response.md +24 -0
- package/docs/GetCustomReportUsers200Response.md +24 -0
- package/docs/GetCustomReports200Response.md +26 -0
- package/docs/GetDashboards200Response.md +26 -0
- package/docs/GetEmailReceipt200Response.md +24 -0
- package/docs/GetEntityUseCodes200Response.md +24 -0
- package/docs/GetEventAccessUsers200Response.md +26 -0
- package/docs/GetEventActivation200Response.md +24 -0
- package/docs/GetEventAddOnPasses200Response.md +26 -0
- package/docs/GetEventAddOns200Response.md +26 -0
- package/docs/GetEventAttendeeCoupons200Response.md +26 -0
- package/docs/GetEventAttendees200Response.md +26 -0
- package/docs/GetEventEmail200Response.md +24 -0
- package/docs/GetEventFaqSectionQuestions200Response.md +26 -0
- package/docs/GetEventFaqSections200Response.md +26 -0
- package/docs/GetEventMediaItem200Response.md +24 -0
- package/docs/GetEventMediaItems200Response.md +26 -0
- package/docs/GetEventOnSite200Response.md +24 -0
- package/docs/GetEventPackages200Response.md +26 -0
- package/docs/GetEventPageImages200Response.md +26 -0
- package/docs/GetEventPages200Response.md +26 -0
- package/docs/GetEventPassMatches200Response.md +24 -0
- package/docs/GetEventPassTypes200Response.md +26 -0
- package/docs/GetEventQuestionSummary200Response.md +24 -0
- package/docs/GetEventRoomTypes200Response.md +26 -0
- package/docs/GetEventRoundMatches200Response.md +26 -0
- package/docs/GetEventRounds200Response.md +24 -0
- package/docs/GetEventSection200Response.md +24 -0
- package/docs/GetEventSessionTracks200Response.md +26 -0
- package/docs/GetEventSessions200Response.md +26 -0
- package/docs/GetEventSpeakers200Response.md +26 -0
- package/docs/GetEventTiers200Response.md +24 -0
- package/docs/GetEvents200Response.md +26 -0
- package/docs/GetFiles200Response.md +26 -0
- package/docs/GetGroupInvitation200Response.md +24 -0
- package/docs/GetGroupRequest200Response.md +24 -0
- package/docs/GetGroupRequests200Response.md +26 -0
- package/docs/GetGroups200Response.md +26 -0
- package/docs/GetImageUsage200Response.md +24 -0
- package/docs/GetImages200Response.md +26 -0
- package/docs/GetImport200Response.md +24 -0
- package/docs/GetImportItems200Response.md +26 -0
- package/docs/GetImports200Response.md +26 -0
- package/docs/GetIntegrations200Response.md +26 -0
- package/docs/GetInvoiceLineItem200Response.md +24 -0
- package/docs/GetInvoices200Response.md +26 -0
- package/docs/GetLivestream200Response.md +24 -0
- package/docs/GetLivestreams200Response.md +26 -0
- package/docs/GetLogin200Response.md +24 -0
- package/docs/GetLoginAuthSessions200Response.md +26 -0
- package/docs/GetLoginDevices200Response.md +26 -0
- package/docs/GetLogins200Response.md +26 -0
- package/docs/GetMeetingLinks200Response.md +26 -0
- package/docs/GetMeetingSession200Response.md +24 -0
- package/docs/GetMeetings200Response.md +26 -0
- package/docs/GetOrganization200Response.md +24 -0
- package/docs/GetOrganizationWebhooks200Response.md +26 -0
- package/docs/GetPayment200Response.md +24 -0
- package/docs/GetPresets200Response.md +26 -0
- package/docs/GetPushDevice200Response.md +24 -0
- package/docs/GetReport200Response.md +24 -0
- package/docs/GetReports200Response.md +24 -0
- package/docs/GetRoomTypeRooms200Response.md +26 -0
- package/docs/GetSearchListValue200Response.md +24 -0
- package/docs/GetSearchLists200Response.md +26 -0
- package/docs/GetSelf200Response.md +24 -0
- package/docs/GetSelfApiKeys200Response.md +26 -0
- package/docs/GetSelfOrganizations200Response.md +26 -0
- package/docs/GetSeriesList200Response.md +26 -0
- package/docs/GetStreamInputs200Response.md +26 -0
- package/docs/GetStreamSession200Response.md +24 -0
- package/docs/GetStreamSessions200Response.md +26 -0
- package/docs/GetStreamVideos200Response.md +26 -0
- package/docs/GetSupportTickets200Response.md +26 -0
- package/docs/GetSurveyQuestion200Response.md +24 -0
- package/docs/GetSurveyQuestions200Response.md +26 -0
- package/docs/GetSurveySections200Response.md +26 -0
- package/docs/GetSurveys200Response.md +26 -0
- package/docs/GetTaxCodes200Response.md +24 -0
- package/docs/GetTaxIntegration200Response.md +24 -0
- package/docs/GetTaxIntegrations200Response.md +26 -0
- package/docs/GetTaxLog200Response.md +24 -0
- package/docs/GetTaxLogs200Response.md +26 -0
- package/docs/GetThreadCircles200Response.md +26 -0
- package/docs/GetThreadMembers200Response.md +26 -0
- package/docs/GetThreadMessageFiles200Response.md +24 -0
- package/docs/GetThreadMessageImages200Response.md +24 -0
- package/docs/GetThreadMessageVideos200Response.md +24 -0
- package/docs/GetThreadMessages200Response.md +24 -0
- package/docs/GetVideo200Response.md +24 -0
- package/docs/GetVideoCaptions200Response.md +26 -0
- package/docs/Group.md +30 -0
- package/docs/GroupAccess.md +10 -0
- package/docs/GroupCount.md +24 -0
- package/docs/GroupCreateInputs.md +38 -0
- package/docs/GroupInvitation.md +30 -0
- package/docs/GroupInvitationStatus.md +12 -0
- package/docs/GroupMembership.md +32 -0
- package/docs/GroupMembershipRole.md +10 -0
- package/docs/GroupMembershipUpdateInputs.md +32 -0
- package/docs/GroupRequest.md +26 -0
- package/docs/GroupRequestStatus.md +10 -0
- package/docs/GroupTranslation.md +34 -0
- package/docs/GroupTranslationUpdateInputs.md +24 -0
- package/docs/GroupUpdateInputs.md +38 -0
- package/docs/GroupsApi.md +421 -0
- package/docs/GroupsEventsApi.md +184 -0
- package/docs/GroupsInterestsApi.md +181 -0
- package/docs/GroupsInvitationsApi.md +352 -0
- package/docs/GroupsMembersApi.md +233 -0
- package/docs/GroupsModeratorsApi.md +181 -0
- package/docs/GroupsRequestsApi.md +294 -0
- package/docs/GroupsSponsorsApi.md +181 -0
- package/docs/Image.md +26 -0
- package/docs/ImageCreateInputs.md +26 -0
- package/docs/ImageModerationLevel.md +10 -0
- package/docs/ImageType.md +18 -0
- package/docs/ImageUpdateInputs.md +24 -0
- package/docs/ImageUsage.md +20 -0
- package/docs/ImageUsageCount.md +32 -0
- package/docs/ImageWCopyUri.md +20 -0
- package/docs/ImagesApi.md +443 -0
- package/docs/ImpersonateAccount200Response.md +24 -0
- package/docs/Import.md +24 -0
- package/docs/ImportCount.md +20 -0
- package/docs/ImportCreateInputs.md +22 -0
- package/docs/ImportCreateInputsValuesInner.md +20 -0
- package/docs/ImportItem.md +20 -0
- package/docs/ImportItemStatus.md +12 -0
- package/docs/ImportRooms200Response.md +24 -0
- package/docs/ImportType.md +8 -0
- package/docs/ImportsApi.md +246 -0
- package/docs/IndexEventPasses200Response.md +24 -0
- package/docs/Integration.md +26 -0
- package/docs/IntegrationCreateInputs.md +28 -0
- package/docs/IntegrationDetails.md +26 -0
- package/docs/IntegrationType.md +8 -0
- package/docs/IntegrationUpdateInputs.md +26 -0
- package/docs/Interest.md +24 -0
- package/docs/InterestCount.md +22 -0
- package/docs/InterestCreateInputs.md +20 -0
- package/docs/InterestInputs.md +22 -0
- package/docs/InterestUpdateInputs.md +24 -0
- package/docs/InterestsApi.md +668 -0
- package/docs/Invoice.md +32 -0
- package/docs/InvoiceCreateInputs.md +32 -0
- package/docs/InvoiceLineItem.md +22 -0
- package/docs/InvoiceLineItemCreateInputs.md +32 -0
- package/docs/InvoiceLineItemCreateInputsQuantity.md +18 -0
- package/docs/InvoiceLineItemUpdateInputs.md +32 -0
- package/docs/InvoiceStatus.md +14 -0
- package/docs/InvoiceUpdateInputs.md +32 -0
- package/docs/InvoicesApi.md +577 -0
- package/docs/InvoicesLineitemsApi.md +177 -0
- package/docs/Lead.md +44 -0
- package/docs/LeadAttributesInner.md +22 -0
- package/docs/LeadCreateInputs.md +22 -0
- package/docs/LeadStatus.md +14 -0
- package/docs/LeadUpdateInputs.md +22 -0
- package/docs/Level.md +26 -0
- package/docs/LevelCreateInputs.md +34 -0
- package/docs/LevelTranslationUpdateInputs.md +24 -0
- package/docs/LevelUpdateInputs.md +34 -0
- package/docs/LevelsAccountsApi.md +181 -0
- package/docs/LevelsApi.md +281 -0
- package/docs/Like.md +22 -0
- package/docs/LineChartSummaryData.md +26 -0
- package/docs/LinkInputs.md +22 -0
- package/docs/Livestream.md +38 -0
- package/docs/LivestreamSession.md +36 -0
- package/docs/LocationQuestionOption.md +12 -0
- package/docs/Login.md +20 -0
- package/docs/LoginCount.md +22 -0
- package/docs/LoginsAccountsApi.md +181 -0
- package/docs/LoginsApi.md +465 -0
- package/docs/MarkNotificationsReadInputs.md +20 -0
- package/docs/Match.md +24 -0
- package/docs/MatchQuestionType.md +12 -0
- package/docs/MatchUpdateInputs.md +22 -0
- package/docs/Meeting.md +42 -0
- package/docs/MeetingCreateInputs.md +40 -0
- package/docs/MeetingLink.md +22 -0
- package/docs/MeetingLinkCreateInputs.md +24 -0
- package/docs/MeetingLinkUpdateInputs.md +24 -0
- package/docs/MeetingParticipant.md +32 -0
- package/docs/MeetingParticipantCreateInputs.md +24 -0
- package/docs/MeetingParticipantUpdateInputs.md +24 -0
- package/docs/MeetingPresetCreateInputs.md +20 -0
- package/docs/MeetingPresetUpdateInputs.md +20 -0
- package/docs/MeetingRecordingCreateInputs.md +50 -0
- package/docs/MeetingRecordingUpdateInputs.md +20 -0
- package/docs/MeetingSession.md +48 -0
- package/docs/MeetingSessionChatDownload.md +22 -0
- package/docs/MeetingSessionParticipant.md +22 -0
- package/docs/MeetingSessionParticipantPeerStats.md +30 -0
- package/docs/MeetingSessionParticipantPeerStatsDeviceInfo.md +42 -0
- package/docs/MeetingSessionParticipantPeerStatsEventsInner.md +22 -0
- package/docs/MeetingSessionParticipantPeerStatsIpInformation.md +34 -0
- package/docs/MeetingSessionParticipantPeerStatsPrecallNetworkInformation.md +36 -0
- package/docs/MeetingSessionParticipantQualityStatsInner.md +38 -0
- package/docs/MeetingSessionParticipantQualityStatsInnerAudioStatsInner.md +28 -0
- package/docs/MeetingSessionParticipantQualityStatsInnerVideoStatsInner.md +34 -0
- package/docs/MeetingSessionSummaryDownload.md +24 -0
- package/docs/MeetingSessionTranscriptDownload.md +24 -0
- package/docs/MeetingType.md +12 -0
- package/docs/MeetingUpdateInputs.md +42 -0
- package/docs/MeetingsApi.md +385 -0
- package/docs/MeetingsLinksApi.md +296 -0
- package/docs/MeetingsLivestreamsApi.md +340 -0
- package/docs/MeetingsParticipantsApi.md +351 -0
- package/docs/MeetingsPresetsApi.md +281 -0
- package/docs/MeetingsRecordingsApi.md +123 -0
- package/docs/MeetingsSessionsApi.md +450 -0
- package/docs/MentionInputs.md +22 -0
- package/docs/ModerationStatus.md +12 -0
- package/docs/ModulePermissions.md +30 -0
- package/docs/Notification.md +30 -0
- package/docs/NotificationFilters.md +24 -0
- package/docs/NotificationPreferences.md +48 -0
- package/docs/NotificationStats.md +26 -0
- package/docs/NotificationType.md +30 -0
- package/docs/NotificationsApi.md +222 -0
- package/docs/Organization.md +156 -0
- package/docs/OrganizationActionType.md +14 -0
- package/docs/OrganizationApi.md +498 -0
- package/docs/OrganizationAttributesApi.md +371 -0
- package/docs/OrganizationDomainsApi.md +149 -0
- package/docs/OrganizationIntegrationsApi.md +281 -0
- package/docs/OrganizationMembership.md +94 -0
- package/docs/OrganizationMembershipUpdateInputs.md +72 -0
- package/docs/OrganizationModule.md +28 -0
- package/docs/OrganizationModuleType.md +36 -0
- package/docs/OrganizationModuleUpdateInputs.md +26 -0
- package/docs/OrganizationModulesApi.md +176 -0
- package/docs/OrganizationModulesCustomApi.md +281 -0
- package/docs/OrganizationModulesTiersApi.md +355 -0
- package/docs/OrganizationOAuthInner.md +20 -0
- package/docs/OrganizationPageCreateInputs.md +24 -0
- package/docs/OrganizationPageTranslationUpdateInputs.md +24 -0
- package/docs/OrganizationPageUpdateInputs.md +24 -0
- package/docs/OrganizationPaymentIntegrationCreateInputs.md +32 -0
- package/docs/OrganizationPaymentIntegrationUpdateInputs.md +20 -0
- package/docs/OrganizationPaymentsApi.md +504 -0
- package/docs/OrganizationSideeffectsApi.md +239 -0
- package/docs/OrganizationTaxApi.md +611 -0
- package/docs/OrganizationTeamMemberCreateInputs.md +52 -0
- package/docs/OrganizationTeamMemberUpdateInputs.md +52 -0
- package/docs/OrganizationTeammembersApi.md +281 -0
- package/docs/OrganizationTrigger.md +30 -0
- package/docs/OrganizationTriggerType.md +8 -0
- package/docs/OrganizationUpdateInputs.md +124 -0
- package/docs/OrganizationUsersApi.md +172 -0
- package/docs/OrganizationWebhooksApi.md +333 -0
- package/docs/PageType.md +14 -0
- package/docs/PassAddOn.md +22 -0
- package/docs/PassTypeAccessLevel.md +12 -0
- package/docs/PassTypeCreateInputs.md +70 -0
- package/docs/PassTypePriceScheduleCreateInputs.md +28 -0
- package/docs/PassTypePriceScheduleUpdateInputs.md +28 -0
- package/docs/PassTypeRefundScheduleCreateInputs.md +24 -0
- package/docs/PassTypeRefundScheduleUpdateInputs.md +24 -0
- package/docs/PassTypeTranslationUpdateInputs.md +24 -0
- package/docs/PassTypeUpdateInputs.md +74 -0
- package/docs/PassTypeVisibility.md +10 -0
- package/docs/Payment.md +70 -0
- package/docs/PaymentIntegration.md +20 -0
- package/docs/PaymentIntegrationType.md +16 -0
- package/docs/PaymentLineItem.md +34 -0
- package/docs/PaymentLineItemType.md +26 -0
- package/docs/PaymentType.md +10 -0
- package/docs/PaymentUpdateInputs.md +22 -0
- package/docs/PaymentsApi.md +63 -0
- package/docs/PaypalActivationFormParams.md +26 -0
- package/docs/PreferencesApi.md +105 -0
- package/docs/PurchaseStatus.md +14 -0
- package/docs/PushDevicesApi.md +175 -0
- package/docs/PushService.md +14 -0
- package/docs/Question.md +22 -0
- package/docs/RecordingAction.md +12 -0
- package/docs/RefundLineItem.md +22 -0
- package/docs/RegistrationFollowup.md +32 -0
- package/docs/RegistrationFollowupQuestion.md +22 -0
- package/docs/RegistrationFollowupTranslation.md +30 -0
- package/docs/RegistrationQuestion.md +30 -0
- package/docs/RegistrationQuestionChoice.md +28 -0
- package/docs/RegistrationQuestionChoiceSubQuestion.md +24 -0
- package/docs/RegistrationQuestionChoiceTranslation.md +32 -0
- package/docs/RegistrationQuestionResponse.md +24 -0
- package/docs/RegistrationQuestionResponseChange.md +22 -0
- package/docs/RegistrationQuestionTranslation.md +32 -0
- package/docs/RegistrationQuestionType.md +28 -0
- package/docs/RegistrationSection.md +32 -0
- package/docs/RegistrationSectionQuestion.md +22 -0
- package/docs/RegistrationSectionTranslation.md +30 -0
- package/docs/ReportFilters.md +34 -0
- package/docs/ReportType.md +50 -0
- package/docs/ReportsApi.md +396 -0
- package/docs/ReportsUsersApi.md +169 -0
- package/docs/Room.md +22 -0
- package/docs/RoomCreateInputs.md +20 -0
- package/docs/RoomUpdateInputs.md +20 -0
- package/docs/Round.md +24 -0
- package/docs/RoundEventQuestion.md +22 -0
- package/docs/RoundEventQuestionUpdataInputs.md +20 -0
- package/docs/RoundMatchesInner.md +24 -0
- package/docs/RoundSessionQuestion.md +22 -0
- package/docs/RoundSessionQuestionUpdateInputs.md +20 -0
- package/docs/SearchField.md +40 -0
- package/docs/SearchList.md +24 -0
- package/docs/SearchListConnectedQuestion.md +42 -0
- package/docs/SearchListCreateInputs.md +20 -0
- package/docs/SearchListUpdateInputs.md +20 -0
- package/docs/SearchListValue.md +24 -0
- package/docs/SearchListValueCreateInputs.md +22 -0
- package/docs/SearchListValueUpdateInputs.md +22 -0
- package/docs/SearchOrganization200Response.md +24 -0
- package/docs/SearchOrganizationFilters.md +30 -0
- package/docs/SearchlistsApi.md +281 -0
- package/docs/SearchlistsValuesApi.md +403 -0
- package/docs/SegmentInputs.md +20 -0
- package/docs/SelfApi.md +263 -0
- package/docs/SelfApikeysApi.md +225 -0
- package/docs/SelfImagesApi.md +105 -0
- package/docs/Series.md +28 -0
- package/docs/SeriesApi.md +455 -0
- package/docs/SeriesCreateInputs.md +34 -0
- package/docs/SeriesUpdateInputs.md +34 -0
- package/docs/SessionAccess.md +10 -0
- package/docs/SideEffect.md +44 -0
- package/docs/SideEffectActionType.md +16 -0
- package/docs/SideEffectTriggerType.md +14 -0
- package/docs/SponsorshipLevelTranslation.md +32 -0
- package/docs/StandardReport.md +24 -0
- package/docs/StorageApi.md +65 -0
- package/docs/StorageConfig.md +42 -0
- package/docs/StreamInput.md +44 -0
- package/docs/StreamInputCreateInputs.md +44 -0
- package/docs/StreamInputDetails.md +46 -0
- package/docs/StreamInputDetailsRecording.md +24 -0
- package/docs/StreamInputDetailsRtmps.md +22 -0
- package/docs/StreamInputDetailsSrt.md +24 -0
- package/docs/StreamInputDetailsWebRTC.md +20 -0
- package/docs/StreamInputOutput.md +26 -0
- package/docs/StreamInputOutputCreateInputs.md +24 -0
- package/docs/StreamInputOutputUpdateInputs.md +20 -0
- package/docs/StreamInputUpdateInputs.md +44 -0
- package/docs/StreamOutputCreateInputs.md +24 -0
- package/docs/StreamSession.md +22 -0
- package/docs/StreamSessionChatMessage.md +34 -0
- package/docs/StreamSessionSubscription.md +22 -0
- package/docs/StreamsApi.md +413 -0
- package/docs/StreamsOutputsApi.md +296 -0
- package/docs/StreamsSessionsApi.md +364 -0
- package/docs/StripeActivationFormParams.md +26 -0
- package/docs/SummaryData.md +26 -0
- package/docs/SupportApi.md +168 -0
- package/docs/SupportMessagesApi.md +63 -0
- package/docs/SupportNotesApi.md +118 -0
- package/docs/SupportTicket.md +42 -0
- package/docs/SupportTicketActivityLog.md +22 -0
- package/docs/SupportTicketActivitySource.md +12 -0
- package/docs/SupportTicketActivityType.md +16 -0
- package/docs/SupportTicketCreateInputs.md +28 -0
- package/docs/SupportTicketMessage.md +22 -0
- package/docs/SupportTicketMessageCreateInputs.md +20 -0
- package/docs/SupportTicketMessageSource.md +12 -0
- package/docs/SupportTicketNote.md +24 -0
- package/docs/SupportTicketNoteCreateInputs.md +20 -0
- package/docs/SupportTicketState.md +14 -0
- package/docs/SupportTicketType.md +12 -0
- package/docs/SupportTicketUpdateInputs.md +30 -0
- package/docs/SupportedLocale.md +136 -0
- package/docs/SupportticketsApi.md +248 -0
- package/docs/SupportticketsMessagesApi.md +71 -0
- package/docs/SupportticketsNotesApi.md +71 -0
- package/docs/Survey.md +26 -0
- package/docs/SurveyCreateInputs.md +34 -0
- package/docs/SurveyQuestion.md +30 -0
- package/docs/SurveyQuestionChoice.md +28 -0
- package/docs/SurveyQuestionChoiceCreateInputs.md +28 -0
- package/docs/SurveyQuestionChoiceSubQuestion.md +24 -0
- package/docs/SurveyQuestionChoiceTranslation.md +32 -0
- package/docs/SurveyQuestionChoiceTranslationUpdateInputs.md +24 -0
- package/docs/SurveyQuestionChoiceUpdateInputs.md +28 -0
- package/docs/SurveyQuestionCreateInputs.md +64 -0
- package/docs/SurveyQuestionResponse.md +24 -0
- package/docs/SurveyQuestionResponseChange.md +22 -0
- package/docs/SurveyQuestionTranslation.md +32 -0
- package/docs/SurveyQuestionTranslationUpdateInputs.md +24 -0
- package/docs/SurveyQuestionType.md +28 -0
- package/docs/SurveyQuestionUpdateInputs.md +56 -0
- package/docs/SurveySection.md +24 -0
- package/docs/SurveySectionCreateInputs.md +24 -0
- package/docs/SurveySectionQuestion.md +22 -0
- package/docs/SurveySectionTranslation.md +30 -0
- package/docs/SurveySectionTranslationUpdateInputs.md +24 -0
- package/docs/SurveySectionUpdateInputs.md +26 -0
- package/docs/SurveySubmission.md +22 -0
- package/docs/SurveySubmissionUpdateInputs.md +20 -0
- package/docs/SurveyTranslation.md +30 -0
- package/docs/SurveyTranslationUpdateInputs.md +24 -0
- package/docs/SurveyUpdateInputs.md +34 -0
- package/docs/SurveysApi.md +281 -0
- package/docs/SurveysQuestionsApi.md +1159 -0
- package/docs/SurveysSectionsApi.md +598 -0
- package/docs/SurveysSubmissionsApi.md +435 -0
- package/docs/SystemEventLog.md +32 -0
- package/docs/SystemEventLogStatus.md +10 -0
- package/docs/TableChartSummaryData.md +26 -0
- package/docs/TableChartSummaryDataDataInner.md +20 -0
- package/docs/TaxCode.md +22 -0
- package/docs/TaxIntegration.md +54 -0
- package/docs/TaxIntegrationCreateInputs.md +26 -0
- package/docs/TaxIntegrationLog.md +22 -0
- package/docs/TaxIntegrationLogType.md +12 -0
- package/docs/TaxIntegrationType.md +14 -0
- package/docs/TaxIntegrationUpdateInputs.md +40 -0
- package/docs/TaxLocationType.md +10 -0
- package/docs/TeamCreateInputs.md +24 -0
- package/docs/TeamMember.md +40 -0
- package/docs/TeamUpdateInputs.md +24 -0
- package/docs/ThreadCircleAccountCreateInputs.md +22 -0
- package/docs/ThreadCircleAccountRole.md +12 -0
- package/docs/ThreadCircleAccountUpdateInputs.md +20 -0
- package/docs/ThreadCircleCreateInputs.md +20 -0
- package/docs/ThreadCircleType.md +10 -0
- package/docs/ThreadCircleUpdateInputs.md +20 -0
- package/docs/ThreadCreateInputs.md +28 -0
- package/docs/ThreadInvitation.md +42 -0
- package/docs/ThreadInvitationStatus.md +10 -0
- package/docs/ThreadMember.md +22 -0
- package/docs/ThreadMemberRole.md +10 -0
- package/docs/ThreadMemberUpdateInputs.md +20 -0
- package/docs/ThreadMessage.md +34 -0
- package/docs/ThreadMessageCreateInputs.md +24 -0
- package/docs/ThreadMessageReaction.md +30 -0
- package/docs/ThreadMessageReactionCreateInputs.md +20 -0
- package/docs/ThreadMessageReactionUpdateInputs.md +20 -0
- package/docs/ThreadMessageType.md +12 -0
- package/docs/ThreadMessageUpdateInputs.md +22 -0
- package/docs/ThreadType.md +14 -0
- package/docs/ThreadUpdateInputs.md +22 -0
- package/docs/ThreadsApi.md +284 -0
- package/docs/ThreadsCirclesAccountsApi.md +299 -0
- package/docs/ThreadsCirclesApi.md +348 -0
- package/docs/ThreadsMembersApi.md +194 -0
- package/docs/ThreadsMessagesApi.md +339 -0
- package/docs/ThreadsMessagesFilesApi.md +178 -0
- package/docs/ThreadsMessagesImagesApi.md +178 -0
- package/docs/ThreadsMessagesReactionsApi.md +182 -0
- package/docs/ThreadsMessagesVideosApi.md +178 -0
- package/docs/Tier.md +28 -0
- package/docs/TierCount.md +20 -0
- package/docs/TierCreateInputs.md +36 -0
- package/docs/TierUpdateInputs.md +36 -0
- package/docs/TiersApi.md +586 -0
- package/docs/Transfer.md +22 -0
- package/docs/TransferLog.md +28 -0
- package/docs/TriggerCreateInputs.md +22 -0
- package/docs/TriggerUpdateInputs.md +22 -0
- package/docs/UpdateEventCheckinCode200Response.md +24 -0
- package/docs/UpdateEventPassResponseInputs.md +20 -0
- package/docs/UpdateSelf200Response.md +24 -0
- package/docs/UpdateThreadMember200Response.md +24 -0
- package/docs/UploadFile200Response.md +24 -0
- package/docs/UploadVideoCaptions200Response.md +24 -0
- package/docs/UpsertLinkPreview200Response.md +24 -0
- package/docs/User.md +24 -0
- package/docs/UserApiKey.md +38 -0
- package/docs/UserApiKeyCreateInputs.md +26 -0
- package/docs/UserImageUpdateInputs.md +22 -0
- package/docs/UserImageUpdateInputsImageDataUri.md +18 -0
- package/docs/UserRole.md +10 -0
- package/docs/UserUpdateInputs.md +26 -0
- package/docs/Video.md +26 -0
- package/docs/VideoCaption.md +26 -0
- package/docs/VideoSource.md +12 -0
- package/docs/VideoStatus.md +18 -0
- package/docs/VideoUpdateInputs.md +22 -0
- package/docs/VideosApi.md +387 -0
- package/docs/VideosCaptionsApi.md +297 -0
- package/docs/Webhook.md +22 -0
- package/docs/WebhookCreateInputs.md +24 -0
- package/docs/WebhookUpdateInputs.md +20 -0
- package/docs/WidgetCategory.md +10 -0
- package/docs/WidgetType.md +12 -0
- package/git_push.sh +57 -0
- package/index.ts +15 -0
- package/package.json +33 -0
- package/tsconfig.esm.json +7 -0
- package/tsconfig.json +18 -0
|
@@ -0,0 +1,1729 @@
|
|
|
1
|
+
# ChannelsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://admin-api.connected.dev*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**addChannelSubscriber**](#addchannelsubscriber) | **POST** /channels/{channelId}/subscribers | Add Channel Subscriber|
|
|
8
|
+
|[**cancelChannelContentPublishSchedule**](#cancelchannelcontentpublishschedule) | **DELETE** /channels/{channelId}/contents/{contentId}/schedule | Cancel Channel Content Publish Schedule|
|
|
9
|
+
|[**createChannel**](#createchannel) | **POST** /channels | Create Channel|
|
|
10
|
+
|[**createChannelContent**](#createchannelcontent) | **POST** /channels/{channelId}/contents | Create Channel Content|
|
|
11
|
+
|[**createChannelContentGuest**](#createchannelcontentguest) | **POST** /channels/{channelId}/contents/{contentId}/guests | Create Channel Content Guest|
|
|
12
|
+
|[**deleteChannel**](#deletechannel) | **DELETE** /channels/{channelId} | Delete Channel|
|
|
13
|
+
|[**deleteChannelContent**](#deletechannelcontent) | **DELETE** /channels/{channelId}/contents/{contentId} | Delete Channel Content|
|
|
14
|
+
|[**deleteChannelContentGuest**](#deletechannelcontentguest) | **DELETE** /channels/{channelId}/contents/{contentId}/guests/{guestId} | Delete Channel Content Guest|
|
|
15
|
+
|[**getChannel**](#getchannel) | **GET** /channels/{channelId} | Get Channel|
|
|
16
|
+
|[**getChannelActivities**](#getchannelactivities) | **GET** /channels/{channelId}/activities | Get Channel Activities|
|
|
17
|
+
|[**getChannelContent**](#getchannelcontent) | **GET** /channels/{channelId}/contents/{contentId} | Get Channel Content|
|
|
18
|
+
|[**getChannelContentActivities**](#getchannelcontentactivities) | **GET** /channels/{channelId}/contents/{contentId}/activities | Get Channel Content Activities|
|
|
19
|
+
|[**getChannelContentGuest**](#getchannelcontentguest) | **GET** /channels/{channelId}/contents/{contentId}/guests/{guestId} | Get Channel Content Guest|
|
|
20
|
+
|[**getChannelContentGuests**](#getchannelcontentguests) | **GET** /channels/{channelId}/contents/{contentId}/guests | Get Channel Content Guests|
|
|
21
|
+
|[**getChannelContentLikes**](#getchannelcontentlikes) | **GET** /channels/{channelId}/contents/{contentId}/likes | Get Channel Content Likes|
|
|
22
|
+
|[**getChannelContents**](#getchannelcontents) | **GET** /channels/{channelId}/contents | Get Channel Contents|
|
|
23
|
+
|[**getChannelSubscriber**](#getchannelsubscriber) | **GET** /channels/{channelId}/subscribers/{accountId} | Get Channel Subscriber|
|
|
24
|
+
|[**getChannelSubscribers**](#getchannelsubscribers) | **GET** /channels/{channelId}/subscribers | Get Channel Subscribers|
|
|
25
|
+
|[**getChannels**](#getchannels) | **GET** /channels | Get Channels|
|
|
26
|
+
|[**getContents**](#getcontents) | **GET** /contents | Get Contents|
|
|
27
|
+
|[**getFeaturedChannels**](#getfeaturedchannels) | **GET** /channels/featured | Get Featured Channels|
|
|
28
|
+
|[**removeAllChannelSubscribers**](#removeallchannelsubscribers) | **DELETE** /channels/{channelId}/subscribers | Remove All Channel Subscribers|
|
|
29
|
+
|[**removeChannelSubscriber**](#removechannelsubscriber) | **DELETE** /channels/{channelId}/subscribers/{accountId} | Remove Channel Subscriber|
|
|
30
|
+
|[**revertChannelContentToDraft**](#revertchannelcontenttodraft) | **PUT** /channels/{channelId}/contents/{contentId}/revertToDraft | Revert Channel Content To Draft|
|
|
31
|
+
|[**updateChannel**](#updatechannel) | **PUT** /channels/{channelId} | Update Channel|
|
|
32
|
+
|[**updateChannelContent**](#updatechannelcontent) | **PUT** /channels/{channelId}/contents/{contentId} | Update Channel Content|
|
|
33
|
+
|[**updateChannelContentGuest**](#updatechannelcontentguest) | **PUT** /channels/{channelId}/contents/{contentId}/guests/{guestId} | Update Channel Content Guest|
|
|
34
|
+
|[**updateChannelContentPublishSchedule**](#updatechannelcontentpublishschedule) | **POST** /channels/{channelId}/contents/{contentId}/schedule | Update Channel Content Publish Schedule|
|
|
35
|
+
|[**updateChannelSubscriber**](#updatechannelsubscriber) | **PUT** /channels/{channelId}/subscribers/{accountId} | Update Channel Subscriber|
|
|
36
|
+
|
|
37
|
+
# **addChannelSubscriber**
|
|
38
|
+
> CreateAccountAddress200Response addChannelSubscriber()
|
|
39
|
+
|
|
40
|
+
Add Channel Subscriber endpoint
|
|
41
|
+
|
|
42
|
+
### Example
|
|
43
|
+
|
|
44
|
+
```typescript
|
|
45
|
+
import {
|
|
46
|
+
ChannelsApi,
|
|
47
|
+
Configuration
|
|
48
|
+
} from '@connectedxm/admin-sdk';
|
|
49
|
+
|
|
50
|
+
const configuration = new Configuration();
|
|
51
|
+
const apiInstance = new ChannelsApi(configuration);
|
|
52
|
+
|
|
53
|
+
let channelId: string; //The channel identifier (default to undefined)
|
|
54
|
+
let accountId: string; //Filter by accountId (default to undefined)
|
|
55
|
+
|
|
56
|
+
const { status, data } = await apiInstance.addChannelSubscriber(
|
|
57
|
+
channelId,
|
|
58
|
+
accountId
|
|
59
|
+
);
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### Parameters
|
|
63
|
+
|
|
64
|
+
|Name | Type | Description | Notes|
|
|
65
|
+
|------------- | ------------- | ------------- | -------------|
|
|
66
|
+
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
|
|
67
|
+
| **accountId** | [**string**] | Filter by accountId | defaults to undefined|
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
### Return type
|
|
71
|
+
|
|
72
|
+
**CreateAccountAddress200Response**
|
|
73
|
+
|
|
74
|
+
### Authorization
|
|
75
|
+
|
|
76
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
77
|
+
|
|
78
|
+
### HTTP request headers
|
|
79
|
+
|
|
80
|
+
- **Content-Type**: Not defined
|
|
81
|
+
- **Accept**: application/json
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
### HTTP response details
|
|
85
|
+
| Status code | Description | Response headers |
|
|
86
|
+
|-------------|-------------|------------------|
|
|
87
|
+
|**200** | Successful response | - |
|
|
88
|
+
|
|
89
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
90
|
+
|
|
91
|
+
# **cancelChannelContentPublishSchedule**
|
|
92
|
+
> CreateAccountAddress200Response cancelChannelContentPublishSchedule()
|
|
93
|
+
|
|
94
|
+
Cancel Channel Content Publish Schedule endpoint
|
|
95
|
+
|
|
96
|
+
### Example
|
|
97
|
+
|
|
98
|
+
```typescript
|
|
99
|
+
import {
|
|
100
|
+
ChannelsApi,
|
|
101
|
+
Configuration
|
|
102
|
+
} from '@connectedxm/admin-sdk';
|
|
103
|
+
|
|
104
|
+
const configuration = new Configuration();
|
|
105
|
+
const apiInstance = new ChannelsApi(configuration);
|
|
106
|
+
|
|
107
|
+
let channelId: string; //The channel identifier (default to undefined)
|
|
108
|
+
let contentId: string; //The content identifier (default to undefined)
|
|
109
|
+
|
|
110
|
+
const { status, data } = await apiInstance.cancelChannelContentPublishSchedule(
|
|
111
|
+
channelId,
|
|
112
|
+
contentId
|
|
113
|
+
);
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
### Parameters
|
|
117
|
+
|
|
118
|
+
|Name | Type | Description | Notes|
|
|
119
|
+
|------------- | ------------- | ------------- | -------------|
|
|
120
|
+
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
|
|
121
|
+
| **contentId** | [**string**] | The content identifier | defaults to undefined|
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
### Return type
|
|
125
|
+
|
|
126
|
+
**CreateAccountAddress200Response**
|
|
127
|
+
|
|
128
|
+
### Authorization
|
|
129
|
+
|
|
130
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
131
|
+
|
|
132
|
+
### HTTP request headers
|
|
133
|
+
|
|
134
|
+
- **Content-Type**: Not defined
|
|
135
|
+
- **Accept**: application/json
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
### HTTP response details
|
|
139
|
+
| Status code | Description | Response headers |
|
|
140
|
+
|-------------|-------------|------------------|
|
|
141
|
+
|**200** | Successful response | - |
|
|
142
|
+
|
|
143
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
144
|
+
|
|
145
|
+
# **createChannel**
|
|
146
|
+
> CreateChannel200Response createChannel(channelCreateInputs)
|
|
147
|
+
|
|
148
|
+
Create Channel endpoint
|
|
149
|
+
|
|
150
|
+
### Example
|
|
151
|
+
|
|
152
|
+
```typescript
|
|
153
|
+
import {
|
|
154
|
+
ChannelsApi,
|
|
155
|
+
Configuration,
|
|
156
|
+
ChannelCreateInputs
|
|
157
|
+
} from '@connectedxm/admin-sdk';
|
|
158
|
+
|
|
159
|
+
const configuration = new Configuration();
|
|
160
|
+
const apiInstance = new ChannelsApi(configuration);
|
|
161
|
+
|
|
162
|
+
let channelCreateInputs: ChannelCreateInputs; //
|
|
163
|
+
|
|
164
|
+
const { status, data } = await apiInstance.createChannel(
|
|
165
|
+
channelCreateInputs
|
|
166
|
+
);
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
### Parameters
|
|
170
|
+
|
|
171
|
+
|Name | Type | Description | Notes|
|
|
172
|
+
|------------- | ------------- | ------------- | -------------|
|
|
173
|
+
| **channelCreateInputs** | **ChannelCreateInputs**| | |
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
### Return type
|
|
177
|
+
|
|
178
|
+
**CreateChannel200Response**
|
|
179
|
+
|
|
180
|
+
### Authorization
|
|
181
|
+
|
|
182
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
183
|
+
|
|
184
|
+
### HTTP request headers
|
|
185
|
+
|
|
186
|
+
- **Content-Type**: application/json
|
|
187
|
+
- **Accept**: application/json
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
### HTTP response details
|
|
191
|
+
| Status code | Description | Response headers |
|
|
192
|
+
|-------------|-------------|------------------|
|
|
193
|
+
|**200** | Successful response | - |
|
|
194
|
+
|
|
195
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
196
|
+
|
|
197
|
+
# **createChannelContent**
|
|
198
|
+
> CreateAccountAddress200Response createChannelContent(channelContentCreateInputs)
|
|
199
|
+
|
|
200
|
+
Create Channel Content endpoint
|
|
201
|
+
|
|
202
|
+
### Example
|
|
203
|
+
|
|
204
|
+
```typescript
|
|
205
|
+
import {
|
|
206
|
+
ChannelsApi,
|
|
207
|
+
Configuration,
|
|
208
|
+
ChannelContentCreateInputs
|
|
209
|
+
} from '@connectedxm/admin-sdk';
|
|
210
|
+
|
|
211
|
+
const configuration = new Configuration();
|
|
212
|
+
const apiInstance = new ChannelsApi(configuration);
|
|
213
|
+
|
|
214
|
+
let channelId: string; //The channel identifier (default to undefined)
|
|
215
|
+
let channelContentCreateInputs: ChannelContentCreateInputs; //
|
|
216
|
+
|
|
217
|
+
const { status, data } = await apiInstance.createChannelContent(
|
|
218
|
+
channelId,
|
|
219
|
+
channelContentCreateInputs
|
|
220
|
+
);
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
### Parameters
|
|
224
|
+
|
|
225
|
+
|Name | Type | Description | Notes|
|
|
226
|
+
|------------- | ------------- | ------------- | -------------|
|
|
227
|
+
| **channelContentCreateInputs** | **ChannelContentCreateInputs**| | |
|
|
228
|
+
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
### Return type
|
|
232
|
+
|
|
233
|
+
**CreateAccountAddress200Response**
|
|
234
|
+
|
|
235
|
+
### Authorization
|
|
236
|
+
|
|
237
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
238
|
+
|
|
239
|
+
### HTTP request headers
|
|
240
|
+
|
|
241
|
+
- **Content-Type**: application/json
|
|
242
|
+
- **Accept**: application/json
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
### HTTP response details
|
|
246
|
+
| Status code | Description | Response headers |
|
|
247
|
+
|-------------|-------------|------------------|
|
|
248
|
+
|**200** | Successful response | - |
|
|
249
|
+
|
|
250
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
251
|
+
|
|
252
|
+
# **createChannelContentGuest**
|
|
253
|
+
> CreateAccountAddress200Response createChannelContentGuest()
|
|
254
|
+
|
|
255
|
+
Create Channel Content Guest endpoint
|
|
256
|
+
|
|
257
|
+
### Example
|
|
258
|
+
|
|
259
|
+
```typescript
|
|
260
|
+
import {
|
|
261
|
+
ChannelsApi,
|
|
262
|
+
Configuration,
|
|
263
|
+
ChannelContentGuestCreateInputs
|
|
264
|
+
} from '@connectedxm/admin-sdk';
|
|
265
|
+
|
|
266
|
+
const configuration = new Configuration();
|
|
267
|
+
const apiInstance = new ChannelsApi(configuration);
|
|
268
|
+
|
|
269
|
+
let channelId: string; //The channel identifier (default to undefined)
|
|
270
|
+
let contentId: string; //The content identifier (default to undefined)
|
|
271
|
+
let contentGuest: ChannelContentGuestCreateInputs; //Filter by contentGuest (default to undefined)
|
|
272
|
+
|
|
273
|
+
const { status, data } = await apiInstance.createChannelContentGuest(
|
|
274
|
+
channelId,
|
|
275
|
+
contentId,
|
|
276
|
+
contentGuest
|
|
277
|
+
);
|
|
278
|
+
```
|
|
279
|
+
|
|
280
|
+
### Parameters
|
|
281
|
+
|
|
282
|
+
|Name | Type | Description | Notes|
|
|
283
|
+
|------------- | ------------- | ------------- | -------------|
|
|
284
|
+
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
|
|
285
|
+
| **contentId** | [**string**] | The content identifier | defaults to undefined|
|
|
286
|
+
| **contentGuest** | **ChannelContentGuestCreateInputs** | Filter by contentGuest | defaults to undefined|
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
### Return type
|
|
290
|
+
|
|
291
|
+
**CreateAccountAddress200Response**
|
|
292
|
+
|
|
293
|
+
### Authorization
|
|
294
|
+
|
|
295
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
296
|
+
|
|
297
|
+
### HTTP request headers
|
|
298
|
+
|
|
299
|
+
- **Content-Type**: Not defined
|
|
300
|
+
- **Accept**: application/json
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
### HTTP response details
|
|
304
|
+
| Status code | Description | Response headers |
|
|
305
|
+
|-------------|-------------|------------------|
|
|
306
|
+
|**200** | Successful response | - |
|
|
307
|
+
|
|
308
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
309
|
+
|
|
310
|
+
# **deleteChannel**
|
|
311
|
+
> CreateAccountInvitations200Response deleteChannel()
|
|
312
|
+
|
|
313
|
+
Delete Channel endpoint
|
|
314
|
+
|
|
315
|
+
### Example
|
|
316
|
+
|
|
317
|
+
```typescript
|
|
318
|
+
import {
|
|
319
|
+
ChannelsApi,
|
|
320
|
+
Configuration
|
|
321
|
+
} from '@connectedxm/admin-sdk';
|
|
322
|
+
|
|
323
|
+
const configuration = new Configuration();
|
|
324
|
+
const apiInstance = new ChannelsApi(configuration);
|
|
325
|
+
|
|
326
|
+
let channelId: string; //The channel identifier (default to undefined)
|
|
327
|
+
|
|
328
|
+
const { status, data } = await apiInstance.deleteChannel(
|
|
329
|
+
channelId
|
|
330
|
+
);
|
|
331
|
+
```
|
|
332
|
+
|
|
333
|
+
### Parameters
|
|
334
|
+
|
|
335
|
+
|Name | Type | Description | Notes|
|
|
336
|
+
|------------- | ------------- | ------------- | -------------|
|
|
337
|
+
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
### Return type
|
|
341
|
+
|
|
342
|
+
**CreateAccountInvitations200Response**
|
|
343
|
+
|
|
344
|
+
### Authorization
|
|
345
|
+
|
|
346
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
347
|
+
|
|
348
|
+
### HTTP request headers
|
|
349
|
+
|
|
350
|
+
- **Content-Type**: Not defined
|
|
351
|
+
- **Accept**: application/json
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
### HTTP response details
|
|
355
|
+
| Status code | Description | Response headers |
|
|
356
|
+
|-------------|-------------|------------------|
|
|
357
|
+
|**200** | Successful response | - |
|
|
358
|
+
|
|
359
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
360
|
+
|
|
361
|
+
# **deleteChannelContent**
|
|
362
|
+
> CreateAccountInvitations200Response deleteChannelContent()
|
|
363
|
+
|
|
364
|
+
Delete Channel Content endpoint
|
|
365
|
+
|
|
366
|
+
### Example
|
|
367
|
+
|
|
368
|
+
```typescript
|
|
369
|
+
import {
|
|
370
|
+
ChannelsApi,
|
|
371
|
+
Configuration
|
|
372
|
+
} from '@connectedxm/admin-sdk';
|
|
373
|
+
|
|
374
|
+
const configuration = new Configuration();
|
|
375
|
+
const apiInstance = new ChannelsApi(configuration);
|
|
376
|
+
|
|
377
|
+
let channelId: string; //The channel identifier (default to undefined)
|
|
378
|
+
let contentId: string; //The content identifier (default to undefined)
|
|
379
|
+
|
|
380
|
+
const { status, data } = await apiInstance.deleteChannelContent(
|
|
381
|
+
channelId,
|
|
382
|
+
contentId
|
|
383
|
+
);
|
|
384
|
+
```
|
|
385
|
+
|
|
386
|
+
### Parameters
|
|
387
|
+
|
|
388
|
+
|Name | Type | Description | Notes|
|
|
389
|
+
|------------- | ------------- | ------------- | -------------|
|
|
390
|
+
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
|
|
391
|
+
| **contentId** | [**string**] | The content identifier | defaults to undefined|
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
### Return type
|
|
395
|
+
|
|
396
|
+
**CreateAccountInvitations200Response**
|
|
397
|
+
|
|
398
|
+
### Authorization
|
|
399
|
+
|
|
400
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
401
|
+
|
|
402
|
+
### HTTP request headers
|
|
403
|
+
|
|
404
|
+
- **Content-Type**: Not defined
|
|
405
|
+
- **Accept**: application/json
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
### HTTP response details
|
|
409
|
+
| Status code | Description | Response headers |
|
|
410
|
+
|-------------|-------------|------------------|
|
|
411
|
+
|**200** | Successful response | - |
|
|
412
|
+
|
|
413
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
414
|
+
|
|
415
|
+
# **deleteChannelContentGuest**
|
|
416
|
+
> CreateAccountAddress200Response deleteChannelContentGuest()
|
|
417
|
+
|
|
418
|
+
Delete Channel Content Guest endpoint
|
|
419
|
+
|
|
420
|
+
### Example
|
|
421
|
+
|
|
422
|
+
```typescript
|
|
423
|
+
import {
|
|
424
|
+
ChannelsApi,
|
|
425
|
+
Configuration
|
|
426
|
+
} from '@connectedxm/admin-sdk';
|
|
427
|
+
|
|
428
|
+
const configuration = new Configuration();
|
|
429
|
+
const apiInstance = new ChannelsApi(configuration);
|
|
430
|
+
|
|
431
|
+
let channelId: string; //The channel identifier (default to undefined)
|
|
432
|
+
let contentId: string; //The content identifier (default to undefined)
|
|
433
|
+
let guestId: string; //The guest identifier (default to undefined)
|
|
434
|
+
|
|
435
|
+
const { status, data } = await apiInstance.deleteChannelContentGuest(
|
|
436
|
+
channelId,
|
|
437
|
+
contentId,
|
|
438
|
+
guestId
|
|
439
|
+
);
|
|
440
|
+
```
|
|
441
|
+
|
|
442
|
+
### Parameters
|
|
443
|
+
|
|
444
|
+
|Name | Type | Description | Notes|
|
|
445
|
+
|------------- | ------------- | ------------- | -------------|
|
|
446
|
+
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
|
|
447
|
+
| **contentId** | [**string**] | The content identifier | defaults to undefined|
|
|
448
|
+
| **guestId** | [**string**] | The guest identifier | defaults to undefined|
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
### Return type
|
|
452
|
+
|
|
453
|
+
**CreateAccountAddress200Response**
|
|
454
|
+
|
|
455
|
+
### Authorization
|
|
456
|
+
|
|
457
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
458
|
+
|
|
459
|
+
### HTTP request headers
|
|
460
|
+
|
|
461
|
+
- **Content-Type**: Not defined
|
|
462
|
+
- **Accept**: application/json
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
### HTTP response details
|
|
466
|
+
| Status code | Description | Response headers |
|
|
467
|
+
|-------------|-------------|------------------|
|
|
468
|
+
|**200** | Successful response | - |
|
|
469
|
+
|
|
470
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
471
|
+
|
|
472
|
+
# **getChannel**
|
|
473
|
+
> CreateChannel200Response getChannel()
|
|
474
|
+
|
|
475
|
+
Get Channel endpoint
|
|
476
|
+
|
|
477
|
+
### Example
|
|
478
|
+
|
|
479
|
+
```typescript
|
|
480
|
+
import {
|
|
481
|
+
ChannelsApi,
|
|
482
|
+
Configuration
|
|
483
|
+
} from '@connectedxm/admin-sdk';
|
|
484
|
+
|
|
485
|
+
const configuration = new Configuration();
|
|
486
|
+
const apiInstance = new ChannelsApi(configuration);
|
|
487
|
+
|
|
488
|
+
let channelId: string; //The channel identifier (default to undefined)
|
|
489
|
+
|
|
490
|
+
const { status, data } = await apiInstance.getChannel(
|
|
491
|
+
channelId
|
|
492
|
+
);
|
|
493
|
+
```
|
|
494
|
+
|
|
495
|
+
### Parameters
|
|
496
|
+
|
|
497
|
+
|Name | Type | Description | Notes|
|
|
498
|
+
|------------- | ------------- | ------------- | -------------|
|
|
499
|
+
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
### Return type
|
|
503
|
+
|
|
504
|
+
**CreateChannel200Response**
|
|
505
|
+
|
|
506
|
+
### Authorization
|
|
507
|
+
|
|
508
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
509
|
+
|
|
510
|
+
### HTTP request headers
|
|
511
|
+
|
|
512
|
+
- **Content-Type**: Not defined
|
|
513
|
+
- **Accept**: application/json
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
### HTTP response details
|
|
517
|
+
| Status code | Description | Response headers |
|
|
518
|
+
|-------------|-------------|------------------|
|
|
519
|
+
|**200** | Successful response | - |
|
|
520
|
+
|
|
521
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
522
|
+
|
|
523
|
+
# **getChannelActivities**
|
|
524
|
+
> GetAccountActivities200Response getChannelActivities()
|
|
525
|
+
|
|
526
|
+
Get Channel Activities endpoint
|
|
527
|
+
|
|
528
|
+
### Example
|
|
529
|
+
|
|
530
|
+
```typescript
|
|
531
|
+
import {
|
|
532
|
+
ChannelsApi,
|
|
533
|
+
Configuration
|
|
534
|
+
} from '@connectedxm/admin-sdk';
|
|
535
|
+
|
|
536
|
+
const configuration = new Configuration();
|
|
537
|
+
const apiInstance = new ChannelsApi(configuration);
|
|
538
|
+
|
|
539
|
+
let channelId: string; //The channel identifier (default to undefined)
|
|
540
|
+
let status: ActivityStatus; //Filter by status (optional) (default to undefined)
|
|
541
|
+
let page: number; //Page number (optional) (default to 1)
|
|
542
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
543
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
544
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
545
|
+
|
|
546
|
+
const { status, data } = await apiInstance.getChannelActivities(
|
|
547
|
+
channelId,
|
|
548
|
+
status,
|
|
549
|
+
page,
|
|
550
|
+
pageSize,
|
|
551
|
+
orderBy,
|
|
552
|
+
search
|
|
553
|
+
);
|
|
554
|
+
```
|
|
555
|
+
|
|
556
|
+
### Parameters
|
|
557
|
+
|
|
558
|
+
|Name | Type | Description | Notes|
|
|
559
|
+
|------------- | ------------- | ------------- | -------------|
|
|
560
|
+
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
|
|
561
|
+
| **status** | **ActivityStatus** | Filter by status | (optional) defaults to undefined|
|
|
562
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
563
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
564
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
565
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
### Return type
|
|
569
|
+
|
|
570
|
+
**GetAccountActivities200Response**
|
|
571
|
+
|
|
572
|
+
### Authorization
|
|
573
|
+
|
|
574
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
575
|
+
|
|
576
|
+
### HTTP request headers
|
|
577
|
+
|
|
578
|
+
- **Content-Type**: Not defined
|
|
579
|
+
- **Accept**: application/json
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
### HTTP response details
|
|
583
|
+
| Status code | Description | Response headers |
|
|
584
|
+
|-------------|-------------|------------------|
|
|
585
|
+
|**200** | Successful response | - |
|
|
586
|
+
|
|
587
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
588
|
+
|
|
589
|
+
# **getChannelContent**
|
|
590
|
+
> GetChannelContent200Response getChannelContent()
|
|
591
|
+
|
|
592
|
+
Get Channel Content endpoint
|
|
593
|
+
|
|
594
|
+
### Example
|
|
595
|
+
|
|
596
|
+
```typescript
|
|
597
|
+
import {
|
|
598
|
+
ChannelsApi,
|
|
599
|
+
Configuration
|
|
600
|
+
} from '@connectedxm/admin-sdk';
|
|
601
|
+
|
|
602
|
+
const configuration = new Configuration();
|
|
603
|
+
const apiInstance = new ChannelsApi(configuration);
|
|
604
|
+
|
|
605
|
+
let channelId: string; //The channel identifier (default to undefined)
|
|
606
|
+
let contentId: string; //The content identifier (default to undefined)
|
|
607
|
+
|
|
608
|
+
const { status, data } = await apiInstance.getChannelContent(
|
|
609
|
+
channelId,
|
|
610
|
+
contentId
|
|
611
|
+
);
|
|
612
|
+
```
|
|
613
|
+
|
|
614
|
+
### Parameters
|
|
615
|
+
|
|
616
|
+
|Name | Type | Description | Notes|
|
|
617
|
+
|------------- | ------------- | ------------- | -------------|
|
|
618
|
+
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
|
|
619
|
+
| **contentId** | [**string**] | The content identifier | defaults to undefined|
|
|
620
|
+
|
|
621
|
+
|
|
622
|
+
### Return type
|
|
623
|
+
|
|
624
|
+
**GetChannelContent200Response**
|
|
625
|
+
|
|
626
|
+
### Authorization
|
|
627
|
+
|
|
628
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
629
|
+
|
|
630
|
+
### HTTP request headers
|
|
631
|
+
|
|
632
|
+
- **Content-Type**: Not defined
|
|
633
|
+
- **Accept**: application/json
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
### HTTP response details
|
|
637
|
+
| Status code | Description | Response headers |
|
|
638
|
+
|-------------|-------------|------------------|
|
|
639
|
+
|**200** | Successful response | - |
|
|
640
|
+
|
|
641
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
642
|
+
|
|
643
|
+
# **getChannelContentActivities**
|
|
644
|
+
> GetAccountActivities200Response getChannelContentActivities()
|
|
645
|
+
|
|
646
|
+
Get Channel Content Activities endpoint
|
|
647
|
+
|
|
648
|
+
### Example
|
|
649
|
+
|
|
650
|
+
```typescript
|
|
651
|
+
import {
|
|
652
|
+
ChannelsApi,
|
|
653
|
+
Configuration
|
|
654
|
+
} from '@connectedxm/admin-sdk';
|
|
655
|
+
|
|
656
|
+
const configuration = new Configuration();
|
|
657
|
+
const apiInstance = new ChannelsApi(configuration);
|
|
658
|
+
|
|
659
|
+
let channelId: string; //The channel identifier (default to undefined)
|
|
660
|
+
let contentId: string; //The content identifier (default to undefined)
|
|
661
|
+
let status: ActivityStatus; //Filter by status (optional) (default to undefined)
|
|
662
|
+
let page: number; //Page number (optional) (default to 1)
|
|
663
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
664
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
665
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
666
|
+
|
|
667
|
+
const { status, data } = await apiInstance.getChannelContentActivities(
|
|
668
|
+
channelId,
|
|
669
|
+
contentId,
|
|
670
|
+
status,
|
|
671
|
+
page,
|
|
672
|
+
pageSize,
|
|
673
|
+
orderBy,
|
|
674
|
+
search
|
|
675
|
+
);
|
|
676
|
+
```
|
|
677
|
+
|
|
678
|
+
### Parameters
|
|
679
|
+
|
|
680
|
+
|Name | Type | Description | Notes|
|
|
681
|
+
|------------- | ------------- | ------------- | -------------|
|
|
682
|
+
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
|
|
683
|
+
| **contentId** | [**string**] | The content identifier | defaults to undefined|
|
|
684
|
+
| **status** | **ActivityStatus** | Filter by status | (optional) defaults to undefined|
|
|
685
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
686
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
687
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
688
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
### Return type
|
|
692
|
+
|
|
693
|
+
**GetAccountActivities200Response**
|
|
694
|
+
|
|
695
|
+
### Authorization
|
|
696
|
+
|
|
697
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
698
|
+
|
|
699
|
+
### HTTP request headers
|
|
700
|
+
|
|
701
|
+
- **Content-Type**: Not defined
|
|
702
|
+
- **Accept**: application/json
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
### HTTP response details
|
|
706
|
+
| Status code | Description | Response headers |
|
|
707
|
+
|-------------|-------------|------------------|
|
|
708
|
+
|**200** | Successful response | - |
|
|
709
|
+
|
|
710
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
711
|
+
|
|
712
|
+
# **getChannelContentGuest**
|
|
713
|
+
> CreateAccountAddress200Response getChannelContentGuest()
|
|
714
|
+
|
|
715
|
+
Get Channel Content Guest endpoint
|
|
716
|
+
|
|
717
|
+
### Example
|
|
718
|
+
|
|
719
|
+
```typescript
|
|
720
|
+
import {
|
|
721
|
+
ChannelsApi,
|
|
722
|
+
Configuration
|
|
723
|
+
} from '@connectedxm/admin-sdk';
|
|
724
|
+
|
|
725
|
+
const configuration = new Configuration();
|
|
726
|
+
const apiInstance = new ChannelsApi(configuration);
|
|
727
|
+
|
|
728
|
+
let channelId: string; //The channel identifier (default to undefined)
|
|
729
|
+
let contentId: string; //The content identifier (default to undefined)
|
|
730
|
+
let guestId: string; //The guest identifier (default to undefined)
|
|
731
|
+
let status: string; //Filter by status (optional) (default to undefined)
|
|
732
|
+
|
|
733
|
+
const { status, data } = await apiInstance.getChannelContentGuest(
|
|
734
|
+
channelId,
|
|
735
|
+
contentId,
|
|
736
|
+
guestId,
|
|
737
|
+
status
|
|
738
|
+
);
|
|
739
|
+
```
|
|
740
|
+
|
|
741
|
+
### Parameters
|
|
742
|
+
|
|
743
|
+
|Name | Type | Description | Notes|
|
|
744
|
+
|------------- | ------------- | ------------- | -------------|
|
|
745
|
+
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
|
|
746
|
+
| **contentId** | [**string**] | The content identifier | defaults to undefined|
|
|
747
|
+
| **guestId** | [**string**] | The guest identifier | defaults to undefined|
|
|
748
|
+
| **status** | [**string**] | Filter by status | (optional) defaults to undefined|
|
|
749
|
+
|
|
750
|
+
|
|
751
|
+
### Return type
|
|
752
|
+
|
|
753
|
+
**CreateAccountAddress200Response**
|
|
754
|
+
|
|
755
|
+
### Authorization
|
|
756
|
+
|
|
757
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
758
|
+
|
|
759
|
+
### HTTP request headers
|
|
760
|
+
|
|
761
|
+
- **Content-Type**: Not defined
|
|
762
|
+
- **Accept**: application/json
|
|
763
|
+
|
|
764
|
+
|
|
765
|
+
### HTTP response details
|
|
766
|
+
| Status code | Description | Response headers |
|
|
767
|
+
|-------------|-------------|------------------|
|
|
768
|
+
|**200** | Successful response | - |
|
|
769
|
+
|
|
770
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
771
|
+
|
|
772
|
+
# **getChannelContentGuests**
|
|
773
|
+
> GetAccountInvitations200Response getChannelContentGuests()
|
|
774
|
+
|
|
775
|
+
Get Channel Content Guests endpoint
|
|
776
|
+
|
|
777
|
+
### Example
|
|
778
|
+
|
|
779
|
+
```typescript
|
|
780
|
+
import {
|
|
781
|
+
ChannelsApi,
|
|
782
|
+
Configuration
|
|
783
|
+
} from '@connectedxm/admin-sdk';
|
|
784
|
+
|
|
785
|
+
const configuration = new Configuration();
|
|
786
|
+
const apiInstance = new ChannelsApi(configuration);
|
|
787
|
+
|
|
788
|
+
let channelId: string; //The channel identifier (default to undefined)
|
|
789
|
+
let contentId: string; //The content identifier (default to undefined)
|
|
790
|
+
let status: string; //Filter by status (optional) (default to undefined)
|
|
791
|
+
let page: number; //Page number (optional) (default to 1)
|
|
792
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
793
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
794
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
795
|
+
|
|
796
|
+
const { status, data } = await apiInstance.getChannelContentGuests(
|
|
797
|
+
channelId,
|
|
798
|
+
contentId,
|
|
799
|
+
status,
|
|
800
|
+
page,
|
|
801
|
+
pageSize,
|
|
802
|
+
orderBy,
|
|
803
|
+
search
|
|
804
|
+
);
|
|
805
|
+
```
|
|
806
|
+
|
|
807
|
+
### Parameters
|
|
808
|
+
|
|
809
|
+
|Name | Type | Description | Notes|
|
|
810
|
+
|------------- | ------------- | ------------- | -------------|
|
|
811
|
+
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
|
|
812
|
+
| **contentId** | [**string**] | The content identifier | defaults to undefined|
|
|
813
|
+
| **status** | [**string**] | Filter by status | (optional) defaults to undefined|
|
|
814
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
815
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
816
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
817
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
818
|
+
|
|
819
|
+
|
|
820
|
+
### Return type
|
|
821
|
+
|
|
822
|
+
**GetAccountInvitations200Response**
|
|
823
|
+
|
|
824
|
+
### Authorization
|
|
825
|
+
|
|
826
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
827
|
+
|
|
828
|
+
### HTTP request headers
|
|
829
|
+
|
|
830
|
+
- **Content-Type**: Not defined
|
|
831
|
+
- **Accept**: application/json
|
|
832
|
+
|
|
833
|
+
|
|
834
|
+
### HTTP response details
|
|
835
|
+
| Status code | Description | Response headers |
|
|
836
|
+
|-------------|-------------|------------------|
|
|
837
|
+
|**200** | Successful response | - |
|
|
838
|
+
|
|
839
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
840
|
+
|
|
841
|
+
# **getChannelContentLikes**
|
|
842
|
+
> GetAccountInvitations200Response getChannelContentLikes()
|
|
843
|
+
|
|
844
|
+
Get Channel Content Likes endpoint
|
|
845
|
+
|
|
846
|
+
### Example
|
|
847
|
+
|
|
848
|
+
```typescript
|
|
849
|
+
import {
|
|
850
|
+
ChannelsApi,
|
|
851
|
+
Configuration
|
|
852
|
+
} from '@connectedxm/admin-sdk';
|
|
853
|
+
|
|
854
|
+
const configuration = new Configuration();
|
|
855
|
+
const apiInstance = new ChannelsApi(configuration);
|
|
856
|
+
|
|
857
|
+
let channelId: string; //The channel identifier (default to undefined)
|
|
858
|
+
let contentId: string; //The content identifier (default to undefined)
|
|
859
|
+
let page: number; //Page number (optional) (default to 1)
|
|
860
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
861
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
862
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
863
|
+
|
|
864
|
+
const { status, data } = await apiInstance.getChannelContentLikes(
|
|
865
|
+
channelId,
|
|
866
|
+
contentId,
|
|
867
|
+
page,
|
|
868
|
+
pageSize,
|
|
869
|
+
orderBy,
|
|
870
|
+
search
|
|
871
|
+
);
|
|
872
|
+
```
|
|
873
|
+
|
|
874
|
+
### Parameters
|
|
875
|
+
|
|
876
|
+
|Name | Type | Description | Notes|
|
|
877
|
+
|------------- | ------------- | ------------- | -------------|
|
|
878
|
+
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
|
|
879
|
+
| **contentId** | [**string**] | The content identifier | defaults to undefined|
|
|
880
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
881
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
882
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
883
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
884
|
+
|
|
885
|
+
|
|
886
|
+
### Return type
|
|
887
|
+
|
|
888
|
+
**GetAccountInvitations200Response**
|
|
889
|
+
|
|
890
|
+
### Authorization
|
|
891
|
+
|
|
892
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
893
|
+
|
|
894
|
+
### HTTP request headers
|
|
895
|
+
|
|
896
|
+
- **Content-Type**: Not defined
|
|
897
|
+
- **Accept**: application/json
|
|
898
|
+
|
|
899
|
+
|
|
900
|
+
### HTTP response details
|
|
901
|
+
| Status code | Description | Response headers |
|
|
902
|
+
|-------------|-------------|------------------|
|
|
903
|
+
|**200** | Successful response | - |
|
|
904
|
+
|
|
905
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
906
|
+
|
|
907
|
+
# **getChannelContents**
|
|
908
|
+
> GetChannelContents200Response getChannelContents()
|
|
909
|
+
|
|
910
|
+
Get Channel Contents endpoint
|
|
911
|
+
|
|
912
|
+
### Example
|
|
913
|
+
|
|
914
|
+
```typescript
|
|
915
|
+
import {
|
|
916
|
+
ChannelsApi,
|
|
917
|
+
Configuration
|
|
918
|
+
} from '@connectedxm/admin-sdk';
|
|
919
|
+
|
|
920
|
+
const configuration = new Configuration();
|
|
921
|
+
const apiInstance = new ChannelsApi(configuration);
|
|
922
|
+
|
|
923
|
+
let channelId: string; //The channel identifier (default to undefined)
|
|
924
|
+
let featured: boolean; //Filter by featured (optional) (default to undefined)
|
|
925
|
+
let page: number; //Page number (optional) (default to 1)
|
|
926
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
927
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
928
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
929
|
+
|
|
930
|
+
const { status, data } = await apiInstance.getChannelContents(
|
|
931
|
+
channelId,
|
|
932
|
+
featured,
|
|
933
|
+
page,
|
|
934
|
+
pageSize,
|
|
935
|
+
orderBy,
|
|
936
|
+
search
|
|
937
|
+
);
|
|
938
|
+
```
|
|
939
|
+
|
|
940
|
+
### Parameters
|
|
941
|
+
|
|
942
|
+
|Name | Type | Description | Notes|
|
|
943
|
+
|------------- | ------------- | ------------- | -------------|
|
|
944
|
+
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
|
|
945
|
+
| **featured** | [**boolean**] | Filter by featured | (optional) defaults to undefined|
|
|
946
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
947
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
948
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
949
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
950
|
+
|
|
951
|
+
|
|
952
|
+
### Return type
|
|
953
|
+
|
|
954
|
+
**GetChannelContents200Response**
|
|
955
|
+
|
|
956
|
+
### Authorization
|
|
957
|
+
|
|
958
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
959
|
+
|
|
960
|
+
### HTTP request headers
|
|
961
|
+
|
|
962
|
+
- **Content-Type**: Not defined
|
|
963
|
+
- **Accept**: application/json
|
|
964
|
+
|
|
965
|
+
|
|
966
|
+
### HTTP response details
|
|
967
|
+
| Status code | Description | Response headers |
|
|
968
|
+
|-------------|-------------|------------------|
|
|
969
|
+
|**200** | Successful response | - |
|
|
970
|
+
|
|
971
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
972
|
+
|
|
973
|
+
# **getChannelSubscriber**
|
|
974
|
+
> CreateAccountAddress200Response getChannelSubscriber()
|
|
975
|
+
|
|
976
|
+
Get Channel Subscriber endpoint
|
|
977
|
+
|
|
978
|
+
### Example
|
|
979
|
+
|
|
980
|
+
```typescript
|
|
981
|
+
import {
|
|
982
|
+
ChannelsApi,
|
|
983
|
+
Configuration
|
|
984
|
+
} from '@connectedxm/admin-sdk';
|
|
985
|
+
|
|
986
|
+
const configuration = new Configuration();
|
|
987
|
+
const apiInstance = new ChannelsApi(configuration);
|
|
988
|
+
|
|
989
|
+
let channelId: string; //The channel identifier (default to undefined)
|
|
990
|
+
let accountId: string; //The account identifier (default to undefined)
|
|
991
|
+
|
|
992
|
+
const { status, data } = await apiInstance.getChannelSubscriber(
|
|
993
|
+
channelId,
|
|
994
|
+
accountId
|
|
995
|
+
);
|
|
996
|
+
```
|
|
997
|
+
|
|
998
|
+
### Parameters
|
|
999
|
+
|
|
1000
|
+
|Name | Type | Description | Notes|
|
|
1001
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1002
|
+
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
|
|
1003
|
+
| **accountId** | [**string**] | The account identifier | defaults to undefined|
|
|
1004
|
+
|
|
1005
|
+
|
|
1006
|
+
### Return type
|
|
1007
|
+
|
|
1008
|
+
**CreateAccountAddress200Response**
|
|
1009
|
+
|
|
1010
|
+
### Authorization
|
|
1011
|
+
|
|
1012
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1013
|
+
|
|
1014
|
+
### HTTP request headers
|
|
1015
|
+
|
|
1016
|
+
- **Content-Type**: Not defined
|
|
1017
|
+
- **Accept**: application/json
|
|
1018
|
+
|
|
1019
|
+
|
|
1020
|
+
### HTTP response details
|
|
1021
|
+
| Status code | Description | Response headers |
|
|
1022
|
+
|-------------|-------------|------------------|
|
|
1023
|
+
|**200** | Successful response | - |
|
|
1024
|
+
|
|
1025
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1026
|
+
|
|
1027
|
+
# **getChannelSubscribers**
|
|
1028
|
+
> GetAccountInvitations200Response getChannelSubscribers()
|
|
1029
|
+
|
|
1030
|
+
Get Channel Subscribers endpoint
|
|
1031
|
+
|
|
1032
|
+
### Example
|
|
1033
|
+
|
|
1034
|
+
```typescript
|
|
1035
|
+
import {
|
|
1036
|
+
ChannelsApi,
|
|
1037
|
+
Configuration
|
|
1038
|
+
} from '@connectedxm/admin-sdk';
|
|
1039
|
+
|
|
1040
|
+
const configuration = new Configuration();
|
|
1041
|
+
const apiInstance = new ChannelsApi(configuration);
|
|
1042
|
+
|
|
1043
|
+
let channelId: string; //The channel identifier (default to undefined)
|
|
1044
|
+
let status: string; //Filter by status (optional) (default to undefined)
|
|
1045
|
+
let page: number; //Page number (optional) (default to 1)
|
|
1046
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
1047
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
1048
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
1049
|
+
|
|
1050
|
+
const { status, data } = await apiInstance.getChannelSubscribers(
|
|
1051
|
+
channelId,
|
|
1052
|
+
status,
|
|
1053
|
+
page,
|
|
1054
|
+
pageSize,
|
|
1055
|
+
orderBy,
|
|
1056
|
+
search
|
|
1057
|
+
);
|
|
1058
|
+
```
|
|
1059
|
+
|
|
1060
|
+
### Parameters
|
|
1061
|
+
|
|
1062
|
+
|Name | Type | Description | Notes|
|
|
1063
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1064
|
+
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
|
|
1065
|
+
| **status** | [**string**] | Filter by status | (optional) defaults to undefined|
|
|
1066
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
1067
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
1068
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
1069
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
1070
|
+
|
|
1071
|
+
|
|
1072
|
+
### Return type
|
|
1073
|
+
|
|
1074
|
+
**GetAccountInvitations200Response**
|
|
1075
|
+
|
|
1076
|
+
### Authorization
|
|
1077
|
+
|
|
1078
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1079
|
+
|
|
1080
|
+
### HTTP request headers
|
|
1081
|
+
|
|
1082
|
+
- **Content-Type**: Not defined
|
|
1083
|
+
- **Accept**: application/json
|
|
1084
|
+
|
|
1085
|
+
|
|
1086
|
+
### HTTP response details
|
|
1087
|
+
| Status code | Description | Response headers |
|
|
1088
|
+
|-------------|-------------|------------------|
|
|
1089
|
+
|**200** | Successful response | - |
|
|
1090
|
+
|
|
1091
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1092
|
+
|
|
1093
|
+
# **getChannels**
|
|
1094
|
+
> GetChannels200Response getChannels()
|
|
1095
|
+
|
|
1096
|
+
Get Channels endpoint
|
|
1097
|
+
|
|
1098
|
+
### Example
|
|
1099
|
+
|
|
1100
|
+
```typescript
|
|
1101
|
+
import {
|
|
1102
|
+
ChannelsApi,
|
|
1103
|
+
Configuration
|
|
1104
|
+
} from '@connectedxm/admin-sdk';
|
|
1105
|
+
|
|
1106
|
+
const configuration = new Configuration();
|
|
1107
|
+
const apiInstance = new ChannelsApi(configuration);
|
|
1108
|
+
|
|
1109
|
+
let page: number; //Page number (optional) (default to 1)
|
|
1110
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
1111
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
1112
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
1113
|
+
|
|
1114
|
+
const { status, data } = await apiInstance.getChannels(
|
|
1115
|
+
page,
|
|
1116
|
+
pageSize,
|
|
1117
|
+
orderBy,
|
|
1118
|
+
search
|
|
1119
|
+
);
|
|
1120
|
+
```
|
|
1121
|
+
|
|
1122
|
+
### Parameters
|
|
1123
|
+
|
|
1124
|
+
|Name | Type | Description | Notes|
|
|
1125
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1126
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
1127
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
1128
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
1129
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
1130
|
+
|
|
1131
|
+
|
|
1132
|
+
### Return type
|
|
1133
|
+
|
|
1134
|
+
**GetChannels200Response**
|
|
1135
|
+
|
|
1136
|
+
### Authorization
|
|
1137
|
+
|
|
1138
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1139
|
+
|
|
1140
|
+
### HTTP request headers
|
|
1141
|
+
|
|
1142
|
+
- **Content-Type**: Not defined
|
|
1143
|
+
- **Accept**: application/json
|
|
1144
|
+
|
|
1145
|
+
|
|
1146
|
+
### HTTP response details
|
|
1147
|
+
| Status code | Description | Response headers |
|
|
1148
|
+
|-------------|-------------|------------------|
|
|
1149
|
+
|**200** | Successful response | - |
|
|
1150
|
+
|
|
1151
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1152
|
+
|
|
1153
|
+
# **getContents**
|
|
1154
|
+
> GetChannelContents200Response getContents()
|
|
1155
|
+
|
|
1156
|
+
Get Contents endpoint
|
|
1157
|
+
|
|
1158
|
+
### Example
|
|
1159
|
+
|
|
1160
|
+
```typescript
|
|
1161
|
+
import {
|
|
1162
|
+
ChannelsApi,
|
|
1163
|
+
Configuration
|
|
1164
|
+
} from '@connectedxm/admin-sdk';
|
|
1165
|
+
|
|
1166
|
+
const configuration = new Configuration();
|
|
1167
|
+
const apiInstance = new ChannelsApi(configuration);
|
|
1168
|
+
|
|
1169
|
+
let featured: boolean; //Filter by featured (optional) (default to undefined)
|
|
1170
|
+
let type: 'video' | 'audio' | 'article'; //Filter by type (optional) (default to undefined)
|
|
1171
|
+
let past: boolean; //Filter by past (optional) (default to undefined)
|
|
1172
|
+
let page: number; //Page number (optional) (default to 1)
|
|
1173
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
1174
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
1175
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
1176
|
+
|
|
1177
|
+
const { status, data } = await apiInstance.getContents(
|
|
1178
|
+
featured,
|
|
1179
|
+
type,
|
|
1180
|
+
past,
|
|
1181
|
+
page,
|
|
1182
|
+
pageSize,
|
|
1183
|
+
orderBy,
|
|
1184
|
+
search
|
|
1185
|
+
);
|
|
1186
|
+
```
|
|
1187
|
+
|
|
1188
|
+
### Parameters
|
|
1189
|
+
|
|
1190
|
+
|Name | Type | Description | Notes|
|
|
1191
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1192
|
+
| **featured** | [**boolean**] | Filter by featured | (optional) defaults to undefined|
|
|
1193
|
+
| **type** | [**'video' | 'audio' | 'article'**]**Array<'video' | 'audio' | 'article'>** | Filter by type | (optional) defaults to undefined|
|
|
1194
|
+
| **past** | [**boolean**] | Filter by past | (optional) defaults to undefined|
|
|
1195
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
1196
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
1197
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
1198
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
1199
|
+
|
|
1200
|
+
|
|
1201
|
+
### Return type
|
|
1202
|
+
|
|
1203
|
+
**GetChannelContents200Response**
|
|
1204
|
+
|
|
1205
|
+
### Authorization
|
|
1206
|
+
|
|
1207
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1208
|
+
|
|
1209
|
+
### HTTP request headers
|
|
1210
|
+
|
|
1211
|
+
- **Content-Type**: Not defined
|
|
1212
|
+
- **Accept**: application/json
|
|
1213
|
+
|
|
1214
|
+
|
|
1215
|
+
### HTTP response details
|
|
1216
|
+
| Status code | Description | Response headers |
|
|
1217
|
+
|-------------|-------------|------------------|
|
|
1218
|
+
|**200** | Successful response | - |
|
|
1219
|
+
|
|
1220
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1221
|
+
|
|
1222
|
+
# **getFeaturedChannels**
|
|
1223
|
+
> GetChannels200Response getFeaturedChannels()
|
|
1224
|
+
|
|
1225
|
+
Get Featured Channels endpoint
|
|
1226
|
+
|
|
1227
|
+
### Example
|
|
1228
|
+
|
|
1229
|
+
```typescript
|
|
1230
|
+
import {
|
|
1231
|
+
ChannelsApi,
|
|
1232
|
+
Configuration
|
|
1233
|
+
} from '@connectedxm/admin-sdk';
|
|
1234
|
+
|
|
1235
|
+
const configuration = new Configuration();
|
|
1236
|
+
const apiInstance = new ChannelsApi(configuration);
|
|
1237
|
+
|
|
1238
|
+
let page: number; //Page number (optional) (default to 1)
|
|
1239
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
1240
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
1241
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
1242
|
+
|
|
1243
|
+
const { status, data } = await apiInstance.getFeaturedChannels(
|
|
1244
|
+
page,
|
|
1245
|
+
pageSize,
|
|
1246
|
+
orderBy,
|
|
1247
|
+
search
|
|
1248
|
+
);
|
|
1249
|
+
```
|
|
1250
|
+
|
|
1251
|
+
### Parameters
|
|
1252
|
+
|
|
1253
|
+
|Name | Type | Description | Notes|
|
|
1254
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1255
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
1256
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
1257
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
1258
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
1259
|
+
|
|
1260
|
+
|
|
1261
|
+
### Return type
|
|
1262
|
+
|
|
1263
|
+
**GetChannels200Response**
|
|
1264
|
+
|
|
1265
|
+
### Authorization
|
|
1266
|
+
|
|
1267
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1268
|
+
|
|
1269
|
+
### HTTP request headers
|
|
1270
|
+
|
|
1271
|
+
- **Content-Type**: Not defined
|
|
1272
|
+
- **Accept**: application/json
|
|
1273
|
+
|
|
1274
|
+
|
|
1275
|
+
### HTTP response details
|
|
1276
|
+
| Status code | Description | Response headers |
|
|
1277
|
+
|-------------|-------------|------------------|
|
|
1278
|
+
|**200** | Successful response | - |
|
|
1279
|
+
|
|
1280
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1281
|
+
|
|
1282
|
+
# **removeAllChannelSubscribers**
|
|
1283
|
+
> CreateAccountAddress200Response removeAllChannelSubscribers()
|
|
1284
|
+
|
|
1285
|
+
Remove All Channel Subscribers endpoint
|
|
1286
|
+
|
|
1287
|
+
### Example
|
|
1288
|
+
|
|
1289
|
+
```typescript
|
|
1290
|
+
import {
|
|
1291
|
+
ChannelsApi,
|
|
1292
|
+
Configuration
|
|
1293
|
+
} from '@connectedxm/admin-sdk';
|
|
1294
|
+
|
|
1295
|
+
const configuration = new Configuration();
|
|
1296
|
+
const apiInstance = new ChannelsApi(configuration);
|
|
1297
|
+
|
|
1298
|
+
let channelId: string; //The channel identifier (default to undefined)
|
|
1299
|
+
|
|
1300
|
+
const { status, data } = await apiInstance.removeAllChannelSubscribers(
|
|
1301
|
+
channelId
|
|
1302
|
+
);
|
|
1303
|
+
```
|
|
1304
|
+
|
|
1305
|
+
### Parameters
|
|
1306
|
+
|
|
1307
|
+
|Name | Type | Description | Notes|
|
|
1308
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1309
|
+
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
|
|
1310
|
+
|
|
1311
|
+
|
|
1312
|
+
### Return type
|
|
1313
|
+
|
|
1314
|
+
**CreateAccountAddress200Response**
|
|
1315
|
+
|
|
1316
|
+
### Authorization
|
|
1317
|
+
|
|
1318
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1319
|
+
|
|
1320
|
+
### HTTP request headers
|
|
1321
|
+
|
|
1322
|
+
- **Content-Type**: Not defined
|
|
1323
|
+
- **Accept**: application/json
|
|
1324
|
+
|
|
1325
|
+
|
|
1326
|
+
### HTTP response details
|
|
1327
|
+
| Status code | Description | Response headers |
|
|
1328
|
+
|-------------|-------------|------------------|
|
|
1329
|
+
|**200** | Successful response | - |
|
|
1330
|
+
|
|
1331
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1332
|
+
|
|
1333
|
+
# **removeChannelSubscriber**
|
|
1334
|
+
> CreateAccountAddress200Response removeChannelSubscriber()
|
|
1335
|
+
|
|
1336
|
+
Remove Channel Subscriber endpoint
|
|
1337
|
+
|
|
1338
|
+
### Example
|
|
1339
|
+
|
|
1340
|
+
```typescript
|
|
1341
|
+
import {
|
|
1342
|
+
ChannelsApi,
|
|
1343
|
+
Configuration
|
|
1344
|
+
} from '@connectedxm/admin-sdk';
|
|
1345
|
+
|
|
1346
|
+
const configuration = new Configuration();
|
|
1347
|
+
const apiInstance = new ChannelsApi(configuration);
|
|
1348
|
+
|
|
1349
|
+
let channelId: string; //The channel identifier (default to undefined)
|
|
1350
|
+
let accountId: string; //The account identifier (default to undefined)
|
|
1351
|
+
|
|
1352
|
+
const { status, data } = await apiInstance.removeChannelSubscriber(
|
|
1353
|
+
channelId,
|
|
1354
|
+
accountId
|
|
1355
|
+
);
|
|
1356
|
+
```
|
|
1357
|
+
|
|
1358
|
+
### Parameters
|
|
1359
|
+
|
|
1360
|
+
|Name | Type | Description | Notes|
|
|
1361
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1362
|
+
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
|
|
1363
|
+
| **accountId** | [**string**] | The account identifier | defaults to undefined|
|
|
1364
|
+
|
|
1365
|
+
|
|
1366
|
+
### Return type
|
|
1367
|
+
|
|
1368
|
+
**CreateAccountAddress200Response**
|
|
1369
|
+
|
|
1370
|
+
### Authorization
|
|
1371
|
+
|
|
1372
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1373
|
+
|
|
1374
|
+
### HTTP request headers
|
|
1375
|
+
|
|
1376
|
+
- **Content-Type**: Not defined
|
|
1377
|
+
- **Accept**: application/json
|
|
1378
|
+
|
|
1379
|
+
|
|
1380
|
+
### HTTP response details
|
|
1381
|
+
| Status code | Description | Response headers |
|
|
1382
|
+
|-------------|-------------|------------------|
|
|
1383
|
+
|**200** | Successful response | - |
|
|
1384
|
+
|
|
1385
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1386
|
+
|
|
1387
|
+
# **revertChannelContentToDraft**
|
|
1388
|
+
> CreateAccountAddress200Response revertChannelContentToDraft()
|
|
1389
|
+
|
|
1390
|
+
Revert Channel Content To Draft endpoint
|
|
1391
|
+
|
|
1392
|
+
### Example
|
|
1393
|
+
|
|
1394
|
+
```typescript
|
|
1395
|
+
import {
|
|
1396
|
+
ChannelsApi,
|
|
1397
|
+
Configuration
|
|
1398
|
+
} from '@connectedxm/admin-sdk';
|
|
1399
|
+
|
|
1400
|
+
const configuration = new Configuration();
|
|
1401
|
+
const apiInstance = new ChannelsApi(configuration);
|
|
1402
|
+
|
|
1403
|
+
let channelId: string; //The channel identifier (default to undefined)
|
|
1404
|
+
let contentId: string; //The content identifier (default to undefined)
|
|
1405
|
+
|
|
1406
|
+
const { status, data } = await apiInstance.revertChannelContentToDraft(
|
|
1407
|
+
channelId,
|
|
1408
|
+
contentId
|
|
1409
|
+
);
|
|
1410
|
+
```
|
|
1411
|
+
|
|
1412
|
+
### Parameters
|
|
1413
|
+
|
|
1414
|
+
|Name | Type | Description | Notes|
|
|
1415
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1416
|
+
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
|
|
1417
|
+
| **contentId** | [**string**] | The content identifier | defaults to undefined|
|
|
1418
|
+
|
|
1419
|
+
|
|
1420
|
+
### Return type
|
|
1421
|
+
|
|
1422
|
+
**CreateAccountAddress200Response**
|
|
1423
|
+
|
|
1424
|
+
### Authorization
|
|
1425
|
+
|
|
1426
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1427
|
+
|
|
1428
|
+
### HTTP request headers
|
|
1429
|
+
|
|
1430
|
+
- **Content-Type**: Not defined
|
|
1431
|
+
- **Accept**: application/json
|
|
1432
|
+
|
|
1433
|
+
|
|
1434
|
+
### HTTP response details
|
|
1435
|
+
| Status code | Description | Response headers |
|
|
1436
|
+
|-------------|-------------|------------------|
|
|
1437
|
+
|**200** | Successful response | - |
|
|
1438
|
+
|
|
1439
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1440
|
+
|
|
1441
|
+
# **updateChannel**
|
|
1442
|
+
> CreateChannel200Response updateChannel()
|
|
1443
|
+
|
|
1444
|
+
Update Channel endpoint
|
|
1445
|
+
|
|
1446
|
+
### Example
|
|
1447
|
+
|
|
1448
|
+
```typescript
|
|
1449
|
+
import {
|
|
1450
|
+
ChannelsApi,
|
|
1451
|
+
Configuration,
|
|
1452
|
+
ChannelUpdateInputs
|
|
1453
|
+
} from '@connectedxm/admin-sdk';
|
|
1454
|
+
|
|
1455
|
+
const configuration = new Configuration();
|
|
1456
|
+
const apiInstance = new ChannelsApi(configuration);
|
|
1457
|
+
|
|
1458
|
+
let channelId: string; //The channel identifier (default to undefined)
|
|
1459
|
+
let channel: ChannelUpdateInputs; //Filter by channel (default to undefined)
|
|
1460
|
+
|
|
1461
|
+
const { status, data } = await apiInstance.updateChannel(
|
|
1462
|
+
channelId,
|
|
1463
|
+
channel
|
|
1464
|
+
);
|
|
1465
|
+
```
|
|
1466
|
+
|
|
1467
|
+
### Parameters
|
|
1468
|
+
|
|
1469
|
+
|Name | Type | Description | Notes|
|
|
1470
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1471
|
+
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
|
|
1472
|
+
| **channel** | **ChannelUpdateInputs** | Filter by channel | defaults to undefined|
|
|
1473
|
+
|
|
1474
|
+
|
|
1475
|
+
### Return type
|
|
1476
|
+
|
|
1477
|
+
**CreateChannel200Response**
|
|
1478
|
+
|
|
1479
|
+
### Authorization
|
|
1480
|
+
|
|
1481
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1482
|
+
|
|
1483
|
+
### HTTP request headers
|
|
1484
|
+
|
|
1485
|
+
- **Content-Type**: Not defined
|
|
1486
|
+
- **Accept**: application/json
|
|
1487
|
+
|
|
1488
|
+
|
|
1489
|
+
### HTTP response details
|
|
1490
|
+
| Status code | Description | Response headers |
|
|
1491
|
+
|-------------|-------------|------------------|
|
|
1492
|
+
|**200** | Successful response | - |
|
|
1493
|
+
|
|
1494
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1495
|
+
|
|
1496
|
+
# **updateChannelContent**
|
|
1497
|
+
> CreateAccountAddress200Response updateChannelContent(channelContentUpdateInputs)
|
|
1498
|
+
|
|
1499
|
+
Update Channel Content endpoint
|
|
1500
|
+
|
|
1501
|
+
### Example
|
|
1502
|
+
|
|
1503
|
+
```typescript
|
|
1504
|
+
import {
|
|
1505
|
+
ChannelsApi,
|
|
1506
|
+
Configuration,
|
|
1507
|
+
ChannelContentUpdateInputs
|
|
1508
|
+
} from '@connectedxm/admin-sdk';
|
|
1509
|
+
|
|
1510
|
+
const configuration = new Configuration();
|
|
1511
|
+
const apiInstance = new ChannelsApi(configuration);
|
|
1512
|
+
|
|
1513
|
+
let channelId: string; //The channel identifier (default to undefined)
|
|
1514
|
+
let contentId: string; //The content identifier (default to undefined)
|
|
1515
|
+
let channelContentUpdateInputs: ChannelContentUpdateInputs; //
|
|
1516
|
+
|
|
1517
|
+
const { status, data } = await apiInstance.updateChannelContent(
|
|
1518
|
+
channelId,
|
|
1519
|
+
contentId,
|
|
1520
|
+
channelContentUpdateInputs
|
|
1521
|
+
);
|
|
1522
|
+
```
|
|
1523
|
+
|
|
1524
|
+
### Parameters
|
|
1525
|
+
|
|
1526
|
+
|Name | Type | Description | Notes|
|
|
1527
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1528
|
+
| **channelContentUpdateInputs** | **ChannelContentUpdateInputs**| | |
|
|
1529
|
+
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
|
|
1530
|
+
| **contentId** | [**string**] | The content identifier | defaults to undefined|
|
|
1531
|
+
|
|
1532
|
+
|
|
1533
|
+
### Return type
|
|
1534
|
+
|
|
1535
|
+
**CreateAccountAddress200Response**
|
|
1536
|
+
|
|
1537
|
+
### Authorization
|
|
1538
|
+
|
|
1539
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1540
|
+
|
|
1541
|
+
### HTTP request headers
|
|
1542
|
+
|
|
1543
|
+
- **Content-Type**: application/json
|
|
1544
|
+
- **Accept**: application/json
|
|
1545
|
+
|
|
1546
|
+
|
|
1547
|
+
### HTTP response details
|
|
1548
|
+
| Status code | Description | Response headers |
|
|
1549
|
+
|-------------|-------------|------------------|
|
|
1550
|
+
|**200** | Successful response | - |
|
|
1551
|
+
|
|
1552
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1553
|
+
|
|
1554
|
+
# **updateChannelContentGuest**
|
|
1555
|
+
> CreateAccountAddress200Response updateChannelContentGuest()
|
|
1556
|
+
|
|
1557
|
+
Update Channel Content Guest endpoint
|
|
1558
|
+
|
|
1559
|
+
### Example
|
|
1560
|
+
|
|
1561
|
+
```typescript
|
|
1562
|
+
import {
|
|
1563
|
+
ChannelsApi,
|
|
1564
|
+
Configuration,
|
|
1565
|
+
ChannelContentGuestUpdateInputs
|
|
1566
|
+
} from '@connectedxm/admin-sdk';
|
|
1567
|
+
|
|
1568
|
+
const configuration = new Configuration();
|
|
1569
|
+
const apiInstance = new ChannelsApi(configuration);
|
|
1570
|
+
|
|
1571
|
+
let channelId: string; //The channel identifier (default to undefined)
|
|
1572
|
+
let contentId: string; //The content identifier (default to undefined)
|
|
1573
|
+
let guestId: string; //The guest identifier (default to undefined)
|
|
1574
|
+
let contentGuest: ChannelContentGuestUpdateInputs; //Filter by contentGuest (default to undefined)
|
|
1575
|
+
|
|
1576
|
+
const { status, data } = await apiInstance.updateChannelContentGuest(
|
|
1577
|
+
channelId,
|
|
1578
|
+
contentId,
|
|
1579
|
+
guestId,
|
|
1580
|
+
contentGuest
|
|
1581
|
+
);
|
|
1582
|
+
```
|
|
1583
|
+
|
|
1584
|
+
### Parameters
|
|
1585
|
+
|
|
1586
|
+
|Name | Type | Description | Notes|
|
|
1587
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1588
|
+
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
|
|
1589
|
+
| **contentId** | [**string**] | The content identifier | defaults to undefined|
|
|
1590
|
+
| **guestId** | [**string**] | The guest identifier | defaults to undefined|
|
|
1591
|
+
| **contentGuest** | **ChannelContentGuestUpdateInputs** | Filter by contentGuest | defaults to undefined|
|
|
1592
|
+
|
|
1593
|
+
|
|
1594
|
+
### Return type
|
|
1595
|
+
|
|
1596
|
+
**CreateAccountAddress200Response**
|
|
1597
|
+
|
|
1598
|
+
### Authorization
|
|
1599
|
+
|
|
1600
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1601
|
+
|
|
1602
|
+
### HTTP request headers
|
|
1603
|
+
|
|
1604
|
+
- **Content-Type**: Not defined
|
|
1605
|
+
- **Accept**: application/json
|
|
1606
|
+
|
|
1607
|
+
|
|
1608
|
+
### HTTP response details
|
|
1609
|
+
| Status code | Description | Response headers |
|
|
1610
|
+
|-------------|-------------|------------------|
|
|
1611
|
+
|**200** | Successful response | - |
|
|
1612
|
+
|
|
1613
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1614
|
+
|
|
1615
|
+
# **updateChannelContentPublishSchedule**
|
|
1616
|
+
> CreateAccountAddress200Response updateChannelContentPublishSchedule(body)
|
|
1617
|
+
|
|
1618
|
+
Update Channel Content Publish Schedule endpoint
|
|
1619
|
+
|
|
1620
|
+
### Example
|
|
1621
|
+
|
|
1622
|
+
```typescript
|
|
1623
|
+
import {
|
|
1624
|
+
ChannelsApi,
|
|
1625
|
+
Configuration
|
|
1626
|
+
} from '@connectedxm/admin-sdk';
|
|
1627
|
+
|
|
1628
|
+
const configuration = new Configuration();
|
|
1629
|
+
const apiInstance = new ChannelsApi(configuration);
|
|
1630
|
+
|
|
1631
|
+
let channelId: string; //The channel identifier (default to undefined)
|
|
1632
|
+
let contentId: string; //The content identifier (default to undefined)
|
|
1633
|
+
let body: object; //
|
|
1634
|
+
|
|
1635
|
+
const { status, data } = await apiInstance.updateChannelContentPublishSchedule(
|
|
1636
|
+
channelId,
|
|
1637
|
+
contentId,
|
|
1638
|
+
body
|
|
1639
|
+
);
|
|
1640
|
+
```
|
|
1641
|
+
|
|
1642
|
+
### Parameters
|
|
1643
|
+
|
|
1644
|
+
|Name | Type | Description | Notes|
|
|
1645
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1646
|
+
| **body** | **object**| | |
|
|
1647
|
+
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
|
|
1648
|
+
| **contentId** | [**string**] | The content identifier | defaults to undefined|
|
|
1649
|
+
|
|
1650
|
+
|
|
1651
|
+
### Return type
|
|
1652
|
+
|
|
1653
|
+
**CreateAccountAddress200Response**
|
|
1654
|
+
|
|
1655
|
+
### Authorization
|
|
1656
|
+
|
|
1657
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1658
|
+
|
|
1659
|
+
### HTTP request headers
|
|
1660
|
+
|
|
1661
|
+
- **Content-Type**: application/json
|
|
1662
|
+
- **Accept**: application/json
|
|
1663
|
+
|
|
1664
|
+
|
|
1665
|
+
### HTTP response details
|
|
1666
|
+
| Status code | Description | Response headers |
|
|
1667
|
+
|-------------|-------------|------------------|
|
|
1668
|
+
|**200** | Successful response | - |
|
|
1669
|
+
|
|
1670
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1671
|
+
|
|
1672
|
+
# **updateChannelSubscriber**
|
|
1673
|
+
> CreateAccountAddress200Response updateChannelSubscriber(channelSubscriberUpdateInputs)
|
|
1674
|
+
|
|
1675
|
+
Update Channel Subscriber endpoint
|
|
1676
|
+
|
|
1677
|
+
### Example
|
|
1678
|
+
|
|
1679
|
+
```typescript
|
|
1680
|
+
import {
|
|
1681
|
+
ChannelsApi,
|
|
1682
|
+
Configuration,
|
|
1683
|
+
ChannelSubscriberUpdateInputs
|
|
1684
|
+
} from '@connectedxm/admin-sdk';
|
|
1685
|
+
|
|
1686
|
+
const configuration = new Configuration();
|
|
1687
|
+
const apiInstance = new ChannelsApi(configuration);
|
|
1688
|
+
|
|
1689
|
+
let channelId: string; //The channel identifier (default to undefined)
|
|
1690
|
+
let accountId: string; //The account identifier (default to undefined)
|
|
1691
|
+
let channelSubscriberUpdateInputs: ChannelSubscriberUpdateInputs; //
|
|
1692
|
+
|
|
1693
|
+
const { status, data } = await apiInstance.updateChannelSubscriber(
|
|
1694
|
+
channelId,
|
|
1695
|
+
accountId,
|
|
1696
|
+
channelSubscriberUpdateInputs
|
|
1697
|
+
);
|
|
1698
|
+
```
|
|
1699
|
+
|
|
1700
|
+
### Parameters
|
|
1701
|
+
|
|
1702
|
+
|Name | Type | Description | Notes|
|
|
1703
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1704
|
+
| **channelSubscriberUpdateInputs** | **ChannelSubscriberUpdateInputs**| | |
|
|
1705
|
+
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
|
|
1706
|
+
| **accountId** | [**string**] | The account identifier | defaults to undefined|
|
|
1707
|
+
|
|
1708
|
+
|
|
1709
|
+
### Return type
|
|
1710
|
+
|
|
1711
|
+
**CreateAccountAddress200Response**
|
|
1712
|
+
|
|
1713
|
+
### Authorization
|
|
1714
|
+
|
|
1715
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1716
|
+
|
|
1717
|
+
### HTTP request headers
|
|
1718
|
+
|
|
1719
|
+
- **Content-Type**: application/json
|
|
1720
|
+
- **Accept**: application/json
|
|
1721
|
+
|
|
1722
|
+
|
|
1723
|
+
### HTTP response details
|
|
1724
|
+
| Status code | Description | Response headers |
|
|
1725
|
+
|-------------|-------------|------------------|
|
|
1726
|
+
|**200** | Successful response | - |
|
|
1727
|
+
|
|
1728
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1729
|
+
|