@connectedxm/admin-sdk 7.5.0 → 7.5.1
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/README.md +1212 -1212
- package/api.ts +9696 -9696
- package/dist/api.d.ts +9696 -9696
- package/dist/api.js +9696 -9696
- package/dist/esm/api.d.ts +9696 -9696
- package/dist/esm/api.js +9696 -9696
- package/docs/AccountsAddressesApi.md +10 -10
- package/docs/AccountsApi.md +42 -42
- package/docs/AccountsFollowersApi.md +6 -6
- package/docs/AccountsFollowingApi.md +6 -6
- package/docs/AccountsGroupsApi.md +6 -6
- package/docs/AccountsInterestsApi.md +6 -6
- package/docs/AccountsInvitationsApi.md +6 -6
- package/docs/AccountsLeadsApi.md +8 -8
- package/docs/AccountsTiersApi.md +8 -8
- package/docs/ActivitiesApi.md +18 -18
- package/docs/ActivitiesScheduleApi.md +4 -4
- package/docs/AdvertisementsApi.md +14 -14
- package/docs/AnnouncementsApi.md +16 -16
- package/docs/AnnouncementsScheduleApi.md +4 -4
- package/docs/AnnouncementsTranslationsApi.md +8 -8
- package/docs/ApiLogsApi.md +4 -4
- package/docs/AuthSessionsApi.md +4 -4
- package/docs/BenefitsApi.md +12 -12
- package/docs/BenefitsTranslationsApi.md +8 -8
- package/docs/BookingsApi.md +56 -56
- package/docs/BookingsAvailabilitiesApi.md +6 -6
- package/docs/BookingsBlackoutsApi.md +6 -6
- package/docs/BookingsPlacesApi.md +6 -6
- package/docs/BookingsPlacesTranslationsApi.md +4 -4
- package/docs/BookingsQuestionsApi.md +16 -16
- package/docs/BookingsQuestionsChoicesApi.md +12 -12
- package/docs/BookingsQuestionsChoicesTranslationsApi.md +8 -8
- package/docs/BookingsQuestionsTranslationsApi.md +8 -8
- package/docs/BookingsSpacesApi.md +6 -6
- package/docs/BookingsSpacesTranslationsApi.md +4 -4
- package/docs/ChannelsApi.md +58 -58
- package/docs/ChannelsTranslationsApi.md +24 -24
- package/docs/DashboardsApi.md +10 -10
- package/docs/DashboardsWidgetsApi.md +8 -8
- package/docs/EmailReceiptsApi.md +4 -4
- package/docs/EventsAccessApi.md +6 -6
- package/docs/EventsActivationsApi.md +22 -22
- package/docs/EventsActivationsSessionsApi.md +6 -6
- package/docs/EventsActivationsTranslationsApi.md +8 -8
- package/docs/EventsAddonsApi.md +24 -24
- package/docs/EventsAddonsTranslationsApi.md +8 -8
- package/docs/EventsApi.md +22 -22
- package/docs/EventsAttendeesApi.md +24 -24
- package/docs/EventsAttendeesPackagesApi.md +10 -10
- package/docs/EventsAttendeesReservationsApi.md +18 -18
- package/docs/EventsAttributesApi.md +10 -10
- package/docs/EventsBenefitsApi.md +4 -4
- package/docs/EventsBlocksApi.md +16 -16
- package/docs/EventsBypassApi.md +10 -10
- package/docs/EventsCohostsApi.md +6 -6
- package/docs/EventsCouponsApi.md +28 -28
- package/docs/EventsEmailsApi.md +4 -4
- package/docs/EventsEmailsTranslationsApi.md +8 -8
- package/docs/EventsFaqsApi.md +22 -22
- package/docs/EventsFaqsTranslationsApi.md +16 -16
- package/docs/EventsFollowupsApi.md +38 -38
- package/docs/EventsFollowupsTranslationsApi.md +8 -8
- package/docs/EventsMatchesApi.md +34 -34
- package/docs/EventsMediaApi.md +16 -16
- package/docs/EventsMediaTranslationsApi.md +8 -8
- package/docs/EventsOnSiteApi.md +6 -6
- package/docs/EventsPackagesApi.md +10 -10
- package/docs/EventsPackagesPassesApi.md +10 -10
- package/docs/EventsPackagesTranslationsApi.md +8 -8
- package/docs/EventsPagesApi.md +16 -16
- package/docs/EventsPagesTranslationsApi.md +8 -8
- package/docs/EventsPassesAccessesApi.md +10 -10
- package/docs/EventsPassesAddonsApi.md +6 -6
- package/docs/EventsPassesApi.md +34 -34
- package/docs/EventsPassesAttributesApi.md +6 -6
- package/docs/EventsPassesFollowupsApi.md +8 -8
- package/docs/EventsPassesResponsesApi.md +10 -10
- package/docs/EventsPasstypesApi.md +34 -34
- package/docs/EventsPasstypesPriceschedulesApi.md +10 -10
- package/docs/EventsPasstypesRefundschedulesApi.md +10 -10
- package/docs/EventsPasstypesTranslationsApi.md +8 -8
- package/docs/EventsQuestionsApi.md +44 -44
- package/docs/EventsQuestionsTranslationsApi.md +16 -16
- package/docs/EventsRoomsApi.md +18 -18
- package/docs/EventsRoomtypesApi.md +24 -24
- package/docs/EventsRoomtypesTranslationsApi.md +8 -8
- package/docs/EventsSectionsApi.md +38 -38
- package/docs/EventsSectionsTranslationsApi.md +8 -8
- package/docs/EventsSessionsAccessesApi.md +6 -6
- package/docs/EventsSessionsApi.md +70 -70
- package/docs/EventsSessionsLocationsApi.md +16 -16
- package/docs/EventsSessionsLocationsTranslationsApi.md +8 -8
- package/docs/EventsSessionsMatchesApi.md +32 -32
- package/docs/EventsSessionsPricesApi.md +6 -6
- package/docs/EventsSessionsQuestionsApi.md +38 -38
- package/docs/EventsSessionsQuestionsTranslationsApi.md +16 -16
- package/docs/EventsSessionsSectionsApi.md +20 -20
- package/docs/EventsSessionsSectionsTranslationsApi.md +8 -8
- package/docs/EventsSessionsTimesApi.md +16 -16
- package/docs/EventsSessionsTimesTranslationsApi.md +8 -8
- package/docs/EventsSessionsTranslationsApi.md +8 -8
- package/docs/EventsSpeakersApi.md +16 -16
- package/docs/EventsSpeakersTranslationsApi.md +8 -8
- package/docs/EventsSponsorsApi.md +8 -8
- package/docs/EventsSponsorshiplevelsApi.md +12 -12
- package/docs/EventsSponsorshiplevelsTranslationsApi.md +8 -8
- package/docs/EventsSponsorshipsApi.md +12 -12
- package/docs/EventsSponsorshipsTranslationsApi.md +8 -8
- package/docs/EventsTemplatesApi.md +2 -2
- package/docs/EventsTracksApi.md +22 -22
- package/docs/EventsTracksTranslationsApi.md +8 -8
- package/docs/EventsTransfersApi.md +4 -4
- package/docs/EventsTranslationsApi.md +8 -8
- package/docs/FilesApi.md +4 -4
- package/docs/GroupsApi.md +12 -12
- package/docs/GroupsEventsApi.md +6 -6
- package/docs/GroupsInterestsApi.md +6 -6
- package/docs/GroupsInvitationsApi.md +12 -12
- package/docs/GroupsMembersApi.md +8 -8
- package/docs/GroupsModeratorsApi.md +6 -6
- package/docs/GroupsRequestsApi.md +10 -10
- package/docs/GroupsSponsorsApi.md +6 -6
- package/docs/GroupsTranslationsApi.md +8 -8
- package/docs/ImportsApi.md +8 -8
- package/docs/InterestsApi.md +22 -22
- package/docs/InvoicesApi.md +20 -20
- package/docs/InvoicesLineitemsApi.md +6 -6
- package/docs/LoginsAccountsApi.md +6 -6
- package/docs/LoginsApi.md +16 -16
- package/docs/MeetingsApi.md +14 -14
- package/docs/MeetingsLinksApi.md +10 -10
- package/docs/MeetingsLivestreamsApi.md +12 -12
- package/docs/MeetingsParticipantsApi.md +12 -12
- package/docs/MeetingsPresetsApi.md +10 -10
- package/docs/MeetingsRecordingsApi.md +4 -4
- package/docs/MeetingsSessionsApi.md +16 -16
- package/docs/NotificationsApi.md +8 -8
- package/docs/OrganizationApi.md +18 -18
- package/docs/OrganizationAttributesApi.md +14 -14
- package/docs/OrganizationDomainsApi.md +6 -6
- package/docs/OrganizationIntegrationsApi.md +10 -10
- package/docs/OrganizationModulesApi.md +6 -6
- package/docs/OrganizationModulesCustomApi.md +10 -10
- package/docs/OrganizationModulesCustomTranslationsApi.md +8 -8
- package/docs/OrganizationModulesSettingsApi.md +4 -4
- package/docs/OrganizationModulesSettingsTranslationsApi.md +8 -8
- package/docs/OrganizationModulesTiersApi.md +12 -12
- package/docs/OrganizationPaymentsApi.md +20 -20
- package/docs/OrganizationSideeffectsApi.md +8 -8
- package/docs/OrganizationTaxApi.md +22 -22
- package/docs/OrganizationTeammembersApi.md +10 -10
- package/docs/OrganizationUsersApi.md +6 -6
- package/docs/OrganizationWebhooksApi.md +12 -12
- package/docs/PaymentsApi.md +2 -2
- package/docs/PreferencesApi.md +4 -4
- package/docs/PushDevicesApi.md +6 -6
- package/docs/ReportsApi.md +22 -22
- package/docs/ReportsUsersApi.md +6 -6
- package/docs/SearchlistsApi.md +10 -10
- package/docs/SearchlistsValuesApi.md +14 -14
- package/docs/SelfApi.md +10 -10
- package/docs/SelfApikeysApi.md +8 -8
- package/docs/SelfImagesApi.md +4 -4
- package/docs/SeriesApi.md +18 -18
- package/docs/SeriesQuestionsApi.md +14 -14
- package/docs/SeriesQuestionsChoicesApi.md +8 -8
- package/docs/SeriesQuestionsTranslationsApi.md +4 -4
- package/docs/SeriesRegistrationsApi.md +18 -18
- package/docs/SeriesTranslationsApi.md +8 -8
- package/docs/SponsorsAccountsApi.md +6 -6
- package/docs/SponsorsApi.md +10 -10
- package/docs/SponsorsTranslationsApi.md +8 -8
- package/docs/StorageFilesApi.md +6 -6
- package/docs/StorageImagesApi.md +18 -18
- package/docs/StorageVideosApi.md +14 -14
- package/docs/StorageVideosCaptionsApi.md +10 -10
- package/docs/StreamsApi.md +14 -14
- package/docs/StreamsOutputsApi.md +10 -10
- package/docs/StreamsSessionsApi.md +12 -12
- package/docs/SupportApi.md +14 -14
- package/docs/SupportMessagesApi.md +4 -4
- package/docs/SupportNotesApi.md +6 -6
- package/docs/SurveysApi.md +12 -12
- package/docs/SurveysQuestionsApi.md +38 -38
- package/docs/SurveysQuestionsTranslationsApi.md +16 -16
- package/docs/SurveysSectionsApi.md +20 -20
- package/docs/SurveysSectionsTranslationsApi.md +8 -8
- package/docs/SurveysSessionsApi.md +4 -4
- package/docs/SurveysSubmissionsApi.md +14 -14
- package/docs/SurveysTranslationsApi.md +8 -8
- package/docs/ThreadsAccountsApi.md +8 -8
- package/docs/ThreadsApi.md +10 -10
- package/docs/ThreadsMessagesApi.md +12 -12
- package/docs/ThreadsMessagesFilesApi.md +6 -6
- package/docs/ThreadsMessagesImagesApi.md +6 -6
- package/docs/ThreadsMessagesReactionsApi.md +6 -6
- package/docs/ThreadsMessagesVideosApi.md +6 -6
- package/docs/ThreadsStorageApi.md +6 -6
- package/docs/TiersApi.md +20 -20
- package/package.json +1 -1
|
@@ -4,30 +4,30 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**addSurveyQuestionChoiceSubQuestion**](#addsurveyquestionchoicesubquestion) | **POST** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/subQuestions/{subQuestionId} |
|
|
8
|
-
|[**attachSurveyQuestionSearchList**](#attachsurveyquestionsearchlist) | **PUT** /surveys/{surveyId}/questions/{questionId}/searchlist | Attach
|
|
9
|
-
|[**createSurveyQuestion**](#createsurveyquestion) | **POST** /surveys/{surveyId}/questions | Create
|
|
10
|
-
|[**createSurveyQuestionChoice**](#createsurveyquestionchoice) | **POST** /surveys/{surveyId}/questions/{questionId}/choices | Create
|
|
11
|
-
|[**deleteSurveyQuestion**](#deletesurveyquestion) | **DELETE** /surveys/{surveyId}/questions/{questionId} | Delete
|
|
12
|
-
|[**deleteSurveyQuestionChoice**](#deletesurveyquestionchoice) | **DELETE** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId} | Delete
|
|
13
|
-
|[**detachSurveyQuestionSearchList**](#detachsurveyquestionsearchlist) | **DELETE** /surveys/{surveyId}/questions/{questionId}/searchlist | Detach
|
|
14
|
-
|[**getSurveyQuestion**](#getsurveyquestion) | **GET** /surveys/{surveyId}/questions/{questionId} | Get
|
|
15
|
-
|[**getSurveyQuestionChoice**](#getsurveyquestionchoice) | **GET** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId} | Get
|
|
16
|
-
|[**getSurveyQuestionChoiceSubQuestions**](#getsurveyquestionchoicesubquestions) | **GET** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/subQuestions |
|
|
17
|
-
|[**getSurveyQuestionChoices**](#getsurveyquestionchoices) | **GET** /surveys/{surveyId}/questions/{questionId}/choices |
|
|
18
|
-
|[**getSurveyQuestionResponses**](#getsurveyquestionresponses) | **GET** /surveys/{surveyId}/questions/{questionId}/responses |
|
|
19
|
-
|[**getSurveyQuestions**](#getsurveyquestions) | **GET** /surveys/{surveyId}/questions |
|
|
20
|
-
|[**removeSurveyQuestionChoiceSubQuestion**](#removesurveyquestionchoicesubquestion) | **DELETE** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/subQuestions/{subQuestionId} | Remove
|
|
21
|
-
|[**reorderSurveyQuestionChoiceSubQuestions**](#reordersurveyquestionchoicesubquestions) | **PUT** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/subQuestions/reorder | Reorder
|
|
22
|
-
|[**reorderSurveyQuestionChoices**](#reordersurveyquestionchoices) | **PUT** /surveys/{surveyId}/questions/{questionId}/choices/reorder | Reorder
|
|
23
|
-
|[**updateSurveyQuestion**](#updatesurveyquestion) | **PUT** /surveys/{surveyId}/questions/{questionId} | Update
|
|
24
|
-
|[**updateSurveyQuestionChoice**](#updatesurveyquestionchoice) | **PUT** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId} | Update
|
|
25
|
-
|[**updateSurveyQuestionChoiceSubQuestion**](#updatesurveyquestionchoicesubquestion) | **PUT** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/subQuestions/{subQuestionId} |
|
|
7
|
+
|[**addSurveyQuestionChoiceSubQuestion**](#addsurveyquestionchoicesubquestion) | **POST** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/subQuestions/{subQuestionId} | Attach a follow-up sub-question to a choice|
|
|
8
|
+
|[**attachSurveyQuestionSearchList**](#attachsurveyquestionsearchlist) | **PUT** /surveys/{surveyId}/questions/{questionId}/searchlist | Attach a search list to a survey question|
|
|
9
|
+
|[**createSurveyQuestion**](#createsurveyquestion) | **POST** /surveys/{surveyId}/questions | Create a survey question|
|
|
10
|
+
|[**createSurveyQuestionChoice**](#createsurveyquestionchoice) | **POST** /surveys/{surveyId}/questions/{questionId}/choices | Create a choice for a survey question|
|
|
11
|
+
|[**deleteSurveyQuestion**](#deletesurveyquestion) | **DELETE** /surveys/{surveyId}/questions/{questionId} | Delete a survey question|
|
|
12
|
+
|[**deleteSurveyQuestionChoice**](#deletesurveyquestionchoice) | **DELETE** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId} | Delete a survey question choice|
|
|
13
|
+
|[**detachSurveyQuestionSearchList**](#detachsurveyquestionsearchlist) | **DELETE** /surveys/{surveyId}/questions/{questionId}/searchlist | Detach the search list from a survey question|
|
|
14
|
+
|[**getSurveyQuestion**](#getsurveyquestion) | **GET** /surveys/{surveyId}/questions/{questionId} | Get a survey question|
|
|
15
|
+
|[**getSurveyQuestionChoice**](#getsurveyquestionchoice) | **GET** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId} | Get a survey question choice|
|
|
16
|
+
|[**getSurveyQuestionChoiceSubQuestions**](#getsurveyquestionchoicesubquestions) | **GET** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/subQuestions | List a choice\'s follow-up sub-questions|
|
|
17
|
+
|[**getSurveyQuestionChoices**](#getsurveyquestionchoices) | **GET** /surveys/{surveyId}/questions/{questionId}/choices | List a survey question\'s choices|
|
|
18
|
+
|[**getSurveyQuestionResponses**](#getsurveyquestionresponses) | **GET** /surveys/{surveyId}/questions/{questionId}/responses | List responses to a survey question|
|
|
19
|
+
|[**getSurveyQuestions**](#getsurveyquestions) | **GET** /surveys/{surveyId}/questions | List a survey\'s questions|
|
|
20
|
+
|[**removeSurveyQuestionChoiceSubQuestion**](#removesurveyquestionchoicesubquestion) | **DELETE** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/subQuestions/{subQuestionId} | Remove a follow-up sub-question from a choice|
|
|
21
|
+
|[**reorderSurveyQuestionChoiceSubQuestions**](#reordersurveyquestionchoicesubquestions) | **PUT** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/subQuestions/reorder | Reorder a choice\'s follow-up sub-questions|
|
|
22
|
+
|[**reorderSurveyQuestionChoices**](#reordersurveyquestionchoices) | **PUT** /surveys/{surveyId}/questions/{questionId}/choices/reorder | Reorder a survey question\'s choices|
|
|
23
|
+
|[**updateSurveyQuestion**](#updatesurveyquestion) | **PUT** /surveys/{surveyId}/questions/{questionId} | Update a survey question|
|
|
24
|
+
|[**updateSurveyQuestionChoice**](#updatesurveyquestionchoice) | **PUT** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId} | Update a survey question choice|
|
|
25
|
+
|[**updateSurveyQuestionChoiceSubQuestion**](#updatesurveyquestionchoicesubquestion) | **PUT** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/subQuestions/{subQuestionId} | Reorder a choice\'s sub-question|
|
|
26
26
|
|
|
27
27
|
# **addSurveyQuestionChoiceSubQuestion**
|
|
28
28
|
> CreateSurveyQuestionChoice200Response addSurveyQuestionChoiceSubQuestion()
|
|
29
29
|
|
|
30
|
-
|
|
30
|
+
Links an existing survey question as a sub-question of the given answer choice so it is presented as a follow-up when that choice is selected, requiring update permission on surveys.
|
|
31
31
|
|
|
32
32
|
### Example
|
|
33
33
|
|
|
@@ -87,7 +87,7 @@ const { status, data } = await apiInstance.addSurveyQuestionChoiceSubQuestion(
|
|
|
87
87
|
# **attachSurveyQuestionSearchList**
|
|
88
88
|
> CreateSurveyQuestion200Response attachSurveyQuestionSearchList(attachSearchListInputs)
|
|
89
89
|
|
|
90
|
-
|
|
90
|
+
Sets the given search list as the source of selectable options for the specified survey question, verifying the search list belongs to the organization and requiring update permission on surveys.
|
|
91
91
|
|
|
92
92
|
### Example
|
|
93
93
|
|
|
@@ -145,7 +145,7 @@ const { status, data } = await apiInstance.attachSurveyQuestionSearchList(
|
|
|
145
145
|
# **createSurveyQuestion**
|
|
146
146
|
> CreateSurveyQuestion200Response createSurveyQuestion(surveyQuestionCreateInputs)
|
|
147
147
|
|
|
148
|
-
|
|
148
|
+
Creates a new question on the given survey, optionally placing it in a section or as a sub-question of another question\'s choice and inserting it at a given sort order, requiring update permission on surveys.
|
|
149
149
|
|
|
150
150
|
### Example
|
|
151
151
|
|
|
@@ -200,7 +200,7 @@ const { status, data } = await apiInstance.createSurveyQuestion(
|
|
|
200
200
|
# **createSurveyQuestionChoice**
|
|
201
201
|
> CreateSurveyQuestionChoice200Response createSurveyQuestionChoice(surveyQuestionChoiceCreateInputs)
|
|
202
202
|
|
|
203
|
-
|
|
203
|
+
Creates a new selectable answer choice for the given survey question, inserting it at the requested sort order among existing choices and requiring update permission on surveys.
|
|
204
204
|
|
|
205
205
|
### Example
|
|
206
206
|
|
|
@@ -258,7 +258,7 @@ const { status, data } = await apiInstance.createSurveyQuestionChoice(
|
|
|
258
258
|
# **deleteSurveyQuestion**
|
|
259
259
|
> CreateAccountInvitations200Response deleteSurveyQuestion()
|
|
260
260
|
|
|
261
|
-
|
|
261
|
+
Permanently deletes the given question from the survey and re-sorts the remaining questions to fill the gap, requiring update permission on surveys.
|
|
262
262
|
|
|
263
263
|
### Example
|
|
264
264
|
|
|
@@ -315,7 +315,7 @@ const { status, data } = await apiInstance.deleteSurveyQuestion(
|
|
|
315
315
|
# **deleteSurveyQuestionChoice**
|
|
316
316
|
> CreateAccountInvitations200Response deleteSurveyQuestionChoice()
|
|
317
317
|
|
|
318
|
-
|
|
318
|
+
Permanently deletes the given answer choice from a survey question and re-sorts the remaining choices, rejecting the deletion if the question is a checkbox type that already has responses, and requiring update permission on surveys.
|
|
319
319
|
|
|
320
320
|
### Example
|
|
321
321
|
|
|
@@ -372,7 +372,7 @@ const { status, data } = await apiInstance.deleteSurveyQuestionChoice(
|
|
|
372
372
|
# **detachSurveyQuestionSearchList**
|
|
373
373
|
> CreateSurveyQuestion200Response detachSurveyQuestionSearchList()
|
|
374
374
|
|
|
375
|
-
|
|
375
|
+
Removes the search list association from the given survey question, clearing its search-list-driven option source, and requires update permission on surveys.
|
|
376
376
|
|
|
377
377
|
### Example
|
|
378
378
|
|
|
@@ -426,7 +426,7 @@ const { status, data } = await apiInstance.detachSurveyQuestionSearchList(
|
|
|
426
426
|
# **getSurveyQuestion**
|
|
427
427
|
> CreateSurveyQuestion200Response getSurveyQuestion()
|
|
428
428
|
|
|
429
|
-
|
|
429
|
+
Returns the details of a single question on a survey, identified by survey and question ID; requires read access to the surveys module.
|
|
430
430
|
|
|
431
431
|
### Example
|
|
432
432
|
|
|
@@ -480,7 +480,7 @@ const { status, data } = await apiInstance.getSurveyQuestion(
|
|
|
480
480
|
# **getSurveyQuestionChoice**
|
|
481
481
|
> CreateSurveyQuestionChoice200Response getSurveyQuestionChoice()
|
|
482
482
|
|
|
483
|
-
|
|
483
|
+
Returns the details of a single answer choice belonging to a survey question, identified by survey, question, and choice ID; requires read access to the surveys module.
|
|
484
484
|
|
|
485
485
|
### Example
|
|
486
486
|
|
|
@@ -537,7 +537,7 @@ const { status, data } = await apiInstance.getSurveyQuestionChoice(
|
|
|
537
537
|
# **getSurveyQuestionChoiceSubQuestions**
|
|
538
538
|
> GetSurveyQuestionChoiceSubQuestions200Response getSurveyQuestionChoiceSubQuestions()
|
|
539
539
|
|
|
540
|
-
|
|
540
|
+
Returns a paginated list of the conditional sub-questions that are triggered when a given survey question choice is selected, supporting search by sub-question name or label; requires read access to the surveys module.
|
|
541
541
|
|
|
542
542
|
### Example
|
|
543
543
|
|
|
@@ -606,7 +606,7 @@ const { status, data } = await apiInstance.getSurveyQuestionChoiceSubQuestions(
|
|
|
606
606
|
# **getSurveyQuestionChoices**
|
|
607
607
|
> GetSurveyQuestionChoices200Response getSurveyQuestionChoices()
|
|
608
608
|
|
|
609
|
-
|
|
609
|
+
Returns a paginated list of the answer choices defined for a survey question, ordered by sort order and supporting search by choice value; requires read access to the surveys module.
|
|
610
610
|
|
|
611
611
|
### Example
|
|
612
612
|
|
|
@@ -672,7 +672,7 @@ const { status, data } = await apiInstance.getSurveyQuestionChoices(
|
|
|
672
672
|
# **getSurveyQuestionResponses**
|
|
673
673
|
> GetSurveyQuestionResponses200Response getSurveyQuestionResponses()
|
|
674
674
|
|
|
675
|
-
|
|
675
|
+
Returns a paginated list of submitted responses for a survey question from completed submissions, supporting search by respondent name or email; file-upload responses include a temporary signed download URL, and read access to the surveys module is required.
|
|
676
676
|
|
|
677
677
|
### Example
|
|
678
678
|
|
|
@@ -738,7 +738,7 @@ const { status, data } = await apiInstance.getSurveyQuestionResponses(
|
|
|
738
738
|
# **getSurveyQuestions**
|
|
739
739
|
> GetSurveyQuestions200Response getSurveyQuestions()
|
|
740
740
|
|
|
741
|
-
|
|
741
|
+
Returns a paginated list of all questions defined on a survey, ordered by sort order and supporting search by name, label, or description; requires read access to the surveys module.
|
|
742
742
|
|
|
743
743
|
### Example
|
|
744
744
|
|
|
@@ -801,7 +801,7 @@ const { status, data } = await apiInstance.getSurveyQuestions(
|
|
|
801
801
|
# **removeSurveyQuestionChoiceSubQuestion**
|
|
802
802
|
> CreateAccountInvitations200Response removeSurveyQuestionChoiceSubQuestion()
|
|
803
803
|
|
|
804
|
-
|
|
804
|
+
Unlinks a sub-question from the given answer choice so it is no longer shown as a follow-up when that choice is selected, re-sorting the remaining sub-questions, and requires update permission on surveys.
|
|
805
805
|
|
|
806
806
|
### Example
|
|
807
807
|
|
|
@@ -861,7 +861,7 @@ const { status, data } = await apiInstance.removeSurveyQuestionChoiceSubQuestion
|
|
|
861
861
|
# **reorderSurveyQuestionChoiceSubQuestions**
|
|
862
862
|
> ReorderSurveyQuestionChoiceSubQuestions200Response reorderSurveyQuestionChoiceSubQuestions()
|
|
863
863
|
|
|
864
|
-
|
|
864
|
+
Sets the display order of the follow-up sub-questions attached to a survey question choice to match the given full list of question IDs, rejecting the request if any sub-question is missing or unknown, and requires update permission on surveys.
|
|
865
865
|
|
|
866
866
|
### Example
|
|
867
867
|
|
|
@@ -921,7 +921,7 @@ const { status, data } = await apiInstance.reorderSurveyQuestionChoiceSubQuestio
|
|
|
921
921
|
# **reorderSurveyQuestionChoices**
|
|
922
922
|
> ReorderSurveyQuestionChoices200Response reorderSurveyQuestionChoices()
|
|
923
923
|
|
|
924
|
-
|
|
924
|
+
Sets the display order of a survey question\'s answer choices to match the given full list of choice IDs, rejecting the request if any choice is missing or unknown, and requires update permission on surveys.
|
|
925
925
|
|
|
926
926
|
### Example
|
|
927
927
|
|
|
@@ -978,7 +978,7 @@ const { status, data } = await apiInstance.reorderSurveyQuestionChoices(
|
|
|
978
978
|
# **updateSurveyQuestion**
|
|
979
979
|
> CreateSurveyQuestion200Response updateSurveyQuestion()
|
|
980
980
|
|
|
981
|
-
|
|
981
|
+
Updates a question\'s fields (such as name, description, type, or required flag) on the given survey, and reorders it among the survey\'s other questions when a new sortOrder is provided; requires the update surveys permission.
|
|
982
982
|
|
|
983
983
|
### Example
|
|
984
984
|
|
|
@@ -1036,7 +1036,7 @@ const { status, data } = await apiInstance.updateSurveyQuestion(
|
|
|
1036
1036
|
# **updateSurveyQuestionChoice**
|
|
1037
1037
|
> SyncAccounts200Response updateSurveyQuestionChoice()
|
|
1038
1038
|
|
|
1039
|
-
|
|
1039
|
+
Updates a choice (such as its label or value) belonging to a survey question, and reorders it among the question\'s other choices when a new sortOrder is provided; requires the update surveys permission.
|
|
1040
1040
|
|
|
1041
1041
|
### Example
|
|
1042
1042
|
|
|
@@ -1097,7 +1097,7 @@ const { status, data } = await apiInstance.updateSurveyQuestionChoice(
|
|
|
1097
1097
|
# **updateSurveyQuestionChoiceSubQuestion**
|
|
1098
1098
|
> CreateSurveyQuestionChoice200Response updateSurveyQuestionChoiceSubQuestion()
|
|
1099
1099
|
|
|
1100
|
-
|
|
1100
|
+
Changes the sort order of a sub-question linked to a survey question choice, shifting the other sub-questions attached to that choice to keep ordering consistent; requires the update surveys permission.
|
|
1101
1101
|
|
|
1102
1102
|
### Example
|
|
1103
1103
|
|
|
@@ -4,19 +4,19 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**deleteSurveyQuestionChoiceTranslation**](#deletesurveyquestionchoicetranslation) | **DELETE** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Delete
|
|
8
|
-
|[**deleteSurveyQuestionTranslation**](#deletesurveyquestiontranslation) | **DELETE** /surveys/{surveyId}/questions/{questionId}/translations/{locale} | Delete
|
|
9
|
-
|[**getSurveyQuestionChoiceTranslation**](#getsurveyquestionchoicetranslation) | **GET** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Get
|
|
10
|
-
|[**getSurveyQuestionChoiceTranslations**](#getsurveyquestionchoicetranslations) | **GET** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/translations |
|
|
11
|
-
|[**getSurveyQuestionTranslation**](#getsurveyquestiontranslation) | **GET** /surveys/{surveyId}/questions/{questionId}/translations/{locale} | Get
|
|
12
|
-
|[**getSurveyQuestionTranslations**](#getsurveyquestiontranslations) | **GET** /surveys/{surveyId}/questions/{questionId}/translations |
|
|
13
|
-
|[**updateSurveyQuestionChoiceTranslation**](#updatesurveyquestionchoicetranslation) | **PUT** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Update
|
|
14
|
-
|[**updateSurveyQuestionTranslation**](#updatesurveyquestiontranslation) | **PUT** /surveys/{surveyId}/questions/{questionId}/translations/{locale} | Update
|
|
7
|
+
|[**deleteSurveyQuestionChoiceTranslation**](#deletesurveyquestionchoicetranslation) | **DELETE** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Delete a survey question choice\'s translation|
|
|
8
|
+
|[**deleteSurveyQuestionTranslation**](#deletesurveyquestiontranslation) | **DELETE** /surveys/{surveyId}/questions/{questionId}/translations/{locale} | Delete a survey question\'s translation|
|
|
9
|
+
|[**getSurveyQuestionChoiceTranslation**](#getsurveyquestionchoicetranslation) | **GET** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Get a survey question choice\'s translation|
|
|
10
|
+
|[**getSurveyQuestionChoiceTranslations**](#getsurveyquestionchoicetranslations) | **GET** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/translations | List a survey question choice\'s translations|
|
|
11
|
+
|[**getSurveyQuestionTranslation**](#getsurveyquestiontranslation) | **GET** /surveys/{surveyId}/questions/{questionId}/translations/{locale} | Get a survey question\'s translation|
|
|
12
|
+
|[**getSurveyQuestionTranslations**](#getsurveyquestiontranslations) | **GET** /surveys/{surveyId}/questions/{questionId}/translations | List a survey question\'s translations|
|
|
13
|
+
|[**updateSurveyQuestionChoiceTranslation**](#updatesurveyquestionchoicetranslation) | **PUT** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Update a survey question choice\'s translation|
|
|
14
|
+
|[**updateSurveyQuestionTranslation**](#updatesurveyquestiontranslation) | **PUT** /surveys/{surveyId}/questions/{questionId}/translations/{locale} | Update a survey question\'s translation|
|
|
15
15
|
|
|
16
16
|
# **deleteSurveyQuestionChoiceTranslation**
|
|
17
17
|
> SyncAccounts200Response deleteSurveyQuestionChoiceTranslation()
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
Removes the translated text for a specific locale on a survey question\'s answer choice; requires \"update\" permission on surveys.
|
|
20
20
|
|
|
21
21
|
### Example
|
|
22
22
|
|
|
@@ -76,7 +76,7 @@ const { status, data } = await apiInstance.deleteSurveyQuestionChoiceTranslation
|
|
|
76
76
|
# **deleteSurveyQuestionTranslation**
|
|
77
77
|
> SyncAccounts200Response deleteSurveyQuestionTranslation()
|
|
78
78
|
|
|
79
|
-
|
|
79
|
+
Removes the translated text for a specific locale on a survey question; requires \"update\" permission on surveys.
|
|
80
80
|
|
|
81
81
|
### Example
|
|
82
82
|
|
|
@@ -133,7 +133,7 @@ const { status, data } = await apiInstance.deleteSurveyQuestionTranslation(
|
|
|
133
133
|
# **getSurveyQuestionChoiceTranslation**
|
|
134
134
|
> GetSurveyQuestionChoiceTranslation200Response getSurveyQuestionChoiceTranslation()
|
|
135
135
|
|
|
136
|
-
|
|
136
|
+
Returns the translated text for a single survey question choice in the given locale, or null if no translation exists for that locale, requiring \"read\" permission on surveys.
|
|
137
137
|
|
|
138
138
|
### Example
|
|
139
139
|
|
|
@@ -193,7 +193,7 @@ const { status, data } = await apiInstance.getSurveyQuestionChoiceTranslation(
|
|
|
193
193
|
# **getSurveyQuestionChoiceTranslations**
|
|
194
194
|
> GetSurveyQuestionChoiceTranslations200Response getSurveyQuestionChoiceTranslations()
|
|
195
195
|
|
|
196
|
-
|
|
196
|
+
Returns a paginated list of locale translations for the given survey question choice, with optional search and ordering, requiring \"read\" permission on surveys.
|
|
197
197
|
|
|
198
198
|
### Example
|
|
199
199
|
|
|
@@ -262,7 +262,7 @@ const { status, data } = await apiInstance.getSurveyQuestionChoiceTranslations(
|
|
|
262
262
|
# **getSurveyQuestionTranslation**
|
|
263
263
|
> GetSurveyQuestionTranslation200Response getSurveyQuestionTranslation()
|
|
264
264
|
|
|
265
|
-
|
|
265
|
+
Returns the translated text for a single survey question in the given locale, or null if no translation exists for that locale, requiring \"read\" permission on surveys.
|
|
266
266
|
|
|
267
267
|
### Example
|
|
268
268
|
|
|
@@ -319,7 +319,7 @@ const { status, data } = await apiInstance.getSurveyQuestionTranslation(
|
|
|
319
319
|
# **getSurveyQuestionTranslations**
|
|
320
320
|
> GetSurveyQuestionTranslations200Response getSurveyQuestionTranslations()
|
|
321
321
|
|
|
322
|
-
|
|
322
|
+
Returns a paginated list of locale translations for a survey question, supporting search and ordering; requires read access to the surveys module.
|
|
323
323
|
|
|
324
324
|
### Example
|
|
325
325
|
|
|
@@ -385,7 +385,7 @@ const { status, data } = await apiInstance.getSurveyQuestionTranslations(
|
|
|
385
385
|
# **updateSurveyQuestionChoiceTranslation**
|
|
386
386
|
> SyncAccounts200Response updateSurveyQuestionChoiceTranslation(surveyQuestionChoiceTranslationUpdateInputs)
|
|
387
387
|
|
|
388
|
-
|
|
388
|
+
Creates or updates the translated text for a specific locale on a survey question\'s answer choice; requires \"update\" permission on surveys.
|
|
389
389
|
|
|
390
390
|
### Example
|
|
391
391
|
|
|
@@ -449,7 +449,7 @@ const { status, data } = await apiInstance.updateSurveyQuestionChoiceTranslation
|
|
|
449
449
|
# **updateSurveyQuestionTranslation**
|
|
450
450
|
> SyncAccounts200Response updateSurveyQuestionTranslation(surveyQuestionTranslationUpdateInputs)
|
|
451
451
|
|
|
452
|
-
|
|
452
|
+
Creates or updates the translated text for a specific locale on a survey question; requires \"update\" permission on surveys.
|
|
453
453
|
|
|
454
454
|
### Example
|
|
455
455
|
|
|
@@ -4,21 +4,21 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**addSurveySectionQuestion**](#addsurveysectionquestion) | **POST** /surveys/{surveyId}/sections/{sectionId}/questions/{questionId} | Add
|
|
8
|
-
|[**createSurveySection**](#createsurveysection) | **POST** /surveys/{surveyId}/sections | Create
|
|
9
|
-
|[**deleteSurveySection**](#deletesurveysection) | **DELETE** /surveys/{surveyId}/sections/{sectionId} | Delete
|
|
10
|
-
|[**getSurveySection**](#getsurveysection) | **GET** /surveys/{surveyId}/sections/{sectionId} | Get
|
|
11
|
-
|[**getSurveySectionQuestions**](#getsurveysectionquestions) | **GET** /surveys/{surveyId}/sections/{sectionId}/questions |
|
|
12
|
-
|[**getSurveySections**](#getsurveysections) | **GET** /surveys/{surveyId}/sections |
|
|
13
|
-
|[**removeSurveySectionQuestion**](#removesurveysectionquestion) | **DELETE** /surveys/{surveyId}/sections/{sectionId}/questions/{questionId} | Remove
|
|
14
|
-
|[**reorderSurveySectionQuestions**](#reordersurveysectionquestions) | **PUT** /surveys/{surveyId}/sections/{sectionId}/questions/reorder | Reorder
|
|
15
|
-
|[**updateSurveySection**](#updatesurveysection) | **PUT** /surveys/{surveyId}/sections/{sectionId} | Update
|
|
16
|
-
|[**updateSurveySectionQuestion**](#updatesurveysectionquestion) | **PUT** /surveys/{surveyId}/sections/{sectionId}/questions/{questionId} |
|
|
7
|
+
|[**addSurveySectionQuestion**](#addsurveysectionquestion) | **POST** /surveys/{surveyId}/sections/{sectionId}/questions/{questionId} | Add a question to a survey section|
|
|
8
|
+
|[**createSurveySection**](#createsurveysection) | **POST** /surveys/{surveyId}/sections | Create a survey section|
|
|
9
|
+
|[**deleteSurveySection**](#deletesurveysection) | **DELETE** /surveys/{surveyId}/sections/{sectionId} | Delete a survey section|
|
|
10
|
+
|[**getSurveySection**](#getsurveysection) | **GET** /surveys/{surveyId}/sections/{sectionId} | Get a survey section|
|
|
11
|
+
|[**getSurveySectionQuestions**](#getsurveysectionquestions) | **GET** /surveys/{surveyId}/sections/{sectionId}/questions | List a survey section\'s questions|
|
|
12
|
+
|[**getSurveySections**](#getsurveysections) | **GET** /surveys/{surveyId}/sections | List a survey\'s sections|
|
|
13
|
+
|[**removeSurveySectionQuestion**](#removesurveysectionquestion) | **DELETE** /surveys/{surveyId}/sections/{sectionId}/questions/{questionId} | Remove a question from a survey section|
|
|
14
|
+
|[**reorderSurveySectionQuestions**](#reordersurveysectionquestions) | **PUT** /surveys/{surveyId}/sections/{sectionId}/questions/reorder | Reorder a survey section\'s questions|
|
|
15
|
+
|[**updateSurveySection**](#updatesurveysection) | **PUT** /surveys/{surveyId}/sections/{sectionId} | Update a survey section|
|
|
16
|
+
|[**updateSurveySectionQuestion**](#updatesurveysectionquestion) | **PUT** /surveys/{surveyId}/sections/{sectionId}/questions/{questionId} | Reorder a question within a survey section|
|
|
17
17
|
|
|
18
18
|
# **addSurveySectionQuestion**
|
|
19
19
|
> CreateSurveySection200Response addSurveySectionQuestion()
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
Links an existing survey question to a section, appending it to the end of that section\'s question order; requires the update surveys permission.
|
|
22
22
|
|
|
23
23
|
### Example
|
|
24
24
|
|
|
@@ -75,7 +75,7 @@ const { status, data } = await apiInstance.addSurveySectionQuestion(
|
|
|
75
75
|
# **createSurveySection**
|
|
76
76
|
> CreateSurveySection200Response createSurveySection(surveySectionCreateInputs)
|
|
77
77
|
|
|
78
|
-
|
|
78
|
+
Creates a new section on the given survey, inserting it at the requested sortOrder position (or at the end if omitted) and shifting the other sections accordingly; requires the update surveys permission.
|
|
79
79
|
|
|
80
80
|
### Example
|
|
81
81
|
|
|
@@ -130,7 +130,7 @@ const { status, data } = await apiInstance.createSurveySection(
|
|
|
130
130
|
# **deleteSurveySection**
|
|
131
131
|
> CreateAccountInvitations200Response deleteSurveySection()
|
|
132
132
|
|
|
133
|
-
|
|
133
|
+
Permanently removes a section from the given survey and re-sorts the remaining sections to close the resulting gap; requires the update surveys permission.
|
|
134
134
|
|
|
135
135
|
### Example
|
|
136
136
|
|
|
@@ -184,7 +184,7 @@ const { status, data } = await apiInstance.deleteSurveySection(
|
|
|
184
184
|
# **getSurveySection**
|
|
185
185
|
> CreateSurveySection200Response getSurveySection()
|
|
186
186
|
|
|
187
|
-
|
|
187
|
+
Returns the details of a single section within a survey, identified by survey and section ID; requires read access to the surveys module.
|
|
188
188
|
|
|
189
189
|
### Example
|
|
190
190
|
|
|
@@ -238,7 +238,7 @@ const { status, data } = await apiInstance.getSurveySection(
|
|
|
238
238
|
# **getSurveySectionQuestions**
|
|
239
239
|
> GetSurveySectionQuestions200Response getSurveySectionQuestions()
|
|
240
240
|
|
|
241
|
-
|
|
241
|
+
Returns a paginated list of questions assigned to a specific section of a survey, with optional search and ordering, requiring read permission on surveys.
|
|
242
242
|
|
|
243
243
|
### Example
|
|
244
244
|
|
|
@@ -304,7 +304,7 @@ const { status, data } = await apiInstance.getSurveySectionQuestions(
|
|
|
304
304
|
# **getSurveySections**
|
|
305
305
|
> GetSurveySections200Response getSurveySections()
|
|
306
306
|
|
|
307
|
-
|
|
307
|
+
Returns a paginated list of the sections defined on a survey, ordered by their sort order, with optional search, requiring read permission on surveys.
|
|
308
308
|
|
|
309
309
|
### Example
|
|
310
310
|
|
|
@@ -367,7 +367,7 @@ const { status, data } = await apiInstance.getSurveySections(
|
|
|
367
367
|
# **removeSurveySectionQuestion**
|
|
368
368
|
> CreateSurveySection200Response removeSurveySectionQuestion()
|
|
369
369
|
|
|
370
|
-
|
|
370
|
+
Unlinks a question from a survey section without deleting the question itself, removing it from that section\'s ordered question list; requires the update surveys permission.
|
|
371
371
|
|
|
372
372
|
### Example
|
|
373
373
|
|
|
@@ -424,7 +424,7 @@ const { status, data } = await apiInstance.removeSurveySectionQuestion(
|
|
|
424
424
|
# **reorderSurveySectionQuestions**
|
|
425
425
|
> ReorderSurveySectionQuestions200Response reorderSurveySectionQuestions()
|
|
426
426
|
|
|
427
|
-
|
|
427
|
+
Sets the sort order of all questions within a survey section by applying the given full, complete ordered list of question IDs; requires the update surveys permission.
|
|
428
428
|
|
|
429
429
|
### Example
|
|
430
430
|
|
|
@@ -481,7 +481,7 @@ const { status, data } = await apiInstance.reorderSurveySectionQuestions(
|
|
|
481
481
|
# **updateSurveySection**
|
|
482
482
|
> CreateSurveySection200Response updateSurveySection()
|
|
483
483
|
|
|
484
|
-
|
|
484
|
+
Updates a section of a survey, such as its title, description, or sort order (reordering it relative to the survey\'s other sections); requires the update surveys permission.
|
|
485
485
|
|
|
486
486
|
### Example
|
|
487
487
|
|
|
@@ -539,7 +539,7 @@ const { status, data } = await apiInstance.updateSurveySection(
|
|
|
539
539
|
# **updateSurveySectionQuestion**
|
|
540
540
|
> CreateSurveySection200Response updateSurveySectionQuestion()
|
|
541
541
|
|
|
542
|
-
|
|
542
|
+
Updates the sort order of a question inside a survey section, shifting the other questions in that section to accommodate the new position; requires the update surveys permission.
|
|
543
543
|
|
|
544
544
|
### Example
|
|
545
545
|
|
|
@@ -4,15 +4,15 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**deleteSurveySectionTranslation**](#deletesurveysectiontranslation) | **DELETE** /surveys/{surveyId}/sections/{sectionId}/translations/{locale} | Delete
|
|
8
|
-
|[**getSurveySectionTranslation**](#getsurveysectiontranslation) | **GET** /surveys/{surveyId}/sections/{sectionId}/translations/{locale} | Get
|
|
9
|
-
|[**getSurveySectionTranslations**](#getsurveysectiontranslations) | **GET** /surveys/{surveyId}/sections/{sectionId}/translations |
|
|
10
|
-
|[**updateSurveySectionTranslation**](#updatesurveysectiontranslation) | **PUT** /surveys/{surveyId}/sections/{sectionId}/translations/{locale} | Update
|
|
7
|
+
|[**deleteSurveySectionTranslation**](#deletesurveysectiontranslation) | **DELETE** /surveys/{surveyId}/sections/{sectionId}/translations/{locale} | Delete a survey section translation|
|
|
8
|
+
|[**getSurveySectionTranslation**](#getsurveysectiontranslation) | **GET** /surveys/{surveyId}/sections/{sectionId}/translations/{locale} | Get a survey section\'s translation|
|
|
9
|
+
|[**getSurveySectionTranslations**](#getsurveysectiontranslations) | **GET** /surveys/{surveyId}/sections/{sectionId}/translations | List a survey section\'s translations|
|
|
10
|
+
|[**updateSurveySectionTranslation**](#updatesurveysectiontranslation) | **PUT** /surveys/{surveyId}/sections/{sectionId}/translations/{locale} | Update a survey section translation|
|
|
11
11
|
|
|
12
12
|
# **deleteSurveySectionTranslation**
|
|
13
13
|
> SyncAccounts200Response deleteSurveySectionTranslation()
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Removes the translation for a survey section in the given locale, reverting that section\'s display for that locale to the default language; requires the update surveys permission.
|
|
16
16
|
|
|
17
17
|
### Example
|
|
18
18
|
|
|
@@ -69,7 +69,7 @@ const { status, data } = await apiInstance.deleteSurveySectionTranslation(
|
|
|
69
69
|
# **getSurveySectionTranslation**
|
|
70
70
|
> GetSurveySectionTranslation200Response getSurveySectionTranslation()
|
|
71
71
|
|
|
72
|
-
|
|
72
|
+
Returns the translated text for a survey section in a single locale, or null if no translation exists for that locale; requires read access to the surveys module.
|
|
73
73
|
|
|
74
74
|
### Example
|
|
75
75
|
|
|
@@ -126,7 +126,7 @@ const { status, data } = await apiInstance.getSurveySectionTranslation(
|
|
|
126
126
|
# **getSurveySectionTranslations**
|
|
127
127
|
> GetSurveySectionTranslations200Response getSurveySectionTranslations()
|
|
128
128
|
|
|
129
|
-
|
|
129
|
+
Returns a paginated list of locale translations for a survey section, supporting search and ordering; requires read access to the surveys module.
|
|
130
130
|
|
|
131
131
|
### Example
|
|
132
132
|
|
|
@@ -192,7 +192,7 @@ const { status, data } = await apiInstance.getSurveySectionTranslations(
|
|
|
192
192
|
# **updateSurveySectionTranslation**
|
|
193
193
|
> SyncAccounts200Response updateSurveySectionTranslation(surveySectionTranslationUpdateInputs)
|
|
194
194
|
|
|
195
|
-
|
|
195
|
+
Creates or updates the translated content (such as the title) for a survey section in the given locale, upserting the translation record if it does not already exist; requires the update surveys permission.
|
|
196
196
|
|
|
197
197
|
### Example
|
|
198
198
|
|
|
@@ -4,13 +4,13 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**addSurveySession**](#addsurveysession) | **POST** /surveys/{surveyId}/sessions/{sessionId} |
|
|
8
|
-
|[**removeSurveySession**](#removesurveysession) | **DELETE** /surveys/{surveyId}/sessions/{sessionId} |
|
|
7
|
+
|[**addSurveySession**](#addsurveysession) | **POST** /surveys/{surveyId}/sessions/{sessionId} | Attach a session to a survey|
|
|
8
|
+
|[**removeSurveySession**](#removesurveysession) | **DELETE** /surveys/{surveyId}/sessions/{sessionId} | Detach a session from a survey|
|
|
9
9
|
|
|
10
10
|
# **addSurveySession**
|
|
11
11
|
> CreateSurvey200Response addSurveySession()
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
Associates an event session with a survey so the survey can be restricted to (or offered during) that session; the survey must already be linked to an event, and this requires the update surveys permission.
|
|
14
14
|
|
|
15
15
|
### Example
|
|
16
16
|
|
|
@@ -64,7 +64,7 @@ const { status, data } = await apiInstance.addSurveySession(
|
|
|
64
64
|
# **removeSurveySession**
|
|
65
65
|
> CreateSurvey200Response removeSurveySession()
|
|
66
66
|
|
|
67
|
-
|
|
67
|
+
Removes the association between an event session and a survey, so the survey is no longer restricted to (or offered during) that session; requires the update surveys permission.
|
|
68
68
|
|
|
69
69
|
### Example
|
|
70
70
|
|
|
@@ -4,18 +4,18 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**deleteSurveySubmission**](#deletesurveysubmission) | **DELETE** /surveys/{surveyId}/submissions/{submissionId} | Delete
|
|
8
|
-
|[**getSurveySubmission**](#getsurveysubmission) | **GET** /surveys/{surveyId}/submissions/{submissionId} | Get
|
|
9
|
-
|[**getSurveySubmissionQuestionSections**](#getsurveysubmissionquestionsections) | **GET** /surveys/{surveyId}/submissions/{submissionId}/sections |
|
|
10
|
-
|[**getSurveySubmissionResponseChanges**](#getsurveysubmissionresponsechanges) | **GET** /surveys/{surveyId}/submissions/{submissionId}/responses/{questionId}/changes |
|
|
11
|
-
|[**getSurveySubmissions**](#getsurveysubmissions) | **GET** /surveys/{surveyId}/submissions |
|
|
12
|
-
|[**updateSurveySubmission**](#updatesurveysubmission) | **PUT** /surveys/{surveyId}/submissions/{submissionId} | Update
|
|
13
|
-
|[**updateSurveySubmissionResponses**](#updatesurveysubmissionresponses) | **PUT** /surveys/{surveyId}/submissions/{submissionId}/responses |
|
|
7
|
+
|[**deleteSurveySubmission**](#deletesurveysubmission) | **DELETE** /surveys/{surveyId}/submissions/{submissionId} | Delete a survey submission|
|
|
8
|
+
|[**getSurveySubmission**](#getsurveysubmission) | **GET** /surveys/{surveyId}/submissions/{submissionId} | Get a survey submission|
|
|
9
|
+
|[**getSurveySubmissionQuestionSections**](#getsurveysubmissionquestionsections) | **GET** /surveys/{surveyId}/submissions/{submissionId}/sections | List a submission\'s sections, questions, and choices|
|
|
10
|
+
|[**getSurveySubmissionResponseChanges**](#getsurveysubmissionresponsechanges) | **GET** /surveys/{surveyId}/submissions/{submissionId}/responses/{questionId}/changes | List the edit history of a submission response|
|
|
11
|
+
|[**getSurveySubmissions**](#getsurveysubmissions) | **GET** /surveys/{surveyId}/submissions | List a survey\'s submissions|
|
|
12
|
+
|[**updateSurveySubmission**](#updatesurveysubmission) | **PUT** /surveys/{surveyId}/submissions/{submissionId} | Update a survey submission|
|
|
13
|
+
|[**updateSurveySubmissionResponses**](#updatesurveysubmissionresponses) | **PUT** /surveys/{surveyId}/submissions/{submissionId}/responses | Replace a submission\'s question responses|
|
|
14
14
|
|
|
15
15
|
# **deleteSurveySubmission**
|
|
16
16
|
> CreateAccountInvitations200Response deleteSurveySubmission()
|
|
17
17
|
|
|
18
|
-
|
|
18
|
+
Permanently deletes a respondent\'s submission (and its answers) for a survey; requires the delete surveys permission.
|
|
19
19
|
|
|
20
20
|
### Example
|
|
21
21
|
|
|
@@ -69,7 +69,7 @@ const { status, data } = await apiInstance.deleteSurveySubmission(
|
|
|
69
69
|
# **getSurveySubmission**
|
|
70
70
|
> GetSurveySubmission200Response getSurveySubmission()
|
|
71
71
|
|
|
72
|
-
|
|
72
|
+
Retrieves a single survey submission by ID for the given survey, including its responses, requiring read permission on surveys.
|
|
73
73
|
|
|
74
74
|
### Example
|
|
75
75
|
|
|
@@ -123,7 +123,7 @@ const { status, data } = await apiInstance.getSurveySubmission(
|
|
|
123
123
|
# **getSurveySubmissionQuestionSections**
|
|
124
124
|
> GetSurveySections200Response getSurveySubmissionQuestionSections()
|
|
125
125
|
|
|
126
|
-
|
|
126
|
+
Returns the survey\'s sections along with their questions and answer choices for a specific submission, used to render the full submission form, requiring read permission on surveys.
|
|
127
127
|
|
|
128
128
|
### Example
|
|
129
129
|
|
|
@@ -189,7 +189,7 @@ const { status, data } = await apiInstance.getSurveySubmissionQuestionSections(
|
|
|
189
189
|
# **getSurveySubmissionResponseChanges**
|
|
190
190
|
> GetSurveySubmissionResponseChanges200Response getSurveySubmissionResponseChanges()
|
|
191
191
|
|
|
192
|
-
|
|
192
|
+
Returns a paginated audit trail of changes made to a specific question\'s response within a survey submission, with optional search and ordering, requiring read permission on surveys.
|
|
193
193
|
|
|
194
194
|
### Example
|
|
195
195
|
|
|
@@ -258,7 +258,7 @@ const { status, data } = await apiInstance.getSurveySubmissionResponseChanges(
|
|
|
258
258
|
# **getSurveySubmissions**
|
|
259
259
|
> GetSurveySubmissions200Response getSurveySubmissions()
|
|
260
260
|
|
|
261
|
-
|
|
261
|
+
Returns a paginated list of submissions for a survey, optionally filtered by purchase status, with search and ordering support, requiring read permission on surveys.
|
|
262
262
|
|
|
263
263
|
### Example
|
|
264
264
|
|
|
@@ -324,7 +324,7 @@ const { status, data } = await apiInstance.getSurveySubmissions(
|
|
|
324
324
|
# **updateSurveySubmission**
|
|
325
325
|
> GetSurveySubmission200Response updateSurveySubmission(surveySubmissionUpdateInputs)
|
|
326
326
|
|
|
327
|
-
|
|
327
|
+
Updates a survey submission\'s status (e.g. flagging it as needing info), or its associated account or event pass; requires the update surveys permission.
|
|
328
328
|
|
|
329
329
|
### Example
|
|
330
330
|
|
|
@@ -382,7 +382,7 @@ const { status, data } = await apiInstance.updateSurveySubmission(
|
|
|
382
382
|
# **updateSurveySubmissionResponses**
|
|
383
383
|
> CreateAccountInvitations200Response updateSurveySubmissionResponses(requestBody)
|
|
384
384
|
|
|
385
|
-
|
|
385
|
+
Overwrites all of a survey submission\'s question responses with the provided question/value pairs, discarding any prior answers to that submission; requires the update surveys permission.
|
|
386
386
|
|
|
387
387
|
### Example
|
|
388
388
|
|