@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/.openapi-generator/FILES
CHANGED
|
@@ -1166,6 +1166,7 @@ docs/GetThreadMessageImages200Response.md
|
|
|
1166
1166
|
docs/GetThreadMessageReactions200Response.md
|
|
1167
1167
|
docs/GetThreadMessageVideos200Response.md
|
|
1168
1168
|
docs/GetThreadMessages200Response.md
|
|
1169
|
+
docs/GetThreadMessagesPoll200Response.md
|
|
1169
1170
|
docs/GetVideo200Response.md
|
|
1170
1171
|
docs/GetVideoCaptions200Response.md
|
|
1171
1172
|
docs/Group.md
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @connectedxm/admin-sdk@16.
|
|
1
|
+
## @connectedxm/admin-sdk@16.8.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@16.
|
|
39
|
+
npm install @connectedxm/admin-sdk@16.8.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: 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).
|
|
@@ -11367,12 +11367,23 @@ export interface GetThreadMessages200Response {
|
|
|
11367
11367
|
'status': GetThreadMessages200ResponseStatusEnum;
|
|
11368
11368
|
'message': string;
|
|
11369
11369
|
'data': Array<ThreadMessage>;
|
|
11370
|
+
'count'?: number;
|
|
11370
11371
|
}
|
|
11371
11372
|
|
|
11372
11373
|
export enum GetThreadMessages200ResponseStatusEnum {
|
|
11373
11374
|
Ok = 'ok'
|
|
11374
11375
|
}
|
|
11375
11376
|
|
|
11377
|
+
export interface GetThreadMessagesPoll200Response {
|
|
11378
|
+
'status': GetThreadMessagesPoll200ResponseStatusEnum;
|
|
11379
|
+
'message': string;
|
|
11380
|
+
'data': Array<ThreadMessage>;
|
|
11381
|
+
}
|
|
11382
|
+
|
|
11383
|
+
export enum GetThreadMessagesPoll200ResponseStatusEnum {
|
|
11384
|
+
Ok = 'ok'
|
|
11385
|
+
}
|
|
11386
|
+
|
|
11376
11387
|
export interface GetVideo200Response {
|
|
11377
11388
|
'status': GetVideo200ResponseStatusEnum;
|
|
11378
11389
|
'message': string;
|
|
@@ -153300,6 +153311,46 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration?: Con
|
|
|
153300
153311
|
options: localVarRequestOptions,
|
|
153301
153312
|
};
|
|
153302
153313
|
},
|
|
153314
|
+
/**
|
|
153315
|
+
* 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.
|
|
153316
|
+
* @summary Start a stream session
|
|
153317
|
+
* @param {string} streamId The stream identifier
|
|
153318
|
+
* @param {*} [options] Override http request option.
|
|
153319
|
+
* @throws {RequiredError}
|
|
153320
|
+
*/
|
|
153321
|
+
startStreamSession: async (streamId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
153322
|
+
// verify required parameter 'streamId' is not null or undefined
|
|
153323
|
+
assertParamExists('startStreamSession', 'streamId', streamId)
|
|
153324
|
+
const localVarPath = `/streams/{streamId}/sessions`
|
|
153325
|
+
.replace('{streamId}', encodeURIComponent(String(streamId)));
|
|
153326
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
153327
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
153328
|
+
let baseOptions;
|
|
153329
|
+
if (configuration) {
|
|
153330
|
+
baseOptions = configuration.baseOptions;
|
|
153331
|
+
}
|
|
153332
|
+
|
|
153333
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
153334
|
+
const localVarHeaderParameter = {} as any;
|
|
153335
|
+
const localVarQueryParameter = {} as any;
|
|
153336
|
+
|
|
153337
|
+
// authentication ApiKeyAuth required
|
|
153338
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
153339
|
+
|
|
153340
|
+
// authentication OrganizationId required
|
|
153341
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
153342
|
+
|
|
153343
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
153344
|
+
|
|
153345
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
153346
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
153347
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
153348
|
+
|
|
153349
|
+
return {
|
|
153350
|
+
url: toPathString(localVarUrlObj),
|
|
153351
|
+
options: localVarRequestOptions,
|
|
153352
|
+
};
|
|
153353
|
+
},
|
|
153303
153354
|
/**
|
|
153304
153355
|
* 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.
|
|
153305
153356
|
* @summary Update a stream session
|
|
@@ -153584,6 +153635,19 @@ export const StreamsSessionsApiFp = function(configuration?: Configuration) {
|
|
|
153584
153635
|
const localVarOperationServerBasePath = operationServerMap['StreamsSessionsApi.getStreamSessions']?.[localVarOperationServerIndex]?.url;
|
|
153585
153636
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
153586
153637
|
},
|
|
153638
|
+
/**
|
|
153639
|
+
* 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.
|
|
153640
|
+
* @summary Start a stream session
|
|
153641
|
+
* @param {string} streamId The stream identifier
|
|
153642
|
+
* @param {*} [options] Override http request option.
|
|
153643
|
+
* @throws {RequiredError}
|
|
153644
|
+
*/
|
|
153645
|
+
async startStreamSession(streamId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionById200Response>> {
|
|
153646
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.startStreamSession(streamId, options);
|
|
153647
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
153648
|
+
const localVarOperationServerBasePath = operationServerMap['StreamsSessionsApi.startStreamSession']?.[localVarOperationServerIndex]?.url;
|
|
153649
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
153650
|
+
},
|
|
153587
153651
|
/**
|
|
153588
153652
|
* 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.
|
|
153589
153653
|
* @summary Update a stream session
|
|
@@ -153757,6 +153821,16 @@ export const StreamsSessionsApiFactory = function (configuration?: Configuration
|
|
|
153757
153821
|
getStreamSessions(requestParameters: StreamsSessionsApiGetStreamSessionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAllStreamSessions200Response> {
|
|
153758
153822
|
return localVarFp.getStreamSessions(requestParameters.streamId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
153759
153823
|
},
|
|
153824
|
+
/**
|
|
153825
|
+
* 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.
|
|
153826
|
+
* @summary Start a stream session
|
|
153827
|
+
* @param {StreamsSessionsApiStartStreamSessionRequest} requestParameters Request parameters.
|
|
153828
|
+
* @param {*} [options] Override http request option.
|
|
153829
|
+
* @throws {RequiredError}
|
|
153830
|
+
*/
|
|
153831
|
+
startStreamSession(requestParameters: StreamsSessionsApiStartStreamSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionById200Response> {
|
|
153832
|
+
return localVarFp.startStreamSession(requestParameters.streamId, options).then((request) => request(axios, basePath));
|
|
153833
|
+
},
|
|
153760
153834
|
/**
|
|
153761
153835
|
* 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.
|
|
153762
153836
|
* @summary Update a stream session
|
|
@@ -154092,6 +154166,16 @@ export interface StreamsSessionsApiGetStreamSessionsRequest {
|
|
|
154092
154166
|
readonly search?: string
|
|
154093
154167
|
}
|
|
154094
154168
|
|
|
154169
|
+
/**
|
|
154170
|
+
* Request parameters for startStreamSession operation in StreamsSessionsApi.
|
|
154171
|
+
*/
|
|
154172
|
+
export interface StreamsSessionsApiStartStreamSessionRequest {
|
|
154173
|
+
/**
|
|
154174
|
+
* The stream identifier
|
|
154175
|
+
*/
|
|
154176
|
+
readonly streamId: string
|
|
154177
|
+
}
|
|
154178
|
+
|
|
154095
154179
|
/**
|
|
154096
154180
|
* Request parameters for updateStreamSession operation in StreamsSessionsApi.
|
|
154097
154181
|
*/
|
|
@@ -154273,6 +154357,17 @@ export class StreamsSessionsApi extends BaseAPI {
|
|
|
154273
154357
|
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));
|
|
154274
154358
|
}
|
|
154275
154359
|
|
|
154360
|
+
/**
|
|
154361
|
+
* 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.
|
|
154362
|
+
* @summary Start a stream session
|
|
154363
|
+
* @param {StreamsSessionsApiStartStreamSessionRequest} requestParameters Request parameters.
|
|
154364
|
+
* @param {*} [options] Override http request option.
|
|
154365
|
+
* @throws {RequiredError}
|
|
154366
|
+
*/
|
|
154367
|
+
public startStreamSession(requestParameters: StreamsSessionsApiStartStreamSessionRequest, options?: RawAxiosRequestConfig) {
|
|
154368
|
+
return StreamsSessionsApiFp(this.configuration).startStreamSession(requestParameters.streamId, options).then((request) => request(this.axios, this.basePath));
|
|
154369
|
+
}
|
|
154370
|
+
|
|
154276
154371
|
/**
|
|
154277
154372
|
* 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.
|
|
154278
154373
|
* @summary Update a stream session
|
|
@@ -163891,13 +163986,17 @@ export const ThreadsMessagesApiAxiosParamCreator = function (configuration?: Con
|
|
|
163891
163986
|
};
|
|
163892
163987
|
},
|
|
163893
163988
|
/**
|
|
163894
|
-
* Returns a
|
|
163989
|
+
* 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.
|
|
163895
163990
|
* @summary List a thread\'s messages
|
|
163896
163991
|
* @param {string} threadId The thread identifier
|
|
163992
|
+
* @param {number} [page] Page number
|
|
163993
|
+
* @param {number} [pageSize] Number of items per page
|
|
163994
|
+
* @param {string} [orderBy] Field to order by
|
|
163995
|
+
* @param {string} [search] Search query
|
|
163897
163996
|
* @param {*} [options] Override http request option.
|
|
163898
163997
|
* @throws {RequiredError}
|
|
163899
163998
|
*/
|
|
163900
|
-
getThreadMessages: async (threadId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
163999
|
+
getThreadMessages: async (threadId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
163901
164000
|
// verify required parameter 'threadId' is not null or undefined
|
|
163902
164001
|
assertParamExists('getThreadMessages', 'threadId', threadId)
|
|
163903
164002
|
const localVarPath = `/threads/{threadId}/messages`
|
|
@@ -163919,6 +164018,22 @@ export const ThreadsMessagesApiAxiosParamCreator = function (configuration?: Con
|
|
|
163919
164018
|
// authentication OrganizationId required
|
|
163920
164019
|
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
163921
164020
|
|
|
164021
|
+
if (page !== undefined) {
|
|
164022
|
+
localVarQueryParameter['page'] = page;
|
|
164023
|
+
}
|
|
164024
|
+
|
|
164025
|
+
if (pageSize !== undefined) {
|
|
164026
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
164027
|
+
}
|
|
164028
|
+
|
|
164029
|
+
if (orderBy !== undefined) {
|
|
164030
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
164031
|
+
}
|
|
164032
|
+
|
|
164033
|
+
if (search !== undefined) {
|
|
164034
|
+
localVarQueryParameter['search'] = search;
|
|
164035
|
+
}
|
|
164036
|
+
|
|
163922
164037
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
163923
164038
|
|
|
163924
164039
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -164078,14 +164193,18 @@ export const ThreadsMessagesApiFp = function(configuration?: Configuration) {
|
|
|
164078
164193
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
164079
164194
|
},
|
|
164080
164195
|
/**
|
|
164081
|
-
* Returns a
|
|
164196
|
+
* 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.
|
|
164082
164197
|
* @summary List a thread\'s messages
|
|
164083
164198
|
* @param {string} threadId The thread identifier
|
|
164199
|
+
* @param {number} [page] Page number
|
|
164200
|
+
* @param {number} [pageSize] Number of items per page
|
|
164201
|
+
* @param {string} [orderBy] Field to order by
|
|
164202
|
+
* @param {string} [search] Search query
|
|
164084
164203
|
* @param {*} [options] Override http request option.
|
|
164085
164204
|
* @throws {RequiredError}
|
|
164086
164205
|
*/
|
|
164087
|
-
async getThreadMessages(threadId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetThreadMessages200Response>> {
|
|
164088
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getThreadMessages(threadId, options);
|
|
164206
|
+
async getThreadMessages(threadId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetThreadMessages200Response>> {
|
|
164207
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getThreadMessages(threadId, page, pageSize, orderBy, search, options);
|
|
164089
164208
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
164090
164209
|
const localVarOperationServerBasePath = operationServerMap['ThreadsMessagesApi.getThreadMessages']?.[localVarOperationServerIndex]?.url;
|
|
164091
164210
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -164098,7 +164217,7 @@ export const ThreadsMessagesApiFp = function(configuration?: Configuration) {
|
|
|
164098
164217
|
* @param {*} [options] Override http request option.
|
|
164099
164218
|
* @throws {RequiredError}
|
|
164100
164219
|
*/
|
|
164101
|
-
async getThreadMessagesPoll(threadId: string, lastMessageId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
164220
|
+
async getThreadMessagesPoll(threadId: string, lastMessageId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetThreadMessagesPoll200Response>> {
|
|
164102
164221
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getThreadMessagesPoll(threadId, lastMessageId, options);
|
|
164103
164222
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
164104
164223
|
const localVarOperationServerBasePath = operationServerMap['ThreadsMessagesApi.getThreadMessagesPoll']?.[localVarOperationServerIndex]?.url;
|
|
@@ -164159,14 +164278,14 @@ export const ThreadsMessagesApiFactory = function (configuration?: Configuration
|
|
|
164159
164278
|
return localVarFp.getThreadMessage(requestParameters.threadId, requestParameters.messageId, options).then((request) => request(axios, basePath));
|
|
164160
164279
|
},
|
|
164161
164280
|
/**
|
|
164162
|
-
* Returns a
|
|
164281
|
+
* 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.
|
|
164163
164282
|
* @summary List a thread\'s messages
|
|
164164
164283
|
* @param {ThreadsMessagesApiGetThreadMessagesRequest} requestParameters Request parameters.
|
|
164165
164284
|
* @param {*} [options] Override http request option.
|
|
164166
164285
|
* @throws {RequiredError}
|
|
164167
164286
|
*/
|
|
164168
164287
|
getThreadMessages(requestParameters: ThreadsMessagesApiGetThreadMessagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetThreadMessages200Response> {
|
|
164169
|
-
return localVarFp.getThreadMessages(requestParameters.threadId, options).then((request) => request(axios, basePath));
|
|
164288
|
+
return localVarFp.getThreadMessages(requestParameters.threadId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
164170
164289
|
},
|
|
164171
164290
|
/**
|
|
164172
164291
|
* Returns any messages sent in the given thread after the provided lastMessageId, for lightweight polling-based updates; requires read permission on threads.
|
|
@@ -164175,7 +164294,7 @@ export const ThreadsMessagesApiFactory = function (configuration?: Configuration
|
|
|
164175
164294
|
* @param {*} [options] Override http request option.
|
|
164176
164295
|
* @throws {RequiredError}
|
|
164177
164296
|
*/
|
|
164178
|
-
getThreadMessagesPoll(requestParameters: ThreadsMessagesApiGetThreadMessagesPollRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
164297
|
+
getThreadMessagesPoll(requestParameters: ThreadsMessagesApiGetThreadMessagesPollRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetThreadMessagesPoll200Response> {
|
|
164179
164298
|
return localVarFp.getThreadMessagesPoll(requestParameters.threadId, requestParameters.lastMessageId, options).then((request) => request(axios, basePath));
|
|
164180
164299
|
},
|
|
164181
164300
|
/**
|
|
@@ -164241,6 +164360,26 @@ export interface ThreadsMessagesApiGetThreadMessagesRequest {
|
|
|
164241
164360
|
* The thread identifier
|
|
164242
164361
|
*/
|
|
164243
164362
|
readonly threadId: string
|
|
164363
|
+
|
|
164364
|
+
/**
|
|
164365
|
+
* Page number
|
|
164366
|
+
*/
|
|
164367
|
+
readonly page?: number
|
|
164368
|
+
|
|
164369
|
+
/**
|
|
164370
|
+
* Number of items per page
|
|
164371
|
+
*/
|
|
164372
|
+
readonly pageSize?: number
|
|
164373
|
+
|
|
164374
|
+
/**
|
|
164375
|
+
* Field to order by
|
|
164376
|
+
*/
|
|
164377
|
+
readonly orderBy?: string
|
|
164378
|
+
|
|
164379
|
+
/**
|
|
164380
|
+
* Search query
|
|
164381
|
+
*/
|
|
164382
|
+
readonly search?: string
|
|
164244
164383
|
}
|
|
164245
164384
|
|
|
164246
164385
|
/**
|
|
@@ -164313,14 +164452,14 @@ export class ThreadsMessagesApi extends BaseAPI {
|
|
|
164313
164452
|
}
|
|
164314
164453
|
|
|
164315
164454
|
/**
|
|
164316
|
-
* Returns a
|
|
164455
|
+
* 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.
|
|
164317
164456
|
* @summary List a thread\'s messages
|
|
164318
164457
|
* @param {ThreadsMessagesApiGetThreadMessagesRequest} requestParameters Request parameters.
|
|
164319
164458
|
* @param {*} [options] Override http request option.
|
|
164320
164459
|
* @throws {RequiredError}
|
|
164321
164460
|
*/
|
|
164322
164461
|
public getThreadMessages(requestParameters: ThreadsMessagesApiGetThreadMessagesRequest, options?: RawAxiosRequestConfig) {
|
|
164323
|
-
return ThreadsMessagesApiFp(this.configuration).getThreadMessages(requestParameters.threadId, options).then((request) => request(this.axios, this.basePath));
|
|
164462
|
+
return ThreadsMessagesApiFp(this.configuration).getThreadMessages(requestParameters.threadId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
164324
164463
|
}
|
|
164325
164464
|
|
|
164326
164465
|
/**
|
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: 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/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: 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/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: 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).
|
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: 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
|