@connectedxm/admin-sdk 15.3.2 → 15.4.0

package/dist/esm/api.d.ts

@@ -2,7 +2,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 15.3.2
+ * The version of the OpenAPI document: 15.4.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -6773,6 +6773,17 @@ export interface EventSponsorshipLevelCreateInputs {
     'benefitAllowance'?: number;
     'benefitPriority'?: number;
 }
+export interface EventSponsorshipLevelSurvey {
+    'id': string;
+    'slug': string;
+    'name': string;
+    'status': SurveyStatus;
+    'description': string | null;
+    'image': BaseImage;
+    'requireAuth': boolean;
+    'submissionsPerAccount': number;
+    'required': boolean;
+}
 export interface EventSponsorshipLevelTranslation {
     'id': number;
     'locale': string;
@@ -8772,6 +8783,15 @@ export interface GetEventSpeakerTranslations200Response {
 export declare enum GetEventSpeakerTranslations200ResponseStatusEnum {
     Ok = "ok"
 }
+export interface GetEventSponsorshipLevelSurveys200Response {
+    'status': GetEventSponsorshipLevelSurveys200ResponseStatusEnum;
+    'message': string;
+    'data': Array<EventSponsorshipLevelSurvey>;
+    'count'?: number;
+}
+export declare enum GetEventSponsorshipLevelSurveys200ResponseStatusEnum {
+    Ok = "ok"
+}
 export interface GetEventSponsorshipLevelTranslation200Response {
     'status': GetEventSponsorshipLevelTranslation200ResponseStatusEnum;
     'message': string;
@@ -13315,7 +13335,6 @@ export interface SponsorshipAdvertisementProgress {
     'complete': boolean;
     'created': number;
     'allowance': number;
-    'unavailable': boolean;
 }
 export declare enum SponsorshipAdvertisementProgressTypeEnum {
     Advertisements = "advertisements"
@@ -13325,7 +13344,6 @@ export interface SponsorshipBenefitProgress {
     'complete': boolean;
     'created': number;
     'allowance': number;
-    'unavailable': boolean;
 }
 export declare enum SponsorshipBenefitProgressTypeEnum {
     Benefits = "benefits"
@@ -13359,7 +13377,16 @@ export interface SponsorshipProgress {
 /**
  * @type SponsorshipProgressCheck
  */
-export type SponsorshipProgressCheck = SponsorshipAdvertisementProgress | SponsorshipBenefitProgress | SponsorshipBrandingProgress | UnavailableSponsorshipAdvertisementProgress | UnavailableSponsorshipBenefitProgress;
+export type SponsorshipProgressCheck = SponsorshipAdvertisementProgress | SponsorshipBenefitProgress | SponsorshipBrandingProgress | SponsorshipSurveyProgress;
+export interface SponsorshipSurveyProgress {
+    'type': SponsorshipSurveyProgressTypeEnum;
+    'complete': boolean;
+    'submitted': number;
+    'required': number;
+}
+export declare enum SponsorshipSurveyProgressTypeEnum {
+    Surveys = "surveys"
+}
 export interface StandardReport {
     'id': string;
     'type': ReportType;
@@ -14426,24 +14453,6 @@ export interface TriggerUpdateInputs {
     'code'?: string | null;
     'enabled'?: boolean;
 }
-export interface UnavailableSponsorshipAdvertisementProgress {
-    'type': UnavailableSponsorshipAdvertisementProgressTypeEnum;
-    'complete': boolean;
-    'unavailable': boolean;
-    'allowance': number;
-}
-export declare enum UnavailableSponsorshipAdvertisementProgressTypeEnum {
-    Advertisements = "advertisements"
-}
-export interface UnavailableSponsorshipBenefitProgress {
-    'type': UnavailableSponsorshipBenefitProgressTypeEnum;
-    'complete': boolean;
-    'unavailable': boolean;
-    'allowance': number;
-}
-export declare enum UnavailableSponsorshipBenefitProgressTypeEnum {
-    Benefits = "benefits"
-}
 export interface UpdateAnnouncementTemplateTranslation200Response {
     'status': UpdateAnnouncementTemplateTranslation200ResponseStatusEnum;
     'message': string;
@@ -61883,6 +61892,16 @@ export declare class EventsSponsorsApi extends BaseAPI {
  * EventsSponsorshiplevelsApi - axios parameter creator
  */
 export declare const EventsSponsorshiplevelsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Links a survey to an event sponsorship level and returns the level; requires read and update permission on events and surveys.
+     * @summary Add a survey to a sponsorship level
+     * @param {string} eventId The event identifier
+     * @param {string} levelId The level identifier
+     * @param {string} surveyId The survey identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addEventSponsorshipLevelSurvey: (eventId: string, levelId: string, surveyId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Creates a new sponsorship level (e.g. Gold, Silver, Bronze) for the given event, which sponsors can then be assigned to; requires update permission on events.
      * @summary Create an event sponsorship level
@@ -61910,6 +61929,19 @@ export declare const EventsSponsorshiplevelsApiAxiosParamCreator: (configuration
      * @throws {RequiredError}
      */
     getEventSponsorshipLevel: (eventId: string, levelId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a paginated list of surveys linked to the given event sponsorship level, supporting search and ordering; requires read permission on events and surveys.
+     * @summary List surveys on a sponsorship level
+     * @param {string} eventId The event identifier
+     * @param {string} levelId The level identifier
+     * @param {number} [page] Page number
+     * @param {number} [pageSize] Number of items per page
+     * @param {string} [orderBy] Field to order by
+     * @param {string} [search] Search query
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEventSponsorshipLevelSurveys: (eventId: string, levelId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Returns a paginated list of sponsorship levels defined for the given event, supporting search and ordering; requires read permission on events.
      * @summary List an event\'s sponsorship levels
@@ -61922,6 +61954,16 @@ export declare const EventsSponsorshiplevelsApiAxiosParamCreator: (configuration
      * @throws {RequiredError}
      */
     getEventSponsorshipLevels: (eventId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Unlinks a survey from an event sponsorship level and returns the level; requires read and update permission on events and surveys.
+     * @summary Remove a survey from a sponsorship level
+     * @param {string} eventId The event identifier
+     * @param {string} levelId The level identifier
+     * @param {string} surveyId The survey identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeEventSponsorshipLevelSurvey: (eventId: string, levelId: string, surveyId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Sets the display order of an event\'s sponsorship levels by supplying the full ordered list of level IDs; requires update permission on events.
      * @summary Reorder an event\'s sponsorship levels
@@ -61946,6 +61988,16 @@ export declare const EventsSponsorshiplevelsApiAxiosParamCreator: (configuration
  * EventsSponsorshiplevelsApi - functional programming interface
  */
 export declare const EventsSponsorshiplevelsApiFp: (configuration?: Configuration) => {
+    /**
+     * Links a survey to an event sponsorship level and returns the level; requires read and update permission on events and surveys.
+     * @summary Add a survey to a sponsorship level
+     * @param {string} eventId The event identifier
+     * @param {string} levelId The level identifier
+     * @param {string} surveyId The survey identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addEventSponsorshipLevelSurvey(eventId: string, levelId: string, surveyId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateEventSponsorshipLevel200Response>>;
     /**
      * Creates a new sponsorship level (e.g. Gold, Silver, Bronze) for the given event, which sponsors can then be assigned to; requires update permission on events.
      * @summary Create an event sponsorship level
@@ -61973,6 +62025,19 @@ export declare const EventsSponsorshiplevelsApiFp: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getEventSponsorshipLevel(eventId: string, levelId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateEventSponsorshipLevel200Response>>;
+    /**
+     * Returns a paginated list of surveys linked to the given event sponsorship level, supporting search and ordering; requires read permission on events and surveys.
+     * @summary List surveys on a sponsorship level
+     * @param {string} eventId The event identifier
+     * @param {string} levelId The level identifier
+     * @param {number} [page] Page number
+     * @param {number} [pageSize] Number of items per page
+     * @param {string} [orderBy] Field to order by
+     * @param {string} [search] Search query
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEventSponsorshipLevelSurveys(eventId: string, levelId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEventSponsorshipLevelSurveys200Response>>;
     /**
      * Returns a paginated list of sponsorship levels defined for the given event, supporting search and ordering; requires read permission on events.
      * @summary List an event\'s sponsorship levels
@@ -61985,6 +62050,16 @@ export declare const EventsSponsorshiplevelsApiFp: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getEventSponsorshipLevels(eventId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEventSponsorshipLevels200Response>>;
+    /**
+     * Unlinks a survey from an event sponsorship level and returns the level; requires read and update permission on events and surveys.
+     * @summary Remove a survey from a sponsorship level
+     * @param {string} eventId The event identifier
+     * @param {string} levelId The level identifier
+     * @param {string} surveyId The survey identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeEventSponsorshipLevelSurvey(eventId: string, levelId: string, surveyId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateEventSponsorshipLevel200Response>>;
     /**
      * Sets the display order of an event\'s sponsorship levels by supplying the full ordered list of level IDs; requires update permission on events.
      * @summary Reorder an event\'s sponsorship levels
@@ -62009,6 +62084,14 @@ export declare const EventsSponsorshiplevelsApiFp: (configuration?: Configuratio
  * EventsSponsorshiplevelsApi - factory interface
  */
 export declare const EventsSponsorshiplevelsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Links a survey to an event sponsorship level and returns the level; requires read and update permission on events and surveys.
+     * @summary Add a survey to a sponsorship level
+     * @param {EventsSponsorshiplevelsApiAddEventSponsorshipLevelSurveyRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addEventSponsorshipLevelSurvey(requestParameters: EventsSponsorshiplevelsApiAddEventSponsorshipLevelSurveyRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateEventSponsorshipLevel200Response>;
     /**
      * Creates a new sponsorship level (e.g. Gold, Silver, Bronze) for the given event, which sponsors can then be assigned to; requires update permission on events.
      * @summary Create an event sponsorship level
@@ -62033,6 +62116,14 @@ export declare const EventsSponsorshiplevelsApiFactory: (configuration?: Configu
      * @throws {RequiredError}
      */
     getEventSponsorshipLevel(requestParameters: EventsSponsorshiplevelsApiGetEventSponsorshipLevelRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateEventSponsorshipLevel200Response>;
+    /**
+     * Returns a paginated list of surveys linked to the given event sponsorship level, supporting search and ordering; requires read permission on events and surveys.
+     * @summary List surveys on a sponsorship level
+     * @param {EventsSponsorshiplevelsApiGetEventSponsorshipLevelSurveysRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEventSponsorshipLevelSurveys(requestParameters: EventsSponsorshiplevelsApiGetEventSponsorshipLevelSurveysRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetEventSponsorshipLevelSurveys200Response>;
     /**
      * Returns a paginated list of sponsorship levels defined for the given event, supporting search and ordering; requires read permission on events.
      * @summary List an event\'s sponsorship levels
@@ -62041,6 +62132,14 @@ export declare const EventsSponsorshiplevelsApiFactory: (configuration?: Configu
      * @throws {RequiredError}
      */
     getEventSponsorshipLevels(requestParameters: EventsSponsorshiplevelsApiGetEventSponsorshipLevelsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetEventSponsorshipLevels200Response>;
+    /**
+     * Unlinks a survey from an event sponsorship level and returns the level; requires read and update permission on events and surveys.
+     * @summary Remove a survey from a sponsorship level
+     * @param {EventsSponsorshiplevelsApiRemoveEventSponsorshipLevelSurveyRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeEventSponsorshipLevelSurvey(requestParameters: EventsSponsorshiplevelsApiRemoveEventSponsorshipLevelSurveyRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateEventSponsorshipLevel200Response>;
     /**
      * Sets the display order of an event\'s sponsorship levels by supplying the full ordered list of level IDs; requires update permission on events.
      * @summary Reorder an event\'s sponsorship levels
@@ -62058,6 +62157,23 @@ export declare const EventsSponsorshiplevelsApiFactory: (configuration?: Configu
      */
     updateEventSponsorshipLevel(requestParameters: EventsSponsorshiplevelsApiUpdateEventSponsorshipLevelRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateEventSponsorshipLevel200Response>;
 };
+/**
+ * Request parameters for addEventSponsorshipLevelSurvey operation in EventsSponsorshiplevelsApi.
+ */
+export interface EventsSponsorshiplevelsApiAddEventSponsorshipLevelSurveyRequest {
+    /**
+     * The event identifier
+     */
+    readonly eventId: string;
+    /**
+     * The level identifier
+     */
+    readonly levelId: string;
+    /**
+     * The survey identifier
+     */
+    readonly surveyId: string;
+}
 /**
  * Request parameters for createEventSponsorshipLevel operation in EventsSponsorshiplevelsApi.
  */
@@ -62094,6 +62210,35 @@ export interface EventsSponsorshiplevelsApiGetEventSponsorshipLevelRequest {
      */
     readonly levelId: string;
 }
+/**
+ * Request parameters for getEventSponsorshipLevelSurveys operation in EventsSponsorshiplevelsApi.
+ */
+export interface EventsSponsorshiplevelsApiGetEventSponsorshipLevelSurveysRequest {
+    /**
+     * The event identifier
+     */
+    readonly eventId: string;
+    /**
+     * The level identifier
+     */
+    readonly levelId: string;
+    /**
+     * Page number
+     */
+    readonly page?: number;
+    /**
+     * Number of items per page
+     */
+    readonly pageSize?: number;
+    /**
+     * Field to order by
+     */
+    readonly orderBy?: string;
+    /**
+     * Search query
+     */
+    readonly search?: string;
+}
 /**
  * Request parameters for getEventSponsorshipLevels operation in EventsSponsorshiplevelsApi.
  */
@@ -62119,6 +62264,23 @@ export interface EventsSponsorshiplevelsApiGetEventSponsorshipLevelsRequest {
      */
     readonly search?: string;
 }
+/**
+ * Request parameters for removeEventSponsorshipLevelSurvey operation in EventsSponsorshiplevelsApi.
+ */
+export interface EventsSponsorshiplevelsApiRemoveEventSponsorshipLevelSurveyRequest {
+    /**
+     * The event identifier
+     */
+    readonly eventId: string;
+    /**
+     * The level identifier
+     */
+    readonly levelId: string;
+    /**
+     * The survey identifier
+     */
+    readonly surveyId: string;
+}
 /**
  * Request parameters for reorderEventSponsorshipLevels operation in EventsSponsorshiplevelsApi.
  */
@@ -62147,6 +62309,14 @@ export interface EventsSponsorshiplevelsApiUpdateEventSponsorshipLevelRequest {
  * EventsSponsorshiplevelsApi - object-oriented interface
  */
 export declare class EventsSponsorshiplevelsApi extends BaseAPI {
+    /**
+     * Links a survey to an event sponsorship level and returns the level; requires read and update permission on events and surveys.
+     * @summary Add a survey to a sponsorship level
+     * @param {EventsSponsorshiplevelsApiAddEventSponsorshipLevelSurveyRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addEventSponsorshipLevelSurvey(requestParameters: EventsSponsorshiplevelsApiAddEventSponsorshipLevelSurveyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateEventSponsorshipLevel200Response, any, {}, any>>;
     /**
      * Creates a new sponsorship level (e.g. Gold, Silver, Bronze) for the given event, which sponsors can then be assigned to; requires update permission on events.
      * @summary Create an event sponsorship level
@@ -62171,6 +62341,14 @@ export declare class EventsSponsorshiplevelsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getEventSponsorshipLevel(requestParameters: EventsSponsorshiplevelsApiGetEventSponsorshipLevelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateEventSponsorshipLevel200Response, any, {}, any>>;
+    /**
+     * Returns a paginated list of surveys linked to the given event sponsorship level, supporting search and ordering; requires read permission on events and surveys.
+     * @summary List surveys on a sponsorship level
+     * @param {EventsSponsorshiplevelsApiGetEventSponsorshipLevelSurveysRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEventSponsorshipLevelSurveys(requestParameters: EventsSponsorshiplevelsApiGetEventSponsorshipLevelSurveysRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventSponsorshipLevelSurveys200Response, any, {}, any>>;
     /**
      * Returns a paginated list of sponsorship levels defined for the given event, supporting search and ordering; requires read permission on events.
      * @summary List an event\'s sponsorship levels
@@ -62179,6 +62357,14 @@ export declare class EventsSponsorshiplevelsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getEventSponsorshipLevels(requestParameters: EventsSponsorshiplevelsApiGetEventSponsorshipLevelsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventSponsorshipLevels200Response, any, {}, any>>;
+    /**
+     * Unlinks a survey from an event sponsorship level and returns the level; requires read and update permission on events and surveys.
+     * @summary Remove a survey from a sponsorship level
+     * @param {EventsSponsorshiplevelsApiRemoveEventSponsorshipLevelSurveyRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeEventSponsorshipLevelSurvey(requestParameters: EventsSponsorshiplevelsApiRemoveEventSponsorshipLevelSurveyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateEventSponsorshipLevel200Response, any, {}, any>>;
     /**
      * Sets the display order of an event\'s sponsorship levels by supplying the full ordered list of level IDs; requires update permission on events.
      * @summary Reorder an event\'s sponsorship levels