@connectedxm/admin-sdk 10.20.1 → 10.21.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 +3 -0
- package/README.md +2 -2
- package/api.ts +319 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +178 -1
- package/dist/api.js +224 -25
- 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/api.d.ts +178 -1
- package/dist/esm/api.js +200 -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/Activity.md +2 -0
- package/docs/ActivityCreateInputs.md +2 -0
- package/docs/BaseActivity.md +2 -0
- package/docs/BaseEventMediaItem.md +2 -0
- package/docs/BaseEventMediaItemLike.md +24 -0
- package/docs/EventMediaItem.md +2 -0
- package/docs/EventMediaItemCreateInputs.md +2 -0
- package/docs/EventMediaItemLike.md +30 -0
- package/docs/EventMediaItemUpdateInputs.md +2 -0
- package/docs/EventsMediaApi.md +137 -0
- package/docs/GetEventMediaItemLikes200Response.md +26 -0
- package/package.json +1 -1
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: 10.
|
|
5
|
+
* The version of the OpenAPI document: 10.21.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -304,6 +304,7 @@ export interface Activity {
|
|
|
304
304
|
'eventId': string | null;
|
|
305
305
|
'groupId': string | null;
|
|
306
306
|
'contentId': string | null;
|
|
307
|
+
'eventMediaItemId': string | null;
|
|
307
308
|
'createdAt': string;
|
|
308
309
|
'updatedAt': string;
|
|
309
310
|
'_count': BaseActivityCount;
|
|
@@ -326,6 +327,7 @@ export interface ActivityCreateInputs {
|
|
|
326
327
|
'eventId'?: string | null;
|
|
327
328
|
'groupId'?: string | null;
|
|
328
329
|
'contentId'?: string | null;
|
|
330
|
+
'eventMediaItemId'?: string | null;
|
|
329
331
|
'commentedId'?: string | null;
|
|
330
332
|
'meetingId'?: string | null;
|
|
331
333
|
'createdAt'?: string | null;
|
|
@@ -806,6 +808,7 @@ export interface BaseActivity {
|
|
|
806
808
|
'eventId': string | null;
|
|
807
809
|
'groupId': string | null;
|
|
808
810
|
'contentId': string | null;
|
|
811
|
+
'eventMediaItemId': string | null;
|
|
809
812
|
'createdAt': string;
|
|
810
813
|
'updatedAt': string;
|
|
811
814
|
'_count': BaseActivityCount;
|
|
@@ -1259,6 +1262,12 @@ export interface BaseEventMediaItem {
|
|
|
1259
1262
|
'fileId': string | null;
|
|
1260
1263
|
'file': BaseFile | null;
|
|
1261
1264
|
'sortOrder': number;
|
|
1265
|
+
'mediaInteractionsEnabled': boolean;
|
|
1266
|
+
}
|
|
1267
|
+
export interface BaseEventMediaItemLike {
|
|
1268
|
+
'accountId': string;
|
|
1269
|
+
'eventId': string;
|
|
1270
|
+
'eventMediaItemId': string;
|
|
1262
1271
|
}
|
|
1263
1272
|
export interface BaseEventOnSite {
|
|
1264
1273
|
'eventId': string;
|
|
@@ -5028,6 +5037,7 @@ export interface EventMediaItem {
|
|
|
5028
5037
|
'fileId': string | null;
|
|
5029
5038
|
'file': BaseFile | null;
|
|
5030
5039
|
'sortOrder': number;
|
|
5040
|
+
'mediaInteractionsEnabled': boolean;
|
|
5031
5041
|
'allowedPassTypes': Array<BaseEventPassType>;
|
|
5032
5042
|
'allowedTiers': Array<BaseTier>;
|
|
5033
5043
|
'createdAt': string;
|
|
@@ -5040,6 +5050,15 @@ export interface EventMediaItemCreateInputs {
|
|
|
5040
5050
|
'imageId'?: string | null;
|
|
5041
5051
|
'videoId'?: string | null;
|
|
5042
5052
|
'fileId'?: string | null;
|
|
5053
|
+
'mediaInteractionsEnabled'?: boolean;
|
|
5054
|
+
}
|
|
5055
|
+
export interface EventMediaItemLike {
|
|
5056
|
+
'accountId': string;
|
|
5057
|
+
'eventId': string;
|
|
5058
|
+
'eventMediaItemId': string;
|
|
5059
|
+
'account': BaseAccount;
|
|
5060
|
+
'createdAt': string;
|
|
5061
|
+
'updatedAt': string;
|
|
5043
5062
|
}
|
|
5044
5063
|
export interface EventMediaItemTranslation {
|
|
5045
5064
|
'id': string;
|
|
@@ -5057,6 +5076,7 @@ export interface EventMediaItemUpdateInputs {
|
|
|
5057
5076
|
'name'?: string | null;
|
|
5058
5077
|
'description'?: string | null;
|
|
5059
5078
|
'sortOrder'?: number | null;
|
|
5079
|
+
'mediaInteractionsEnabled'?: boolean;
|
|
5060
5080
|
}
|
|
5061
5081
|
export interface EventOnSite {
|
|
5062
5082
|
'eventId': string;
|
|
@@ -7387,6 +7407,15 @@ export interface GetEventFollowups200Response {
|
|
|
7387
7407
|
export declare enum GetEventFollowups200ResponseStatusEnum {
|
|
7388
7408
|
Ok = "ok"
|
|
7389
7409
|
}
|
|
7410
|
+
export interface GetEventMediaItemLikes200Response {
|
|
7411
|
+
'status': GetEventMediaItemLikes200ResponseStatusEnum;
|
|
7412
|
+
'message': string;
|
|
7413
|
+
'data': Array<EventMediaItemLike>;
|
|
7414
|
+
'count'?: number;
|
|
7415
|
+
}
|
|
7416
|
+
export declare enum GetEventMediaItemLikes200ResponseStatusEnum {
|
|
7417
|
+
Ok = "ok"
|
|
7418
|
+
}
|
|
7390
7419
|
export interface GetEventMediaItemTranslation200Response {
|
|
7391
7420
|
'status': GetEventMediaItemTranslation200ResponseStatusEnum;
|
|
7392
7421
|
'message': string;
|
|
@@ -34345,6 +34374,33 @@ export declare const EventsMediaApiAxiosParamCreator: (configuration?: Configura
|
|
|
34345
34374
|
* @throws {RequiredError}
|
|
34346
34375
|
*/
|
|
34347
34376
|
getEventMediaItem: (eventId: string, itemId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
34377
|
+
/**
|
|
34378
|
+
* Returns a paginated list of activity records posted on a specific event media item, optionally filtered by activity status and search term, requiring read permission on events, storage, and activities.
|
|
34379
|
+
* @summary List a media item\'s activity feed
|
|
34380
|
+
* @param {string} eventId The event identifier
|
|
34381
|
+
* @param {string} mediaItemId The mediaItem identifier
|
|
34382
|
+
* @param {ActivityStatus} [status] Filter by status
|
|
34383
|
+
* @param {number} [page] Page number
|
|
34384
|
+
* @param {number} [pageSize] Number of items per page
|
|
34385
|
+
* @param {string} [orderBy] Field to order by
|
|
34386
|
+
* @param {string} [search] Search query
|
|
34387
|
+
* @param {*} [options] Override http request option.
|
|
34388
|
+
* @throws {RequiredError}
|
|
34389
|
+
*/
|
|
34390
|
+
getEventMediaItemActivities: (eventId: string, mediaItemId: string, status?: ActivityStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
34391
|
+
/**
|
|
34392
|
+
* Returns a paginated list of accounts that liked a specific event media item, optionally filtered by search term and sort order, requiring read permission on events and storage.
|
|
34393
|
+
* @summary List a media item\'s likes
|
|
34394
|
+
* @param {string} eventId The event identifier
|
|
34395
|
+
* @param {string} mediaItemId The mediaItem identifier
|
|
34396
|
+
* @param {number} [page] Page number
|
|
34397
|
+
* @param {number} [pageSize] Number of items per page
|
|
34398
|
+
* @param {string} [orderBy] Field to order by
|
|
34399
|
+
* @param {string} [search] Search query
|
|
34400
|
+
* @param {*} [options] Override http request option.
|
|
34401
|
+
* @throws {RequiredError}
|
|
34402
|
+
*/
|
|
34403
|
+
getEventMediaItemLikes: (eventId: string, mediaItemId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
34348
34404
|
/**
|
|
34349
34405
|
* Returns a paginated list of the event\'s pass types (ticket types) that are associated with a given media item, supporting search and ordering; requires read access to events and storage.
|
|
34350
34406
|
* @summary List pass types linked to a media item
|
|
@@ -34466,6 +34522,33 @@ export declare const EventsMediaApiFp: (configuration?: Configuration) => {
|
|
|
34466
34522
|
* @throws {RequiredError}
|
|
34467
34523
|
*/
|
|
34468
34524
|
getEventMediaItem(eventId: string, itemId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateEventMediaItem200Response>>;
|
|
34525
|
+
/**
|
|
34526
|
+
* Returns a paginated list of activity records posted on a specific event media item, optionally filtered by activity status and search term, requiring read permission on events, storage, and activities.
|
|
34527
|
+
* @summary List a media item\'s activity feed
|
|
34528
|
+
* @param {string} eventId The event identifier
|
|
34529
|
+
* @param {string} mediaItemId The mediaItem identifier
|
|
34530
|
+
* @param {ActivityStatus} [status] Filter by status
|
|
34531
|
+
* @param {number} [page] Page number
|
|
34532
|
+
* @param {number} [pageSize] Number of items per page
|
|
34533
|
+
* @param {string} [orderBy] Field to order by
|
|
34534
|
+
* @param {string} [search] Search query
|
|
34535
|
+
* @param {*} [options] Override http request option.
|
|
34536
|
+
* @throws {RequiredError}
|
|
34537
|
+
*/
|
|
34538
|
+
getEventMediaItemActivities(eventId: string, mediaItemId: string, status?: ActivityStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountActivities200Response>>;
|
|
34539
|
+
/**
|
|
34540
|
+
* Returns a paginated list of accounts that liked a specific event media item, optionally filtered by search term and sort order, requiring read permission on events and storage.
|
|
34541
|
+
* @summary List a media item\'s likes
|
|
34542
|
+
* @param {string} eventId The event identifier
|
|
34543
|
+
* @param {string} mediaItemId The mediaItem identifier
|
|
34544
|
+
* @param {number} [page] Page number
|
|
34545
|
+
* @param {number} [pageSize] Number of items per page
|
|
34546
|
+
* @param {string} [orderBy] Field to order by
|
|
34547
|
+
* @param {string} [search] Search query
|
|
34548
|
+
* @param {*} [options] Override http request option.
|
|
34549
|
+
* @throws {RequiredError}
|
|
34550
|
+
*/
|
|
34551
|
+
getEventMediaItemLikes(eventId: string, mediaItemId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEventMediaItemLikes200Response>>;
|
|
34469
34552
|
/**
|
|
34470
34553
|
* Returns a paginated list of the event\'s pass types (ticket types) that are associated with a given media item, supporting search and ordering; requires read access to events and storage.
|
|
34471
34554
|
* @summary List pass types linked to a media item
|
|
@@ -34580,6 +34663,22 @@ export declare const EventsMediaApiFactory: (configuration?: Configuration, base
|
|
|
34580
34663
|
* @throws {RequiredError}
|
|
34581
34664
|
*/
|
|
34582
34665
|
getEventMediaItem(requestParameters: EventsMediaApiGetEventMediaItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateEventMediaItem200Response>;
|
|
34666
|
+
/**
|
|
34667
|
+
* Returns a paginated list of activity records posted on a specific event media item, optionally filtered by activity status and search term, requiring read permission on events, storage, and activities.
|
|
34668
|
+
* @summary List a media item\'s activity feed
|
|
34669
|
+
* @param {EventsMediaApiGetEventMediaItemActivitiesRequest} requestParameters Request parameters.
|
|
34670
|
+
* @param {*} [options] Override http request option.
|
|
34671
|
+
* @throws {RequiredError}
|
|
34672
|
+
*/
|
|
34673
|
+
getEventMediaItemActivities(requestParameters: EventsMediaApiGetEventMediaItemActivitiesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountActivities200Response>;
|
|
34674
|
+
/**
|
|
34675
|
+
* Returns a paginated list of accounts that liked a specific event media item, optionally filtered by search term and sort order, requiring read permission on events and storage.
|
|
34676
|
+
* @summary List a media item\'s likes
|
|
34677
|
+
* @param {EventsMediaApiGetEventMediaItemLikesRequest} requestParameters Request parameters.
|
|
34678
|
+
* @param {*} [options] Override http request option.
|
|
34679
|
+
* @throws {RequiredError}
|
|
34680
|
+
*/
|
|
34681
|
+
getEventMediaItemLikes(requestParameters: EventsMediaApiGetEventMediaItemLikesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetEventMediaItemLikes200Response>;
|
|
34583
34682
|
/**
|
|
34584
34683
|
* Returns a paginated list of the event\'s pass types (ticket types) that are associated with a given media item, supporting search and ordering; requires read access to events and storage.
|
|
34585
34684
|
* @summary List pass types linked to a media item
|
|
@@ -34699,6 +34798,68 @@ export interface EventsMediaApiGetEventMediaItemRequest {
|
|
|
34699
34798
|
*/
|
|
34700
34799
|
readonly itemId: string;
|
|
34701
34800
|
}
|
|
34801
|
+
/**
|
|
34802
|
+
* Request parameters for getEventMediaItemActivities operation in EventsMediaApi.
|
|
34803
|
+
*/
|
|
34804
|
+
export interface EventsMediaApiGetEventMediaItemActivitiesRequest {
|
|
34805
|
+
/**
|
|
34806
|
+
* The event identifier
|
|
34807
|
+
*/
|
|
34808
|
+
readonly eventId: string;
|
|
34809
|
+
/**
|
|
34810
|
+
* The mediaItem identifier
|
|
34811
|
+
*/
|
|
34812
|
+
readonly mediaItemId: string;
|
|
34813
|
+
/**
|
|
34814
|
+
* Filter by status
|
|
34815
|
+
*/
|
|
34816
|
+
readonly status?: ActivityStatus;
|
|
34817
|
+
/**
|
|
34818
|
+
* Page number
|
|
34819
|
+
*/
|
|
34820
|
+
readonly page?: number;
|
|
34821
|
+
/**
|
|
34822
|
+
* Number of items per page
|
|
34823
|
+
*/
|
|
34824
|
+
readonly pageSize?: number;
|
|
34825
|
+
/**
|
|
34826
|
+
* Field to order by
|
|
34827
|
+
*/
|
|
34828
|
+
readonly orderBy?: string;
|
|
34829
|
+
/**
|
|
34830
|
+
* Search query
|
|
34831
|
+
*/
|
|
34832
|
+
readonly search?: string;
|
|
34833
|
+
}
|
|
34834
|
+
/**
|
|
34835
|
+
* Request parameters for getEventMediaItemLikes operation in EventsMediaApi.
|
|
34836
|
+
*/
|
|
34837
|
+
export interface EventsMediaApiGetEventMediaItemLikesRequest {
|
|
34838
|
+
/**
|
|
34839
|
+
* The event identifier
|
|
34840
|
+
*/
|
|
34841
|
+
readonly eventId: string;
|
|
34842
|
+
/**
|
|
34843
|
+
* The mediaItem identifier
|
|
34844
|
+
*/
|
|
34845
|
+
readonly mediaItemId: string;
|
|
34846
|
+
/**
|
|
34847
|
+
* Page number
|
|
34848
|
+
*/
|
|
34849
|
+
readonly page?: number;
|
|
34850
|
+
/**
|
|
34851
|
+
* Number of items per page
|
|
34852
|
+
*/
|
|
34853
|
+
readonly pageSize?: number;
|
|
34854
|
+
/**
|
|
34855
|
+
* Field to order by
|
|
34856
|
+
*/
|
|
34857
|
+
readonly orderBy?: string;
|
|
34858
|
+
/**
|
|
34859
|
+
* Search query
|
|
34860
|
+
*/
|
|
34861
|
+
readonly search?: string;
|
|
34862
|
+
}
|
|
34702
34863
|
/**
|
|
34703
34864
|
* Request parameters for getEventMediaItemPassTypes operation in EventsMediaApi.
|
|
34704
34865
|
*/
|
|
@@ -34878,6 +35039,22 @@ export declare class EventsMediaApi extends BaseAPI {
|
|
|
34878
35039
|
* @throws {RequiredError}
|
|
34879
35040
|
*/
|
|
34880
35041
|
getEventMediaItem(requestParameters: EventsMediaApiGetEventMediaItemRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateEventMediaItem200Response, any, {}>>;
|
|
35042
|
+
/**
|
|
35043
|
+
* Returns a paginated list of activity records posted on a specific event media item, optionally filtered by activity status and search term, requiring read permission on events, storage, and activities.
|
|
35044
|
+
* @summary List a media item\'s activity feed
|
|
35045
|
+
* @param {EventsMediaApiGetEventMediaItemActivitiesRequest} requestParameters Request parameters.
|
|
35046
|
+
* @param {*} [options] Override http request option.
|
|
35047
|
+
* @throws {RequiredError}
|
|
35048
|
+
*/
|
|
35049
|
+
getEventMediaItemActivities(requestParameters: EventsMediaApiGetEventMediaItemActivitiesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountActivities200Response, any, {}>>;
|
|
35050
|
+
/**
|
|
35051
|
+
* Returns a paginated list of accounts that liked a specific event media item, optionally filtered by search term and sort order, requiring read permission on events and storage.
|
|
35052
|
+
* @summary List a media item\'s likes
|
|
35053
|
+
* @param {EventsMediaApiGetEventMediaItemLikesRequest} requestParameters Request parameters.
|
|
35054
|
+
* @param {*} [options] Override http request option.
|
|
35055
|
+
* @throws {RequiredError}
|
|
35056
|
+
*/
|
|
35057
|
+
getEventMediaItemLikes(requestParameters: EventsMediaApiGetEventMediaItemLikesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventMediaItemLikes200Response, any, {}>>;
|
|
34881
35058
|
/**
|
|
34882
35059
|
* Returns a paginated list of the event\'s pass types (ticket types) that are associated with a given media item, supporting search and ordering; requires read access to events and storage.
|
|
34883
35060
|
* @summary List pass types linked to a media item
|