@connectedxm/admin-sdk 16.7.0 → 16.8.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/api.ts +117 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +66 -1
- package/dist/api.js +71 -1
- 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 +66 -1
- package/dist/esm/api.js +71 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/docs/BaseEventSponsorshipLevel.md +12 -0
- package/docs/EventSponsorshipLevel.md +12 -0
- package/docs/EventSponsorshipLevelCreateInputs.md +12 -0
- package/docs/EventSponsorshipLevelUpdateInputs.md +12 -0
- package/docs/StreamsSessionsApi.md +52 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @connectedxm/admin-sdk@16.
|
|
1
|
+
## @connectedxm/admin-sdk@16.8.1
|
|
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.1 --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.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2147,7 +2147,15 @@ export interface BaseEventSponsorshipLevel {
|
|
|
2147
2147
|
'sponsorCouponPassLimit': number;
|
|
2148
2148
|
'sponsorCouponPassTypeId': string | null;
|
|
2149
2149
|
'bookingSpaceAllowance': number;
|
|
2150
|
+
'price': number | null;
|
|
2151
|
+
'supply': number | null;
|
|
2152
|
+
'purchasable': boolean;
|
|
2153
|
+
'taxCode': string | null;
|
|
2154
|
+
'taxIncluded': boolean;
|
|
2155
|
+
'taxLocation': TaxLocationType;
|
|
2150
2156
|
}
|
|
2157
|
+
|
|
2158
|
+
|
|
2151
2159
|
export interface BaseEventTrack {
|
|
2152
2160
|
'id': string;
|
|
2153
2161
|
'slug': string;
|
|
@@ -7359,12 +7367,20 @@ export interface EventSponsorshipLevel {
|
|
|
7359
7367
|
'sponsorCouponPassLimit': number;
|
|
7360
7368
|
'sponsorCouponPassTypeId': string | null;
|
|
7361
7369
|
'bookingSpaceAllowance': number;
|
|
7370
|
+
'price': number | null;
|
|
7371
|
+
'supply': number | null;
|
|
7372
|
+
'purchasable': boolean;
|
|
7373
|
+
'taxCode': string | null;
|
|
7374
|
+
'taxIncluded': boolean;
|
|
7375
|
+
'taxLocation': TaxLocationType;
|
|
7362
7376
|
'sponsorCouponPassType': BaseEventPassType | null;
|
|
7363
7377
|
'sortOrder': number;
|
|
7364
7378
|
'sponsors': Array<BaseEventSponsorship>;
|
|
7365
7379
|
'createdAt': string;
|
|
7366
7380
|
'updatedAt': string;
|
|
7367
7381
|
}
|
|
7382
|
+
|
|
7383
|
+
|
|
7368
7384
|
export interface EventSponsorshipLevelCreateInputs {
|
|
7369
7385
|
'name': string;
|
|
7370
7386
|
'slug'?: string | null;
|
|
@@ -7381,7 +7397,15 @@ export interface EventSponsorshipLevelCreateInputs {
|
|
|
7381
7397
|
'sponsorCouponPassLimit'?: number;
|
|
7382
7398
|
'sponsorCouponPassTypeId'?: string | null;
|
|
7383
7399
|
'bookingSpaceAllowance'?: number;
|
|
7400
|
+
'price'?: number | null;
|
|
7401
|
+
'supply'?: number | null;
|
|
7402
|
+
'purchasable'?: boolean;
|
|
7403
|
+
'taxCode'?: string | null;
|
|
7404
|
+
'taxIncluded'?: boolean;
|
|
7405
|
+
'taxLocation'?: TaxLocationType;
|
|
7384
7406
|
}
|
|
7407
|
+
|
|
7408
|
+
|
|
7385
7409
|
export interface EventSponsorshipLevelSurvey {
|
|
7386
7410
|
'id': string;
|
|
7387
7411
|
'slug': string;
|
|
@@ -7423,7 +7447,15 @@ export interface EventSponsorshipLevelUpdateInputs {
|
|
|
7423
7447
|
'sponsorCouponPassLimit'?: number;
|
|
7424
7448
|
'sponsorCouponPassTypeId'?: string | null;
|
|
7425
7449
|
'bookingSpaceAllowance'?: number;
|
|
7450
|
+
'price'?: number | null;
|
|
7451
|
+
'supply'?: number | null;
|
|
7452
|
+
'purchasable'?: boolean;
|
|
7453
|
+
'taxCode'?: string | null;
|
|
7454
|
+
'taxIncluded'?: boolean;
|
|
7455
|
+
'taxLocation'?: TaxLocationType;
|
|
7426
7456
|
}
|
|
7457
|
+
|
|
7458
|
+
|
|
7427
7459
|
export interface EventSponsorshipProgress {
|
|
7428
7460
|
'id': string;
|
|
7429
7461
|
'name': string;
|
|
@@ -153311,6 +153343,46 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration?: Con
|
|
|
153311
153343
|
options: localVarRequestOptions,
|
|
153312
153344
|
};
|
|
153313
153345
|
},
|
|
153346
|
+
/**
|
|
153347
|
+
* 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.
|
|
153348
|
+
* @summary Start a stream session
|
|
153349
|
+
* @param {string} streamId The stream identifier
|
|
153350
|
+
* @param {*} [options] Override http request option.
|
|
153351
|
+
* @throws {RequiredError}
|
|
153352
|
+
*/
|
|
153353
|
+
startStreamSession: async (streamId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
153354
|
+
// verify required parameter 'streamId' is not null or undefined
|
|
153355
|
+
assertParamExists('startStreamSession', 'streamId', streamId)
|
|
153356
|
+
const localVarPath = `/streams/{streamId}/sessions`
|
|
153357
|
+
.replace('{streamId}', encodeURIComponent(String(streamId)));
|
|
153358
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
153359
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
153360
|
+
let baseOptions;
|
|
153361
|
+
if (configuration) {
|
|
153362
|
+
baseOptions = configuration.baseOptions;
|
|
153363
|
+
}
|
|
153364
|
+
|
|
153365
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
153366
|
+
const localVarHeaderParameter = {} as any;
|
|
153367
|
+
const localVarQueryParameter = {} as any;
|
|
153368
|
+
|
|
153369
|
+
// authentication ApiKeyAuth required
|
|
153370
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
153371
|
+
|
|
153372
|
+
// authentication OrganizationId required
|
|
153373
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
153374
|
+
|
|
153375
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
153376
|
+
|
|
153377
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
153378
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
153379
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
153380
|
+
|
|
153381
|
+
return {
|
|
153382
|
+
url: toPathString(localVarUrlObj),
|
|
153383
|
+
options: localVarRequestOptions,
|
|
153384
|
+
};
|
|
153385
|
+
},
|
|
153314
153386
|
/**
|
|
153315
153387
|
* 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
153388
|
* @summary Update a stream session
|
|
@@ -153595,6 +153667,19 @@ export const StreamsSessionsApiFp = function(configuration?: Configuration) {
|
|
|
153595
153667
|
const localVarOperationServerBasePath = operationServerMap['StreamsSessionsApi.getStreamSessions']?.[localVarOperationServerIndex]?.url;
|
|
153596
153668
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
153597
153669
|
},
|
|
153670
|
+
/**
|
|
153671
|
+
* 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.
|
|
153672
|
+
* @summary Start a stream session
|
|
153673
|
+
* @param {string} streamId The stream identifier
|
|
153674
|
+
* @param {*} [options] Override http request option.
|
|
153675
|
+
* @throws {RequiredError}
|
|
153676
|
+
*/
|
|
153677
|
+
async startStreamSession(streamId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionById200Response>> {
|
|
153678
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.startStreamSession(streamId, options);
|
|
153679
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
153680
|
+
const localVarOperationServerBasePath = operationServerMap['StreamsSessionsApi.startStreamSession']?.[localVarOperationServerIndex]?.url;
|
|
153681
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
153682
|
+
},
|
|
153598
153683
|
/**
|
|
153599
153684
|
* 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
153685
|
* @summary Update a stream session
|
|
@@ -153768,6 +153853,16 @@ export const StreamsSessionsApiFactory = function (configuration?: Configuration
|
|
|
153768
153853
|
getStreamSessions(requestParameters: StreamsSessionsApiGetStreamSessionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAllStreamSessions200Response> {
|
|
153769
153854
|
return localVarFp.getStreamSessions(requestParameters.streamId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
153770
153855
|
},
|
|
153856
|
+
/**
|
|
153857
|
+
* 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.
|
|
153858
|
+
* @summary Start a stream session
|
|
153859
|
+
* @param {StreamsSessionsApiStartStreamSessionRequest} requestParameters Request parameters.
|
|
153860
|
+
* @param {*} [options] Override http request option.
|
|
153861
|
+
* @throws {RequiredError}
|
|
153862
|
+
*/
|
|
153863
|
+
startStreamSession(requestParameters: StreamsSessionsApiStartStreamSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionById200Response> {
|
|
153864
|
+
return localVarFp.startStreamSession(requestParameters.streamId, options).then((request) => request(axios, basePath));
|
|
153865
|
+
},
|
|
153771
153866
|
/**
|
|
153772
153867
|
* 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
153868
|
* @summary Update a stream session
|
|
@@ -154103,6 +154198,16 @@ export interface StreamsSessionsApiGetStreamSessionsRequest {
|
|
|
154103
154198
|
readonly search?: string
|
|
154104
154199
|
}
|
|
154105
154200
|
|
|
154201
|
+
/**
|
|
154202
|
+
* Request parameters for startStreamSession operation in StreamsSessionsApi.
|
|
154203
|
+
*/
|
|
154204
|
+
export interface StreamsSessionsApiStartStreamSessionRequest {
|
|
154205
|
+
/**
|
|
154206
|
+
* The stream identifier
|
|
154207
|
+
*/
|
|
154208
|
+
readonly streamId: string
|
|
154209
|
+
}
|
|
154210
|
+
|
|
154106
154211
|
/**
|
|
154107
154212
|
* Request parameters for updateStreamSession operation in StreamsSessionsApi.
|
|
154108
154213
|
*/
|
|
@@ -154284,6 +154389,17 @@ export class StreamsSessionsApi extends BaseAPI {
|
|
|
154284
154389
|
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
154390
|
}
|
|
154286
154391
|
|
|
154392
|
+
/**
|
|
154393
|
+
* 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.
|
|
154394
|
+
* @summary Start a stream session
|
|
154395
|
+
* @param {StreamsSessionsApiStartStreamSessionRequest} requestParameters Request parameters.
|
|
154396
|
+
* @param {*} [options] Override http request option.
|
|
154397
|
+
* @throws {RequiredError}
|
|
154398
|
+
*/
|
|
154399
|
+
public startStreamSession(requestParameters: StreamsSessionsApiStartStreamSessionRequest, options?: RawAxiosRequestConfig) {
|
|
154400
|
+
return StreamsSessionsApiFp(this.configuration).startStreamSession(requestParameters.streamId, options).then((request) => request(this.axios, this.basePath));
|
|
154401
|
+
}
|
|
154402
|
+
|
|
154287
154403
|
/**
|
|
154288
154404
|
* 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
154405
|
* @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
|
+
* The version of the OpenAPI document: 16.8.1
|
|
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.1
|
|
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.1
|
|
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.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1980,6 +1980,12 @@ export interface BaseEventSponsorshipLevel {
|
|
|
1980
1980
|
'sponsorCouponPassLimit': number;
|
|
1981
1981
|
'sponsorCouponPassTypeId': string | null;
|
|
1982
1982
|
'bookingSpaceAllowance': number;
|
|
1983
|
+
'price': number | null;
|
|
1984
|
+
'supply': number | null;
|
|
1985
|
+
'purchasable': boolean;
|
|
1986
|
+
'taxCode': string | null;
|
|
1987
|
+
'taxIncluded': boolean;
|
|
1988
|
+
'taxLocation': TaxLocationType;
|
|
1983
1989
|
}
|
|
1984
1990
|
export interface BaseEventTrack {
|
|
1985
1991
|
'id': string;
|
|
@@ -6740,6 +6746,12 @@ export interface EventSponsorshipLevel {
|
|
|
6740
6746
|
'sponsorCouponPassLimit': number;
|
|
6741
6747
|
'sponsorCouponPassTypeId': string | null;
|
|
6742
6748
|
'bookingSpaceAllowance': number;
|
|
6749
|
+
'price': number | null;
|
|
6750
|
+
'supply': number | null;
|
|
6751
|
+
'purchasable': boolean;
|
|
6752
|
+
'taxCode': string | null;
|
|
6753
|
+
'taxIncluded': boolean;
|
|
6754
|
+
'taxLocation': TaxLocationType;
|
|
6743
6755
|
'sponsorCouponPassType': BaseEventPassType | null;
|
|
6744
6756
|
'sortOrder': number;
|
|
6745
6757
|
'sponsors': Array<BaseEventSponsorship>;
|
|
@@ -6762,6 +6774,12 @@ export interface EventSponsorshipLevelCreateInputs {
|
|
|
6762
6774
|
'sponsorCouponPassLimit'?: number;
|
|
6763
6775
|
'sponsorCouponPassTypeId'?: string | null;
|
|
6764
6776
|
'bookingSpaceAllowance'?: number;
|
|
6777
|
+
'price'?: number | null;
|
|
6778
|
+
'supply'?: number | null;
|
|
6779
|
+
'purchasable'?: boolean;
|
|
6780
|
+
'taxCode'?: string | null;
|
|
6781
|
+
'taxIncluded'?: boolean;
|
|
6782
|
+
'taxLocation'?: TaxLocationType;
|
|
6765
6783
|
}
|
|
6766
6784
|
export interface EventSponsorshipLevelSurvey {
|
|
6767
6785
|
'id': string;
|
|
@@ -6802,6 +6820,12 @@ export interface EventSponsorshipLevelUpdateInputs {
|
|
|
6802
6820
|
'sponsorCouponPassLimit'?: number;
|
|
6803
6821
|
'sponsorCouponPassTypeId'?: string | null;
|
|
6804
6822
|
'bookingSpaceAllowance'?: number;
|
|
6823
|
+
'price'?: number | null;
|
|
6824
|
+
'supply'?: number | null;
|
|
6825
|
+
'purchasable'?: boolean;
|
|
6826
|
+
'taxCode'?: string | null;
|
|
6827
|
+
'taxIncluded'?: boolean;
|
|
6828
|
+
'taxLocation'?: TaxLocationType;
|
|
6805
6829
|
}
|
|
6806
6830
|
export interface EventSponsorshipProgress {
|
|
6807
6831
|
'id': string;
|
|
@@ -83636,6 +83660,14 @@ export declare const StreamsSessionsApiAxiosParamCreator: (configuration?: Confi
|
|
|
83636
83660
|
* @throws {RequiredError}
|
|
83637
83661
|
*/
|
|
83638
83662
|
getStreamSessions: (streamId: string, status?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83663
|
+
/**
|
|
83664
|
+
* 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.
|
|
83665
|
+
* @summary Start a stream session
|
|
83666
|
+
* @param {string} streamId The stream identifier
|
|
83667
|
+
* @param {*} [options] Override http request option.
|
|
83668
|
+
* @throws {RequiredError}
|
|
83669
|
+
*/
|
|
83670
|
+
startStreamSession: (streamId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83639
83671
|
/**
|
|
83640
83672
|
* 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
83673
|
* @summary Update a stream session
|
|
@@ -83805,6 +83837,14 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
|
|
|
83805
83837
|
* @throws {RequiredError}
|
|
83806
83838
|
*/
|
|
83807
83839
|
getStreamSessions(streamId: string, status?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAllStreamSessions200Response>>;
|
|
83840
|
+
/**
|
|
83841
|
+
* 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.
|
|
83842
|
+
* @summary Start a stream session
|
|
83843
|
+
* @param {string} streamId The stream identifier
|
|
83844
|
+
* @param {*} [options] Override http request option.
|
|
83845
|
+
* @throws {RequiredError}
|
|
83846
|
+
*/
|
|
83847
|
+
startStreamSession(streamId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionById200Response>>;
|
|
83808
83848
|
/**
|
|
83809
83849
|
* 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
83850
|
* @summary Update a stream session
|
|
@@ -83939,6 +83979,14 @@ export declare const StreamsSessionsApiFactory: (configuration?: Configuration,
|
|
|
83939
83979
|
* @throws {RequiredError}
|
|
83940
83980
|
*/
|
|
83941
83981
|
getStreamSessions(requestParameters: StreamsSessionsApiGetStreamSessionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAllStreamSessions200Response>;
|
|
83982
|
+
/**
|
|
83983
|
+
* 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.
|
|
83984
|
+
* @summary Start a stream session
|
|
83985
|
+
* @param {StreamsSessionsApiStartStreamSessionRequest} requestParameters Request parameters.
|
|
83986
|
+
* @param {*} [options] Override http request option.
|
|
83987
|
+
* @throws {RequiredError}
|
|
83988
|
+
*/
|
|
83989
|
+
startStreamSession(requestParameters: StreamsSessionsApiStartStreamSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionById200Response>;
|
|
83942
83990
|
/**
|
|
83943
83991
|
* 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
83992
|
* @summary Update a stream session
|
|
@@ -84220,6 +84268,15 @@ export interface StreamsSessionsApiGetStreamSessionsRequest {
|
|
|
84220
84268
|
*/
|
|
84221
84269
|
readonly search?: string;
|
|
84222
84270
|
}
|
|
84271
|
+
/**
|
|
84272
|
+
* Request parameters for startStreamSession operation in StreamsSessionsApi.
|
|
84273
|
+
*/
|
|
84274
|
+
export interface StreamsSessionsApiStartStreamSessionRequest {
|
|
84275
|
+
/**
|
|
84276
|
+
* The stream identifier
|
|
84277
|
+
*/
|
|
84278
|
+
readonly streamId: string;
|
|
84279
|
+
}
|
|
84223
84280
|
/**
|
|
84224
84281
|
* Request parameters for updateStreamSession operation in StreamsSessionsApi.
|
|
84225
84282
|
*/
|
|
@@ -84354,6 +84411,14 @@ export declare class StreamsSessionsApi extends BaseAPI {
|
|
|
84354
84411
|
* @throws {RequiredError}
|
|
84355
84412
|
*/
|
|
84356
84413
|
getStreamSessions(requestParameters: StreamsSessionsApiGetStreamSessionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAllStreamSessions200Response, any, {}, any>>;
|
|
84414
|
+
/**
|
|
84415
|
+
* 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.
|
|
84416
|
+
* @summary Start a stream session
|
|
84417
|
+
* @param {StreamsSessionsApiStartStreamSessionRequest} requestParameters Request parameters.
|
|
84418
|
+
* @param {*} [options] Override http request option.
|
|
84419
|
+
* @throws {RequiredError}
|
|
84420
|
+
*/
|
|
84421
|
+
startStreamSession(requestParameters: StreamsSessionsApiStartStreamSessionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamSessionById200Response, any, {}, any>>;
|
|
84357
84422
|
/**
|
|
84358
84423
|
* 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
84424
|
* @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.
|
|
8
|
+
* The version of the OpenAPI document: 16.8.1
|
|
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.
|
|
5
|
+
* The version of the OpenAPI document: 16.8.1
|
|
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.
|
|
8
|
+
* The version of the OpenAPI document: 16.8.1
|
|
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.
|
|
5
|
+
* The version of the OpenAPI document: 16.8.1
|
|
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.
|
|
8
|
+
* The version of the OpenAPI document: 16.8.1
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 16.
|
|
5
|
+
* The version of the OpenAPI document: 16.8.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 16.
|
|
7
|
+
* The version of the OpenAPI document: 16.8.1
|
|
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.
|
|
5
|
+
* The version of the OpenAPI document: 16.8.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1980,6 +1980,12 @@ export interface BaseEventSponsorshipLevel {
|
|
|
1980
1980
|
'sponsorCouponPassLimit': number;
|
|
1981
1981
|
'sponsorCouponPassTypeId': string | null;
|
|
1982
1982
|
'bookingSpaceAllowance': number;
|
|
1983
|
+
'price': number | null;
|
|
1984
|
+
'supply': number | null;
|
|
1985
|
+
'purchasable': boolean;
|
|
1986
|
+
'taxCode': string | null;
|
|
1987
|
+
'taxIncluded': boolean;
|
|
1988
|
+
'taxLocation': TaxLocationType;
|
|
1983
1989
|
}
|
|
1984
1990
|
export interface BaseEventTrack {
|
|
1985
1991
|
'id': string;
|
|
@@ -6740,6 +6746,12 @@ export interface EventSponsorshipLevel {
|
|
|
6740
6746
|
'sponsorCouponPassLimit': number;
|
|
6741
6747
|
'sponsorCouponPassTypeId': string | null;
|
|
6742
6748
|
'bookingSpaceAllowance': number;
|
|
6749
|
+
'price': number | null;
|
|
6750
|
+
'supply': number | null;
|
|
6751
|
+
'purchasable': boolean;
|
|
6752
|
+
'taxCode': string | null;
|
|
6753
|
+
'taxIncluded': boolean;
|
|
6754
|
+
'taxLocation': TaxLocationType;
|
|
6743
6755
|
'sponsorCouponPassType': BaseEventPassType | null;
|
|
6744
6756
|
'sortOrder': number;
|
|
6745
6757
|
'sponsors': Array<BaseEventSponsorship>;
|
|
@@ -6762,6 +6774,12 @@ export interface EventSponsorshipLevelCreateInputs {
|
|
|
6762
6774
|
'sponsorCouponPassLimit'?: number;
|
|
6763
6775
|
'sponsorCouponPassTypeId'?: string | null;
|
|
6764
6776
|
'bookingSpaceAllowance'?: number;
|
|
6777
|
+
'price'?: number | null;
|
|
6778
|
+
'supply'?: number | null;
|
|
6779
|
+
'purchasable'?: boolean;
|
|
6780
|
+
'taxCode'?: string | null;
|
|
6781
|
+
'taxIncluded'?: boolean;
|
|
6782
|
+
'taxLocation'?: TaxLocationType;
|
|
6765
6783
|
}
|
|
6766
6784
|
export interface EventSponsorshipLevelSurvey {
|
|
6767
6785
|
'id': string;
|
|
@@ -6802,6 +6820,12 @@ export interface EventSponsorshipLevelUpdateInputs {
|
|
|
6802
6820
|
'sponsorCouponPassLimit'?: number;
|
|
6803
6821
|
'sponsorCouponPassTypeId'?: string | null;
|
|
6804
6822
|
'bookingSpaceAllowance'?: number;
|
|
6823
|
+
'price'?: number | null;
|
|
6824
|
+
'supply'?: number | null;
|
|
6825
|
+
'purchasable'?: boolean;
|
|
6826
|
+
'taxCode'?: string | null;
|
|
6827
|
+
'taxIncluded'?: boolean;
|
|
6828
|
+
'taxLocation'?: TaxLocationType;
|
|
6805
6829
|
}
|
|
6806
6830
|
export interface EventSponsorshipProgress {
|
|
6807
6831
|
'id': string;
|
|
@@ -83636,6 +83660,14 @@ export declare const StreamsSessionsApiAxiosParamCreator: (configuration?: Confi
|
|
|
83636
83660
|
* @throws {RequiredError}
|
|
83637
83661
|
*/
|
|
83638
83662
|
getStreamSessions: (streamId: string, status?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83663
|
+
/**
|
|
83664
|
+
* 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.
|
|
83665
|
+
* @summary Start a stream session
|
|
83666
|
+
* @param {string} streamId The stream identifier
|
|
83667
|
+
* @param {*} [options] Override http request option.
|
|
83668
|
+
* @throws {RequiredError}
|
|
83669
|
+
*/
|
|
83670
|
+
startStreamSession: (streamId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83639
83671
|
/**
|
|
83640
83672
|
* 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
83673
|
* @summary Update a stream session
|
|
@@ -83805,6 +83837,14 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
|
|
|
83805
83837
|
* @throws {RequiredError}
|
|
83806
83838
|
*/
|
|
83807
83839
|
getStreamSessions(streamId: string, status?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAllStreamSessions200Response>>;
|
|
83840
|
+
/**
|
|
83841
|
+
* 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.
|
|
83842
|
+
* @summary Start a stream session
|
|
83843
|
+
* @param {string} streamId The stream identifier
|
|
83844
|
+
* @param {*} [options] Override http request option.
|
|
83845
|
+
* @throws {RequiredError}
|
|
83846
|
+
*/
|
|
83847
|
+
startStreamSession(streamId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionById200Response>>;
|
|
83808
83848
|
/**
|
|
83809
83849
|
* 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
83850
|
* @summary Update a stream session
|
|
@@ -83939,6 +83979,14 @@ export declare const StreamsSessionsApiFactory: (configuration?: Configuration,
|
|
|
83939
83979
|
* @throws {RequiredError}
|
|
83940
83980
|
*/
|
|
83941
83981
|
getStreamSessions(requestParameters: StreamsSessionsApiGetStreamSessionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAllStreamSessions200Response>;
|
|
83982
|
+
/**
|
|
83983
|
+
* 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.
|
|
83984
|
+
* @summary Start a stream session
|
|
83985
|
+
* @param {StreamsSessionsApiStartStreamSessionRequest} requestParameters Request parameters.
|
|
83986
|
+
* @param {*} [options] Override http request option.
|
|
83987
|
+
* @throws {RequiredError}
|
|
83988
|
+
*/
|
|
83989
|
+
startStreamSession(requestParameters: StreamsSessionsApiStartStreamSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionById200Response>;
|
|
83942
83990
|
/**
|
|
83943
83991
|
* 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
83992
|
* @summary Update a stream session
|
|
@@ -84220,6 +84268,15 @@ export interface StreamsSessionsApiGetStreamSessionsRequest {
|
|
|
84220
84268
|
*/
|
|
84221
84269
|
readonly search?: string;
|
|
84222
84270
|
}
|
|
84271
|
+
/**
|
|
84272
|
+
* Request parameters for startStreamSession operation in StreamsSessionsApi.
|
|
84273
|
+
*/
|
|
84274
|
+
export interface StreamsSessionsApiStartStreamSessionRequest {
|
|
84275
|
+
/**
|
|
84276
|
+
* The stream identifier
|
|
84277
|
+
*/
|
|
84278
|
+
readonly streamId: string;
|
|
84279
|
+
}
|
|
84223
84280
|
/**
|
|
84224
84281
|
* Request parameters for updateStreamSession operation in StreamsSessionsApi.
|
|
84225
84282
|
*/
|
|
@@ -84354,6 +84411,14 @@ export declare class StreamsSessionsApi extends BaseAPI {
|
|
|
84354
84411
|
* @throws {RequiredError}
|
|
84355
84412
|
*/
|
|
84356
84413
|
getStreamSessions(requestParameters: StreamsSessionsApiGetStreamSessionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAllStreamSessions200Response, any, {}, any>>;
|
|
84414
|
+
/**
|
|
84415
|
+
* 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.
|
|
84416
|
+
* @summary Start a stream session
|
|
84417
|
+
* @param {StreamsSessionsApiStartStreamSessionRequest} requestParameters Request parameters.
|
|
84418
|
+
* @param {*} [options] Override http request option.
|
|
84419
|
+
* @throws {RequiredError}
|
|
84420
|
+
*/
|
|
84421
|
+
startStreamSession(requestParameters: StreamsSessionsApiStartStreamSessionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamSessionById200Response, any, {}, any>>;
|
|
84357
84422
|
/**
|
|
84358
84423
|
* 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
84424
|
* @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
|
+
* The version of the OpenAPI document: 16.8.1
|
|
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
|
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.1
|
|
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.1
|
|
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.1
|
|
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.1
|
|
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.1
|
|
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.1
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -20,6 +20,12 @@ Name | Type | Description | Notes
|
|
|
20
20
|
**sponsorCouponPassLimit** | **number** | | [default to undefined]
|
|
21
21
|
**sponsorCouponPassTypeId** | **string** | | [default to undefined]
|
|
22
22
|
**bookingSpaceAllowance** | **number** | | [default to undefined]
|
|
23
|
+
**price** | **number** | | [default to undefined]
|
|
24
|
+
**supply** | **number** | | [default to undefined]
|
|
25
|
+
**purchasable** | **boolean** | | [default to undefined]
|
|
26
|
+
**taxCode** | **string** | | [default to undefined]
|
|
27
|
+
**taxIncluded** | **boolean** | | [default to undefined]
|
|
28
|
+
**taxLocation** | [**TaxLocationType**](TaxLocationType.md) | | [default to undefined]
|
|
23
29
|
|
|
24
30
|
## Example
|
|
25
31
|
|
|
@@ -42,6 +48,12 @@ const instance: BaseEventSponsorshipLevel = {
|
|
|
42
48
|
sponsorCouponPassLimit,
|
|
43
49
|
sponsorCouponPassTypeId,
|
|
44
50
|
bookingSpaceAllowance,
|
|
51
|
+
price,
|
|
52
|
+
supply,
|
|
53
|
+
purchasable,
|
|
54
|
+
taxCode,
|
|
55
|
+
taxIncluded,
|
|
56
|
+
taxLocation,
|
|
45
57
|
};
|
|
46
58
|
```
|
|
47
59
|
|
|
@@ -20,6 +20,12 @@ Name | Type | Description | Notes
|
|
|
20
20
|
**sponsorCouponPassLimit** | **number** | | [default to undefined]
|
|
21
21
|
**sponsorCouponPassTypeId** | **string** | | [default to undefined]
|
|
22
22
|
**bookingSpaceAllowance** | **number** | | [default to undefined]
|
|
23
|
+
**price** | **number** | | [default to undefined]
|
|
24
|
+
**supply** | **number** | | [default to undefined]
|
|
25
|
+
**purchasable** | **boolean** | | [default to undefined]
|
|
26
|
+
**taxCode** | **string** | | [default to undefined]
|
|
27
|
+
**taxIncluded** | **boolean** | | [default to undefined]
|
|
28
|
+
**taxLocation** | [**TaxLocationType**](TaxLocationType.md) | | [default to undefined]
|
|
23
29
|
**sponsorCouponPassType** | [**BaseEventPassType**](BaseEventPassType.md) | | [default to undefined]
|
|
24
30
|
**sortOrder** | **number** | | [default to undefined]
|
|
25
31
|
**sponsors** | [**Array<BaseEventSponsorship>**](BaseEventSponsorship.md) | | [default to undefined]
|
|
@@ -47,6 +53,12 @@ const instance: EventSponsorshipLevel = {
|
|
|
47
53
|
sponsorCouponPassLimit,
|
|
48
54
|
sponsorCouponPassTypeId,
|
|
49
55
|
bookingSpaceAllowance,
|
|
56
|
+
price,
|
|
57
|
+
supply,
|
|
58
|
+
purchasable,
|
|
59
|
+
taxCode,
|
|
60
|
+
taxIncluded,
|
|
61
|
+
taxLocation,
|
|
50
62
|
sponsorCouponPassType,
|
|
51
63
|
sortOrder,
|
|
52
64
|
sponsors,
|
|
@@ -20,6 +20,12 @@ Name | Type | Description | Notes
|
|
|
20
20
|
**sponsorCouponPassLimit** | **number** | | [optional] [default to undefined]
|
|
21
21
|
**sponsorCouponPassTypeId** | **string** | | [optional] [default to undefined]
|
|
22
22
|
**bookingSpaceAllowance** | **number** | | [optional] [default to undefined]
|
|
23
|
+
**price** | **number** | | [optional] [default to undefined]
|
|
24
|
+
**supply** | **number** | | [optional] [default to undefined]
|
|
25
|
+
**purchasable** | **boolean** | | [optional] [default to undefined]
|
|
26
|
+
**taxCode** | **string** | | [optional] [default to undefined]
|
|
27
|
+
**taxIncluded** | **boolean** | | [optional] [default to undefined]
|
|
28
|
+
**taxLocation** | [**TaxLocationType**](TaxLocationType.md) | | [optional] [default to undefined]
|
|
23
29
|
|
|
24
30
|
## Example
|
|
25
31
|
|
|
@@ -42,6 +48,12 @@ const instance: EventSponsorshipLevelCreateInputs = {
|
|
|
42
48
|
sponsorCouponPassLimit,
|
|
43
49
|
sponsorCouponPassTypeId,
|
|
44
50
|
bookingSpaceAllowance,
|
|
51
|
+
price,
|
|
52
|
+
supply,
|
|
53
|
+
purchasable,
|
|
54
|
+
taxCode,
|
|
55
|
+
taxIncluded,
|
|
56
|
+
taxLocation,
|
|
45
57
|
};
|
|
46
58
|
```
|
|
47
59
|
|
|
@@ -20,6 +20,12 @@ Name | Type | Description | Notes
|
|
|
20
20
|
**sponsorCouponPassLimit** | **number** | | [optional] [default to undefined]
|
|
21
21
|
**sponsorCouponPassTypeId** | **string** | | [optional] [default to undefined]
|
|
22
22
|
**bookingSpaceAllowance** | **number** | | [optional] [default to undefined]
|
|
23
|
+
**price** | **number** | | [optional] [default to undefined]
|
|
24
|
+
**supply** | **number** | | [optional] [default to undefined]
|
|
25
|
+
**purchasable** | **boolean** | | [optional] [default to undefined]
|
|
26
|
+
**taxCode** | **string** | | [optional] [default to undefined]
|
|
27
|
+
**taxIncluded** | **boolean** | | [optional] [default to undefined]
|
|
28
|
+
**taxLocation** | [**TaxLocationType**](TaxLocationType.md) | | [optional] [default to undefined]
|
|
23
29
|
|
|
24
30
|
## Example
|
|
25
31
|
|
|
@@ -42,6 +48,12 @@ const instance: EventSponsorshipLevelUpdateInputs = {
|
|
|
42
48
|
sponsorCouponPassLimit,
|
|
43
49
|
sponsorCouponPassTypeId,
|
|
44
50
|
bookingSpaceAllowance,
|
|
51
|
+
price,
|
|
52
|
+
supply,
|
|
53
|
+
purchasable,
|
|
54
|
+
taxCode,
|
|
55
|
+
taxIncluded,
|
|
56
|
+
taxLocation,
|
|
45
57
|
};
|
|
46
58
|
```
|
|
47
59
|
|
|
@@ -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
|
|-------------|-------------|------------------|
|