@connectedxm/admin-sdk 7.5.0 → 7.8.0

package/docs/EventsQuestionsTranslationsApi.md

@@ -4,19 +4,19 @@ All URIs are relative to *https://admin-api.connected.dev*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**deleteEventQuestionChoiceTranslation**](#deleteeventquestionchoicetranslation) | **DELETE** /events/{eventId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Delete Event Question Choice Translation|
-|[**deleteEventQuestionTranslation**](#deleteeventquestiontranslation) | **DELETE** /events/{eventId}/questions/{questionId}/translations/{locale} | Delete Event Question Translation|
-|[**getEventQuestionChoiceTranslation**](#geteventquestionchoicetranslation) | **GET** /events/{eventId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Get Event Question Choice Translation|
-|[**getEventQuestionChoiceTranslations**](#geteventquestionchoicetranslations) | **GET** /events/{eventId}/questions/{questionId}/choices/{choiceId}/translations | Get Event Question Choice Translations|
-|[**getEventQuestionTranslation**](#geteventquestiontranslation) | **GET** /events/{eventId}/questions/{questionId}/translations/{locale} | Get Event Question Translation|
-|[**getEventQuestionTranslations**](#geteventquestiontranslations) | **GET** /events/{eventId}/questions/{questionId}/translations | Get Event Question Translations|
-|[**updateEventQuestionChoiceTranslation**](#updateeventquestionchoicetranslation) | **PUT** /events/{eventId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Update Event Question Choice Translation|
-|[**updateEventQuestionTranslation**](#updateeventquestiontranslation) | **PUT** /events/{eventId}/questions/{questionId}/translations/{locale} | Update Event Question Translation|
+|[**deleteEventQuestionChoiceTranslation**](#deleteeventquestionchoicetranslation) | **DELETE** /events/{eventId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Delete a question choice translation|
+|[**deleteEventQuestionTranslation**](#deleteeventquestiontranslation) | **DELETE** /events/{eventId}/questions/{questionId}/translations/{locale} | Delete an event question translation|
+|[**getEventQuestionChoiceTranslation**](#geteventquestionchoicetranslation) | **GET** /events/{eventId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Get a question choice\'s translation|
+|[**getEventQuestionChoiceTranslations**](#geteventquestionchoicetranslations) | **GET** /events/{eventId}/questions/{questionId}/choices/{choiceId}/translations | List a question choice\'s translations|
+|[**getEventQuestionTranslation**](#geteventquestiontranslation) | **GET** /events/{eventId}/questions/{questionId}/translations/{locale} | Get a registration question\'s translation|
+|[**getEventQuestionTranslations**](#geteventquestiontranslations) | **GET** /events/{eventId}/questions/{questionId}/translations | List a registration question\'s translations|
+|[**updateEventQuestionChoiceTranslation**](#updateeventquestionchoicetranslation) | **PUT** /events/{eventId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Update a question choice translation|
+|[**updateEventQuestionTranslation**](#updateeventquestiontranslation) | **PUT** /events/{eventId}/questions/{questionId}/translations/{locale} | Update an event question\'s translation|
 
 # **deleteEventQuestionChoiceTranslation**
 > SyncAccounts200Response deleteEventQuestionChoiceTranslation()
 
-Delete Event Question Choice Translation endpoint
+Removes the translation for a specific locale from an answer choice of an event registration question; requires update permission on events.
 
 ### Example
 
@@ -76,7 +76,7 @@ const { status, data } = await apiInstance.deleteEventQuestionChoiceTranslation(
 # **deleteEventQuestionTranslation**
 > SyncAccounts200Response deleteEventQuestionTranslation()
 
-Delete Event Question Translation endpoint
+Removes the translation for a specific locale from an event registration question; requires update permission on events.
 
 ### Example
 
@@ -133,7 +133,7 @@ const { status, data } = await apiInstance.deleteEventQuestionTranslation(
 # **getEventQuestionChoiceTranslation**
 > GetEventQuestionChoiceTranslation200Response getEventQuestionChoiceTranslation()
 
-Get Event Question Choice Translation endpoint
+Returns the translation for a specific locale of a registration question choice on an event, or null if no translation exists for that locale; requires read permission on events.
 
 ### Example
 
@@ -193,7 +193,7 @@ const { status, data } = await apiInstance.getEventQuestionChoiceTranslation(
 # **getEventQuestionChoiceTranslations**
 > GetEventQuestionChoiceTranslations200Response getEventQuestionChoiceTranslations()
 
-Get Event Question Choice Translations endpoint
+Returns a paginated list of locale translations for a specific registration question choice on an event, with optional search and ordering; requires read permission on events.
 
 ### Example
 
@@ -262,7 +262,7 @@ const { status, data } = await apiInstance.getEventQuestionChoiceTranslations(
 # **getEventQuestionTranslation**
 > GetEventQuestionTranslation200Response getEventQuestionTranslation()
 
-Get Event Question Translation endpoint
+Returns the translation for a specific locale of a registration question on an event, or null if no translation exists for that locale; requires read permission on events.
 
 ### Example
 
@@ -319,7 +319,7 @@ const { status, data } = await apiInstance.getEventQuestionTranslation(
 # **getEventQuestionTranslations**
 > GetEventQuestionTranslations200Response getEventQuestionTranslations()
 
-Get Event Question Translations endpoint
+Returns a paginated list of locale translations for a specific registration question on an event, with optional search and ordering; requires read permission on events.
 
 ### Example
 
@@ -385,7 +385,7 @@ const { status, data } = await apiInstance.getEventQuestionTranslations(
 # **updateEventQuestionChoiceTranslation**
 > SyncAccounts200Response updateEventQuestionChoiceTranslation(eventQuestionChoiceTranslationUpdateInputs)
 
-Update Event Question Choice Translation endpoint
+Creates or updates the translation for a specific locale on an answer choice of an event registration question; requires update permission on events.
 
 ### Example
 
@@ -449,7 +449,7 @@ const { status, data } = await apiInstance.updateEventQuestionChoiceTranslation(
 # **updateEventQuestionTranslation**
 > SyncAccounts200Response updateEventQuestionTranslation(eventQuestionTranslationUpdateInputs)
 
-Update Event Question Translation endpoint
+Updates the translated text for a registration question in the given locale, creating the translation if it does not yet exist; requires update permission on events.
 
 ### Example
 

package/docs/EventsRoomsApi.md

@@ -4,20 +4,20 @@ All URIs are relative to *https://admin-api.connected.dev*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**addRoomToRoomType**](#addroomtoroomtype) | **POST** /events/{eventId}/roomTypes/{roomTypeId}/rooms | Add Room To Room Type|
-|[**createRoom**](#createroom) | **POST** /events/{eventId}/rooms | Create Room|
-|[**deleteRoom**](#deleteroom) | **DELETE** /events/{eventId}/rooms/{roomId} | Delete Room|
-|[**getRoom**](#getroom) | **GET** /events/{eventId}/rooms/{roomId} | Get Room|
-|[**getRoomTypeRooms**](#getroomtyperooms) | **GET** /events/{eventId}/roomTypes/{roomTypeId}/rooms | Get Room Type Rooms|
-|[**getRooms**](#getrooms) | **GET** /events/{eventId}/rooms | Get Rooms|
-|[**importRooms**](#importrooms) | **POST** /events/{eventId}/rooms/import | Import Rooms|
-|[**removeRoomFromRoomType**](#removeroomfromroomtype) | **DELETE** /events/{eventId}/roomTypes/{roomTypeId}/rooms/{roomId} | Remove Room From Room Type|
-|[**updateRoom**](#updateroom) | **PUT** /events/{eventId}/rooms/{roomId} | Update Room|
+|[**addRoomToRoomType**](#addroomtoroomtype) | **POST** /events/{eventId}/roomTypes/{roomTypeId}/rooms | Add a room to a room type|
+|[**createRoom**](#createroom) | **POST** /events/{eventId}/rooms | Create an event room|
+|[**deleteRoom**](#deleteroom) | **DELETE** /events/{eventId}/rooms/{roomId} | Delete an event room|
+|[**getRoom**](#getroom) | **GET** /events/{eventId}/rooms/{roomId} | Get a single event room|
+|[**getRoomTypeRooms**](#getroomtyperooms) | **GET** /events/{eventId}/roomTypes/{roomTypeId}/rooms | List rooms belonging to a room type|
+|[**getRooms**](#getrooms) | **GET** /events/{eventId}/rooms | List an event\'s rooms|
+|[**importRooms**](#importrooms) | **POST** /events/{eventId}/rooms/import | Bulk import event rooms by name|
+|[**removeRoomFromRoomType**](#removeroomfromroomtype) | **DELETE** /events/{eventId}/roomTypes/{roomTypeId}/rooms/{roomId} | Remove a room from a room type|
+|[**updateRoom**](#updateroom) | **PUT** /events/{eventId}/rooms/{roomId} | Update an event room|
 
 # **addRoomToRoomType**
 > CreateEventRoomType200Response addRoomToRoomType()
 
-Add Room To Room Type endpoint
+Connects an existing event room to a room type, verifying the room belongs to the same event, and requires update permission on events.
 
 ### Example
 
@@ -74,7 +74,7 @@ const { status, data } = await apiInstance.addRoomToRoomType(
 # **createRoom**
 > CreateRoom200Response createRoom(roomCreateInputs)
 
-Create Room endpoint
+Creates a new room for an event, such as a physical or virtual space used for sessions, and requires update permission on events.
 
 ### Example
 
@@ -129,7 +129,7 @@ const { status, data } = await apiInstance.createRoom(
 # **deleteRoom**
 > CreateAccountInvitations200Response deleteRoom()
 
-Delete Room endpoint
+Permanently deletes a room from an event and requires update permission on events.
 
 ### Example
 
@@ -183,7 +183,7 @@ const { status, data } = await apiInstance.deleteRoom(
 # **getRoom**
 > CreateRoom200Response getRoom()
 
-Get Room endpoint
+Returns the details of a single room belonging to an event, verifying the room belongs to the given event and organization before returning it; requires read access to the event.
 
 ### Example
 
@@ -237,7 +237,7 @@ const { status, data } = await apiInstance.getRoom(
 # **getRoomTypeRooms**
 > GetRoomTypeRooms200Response getRoomTypeRooms()
 
-Get Room Type Rooms endpoint
+Returns a paginated list of rooms assigned to a specific room type on an event, ordered by room name by default and filterable by search against the room name; requires read access to the event.
 
 ### Example
 
@@ -303,7 +303,7 @@ const { status, data } = await apiInstance.getRoomTypeRooms(
 # **getRooms**
 > GetRoomTypeRooms200Response getRooms()
 
-Get Rooms endpoint
+Returns a paginated list of rooms belonging to an event, ordered by room name by default and filterable by search against the room name; requires read access to the event.
 
 ### Example
 
@@ -366,7 +366,7 @@ const { status, data } = await apiInstance.getRooms(
 # **importRooms**
 > ImportRooms200Response importRooms()
 
-Import Rooms endpoint
+Bulk-creates event rooms from a list of room names, skipping any names that already exist for the event, and optionally assigns the newly created rooms to a room type; requires update permission on events.
 
 ### Example
 
@@ -423,7 +423,7 @@ const { status, data } = await apiInstance.importRooms(
 # **removeRoomFromRoomType**
 > CreateEventRoomType200Response removeRoomFromRoomType()
 
-Remove Room From Room Type endpoint
+Disconnects a room from a room type without deleting the room itself, and requires update permission on events.
 
 ### Example
 
@@ -480,7 +480,7 @@ const { status, data } = await apiInstance.removeRoomFromRoomType(
 # **updateRoom**
 > CreateRoom200Response updateRoom(roomUpdateInputs)
 
-Update Room endpoint
+Updates the fields of an existing event room, such as its name or capacity, and requires update permission on events.
 
 ### Example
 

package/docs/EventsRoomtypesApi.md

@@ -4,23 +4,23 @@ All URIs are relative to *https://admin-api.connected.dev*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**addEventRoomTypeTier**](#addeventroomtypetier) | **POST** /events/{eventId}/roomTypes/{roomTypeId}/tiers/{tierId} | Add Event Room Type Tier|
-|[**createEventRoomType**](#createeventroomtype) | **POST** /events/{eventId}/roomTypes | Create Event Room Type|
-|[**deleteEventRoomType**](#deleteeventroomtype) | **DELETE** /events/{eventId}/roomTypes/{roomTypeId} | Delete Event Room Type|
-|[**getEventRoomType**](#geteventroomtype) | **GET** /events/{eventId}/roomTypes/{roomTypeId} | Get Event Room Type|
-|[**getEventRoomTypePasses**](#geteventroomtypepasses) | **GET** /events/{eventId}/roomTypes/{roomTypeId}/passes | Get Event Room Type Passes|
-|[**getEventRoomTypeReservations**](#geteventroomtypereservations) | **GET** /events/{eventId}/roomTypes/{roomTypeId}/reservations | Get Event Room Type Reservations|
-|[**getEventRoomTypeTiers**](#geteventroomtypetiers) | **GET** /events/{eventId}/roomTypes/{roomTypeId}/tiers | Get Event Room Type Tiers|
-|[**getEventRoomTypes**](#geteventroomtypes) | **GET** /events/{eventId}/roomTypes | Get Event Room Types|
-|[**removeEventRoomTypeTier**](#removeeventroomtypetier) | **DELETE** /events/{eventId}/roomTypes/{roomTypeId}/tiers/{tierId} | Remove Event Room Type Tier|
-|[**updateEventRoomType**](#updateeventroomtype) | **PUT** /events/{eventId}/roomTypes/{roomTypeId} | Update Event Room Type|
-|[**updateEventRoomTypeAddOnDetails**](#updateeventroomtypeaddondetails) | **PUT** /events/{eventId}/roomTypes/{roomTypeId}/addOns/{addOnId} | Update Event Room Type Add On Details|
-|[**updateEventRoomTypePassTypeDetails**](#updateeventroomtypepasstypedetails) | **PUT** /events/{eventId}/roomTypes/{roomTypeId}/passTypes/{passTypeId} | Update Event Room Type Pass Type Details|
+|[**addEventRoomTypeTier**](#addeventroomtypetier) | **POST** /events/{eventId}/roomTypes/{roomTypeId}/tiers/{tierId} | Add an account tier to a room type|
+|[**createEventRoomType**](#createeventroomtype) | **POST** /events/{eventId}/roomTypes | Create an event room type|
+|[**deleteEventRoomType**](#deleteeventroomtype) | **DELETE** /events/{eventId}/roomTypes/{roomTypeId} | Delete an event room type|
+|[**getEventRoomType**](#geteventroomtype) | **GET** /events/{eventId}/roomTypes/{roomTypeId} | Get an event room type|
+|[**getEventRoomTypePasses**](#geteventroomtypepasses) | **GET** /events/{eventId}/roomTypes/{roomTypeId}/passes | List purchases for an event room type|
+|[**getEventRoomTypeReservations**](#geteventroomtypereservations) | **GET** /events/{eventId}/roomTypes/{roomTypeId}/reservations | List reservations for an event room type|
+|[**getEventRoomTypeTiers**](#geteventroomtypetiers) | **GET** /events/{eventId}/roomTypes/{roomTypeId}/tiers | List account tiers allowed or disallowed for a room type|
+|[**getEventRoomTypes**](#geteventroomtypes) | **GET** /events/{eventId}/roomTypes | List an event\'s room types|
+|[**removeEventRoomTypeTier**](#removeeventroomtypetier) | **DELETE** /events/{eventId}/roomTypes/{roomTypeId}/tiers/{tierId} | Remove an account tier from a room type|
+|[**updateEventRoomType**](#updateeventroomtype) | **PUT** /events/{eventId}/roomTypes/{roomTypeId} | Update an event room type|
+|[**updateEventRoomTypeAddOnDetails**](#updateeventroomtypeaddondetails) | **PUT** /events/{eventId}/roomTypes/{roomTypeId}/addOns/{addOnId} | Update a room type\'s add-on details|
+|[**updateEventRoomTypePassTypeDetails**](#updateeventroomtypepasstypedetails) | **PUT** /events/{eventId}/roomTypes/{roomTypeId}/passTypes/{passTypeId} | Update a room type\'s pass type details|
 
 # **addEventRoomTypeTier**
 > CreateEventRoomType200Response addEventRoomTypeTier()
 
-Add Event Room Type Tier endpoint
+Adds an account tier to a room type\'s allowed or disallowed tier list depending on the `allowed` flag, controlling which member tiers may book the room type, and requires the update permission on events plus read permission on tiers.
 
 ### Example
 
@@ -80,7 +80,7 @@ const { status, data } = await apiInstance.addEventRoomTypeTier(
 # **createEventRoomType**
 > CreateEventRoomType200Response createEventRoomType(eventRoomTypeCreateInputs)
 
-Create Event Room Type endpoint
+Creates a new room type (a bookable room/reservation category) for the given event, requiring the update permission on events.
 
 ### Example
 
@@ -135,7 +135,7 @@ const { status, data } = await apiInstance.createEventRoomType(
 # **deleteEventRoomType**
 > CreateAccountInvitations200Response deleteEventRoomType()
 
-Delete Event Room Type endpoint
+Permanently deletes a room type from the given event, requiring the update permission on events.
 
 ### Example
 
@@ -189,7 +189,7 @@ const { status, data } = await apiInstance.deleteEventRoomType(
 # **getEventRoomType**
 > CreateEventRoomType200Response getEventRoomType()
 
-Get Event Room Type endpoint
+Retrieves a single room type for the given event by ID, including its configured details; requires read permission on events.
 
 ### Example
 
@@ -243,7 +243,7 @@ const { status, data } = await apiInstance.getEventRoomType(
 # **getEventRoomTypePasses**
 > GetEventAddOnPasses200Response getEventRoomTypePasses()
 
-Get Event Room Type Passes endpoint
+Returns a paginated list of pass purchases tied to reservations for the specified event room type, supporting search by attendee name, email, purchase ID, or response value; requires read permission on events and attendees.
 
 ### Example
 
@@ -309,7 +309,7 @@ const { status, data } = await apiInstance.getEventRoomTypePasses(
 # **getEventRoomTypeReservations**
 > GetEventAttendeeReservations200Response getEventRoomTypeReservations()
 
-Get Event Room Type Reservations endpoint
+Returns a paginated list of room reservations made for the specified event room type, searchable by pass name or attendee name/email; requires read permission on events and attendees.
 
 ### Example
 
@@ -375,7 +375,7 @@ const { status, data } = await apiInstance.getEventRoomTypeReservations(
 # **getEventRoomTypeTiers**
 > GetAccountTiers200Response getEventRoomTypeTiers()
 
-Get Event Room Type Tiers endpoint
+Returns a paginated list of account tiers that are either allowed or disallowed to book the specified event room type, selected via the required allowed flag and searchable by name or description; requires read permission on events and tiers.
 
 ### Example
 
@@ -444,7 +444,7 @@ const { status, data } = await apiInstance.getEventRoomTypeTiers(
 # **getEventRoomTypes**
 > GetEventRoomTypes200Response getEventRoomTypes()
 
-Get Event Room Types endpoint
+Returns a paginated list of room types configured for the given event, searchable by name or description; requires read permission on events.
 
 ### Example
 
@@ -507,7 +507,7 @@ const { status, data } = await apiInstance.getEventRoomTypes(
 # **removeEventRoomTypeTier**
 > CreateEventRoomType200Response removeEventRoomTypeTier()
 
-Remove Event Room Type Tier endpoint
+Removes an account tier from a room type\'s allowed or disallowed tier list depending on the `allowed` flag, requiring the update permission on events plus read permission on tiers.
 
 ### Example
 
@@ -567,7 +567,7 @@ const { status, data } = await apiInstance.removeEventRoomTypeTier(
 # **updateEventRoomType**
 > CreateEventRoomType200Response updateEventRoomType()
 
-Update Event Room Type endpoint
+Updates the details of an existing room type for the given event, requiring the update permission on events.
 
 ### Example
 
@@ -625,7 +625,7 @@ const { status, data } = await apiInstance.updateEventRoomType(
 # **updateEventRoomTypeAddOnDetails**
 > CreateEventRoomType200Response updateEventRoomTypeAddOnDetails(eventRoomTypeAddOnDetailsUpdateInputs)
 
-Update Event Room Type Add On Details endpoint
+Creates or updates the pricing/availability details linking a specific add-on to a room type, requiring the update permission on events.
 
 ### Example
 
@@ -686,7 +686,7 @@ const { status, data } = await apiInstance.updateEventRoomTypeAddOnDetails(
 # **updateEventRoomTypePassTypeDetails**
 > CreateEventRoomType200Response updateEventRoomTypePassTypeDetails(eventRoomTypePassTypeDetailsUpdateInputs)
 
-Update Event Room Type Pass Type Details endpoint
+Creates or updates the pricing/availability details linking a specific pass type to a room type, requiring the update permission on events.
 
 ### Example
 

package/docs/EventsRoomtypesTranslationsApi.md

@@ -4,15 +4,15 @@ All URIs are relative to *https://admin-api.connected.dev*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**deleteEventRoomTypeTranslation**](#deleteeventroomtypetranslation) | **DELETE** /events/{eventId}/roomTypes/{roomTypeId}/translations/{locale} | Delete Event Room Type Translation|
-|[**getEventRoomTypeTranslation**](#geteventroomtypetranslation) | **GET** /events/{eventId}/roomTypes/{roomTypeId}/translations/{locale} | Get Event Room Type Translation|
-|[**getEventRoomTypeTranslations**](#geteventroomtypetranslations) | **GET** /events/{eventId}/roomTypes/{roomTypeId}/translations | Get Event Room Type Translations|
-|[**updateEventRoomTypeTranslation**](#updateeventroomtypetranslation) | **PUT** /events/{eventId}/roomTypes/{roomTypeId}/translations/{locale} | Update Event Room Type Translation|
+|[**deleteEventRoomTypeTranslation**](#deleteeventroomtypetranslation) | **DELETE** /events/{eventId}/roomTypes/{roomTypeId}/translations/{locale} | Delete a room type translation|
+|[**getEventRoomTypeTranslation**](#geteventroomtypetranslation) | **GET** /events/{eventId}/roomTypes/{roomTypeId}/translations/{locale} | Get a room type\'s translation for a locale|
+|[**getEventRoomTypeTranslations**](#geteventroomtypetranslations) | **GET** /events/{eventId}/roomTypes/{roomTypeId}/translations | List an event room type\'s translations|
+|[**updateEventRoomTypeTranslation**](#updateeventroomtypetranslation) | **PUT** /events/{eventId}/roomTypes/{roomTypeId}/translations/{locale} | Update a room type translation|
 
 # **deleteEventRoomTypeTranslation**
 > SyncAccounts200Response deleteEventRoomTypeTranslation()
 
-Delete Event Room Type Translation endpoint
+Removes the translation for a specific locale from an event room type, requiring the update permission on events.
 
 ### Example
 
@@ -69,7 +69,7 @@ const { status, data } = await apiInstance.deleteEventRoomTypeTranslation(
 # **getEventRoomTypeTranslation**
 > GetEventRoomTypeTranslation200Response getEventRoomTypeTranslation()
 
-Get Event Room Type Translation endpoint
+Returns the translated content for an event room type in a specific non-English locale, or null if no translation exists for that locale; requires read access to the event.
 
 ### Example
 
@@ -126,7 +126,7 @@ const { status, data } = await apiInstance.getEventRoomTypeTranslation(
 # **getEventRoomTypeTranslations**
 > GetEventRoomTypeTranslations200Response getEventRoomTypeTranslations()
 
-Get Event Room Type Translations endpoint
+Returns a paginated list of locale translations for the specified event room type, supporting search and ordering; requires read permission on events.
 
 ### Example
 
@@ -192,7 +192,7 @@ const { status, data } = await apiInstance.getEventRoomTypeTranslations(
 # **updateEventRoomTypeTranslation**
 > SyncAccounts200Response updateEventRoomTypeTranslation(eventRoomTypeTranslationUpdateInputs)
 
-Update Event Room Type Translation endpoint
+Creates or updates the localized name and description for an event room type in the given locale, requiring the update permission on events.
 
 ### Example
 

package/docs/EventsSectionsApi.md

@@ -4,30 +4,30 @@ All URIs are relative to *https://admin-api.connected.dev*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**addEventSectionAddOn**](#addeventsectionaddon) | **POST** /events/{eventId}/sections/{sectionId}/addOns/{addOnId} | Add Event Section Add On|
-|[**addEventSectionPassType**](#addeventsectionpasstype) | **POST** /events/{eventId}/sections/{sectionId}/passTypes/{passTypeId} | Add Event Section Pass Type|
-|[**addEventSectionQuestion**](#addeventsectionquestion) | **POST** /events/{eventId}/sections/{sectionId}/questions/{questionId} | Add Event Section Question|
-|[**addEventSectionTier**](#addeventsectiontier) | **POST** /events/{eventId}/sections/{sectionId}/tiers/{tierId} | Add Event Section Tier|
-|[**createEventSection**](#createeventsection) | **POST** /events/{eventId}/sections | Create Event Section|
-|[**deleteEventSection**](#deleteeventsection) | **DELETE** /events/{eventId}/sections/{sectionId} | Delete Event Section|
-|[**getEventSection**](#geteventsection) | **GET** /events/{eventId}/sections/{sectionId} | Get Event Section|
-|[**getEventSectionAddOns**](#geteventsectionaddons) | **GET** /events/{eventId}/sections/{sectionId}/addOns | Get Event Section Add Ons|
-|[**getEventSectionPassTypes**](#geteventsectionpasstypes) | **GET** /events/{eventId}/sections/{sectionId}/passTypes | Get Event Section Pass Types|
-|[**getEventSectionQuestions**](#geteventsectionquestions) | **GET** /events/{eventId}/sections/{sectionId}/questions | Get Event Section Questions|
-|[**getEventSectionTiers**](#geteventsectiontiers) | **GET** /events/{eventId}/sections/{sectionId}/tiers | Get Event Section Tiers|
-|[**getEventSections**](#geteventsections) | **GET** /events/{eventId}/sections | Get Event Sections|
-|[**removeEventSectionAddOn**](#removeeventsectionaddon) | **DELETE** /events/{eventId}/sections/{sectionId}/addOns/{addOnId} | Remove Event Section Add On|
-|[**removeEventSectionPassType**](#removeeventsectionpasstype) | **DELETE** /events/{eventId}/sections/{sectionId}/passTypes/{passTypeId} | Remove Event Section Pass Type|
-|[**removeEventSectionQuestion**](#removeeventsectionquestion) | **DELETE** /events/{eventId}/sections/{sectionId}/questions/{questionId} | Remove Event Section Question|
-|[**removeEventSectionTier**](#removeeventsectiontier) | **DELETE** /events/{eventId}/sections/{sectionId}/tiers/{tierId} | Remove Event Section Tier|
-|[**reorderEventSectionQuestions**](#reordereventsectionquestions) | **PUT** /events/{eventId}/sections/{sectionId}/questions/reorder | Reorder Event Section Questions|
-|[**updateEventSection**](#updateeventsection) | **PUT** /events/{eventId}/sections/{sectionId} | Update Event Section|
-|[**updateEventSectionQuestion**](#updateeventsectionquestion) | **PUT** /events/{eventId}/sections/{sectionId}/questions/{questionId} | Update Event Section Question|
+|[**addEventSectionAddOn**](#addeventsectionaddon) | **POST** /events/{eventId}/sections/{sectionId}/addOns/{addOnId} | Add an add-on to an event section|
+|[**addEventSectionPassType**](#addeventsectionpasstype) | **POST** /events/{eventId}/sections/{sectionId}/passTypes/{passTypeId} | Add a pass type to an event section|
+|[**addEventSectionQuestion**](#addeventsectionquestion) | **POST** /events/{eventId}/sections/{sectionId}/questions/{questionId} | Add a question to an event section|
+|[**addEventSectionTier**](#addeventsectiontier) | **POST** /events/{eventId}/sections/{sectionId}/tiers/{tierId} | Add an account tier to an event section|
+|[**createEventSection**](#createeventsection) | **POST** /events/{eventId}/sections | Create an event registration section|
+|[**deleteEventSection**](#deleteeventsection) | **DELETE** /events/{eventId}/sections/{sectionId} | Delete an event registration section|
+|[**getEventSection**](#geteventsection) | **GET** /events/{eventId}/sections/{sectionId} | Get a registration section|
+|[**getEventSectionAddOns**](#geteventsectionaddons) | **GET** /events/{eventId}/sections/{sectionId}/addOns | List add-ons linked to a registration section|
+|[**getEventSectionPassTypes**](#geteventsectionpasstypes) | **GET** /events/{eventId}/sections/{sectionId}/passTypes | List pass types linked to a section|
+|[**getEventSectionQuestions**](#geteventsectionquestions) | **GET** /events/{eventId}/sections/{sectionId}/questions | List questions in an event section|
+|[**getEventSectionTiers**](#geteventsectiontiers) | **GET** /events/{eventId}/sections/{sectionId}/tiers | List account tiers linked to a section|
+|[**getEventSections**](#geteventsections) | **GET** /events/{eventId}/sections | List an event\'s registration sections|
+|[**removeEventSectionAddOn**](#removeeventsectionaddon) | **DELETE** /events/{eventId}/sections/{sectionId}/addOns/{addOnId} | Remove an add-on from an event section|
+|[**removeEventSectionPassType**](#removeeventsectionpasstype) | **DELETE** /events/{eventId}/sections/{sectionId}/passTypes/{passTypeId} | Remove a pass type from an event section|
+|[**removeEventSectionQuestion**](#removeeventsectionquestion) | **DELETE** /events/{eventId}/sections/{sectionId}/questions/{questionId} | Remove a question from an event section|
+|[**removeEventSectionTier**](#removeeventsectiontier) | **DELETE** /events/{eventId}/sections/{sectionId}/tiers/{tierId} | Remove an account tier restriction from a section|
+|[**reorderEventSectionQuestions**](#reordereventsectionquestions) | **PUT** /events/{eventId}/sections/{sectionId}/questions/reorder | Reorder a section\'s questions|
+|[**updateEventSection**](#updateeventsection) | **PUT** /events/{eventId}/sections/{sectionId} | Update an event registration section|
+|[**updateEventSectionQuestion**](#updateeventsectionquestion) | **PUT** /events/{eventId}/sections/{sectionId}/questions/{questionId} | Update a section question\'s sort order|
 
 # **addEventSectionAddOn**
 > CreateEventSection200Response addEventSectionAddOn()
 
-Add Event Section Add On endpoint
+Connects an existing event add-on to a registration section, making it available for purchase within that section; requires update permission on events.
 
 ### Example
 
@@ -84,7 +84,7 @@ const { status, data } = await apiInstance.addEventSectionAddOn(
 # **addEventSectionPassType**
 > CreateEventSection200Response addEventSectionPassType()
 
-Add Event Section Pass Type endpoint
+Connects an existing event pass type (ticket) to a registration section, making that pass type available within the section; requires update permission on events.
 
 ### Example
 
@@ -141,7 +141,7 @@ const { status, data } = await apiInstance.addEventSectionPassType(
 # **addEventSectionQuestion**
 > CreateEventSection200Response addEventSectionQuestion()
 
-Add Event Section Question endpoint
+Attaches an existing registration question to a section, appending it to the end of the section\'s question order; requires update permission on events.
 
 ### Example
 
@@ -198,7 +198,7 @@ const { status, data } = await apiInstance.addEventSectionQuestion(
 # **addEventSectionTier**
 > CreateEventSection200Response addEventSectionTier()
 
-Add Event Section Tier endpoint
+Adds an account tier to a registration section\'s allowed or disallowed tier list depending on the allowed flag, controlling which account tiers can access the section; requires update permission on events and read permission on tiers.
 
 ### Example
 
@@ -258,7 +258,7 @@ const { status, data } = await apiInstance.addEventSectionTier(
 # **createEventSection**
 > CreateEventSection200Response createEventSection(eventSectionCreateInputs)
 
-Create Event Section endpoint
+Creates a new registration section for an event, inserting it at the requested sort position among the event\'s existing sections; requires update permission on events.
 
 ### Example
 
@@ -313,7 +313,7 @@ const { status, data } = await apiInstance.createEventSection(
 # **deleteEventSection**
 > CreateAccountInvitations200Response deleteEventSection()
 
-Delete Event Section endpoint
+Permanently removes a registration section from an event and re-sequences the sort order of the event\'s remaining sections; requires update permission on events.
 
 ### Example
 
@@ -367,7 +367,7 @@ const { status, data } = await apiInstance.deleteEventSection(
 # **getEventSection**
 > CreateEventSection200Response getEventSection()
 
-Get Event Section endpoint
+Retrieves a single registration section for the given event by ID, including its configured questions, pass types, and add-ons; requires read permission on events.
 
 ### Example
 
@@ -421,7 +421,7 @@ const { status, data } = await apiInstance.getEventSection(
 # **getEventSectionAddOns**
 > GetEventAddOns200Response getEventSectionAddOns()
 
-Get Event Section Add Ons endpoint
+Returns a paginated list of event add-ons associated with the specified registration section, searchable by name; requires read permission on events.
 
 ### Example
 
@@ -487,7 +487,7 @@ const { status, data } = await apiInstance.getEventSectionAddOns(
 # **getEventSectionPassTypes**
 > GetEventAddOnPassTypes200Response getEventSectionPassTypes()
 
-Get Event Section Pass Types endpoint
+Returns a paginated list of the pass types associated with a registration section on an event, supporting search and ordering; requires read access to the events module.
 
 ### Example
 
@@ -553,7 +553,7 @@ const { status, data } = await apiInstance.getEventSectionPassTypes(
 # **getEventSectionQuestions**
 > GetEventSectionQuestions200Response getEventSectionQuestions()
 
-Get Event Section Questions endpoint
+Returns a paginated list of the registration questions belonging to a section of an event, supporting search and ordering; requires read access to the events module.
 
 ### Example
 
@@ -619,7 +619,7 @@ const { status, data } = await apiInstance.getEventSectionQuestions(
 # **getEventSectionTiers**
 > GetAccountTiers200Response getEventSectionTiers()
 
-Get Event Section Tiers endpoint
+Returns a paginated list of the account tiers associated with a registration section on an event, filterable by the `allowed` flag and supporting search and ordering; requires read access to the events and tiers modules.
 
 ### Example
 
@@ -688,7 +688,7 @@ const { status, data } = await apiInstance.getEventSectionTiers(
 # **getEventSections**
 > GetEventPassQuestionSections200Response getEventSections()
 
-Get Event Sections endpoint
+Returns a paginated list of the registration sections defined for an event, supporting search and ordering; requires read access to the events module.
 
 ### Example
 
@@ -751,7 +751,7 @@ const { status, data } = await apiInstance.getEventSections(
 # **removeEventSectionAddOn**
 > CreateEventSection200Response removeEventSectionAddOn()
 
-Remove Event Section Add On endpoint
+Disconnects an event add-on from a registration section so it is no longer available for purchase within that section; requires update permission on events.
 
 ### Example
 
@@ -808,7 +808,7 @@ const { status, data } = await apiInstance.removeEventSectionAddOn(
 # **removeEventSectionPassType**
 > CreateEventSection200Response removeEventSectionPassType()
 
-Remove Event Section Pass Type endpoint
+Disconnects an event pass type (ticket) from a registration section so it is no longer offered within that section; requires update permission on events.
 
 ### Example
 
@@ -865,7 +865,7 @@ const { status, data } = await apiInstance.removeEventSectionPassType(
 # **removeEventSectionQuestion**
 > CreateEventSection200Response removeEventSectionQuestion()
 
-Remove Event Section Question endpoint
+Detaches a registration question from a section and re-sequences the sort order of the section\'s remaining questions; requires update permission on events.
 
 ### Example
 
@@ -922,7 +922,7 @@ const { status, data } = await apiInstance.removeEventSectionQuestion(
 # **removeEventSectionTier**
 > CreateEventSection200Response removeEventSectionTier()
 
-Remove Event Section Tier endpoint
+Disconnects an account tier from a registration section\'s allowed or disallowed tier list, based on the `allowed` flag, requiring read/update permission on events and read permission on tiers.
 
 ### Example
 
@@ -982,7 +982,7 @@ const { status, data } = await apiInstance.removeEventSectionTier(
 # **reorderEventSectionQuestions**
 > ReorderEventSectionQuestions200Response reorderEventSectionQuestions()
 
-Reorder Event Section Questions endpoint
+Sets the sort order of a registration section\'s questions to match the order of the given questionIds array, requiring read/update permission on events.
 
 ### Example
 
@@ -1039,7 +1039,7 @@ const { status, data } = await apiInstance.reorderEventSectionQuestions(
 # **updateEventSection**
 > CreateEventSection200Response updateEventSection()
 
-Update Event Section endpoint
+Updates the fields of an event\'s registration section, such as name, description, or sort order, requiring read/update permission on events.
 
 ### Example
 
@@ -1097,7 +1097,7 @@ const { status, data } = await apiInstance.updateEventSection(
 # **updateEventSectionQuestion**
 > CreateEventSection200Response updateEventSectionQuestion()
 
-Update Event Section Question endpoint
+Sets the sort order of a single question within an event registration section, requiring read/update permission on events.
 
 ### Example