@connectedxm/admin-sdk 15.1.0 → 15.2.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.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
  */

package/dist/esm/api.js

@@ -4,7 +4,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).
@@ -1582,6 +1582,10 @@ export var GetEventSponsorshipLevels200ResponseStatusEnum;
 (function (GetEventSponsorshipLevels200ResponseStatusEnum) {
     GetEventSponsorshipLevels200ResponseStatusEnum["Ok"] = "ok";
 })(GetEventSponsorshipLevels200ResponseStatusEnum || (GetEventSponsorshipLevels200ResponseStatusEnum = {}));
+export var GetEventSponsorshipProgress200ResponseStatusEnum;
+(function (GetEventSponsorshipProgress200ResponseStatusEnum) {
+    GetEventSponsorshipProgress200ResponseStatusEnum["Ok"] = "ok";
+})(GetEventSponsorshipProgress200ResponseStatusEnum || (GetEventSponsorshipProgress200ResponseStatusEnum = {}));
 export var GetEventSponsorshipTranslation200ResponseStatusEnum;
 (function (GetEventSponsorshipTranslation200ResponseStatusEnum) {
     GetEventSponsorshipTranslation200ResponseStatusEnum["Ok"] = "ok";
@@ -2802,6 +2806,23 @@ export var SideEffectTriggerType;
     SideEffectTriggerType["PassWithQuestionChoice"] = "PASS_WITH_QUESTION_CHOICE";
     SideEffectTriggerType["PurchasedAddon"] = "PURCHASED_ADDON";
 })(SideEffectTriggerType || (SideEffectTriggerType = {}));
+export var SponsorshipAdvertisementProgressTypeEnum;
+(function (SponsorshipAdvertisementProgressTypeEnum) {
+    SponsorshipAdvertisementProgressTypeEnum["Advertisements"] = "advertisements";
+})(SponsorshipAdvertisementProgressTypeEnum || (SponsorshipAdvertisementProgressTypeEnum = {}));
+export var SponsorshipBenefitProgressTypeEnum;
+(function (SponsorshipBenefitProgressTypeEnum) {
+    SponsorshipBenefitProgressTypeEnum["Benefits"] = "benefits";
+})(SponsorshipBenefitProgressTypeEnum || (SponsorshipBenefitProgressTypeEnum = {}));
+export var SponsorshipBrandingField;
+(function (SponsorshipBrandingField) {
+    SponsorshipBrandingField["Logo"] = "logo";
+    SponsorshipBrandingField["Link"] = "link";
+})(SponsorshipBrandingField || (SponsorshipBrandingField = {}));
+export var SponsorshipBrandingProgressTypeEnum;
+(function (SponsorshipBrandingProgressTypeEnum) {
+    SponsorshipBrandingProgressTypeEnum["Branding"] = "branding";
+})(SponsorshipBrandingProgressTypeEnum || (SponsorshipBrandingProgressTypeEnum = {}));
 export var StorageConfigTypeEnum;
 (function (StorageConfigTypeEnum) {
     StorageConfigTypeEnum["Aws"] = "aws";
@@ -2999,6 +3020,14 @@ export var ThreadType;
     ThreadType["Direct"] = "direct";
     ThreadType["Default"] = "default";
 })(ThreadType || (ThreadType = {}));
+export var UnavailableSponsorshipAdvertisementProgressTypeEnum;
+(function (UnavailableSponsorshipAdvertisementProgressTypeEnum) {
+    UnavailableSponsorshipAdvertisementProgressTypeEnum["Advertisements"] = "advertisements";
+})(UnavailableSponsorshipAdvertisementProgressTypeEnum || (UnavailableSponsorshipAdvertisementProgressTypeEnum = {}));
+export var UnavailableSponsorshipBenefitProgressTypeEnum;
+(function (UnavailableSponsorshipBenefitProgressTypeEnum) {
+    UnavailableSponsorshipBenefitProgressTypeEnum["Benefits"] = "benefits";
+})(UnavailableSponsorshipBenefitProgressTypeEnum || (UnavailableSponsorshipBenefitProgressTypeEnum = {}));
 export var UpdateAnnouncementTemplateTranslation200ResponseStatusEnum;
 (function (UpdateAnnouncementTemplateTranslation200ResponseStatusEnum) {
     UpdateAnnouncementTemplateTranslation200ResponseStatusEnum["Ok"] = "ok";
@@ -74169,6 +74198,124 @@ export class EventsSponsorshiplevelsTranslationsApi extends BaseAPI {
         return EventsSponsorshiplevelsTranslationsApiFp(this.configuration).updateEventSponsorshipLevelTranslation(requestParameters.eventId, requestParameters.levelId, requestParameters.locale, requestParameters.eventSponsorshipLevelTranslationUpdateInputs, options).then((request) => request(this.axios, this.basePath));
     }
 }
+/**
+ * EventsSponsorshipprogressApi - axios parameter creator
+ */
+export const EventsSponsorshipprogressApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * 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_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [eventId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (eventId, page, pageSize, orderBy, search, options = {}) {
+            // verify required parameter 'eventId' is not null or undefined
+            assertParamExists('getEventSponsorshipProgress', 'eventId', eventId);
+            const localVarPath = `/events/{eventId}/sponsorshipProgress`
+                .replace('{eventId}', encodeURIComponent(String(eventId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication ApiKeyAuth required
+            yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
+            // authentication OrganizationId required
+            yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
+            if (page !== undefined) {
+                localVarQueryParameter['page'] = page;
+            }
+            if (pageSize !== undefined) {
+                localVarQueryParameter['pageSize'] = pageSize;
+            }
+            if (orderBy !== undefined) {
+                localVarQueryParameter['orderBy'] = orderBy;
+            }
+            if (search !== undefined) {
+                localVarQueryParameter['search'] = search;
+            }
+            localVarHeaderParameter['Accept'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+/**
+ * EventsSponsorshipprogressApi - functional programming interface
+ */
+export const EventsSponsorshipprogressApiFp = function (configuration) {
+    const localVarAxiosParamCreator = EventsSponsorshipprogressApiAxiosParamCreator(configuration);
+    return {
+        /**
+         * 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, page, pageSize, orderBy, search, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getEventSponsorshipProgress(eventId, page, pageSize, orderBy, search, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EventsSponsorshipprogressApi.getEventSponsorshipProgress']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+    };
+};
+/**
+ * EventsSponsorshipprogressApi - factory interface
+ */
+export const EventsSponsorshipprogressApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = EventsSponsorshipprogressApiFp(configuration);
+    return {
+        /**
+         * 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, options) {
+            return localVarFp.getEventSponsorshipProgress(requestParameters.eventId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * EventsSponsorshipprogressApi - object-oriented interface
+ */
+export 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, options) {
+        return EventsSponsorshipprogressApiFp(this.configuration).getEventSponsorshipProgress(requestParameters.eventId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
+    }
+}
 /**
  * EventsSponsorshipsApi - axios parameter creator
  */

package/dist/esm/base.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).

package/dist/esm/base.js

@@ -4,7 +4,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).

package/dist/esm/common.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).

package/dist/esm/common.js

@@ -4,7 +4,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).

package/dist/esm/configuration.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).

package/dist/esm/configuration.js

@@ -3,7 +3,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).

package/docs/EventSponsorshipProgress.md

@@ -0,0 +1,28 @@
+# EventSponsorshipProgress
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**account** | [**EventSponsorshipProgressAccount**](EventSponsorshipProgressAccount.md) |  | [default to undefined]
+**level** | [**EventSponsorshipProgressLevel**](EventSponsorshipProgressLevel.md) |  | [default to undefined]
+**progress** | [**SponsorshipProgress**](SponsorshipProgress.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { EventSponsorshipProgress } from '@connectedxm/admin-sdk';
+
+const instance: EventSponsorshipProgress = {
+    id,
+    name,
+    account,
+    level,
+    progress,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/EventSponsorshipProgressAccount.md

@@ -0,0 +1,26 @@
+# EventSponsorshipProgressAccount
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**fullName** | **string** |  | [default to undefined]
+**firstName** | **string** |  | [default to undefined]
+**lastName** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { EventSponsorshipProgressAccount } from '@connectedxm/admin-sdk';
+
+const instance: EventSponsorshipProgressAccount = {
+    id,
+    fullName,
+    firstName,
+    lastName,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/EventSponsorshipProgressLevel.md

@@ -0,0 +1,22 @@
+# EventSponsorshipProgressLevel
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { EventSponsorshipProgressLevel } from '@connectedxm/admin-sdk';
+
+const instance: EventSponsorshipProgressLevel = {
+    id,
+    name,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/EventsSponsorshipprogressApi.md

@@ -0,0 +1,71 @@
+# EventsSponsorshipprogressApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getEventSponsorshipProgress**](#geteventsponsorshipprogress) | **GET** /events/{eventId}/sponsorshipProgress | List derived sponsor progress for an event|
+
+# **getEventSponsorshipProgress**
+> GetEventSponsorshipProgress200Response getEventSponsorshipProgress()
+
+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.
+
+### Example
+
+```typescript
+import {
+    EventsSponsorshipprogressApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSponsorshipprogressApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let page: number; //Page number (optional) (default to 1)
+let pageSize: number; //Number of items per page (optional) (default to 25)
+let orderBy: string; //Field to order by (optional) (default to undefined)
+let search: string; //Search query (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getEventSponsorshipProgress(
+    eventId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **page** | [**number**] | Page number | (optional) defaults to 1|
+| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
+| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
+| **search** | [**string**] | Search query | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetEventSponsorshipProgress200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/GetEventSponsorshipProgress200Response.md

@@ -0,0 +1,26 @@
+# GetEventSponsorshipProgress200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**Array<EventSponsorshipProgress>**](EventSponsorshipProgress.md) |  | [default to undefined]
+**count** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetEventSponsorshipProgress200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetEventSponsorshipProgress200Response = {
+    status,
+    message,
+    data,
+    count,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SponsorshipAdvertisementProgress.md

@@ -0,0 +1,28 @@
+# SponsorshipAdvertisementProgress
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** |  | [default to undefined]
+**complete** | **boolean** |  | [default to undefined]
+**created** | **number** |  | [default to undefined]
+**allowance** | **number** |  | [default to undefined]
+**unavailable** | **boolean** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SponsorshipAdvertisementProgress } from '@connectedxm/admin-sdk';
+
+const instance: SponsorshipAdvertisementProgress = {
+    type,
+    complete,
+    created,
+    allowance,
+    unavailable,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)