@connectedxm/admin-sdk 13.2.0 → 13.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -12,7 +12,7 @@
12
12
  * const eventsPasses = await adminApi.eventsPasses.getEventPasses();
13
13
  */
14
14
  import { Configuration } from "./configuration";
15
- import { AccountsApi, AccountsAddressesApi, AccountsFollowersApi, AccountsFollowingApi, AccountsGroupsApi, AccountsInterestsApi, AccountsInvitationsApi, AccountsLeadsApi, AccountsMergesApi, AccountsTiersApi, ActivitiesApi, ActivitiesScheduleApi, AdvertisementsApi, AnnouncementsApi, AnnouncementsAudiencesApi, AnnouncementsScheduleApi, AnnouncementsTemplatesApi, AnnouncementsTemplatesTranslationsApi, AnnouncementsTranslationsApi, ApiLogsApi, AuthSessionsApi, BenefitsApi, BenefitsTranslationsApi, BookingsApi, BookingsAvailabilitiesApi, BookingsBlackoutsApi, BookingsPlacesApi, BookingsPlacesTranslationsApi, BookingsQuestionsApi, BookingsQuestionsChoicesApi, BookingsQuestionsChoicesTranslationsApi, BookingsQuestionsTranslationsApi, BookingsResponsesApi, BookingsSpacesApi, BookingsSpacesTranslationsApi, ChannelsApi, ChannelsTranslationsApi, DashboardsApi, DashboardsWidgetsApi, EmailReceiptsApi, EventsApi, EventsAccessApi, EventsActivationsApi, EventsActivationsSessionsApi, EventsActivationsTranslationsApi, EventsAddonsApi, EventsAddonsTranslationsApi, EventsAttributesApi, EventsBenefitsApi, EventsBlocksApi, EventsBypassApi, EventsCohostsApi, EventsCouponsApi, EventsEmailsApi, EventsEmailsTranslationsApi, EventsFaqsApi, EventsFaqsTranslationsApi, EventsFollowupsApi, EventsFollowupsTranslationsApi, EventsGroupcouponreminderApi, EventsMatchesApi, EventsMediaApi, EventsMediaTranslationsApi, EventsOnSiteApi, EventsPackagesApi, EventsPackagesPassesApi, EventsPackagesTranslationsApi, EventsPagesApi, EventsPagesTranslationsApi, EventsPasschangesApi, EventsPassesApi, EventsPassesAccessesApi, EventsPassesAddonsApi, EventsPassesAttributesApi, EventsPassesFollowupsApi, EventsPassesResponsesApi, EventsPasstypesApi, EventsPasstypesExchangetargetsApi, EventsPasstypesPriceschedulesApi, EventsPasstypesRefundschedulesApi, EventsPasstypesTranslationsApi, EventsQuestionsApi, EventsQuestionsTranslationsApi, EventsRegistrationsApi, EventsRegistrationsPackagesApi, EventsRegistrationsReservationsApi, EventsRoomsApi, EventsRoomtypesApi, EventsRoomtypesTranslationsApi, EventsSectionsApi, EventsSectionsTranslationsApi, EventsSessionsApi, EventsSessionsAccessesApi, EventsSessionsLocationsApi, EventsSessionsLocationsTranslationsApi, EventsSessionsMatchesApi, EventsSessionsPricesApi, EventsSessionsQuestionsApi, EventsSessionsQuestionsTranslationsApi, EventsSessionsSectionsApi, EventsSessionsSectionsTranslationsApi, EventsSessionsTimesApi, EventsSessionsTimesTranslationsApi, EventsSessionsTranslationsApi, EventsSpeakersApi, EventsSpeakersTranslationsApi, EventsSponsorsApi, EventsSponsorshiplevelsApi, EventsSponsorshiplevelsTranslationsApi, EventsSponsorshipsApi, EventsSponsorshipsTranslationsApi, EventsTemplatesApi, EventsTracksApi, EventsTracksTranslationsApi, EventsTransfersApi, EventsTranslationsApi, FilesApi, GroupsApi, GroupsEventsApi, GroupsInterestsApi, GroupsInvitationsApi, GroupsMembersApi, GroupsModeratorsApi, GroupsRequestsApi, GroupsSponsorsApi, GroupsTranslationsApi, ImportsApi, InterestsApi, InvoicesApi, InvoicesLineitemsApi, LoginsApi, LoginsAccountsApi, MeetingsApi, MeetingsLinksApi, MeetingsLivestreamsApi, MeetingsParticipantsApi, MeetingsPresetsApi, MeetingsRecordingsApi, MeetingsSessionsApi, NotificationsApi, OrganizationApi, OrganizationAttributesApi, OrganizationDomainsApi, OrganizationEntitiesApi, OrganizationIntegrationsApi, OrganizationLanguageoverridesApi, OrganizationModulesApi, OrganizationModulesCustomApi, OrganizationModulesCustomTranslationsApi, OrganizationModulesSettingsApi, OrganizationModulesSettingsTranslationsApi, OrganizationModulesTiersApi, OrganizationPaymentsApi, OrganizationSideeffectsApi, OrganizationTaxApi, OrganizationTeammembersApi, OrganizationUsersApi, OrganizationWebhooksApi, PaymentsApi, PreferencesApi, PushDevicesApi, ReportsApi, ReportsUsersApi, SearchlistsApi, SearchlistsValuesApi, SelfApi, SelfApikeysApi, SelfImagesApi, SeriesApi, SeriesQuestionsApi, SeriesQuestionsChoicesApi, SeriesQuestionsTranslationsApi, SeriesRegistrationsApi, SeriesTranslationsApi, SponsorsApi, SponsorsAccountsApi, SponsorsTranslationsApi, StorageFilesApi, StorageImagesApi, StorageVideosApi, StorageVideosCaptionsApi, StreamsApi, StreamsOutputsApi, StreamsSessionsApi, SupportApi, SupportMessagesApi, SupportNotesApi, SurveysApi, SurveysQuestionsApi, SurveysQuestionsTranslationsApi, SurveysSectionsApi, SurveysSectionsTranslationsApi, SurveysSessionsApi, SurveysSubmissionsApi, SurveysTranslationsApi, ThreadsApi, ThreadsAccountsApi, ThreadsMessagesApi, ThreadsMessagesFilesApi, ThreadsMessagesImagesApi, ThreadsMessagesReactionsApi, ThreadsMessagesVideosApi, ThreadsStorageApi, TiersApi, } from "./api";
15
+ import { AccountsApi, AccountsAddressesApi, AccountsFollowersApi, AccountsFollowingApi, AccountsGroupsApi, AccountsInterestsApi, AccountsInvitationsApi, AccountsLeadsApi, AccountsMergesApi, AccountsTiersApi, ActivitiesApi, ActivitiesScheduleApi, AdvertisementsApi, AnnouncementsApi, AnnouncementsAudiencesApi, AnnouncementsScheduleApi, AnnouncementsTemplatesApi, AnnouncementsTemplatesTranslationsApi, AnnouncementsTranslationsApi, ApiLogsApi, AuthSessionsApi, BenefitsApi, BenefitsTranslationsApi, BookingsApi, BookingsAvailabilitiesApi, BookingsBlackoutsApi, BookingsPlacesApi, BookingsPlacesTranslationsApi, BookingsQuestionsApi, BookingsQuestionsChoicesApi, BookingsQuestionsChoicesTranslationsApi, BookingsQuestionsTranslationsApi, BookingsResponsesApi, BookingsSpacesApi, BookingsSpacesTranslationsApi, ChannelsApi, ChannelsTranslationsApi, DashboardsApi, DashboardsWidgetsApi, EmailReceiptsApi, EventsApi, EventsAccessApi, EventsActivationsApi, EventsActivationsSessionsApi, EventsActivationsTranslationsApi, EventsAddonsApi, EventsAddonsTranslationsApi, EventsAttributesApi, EventsBenefitsApi, EventsBlocksApi, EventsBypassApi, EventsCohostsApi, EventsCouponsApi, EventsEmailsApi, EventsEmailsTranslationsApi, EventsFaqsApi, EventsFaqsTranslationsApi, EventsFollowupsApi, EventsFollowupsTranslationsApi, EventsGroupcouponreminderApi, EventsMatchesApi, EventsMediaApi, EventsMediaTranslationsApi, EventsOnSiteApi, EventsPackagesApi, EventsPackagesPassesApi, EventsPackagesTranslationsApi, EventsPagesApi, EventsPagesTranslationsApi, EventsPasschangesApi, EventsPassesApi, EventsPassesAccessesApi, EventsPassesAddonsApi, EventsPassesAttributesApi, EventsPassesFollowupsApi, EventsPassesResponsesApi, EventsPasstypesApi, EventsPasstypesExchangetargetsApi, EventsPasstypesPriceschedulesApi, EventsPasstypesRefundschedulesApi, EventsPasstypesTranslationsApi, EventsQuestionsApi, EventsQuestionsTranslationsApi, EventsRegistrationsApi, EventsRegistrationsPackagesApi, EventsRegistrationsReservationsApi, EventsRoomsApi, EventsRoomtypesApi, EventsRoomtypesTranslationsApi, EventsSectionsApi, EventsSectionsTranslationsApi, EventsSessionsApi, EventsSessionsAccessesApi, EventsSessionsLocationsApi, EventsSessionsLocationsTranslationsApi, EventsSessionsMatchesApi, EventsSessionsPricesApi, EventsSessionsQuestionsApi, EventsSessionsQuestionsTranslationsApi, EventsSessionsSectionsApi, EventsSessionsSectionsTranslationsApi, EventsSessionsTimesApi, EventsSessionsTimesTranslationsApi, EventsSessionsTranslationsApi, EventsSpeakersApi, EventsSpeakersTranslationsApi, EventsSponsorsApi, EventsSponsorshiplevelsApi, EventsSponsorshiplevelsTranslationsApi, EventsSponsorshipsApi, EventsSponsorshipsTranslationsApi, EventsTemplatesApi, EventsTracksApi, EventsTracksTranslationsApi, EventsTransfersApi, EventsTranslationsApi, ExportsApi, FilesApi, GroupsApi, GroupsEventsApi, GroupsInterestsApi, GroupsInvitationsApi, GroupsMembersApi, GroupsModeratorsApi, GroupsRequestsApi, GroupsSponsorsApi, GroupsTranslationsApi, ImportsApi, InterestsApi, InvoicesApi, InvoicesLineitemsApi, LoginsApi, LoginsAccountsApi, MeetingsApi, MeetingsLinksApi, MeetingsLivestreamsApi, MeetingsParticipantsApi, MeetingsPresetsApi, MeetingsRecordingsApi, MeetingsSessionsApi, NotificationsApi, OrganizationApi, OrganizationAttributesApi, OrganizationDomainsApi, OrganizationEntitiesApi, OrganizationIntegrationsApi, OrganizationLanguageoverridesApi, OrganizationModulesApi, OrganizationModulesCustomApi, OrganizationModulesCustomTranslationsApi, OrganizationModulesSettingsApi, OrganizationModulesSettingsTranslationsApi, OrganizationModulesTiersApi, OrganizationPaymentsApi, OrganizationSideeffectsApi, OrganizationTaxApi, OrganizationTeammembersApi, OrganizationUsersApi, OrganizationWebhooksApi, PaymentsApi, PreferencesApi, PushDevicesApi, ReportsApi, ReportsUsersApi, SearchlistsApi, SearchlistsValuesApi, SelfApi, SelfApikeysApi, SelfImagesApi, SeriesApi, SeriesQuestionsApi, SeriesQuestionsChoicesApi, SeriesQuestionsTranslationsApi, SeriesRegistrationsApi, SeriesTranslationsApi, SponsorsApi, SponsorsAccountsApi, SponsorsTranslationsApi, StorageFilesApi, StorageImagesApi, StorageVideosApi, StorageVideosCaptionsApi, StreamsApi, StreamsOutputsApi, StreamsSessionsApi, SupportApi, SupportMessagesApi, SupportNotesApi, SurveysApi, SurveysQuestionsApi, SurveysQuestionsTranslationsApi, SurveysSectionsApi, SurveysSectionsTranslationsApi, SurveysSessionsApi, SurveysSubmissionsApi, SurveysTranslationsApi, ThreadsApi, ThreadsAccountsApi, ThreadsMessagesApi, ThreadsMessagesFilesApi, ThreadsMessagesImagesApi, ThreadsMessagesReactionsApi, ThreadsMessagesVideosApi, ThreadsStorageApi, TiersApi, } from "./api";
16
16
  export class AdminApi {
17
17
  constructor(config) {
18
18
  var _a;
@@ -141,6 +141,7 @@ export class AdminApi {
141
141
  this.eventsTracksTranslations = new EventsTracksTranslationsApi(this.config);
142
142
  this.eventsTransfers = new EventsTransfersApi(this.config);
143
143
  this.eventsTranslations = new EventsTranslationsApi(this.config);
144
+ this.exports = new ExportsApi(this.config);
144
145
  this.files = new FilesApi(this.config);
145
146
  this.groups = new GroupsApi(this.config);
146
147
  this.groupsEvents = new GroupsEventsApi(this.config);
package/dist/esm/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Connected Admin API
3
3
  * The Admin API allows you to manage your Connected community programmatically.
4
4
  *
5
- * The version of the OpenAPI document: 13.2.0
5
+ * The version of the OpenAPI document: 13.3.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1984,6 +1984,18 @@ export interface BaseEventTrack {
1984
1984
  'description': string | null;
1985
1985
  'color': string;
1986
1986
  }
1987
+ export interface BaseExport {
1988
+ 'id': string;
1989
+ 'type': string;
1990
+ 'status': ExportStatus;
1991
+ 'message': string | null;
1992
+ 'eventId': string | null;
1993
+ 'userId': string | null;
1994
+ 'expiration': string | null;
1995
+ 'downloadUrl': string | null;
1996
+ 'createdAt': string;
1997
+ 'updatedAt': string;
1998
+ }
1987
1999
  export interface BaseFaq {
1988
2000
  'id': string;
1989
2001
  'slug': string;
@@ -6881,6 +6893,19 @@ export declare enum ExchangeType {
6881
6893
  Downgrade = "downgrade",
6882
6894
  Swap = "swap"
6883
6895
  }
6896
+ export interface Export {
6897
+ 'id': string;
6898
+ 'type': string;
6899
+ 'status': ExportStatus;
6900
+ 'message': string | null;
6901
+ 'eventId': string | null;
6902
+ 'userId': string | null;
6903
+ 'expiration': string | null;
6904
+ 'downloadUrl': string | null;
6905
+ 'createdAt': string;
6906
+ 'updatedAt': string;
6907
+ 'user': BaseUser | null;
6908
+ }
6884
6909
  export declare enum ExportStatus {
6885
6910
  Pending = "pending",
6886
6911
  Resolved = "resolved",
@@ -8765,6 +8790,23 @@ export interface GetEvents200Response {
8765
8790
  export declare enum GetEvents200ResponseStatusEnum {
8766
8791
  Ok = "ok"
8767
8792
  }
8793
+ export interface GetExport200Response {
8794
+ 'status': GetExport200ResponseStatusEnum;
8795
+ 'message': string;
8796
+ 'data': Export;
8797
+ }
8798
+ export declare enum GetExport200ResponseStatusEnum {
8799
+ Ok = "ok"
8800
+ }
8801
+ export interface GetExports200Response {
8802
+ 'status': GetExports200ResponseStatusEnum;
8803
+ 'message': string;
8804
+ 'data': Array<Export>;
8805
+ 'count'?: number;
8806
+ }
8807
+ export declare enum GetExports200ResponseStatusEnum {
8808
+ Ok = "ok"
8809
+ }
8768
8810
  export interface GetFiles200Response {
8769
8811
  'status': GetFiles200ResponseStatusEnum;
8770
8812
  'message': string;
@@ -62966,6 +63008,132 @@ export declare class EventsTranslationsApi extends BaseAPI {
62966
63008
  */
62967
63009
  updateEventTranslation(requestParameters: EventsTranslationsApiUpdateEventTranslationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SyncAccounts200Response, any, {}, any>>;
62968
63010
  }
63011
+ /**
63012
+ * ExportsApi - axios parameter creator
63013
+ */
63014
+ export declare const ExportsApiAxiosParamCreator: (configuration?: Configuration) => {
63015
+ /**
63016
+ * Returns the status, message and download link of a single data export job by its ID; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
63017
+ * @summary Get a single export
63018
+ * @param {string} exportId The export identifier
63019
+ * @param {*} [options] Override http request option.
63020
+ * @throws {RequiredError}
63021
+ */
63022
+ getExport: (exportId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63023
+ /**
63024
+ * Returns a paginated list of the organization\'s data export jobs, newest first, optionally filtered by status and searchable by export type; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
63025
+ * @summary List data exports
63026
+ * @param {ExportStatus} [status] Filter by status
63027
+ * @param {number} [page] Page number
63028
+ * @param {number} [pageSize] Number of items per page
63029
+ * @param {string} [orderBy] Field to order by
63030
+ * @param {string} [search] Search query
63031
+ * @param {*} [options] Override http request option.
63032
+ * @throws {RequiredError}
63033
+ */
63034
+ getExports: (status?: ExportStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
63035
+ };
63036
+ /**
63037
+ * ExportsApi - functional programming interface
63038
+ */
63039
+ export declare const ExportsApiFp: (configuration?: Configuration) => {
63040
+ /**
63041
+ * Returns the status, message and download link of a single data export job by its ID; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
63042
+ * @summary Get a single export
63043
+ * @param {string} exportId The export identifier
63044
+ * @param {*} [options] Override http request option.
63045
+ * @throws {RequiredError}
63046
+ */
63047
+ getExport(exportId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetExport200Response>>;
63048
+ /**
63049
+ * Returns a paginated list of the organization\'s data export jobs, newest first, optionally filtered by status and searchable by export type; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
63050
+ * @summary List data exports
63051
+ * @param {ExportStatus} [status] Filter by status
63052
+ * @param {number} [page] Page number
63053
+ * @param {number} [pageSize] Number of items per page
63054
+ * @param {string} [orderBy] Field to order by
63055
+ * @param {string} [search] Search query
63056
+ * @param {*} [options] Override http request option.
63057
+ * @throws {RequiredError}
63058
+ */
63059
+ getExports(status?: ExportStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetExports200Response>>;
63060
+ };
63061
+ /**
63062
+ * ExportsApi - factory interface
63063
+ */
63064
+ export declare const ExportsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
63065
+ /**
63066
+ * Returns the status, message and download link of a single data export job by its ID; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
63067
+ * @summary Get a single export
63068
+ * @param {ExportsApiGetExportRequest} requestParameters Request parameters.
63069
+ * @param {*} [options] Override http request option.
63070
+ * @throws {RequiredError}
63071
+ */
63072
+ getExport(requestParameters: ExportsApiGetExportRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetExport200Response>;
63073
+ /**
63074
+ * Returns a paginated list of the organization\'s data export jobs, newest first, optionally filtered by status and searchable by export type; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
63075
+ * @summary List data exports
63076
+ * @param {ExportsApiGetExportsRequest} requestParameters Request parameters.
63077
+ * @param {*} [options] Override http request option.
63078
+ * @throws {RequiredError}
63079
+ */
63080
+ getExports(requestParameters?: ExportsApiGetExportsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetExports200Response>;
63081
+ };
63082
+ /**
63083
+ * Request parameters for getExport operation in ExportsApi.
63084
+ */
63085
+ export interface ExportsApiGetExportRequest {
63086
+ /**
63087
+ * The export identifier
63088
+ */
63089
+ readonly exportId: string;
63090
+ }
63091
+ /**
63092
+ * Request parameters for getExports operation in ExportsApi.
63093
+ */
63094
+ export interface ExportsApiGetExportsRequest {
63095
+ /**
63096
+ * Filter by status
63097
+ */
63098
+ readonly status?: ExportStatus;
63099
+ /**
63100
+ * Page number
63101
+ */
63102
+ readonly page?: number;
63103
+ /**
63104
+ * Number of items per page
63105
+ */
63106
+ readonly pageSize?: number;
63107
+ /**
63108
+ * Field to order by
63109
+ */
63110
+ readonly orderBy?: string;
63111
+ /**
63112
+ * Search query
63113
+ */
63114
+ readonly search?: string;
63115
+ }
63116
+ /**
63117
+ * ExportsApi - object-oriented interface
63118
+ */
63119
+ export declare class ExportsApi extends BaseAPI {
63120
+ /**
63121
+ * Returns the status, message and download link of a single data export job by its ID; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
63122
+ * @summary Get a single export
63123
+ * @param {ExportsApiGetExportRequest} requestParameters Request parameters.
63124
+ * @param {*} [options] Override http request option.
63125
+ * @throws {RequiredError}
63126
+ */
63127
+ getExport(requestParameters: ExportsApiGetExportRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetExport200Response, any, {}, any>>;
63128
+ /**
63129
+ * Returns a paginated list of the organization\'s data export jobs, newest first, optionally filtered by status and searchable by export type; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
63130
+ * @summary List data exports
63131
+ * @param {ExportsApiGetExportsRequest} requestParameters Request parameters.
63132
+ * @param {*} [options] Override http request option.
63133
+ * @throws {RequiredError}
63134
+ */
63135
+ getExports(requestParameters?: ExportsApiGetExportsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetExports200Response, any, {}, any>>;
63136
+ }
62969
63137
  /**
62970
63138
  * FilesApi - axios parameter creator
62971
63139
  */
package/dist/esm/api.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Connected Admin API
5
5
  * The Admin API allows you to manage your Connected community programmatically.
6
6
  *
7
- * The version of the OpenAPI document: 13.2.0
7
+ * The version of the OpenAPI document: 13.3.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1606,6 +1606,14 @@ export var GetEvents200ResponseStatusEnum;
1606
1606
  (function (GetEvents200ResponseStatusEnum) {
1607
1607
  GetEvents200ResponseStatusEnum["Ok"] = "ok";
1608
1608
  })(GetEvents200ResponseStatusEnum || (GetEvents200ResponseStatusEnum = {}));
1609
+ export var GetExport200ResponseStatusEnum;
1610
+ (function (GetExport200ResponseStatusEnum) {
1611
+ GetExport200ResponseStatusEnum["Ok"] = "ok";
1612
+ })(GetExport200ResponseStatusEnum || (GetExport200ResponseStatusEnum = {}));
1613
+ export var GetExports200ResponseStatusEnum;
1614
+ (function (GetExports200ResponseStatusEnum) {
1615
+ GetExports200ResponseStatusEnum["Ok"] = "ok";
1616
+ })(GetExports200ResponseStatusEnum || (GetExports200ResponseStatusEnum = {}));
1609
1617
  export var GetFiles200ResponseStatusEnum;
1610
1618
  (function (GetFiles200ResponseStatusEnum) {
1611
1619
  GetFiles200ResponseStatusEnum["Ok"] = "ok";
@@ -75435,6 +75443,194 @@ export class EventsTranslationsApi extends BaseAPI {
75435
75443
  return EventsTranslationsApiFp(this.configuration).updateEventTranslation(requestParameters.eventId, requestParameters.locale, requestParameters.eventTranslationUpdateInputs, options).then((request) => request(this.axios, this.basePath));
75436
75444
  }
75437
75445
  }
75446
+ /**
75447
+ * ExportsApi - axios parameter creator
75448
+ */
75449
+ export const ExportsApiAxiosParamCreator = function (configuration) {
75450
+ return {
75451
+ /**
75452
+ * Returns the status, message and download link of a single data export job by its ID; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
75453
+ * @summary Get a single export
75454
+ * @param {string} exportId The export identifier
75455
+ * @param {*} [options] Override http request option.
75456
+ * @throws {RequiredError}
75457
+ */
75458
+ getExport: (exportId_1, ...args_1) => __awaiter(this, [exportId_1, ...args_1], void 0, function* (exportId, options = {}) {
75459
+ // verify required parameter 'exportId' is not null or undefined
75460
+ assertParamExists('getExport', 'exportId', exportId);
75461
+ const localVarPath = `/exports/{exportId}`
75462
+ .replace('{exportId}', encodeURIComponent(String(exportId)));
75463
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
75464
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
75465
+ let baseOptions;
75466
+ if (configuration) {
75467
+ baseOptions = configuration.baseOptions;
75468
+ }
75469
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
75470
+ const localVarHeaderParameter = {};
75471
+ const localVarQueryParameter = {};
75472
+ // authentication ApiKeyAuth required
75473
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
75474
+ // authentication OrganizationId required
75475
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
75476
+ localVarHeaderParameter['Accept'] = 'application/json';
75477
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
75478
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
75479
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
75480
+ return {
75481
+ url: toPathString(localVarUrlObj),
75482
+ options: localVarRequestOptions,
75483
+ };
75484
+ }),
75485
+ /**
75486
+ * Returns a paginated list of the organization\'s data export jobs, newest first, optionally filtered by status and searchable by export type; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
75487
+ * @summary List data exports
75488
+ * @param {ExportStatus} [status] Filter by status
75489
+ * @param {number} [page] Page number
75490
+ * @param {number} [pageSize] Number of items per page
75491
+ * @param {string} [orderBy] Field to order by
75492
+ * @param {string} [search] Search query
75493
+ * @param {*} [options] Override http request option.
75494
+ * @throws {RequiredError}
75495
+ */
75496
+ getExports: (status_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [status_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (status, page, pageSize, orderBy, search, options = {}) {
75497
+ const localVarPath = `/exports`;
75498
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
75499
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
75500
+ let baseOptions;
75501
+ if (configuration) {
75502
+ baseOptions = configuration.baseOptions;
75503
+ }
75504
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
75505
+ const localVarHeaderParameter = {};
75506
+ const localVarQueryParameter = {};
75507
+ // authentication ApiKeyAuth required
75508
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
75509
+ // authentication OrganizationId required
75510
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
75511
+ if (status !== undefined) {
75512
+ localVarQueryParameter['status'] = status;
75513
+ }
75514
+ if (page !== undefined) {
75515
+ localVarQueryParameter['page'] = page;
75516
+ }
75517
+ if (pageSize !== undefined) {
75518
+ localVarQueryParameter['pageSize'] = pageSize;
75519
+ }
75520
+ if (orderBy !== undefined) {
75521
+ localVarQueryParameter['orderBy'] = orderBy;
75522
+ }
75523
+ if (search !== undefined) {
75524
+ localVarQueryParameter['search'] = search;
75525
+ }
75526
+ localVarHeaderParameter['Accept'] = 'application/json';
75527
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
75528
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
75529
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
75530
+ return {
75531
+ url: toPathString(localVarUrlObj),
75532
+ options: localVarRequestOptions,
75533
+ };
75534
+ }),
75535
+ };
75536
+ };
75537
+ /**
75538
+ * ExportsApi - functional programming interface
75539
+ */
75540
+ export const ExportsApiFp = function (configuration) {
75541
+ const localVarAxiosParamCreator = ExportsApiAxiosParamCreator(configuration);
75542
+ return {
75543
+ /**
75544
+ * Returns the status, message and download link of a single data export job by its ID; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
75545
+ * @summary Get a single export
75546
+ * @param {string} exportId The export identifier
75547
+ * @param {*} [options] Override http request option.
75548
+ * @throws {RequiredError}
75549
+ */
75550
+ getExport(exportId, options) {
75551
+ return __awaiter(this, void 0, void 0, function* () {
75552
+ var _a, _b, _c;
75553
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getExport(exportId, options);
75554
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
75555
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ExportsApi.getExport']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
75556
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
75557
+ });
75558
+ },
75559
+ /**
75560
+ * Returns a paginated list of the organization\'s data export jobs, newest first, optionally filtered by status and searchable by export type; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
75561
+ * @summary List data exports
75562
+ * @param {ExportStatus} [status] Filter by status
75563
+ * @param {number} [page] Page number
75564
+ * @param {number} [pageSize] Number of items per page
75565
+ * @param {string} [orderBy] Field to order by
75566
+ * @param {string} [search] Search query
75567
+ * @param {*} [options] Override http request option.
75568
+ * @throws {RequiredError}
75569
+ */
75570
+ getExports(status, page, pageSize, orderBy, search, options) {
75571
+ return __awaiter(this, void 0, void 0, function* () {
75572
+ var _a, _b, _c;
75573
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getExports(status, page, pageSize, orderBy, search, options);
75574
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
75575
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ExportsApi.getExports']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
75576
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
75577
+ });
75578
+ },
75579
+ };
75580
+ };
75581
+ /**
75582
+ * ExportsApi - factory interface
75583
+ */
75584
+ export const ExportsApiFactory = function (configuration, basePath, axios) {
75585
+ const localVarFp = ExportsApiFp(configuration);
75586
+ return {
75587
+ /**
75588
+ * Returns the status, message and download link of a single data export job by its ID; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
75589
+ * @summary Get a single export
75590
+ * @param {ExportsApiGetExportRequest} requestParameters Request parameters.
75591
+ * @param {*} [options] Override http request option.
75592
+ * @throws {RequiredError}
75593
+ */
75594
+ getExport(requestParameters, options) {
75595
+ return localVarFp.getExport(requestParameters.exportId, options).then((request) => request(axios, basePath));
75596
+ },
75597
+ /**
75598
+ * Returns a paginated list of the organization\'s data export jobs, newest first, optionally filtered by status and searchable by export type; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
75599
+ * @summary List data exports
75600
+ * @param {ExportsApiGetExportsRequest} requestParameters Request parameters.
75601
+ * @param {*} [options] Override http request option.
75602
+ * @throws {RequiredError}
75603
+ */
75604
+ getExports(requestParameters = {}, options) {
75605
+ return localVarFp.getExports(requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
75606
+ },
75607
+ };
75608
+ };
75609
+ /**
75610
+ * ExportsApi - object-oriented interface
75611
+ */
75612
+ export class ExportsApi extends BaseAPI {
75613
+ /**
75614
+ * Returns the status, message and download link of a single data export job by its ID; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
75615
+ * @summary Get a single export
75616
+ * @param {ExportsApiGetExportRequest} requestParameters Request parameters.
75617
+ * @param {*} [options] Override http request option.
75618
+ * @throws {RequiredError}
75619
+ */
75620
+ getExport(requestParameters, options) {
75621
+ return ExportsApiFp(this.configuration).getExport(requestParameters.exportId, options).then((request) => request(this.axios, this.basePath));
75622
+ }
75623
+ /**
75624
+ * Returns a paginated list of the organization\'s data export jobs, newest first, optionally filtered by status and searchable by export type; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
75625
+ * @summary List data exports
75626
+ * @param {ExportsApiGetExportsRequest} requestParameters Request parameters.
75627
+ * @param {*} [options] Override http request option.
75628
+ * @throws {RequiredError}
75629
+ */
75630
+ getExports(requestParameters = {}, options) {
75631
+ return ExportsApiFp(this.configuration).getExports(requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
75632
+ }
75633
+ }
75438
75634
  /**
75439
75635
  * FilesApi - axios parameter creator
75440
75636
  */
@@ -2,7 +2,7 @@
2
2
  * Connected Admin API
3
3
  * The Admin API allows you to manage your Connected community programmatically.
4
4
  *
5
- * The version of the OpenAPI document: 13.2.0
5
+ * The version of the OpenAPI document: 13.3.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/base.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Connected Admin API
5
5
  * The Admin API allows you to manage your Connected community programmatically.
6
6
  *
7
- * The version of the OpenAPI document: 13.2.0
7
+ * The version of the OpenAPI document: 13.3.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Connected Admin API
3
3
  * The Admin API allows you to manage your Connected community programmatically.
4
4
  *
5
- * The version of the OpenAPI document: 13.2.0
5
+ * The version of the OpenAPI document: 13.3.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Connected Admin API
5
5
  * The Admin API allows you to manage your Connected community programmatically.
6
6
  *
7
- * The version of the OpenAPI document: 13.2.0
7
+ * The version of the OpenAPI document: 13.3.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Connected Admin API
3
3
  * The Admin API allows you to manage your Connected community programmatically.
4
4
  *
5
- * The version of the OpenAPI document: 13.2.0
5
+ * The version of the OpenAPI document: 13.3.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -3,7 +3,7 @@
3
3
  * Connected Admin API
4
4
  * The Admin API allows you to manage your Connected community programmatically.
5
5
  *
6
- * The version of the OpenAPI document: 13.2.0
6
+ * The version of the OpenAPI document: 13.3.0
7
7
  *
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -0,0 +1,38 @@
1
+ # BaseExport
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | | [default to undefined]
9
+ **type** | **string** | | [default to undefined]
10
+ **status** | [**ExportStatus**](ExportStatus.md) | | [default to undefined]
11
+ **message** | **string** | | [default to undefined]
12
+ **eventId** | **string** | | [default to undefined]
13
+ **userId** | **string** | | [default to undefined]
14
+ **expiration** | **string** | | [default to undefined]
15
+ **downloadUrl** | **string** | | [default to undefined]
16
+ **createdAt** | **string** | | [default to undefined]
17
+ **updatedAt** | **string** | | [default to undefined]
18
+
19
+ ## Example
20
+
21
+ ```typescript
22
+ import { BaseExport } from '@connectedxm/admin-sdk';
23
+
24
+ const instance: BaseExport = {
25
+ id,
26
+ type,
27
+ status,
28
+ message,
29
+ eventId,
30
+ userId,
31
+ expiration,
32
+ downloadUrl,
33
+ createdAt,
34
+ updatedAt,
35
+ };
36
+ ```
37
+
38
+ [[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/Export.md ADDED
@@ -0,0 +1,40 @@
1
+ # Export
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | | [default to undefined]
9
+ **type** | **string** | | [default to undefined]
10
+ **status** | [**ExportStatus**](ExportStatus.md) | | [default to undefined]
11
+ **message** | **string** | | [default to undefined]
12
+ **eventId** | **string** | | [default to undefined]
13
+ **userId** | **string** | | [default to undefined]
14
+ **expiration** | **string** | | [default to undefined]
15
+ **downloadUrl** | **string** | | [default to undefined]
16
+ **createdAt** | **string** | | [default to undefined]
17
+ **updatedAt** | **string** | | [default to undefined]
18
+ **user** | [**BaseUser**](BaseUser.md) | | [default to undefined]
19
+
20
+ ## Example
21
+
22
+ ```typescript
23
+ import { Export } from '@connectedxm/admin-sdk';
24
+
25
+ const instance: Export = {
26
+ id,
27
+ type,
28
+ status,
29
+ message,
30
+ eventId,
31
+ userId,
32
+ expiration,
33
+ downloadUrl,
34
+ createdAt,
35
+ updatedAt,
36
+ user,
37
+ };
38
+ ```
39
+
40
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)