@connectedxm/admin-sdk 16.7.0 → 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/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @connectedxm/admin-sdk@16.7.0
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.7.0 --save
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.0
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).
@@ -153311,6 +153311,46 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration?: Con
153311
153311
  options: localVarRequestOptions,
153312
153312
  };
153313
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
+ },
153314
153354
  /**
153315
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.
153316
153356
  * @summary Update a stream session
@@ -153595,6 +153635,19 @@ export const StreamsSessionsApiFp = function(configuration?: Configuration) {
153595
153635
  const localVarOperationServerBasePath = operationServerMap['StreamsSessionsApi.getStreamSessions']?.[localVarOperationServerIndex]?.url;
153596
153636
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
153597
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
+ },
153598
153651
  /**
153599
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.
153600
153653
  * @summary Update a stream session
@@ -153768,6 +153821,16 @@ export const StreamsSessionsApiFactory = function (configuration?: Configuration
153768
153821
  getStreamSessions(requestParameters: StreamsSessionsApiGetStreamSessionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAllStreamSessions200Response> {
153769
153822
  return localVarFp.getStreamSessions(requestParameters.streamId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
153770
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
+ },
153771
153834
  /**
153772
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.
153773
153836
  * @summary Update a stream session
@@ -154103,6 +154166,16 @@ export interface StreamsSessionsApiGetStreamSessionsRequest {
154103
154166
  readonly search?: string
154104
154167
  }
154105
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
+
154106
154179
  /**
154107
154180
  * Request parameters for updateStreamSession operation in StreamsSessionsApi.
154108
154181
  */
@@ -154284,6 +154357,17 @@ export class StreamsSessionsApi extends BaseAPI {
154284
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));
154285
154358
  }
154286
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
+
154287
154371
  /**
154288
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.
154289
154373
  * @summary Update a stream session
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.0
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.0
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.7.0
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.7.0
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).
@@ -83636,6 +83636,14 @@ export declare const StreamsSessionsApiAxiosParamCreator: (configuration?: Confi
83636
83636
  * @throws {RequiredError}
83637
83637
  */
83638
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>;
83639
83647
  /**
83640
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.
83641
83649
  * @summary Update a stream session
@@ -83805,6 +83813,14 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
83805
83813
  * @throws {RequiredError}
83806
83814
  */
83807
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>>;
83808
83824
  /**
83809
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.
83810
83826
  * @summary Update a stream session
@@ -83939,6 +83955,14 @@ export declare const StreamsSessionsApiFactory: (configuration?: Configuration,
83939
83955
  * @throws {RequiredError}
83940
83956
  */
83941
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>;
83942
83966
  /**
83943
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.
83944
83968
  * @summary Update a stream session
@@ -84220,6 +84244,15 @@ export interface StreamsSessionsApiGetStreamSessionsRequest {
84220
84244
  */
84221
84245
  readonly search?: string;
84222
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
+ }
84223
84256
  /**
84224
84257
  * Request parameters for updateStreamSession operation in StreamsSessionsApi.
84225
84258
  */
@@ -84354,6 +84387,14 @@ export declare class StreamsSessionsApi extends BaseAPI {
84354
84387
  * @throws {RequiredError}
84355
84388
  */
84356
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>>;
84357
84398
  /**
84358
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.
84359
84400
  * @summary Update a stream session
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: 16.7.0
8
+ * The version of the OpenAPI document: 16.8.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -108622,6 +108622,40 @@ const StreamsSessionsApiAxiosParamCreator = function (configuration) {
108622
108622
  options: localVarRequestOptions,
108623
108623
  };
108624
108624
  }),
108625
+ /**
108626
+ * 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.
108627
+ * @summary Start a stream session
108628
+ * @param {string} streamId The stream identifier
108629
+ * @param {*} [options] Override http request option.
108630
+ * @throws {RequiredError}
108631
+ */
108632
+ startStreamSession: (streamId_1, ...args_1) => __awaiter(this, [streamId_1, ...args_1], void 0, function* (streamId, options = {}) {
108633
+ // verify required parameter 'streamId' is not null or undefined
108634
+ (0, common_1.assertParamExists)('startStreamSession', 'streamId', streamId);
108635
+ const localVarPath = `/streams/{streamId}/sessions`
108636
+ .replace('{streamId}', encodeURIComponent(String(streamId)));
108637
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
108638
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
108639
+ let baseOptions;
108640
+ if (configuration) {
108641
+ baseOptions = configuration.baseOptions;
108642
+ }
108643
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
108644
+ const localVarHeaderParameter = {};
108645
+ const localVarQueryParameter = {};
108646
+ // authentication ApiKeyAuth required
108647
+ yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "api-key", configuration);
108648
+ // authentication OrganizationId required
108649
+ yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "organization", configuration);
108650
+ localVarHeaderParameter['Accept'] = 'application/json';
108651
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
108652
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
108653
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
108654
+ return {
108655
+ url: (0, common_1.toPathString)(localVarUrlObj),
108656
+ options: localVarRequestOptions,
108657
+ };
108658
+ }),
108625
108659
  /**
108626
108660
  * 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.
108627
108661
  * @summary Update a stream session
@@ -108945,6 +108979,22 @@ const StreamsSessionsApiFp = function (configuration) {
108945
108979
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
108946
108980
  });
108947
108981
  },
108982
+ /**
108983
+ * 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.
108984
+ * @summary Start a stream session
108985
+ * @param {string} streamId The stream identifier
108986
+ * @param {*} [options] Override http request option.
108987
+ * @throws {RequiredError}
108988
+ */
108989
+ startStreamSession(streamId, options) {
108990
+ return __awaiter(this, void 0, void 0, function* () {
108991
+ var _a, _b, _c;
108992
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.startStreamSession(streamId, options);
108993
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
108994
+ const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['StreamsSessionsApi.startStreamSession']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
108995
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
108996
+ });
108997
+ },
108948
108998
  /**
108949
108999
  * 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.
108950
109000
  * @summary Update a stream session
@@ -109121,6 +109171,16 @@ const StreamsSessionsApiFactory = function (configuration, basePath, axios) {
109121
109171
  getStreamSessions(requestParameters, options) {
109122
109172
  return localVarFp.getStreamSessions(requestParameters.streamId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
109123
109173
  },
109174
+ /**
109175
+ * 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.
109176
+ * @summary Start a stream session
109177
+ * @param {StreamsSessionsApiStartStreamSessionRequest} requestParameters Request parameters.
109178
+ * @param {*} [options] Override http request option.
109179
+ * @throws {RequiredError}
109180
+ */
109181
+ startStreamSession(requestParameters, options) {
109182
+ return localVarFp.startStreamSession(requestParameters.streamId, options).then((request) => request(axios, basePath));
109183
+ },
109124
109184
  /**
109125
109185
  * 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.
109126
109186
  * @summary Update a stream session
@@ -109288,6 +109348,16 @@ class StreamsSessionsApi extends base_1.BaseAPI {
109288
109348
  getStreamSessions(requestParameters, options) {
109289
109349
  return (0, exports.StreamsSessionsApiFp)(this.configuration).getStreamSessions(requestParameters.streamId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
109290
109350
  }
109351
+ /**
109352
+ * 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.
109353
+ * @summary Start a stream session
109354
+ * @param {StreamsSessionsApiStartStreamSessionRequest} requestParameters Request parameters.
109355
+ * @param {*} [options] Override http request option.
109356
+ * @throws {RequiredError}
109357
+ */
109358
+ startStreamSession(requestParameters, options) {
109359
+ return (0, exports.StreamsSessionsApiFp)(this.configuration).startStreamSession(requestParameters.streamId, options).then((request) => request(this.axios, this.basePath));
109360
+ }
109291
109361
  /**
109292
109362
  * 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.
109293
109363
  * @summary Update a stream session
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: 16.7.0
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/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: 16.7.0
8
+ * The version of the OpenAPI document: 16.8.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: 16.7.0
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/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: 16.7.0
8
+ * The version of the OpenAPI document: 16.8.0
9
9
  *
10
10
  *
11
11
  * 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.7.0
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).
@@ -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.0
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/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.7.0
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).
@@ -83636,6 +83636,14 @@ export declare const StreamsSessionsApiAxiosParamCreator: (configuration?: Confi
83636
83636
  * @throws {RequiredError}
83637
83637
  */
83638
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>;
83639
83647
  /**
83640
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.
83641
83649
  * @summary Update a stream session
@@ -83805,6 +83813,14 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
83805
83813
  * @throws {RequiredError}
83806
83814
  */
83807
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>>;
83808
83824
  /**
83809
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.
83810
83826
  * @summary Update a stream session
@@ -83939,6 +83955,14 @@ export declare const StreamsSessionsApiFactory: (configuration?: Configuration,
83939
83955
  * @throws {RequiredError}
83940
83956
  */
83941
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>;
83942
83966
  /**
83943
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.
83944
83968
  * @summary Update a stream session
@@ -84220,6 +84244,15 @@ export interface StreamsSessionsApiGetStreamSessionsRequest {
84220
84244
  */
84221
84245
  readonly search?: string;
84222
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
+ }
84223
84256
  /**
84224
84257
  * Request parameters for updateStreamSession operation in StreamsSessionsApi.
84225
84258
  */
@@ -84354,6 +84387,14 @@ export declare class StreamsSessionsApi extends BaseAPI {
84354
84387
  * @throws {RequiredError}
84355
84388
  */
84356
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>>;
84357
84398
  /**
84358
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.
84359
84400
  * @summary Update a stream session
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.0
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).
@@ -107841,6 +107841,40 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration) {
107841
107841
  options: localVarRequestOptions,
107842
107842
  };
107843
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
+ }),
107844
107878
  /**
107845
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.
107846
107880
  * @summary Update a stream session
@@ -108163,6 +108197,22 @@ export const StreamsSessionsApiFp = function (configuration) {
108163
108197
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
108164
108198
  });
108165
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
+ },
108166
108216
  /**
108167
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.
108168
108218
  * @summary Update a stream session
@@ -108338,6 +108388,16 @@ export const StreamsSessionsApiFactory = function (configuration, basePath, axio
108338
108388
  getStreamSessions(requestParameters, options) {
108339
108389
  return localVarFp.getStreamSessions(requestParameters.streamId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
108340
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
+ },
108341
108401
  /**
108342
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.
108343
108403
  * @summary Update a stream session
@@ -108504,6 +108564,16 @@ export class StreamsSessionsApi extends BaseAPI {
108504
108564
  getStreamSessions(requestParameters, options) {
108505
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));
108506
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
+ }
108507
108577
  /**
108508
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.
108509
108579
  * @summary Update a stream session
@@ -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.7.0
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.0
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.7.0
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).
@@ -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.0
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.7.0
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.7.0
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).
@@ -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\&#39;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\&#39;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
  |-------------|-------------|------------------|
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@connectedxm/admin-sdk",
3
- "version": "16.7.0",
3
+ "version": "16.8.0",
4
4
  "description": "OpenAPI client for @connectedxm/admin-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {