@connectedxm/admin-sdk 6.14.0 → 6.17.4
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 +176 -12
- package/AdminApi.ts +12 -0
- package/README.md +191 -29
- package/api.ts +5214 -3201
- package/dist/AdminApi.d.ts +5 -1
- package/dist/AdminApi.js +4 -0
- package/dist/api.d.ts +3859 -2306
- package/dist/api.js +2671 -1753
- package/dist/esm/AdminApi.d.ts +5 -1
- package/dist/esm/AdminApi.js +5 -1
- package/dist/esm/api.d.ts +3859 -2306
- package/dist/esm/api.js +2750 -1851
- package/docs/AccountsAddressesApi.md +4 -4
- package/docs/AccountsApi.md +58 -6
- package/docs/AddChannelSubscriber200Response.md +24 -0
- package/docs/AddOrganizationUser200Response.md +24 -0
- package/docs/AdvertisementsApi.md +4 -4
- package/docs/AnnouncementsApi.md +4 -4
- package/docs/AnnouncementsScheduleApi.md +4 -4
- package/docs/BaseEventActivation.md +2 -0
- package/docs/BaseSideEffect.md +4 -0
- package/docs/BookingSpace.md +4 -0
- package/docs/BookingSpaceCreateInputs.md +4 -0
- package/docs/BookingSpaceTranslation.md +4 -0
- package/docs/BookingSpaceTranslationUpdateInputs.md +4 -0
- package/docs/BookingSpaceUpdateInputs.md +4 -0
- package/docs/BookingsApi.md +68 -10
- package/docs/BookingsAvailabilitiesApi.md +6 -6
- package/docs/BookingsBlackoutsApi.md +4 -4
- package/docs/BulkUploadSearchListValues200Response.md +24 -0
- package/docs/ChannelsApi.md +36 -36
- package/docs/CreateAccountAddress200Response.md +1 -1
- package/docs/CreateAccountAttribute200Response.md +24 -0
- package/docs/CreateBookingSpaceAvailability200Response.md +24 -0
- package/docs/CreateBookingSpaceBlackout200Response.md +24 -0
- package/docs/{GetChannelContent200Response.md → CreateChannelContent200Response.md} +3 -3
- package/docs/CreateChannelContentGuest200Response.md +24 -0
- package/docs/CreateDashboardWidget200Response.md +24 -0
- package/docs/{GetEventActivation200Response.md → CreateEventActivation200Response.md} +3 -3
- package/docs/CreateEventActivationCompletion200Response.md +24 -0
- package/docs/CreateEventAttendeePackage200Response.md +24 -0
- package/docs/{GetAccountAddress200Response.md → CreateEventAttribute200Response.md} +4 -4
- package/docs/CreateEventFollowup200Response.md +24 -0
- package/docs/{GetEventMediaItem200Response.md → CreateEventMediaItem200Response.md} +3 -3
- package/docs/CreateEventPackagePass200Response.md +24 -0
- package/docs/CreateEventQuestion200Response.md +24 -0
- package/docs/CreateEventQuestionChoice200Response.md +24 -0
- package/docs/CreateEventRegistrationBypass200Response.md +24 -0
- package/docs/CreateEventReservation200Response.md +24 -0
- package/docs/{GetEventSection200Response.md → CreateEventSection200Response.md} +3 -3
- package/docs/CreateEventSessionLocation200Response.md +24 -0
- package/docs/CreateEventSessionQuestion200Response.md +24 -0
- package/docs/CreateEventSessionQuestionChoice200Response.md +24 -0
- package/docs/CreateEventSessionSection200Response.md +24 -0
- package/docs/CreateEventSponsorship200Response.md +24 -0
- package/docs/CreateEventSponsorshipLevel200Response.md +24 -0
- package/docs/CreateGroupInvitations200Response.md +24 -0
- package/docs/{GetInvoiceLineItem200Response.md → CreateInvoiceLineItem200Response.md} +3 -3
- package/docs/CreateOrganizationPaymentIntegration200Response.md +24 -0
- package/docs/CreateOrganizationSideEffect200Response.md +24 -0
- package/docs/CreateOrganizationTeamMember200Response.md +24 -0
- package/docs/{GetSearchListValue200Response.md → CreateSearchListValue200Response.md} +3 -3
- package/docs/CreateSeriesQuestion200Response.md +24 -0
- package/docs/CreateSeriesQuestionChoice200Response.md +24 -0
- package/docs/CreateSeriesRegistration200Response.md +24 -0
- package/docs/CreateStreamInputOutput200Response.md +24 -0
- package/docs/CreateSupportTicketMessage200Response.md +24 -0
- package/docs/{GetSurveyQuestion200Response.md → CreateSurveyQuestion200Response.md} +3 -3
- package/docs/CreateSurveyQuestionChoice200Response.md +24 -0
- package/docs/CreateThreadCircleAccount200Response.md +24 -0
- package/docs/CreateThreadMessageReaction200Response.md +24 -0
- package/docs/DashboardsApi.md +2 -2
- package/docs/DashboardsWidgetsApi.md +8 -8
- package/docs/DeleteDashboard200Response.md +24 -0
- package/docs/EmailReceiptsApi.md +2 -2
- package/docs/Event.md +2 -0
- package/docs/EventActivation.md +2 -0
- package/docs/EventActivationCreateInputs.md +2 -0
- package/docs/EventActivationUpdateInputs.md +2 -0
- package/docs/EventCreateInputs.md +2 -0
- package/docs/EventTranslation.md +2 -0
- package/docs/EventTranslationUpdateInputs.md +2 -0
- package/docs/EventUpdateInputs.md +2 -0
- package/docs/EventsAccessApi.md +4 -4
- package/docs/EventsActivationsApi.md +20 -20
- package/docs/EventsActivationsSessionsApi.md +4 -4
- package/docs/EventsAddonsApi.md +4 -4
- package/docs/EventsApi.md +2 -2
- package/docs/EventsAttendeesApi.md +8 -8
- package/docs/EventsAttendeesPackagesApi.md +10 -10
- package/docs/EventsAttendeesReservationsApi.md +16 -16
- package/docs/EventsAttributesApi.md +8 -8
- package/docs/EventsBlocksApi.md +2 -2
- package/docs/EventsBypassApi.md +8 -8
- package/docs/EventsFaqsApi.md +2 -2
- package/docs/EventsFollowupsApi.md +32 -32
- package/docs/EventsMatchesApi.md +10 -10
- package/docs/EventsMediaApi.md +12 -12
- package/docs/EventsOnSiteApi.md +2 -2
- package/docs/EventsPackagesPassesApi.md +8 -8
- package/docs/EventsPassesAccessesApi.md +313 -0
- package/docs/EventsPassesAddonsApi.md +190 -0
- package/docs/EventsPassesApi.md +77 -1149
- package/docs/EventsPassesAttributesApi.md +6 -6
- package/docs/EventsPassesFollowupsApi.md +272 -0
- package/docs/EventsPassesResponsesApi.md +326 -0
- package/docs/EventsPasstypesApi.md +14 -14
- package/docs/EventsPasstypesPriceschedulesApi.md +10 -10
- package/docs/EventsPasstypesRefundschedulesApi.md +10 -10
- package/docs/EventsQuestionsApi.md +38 -38
- package/docs/EventsRoomsApi.md +2 -2
- package/docs/EventsRoomtypesApi.md +8 -8
- package/docs/EventsSectionsApi.md +32 -32
- package/docs/EventsSessionsAccessesApi.md +6 -6
- package/docs/EventsSessionsApi.md +32 -32
- package/docs/EventsSessionsLocationsApi.md +14 -14
- package/docs/EventsSessionsMatchesApi.md +12 -12
- package/docs/EventsSessionsQuestionsApi.md +36 -36
- package/docs/EventsSessionsSectionsApi.md +18 -18
- package/docs/EventsSpeakersApi.md +8 -8
- package/docs/EventsSponsorshiplevelsApi.md +10 -10
- package/docs/EventsSponsorshipsApi.md +10 -10
- package/docs/EventsTracksApi.md +2 -2
- package/docs/GetAcccountEmailReceipts200Response.md +26 -0
- package/docs/GetAccountAddresses200Response.md +26 -0
- package/docs/GetAccountInvitations200Response.md +1 -1
- package/docs/GetAccountNotificationPreferences200Response.md +24 -0
- package/docs/{GetEventAttendees200Response.md → GetAccountRegistrations200Response.md} +3 -3
- package/docs/GetAccountsByInternalRefId200Response.md +24 -0
- package/docs/GetAdvertisementClicks200Response.md +26 -0
- package/docs/GetAdvertisementViews200Response.md +26 -0
- package/docs/GetAnnouncementAudience200Response.md +26 -0
- package/docs/GetBookingSpaceAvailabilities200Response.md +24 -0
- package/docs/GetBookingSpaceBlackouts200Response.md +26 -0
- package/docs/GetBookingSpaceSlots200Response.md +24 -0
- package/docs/GetChannelContentGuests200Response.md +26 -0
- package/docs/GetChannelContentLikes200Response.md +26 -0
- package/docs/GetChannelSubscribers200Response.md +26 -0
- package/docs/GetDashboardAttributes200Response.md +24 -0
- package/docs/GetDashboardWidgets200Response.md +24 -0
- package/docs/GetEmailReceipts200Response.md +26 -0
- package/docs/GetEventActivationCompletions200Response.md +26 -0
- package/docs/{GetEventSessions200Response.md → GetEventActivationSessions200Response.md} +3 -3
- package/docs/GetEventActivations200Response.md +26 -0
- package/docs/{GetEventPassTypes200Response.md → GetEventAddOnPassTypes200Response.md} +3 -3
- package/docs/GetEventAttendeePackages200Response.md +26 -0
- package/docs/GetEventAttendeeReservations200Response.md +26 -0
- package/docs/GetEventAttendeeTransfersLogs200Response.md +26 -0
- package/docs/GetEventAttributes200Response.md +26 -0
- package/docs/GetEventDashboardQuestions200Response.md +24 -0
- package/docs/GetEventFollowupQuestions200Response.md +26 -0
- package/docs/GetEventPackagePasses200Response.md +26 -0
- package/docs/GetEventPassAccesses200Response.md +26 -0
- package/docs/GetEventPassAttributes200Response.md +26 -0
- package/docs/GetEventPassQuestionFollowups200Response.md +26 -0
- package/docs/GetEventPassQuestionSections200Response.md +26 -0
- package/docs/GetEventPassResponse200Response.md +24 -0
- package/docs/GetEventPassResponseChanges200Response.md +26 -0
- package/docs/GetEventPassResponses200Response.md +26 -0
- package/docs/GetEventPassTypePriceSchedule200Response.md +24 -0
- package/docs/GetEventPassTypePriceSchedules200Response.md +26 -0
- package/docs/GetEventPassTypeRefundSchedule200Response.md +24 -0
- package/docs/GetEventPassTypeRefundSchedules200Response.md +26 -0
- package/docs/GetEventQuestionChoiceSubQuestions200Response.md +26 -0
- package/docs/GetEventQuestionChoices200Response.md +26 -0
- package/docs/GetEventQuestionSummaries200Response.md +26 -0
- package/docs/GetEventQuestions200Response.md +26 -0
- package/docs/GetEventRegistrationBypassList200Response.md +26 -0
- package/docs/GetEventRoundQuestions200Response.md +26 -0
- package/docs/GetEventRoundQuestionsSummary200Response.md +24 -0
- package/docs/GetEventSectionQuestions200Response.md +26 -0
- package/docs/GetEventSessionAccess200Response.md +24 -0
- package/docs/GetEventSessionAccessQuestionSections200Response.md +26 -0
- package/docs/GetEventSessionAccessResponseChanges200Response.md +26 -0
- package/docs/GetEventSessionLocations200Response.md +26 -0
- package/docs/GetEventSessionQuestionChoiceSubQuestions200Response.md +26 -0
- package/docs/GetEventSessionQuestionChoices200Response.md +26 -0
- package/docs/GetEventSessionQuestionResponses200Response.md +26 -0
- package/docs/GetEventSessionQuestions200Response.md +26 -0
- package/docs/GetEventSessionRoundQuestions200Response.md +26 -0
- package/docs/GetEventSessionSectionQuestions200Response.md +26 -0
- package/docs/{GetEventSpeakers200Response.md → GetEventSessionSpeakers200Response.md} +3 -3
- package/docs/GetEventSponsorshipLevels200Response.md +26 -0
- package/docs/GetEventSponsorships200Response.md +26 -0
- package/docs/GetGroupInvitations200Response.md +26 -0
- package/docs/GetInvoiceLineItems200Response.md +26 -0
- package/docs/GetLivestreamSessions200Response.md +26 -0
- package/docs/GetMeetingParticipant200Response.md +24 -0
- package/docs/GetMeetingParticipants200Response.md +26 -0
- package/docs/GetMeetingRecording200Response.md +24 -0
- package/docs/GetMeetingRecordings200Response.md +26 -0
- package/docs/GetMeetingSessionMessages200Response.md +24 -0
- package/docs/GetMeetingSessionParticipant200Response.md +24 -0
- package/docs/GetMeetingSessionParticipants200Response.md +26 -0
- package/docs/GetMeetingSessionSummary200Response.md +24 -0
- package/docs/GetMeetingSessionTranscript200Response.md +24 -0
- package/docs/GetMeetingSessions200Response.md +26 -0
- package/docs/GetNotificationStats200Response.md +24 -0
- package/docs/GetNotifications200Response.md +26 -0
- package/docs/GetOrganizationAccountAttributes200Response.md +26 -0
- package/docs/GetOrganizationDomain200Response.md +24 -0
- package/docs/GetOrganizationModule200Response.md +24 -0
- package/docs/GetOrganizationModuleSettings200Response.md +24 -0
- package/docs/GetOrganizationModules200Response.md +26 -0
- package/docs/GetOrganizationPaymentIntegrations200Response.md +26 -0
- package/docs/GetOrganizationSideEffects200Response.md +26 -0
- package/docs/GetOrganizationSystemLog200Response.md +24 -0
- package/docs/GetOrganizationSystemLogs200Response.md +26 -0
- package/docs/GetOrganizationTeamMembers200Response.md +26 -0
- package/docs/GetOrganizationUsers200Response.md +26 -0
- package/docs/GetPreferences200Response.md +24 -0
- package/docs/GetSearchListConnectedQuestions200Response.md +24 -0
- package/docs/GetSearchListValues200Response.md +26 -0
- package/docs/GetSeriesQuestionChoices200Response.md +26 -0
- package/docs/GetSeriesQuestions200Response.md +26 -0
- package/docs/GetSeriesRegistrationResponses200Response.md +24 -0
- package/docs/GetSeriesRegistrations200Response.md +26 -0
- package/docs/GetStreamInputOutputs200Response.md +26 -0
- package/docs/GetStreamSessionChat200Response.md +24 -0
- package/docs/GetStreamSessionSubscriptions200Response.md +26 -0
- package/docs/GetSupportTicketActivity200Response.md +24 -0
- package/docs/GetSupportTicketMessages200Response.md +26 -0
- package/docs/GetSupportTicketNotes200Response.md +26 -0
- package/docs/GetSupportTicketViewer200Response.md +26 -0
- package/docs/GetSurveyQuestionChoiceSubQuestions200Response.md +26 -0
- package/docs/GetSurveyQuestionChoices200Response.md +26 -0
- package/docs/GetSurveyQuestionResponses200Response.md +26 -0
- package/docs/GetSurveySectionQuestions200Response.md +26 -0
- package/docs/GetSurveySubmission200Response.md +24 -0
- package/docs/GetSurveySubmissionResponseChanges200Response.md +26 -0
- package/docs/GetSurveySubmissions200Response.md +26 -0
- package/docs/GetThreadCircleAccounts200Response.md +26 -0
- package/docs/GetThreadMessageReactions200Response.md +24 -0
- package/docs/GroupsInvitationsApi.md +8 -8
- package/docs/GroupsModeratorsApi.md +4 -4
- package/docs/InterestsApi.md +2 -2
- package/docs/InvoicesApi.md +4 -4
- package/docs/InvoicesLineitemsApi.md +4 -4
- package/docs/MeetingsLivestreamsApi.md +4 -4
- package/docs/MeetingsParticipantsApi.md +10 -10
- package/docs/MeetingsRecordingsApi.md +4 -4
- package/docs/MeetingsSessionsApi.md +14 -14
- package/docs/NotificationsApi.md +8 -8
- package/docs/OrganizationApi.md +10 -10
- package/docs/OrganizationAttributesApi.md +12 -12
- package/docs/OrganizationDomainsApi.md +4 -4
- package/docs/OrganizationModulesApi.md +6 -6
- package/docs/OrganizationModulesSettingsApi.md +4 -4
- package/docs/OrganizationModulesTiersApi.md +12 -12
- package/docs/OrganizationPaymentsApi.md +12 -12
- package/docs/OrganizationSideeffectsApi.md +8 -8
- package/docs/OrganizationTaxApi.md +6 -6
- package/docs/OrganizationTeammembersApi.md +8 -8
- package/docs/OrganizationUsersApi.md +4 -4
- package/docs/PreferencesApi.md +4 -4
- package/docs/RemoveEventPassAttribute200Response.md +24 -0
- package/docs/ReorderEventFaqSectionQuestions200Response.md +24 -0
- package/docs/ReorderEventFollowupQuestions200Response.md +24 -0
- package/docs/ReorderEventQuestionChoiceSubQuestions200Response.md +24 -0
- package/docs/ReorderEventQuestionChoices200Response.md +24 -0
- package/docs/ReorderEventSectionQuestions200Response.md +24 -0
- package/docs/ReorderEventSessionQuestionChoiceSubQuestions200Response.md +24 -0
- package/docs/ReorderEventSessionQuestionChoices200Response.md +24 -0
- package/docs/ReorderEventSessionSectionQuestions200Response.md +24 -0
- package/docs/ReorderEventSponsorshipLevels200Response.md +24 -0
- package/docs/ReorderEventSponsorships200Response.md +24 -0
- package/docs/ReorderSeriesQuestionChoices200Response.md +24 -0
- package/docs/ReorderSurveyQuestionChoiceSubQuestions200Response.md +24 -0
- package/docs/ReorderSurveyQuestionChoices200Response.md +24 -0
- package/docs/ReorderSurveySectionQuestions200Response.md +24 -0
- package/docs/SearchlistsValuesApi.md +12 -12
- package/docs/SelfApi.md +2 -2
- package/docs/SeriesQuestionsApi.md +12 -12
- package/docs/SeriesQuestionsChoicesApi.md +6 -6
- package/docs/SeriesRegistrationsApi.md +16 -16
- package/docs/SideEffect.md +8 -0
- package/docs/SideEffectActionType.md +2 -0
- package/docs/SideEffectTriggerType.md +4 -2
- package/docs/StorageVideosApi.md +4 -4
- package/docs/StorageVideosCaptionsApi.md +2 -2
- package/docs/StreamsApi.md +2 -2
- package/docs/StreamsOutputsApi.md +8 -8
- package/docs/StreamsSessionsApi.md +4 -4
- package/docs/SupportApi.md +4 -4
- package/docs/SupportMessagesApi.md +4 -4
- package/docs/SupportNotesApi.md +4 -4
- package/docs/Survey.md +2 -0
- package/docs/SurveyCreateInputs.md +2 -0
- package/docs/SurveyUpdateInputs.md +2 -0
- package/docs/SurveysApi.md +2 -2
- package/docs/SurveysQuestionsApi.md +32 -32
- package/docs/SurveysSectionsApi.md +10 -10
- package/docs/SurveysSubmissionsApi.md +12 -12
- package/docs/ThreadsCirclesAccountsApi.md +8 -8
- package/docs/ThreadsMessagesApi.md +2 -2
- package/docs/ThreadsMessagesFilesApi.md +2 -2
- package/docs/ThreadsMessagesImagesApi.md +2 -2
- package/docs/ThreadsMessagesReactionsApi.md +4 -4
- package/docs/ThreadsMessagesVideosApi.md +2 -2
- package/docs/UpdateEventPassAttributes200Response.md +24 -0
- package/docs/UpdateEventPassResponsesInputs.md +20 -0
- package/docs/UpdateEventRoundQuestion200Response.md +24 -0
- package/docs/UpdateEventSessionRoundQuestion200Response.md +24 -0
- package/docs/UpdateOrganizationDomain200Response.md +24 -0
- package/package.json +1 -1
|
@@ -120,7 +120,7 @@ const { status, data } = await apiInstance.deleteAccountAddress(
|
|
|
120
120
|
[[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)
|
|
121
121
|
|
|
122
122
|
# **getAccountAddress**
|
|
123
|
-
>
|
|
123
|
+
> CreateAccountAddress200Response getAccountAddress()
|
|
124
124
|
|
|
125
125
|
Get Account Address endpoint
|
|
126
126
|
|
|
@@ -154,7 +154,7 @@ const { status, data } = await apiInstance.getAccountAddress(
|
|
|
154
154
|
|
|
155
155
|
### Return type
|
|
156
156
|
|
|
157
|
-
**
|
|
157
|
+
**CreateAccountAddress200Response**
|
|
158
158
|
|
|
159
159
|
### Authorization
|
|
160
160
|
|
|
@@ -174,7 +174,7 @@ const { status, data } = await apiInstance.getAccountAddress(
|
|
|
174
174
|
[[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)
|
|
175
175
|
|
|
176
176
|
# **getAccountAddresses**
|
|
177
|
-
>
|
|
177
|
+
> GetAccountAddresses200Response getAccountAddresses()
|
|
178
178
|
|
|
179
179
|
Get Account Addresses endpoint
|
|
180
180
|
|
|
@@ -217,7 +217,7 @@ const { status, data } = await apiInstance.getAccountAddresses(
|
|
|
217
217
|
|
|
218
218
|
### Return type
|
|
219
219
|
|
|
220
|
-
**
|
|
220
|
+
**GetAccountAddresses200Response**
|
|
221
221
|
|
|
222
222
|
### Authorization
|
|
223
223
|
|
package/docs/AccountsApi.md
CHANGED
|
@@ -18,6 +18,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
18
18
|
|[**getAccountRegistrations**](#getaccountregistrations) | **GET** /accounts/{accountId}/registrations | Get Account Registrations|
|
|
19
19
|
|[**getAccountThreads**](#getaccountthreads) | **GET** /accounts/{accountId}/threads | Get Account Threads|
|
|
20
20
|
|[**getAccounts**](#getaccounts) | **GET** /accounts | Get Accounts|
|
|
21
|
+
|[**getAccountsByInternalRefId**](#getaccountsbyinternalrefid) | **GET** /accounts/internal-ref-id/{internalRefId} | Get Accounts By Internal Ref Id|
|
|
21
22
|
|[**impersonateAccount**](#impersonateaccount) | **POST** /accounts/{accountId}/impersonate/{username} | Impersonate Account|
|
|
22
23
|
|[**updateAccount**](#updateaccount) | **PUT** /accounts/{accountId} | Update Account|
|
|
23
24
|
|
|
@@ -176,7 +177,7 @@ const { status, data } = await apiInstance.exportAccount(
|
|
|
176
177
|
[[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)
|
|
177
178
|
|
|
178
179
|
# **getAcccountEmailReceipts**
|
|
179
|
-
>
|
|
180
|
+
> GetAcccountEmailReceipts200Response getAcccountEmailReceipts()
|
|
180
181
|
|
|
181
182
|
Get Acccount Email Receipts endpoint
|
|
182
183
|
|
|
@@ -222,7 +223,7 @@ const { status, data } = await apiInstance.getAcccountEmailReceipts(
|
|
|
222
223
|
|
|
223
224
|
### Return type
|
|
224
225
|
|
|
225
|
-
**
|
|
226
|
+
**GetAcccountEmailReceipts200Response**
|
|
226
227
|
|
|
227
228
|
### Authorization
|
|
228
229
|
|
|
@@ -551,7 +552,7 @@ const { status, data } = await apiInstance.getAccountLikes(
|
|
|
551
552
|
[[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)
|
|
552
553
|
|
|
553
554
|
# **getAccountNotificationPreferences**
|
|
554
|
-
>
|
|
555
|
+
> GetAccountNotificationPreferences200Response getAccountNotificationPreferences()
|
|
555
556
|
|
|
556
557
|
Get Account Notification Preferences endpoint
|
|
557
558
|
|
|
@@ -582,7 +583,7 @@ const { status, data } = await apiInstance.getAccountNotificationPreferences(
|
|
|
582
583
|
|
|
583
584
|
### Return type
|
|
584
585
|
|
|
585
|
-
**
|
|
586
|
+
**GetAccountNotificationPreferences200Response**
|
|
586
587
|
|
|
587
588
|
### Authorization
|
|
588
589
|
|
|
@@ -665,7 +666,7 @@ const { status, data } = await apiInstance.getAccountPayments(
|
|
|
665
666
|
[[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)
|
|
666
667
|
|
|
667
668
|
# **getAccountRegistrations**
|
|
668
|
-
>
|
|
669
|
+
> GetAccountRegistrations200Response getAccountRegistrations()
|
|
669
670
|
|
|
670
671
|
Get Account Registrations endpoint
|
|
671
672
|
|
|
@@ -708,7 +709,7 @@ const { status, data } = await apiInstance.getAccountRegistrations(
|
|
|
708
709
|
|
|
709
710
|
### Return type
|
|
710
711
|
|
|
711
|
-
**
|
|
712
|
+
**GetAccountRegistrations200Response**
|
|
712
713
|
|
|
713
714
|
### Authorization
|
|
714
715
|
|
|
@@ -849,6 +850,57 @@ const { status, data } = await apiInstance.getAccounts(
|
|
|
849
850
|
- **Accept**: application/json
|
|
850
851
|
|
|
851
852
|
|
|
853
|
+
### HTTP response details
|
|
854
|
+
| Status code | Description | Response headers |
|
|
855
|
+
|-------------|-------------|------------------|
|
|
856
|
+
|**200** | Successful response | - |
|
|
857
|
+
|
|
858
|
+
[[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)
|
|
859
|
+
|
|
860
|
+
# **getAccountsByInternalRefId**
|
|
861
|
+
> GetAccountsByInternalRefId200Response getAccountsByInternalRefId()
|
|
862
|
+
|
|
863
|
+
Get Accounts By Internal Ref Id endpoint
|
|
864
|
+
|
|
865
|
+
### Example
|
|
866
|
+
|
|
867
|
+
```typescript
|
|
868
|
+
import {
|
|
869
|
+
AccountsApi,
|
|
870
|
+
Configuration
|
|
871
|
+
} from '@connectedxm/admin-sdk';
|
|
872
|
+
|
|
873
|
+
const configuration = new Configuration();
|
|
874
|
+
const apiInstance = new AccountsApi(configuration);
|
|
875
|
+
|
|
876
|
+
let internalRefId: string; //The internalRef identifier (default to undefined)
|
|
877
|
+
|
|
878
|
+
const { status, data } = await apiInstance.getAccountsByInternalRefId(
|
|
879
|
+
internalRefId
|
|
880
|
+
);
|
|
881
|
+
```
|
|
882
|
+
|
|
883
|
+
### Parameters
|
|
884
|
+
|
|
885
|
+
|Name | Type | Description | Notes|
|
|
886
|
+
|------------- | ------------- | ------------- | -------------|
|
|
887
|
+
| **internalRefId** | [**string**] | The internalRef identifier | defaults to undefined|
|
|
888
|
+
|
|
889
|
+
|
|
890
|
+
### Return type
|
|
891
|
+
|
|
892
|
+
**GetAccountsByInternalRefId200Response**
|
|
893
|
+
|
|
894
|
+
### Authorization
|
|
895
|
+
|
|
896
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
897
|
+
|
|
898
|
+
### HTTP request headers
|
|
899
|
+
|
|
900
|
+
- **Content-Type**: Not defined
|
|
901
|
+
- **Accept**: application/json
|
|
902
|
+
|
|
903
|
+
|
|
852
904
|
### HTTP response details
|
|
853
905
|
| Status code | Description | Response headers |
|
|
854
906
|
|-------------|-------------|------------------|
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# AddChannelSubscriber200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
**data** | [**BaseChannelSubscriber**](BaseChannelSubscriber.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { AddChannelSubscriber200Response } from '@connectedxm/admin-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: AddChannelSubscriber200Response = {
|
|
18
|
+
status,
|
|
19
|
+
message,
|
|
20
|
+
data,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# AddOrganizationUser200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
**data** | [**OrganizationMembership**](OrganizationMembership.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { AddOrganizationUser200Response } from '@connectedxm/admin-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: AddOrganizationUser200Response = {
|
|
18
|
+
status,
|
|
19
|
+
message,
|
|
20
|
+
data,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -167,7 +167,7 @@ const { status, data } = await apiInstance.getAdvertisement(
|
|
|
167
167
|
[[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)
|
|
168
168
|
|
|
169
169
|
# **getAdvertisementClicks**
|
|
170
|
-
>
|
|
170
|
+
> GetAdvertisementClicks200Response getAdvertisementClicks()
|
|
171
171
|
|
|
172
172
|
Get Advertisement Clicks endpoint
|
|
173
173
|
|
|
@@ -210,7 +210,7 @@ const { status, data } = await apiInstance.getAdvertisementClicks(
|
|
|
210
210
|
|
|
211
211
|
### Return type
|
|
212
212
|
|
|
213
|
-
**
|
|
213
|
+
**GetAdvertisementClicks200Response**
|
|
214
214
|
|
|
215
215
|
### Authorization
|
|
216
216
|
|
|
@@ -230,7 +230,7 @@ const { status, data } = await apiInstance.getAdvertisementClicks(
|
|
|
230
230
|
[[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)
|
|
231
231
|
|
|
232
232
|
# **getAdvertisementViews**
|
|
233
|
-
>
|
|
233
|
+
> GetAdvertisementViews200Response getAdvertisementViews()
|
|
234
234
|
|
|
235
235
|
Get Advertisement Views endpoint
|
|
236
236
|
|
|
@@ -273,7 +273,7 @@ const { status, data } = await apiInstance.getAdvertisementViews(
|
|
|
273
273
|
|
|
274
274
|
### Return type
|
|
275
275
|
|
|
276
|
-
**
|
|
276
|
+
**GetAdvertisementViews200Response**
|
|
277
277
|
|
|
278
278
|
### Authorization
|
|
279
279
|
|
package/docs/AnnouncementsApi.md
CHANGED
|
@@ -168,7 +168,7 @@ const { status, data } = await apiInstance.getAnnouncement(
|
|
|
168
168
|
[[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)
|
|
169
169
|
|
|
170
170
|
# **getAnnouncementAudience**
|
|
171
|
-
>
|
|
171
|
+
> GetAnnouncementAudience200Response getAnnouncementAudience()
|
|
172
172
|
|
|
173
173
|
Get Announcement Audience endpoint
|
|
174
174
|
|
|
@@ -211,7 +211,7 @@ const { status, data } = await apiInstance.getAnnouncementAudience(
|
|
|
211
211
|
|
|
212
212
|
### Return type
|
|
213
213
|
|
|
214
|
-
**
|
|
214
|
+
**GetAnnouncementAudience200Response**
|
|
215
215
|
|
|
216
216
|
### Authorization
|
|
217
217
|
|
|
@@ -231,7 +231,7 @@ const { status, data } = await apiInstance.getAnnouncementAudience(
|
|
|
231
231
|
[[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)
|
|
232
232
|
|
|
233
233
|
# **getAnnouncementEmailReceipts**
|
|
234
|
-
>
|
|
234
|
+
> GetAcccountEmailReceipts200Response getAnnouncementEmailReceipts()
|
|
235
235
|
|
|
236
236
|
Get Announcement Email Receipts endpoint
|
|
237
237
|
|
|
@@ -277,7 +277,7 @@ const { status, data } = await apiInstance.getAnnouncementEmailReceipts(
|
|
|
277
277
|
|
|
278
278
|
### Return type
|
|
279
279
|
|
|
280
|
-
**
|
|
280
|
+
**GetAcccountEmailReceipts200Response**
|
|
281
281
|
|
|
282
282
|
### Authorization
|
|
283
283
|
|
|
@@ -8,7 +8,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
8
8
|
|[**updateAnnouncementSchedule**](#updateannouncementschedule) | **PUT** /announcements/{announcementId}/schedule | Update Announcement Schedule|
|
|
9
9
|
|
|
10
10
|
# **cancelAnnouncementSchedule**
|
|
11
|
-
>
|
|
11
|
+
> CreateAnnouncement200Response cancelAnnouncementSchedule()
|
|
12
12
|
|
|
13
13
|
Cancel Announcement Schedule endpoint
|
|
14
14
|
|
|
@@ -39,7 +39,7 @@ const { status, data } = await apiInstance.cancelAnnouncementSchedule(
|
|
|
39
39
|
|
|
40
40
|
### Return type
|
|
41
41
|
|
|
42
|
-
**
|
|
42
|
+
**CreateAnnouncement200Response**
|
|
43
43
|
|
|
44
44
|
### Authorization
|
|
45
45
|
|
|
@@ -59,7 +59,7 @@ const { status, data } = await apiInstance.cancelAnnouncementSchedule(
|
|
|
59
59
|
[[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)
|
|
60
60
|
|
|
61
61
|
# **updateAnnouncementSchedule**
|
|
62
|
-
>
|
|
62
|
+
> CreateAnnouncement200Response updateAnnouncementSchedule(body)
|
|
63
63
|
|
|
64
64
|
Update Announcement Schedule endpoint
|
|
65
65
|
|
|
@@ -93,7 +93,7 @@ const { status, data } = await apiInstance.updateAnnouncementSchedule(
|
|
|
93
93
|
|
|
94
94
|
### Return type
|
|
95
95
|
|
|
96
|
-
**
|
|
96
|
+
**CreateAnnouncement200Response**
|
|
97
97
|
|
|
98
98
|
### Authorization
|
|
99
99
|
|
|
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**startAfter** | **string** | | [default to undefined]
|
|
15
15
|
**type** | [**EventActivationType**](EventActivationType.md) | | [default to undefined]
|
|
16
16
|
**accessLevel** | [**PassTypeAccessLevel**](PassTypeAccessLevel.md) | | [default to undefined]
|
|
17
|
+
**sortOrder** | **number** | | [default to undefined]
|
|
17
18
|
**survey** | [**BaseSurvey**](BaseSurvey.md) | | [default to undefined]
|
|
18
19
|
**_count** | [**BaseEventActivationCount**](BaseEventActivationCount.md) | | [default to undefined]
|
|
19
20
|
|
|
@@ -32,6 +33,7 @@ const instance: BaseEventActivation = {
|
|
|
32
33
|
startAfter,
|
|
33
34
|
type,
|
|
34
35
|
accessLevel,
|
|
36
|
+
sortOrder,
|
|
35
37
|
survey,
|
|
36
38
|
_count,
|
|
37
39
|
};
|
package/docs/BaseSideEffect.md
CHANGED
|
@@ -10,12 +10,14 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**checkedInPassEventId** | **string** | | [default to undefined]
|
|
11
11
|
**newAccountTierId** | **string** | | [default to undefined]
|
|
12
12
|
**removedAccountTierId** | **string** | | [default to undefined]
|
|
13
|
+
**passWithQuestionChoiceId** | **string** | | [default to undefined]
|
|
13
14
|
**joinGroupId** | **string** | | [default to undefined]
|
|
14
15
|
**leaveGroupId** | **string** | | [default to undefined]
|
|
15
16
|
**addToTierId** | **string** | | [default to undefined]
|
|
16
17
|
**subscribeToChannelId** | **string** | | [default to undefined]
|
|
17
18
|
**sendWebhookId** | **string** | | [default to undefined]
|
|
18
19
|
**completeActivationId** | **string** | | [default to undefined]
|
|
20
|
+
**registerForSessionId** | **string** | | [default to undefined]
|
|
19
21
|
|
|
20
22
|
## Example
|
|
21
23
|
|
|
@@ -28,12 +30,14 @@ const instance: BaseSideEffect = {
|
|
|
28
30
|
checkedInPassEventId,
|
|
29
31
|
newAccountTierId,
|
|
30
32
|
removedAccountTierId,
|
|
33
|
+
passWithQuestionChoiceId,
|
|
31
34
|
joinGroupId,
|
|
32
35
|
leaveGroupId,
|
|
33
36
|
addToTierId,
|
|
34
37
|
subscribeToChannelId,
|
|
35
38
|
sendWebhookId,
|
|
36
39
|
completeActivationId,
|
|
40
|
+
registerForSessionId,
|
|
37
41
|
};
|
|
38
42
|
```
|
|
39
43
|
|
package/docs/BookingSpace.md
CHANGED
|
@@ -22,6 +22,8 @@ Name | Type | Description | Notes
|
|
|
22
22
|
**taxLocation** | [**TaxLocationType**](TaxLocationType.md) | | [default to undefined]
|
|
23
23
|
**confirmationBody** | **string** | | [default to undefined]
|
|
24
24
|
**confirmationReplyTo** | **string** | | [default to undefined]
|
|
25
|
+
**cancellationBody** | **string** | | [default to undefined]
|
|
26
|
+
**cancellationReplyTo** | **string** | | [default to undefined]
|
|
25
27
|
**createdAt** | **string** | | [default to undefined]
|
|
26
28
|
**updatedAt** | **string** | | [default to undefined]
|
|
27
29
|
|
|
@@ -48,6 +50,8 @@ const instance: BookingSpace = {
|
|
|
48
50
|
taxLocation,
|
|
49
51
|
confirmationBody,
|
|
50
52
|
confirmationReplyTo,
|
|
53
|
+
cancellationBody,
|
|
54
|
+
cancellationReplyTo,
|
|
51
55
|
createdAt,
|
|
52
56
|
updatedAt,
|
|
53
57
|
};
|
|
@@ -17,6 +17,8 @@ Name | Type | Description | Notes
|
|
|
17
17
|
**visible** | **boolean** | | [optional] [default to undefined]
|
|
18
18
|
**confirmationBody** | **string** | | [optional] [default to undefined]
|
|
19
19
|
**confirmationReplyTo** | **string** | | [optional] [default to undefined]
|
|
20
|
+
**cancellationBody** | **string** | | [optional] [default to undefined]
|
|
21
|
+
**cancellationReplyTo** | **string** | | [optional] [default to undefined]
|
|
20
22
|
**taxCode** | **string** | | [optional] [default to undefined]
|
|
21
23
|
**taxIncluded** | **boolean** | | [optional] [default to undefined]
|
|
22
24
|
**taxLocation** | [**TaxLocationType**](TaxLocationType.md) | | [optional] [default to undefined]
|
|
@@ -39,6 +41,8 @@ const instance: BookingSpaceCreateInputs = {
|
|
|
39
41
|
visible,
|
|
40
42
|
confirmationBody,
|
|
41
43
|
confirmationReplyTo,
|
|
44
|
+
cancellationBody,
|
|
45
|
+
cancellationReplyTo,
|
|
42
46
|
taxCode,
|
|
43
47
|
taxIncluded,
|
|
44
48
|
taxLocation,
|
|
@@ -9,6 +9,8 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**locale** | **string** | | [default to undefined]
|
|
10
10
|
**name** | **string** | | [default to undefined]
|
|
11
11
|
**description** | **string** | | [default to undefined]
|
|
12
|
+
**confirmationBody** | **string** | | [default to undefined]
|
|
13
|
+
**cancellationBody** | **string** | | [default to undefined]
|
|
12
14
|
**createdAt** | **string** | | [default to undefined]
|
|
13
15
|
**updatedAt** | **string** | | [default to undefined]
|
|
14
16
|
|
|
@@ -22,6 +24,8 @@ const instance: BookingSpaceTranslation = {
|
|
|
22
24
|
locale,
|
|
23
25
|
name,
|
|
24
26
|
description,
|
|
27
|
+
confirmationBody,
|
|
28
|
+
cancellationBody,
|
|
25
29
|
createdAt,
|
|
26
30
|
updatedAt,
|
|
27
31
|
};
|
|
@@ -7,6 +7,8 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**name** | **string** | | [optional] [default to undefined]
|
|
9
9
|
**description** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**confirmationBody** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**cancellationBody** | **string** | | [optional] [default to undefined]
|
|
10
12
|
|
|
11
13
|
## Example
|
|
12
14
|
|
|
@@ -16,6 +18,8 @@ import { BookingSpaceTranslationUpdateInputs } from '@connectedxm/admin-sdk';
|
|
|
16
18
|
const instance: BookingSpaceTranslationUpdateInputs = {
|
|
17
19
|
name,
|
|
18
20
|
description,
|
|
21
|
+
confirmationBody,
|
|
22
|
+
cancellationBody,
|
|
19
23
|
};
|
|
20
24
|
```
|
|
21
25
|
|
|
@@ -16,6 +16,8 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**visible** | **boolean** | | [optional] [default to undefined]
|
|
17
17
|
**confirmationBody** | **string** | | [optional] [default to undefined]
|
|
18
18
|
**confirmationReplyTo** | **string** | | [optional] [default to undefined]
|
|
19
|
+
**cancellationBody** | **string** | | [optional] [default to undefined]
|
|
20
|
+
**cancellationReplyTo** | **string** | | [optional] [default to undefined]
|
|
19
21
|
**taxCode** | **string** | | [optional] [default to undefined]
|
|
20
22
|
**taxIncluded** | **boolean** | | [optional] [default to undefined]
|
|
21
23
|
**taxLocation** | [**TaxLocationType**](TaxLocationType.md) | | [optional] [default to undefined]
|
|
@@ -37,6 +39,8 @@ const instance: BookingSpaceUpdateInputs = {
|
|
|
37
39
|
visible,
|
|
38
40
|
confirmationBody,
|
|
39
41
|
confirmationReplyTo,
|
|
42
|
+
cancellationBody,
|
|
43
|
+
cancellationReplyTo,
|
|
40
44
|
taxCode,
|
|
41
45
|
taxIncluded,
|
|
42
46
|
taxLocation,
|
package/docs/BookingsApi.md
CHANGED
|
@@ -4,6 +4,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
|[**cancelBooking**](#cancelbooking) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/bookings/{bookingId}/cancel | Cancel Booking|
|
|
7
8
|
|[**createBooking**](#createbooking) | **POST** /bookings/places/{placeId}/spaces/{spaceId}/bookings | Create Booking|
|
|
8
9
|
|[**deleteBooking**](#deletebooking) | **DELETE** /bookings/places/{placeId}/spaces/{spaceId}/bookings/{bookingId} | Delete Booking|
|
|
9
10
|
|[**getBooking**](#getbooking) | **GET** /bookings/{bookingId} | Get Booking|
|
|
@@ -22,6 +23,63 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
22
23
|
|[**getBookingSpaces**](#getbookingspaces) | **GET** /bookings/places/{placeId}/spaces | Get Booking Spaces|
|
|
23
24
|
|[**updateBooking**](#updatebooking) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/bookings/{bookingId} | Update Booking|
|
|
24
25
|
|
|
26
|
+
# **cancelBooking**
|
|
27
|
+
> CreateBooking200Response cancelBooking()
|
|
28
|
+
|
|
29
|
+
Cancel Booking endpoint
|
|
30
|
+
|
|
31
|
+
### Example
|
|
32
|
+
|
|
33
|
+
```typescript
|
|
34
|
+
import {
|
|
35
|
+
BookingsApi,
|
|
36
|
+
Configuration
|
|
37
|
+
} from '@connectedxm/admin-sdk';
|
|
38
|
+
|
|
39
|
+
const configuration = new Configuration();
|
|
40
|
+
const apiInstance = new BookingsApi(configuration);
|
|
41
|
+
|
|
42
|
+
let placeId: string; //The place identifier (default to undefined)
|
|
43
|
+
let spaceId: string; //The space identifier (default to undefined)
|
|
44
|
+
let bookingId: string; //The booking identifier (default to undefined)
|
|
45
|
+
|
|
46
|
+
const { status, data } = await apiInstance.cancelBooking(
|
|
47
|
+
placeId,
|
|
48
|
+
spaceId,
|
|
49
|
+
bookingId
|
|
50
|
+
);
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### Parameters
|
|
54
|
+
|
|
55
|
+
|Name | Type | Description | Notes|
|
|
56
|
+
|------------- | ------------- | ------------- | -------------|
|
|
57
|
+
| **placeId** | [**string**] | The place identifier | defaults to undefined|
|
|
58
|
+
| **spaceId** | [**string**] | The space identifier | defaults to undefined|
|
|
59
|
+
| **bookingId** | [**string**] | The booking identifier | defaults to undefined|
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
### Return type
|
|
63
|
+
|
|
64
|
+
**CreateBooking200Response**
|
|
65
|
+
|
|
66
|
+
### Authorization
|
|
67
|
+
|
|
68
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
69
|
+
|
|
70
|
+
### HTTP request headers
|
|
71
|
+
|
|
72
|
+
- **Content-Type**: Not defined
|
|
73
|
+
- **Accept**: application/json
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
### HTTP response details
|
|
77
|
+
| Status code | Description | Response headers |
|
|
78
|
+
|-------------|-------------|------------------|
|
|
79
|
+
|**200** | Successful response | - |
|
|
80
|
+
|
|
81
|
+
[[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)
|
|
82
|
+
|
|
25
83
|
# **createBooking**
|
|
26
84
|
> CreateBooking200Response createBooking(bookingCreateInputs)
|
|
27
85
|
|
|
@@ -486,7 +544,7 @@ const { status, data } = await apiInstance.getBookingSpace(
|
|
|
486
544
|
[[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)
|
|
487
545
|
|
|
488
546
|
# **getBookingSpaceAvailabilities**
|
|
489
|
-
>
|
|
547
|
+
> GetBookingSpaceAvailabilities200Response getBookingSpaceAvailabilities()
|
|
490
548
|
|
|
491
549
|
Get Booking Space Availabilities endpoint
|
|
492
550
|
|
|
@@ -520,7 +578,7 @@ const { status, data } = await apiInstance.getBookingSpaceAvailabilities(
|
|
|
520
578
|
|
|
521
579
|
### Return type
|
|
522
580
|
|
|
523
|
-
**
|
|
581
|
+
**GetBookingSpaceAvailabilities200Response**
|
|
524
582
|
|
|
525
583
|
### Authorization
|
|
526
584
|
|
|
@@ -540,7 +598,7 @@ const { status, data } = await apiInstance.getBookingSpaceAvailabilities(
|
|
|
540
598
|
[[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)
|
|
541
599
|
|
|
542
600
|
# **getBookingSpaceAvailability**
|
|
543
|
-
>
|
|
601
|
+
> CreateBookingSpaceAvailability200Response getBookingSpaceAvailability()
|
|
544
602
|
|
|
545
603
|
Get Booking Space Availability endpoint
|
|
546
604
|
|
|
@@ -577,7 +635,7 @@ const { status, data } = await apiInstance.getBookingSpaceAvailability(
|
|
|
577
635
|
|
|
578
636
|
### Return type
|
|
579
637
|
|
|
580
|
-
**
|
|
638
|
+
**CreateBookingSpaceAvailability200Response**
|
|
581
639
|
|
|
582
640
|
### Authorization
|
|
583
641
|
|
|
@@ -597,7 +655,7 @@ const { status, data } = await apiInstance.getBookingSpaceAvailability(
|
|
|
597
655
|
[[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)
|
|
598
656
|
|
|
599
657
|
# **getBookingSpaceBlackout**
|
|
600
|
-
>
|
|
658
|
+
> CreateBookingSpaceBlackout200Response getBookingSpaceBlackout()
|
|
601
659
|
|
|
602
660
|
Get Booking Space Blackout endpoint
|
|
603
661
|
|
|
@@ -634,7 +692,7 @@ const { status, data } = await apiInstance.getBookingSpaceBlackout(
|
|
|
634
692
|
|
|
635
693
|
### Return type
|
|
636
694
|
|
|
637
|
-
**
|
|
695
|
+
**CreateBookingSpaceBlackout200Response**
|
|
638
696
|
|
|
639
697
|
### Authorization
|
|
640
698
|
|
|
@@ -654,7 +712,7 @@ const { status, data } = await apiInstance.getBookingSpaceBlackout(
|
|
|
654
712
|
[[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)
|
|
655
713
|
|
|
656
714
|
# **getBookingSpaceBlackouts**
|
|
657
|
-
>
|
|
715
|
+
> GetBookingSpaceBlackouts200Response getBookingSpaceBlackouts()
|
|
658
716
|
|
|
659
717
|
Get Booking Space Blackouts endpoint
|
|
660
718
|
|
|
@@ -703,7 +761,7 @@ const { status, data } = await apiInstance.getBookingSpaceBlackouts(
|
|
|
703
761
|
|
|
704
762
|
### Return type
|
|
705
763
|
|
|
706
|
-
**
|
|
764
|
+
**GetBookingSpaceBlackouts200Response**
|
|
707
765
|
|
|
708
766
|
### Authorization
|
|
709
767
|
|
|
@@ -867,7 +925,7 @@ const { status, data } = await apiInstance.getBookingSpacePayments(
|
|
|
867
925
|
[[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)
|
|
868
926
|
|
|
869
927
|
# **getBookingSpaceSlots**
|
|
870
|
-
>
|
|
928
|
+
> GetBookingSpaceSlots200Response getBookingSpaceSlots()
|
|
871
929
|
|
|
872
930
|
Get Booking Space Slots endpoint
|
|
873
931
|
|
|
@@ -904,7 +962,7 @@ const { status, data } = await apiInstance.getBookingSpaceSlots(
|
|
|
904
962
|
|
|
905
963
|
### Return type
|
|
906
964
|
|
|
907
|
-
**
|
|
965
|
+
**GetBookingSpaceSlots200Response**
|
|
908
966
|
|
|
909
967
|
### Authorization
|
|
910
968
|
|
|
@@ -9,7 +9,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
9
9
|
|[**updateBookingSpaceAvailability**](#updatebookingspaceavailability) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/availabilities/{availabilityId} | Update Booking Space Availability|
|
|
10
10
|
|
|
11
11
|
# **createBookingSpaceAvailability**
|
|
12
|
-
>
|
|
12
|
+
> CreateBookingSpaceAvailability200Response createBookingSpaceAvailability(bookingSpaceAvailabilityCreateInputs)
|
|
13
13
|
|
|
14
14
|
Create Booking Space Availability endpoint
|
|
15
15
|
|
|
@@ -47,7 +47,7 @@ const { status, data } = await apiInstance.createBookingSpaceAvailability(
|
|
|
47
47
|
|
|
48
48
|
### Return type
|
|
49
49
|
|
|
50
|
-
**
|
|
50
|
+
**CreateBookingSpaceAvailability200Response**
|
|
51
51
|
|
|
52
52
|
### Authorization
|
|
53
53
|
|
|
@@ -67,7 +67,7 @@ const { status, data } = await apiInstance.createBookingSpaceAvailability(
|
|
|
67
67
|
[[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)
|
|
68
68
|
|
|
69
69
|
# **deleteBookingSpaceAvailability**
|
|
70
|
-
>
|
|
70
|
+
> CreateAccountInvitations200Response deleteBookingSpaceAvailability()
|
|
71
71
|
|
|
72
72
|
Delete Booking Space Availability endpoint
|
|
73
73
|
|
|
@@ -104,7 +104,7 @@ const { status, data } = await apiInstance.deleteBookingSpaceAvailability(
|
|
|
104
104
|
|
|
105
105
|
### Return type
|
|
106
106
|
|
|
107
|
-
**
|
|
107
|
+
**CreateAccountInvitations200Response**
|
|
108
108
|
|
|
109
109
|
### Authorization
|
|
110
110
|
|
|
@@ -124,7 +124,7 @@ const { status, data } = await apiInstance.deleteBookingSpaceAvailability(
|
|
|
124
124
|
[[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)
|
|
125
125
|
|
|
126
126
|
# **updateBookingSpaceAvailability**
|
|
127
|
-
>
|
|
127
|
+
> CreateBookingSpaceAvailability200Response updateBookingSpaceAvailability()
|
|
128
128
|
|
|
129
129
|
Update Booking Space Availability endpoint
|
|
130
130
|
|
|
@@ -165,7 +165,7 @@ const { status, data } = await apiInstance.updateBookingSpaceAvailability(
|
|
|
165
165
|
|
|
166
166
|
### Return type
|
|
167
167
|
|
|
168
|
-
**
|
|
168
|
+
**CreateBookingSpaceAvailability200Response**
|
|
169
169
|
|
|
170
170
|
### Authorization
|
|
171
171
|
|