@connectedxm/admin-sdk 12.0.0 → 12.1.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/README.md +2 -2
- package/api.ts +12 -5
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +12 -5
- package/dist/api.js +5 -5
- 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 +12 -5
- package/dist/esm/api.js +5 -5
- 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/AnnouncementAudience.md +4 -0
- package/docs/AnnouncementAudienceScope.md +2 -0
- package/docs/AnnouncementAudienceUpdateInputs.md +4 -0
- package/docs/AnnouncementsAudiencesApi.md +1 -1
- package/docs/BaseAnnouncementAudience.md +4 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @connectedxm/admin-sdk@12.
|
|
1
|
+
## @connectedxm/admin-sdk@12.1.0
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @connectedxm/admin-sdk@12.
|
|
39
|
+
npm install @connectedxm/admin-sdk@12.1.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
package/api.ts
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: 12.
|
|
7
|
+
* The version of the OpenAPI document: 12.1.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -737,6 +737,8 @@ export interface AnnouncementAudience {
|
|
|
737
737
|
'groupId': string | null;
|
|
738
738
|
'channelId': string | null;
|
|
739
739
|
'operator': AnnouncementAudienceOperator;
|
|
740
|
+
'featured': boolean;
|
|
741
|
+
'archived': boolean;
|
|
740
742
|
'createdAt': string;
|
|
741
743
|
'updatedAt': string;
|
|
742
744
|
'event': AnnouncementAudienceConditionEvent | null;
|
|
@@ -972,11 +974,14 @@ export interface AnnouncementAudienceScope {
|
|
|
972
974
|
'eventId'?: string;
|
|
973
975
|
'groupId'?: string;
|
|
974
976
|
'channelId'?: string;
|
|
977
|
+
'archived'?: boolean;
|
|
975
978
|
}
|
|
976
979
|
export interface AnnouncementAudienceUpdateInputs {
|
|
977
980
|
'name'?: string;
|
|
978
981
|
'description'?: string | null;
|
|
979
982
|
'operator'?: AnnouncementAudienceOperator;
|
|
983
|
+
'featured'?: boolean;
|
|
984
|
+
'archived'?: boolean;
|
|
980
985
|
}
|
|
981
986
|
|
|
982
987
|
|
|
@@ -1338,6 +1343,8 @@ export interface BaseAnnouncementAudience {
|
|
|
1338
1343
|
'groupId': string | null;
|
|
1339
1344
|
'channelId': string | null;
|
|
1340
1345
|
'operator': AnnouncementAudienceOperator;
|
|
1346
|
+
'featured': boolean;
|
|
1347
|
+
'archived': boolean;
|
|
1341
1348
|
'createdAt': string;
|
|
1342
1349
|
'updatedAt': string;
|
|
1343
1350
|
}
|
|
@@ -25549,7 +25556,7 @@ export const AnnouncementsAudiencesApiAxiosParamCreator = function (configuratio
|
|
|
25549
25556
|
};
|
|
25550
25557
|
},
|
|
25551
25558
|
/**
|
|
25552
|
-
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences; requires read permission on announcements.
|
|
25559
|
+
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences. Active audiences by default, starred first; pass archived for the archived ones. requires read permission on announcements.
|
|
25553
25560
|
* @summary List announcement audiences
|
|
25554
25561
|
* @param {AnnouncementAudienceScope} [scope] Filter by scope
|
|
25555
25562
|
* @param {number} [page] Page number
|
|
@@ -25882,7 +25889,7 @@ export const AnnouncementsAudiencesApiFp = function(configuration?: Configuratio
|
|
|
25882
25889
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25883
25890
|
},
|
|
25884
25891
|
/**
|
|
25885
|
-
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences; requires read permission on announcements.
|
|
25892
|
+
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences. Active audiences by default, starred first; pass archived for the archived ones. requires read permission on announcements.
|
|
25886
25893
|
* @summary List announcement audiences
|
|
25887
25894
|
* @param {AnnouncementAudienceScope} [scope] Filter by scope
|
|
25888
25895
|
* @param {number} [page] Page number
|
|
@@ -26033,7 +26040,7 @@ export const AnnouncementsAudiencesApiFactory = function (configuration?: Config
|
|
|
26033
26040
|
return localVarFp.getAnnouncementAudienceAccounts(requestParameters.audienceId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
26034
26041
|
},
|
|
26035
26042
|
/**
|
|
26036
|
-
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences; requires read permission on announcements.
|
|
26043
|
+
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences. Active audiences by default, starred first; pass archived for the archived ones. requires read permission on announcements.
|
|
26037
26044
|
* @summary List announcement audiences
|
|
26038
26045
|
* @param {AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest} requestParameters Request parameters.
|
|
26039
26046
|
* @param {*} [options] Override http request option.
|
|
@@ -26370,7 +26377,7 @@ export class AnnouncementsAudiencesApi extends BaseAPI {
|
|
|
26370
26377
|
}
|
|
26371
26378
|
|
|
26372
26379
|
/**
|
|
26373
|
-
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences; requires read permission on announcements.
|
|
26380
|
+
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences. Active audiences by default, starred first; pass archived for the archived ones. requires read permission on announcements.
|
|
26374
26381
|
* @summary List announcement audiences
|
|
26375
26382
|
* @param {AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest} requestParameters Request parameters.
|
|
26376
26383
|
* @param {*} [options] Override http request option.
|
package/base.ts
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: 12.
|
|
7
|
+
* The version of the OpenAPI document: 12.1.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/common.ts
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: 12.
|
|
7
|
+
* The version of the OpenAPI document: 12.1.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/configuration.ts
CHANGED
|
@@ -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: 12.
|
|
6
|
+
* The version of the OpenAPI document: 12.1.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
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: 12.
|
|
5
|
+
* The version of the OpenAPI document: 12.1.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -663,6 +663,8 @@ export interface AnnouncementAudience {
|
|
|
663
663
|
'groupId': string | null;
|
|
664
664
|
'channelId': string | null;
|
|
665
665
|
'operator': AnnouncementAudienceOperator;
|
|
666
|
+
'featured': boolean;
|
|
667
|
+
'archived': boolean;
|
|
666
668
|
'createdAt': string;
|
|
667
669
|
'updatedAt': string;
|
|
668
670
|
'event': AnnouncementAudienceConditionEvent | null;
|
|
@@ -869,11 +871,14 @@ export interface AnnouncementAudienceScope {
|
|
|
869
871
|
'eventId'?: string;
|
|
870
872
|
'groupId'?: string;
|
|
871
873
|
'channelId'?: string;
|
|
874
|
+
'archived'?: boolean;
|
|
872
875
|
}
|
|
873
876
|
export interface AnnouncementAudienceUpdateInputs {
|
|
874
877
|
'name'?: string;
|
|
875
878
|
'description'?: string | null;
|
|
876
879
|
'operator'?: AnnouncementAudienceOperator;
|
|
880
|
+
'featured'?: boolean;
|
|
881
|
+
'archived'?: boolean;
|
|
877
882
|
}
|
|
878
883
|
export interface AnnouncementCreateInputs {
|
|
879
884
|
'title'?: string | null;
|
|
@@ -1207,6 +1212,8 @@ export interface BaseAnnouncementAudience {
|
|
|
1207
1212
|
'groupId': string | null;
|
|
1208
1213
|
'channelId': string | null;
|
|
1209
1214
|
'operator': AnnouncementAudienceOperator;
|
|
1215
|
+
'featured': boolean;
|
|
1216
|
+
'archived': boolean;
|
|
1210
1217
|
'createdAt': string;
|
|
1211
1218
|
'updatedAt': string;
|
|
1212
1219
|
}
|
|
@@ -18981,7 +18988,7 @@ export declare const AnnouncementsAudiencesApiAxiosParamCreator: (configuration?
|
|
|
18981
18988
|
*/
|
|
18982
18989
|
getAnnouncementAudienceAccounts: (audienceId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18983
18990
|
/**
|
|
18984
|
-
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences; requires read permission on announcements.
|
|
18991
|
+
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences. Active audiences by default, starred first; pass archived for the archived ones. requires read permission on announcements.
|
|
18985
18992
|
* @summary List announcement audiences
|
|
18986
18993
|
* @param {AnnouncementAudienceScope} [scope] Filter by scope
|
|
18987
18994
|
* @param {number} [page] Page number
|
|
@@ -19102,7 +19109,7 @@ export declare const AnnouncementsAudiencesApiFp: (configuration?: Configuration
|
|
|
19102
19109
|
*/
|
|
19103
19110
|
getAnnouncementAudienceAccounts(audienceId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAnnouncementAudienceAccounts200Response>>;
|
|
19104
19111
|
/**
|
|
19105
|
-
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences; requires read permission on announcements.
|
|
19112
|
+
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences. Active audiences by default, starred first; pass archived for the archived ones. requires read permission on announcements.
|
|
19106
19113
|
* @summary List announcement audiences
|
|
19107
19114
|
* @param {AnnouncementAudienceScope} [scope] Filter by scope
|
|
19108
19115
|
* @param {number} [page] Page number
|
|
@@ -19213,7 +19220,7 @@ export declare const AnnouncementsAudiencesApiFactory: (configuration?: Configur
|
|
|
19213
19220
|
*/
|
|
19214
19221
|
getAnnouncementAudienceAccounts(requestParameters: AnnouncementsAudiencesApiGetAnnouncementAudienceAccountsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAnnouncementAudienceAccounts200Response>;
|
|
19215
19222
|
/**
|
|
19216
|
-
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences; requires read permission on announcements.
|
|
19223
|
+
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences. Active audiences by default, starred first; pass archived for the archived ones. requires read permission on announcements.
|
|
19217
19224
|
* @summary List announcement audiences
|
|
19218
19225
|
* @param {AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest} requestParameters Request parameters.
|
|
19219
19226
|
* @param {*} [options] Override http request option.
|
|
@@ -19484,7 +19491,7 @@ export declare class AnnouncementsAudiencesApi extends BaseAPI {
|
|
|
19484
19491
|
*/
|
|
19485
19492
|
getAnnouncementAudienceAccounts(requestParameters: AnnouncementsAudiencesApiGetAnnouncementAudienceAccountsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAnnouncementAudienceAccounts200Response, any, {}, any>>;
|
|
19486
19493
|
/**
|
|
19487
|
-
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences; requires read permission on announcements.
|
|
19494
|
+
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences. Active audiences by default, starred first; pass archived for the archived ones. requires read permission on announcements.
|
|
19488
19495
|
* @summary List announcement audiences
|
|
19489
19496
|
* @param {AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest} requestParameters Request parameters.
|
|
19490
19497
|
* @param {*} [options] Override http request option.
|
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Connected Admin API
|
|
6
6
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 12.
|
|
8
|
+
* The version of the OpenAPI document: 12.1.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -10425,7 +10425,7 @@ const AnnouncementsAudiencesApiAxiosParamCreator = function (configuration) {
|
|
|
10425
10425
|
};
|
|
10426
10426
|
}),
|
|
10427
10427
|
/**
|
|
10428
|
-
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences; requires read permission on announcements.
|
|
10428
|
+
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences. Active audiences by default, starred first; pass archived for the archived ones. requires read permission on announcements.
|
|
10429
10429
|
* @summary List announcement audiences
|
|
10430
10430
|
* @param {AnnouncementAudienceScope} [scope] Filter by scope
|
|
10431
10431
|
* @param {number} [page] Page number
|
|
@@ -10753,7 +10753,7 @@ const AnnouncementsAudiencesApiFp = function (configuration) {
|
|
|
10753
10753
|
});
|
|
10754
10754
|
},
|
|
10755
10755
|
/**
|
|
10756
|
-
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences; requires read permission on announcements.
|
|
10756
|
+
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences. Active audiences by default, starred first; pass archived for the archived ones. requires read permission on announcements.
|
|
10757
10757
|
* @summary List announcement audiences
|
|
10758
10758
|
* @param {AnnouncementAudienceScope} [scope] Filter by scope
|
|
10759
10759
|
* @param {number} [page] Page number
|
|
@@ -10916,7 +10916,7 @@ const AnnouncementsAudiencesApiFactory = function (configuration, basePath, axio
|
|
|
10916
10916
|
return localVarFp.getAnnouncementAudienceAccounts(requestParameters.audienceId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
10917
10917
|
},
|
|
10918
10918
|
/**
|
|
10919
|
-
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences; requires read permission on announcements.
|
|
10919
|
+
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences. Active audiences by default, starred first; pass archived for the archived ones. requires read permission on announcements.
|
|
10920
10920
|
* @summary List announcement audiences
|
|
10921
10921
|
* @param {AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest} requestParameters Request parameters.
|
|
10922
10922
|
* @param {*} [options] Override http request option.
|
|
@@ -11043,7 +11043,7 @@ class AnnouncementsAudiencesApi extends base_1.BaseAPI {
|
|
|
11043
11043
|
return (0, exports.AnnouncementsAudiencesApiFp)(this.configuration).getAnnouncementAudienceAccounts(requestParameters.audienceId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
11044
11044
|
}
|
|
11045
11045
|
/**
|
|
11046
|
-
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences; requires read permission on announcements.
|
|
11046
|
+
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences. Active audiences by default, starred first; pass archived for the archived ones. requires read permission on announcements.
|
|
11047
11047
|
* @summary List announcement audiences
|
|
11048
11048
|
* @param {AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest} requestParameters Request parameters.
|
|
11049
11049
|
* @param {*} [options] Override http request option.
|
package/dist/base.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: 12.
|
|
5
|
+
* The version of the OpenAPI document: 12.1.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/base.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Connected Admin API
|
|
6
6
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 12.
|
|
8
|
+
* The version of the OpenAPI document: 12.1.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.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: 12.
|
|
5
|
+
* The version of the OpenAPI document: 12.1.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Connected Admin API
|
|
6
6
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 12.
|
|
8
|
+
* The version of the OpenAPI document: 12.1.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.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: 12.
|
|
5
|
+
* The version of the OpenAPI document: 12.1.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.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: 12.
|
|
7
|
+
* The version of the OpenAPI document: 12.1.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
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: 12.
|
|
5
|
+
* The version of the OpenAPI document: 12.1.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -663,6 +663,8 @@ export interface AnnouncementAudience {
|
|
|
663
663
|
'groupId': string | null;
|
|
664
664
|
'channelId': string | null;
|
|
665
665
|
'operator': AnnouncementAudienceOperator;
|
|
666
|
+
'featured': boolean;
|
|
667
|
+
'archived': boolean;
|
|
666
668
|
'createdAt': string;
|
|
667
669
|
'updatedAt': string;
|
|
668
670
|
'event': AnnouncementAudienceConditionEvent | null;
|
|
@@ -869,11 +871,14 @@ export interface AnnouncementAudienceScope {
|
|
|
869
871
|
'eventId'?: string;
|
|
870
872
|
'groupId'?: string;
|
|
871
873
|
'channelId'?: string;
|
|
874
|
+
'archived'?: boolean;
|
|
872
875
|
}
|
|
873
876
|
export interface AnnouncementAudienceUpdateInputs {
|
|
874
877
|
'name'?: string;
|
|
875
878
|
'description'?: string | null;
|
|
876
879
|
'operator'?: AnnouncementAudienceOperator;
|
|
880
|
+
'featured'?: boolean;
|
|
881
|
+
'archived'?: boolean;
|
|
877
882
|
}
|
|
878
883
|
export interface AnnouncementCreateInputs {
|
|
879
884
|
'title'?: string | null;
|
|
@@ -1207,6 +1212,8 @@ export interface BaseAnnouncementAudience {
|
|
|
1207
1212
|
'groupId': string | null;
|
|
1208
1213
|
'channelId': string | null;
|
|
1209
1214
|
'operator': AnnouncementAudienceOperator;
|
|
1215
|
+
'featured': boolean;
|
|
1216
|
+
'archived': boolean;
|
|
1210
1217
|
'createdAt': string;
|
|
1211
1218
|
'updatedAt': string;
|
|
1212
1219
|
}
|
|
@@ -18981,7 +18988,7 @@ export declare const AnnouncementsAudiencesApiAxiosParamCreator: (configuration?
|
|
|
18981
18988
|
*/
|
|
18982
18989
|
getAnnouncementAudienceAccounts: (audienceId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18983
18990
|
/**
|
|
18984
|
-
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences; requires read permission on announcements.
|
|
18991
|
+
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences. Active audiences by default, starred first; pass archived for the archived ones. requires read permission on announcements.
|
|
18985
18992
|
* @summary List announcement audiences
|
|
18986
18993
|
* @param {AnnouncementAudienceScope} [scope] Filter by scope
|
|
18987
18994
|
* @param {number} [page] Page number
|
|
@@ -19102,7 +19109,7 @@ export declare const AnnouncementsAudiencesApiFp: (configuration?: Configuration
|
|
|
19102
19109
|
*/
|
|
19103
19110
|
getAnnouncementAudienceAccounts(audienceId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAnnouncementAudienceAccounts200Response>>;
|
|
19104
19111
|
/**
|
|
19105
|
-
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences; requires read permission on announcements.
|
|
19112
|
+
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences. Active audiences by default, starred first; pass archived for the archived ones. requires read permission on announcements.
|
|
19106
19113
|
* @summary List announcement audiences
|
|
19107
19114
|
* @param {AnnouncementAudienceScope} [scope] Filter by scope
|
|
19108
19115
|
* @param {number} [page] Page number
|
|
@@ -19213,7 +19220,7 @@ export declare const AnnouncementsAudiencesApiFactory: (configuration?: Configur
|
|
|
19213
19220
|
*/
|
|
19214
19221
|
getAnnouncementAudienceAccounts(requestParameters: AnnouncementsAudiencesApiGetAnnouncementAudienceAccountsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAnnouncementAudienceAccounts200Response>;
|
|
19215
19222
|
/**
|
|
19216
|
-
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences; requires read permission on announcements.
|
|
19223
|
+
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences. Active audiences by default, starred first; pass archived for the archived ones. requires read permission on announcements.
|
|
19217
19224
|
* @summary List announcement audiences
|
|
19218
19225
|
* @param {AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest} requestParameters Request parameters.
|
|
19219
19226
|
* @param {*} [options] Override http request option.
|
|
@@ -19484,7 +19491,7 @@ export declare class AnnouncementsAudiencesApi extends BaseAPI {
|
|
|
19484
19491
|
*/
|
|
19485
19492
|
getAnnouncementAudienceAccounts(requestParameters: AnnouncementsAudiencesApiGetAnnouncementAudienceAccountsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAnnouncementAudienceAccounts200Response, any, {}, any>>;
|
|
19486
19493
|
/**
|
|
19487
|
-
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences; requires read permission on announcements.
|
|
19494
|
+
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences. Active audiences by default, starred first; pass archived for the archived ones. requires read permission on announcements.
|
|
19488
19495
|
* @summary List announcement audiences
|
|
19489
19496
|
* @param {AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest} requestParameters Request parameters.
|
|
19490
19497
|
* @param {*} [options] Override http request option.
|
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: 12.
|
|
7
|
+
* The version of the OpenAPI document: 12.1.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -10337,7 +10337,7 @@ export const AnnouncementsAudiencesApiAxiosParamCreator = function (configuratio
|
|
|
10337
10337
|
};
|
|
10338
10338
|
}),
|
|
10339
10339
|
/**
|
|
10340
|
-
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences; requires read permission on announcements.
|
|
10340
|
+
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences. Active audiences by default, starred first; pass archived for the archived ones. requires read permission on announcements.
|
|
10341
10341
|
* @summary List announcement audiences
|
|
10342
10342
|
* @param {AnnouncementAudienceScope} [scope] Filter by scope
|
|
10343
10343
|
* @param {number} [page] Page number
|
|
@@ -10664,7 +10664,7 @@ export const AnnouncementsAudiencesApiFp = function (configuration) {
|
|
|
10664
10664
|
});
|
|
10665
10665
|
},
|
|
10666
10666
|
/**
|
|
10667
|
-
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences; requires read permission on announcements.
|
|
10667
|
+
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences. Active audiences by default, starred first; pass archived for the archived ones. requires read permission on announcements.
|
|
10668
10668
|
* @summary List announcement audiences
|
|
10669
10669
|
* @param {AnnouncementAudienceScope} [scope] Filter by scope
|
|
10670
10670
|
* @param {number} [page] Page number
|
|
@@ -10826,7 +10826,7 @@ export const AnnouncementsAudiencesApiFactory = function (configuration, basePat
|
|
|
10826
10826
|
return localVarFp.getAnnouncementAudienceAccounts(requestParameters.audienceId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
10827
10827
|
},
|
|
10828
10828
|
/**
|
|
10829
|
-
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences; requires read permission on announcements.
|
|
10829
|
+
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences. Active audiences by default, starred first; pass archived for the archived ones. requires read permission on announcements.
|
|
10830
10830
|
* @summary List announcement audiences
|
|
10831
10831
|
* @param {AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest} requestParameters Request parameters.
|
|
10832
10832
|
* @param {*} [options] Override http request option.
|
|
@@ -10952,7 +10952,7 @@ export class AnnouncementsAudiencesApi extends BaseAPI {
|
|
|
10952
10952
|
return AnnouncementsAudiencesApiFp(this.configuration).getAnnouncementAudienceAccounts(requestParameters.audienceId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
10953
10953
|
}
|
|
10954
10954
|
/**
|
|
10955
|
-
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences; requires read permission on announcements.
|
|
10955
|
+
* Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences. Active audiences by default, starred first; pass archived for the archived ones. requires read permission on announcements.
|
|
10956
10956
|
* @summary List announcement audiences
|
|
10957
10957
|
* @param {AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest} requestParameters Request parameters.
|
|
10958
10958
|
* @param {*} [options] Override http request option.
|
package/dist/esm/base.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: 12.
|
|
5
|
+
* The version of the OpenAPI document: 12.1.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: 12.
|
|
7
|
+
* The version of the OpenAPI document: 12.1.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.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: 12.
|
|
5
|
+
* The version of the OpenAPI document: 12.1.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.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: 12.
|
|
7
|
+
* The version of the OpenAPI document: 12.1.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: 12.
|
|
5
|
+
* The version of the OpenAPI document: 12.1.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: 12.
|
|
6
|
+
* The version of the OpenAPI document: 12.1.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -12,6 +12,8 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**groupId** | **string** | | [default to undefined]
|
|
13
13
|
**channelId** | **string** | | [default to undefined]
|
|
14
14
|
**operator** | [**AnnouncementAudienceOperator**](AnnouncementAudienceOperator.md) | | [default to undefined]
|
|
15
|
+
**featured** | **boolean** | | [default to undefined]
|
|
16
|
+
**archived** | **boolean** | | [default to undefined]
|
|
15
17
|
**createdAt** | **string** | | [default to undefined]
|
|
16
18
|
**updatedAt** | **string** | | [default to undefined]
|
|
17
19
|
**event** | [**AnnouncementAudienceConditionEvent**](AnnouncementAudienceConditionEvent.md) | | [default to undefined]
|
|
@@ -32,6 +34,8 @@ const instance: AnnouncementAudience = {
|
|
|
32
34
|
groupId,
|
|
33
35
|
channelId,
|
|
34
36
|
operator,
|
|
37
|
+
featured,
|
|
38
|
+
archived,
|
|
35
39
|
createdAt,
|
|
36
40
|
updatedAt,
|
|
37
41
|
event,
|
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**eventId** | **string** | | [optional] [default to undefined]
|
|
9
9
|
**groupId** | **string** | | [optional] [default to undefined]
|
|
10
10
|
**channelId** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**archived** | **boolean** | | [optional] [default to undefined]
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -18,6 +19,7 @@ const instance: AnnouncementAudienceScope = {
|
|
|
18
19
|
eventId,
|
|
19
20
|
groupId,
|
|
20
21
|
channelId,
|
|
22
|
+
archived,
|
|
21
23
|
};
|
|
22
24
|
```
|
|
23
25
|
|
|
@@ -8,6 +8,8 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**name** | **string** | | [optional] [default to undefined]
|
|
9
9
|
**description** | **string** | | [optional] [default to undefined]
|
|
10
10
|
**operator** | [**AnnouncementAudienceOperator**](AnnouncementAudienceOperator.md) | | [optional] [default to undefined]
|
|
11
|
+
**featured** | **boolean** | | [optional] [default to undefined]
|
|
12
|
+
**archived** | **boolean** | | [optional] [default to undefined]
|
|
11
13
|
|
|
12
14
|
## Example
|
|
13
15
|
|
|
@@ -18,6 +20,8 @@ const instance: AnnouncementAudienceUpdateInputs = {
|
|
|
18
20
|
name,
|
|
19
21
|
description,
|
|
20
22
|
operator,
|
|
23
|
+
featured,
|
|
24
|
+
archived,
|
|
21
25
|
};
|
|
22
26
|
```
|
|
23
27
|
|
|
@@ -461,7 +461,7 @@ const { status, data } = await apiInstance.getAnnouncementAudienceAccounts(
|
|
|
461
461
|
# **getAnnouncementAudiences**
|
|
462
462
|
> GetAnnouncementAudiences200Response getAnnouncementAudiences()
|
|
463
463
|
|
|
464
|
-
Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences; requires read permission on announcements.
|
|
464
|
+
Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences. Active audiences by default, starred first; pass archived for the archived ones. requires read permission on announcements.
|
|
465
465
|
|
|
466
466
|
### Example
|
|
467
467
|
|
|
@@ -12,6 +12,8 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**groupId** | **string** | | [default to undefined]
|
|
13
13
|
**channelId** | **string** | | [default to undefined]
|
|
14
14
|
**operator** | [**AnnouncementAudienceOperator**](AnnouncementAudienceOperator.md) | | [default to undefined]
|
|
15
|
+
**featured** | **boolean** | | [default to undefined]
|
|
16
|
+
**archived** | **boolean** | | [default to undefined]
|
|
15
17
|
**createdAt** | **string** | | [default to undefined]
|
|
16
18
|
**updatedAt** | **string** | | [default to undefined]
|
|
17
19
|
|
|
@@ -28,6 +30,8 @@ const instance: BaseAnnouncementAudience = {
|
|
|
28
30
|
groupId,
|
|
29
31
|
channelId,
|
|
30
32
|
operator,
|
|
33
|
+
featured,
|
|
34
|
+
archived,
|
|
31
35
|
createdAt,
|
|
32
36
|
updatedAt,
|
|
33
37
|
};
|