@connectedxm/admin-sdk 16.6.1 → 16.8.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 +1 -0
- package/README.md +2 -2
- package/api.ts +151 -12
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +84 -10
- package/dist/api.js +125 -31
- 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 +84 -10
- package/dist/esm/api.js +104 -10
- 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/GetThreadMessages200Response.md +2 -0
- package/docs/GetThreadMessagesPoll200Response.md +24 -0
- package/docs/StreamsSessionsApi.md +52 -0
- package/docs/ThreadsMessagesApi.md +16 -4
- package/package.json +1 -1
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: 16.
|
|
5
|
+
* The version of the OpenAPI document: 16.8.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -10038,10 +10038,19 @@ export interface GetThreadMessages200Response {
|
|
|
10038
10038
|
'status': GetThreadMessages200ResponseStatusEnum;
|
|
10039
10039
|
'message': string;
|
|
10040
10040
|
'data': Array<ThreadMessage>;
|
|
10041
|
+
'count'?: number;
|
|
10041
10042
|
}
|
|
10042
10043
|
export declare enum GetThreadMessages200ResponseStatusEnum {
|
|
10043
10044
|
Ok = "ok"
|
|
10044
10045
|
}
|
|
10046
|
+
export interface GetThreadMessagesPoll200Response {
|
|
10047
|
+
'status': GetThreadMessagesPoll200ResponseStatusEnum;
|
|
10048
|
+
'message': string;
|
|
10049
|
+
'data': Array<ThreadMessage>;
|
|
10050
|
+
}
|
|
10051
|
+
export declare enum GetThreadMessagesPoll200ResponseStatusEnum {
|
|
10052
|
+
Ok = "ok"
|
|
10053
|
+
}
|
|
10045
10054
|
export interface GetVideo200Response {
|
|
10046
10055
|
'status': GetVideo200ResponseStatusEnum;
|
|
10047
10056
|
'message': string;
|
|
@@ -83627,6 +83636,14 @@ export declare const StreamsSessionsApiAxiosParamCreator: (configuration?: Confi
|
|
|
83627
83636
|
* @throws {RequiredError}
|
|
83628
83637
|
*/
|
|
83629
83638
|
getStreamSessions: (streamId: string, status?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83639
|
+
/**
|
|
83640
|
+
* Starts the live session on a stream input (streamId), or returns the one already running; viewers waiting for the stream join it and chat opens; requires the read and update permissions on streams.
|
|
83641
|
+
* @summary Start a stream session
|
|
83642
|
+
* @param {string} streamId The stream identifier
|
|
83643
|
+
* @param {*} [options] Override http request option.
|
|
83644
|
+
* @throws {RequiredError}
|
|
83645
|
+
*/
|
|
83646
|
+
startStreamSession: (streamId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83630
83647
|
/**
|
|
83631
83648
|
* Renames a broadcast session (sessionId) or changes the event and event session it belongs to; eventSessionId requires eventId, and changing eventId without an eventSessionId clears the event session; requires the read and update permissions on streams.
|
|
83632
83649
|
* @summary Update a stream session
|
|
@@ -83796,6 +83813,14 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
|
|
|
83796
83813
|
* @throws {RequiredError}
|
|
83797
83814
|
*/
|
|
83798
83815
|
getStreamSessions(streamId: string, status?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAllStreamSessions200Response>>;
|
|
83816
|
+
/**
|
|
83817
|
+
* Starts the live session on a stream input (streamId), or returns the one already running; viewers waiting for the stream join it and chat opens; requires the read and update permissions on streams.
|
|
83818
|
+
* @summary Start a stream session
|
|
83819
|
+
* @param {string} streamId The stream identifier
|
|
83820
|
+
* @param {*} [options] Override http request option.
|
|
83821
|
+
* @throws {RequiredError}
|
|
83822
|
+
*/
|
|
83823
|
+
startStreamSession(streamId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionById200Response>>;
|
|
83799
83824
|
/**
|
|
83800
83825
|
* Renames a broadcast session (sessionId) or changes the event and event session it belongs to; eventSessionId requires eventId, and changing eventId without an eventSessionId clears the event session; requires the read and update permissions on streams.
|
|
83801
83826
|
* @summary Update a stream session
|
|
@@ -83930,6 +83955,14 @@ export declare const StreamsSessionsApiFactory: (configuration?: Configuration,
|
|
|
83930
83955
|
* @throws {RequiredError}
|
|
83931
83956
|
*/
|
|
83932
83957
|
getStreamSessions(requestParameters: StreamsSessionsApiGetStreamSessionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAllStreamSessions200Response>;
|
|
83958
|
+
/**
|
|
83959
|
+
* Starts the live session on a stream input (streamId), or returns the one already running; viewers waiting for the stream join it and chat opens; requires the read and update permissions on streams.
|
|
83960
|
+
* @summary Start a stream session
|
|
83961
|
+
* @param {StreamsSessionsApiStartStreamSessionRequest} requestParameters Request parameters.
|
|
83962
|
+
* @param {*} [options] Override http request option.
|
|
83963
|
+
* @throws {RequiredError}
|
|
83964
|
+
*/
|
|
83965
|
+
startStreamSession(requestParameters: StreamsSessionsApiStartStreamSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionById200Response>;
|
|
83933
83966
|
/**
|
|
83934
83967
|
* Renames a broadcast session (sessionId) or changes the event and event session it belongs to; eventSessionId requires eventId, and changing eventId without an eventSessionId clears the event session; requires the read and update permissions on streams.
|
|
83935
83968
|
* @summary Update a stream session
|
|
@@ -84211,6 +84244,15 @@ export interface StreamsSessionsApiGetStreamSessionsRequest {
|
|
|
84211
84244
|
*/
|
|
84212
84245
|
readonly search?: string;
|
|
84213
84246
|
}
|
|
84247
|
+
/**
|
|
84248
|
+
* Request parameters for startStreamSession operation in StreamsSessionsApi.
|
|
84249
|
+
*/
|
|
84250
|
+
export interface StreamsSessionsApiStartStreamSessionRequest {
|
|
84251
|
+
/**
|
|
84252
|
+
* The stream identifier
|
|
84253
|
+
*/
|
|
84254
|
+
readonly streamId: string;
|
|
84255
|
+
}
|
|
84214
84256
|
/**
|
|
84215
84257
|
* Request parameters for updateStreamSession operation in StreamsSessionsApi.
|
|
84216
84258
|
*/
|
|
@@ -84345,6 +84387,14 @@ export declare class StreamsSessionsApi extends BaseAPI {
|
|
|
84345
84387
|
* @throws {RequiredError}
|
|
84346
84388
|
*/
|
|
84347
84389
|
getStreamSessions(requestParameters: StreamsSessionsApiGetStreamSessionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAllStreamSessions200Response, any, {}, any>>;
|
|
84390
|
+
/**
|
|
84391
|
+
* Starts the live session on a stream input (streamId), or returns the one already running; viewers waiting for the stream join it and chat opens; requires the read and update permissions on streams.
|
|
84392
|
+
* @summary Start a stream session
|
|
84393
|
+
* @param {StreamsSessionsApiStartStreamSessionRequest} requestParameters Request parameters.
|
|
84394
|
+
* @param {*} [options] Override http request option.
|
|
84395
|
+
* @throws {RequiredError}
|
|
84396
|
+
*/
|
|
84397
|
+
startStreamSession(requestParameters: StreamsSessionsApiStartStreamSessionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamSessionById200Response, any, {}, any>>;
|
|
84348
84398
|
/**
|
|
84349
84399
|
* Renames a broadcast session (sessionId) or changes the event and event session it belongs to; eventSessionId requires eventId, and changing eventId without an eventSessionId clears the event session; requires the read and update permissions on streams.
|
|
84350
84400
|
* @summary Update a stream session
|
|
@@ -89178,13 +89228,17 @@ export declare const ThreadsMessagesApiAxiosParamCreator: (configuration?: Confi
|
|
|
89178
89228
|
*/
|
|
89179
89229
|
getThreadMessage: (threadId: string, messageId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
89180
89230
|
/**
|
|
89181
|
-
* Returns a
|
|
89231
|
+
* Returns a paginated list of top-level messages in the given thread (excludes replies, which are listed under their parent message), newest first and searchable by message body; requires read permission on threads.
|
|
89182
89232
|
* @summary List a thread\'s messages
|
|
89183
89233
|
* @param {string} threadId The thread identifier
|
|
89234
|
+
* @param {number} [page] Page number
|
|
89235
|
+
* @param {number} [pageSize] Number of items per page
|
|
89236
|
+
* @param {string} [orderBy] Field to order by
|
|
89237
|
+
* @param {string} [search] Search query
|
|
89184
89238
|
* @param {*} [options] Override http request option.
|
|
89185
89239
|
* @throws {RequiredError}
|
|
89186
89240
|
*/
|
|
89187
|
-
getThreadMessages: (threadId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
89241
|
+
getThreadMessages: (threadId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
89188
89242
|
/**
|
|
89189
89243
|
* Returns any messages sent in the given thread after the provided lastMessageId, for lightweight polling-based updates; requires read permission on threads.
|
|
89190
89244
|
* @summary Poll a thread for new messages
|
|
@@ -89237,13 +89291,17 @@ export declare const ThreadsMessagesApiFp: (configuration?: Configuration) => {
|
|
|
89237
89291
|
*/
|
|
89238
89292
|
getThreadMessage(threadId: string, messageId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateThreadMessage200Response>>;
|
|
89239
89293
|
/**
|
|
89240
|
-
* Returns a
|
|
89294
|
+
* Returns a paginated list of top-level messages in the given thread (excludes replies, which are listed under their parent message), newest first and searchable by message body; requires read permission on threads.
|
|
89241
89295
|
* @summary List a thread\'s messages
|
|
89242
89296
|
* @param {string} threadId The thread identifier
|
|
89297
|
+
* @param {number} [page] Page number
|
|
89298
|
+
* @param {number} [pageSize] Number of items per page
|
|
89299
|
+
* @param {string} [orderBy] Field to order by
|
|
89300
|
+
* @param {string} [search] Search query
|
|
89243
89301
|
* @param {*} [options] Override http request option.
|
|
89244
89302
|
* @throws {RequiredError}
|
|
89245
89303
|
*/
|
|
89246
|
-
getThreadMessages(threadId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetThreadMessages200Response>>;
|
|
89304
|
+
getThreadMessages(threadId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetThreadMessages200Response>>;
|
|
89247
89305
|
/**
|
|
89248
89306
|
* Returns any messages sent in the given thread after the provided lastMessageId, for lightweight polling-based updates; requires read permission on threads.
|
|
89249
89307
|
* @summary Poll a thread for new messages
|
|
@@ -89252,7 +89310,7 @@ export declare const ThreadsMessagesApiFp: (configuration?: Configuration) => {
|
|
|
89252
89310
|
* @param {*} [options] Override http request option.
|
|
89253
89311
|
* @throws {RequiredError}
|
|
89254
89312
|
*/
|
|
89255
|
-
getThreadMessagesPoll(threadId: string, lastMessageId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
89313
|
+
getThreadMessagesPoll(threadId: string, lastMessageId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetThreadMessagesPoll200Response>>;
|
|
89256
89314
|
/**
|
|
89257
89315
|
* Updates the content of an existing message within a thread; requires the \"read\" and \"update\" permissions on threads.
|
|
89258
89316
|
* @summary Edit a thread message
|
|
@@ -89293,7 +89351,7 @@ export declare const ThreadsMessagesApiFactory: (configuration?: Configuration,
|
|
|
89293
89351
|
*/
|
|
89294
89352
|
getThreadMessage(requestParameters: ThreadsMessagesApiGetThreadMessageRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateThreadMessage200Response>;
|
|
89295
89353
|
/**
|
|
89296
|
-
* Returns a
|
|
89354
|
+
* Returns a paginated list of top-level messages in the given thread (excludes replies, which are listed under their parent message), newest first and searchable by message body; requires read permission on threads.
|
|
89297
89355
|
* @summary List a thread\'s messages
|
|
89298
89356
|
* @param {ThreadsMessagesApiGetThreadMessagesRequest} requestParameters Request parameters.
|
|
89299
89357
|
* @param {*} [options] Override http request option.
|
|
@@ -89307,7 +89365,7 @@ export declare const ThreadsMessagesApiFactory: (configuration?: Configuration,
|
|
|
89307
89365
|
* @param {*} [options] Override http request option.
|
|
89308
89366
|
* @throws {RequiredError}
|
|
89309
89367
|
*/
|
|
89310
|
-
getThreadMessagesPoll(requestParameters: ThreadsMessagesApiGetThreadMessagesPollRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
89368
|
+
getThreadMessagesPoll(requestParameters: ThreadsMessagesApiGetThreadMessagesPollRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetThreadMessagesPoll200Response>;
|
|
89311
89369
|
/**
|
|
89312
89370
|
* Updates the content of an existing message within a thread; requires the \"read\" and \"update\" permissions on threads.
|
|
89313
89371
|
* @summary Edit a thread message
|
|
@@ -89361,6 +89419,22 @@ export interface ThreadsMessagesApiGetThreadMessagesRequest {
|
|
|
89361
89419
|
* The thread identifier
|
|
89362
89420
|
*/
|
|
89363
89421
|
readonly threadId: string;
|
|
89422
|
+
/**
|
|
89423
|
+
* Page number
|
|
89424
|
+
*/
|
|
89425
|
+
readonly page?: number;
|
|
89426
|
+
/**
|
|
89427
|
+
* Number of items per page
|
|
89428
|
+
*/
|
|
89429
|
+
readonly pageSize?: number;
|
|
89430
|
+
/**
|
|
89431
|
+
* Field to order by
|
|
89432
|
+
*/
|
|
89433
|
+
readonly orderBy?: string;
|
|
89434
|
+
/**
|
|
89435
|
+
* Search query
|
|
89436
|
+
*/
|
|
89437
|
+
readonly search?: string;
|
|
89364
89438
|
}
|
|
89365
89439
|
/**
|
|
89366
89440
|
* Request parameters for getThreadMessagesPoll operation in ThreadsMessagesApi.
|
|
@@ -89418,7 +89492,7 @@ export declare class ThreadsMessagesApi extends BaseAPI {
|
|
|
89418
89492
|
*/
|
|
89419
89493
|
getThreadMessage(requestParameters: ThreadsMessagesApiGetThreadMessageRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateThreadMessage200Response, any, {}, any>>;
|
|
89420
89494
|
/**
|
|
89421
|
-
* Returns a
|
|
89495
|
+
* Returns a paginated list of top-level messages in the given thread (excludes replies, which are listed under their parent message), newest first and searchable by message body; requires read permission on threads.
|
|
89422
89496
|
* @summary List a thread\'s messages
|
|
89423
89497
|
* @param {ThreadsMessagesApiGetThreadMessagesRequest} requestParameters Request parameters.
|
|
89424
89498
|
* @param {*} [options] Override http request option.
|
|
@@ -89432,7 +89506,7 @@ export declare class ThreadsMessagesApi extends BaseAPI {
|
|
|
89432
89506
|
* @param {*} [options] Override http request option.
|
|
89433
89507
|
* @throws {RequiredError}
|
|
89434
89508
|
*/
|
|
89435
|
-
getThreadMessagesPoll(requestParameters: ThreadsMessagesApiGetThreadMessagesPollRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
89509
|
+
getThreadMessagesPoll(requestParameters: ThreadsMessagesApiGetThreadMessagesPollRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetThreadMessagesPoll200Response, any, {}, any>>;
|
|
89436
89510
|
/**
|
|
89437
89511
|
* Updates the content of an existing message within a thread; requires the \"read\" and \"update\" permissions on threads.
|
|
89438
89512
|
* @summary Edit a thread message
|
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: 16.
|
|
7
|
+
* The version of the OpenAPI document: 16.8.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2156,6 +2156,10 @@ export var GetThreadMessages200ResponseStatusEnum;
|
|
|
2156
2156
|
(function (GetThreadMessages200ResponseStatusEnum) {
|
|
2157
2157
|
GetThreadMessages200ResponseStatusEnum["Ok"] = "ok";
|
|
2158
2158
|
})(GetThreadMessages200ResponseStatusEnum || (GetThreadMessages200ResponseStatusEnum = {}));
|
|
2159
|
+
export var GetThreadMessagesPoll200ResponseStatusEnum;
|
|
2160
|
+
(function (GetThreadMessagesPoll200ResponseStatusEnum) {
|
|
2161
|
+
GetThreadMessagesPoll200ResponseStatusEnum["Ok"] = "ok";
|
|
2162
|
+
})(GetThreadMessagesPoll200ResponseStatusEnum || (GetThreadMessagesPoll200ResponseStatusEnum = {}));
|
|
2159
2163
|
export var GetVideo200ResponseStatusEnum;
|
|
2160
2164
|
(function (GetVideo200ResponseStatusEnum) {
|
|
2161
2165
|
GetVideo200ResponseStatusEnum["Ok"] = "ok";
|
|
@@ -107837,6 +107841,40 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration) {
|
|
|
107837
107841
|
options: localVarRequestOptions,
|
|
107838
107842
|
};
|
|
107839
107843
|
}),
|
|
107844
|
+
/**
|
|
107845
|
+
* Starts the live session on a stream input (streamId), or returns the one already running; viewers waiting for the stream join it and chat opens; requires the read and update permissions on streams.
|
|
107846
|
+
* @summary Start a stream session
|
|
107847
|
+
* @param {string} streamId The stream identifier
|
|
107848
|
+
* @param {*} [options] Override http request option.
|
|
107849
|
+
* @throws {RequiredError}
|
|
107850
|
+
*/
|
|
107851
|
+
startStreamSession: (streamId_1, ...args_1) => __awaiter(this, [streamId_1, ...args_1], void 0, function* (streamId, options = {}) {
|
|
107852
|
+
// verify required parameter 'streamId' is not null or undefined
|
|
107853
|
+
assertParamExists('startStreamSession', 'streamId', streamId);
|
|
107854
|
+
const localVarPath = `/streams/{streamId}/sessions`
|
|
107855
|
+
.replace('{streamId}', encodeURIComponent(String(streamId)));
|
|
107856
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
107857
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
107858
|
+
let baseOptions;
|
|
107859
|
+
if (configuration) {
|
|
107860
|
+
baseOptions = configuration.baseOptions;
|
|
107861
|
+
}
|
|
107862
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
107863
|
+
const localVarHeaderParameter = {};
|
|
107864
|
+
const localVarQueryParameter = {};
|
|
107865
|
+
// authentication ApiKeyAuth required
|
|
107866
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
107867
|
+
// authentication OrganizationId required
|
|
107868
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
107869
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
107870
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
107871
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
107872
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
107873
|
+
return {
|
|
107874
|
+
url: toPathString(localVarUrlObj),
|
|
107875
|
+
options: localVarRequestOptions,
|
|
107876
|
+
};
|
|
107877
|
+
}),
|
|
107840
107878
|
/**
|
|
107841
107879
|
* Renames a broadcast session (sessionId) or changes the event and event session it belongs to; eventSessionId requires eventId, and changing eventId without an eventSessionId clears the event session; requires the read and update permissions on streams.
|
|
107842
107880
|
* @summary Update a stream session
|
|
@@ -108159,6 +108197,22 @@ export const StreamsSessionsApiFp = function (configuration) {
|
|
|
108159
108197
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
108160
108198
|
});
|
|
108161
108199
|
},
|
|
108200
|
+
/**
|
|
108201
|
+
* Starts the live session on a stream input (streamId), or returns the one already running; viewers waiting for the stream join it and chat opens; requires the read and update permissions on streams.
|
|
108202
|
+
* @summary Start a stream session
|
|
108203
|
+
* @param {string} streamId The stream identifier
|
|
108204
|
+
* @param {*} [options] Override http request option.
|
|
108205
|
+
* @throws {RequiredError}
|
|
108206
|
+
*/
|
|
108207
|
+
startStreamSession(streamId, options) {
|
|
108208
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
108209
|
+
var _a, _b, _c;
|
|
108210
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.startStreamSession(streamId, options);
|
|
108211
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
108212
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['StreamsSessionsApi.startStreamSession']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
108213
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
108214
|
+
});
|
|
108215
|
+
},
|
|
108162
108216
|
/**
|
|
108163
108217
|
* Renames a broadcast session (sessionId) or changes the event and event session it belongs to; eventSessionId requires eventId, and changing eventId without an eventSessionId clears the event session; requires the read and update permissions on streams.
|
|
108164
108218
|
* @summary Update a stream session
|
|
@@ -108334,6 +108388,16 @@ export const StreamsSessionsApiFactory = function (configuration, basePath, axio
|
|
|
108334
108388
|
getStreamSessions(requestParameters, options) {
|
|
108335
108389
|
return localVarFp.getStreamSessions(requestParameters.streamId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
108336
108390
|
},
|
|
108391
|
+
/**
|
|
108392
|
+
* Starts the live session on a stream input (streamId), or returns the one already running; viewers waiting for the stream join it and chat opens; requires the read and update permissions on streams.
|
|
108393
|
+
* @summary Start a stream session
|
|
108394
|
+
* @param {StreamsSessionsApiStartStreamSessionRequest} requestParameters Request parameters.
|
|
108395
|
+
* @param {*} [options] Override http request option.
|
|
108396
|
+
* @throws {RequiredError}
|
|
108397
|
+
*/
|
|
108398
|
+
startStreamSession(requestParameters, options) {
|
|
108399
|
+
return localVarFp.startStreamSession(requestParameters.streamId, options).then((request) => request(axios, basePath));
|
|
108400
|
+
},
|
|
108337
108401
|
/**
|
|
108338
108402
|
* Renames a broadcast session (sessionId) or changes the event and event session it belongs to; eventSessionId requires eventId, and changing eventId without an eventSessionId clears the event session; requires the read and update permissions on streams.
|
|
108339
108403
|
* @summary Update a stream session
|
|
@@ -108500,6 +108564,16 @@ export class StreamsSessionsApi extends BaseAPI {
|
|
|
108500
108564
|
getStreamSessions(requestParameters, options) {
|
|
108501
108565
|
return StreamsSessionsApiFp(this.configuration).getStreamSessions(requestParameters.streamId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
108502
108566
|
}
|
|
108567
|
+
/**
|
|
108568
|
+
* Starts the live session on a stream input (streamId), or returns the one already running; viewers waiting for the stream join it and chat opens; requires the read and update permissions on streams.
|
|
108569
|
+
* @summary Start a stream session
|
|
108570
|
+
* @param {StreamsSessionsApiStartStreamSessionRequest} requestParameters Request parameters.
|
|
108571
|
+
* @param {*} [options] Override http request option.
|
|
108572
|
+
* @throws {RequiredError}
|
|
108573
|
+
*/
|
|
108574
|
+
startStreamSession(requestParameters, options) {
|
|
108575
|
+
return StreamsSessionsApiFp(this.configuration).startStreamSession(requestParameters.streamId, options).then((request) => request(this.axios, this.basePath));
|
|
108576
|
+
}
|
|
108503
108577
|
/**
|
|
108504
108578
|
* Renames a broadcast session (sessionId) or changes the event and event session it belongs to; eventSessionId requires eventId, and changing eventId without an eventSessionId clears the event session; requires the read and update permissions on streams.
|
|
108505
108579
|
* @summary Update a stream session
|
|
@@ -115850,13 +115924,17 @@ export const ThreadsMessagesApiAxiosParamCreator = function (configuration) {
|
|
|
115850
115924
|
};
|
|
115851
115925
|
}),
|
|
115852
115926
|
/**
|
|
115853
|
-
* Returns a
|
|
115927
|
+
* Returns a paginated list of top-level messages in the given thread (excludes replies, which are listed under their parent message), newest first and searchable by message body; requires read permission on threads.
|
|
115854
115928
|
* @summary List a thread\'s messages
|
|
115855
115929
|
* @param {string} threadId The thread identifier
|
|
115930
|
+
* @param {number} [page] Page number
|
|
115931
|
+
* @param {number} [pageSize] Number of items per page
|
|
115932
|
+
* @param {string} [orderBy] Field to order by
|
|
115933
|
+
* @param {string} [search] Search query
|
|
115856
115934
|
* @param {*} [options] Override http request option.
|
|
115857
115935
|
* @throws {RequiredError}
|
|
115858
115936
|
*/
|
|
115859
|
-
getThreadMessages: (threadId_1, ...args_1) => __awaiter(this, [threadId_1, ...args_1], void 0, function* (threadId, options = {}) {
|
|
115937
|
+
getThreadMessages: (threadId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [threadId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (threadId, page, pageSize, orderBy, search, options = {}) {
|
|
115860
115938
|
// verify required parameter 'threadId' is not null or undefined
|
|
115861
115939
|
assertParamExists('getThreadMessages', 'threadId', threadId);
|
|
115862
115940
|
const localVarPath = `/threads/{threadId}/messages`
|
|
@@ -115874,6 +115952,18 @@ export const ThreadsMessagesApiAxiosParamCreator = function (configuration) {
|
|
|
115874
115952
|
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
115875
115953
|
// authentication OrganizationId required
|
|
115876
115954
|
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
115955
|
+
if (page !== undefined) {
|
|
115956
|
+
localVarQueryParameter['page'] = page;
|
|
115957
|
+
}
|
|
115958
|
+
if (pageSize !== undefined) {
|
|
115959
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
115960
|
+
}
|
|
115961
|
+
if (orderBy !== undefined) {
|
|
115962
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
115963
|
+
}
|
|
115964
|
+
if (search !== undefined) {
|
|
115965
|
+
localVarQueryParameter['search'] = search;
|
|
115966
|
+
}
|
|
115877
115967
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
115878
115968
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
115879
115969
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -116026,16 +116116,20 @@ export const ThreadsMessagesApiFp = function (configuration) {
|
|
|
116026
116116
|
});
|
|
116027
116117
|
},
|
|
116028
116118
|
/**
|
|
116029
|
-
* Returns a
|
|
116119
|
+
* Returns a paginated list of top-level messages in the given thread (excludes replies, which are listed under their parent message), newest first and searchable by message body; requires read permission on threads.
|
|
116030
116120
|
* @summary List a thread\'s messages
|
|
116031
116121
|
* @param {string} threadId The thread identifier
|
|
116122
|
+
* @param {number} [page] Page number
|
|
116123
|
+
* @param {number} [pageSize] Number of items per page
|
|
116124
|
+
* @param {string} [orderBy] Field to order by
|
|
116125
|
+
* @param {string} [search] Search query
|
|
116032
116126
|
* @param {*} [options] Override http request option.
|
|
116033
116127
|
* @throws {RequiredError}
|
|
116034
116128
|
*/
|
|
116035
|
-
getThreadMessages(threadId, options) {
|
|
116129
|
+
getThreadMessages(threadId, page, pageSize, orderBy, search, options) {
|
|
116036
116130
|
return __awaiter(this, void 0, void 0, function* () {
|
|
116037
116131
|
var _a, _b, _c;
|
|
116038
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getThreadMessages(threadId, options);
|
|
116132
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getThreadMessages(threadId, page, pageSize, orderBy, search, options);
|
|
116039
116133
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
116040
116134
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ThreadsMessagesApi.getThreadMessages']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
116041
116135
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -116115,14 +116209,14 @@ export const ThreadsMessagesApiFactory = function (configuration, basePath, axio
|
|
|
116115
116209
|
return localVarFp.getThreadMessage(requestParameters.threadId, requestParameters.messageId, options).then((request) => request(axios, basePath));
|
|
116116
116210
|
},
|
|
116117
116211
|
/**
|
|
116118
|
-
* Returns a
|
|
116212
|
+
* Returns a paginated list of top-level messages in the given thread (excludes replies, which are listed under their parent message), newest first and searchable by message body; requires read permission on threads.
|
|
116119
116213
|
* @summary List a thread\'s messages
|
|
116120
116214
|
* @param {ThreadsMessagesApiGetThreadMessagesRequest} requestParameters Request parameters.
|
|
116121
116215
|
* @param {*} [options] Override http request option.
|
|
116122
116216
|
* @throws {RequiredError}
|
|
116123
116217
|
*/
|
|
116124
116218
|
getThreadMessages(requestParameters, options) {
|
|
116125
|
-
return localVarFp.getThreadMessages(requestParameters.threadId, options).then((request) => request(axios, basePath));
|
|
116219
|
+
return localVarFp.getThreadMessages(requestParameters.threadId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
116126
116220
|
},
|
|
116127
116221
|
/**
|
|
116128
116222
|
* Returns any messages sent in the given thread after the provided lastMessageId, for lightweight polling-based updates; requires read permission on threads.
|
|
@@ -116181,14 +116275,14 @@ export class ThreadsMessagesApi extends BaseAPI {
|
|
|
116181
116275
|
return ThreadsMessagesApiFp(this.configuration).getThreadMessage(requestParameters.threadId, requestParameters.messageId, options).then((request) => request(this.axios, this.basePath));
|
|
116182
116276
|
}
|
|
116183
116277
|
/**
|
|
116184
|
-
* Returns a
|
|
116278
|
+
* Returns a paginated list of top-level messages in the given thread (excludes replies, which are listed under their parent message), newest first and searchable by message body; requires read permission on threads.
|
|
116185
116279
|
* @summary List a thread\'s messages
|
|
116186
116280
|
* @param {ThreadsMessagesApiGetThreadMessagesRequest} requestParameters Request parameters.
|
|
116187
116281
|
* @param {*} [options] Override http request option.
|
|
116188
116282
|
* @throws {RequiredError}
|
|
116189
116283
|
*/
|
|
116190
116284
|
getThreadMessages(requestParameters, options) {
|
|
116191
|
-
return ThreadsMessagesApiFp(this.configuration).getThreadMessages(requestParameters.threadId, options).then((request) => request(this.axios, this.basePath));
|
|
116285
|
+
return ThreadsMessagesApiFp(this.configuration).getThreadMessages(requestParameters.threadId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
116192
116286
|
}
|
|
116193
116287
|
/**
|
|
116194
116288
|
* Returns any messages sent in the given thread after the provided lastMessageId, for lightweight polling-based updates; requires read permission on threads.
|
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: 16.
|
|
5
|
+
* The version of the OpenAPI document: 16.8.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: 16.
|
|
7
|
+
* The version of the OpenAPI document: 16.8.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: 16.
|
|
5
|
+
* The version of the OpenAPI document: 16.8.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: 16.
|
|
7
|
+
* The version of the OpenAPI document: 16.8.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: 16.
|
|
5
|
+
* The version of the OpenAPI document: 16.8.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: 16.
|
|
6
|
+
* The version of the OpenAPI document: 16.8.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**status** | **string** | | [default to undefined]
|
|
9
9
|
**message** | **string** | | [default to undefined]
|
|
10
10
|
**data** | [**Array<ThreadMessage>**](ThreadMessage.md) | | [default to undefined]
|
|
11
|
+
**count** | **number** | | [optional] [default to undefined]
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -18,6 +19,7 @@ const instance: GetThreadMessages200Response = {
|
|
|
18
19
|
status,
|
|
19
20
|
message,
|
|
20
21
|
data,
|
|
22
|
+
count,
|
|
21
23
|
};
|
|
22
24
|
```
|
|
23
25
|
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# GetThreadMessagesPoll200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
**data** | [**Array<ThreadMessage>**](ThreadMessage.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { GetThreadMessagesPoll200Response } from '@connectedxm/admin-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: GetThreadMessagesPoll200Response = {
|
|
18
|
+
status,
|
|
19
|
+
message,
|
|
20
|
+
data,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -19,6 +19,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
19
19
|
|[**getStreamSessionSubscriptions**](#getstreamsessionsubscriptions) | **GET** /streams/{streamId}/sessions/{sessionId}/subscriptions | List a stream session\'s viewer connections|
|
|
20
20
|
|[**getStreamSessionViewers**](#getstreamsessionviewers) | **GET** /streams/sessions/{sessionId}/viewers | List the people who watched a stream session|
|
|
21
21
|
|[**getStreamSessions**](#getstreamsessions) | **GET** /streams/{streamId}/sessions | List a stream\'s broadcast sessions|
|
|
22
|
+
|[**startStreamSession**](#startstreamsession) | **POST** /streams/{streamId}/sessions | Start a stream session|
|
|
22
23
|
|[**updateStreamSession**](#updatestreamsession) | **PUT** /streams/sessions/{sessionId} | Update a stream session|
|
|
23
24
|
|
|
24
25
|
# **closeStreamSession**
|
|
@@ -885,6 +886,57 @@ const { status, data } = await apiInstance.getStreamSessions(
|
|
|
885
886
|
- **Accept**: application/json
|
|
886
887
|
|
|
887
888
|
|
|
889
|
+
### HTTP response details
|
|
890
|
+
| Status code | Description | Response headers |
|
|
891
|
+
|-------------|-------------|------------------|
|
|
892
|
+
|**200** | Successful response | - |
|
|
893
|
+
|
|
894
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
895
|
+
|
|
896
|
+
# **startStreamSession**
|
|
897
|
+
> GetStreamSessionById200Response startStreamSession()
|
|
898
|
+
|
|
899
|
+
Starts the live session on a stream input (streamId), or returns the one already running; viewers waiting for the stream join it and chat opens; requires the read and update permissions on streams.
|
|
900
|
+
|
|
901
|
+
### Example
|
|
902
|
+
|
|
903
|
+
```typescript
|
|
904
|
+
import {
|
|
905
|
+
StreamsSessionsApi,
|
|
906
|
+
Configuration
|
|
907
|
+
} from '@connectedxm/admin-sdk';
|
|
908
|
+
|
|
909
|
+
const configuration = new Configuration();
|
|
910
|
+
const apiInstance = new StreamsSessionsApi(configuration);
|
|
911
|
+
|
|
912
|
+
let streamId: string; //The stream identifier (default to undefined)
|
|
913
|
+
|
|
914
|
+
const { status, data } = await apiInstance.startStreamSession(
|
|
915
|
+
streamId
|
|
916
|
+
);
|
|
917
|
+
```
|
|
918
|
+
|
|
919
|
+
### Parameters
|
|
920
|
+
|
|
921
|
+
|Name | Type | Description | Notes|
|
|
922
|
+
|------------- | ------------- | ------------- | -------------|
|
|
923
|
+
| **streamId** | [**string**] | The stream identifier | defaults to undefined|
|
|
924
|
+
|
|
925
|
+
|
|
926
|
+
### Return type
|
|
927
|
+
|
|
928
|
+
**GetStreamSessionById200Response**
|
|
929
|
+
|
|
930
|
+
### Authorization
|
|
931
|
+
|
|
932
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
933
|
+
|
|
934
|
+
### HTTP request headers
|
|
935
|
+
|
|
936
|
+
- **Content-Type**: Not defined
|
|
937
|
+
- **Accept**: application/json
|
|
938
|
+
|
|
939
|
+
|
|
888
940
|
### HTTP response details
|
|
889
941
|
| Status code | Description | Response headers |
|
|
890
942
|
|-------------|-------------|------------------|
|