@connectedxm/admin-sdk 15.1.0 → 15.2.0

package/dist/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.1.0
+ * The version of the OpenAPI document: 15.2.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -6796,6 +6796,23 @@ export interface EventSponsorshipLevelUpdateInputs {
     'benefitAllowance'?: number;
     'benefitPriority'?: number;
 }
+export interface EventSponsorshipProgress {
+    'id': string;
+    'name': string;
+    'account': EventSponsorshipProgressAccount | null;
+    'level': EventSponsorshipProgressLevel;
+    'progress': SponsorshipProgress;
+}
+export interface EventSponsorshipProgressAccount {
+    'id': string;
+    'fullName': string | null;
+    'firstName': string | null;
+    'lastName': string | null;
+}
+export interface EventSponsorshipProgressLevel {
+    'id': string;
+    'name': string;
+}
 export interface EventSponsorshipTranslation {
     'id': number;
     'locale': string;
@@ -8781,6 +8798,15 @@ export interface GetEventSponsorshipLevels200Response {
 export declare enum GetEventSponsorshipLevels200ResponseStatusEnum {
     Ok = "ok"
 }
+export interface GetEventSponsorshipProgress200Response {
+    'status': GetEventSponsorshipProgress200ResponseStatusEnum;
+    'message': string;
+    'data': Array<EventSponsorshipProgress>;
+    'count'?: number;
+}
+export declare enum GetEventSponsorshipProgress200ResponseStatusEnum {
+    Ok = "ok"
+}
 export interface GetEventSponsorshipTranslation200Response {
     'status': GetEventSponsorshipTranslation200ResponseStatusEnum;
     'message': string;
@@ -13283,6 +13309,38 @@ export declare enum SideEffectTriggerType {
     PassWithQuestionChoice = "PASS_WITH_QUESTION_CHOICE",
     PurchasedAddon = "PURCHASED_ADDON"
 }
+export interface SponsorshipAdvertisementProgress {
+    'type': SponsorshipAdvertisementProgressTypeEnum;
+    'complete': boolean;
+    'created': number;
+    'allowance': number;
+    'unavailable': boolean;
+}
+export declare enum SponsorshipAdvertisementProgressTypeEnum {
+    Advertisements = "advertisements"
+}
+export interface SponsorshipBenefitProgress {
+    'type': SponsorshipBenefitProgressTypeEnum;
+    'complete': boolean;
+    'created': number;
+    'allowance': number;
+    'unavailable': boolean;
+}
+export declare enum SponsorshipBenefitProgressTypeEnum {
+    Benefits = "benefits"
+}
+export declare enum SponsorshipBrandingField {
+    Logo = "logo",
+    Link = "link"
+}
+export interface SponsorshipBrandingProgress {
+    'type': SponsorshipBrandingProgressTypeEnum;
+    'complete': boolean;
+    'missing': Array<SponsorshipBrandingField>;
+}
+export declare enum SponsorshipBrandingProgressTypeEnum {
+    Branding = "branding"
+}
 export interface SponsorshipLevelTranslation {
     'id': number;
     'locale': string;
@@ -13292,6 +13350,15 @@ export interface SponsorshipLevelTranslation {
     'createdAt': string;
     'updatedAt': string;
 }
+export interface SponsorshipProgress {
+    'complete': boolean;
+    'checks': Array<SponsorshipProgressCheck>;
+    'attention': Array<SponsorshipProgressCheck>;
+}
+/**
+ * @type SponsorshipProgressCheck
+ */
+export type SponsorshipProgressCheck = SponsorshipAdvertisementProgress | SponsorshipBenefitProgress | SponsorshipBrandingProgress | UnavailableSponsorshipAdvertisementProgress | UnavailableSponsorshipBenefitProgress;
 export interface StandardReport {
     'id': string;
     'type': ReportType;
@@ -14358,6 +14425,24 @@ 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;
@@ -62363,6 +62448,91 @@ export declare class EventsSponsorshiplevelsTranslationsApi extends BaseAPI {
      */
     updateEventSponsorshipLevelTranslation(requestParameters: EventsSponsorshiplevelsTranslationsApiUpdateEventSponsorshipLevelTranslationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventSponsorshipLevelTranslation200Response, any, {}, any>>;
 }
+/**
+ * EventsSponsorshipprogressApi - axios parameter creator
+ */
+export declare const EventsSponsorshipprogressApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Returns a paginated list of sponsorships for the event with the same derived progress the sponsor sees, least-complete first, supporting search; requires read permission on sponsors, events, and accounts.
+     * @summary List derived sponsor progress for an event
+     * @param {string} eventId The event 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}
+     */
+    getEventSponsorshipProgress: (eventId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * EventsSponsorshipprogressApi - functional programming interface
+ */
+export declare const EventsSponsorshipprogressApiFp: (configuration?: Configuration) => {
+    /**
+     * Returns a paginated list of sponsorships for the event with the same derived progress the sponsor sees, least-complete first, supporting search; requires read permission on sponsors, events, and accounts.
+     * @summary List derived sponsor progress for an event
+     * @param {string} eventId The event 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}
+     */
+    getEventSponsorshipProgress(eventId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEventSponsorshipProgress200Response>>;
+};
+/**
+ * EventsSponsorshipprogressApi - factory interface
+ */
+export declare const EventsSponsorshipprogressApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Returns a paginated list of sponsorships for the event with the same derived progress the sponsor sees, least-complete first, supporting search; requires read permission on sponsors, events, and accounts.
+     * @summary List derived sponsor progress for an event
+     * @param {EventsSponsorshipprogressApiGetEventSponsorshipProgressRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEventSponsorshipProgress(requestParameters: EventsSponsorshipprogressApiGetEventSponsorshipProgressRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetEventSponsorshipProgress200Response>;
+};
+/**
+ * Request parameters for getEventSponsorshipProgress operation in EventsSponsorshipprogressApi.
+ */
+export interface EventsSponsorshipprogressApiGetEventSponsorshipProgressRequest {
+    /**
+     * The event identifier
+     */
+    readonly eventId: 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;
+}
+/**
+ * EventsSponsorshipprogressApi - object-oriented interface
+ */
+export declare class EventsSponsorshipprogressApi extends BaseAPI {
+    /**
+     * Returns a paginated list of sponsorships for the event with the same derived progress the sponsor sees, least-complete first, supporting search; requires read permission on sponsors, events, and accounts.
+     * @summary List derived sponsor progress for an event
+     * @param {EventsSponsorshipprogressApiGetEventSponsorshipProgressRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEventSponsorshipProgress(requestParameters: EventsSponsorshipprogressApiGetEventSponsorshipProgressRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventSponsorshipProgress200Response, any, {}, any>>;
+}
 /**
  * EventsSponsorshipsApi - axios parameter creator
  */