@connectedxm/admin-sdk 13.1.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.
- package/.openapi-generator/FILES +9 -0
- package/AdminApi.ts +3 -0
- package/README.md +2 -2
- package/api.ts +510 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/AdminApi.d.ts +2 -1
- package/dist/AdminApi.js +1 -0
- package/dist/api.d.ts +283 -1
- package/dist/api.js +383 -29
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/AdminApi.d.ts +2 -1
- package/dist/esm/AdminApi.js +2 -1
- package/dist/esm/api.d.ts +283 -1
- package/dist/esm/api.js +351 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/docs/BaseExport.md +38 -0
- package/docs/BaseReportExport.md +22 -0
- package/docs/DownloadReport200Response.md +24 -0
- package/docs/Export.md +40 -0
- package/docs/ExportsApi.md +123 -0
- package/docs/GetExport200Response.md +24 -0
- package/docs/GetExports200Response.md +26 -0
- package/docs/GetReportExport200Response.md +24 -0
- package/docs/ReportExport.md +32 -0
- package/docs/ReportsApi.md +108 -0
- package/package.json +1 -1
package/dist/AdminApi.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* const accounts = await adminApi.accounts.getAccounts();
|
|
10
10
|
* const eventsPasses = await adminApi.eventsPasses.getEventPasses();
|
|
11
11
|
*/
|
|
12
|
-
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";
|
|
12
|
+
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";
|
|
13
13
|
export interface AdminApiConfig {
|
|
14
14
|
/** Your API key for authentication */
|
|
15
15
|
apiKey: string;
|
|
@@ -136,6 +136,7 @@ export declare class AdminApi {
|
|
|
136
136
|
readonly eventsTracksTranslations: EventsTracksTranslationsApi;
|
|
137
137
|
readonly eventsTransfers: EventsTransfersApi;
|
|
138
138
|
readonly eventsTranslations: EventsTranslationsApi;
|
|
139
|
+
readonly exports: ExportsApi;
|
|
139
140
|
readonly files: FilesApi;
|
|
140
141
|
readonly groups: GroupsApi;
|
|
141
142
|
readonly groupsEvents: GroupsEventsApi;
|
package/dist/AdminApi.js
CHANGED
|
@@ -144,6 +144,7 @@ class AdminApi {
|
|
|
144
144
|
this.eventsTracksTranslations = new api_1.EventsTracksTranslationsApi(this.config);
|
|
145
145
|
this.eventsTransfers = new api_1.EventsTransfersApi(this.config);
|
|
146
146
|
this.eventsTranslations = new api_1.EventsTranslationsApi(this.config);
|
|
147
|
+
this.exports = new api_1.ExportsApi(this.config);
|
|
147
148
|
this.files = new api_1.FilesApi(this.config);
|
|
148
149
|
this.groups = new api_1.GroupsApi(this.config);
|
|
149
150
|
this.groupsEvents = new api_1.GroupsEventsApi(this.config);
|
package/dist/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.
|
|
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;
|
|
@@ -2580,6 +2592,10 @@ export interface BaseRegistrationSectionQuestion {
|
|
|
2580
2592
|
'question': BaseRegistrationQuestion;
|
|
2581
2593
|
'sortOrder': number;
|
|
2582
2594
|
}
|
|
2595
|
+
export interface BaseReportExport {
|
|
2596
|
+
'id': string;
|
|
2597
|
+
'status': ExportStatus;
|
|
2598
|
+
}
|
|
2583
2599
|
export interface BaseRoom {
|
|
2584
2600
|
'id': string;
|
|
2585
2601
|
'roomName': string;
|
|
@@ -4872,6 +4888,14 @@ export interface DenyEventPassRequest {
|
|
|
4872
4888
|
export interface DomainDetails {
|
|
4873
4889
|
'name': string;
|
|
4874
4890
|
}
|
|
4891
|
+
export interface DownloadReport200Response {
|
|
4892
|
+
'status': DownloadReport200ResponseStatusEnum;
|
|
4893
|
+
'message': string;
|
|
4894
|
+
'data': BaseReportExport;
|
|
4895
|
+
}
|
|
4896
|
+
export declare enum DownloadReport200ResponseStatusEnum {
|
|
4897
|
+
Ok = "ok"
|
|
4898
|
+
}
|
|
4875
4899
|
export declare enum EmailCodeAuth {
|
|
4876
4900
|
Disabled = "disabled",
|
|
4877
4901
|
Optional = "optional",
|
|
@@ -6869,6 +6893,19 @@ export declare enum ExchangeType {
|
|
|
6869
6893
|
Downgrade = "downgrade",
|
|
6870
6894
|
Swap = "swap"
|
|
6871
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
|
+
}
|
|
6872
6909
|
export declare enum ExportStatus {
|
|
6873
6910
|
Pending = "pending",
|
|
6874
6911
|
Resolved = "resolved",
|
|
@@ -8753,6 +8790,23 @@ export interface GetEvents200Response {
|
|
|
8753
8790
|
export declare enum GetEvents200ResponseStatusEnum {
|
|
8754
8791
|
Ok = "ok"
|
|
8755
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
|
+
}
|
|
8756
8810
|
export interface GetFiles200Response {
|
|
8757
8811
|
'status': GetFiles200ResponseStatusEnum;
|
|
8758
8812
|
'message': string;
|
|
@@ -9335,6 +9389,14 @@ export interface GetReport200Response {
|
|
|
9335
9389
|
export declare enum GetReport200ResponseStatusEnum {
|
|
9336
9390
|
Ok = "ok"
|
|
9337
9391
|
}
|
|
9392
|
+
export interface GetReportExport200Response {
|
|
9393
|
+
'status': GetReportExport200ResponseStatusEnum;
|
|
9394
|
+
'message': string;
|
|
9395
|
+
'data': ReportExport;
|
|
9396
|
+
}
|
|
9397
|
+
export declare enum GetReportExport200ResponseStatusEnum {
|
|
9398
|
+
Ok = "ok"
|
|
9399
|
+
}
|
|
9338
9400
|
export interface GetReports200Response {
|
|
9339
9401
|
'status': GetReports200ResponseStatusEnum;
|
|
9340
9402
|
'message': string;
|
|
@@ -12354,6 +12416,15 @@ export interface ReorderSurveySectionQuestions200Response {
|
|
|
12354
12416
|
export declare enum ReorderSurveySectionQuestions200ResponseStatusEnum {
|
|
12355
12417
|
Ok = "ok"
|
|
12356
12418
|
}
|
|
12419
|
+
export interface ReportExport {
|
|
12420
|
+
'id': string;
|
|
12421
|
+
'status': ExportStatus;
|
|
12422
|
+
'standard': string;
|
|
12423
|
+
'message': string | null;
|
|
12424
|
+
'downloadUrl': string | null;
|
|
12425
|
+
'expiration': string | null;
|
|
12426
|
+
'createdAt': string;
|
|
12427
|
+
}
|
|
12357
12428
|
export interface ReportFilters {
|
|
12358
12429
|
'eventId'?: string;
|
|
12359
12430
|
'placeId'?: string;
|
|
@@ -62937,6 +63008,132 @@ export declare class EventsTranslationsApi extends BaseAPI {
|
|
|
62937
63008
|
*/
|
|
62938
63009
|
updateEventTranslation(requestParameters: EventsTranslationsApiUpdateEventTranslationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SyncAccounts200Response, any, {}, any>>;
|
|
62939
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
|
+
}
|
|
62940
63137
|
/**
|
|
62941
63138
|
* FilesApi - axios parameter creator
|
|
62942
63139
|
*/
|
|
@@ -75182,6 +75379,15 @@ export declare const ReportsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
75182
75379
|
* @throws {RequiredError}
|
|
75183
75380
|
*/
|
|
75184
75381
|
deleteCustomReportSchedule: (reportId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
75382
|
+
/**
|
|
75383
|
+
* Starts an asynchronous server-side build of every row and column of a standard report and returns a pending export; poll the export by ID until it resolves with a signed CSV download link valid for 24 hours. Requires read permission on the reports resource plus the domain permissions declared by the standard report.
|
|
75384
|
+
* @summary Build a standard report as a downloadable CSV
|
|
75385
|
+
* @param {string} standard The standard identifier
|
|
75386
|
+
* @param {ReportFilters} reportFilters
|
|
75387
|
+
* @param {*} [options] Override http request option.
|
|
75388
|
+
* @throws {RequiredError}
|
|
75389
|
+
*/
|
|
75390
|
+
downloadReport: (standard: string, reportFilters: ReportFilters, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
75185
75391
|
/**
|
|
75186
75392
|
* Kicks off an asynchronous export of a custom report\'s data, optionally emailing the resulting file to a specified address in addition to the requesting user, and requires read permission on the reports domain plus any domains associated with the report\'s standard type.
|
|
75187
75393
|
* @summary Export a custom report
|
|
@@ -75248,6 +75454,14 @@ export declare const ReportsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
75248
75454
|
* @throws {RequiredError}
|
|
75249
75455
|
*/
|
|
75250
75456
|
getReport: (standard: string, eventId?: string, placeId?: string, groupId?: string, channelId?: string, accountId?: string, surveyId?: string, sessionId?: string, seriesId?: string, spaceId?: string, entityId?: string, since?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
75457
|
+
/**
|
|
75458
|
+
* Retrieves a report download started with DownloadReport: its status (pending, resolved or failed), the signed CSV download link and its expiration once resolved, or the reason it failed. Requires read permission on the reports resource plus the domain permissions declared by the standard report.
|
|
75459
|
+
* @summary Get the status of a report download
|
|
75460
|
+
* @param {string} exportId The export identifier
|
|
75461
|
+
* @param {*} [options] Override http request option.
|
|
75462
|
+
* @throws {RequiredError}
|
|
75463
|
+
*/
|
|
75464
|
+
getReportExport: (exportId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
75251
75465
|
/**
|
|
75252
75466
|
* Returns the list of standard reports available to the organization, filtered by report type and further filtered to only those reports whose required permission domains the caller can read; requires the `read:reports` permission.
|
|
75253
75467
|
* @summary List available standard reports
|
|
@@ -75304,6 +75518,15 @@ export declare const ReportsApiFp: (configuration?: Configuration) => {
|
|
|
75304
75518
|
* @throws {RequiredError}
|
|
75305
75519
|
*/
|
|
75306
75520
|
deleteCustomReportSchedule(reportId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCustomReportSchedule200Response>>;
|
|
75521
|
+
/**
|
|
75522
|
+
* Starts an asynchronous server-side build of every row and column of a standard report and returns a pending export; poll the export by ID until it resolves with a signed CSV download link valid for 24 hours. Requires read permission on the reports resource plus the domain permissions declared by the standard report.
|
|
75523
|
+
* @summary Build a standard report as a downloadable CSV
|
|
75524
|
+
* @param {string} standard The standard identifier
|
|
75525
|
+
* @param {ReportFilters} reportFilters
|
|
75526
|
+
* @param {*} [options] Override http request option.
|
|
75527
|
+
* @throws {RequiredError}
|
|
75528
|
+
*/
|
|
75529
|
+
downloadReport(standard: string, reportFilters: ReportFilters, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DownloadReport200Response>>;
|
|
75307
75530
|
/**
|
|
75308
75531
|
* Kicks off an asynchronous export of a custom report\'s data, optionally emailing the resulting file to a specified address in addition to the requesting user, and requires read permission on the reports domain plus any domains associated with the report\'s standard type.
|
|
75309
75532
|
* @summary Export a custom report
|
|
@@ -75370,6 +75593,14 @@ export declare const ReportsApiFp: (configuration?: Configuration) => {
|
|
|
75370
75593
|
* @throws {RequiredError}
|
|
75371
75594
|
*/
|
|
75372
75595
|
getReport(standard: string, eventId?: string, placeId?: string, groupId?: string, channelId?: string, accountId?: string, surveyId?: string, sessionId?: string, seriesId?: string, spaceId?: string, entityId?: string, since?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetReport200Response>>;
|
|
75596
|
+
/**
|
|
75597
|
+
* Retrieves a report download started with DownloadReport: its status (pending, resolved or failed), the signed CSV download link and its expiration once resolved, or the reason it failed. Requires read permission on the reports resource plus the domain permissions declared by the standard report.
|
|
75598
|
+
* @summary Get the status of a report download
|
|
75599
|
+
* @param {string} exportId The export identifier
|
|
75600
|
+
* @param {*} [options] Override http request option.
|
|
75601
|
+
* @throws {RequiredError}
|
|
75602
|
+
*/
|
|
75603
|
+
getReportExport(exportId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetReportExport200Response>>;
|
|
75373
75604
|
/**
|
|
75374
75605
|
* Returns the list of standard reports available to the organization, filtered by report type and further filtered to only those reports whose required permission domains the caller can read; requires the `read:reports` permission.
|
|
75375
75606
|
* @summary List available standard reports
|
|
@@ -75425,6 +75656,14 @@ export declare const ReportsApiFactory: (configuration?: Configuration, basePath
|
|
|
75425
75656
|
* @throws {RequiredError}
|
|
75426
75657
|
*/
|
|
75427
75658
|
deleteCustomReportSchedule(requestParameters: ReportsApiDeleteCustomReportScheduleRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetCustomReportSchedule200Response>;
|
|
75659
|
+
/**
|
|
75660
|
+
* Starts an asynchronous server-side build of every row and column of a standard report and returns a pending export; poll the export by ID until it resolves with a signed CSV download link valid for 24 hours. Requires read permission on the reports resource plus the domain permissions declared by the standard report.
|
|
75661
|
+
* @summary Build a standard report as a downloadable CSV
|
|
75662
|
+
* @param {ReportsApiDownloadReportRequest} requestParameters Request parameters.
|
|
75663
|
+
* @param {*} [options] Override http request option.
|
|
75664
|
+
* @throws {RequiredError}
|
|
75665
|
+
*/
|
|
75666
|
+
downloadReport(requestParameters: ReportsApiDownloadReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<DownloadReport200Response>;
|
|
75428
75667
|
/**
|
|
75429
75668
|
* Kicks off an asynchronous export of a custom report\'s data, optionally emailing the resulting file to a specified address in addition to the requesting user, and requires read permission on the reports domain plus any domains associated with the report\'s standard type.
|
|
75430
75669
|
* @summary Export a custom report
|
|
@@ -75465,6 +75704,14 @@ export declare const ReportsApiFactory: (configuration?: Configuration, basePath
|
|
|
75465
75704
|
* @throws {RequiredError}
|
|
75466
75705
|
*/
|
|
75467
75706
|
getReport(requestParameters: ReportsApiGetReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetReport200Response>;
|
|
75707
|
+
/**
|
|
75708
|
+
* Retrieves a report download started with DownloadReport: its status (pending, resolved or failed), the signed CSV download link and its expiration once resolved, or the reason it failed. Requires read permission on the reports resource plus the domain permissions declared by the standard report.
|
|
75709
|
+
* @summary Get the status of a report download
|
|
75710
|
+
* @param {ReportsApiGetReportExportRequest} requestParameters Request parameters.
|
|
75711
|
+
* @param {*} [options] Override http request option.
|
|
75712
|
+
* @throws {RequiredError}
|
|
75713
|
+
*/
|
|
75714
|
+
getReportExport(requestParameters: ReportsApiGetReportExportRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetReportExport200Response>;
|
|
75468
75715
|
/**
|
|
75469
75716
|
* Returns the list of standard reports available to the organization, filtered by report type and further filtered to only those reports whose required permission domains the caller can read; requires the `read:reports` permission.
|
|
75470
75717
|
* @summary List available standard reports
|
|
@@ -75518,6 +75765,16 @@ export interface ReportsApiDeleteCustomReportScheduleRequest {
|
|
|
75518
75765
|
*/
|
|
75519
75766
|
readonly reportId: string;
|
|
75520
75767
|
}
|
|
75768
|
+
/**
|
|
75769
|
+
* Request parameters for downloadReport operation in ReportsApi.
|
|
75770
|
+
*/
|
|
75771
|
+
export interface ReportsApiDownloadReportRequest {
|
|
75772
|
+
/**
|
|
75773
|
+
* The standard identifier
|
|
75774
|
+
*/
|
|
75775
|
+
readonly standard: string;
|
|
75776
|
+
readonly reportFilters: ReportFilters;
|
|
75777
|
+
}
|
|
75521
75778
|
/**
|
|
75522
75779
|
* Request parameters for exportCustomReport operation in ReportsApi.
|
|
75523
75780
|
*/
|
|
@@ -75664,6 +75921,15 @@ export interface ReportsApiGetReportRequest {
|
|
|
75664
75921
|
*/
|
|
75665
75922
|
readonly since?: string;
|
|
75666
75923
|
}
|
|
75924
|
+
/**
|
|
75925
|
+
* Request parameters for getReportExport operation in ReportsApi.
|
|
75926
|
+
*/
|
|
75927
|
+
export interface ReportsApiGetReportExportRequest {
|
|
75928
|
+
/**
|
|
75929
|
+
* The export identifier
|
|
75930
|
+
*/
|
|
75931
|
+
readonly exportId: string;
|
|
75932
|
+
}
|
|
75667
75933
|
/**
|
|
75668
75934
|
* Request parameters for getReports operation in ReportsApi.
|
|
75669
75935
|
*/
|
|
@@ -75721,6 +75987,14 @@ export declare class ReportsApi extends BaseAPI {
|
|
|
75721
75987
|
* @throws {RequiredError}
|
|
75722
75988
|
*/
|
|
75723
75989
|
deleteCustomReportSchedule(requestParameters: ReportsApiDeleteCustomReportScheduleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCustomReportSchedule200Response, any, {}, any>>;
|
|
75990
|
+
/**
|
|
75991
|
+
* Starts an asynchronous server-side build of every row and column of a standard report and returns a pending export; poll the export by ID until it resolves with a signed CSV download link valid for 24 hours. Requires read permission on the reports resource plus the domain permissions declared by the standard report.
|
|
75992
|
+
* @summary Build a standard report as a downloadable CSV
|
|
75993
|
+
* @param {ReportsApiDownloadReportRequest} requestParameters Request parameters.
|
|
75994
|
+
* @param {*} [options] Override http request option.
|
|
75995
|
+
* @throws {RequiredError}
|
|
75996
|
+
*/
|
|
75997
|
+
downloadReport(requestParameters: ReportsApiDownloadReportRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DownloadReport200Response, any, {}, any>>;
|
|
75724
75998
|
/**
|
|
75725
75999
|
* Kicks off an asynchronous export of a custom report\'s data, optionally emailing the resulting file to a specified address in addition to the requesting user, and requires read permission on the reports domain plus any domains associated with the report\'s standard type.
|
|
75726
76000
|
* @summary Export a custom report
|
|
@@ -75761,6 +76035,14 @@ export declare class ReportsApi extends BaseAPI {
|
|
|
75761
76035
|
* @throws {RequiredError}
|
|
75762
76036
|
*/
|
|
75763
76037
|
getReport(requestParameters: ReportsApiGetReportRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetReport200Response, any, {}, any>>;
|
|
76038
|
+
/**
|
|
76039
|
+
* Retrieves a report download started with DownloadReport: its status (pending, resolved or failed), the signed CSV download link and its expiration once resolved, or the reason it failed. Requires read permission on the reports resource plus the domain permissions declared by the standard report.
|
|
76040
|
+
* @summary Get the status of a report download
|
|
76041
|
+
* @param {ReportsApiGetReportExportRequest} requestParameters Request parameters.
|
|
76042
|
+
* @param {*} [options] Override http request option.
|
|
76043
|
+
* @throws {RequiredError}
|
|
76044
|
+
*/
|
|
76045
|
+
getReportExport(requestParameters: ReportsApiGetReportExportRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetReportExport200Response, any, {}, any>>;
|
|
75764
76046
|
/**
|
|
75765
76047
|
* Returns the list of standard reports available to the organization, filtered by report type and further filtered to only those reports whose required permission domains the caller can read; requires the `read:reports` permission.
|
|
75766
76048
|
* @summary List available standard reports
|