yellowgrid-api-ts 3.2.357 → 3.2.359
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 +1 -0
- package/api.ts +25 -9
- package/dist/api.d.ts +18 -7
- package/dist/api.js +18 -7
- package/docs/Class3CXApi.md +4 -4
- package/docs/OAuth20Api.md +8 -5
- package/docs/TcxServicePrincipalEntity.md +2 -0
- package/package.json +1 -1
package/README.md
CHANGED
package/api.ts
CHANGED
|
@@ -10912,6 +10912,10 @@ export interface TcxServicePrincipalEntity {
|
|
|
10912
10912
|
* id
|
|
10913
10913
|
*/
|
|
10914
10914
|
'id': string;
|
|
10915
|
+
/**
|
|
10916
|
+
* customerId
|
|
10917
|
+
*/
|
|
10918
|
+
'customerId': number;
|
|
10915
10919
|
/**
|
|
10916
10920
|
* pbxBase
|
|
10917
10921
|
*/
|
|
@@ -21092,6 +21096,7 @@ export const Class3CXApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
21092
21096
|
const localVarHeaderParameter = {} as any;
|
|
21093
21097
|
const localVarQueryParameter = {} as any;
|
|
21094
21098
|
|
|
21099
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
21095
21100
|
|
|
21096
21101
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
21097
21102
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -21260,7 +21265,7 @@ export const Class3CXApiFp = function(configuration?: Configuration) {
|
|
|
21260
21265
|
* @param {*} [options] Override http request option.
|
|
21261
21266
|
* @throws {RequiredError}
|
|
21262
21267
|
*/
|
|
21263
|
-
async postAuthenticateInstanceWebsocket(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
21268
|
+
async postAuthenticateInstanceWebsocket(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TcxInstallationModel>> {
|
|
21264
21269
|
const localVarAxiosArgs = await localVarAxiosParamCreator.postAuthenticateInstanceWebsocket(id, options);
|
|
21265
21270
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
21266
21271
|
const localVarOperationServerBasePath = operationServerMap['Class3CXApi.postAuthenticateInstanceWebsocket']?.[localVarOperationServerIndex]?.url;
|
|
@@ -21377,7 +21382,7 @@ export const Class3CXApiFactory = function (configuration?: Configuration, baseP
|
|
|
21377
21382
|
* @param {*} [options] Override http request option.
|
|
21378
21383
|
* @throws {RequiredError}
|
|
21379
21384
|
*/
|
|
21380
|
-
postAuthenticateInstanceWebsocket(id: string, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
21385
|
+
postAuthenticateInstanceWebsocket(id: string, options?: RawAxiosRequestConfig): AxiosPromise<TcxInstallationModel> {
|
|
21381
21386
|
return localVarFp.postAuthenticateInstanceWebsocket(id, options).then((request) => request(axios, basePath));
|
|
21382
21387
|
},
|
|
21383
21388
|
/**
|
|
@@ -28559,10 +28564,11 @@ export const OAuth20ApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
28559
28564
|
* @param {PostAccessTokenTokenExchangeTypeEnum} [tokenExchangeType] Token Exchange Type (Only used in Token Exchange)
|
|
28560
28565
|
* @param {string | null} [licenceKey] 3CX Licence Key (Only used in Token Exchange)
|
|
28561
28566
|
* @param {boolean | null} [endUser] End User (Only used in Token Exchange)
|
|
28567
|
+
* @param {string | null} [instanceId] 3CX Instance ID (Only used in Token Exchange)
|
|
28562
28568
|
* @param {*} [options] Override http request option.
|
|
28563
28569
|
* @throws {RequiredError}
|
|
28564
28570
|
*/
|
|
28565
|
-
postAccessToken: async (clientId?: string | null, clientSecret?: string | null, grantType?: PostAccessTokenGrantTypeEnum, scope?: PostAccessTokenScopeEnum, redirectUri?: string | null, code?: string | null, refreshToken?: string | null, codeVerifier?: string | null, token?: string | null, tokenExchangeType?: PostAccessTokenTokenExchangeTypeEnum, licenceKey?: string | null, endUser?: boolean | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
28571
|
+
postAccessToken: async (clientId?: string | null, clientSecret?: string | null, grantType?: PostAccessTokenGrantTypeEnum, scope?: PostAccessTokenScopeEnum, redirectUri?: string | null, code?: string | null, refreshToken?: string | null, codeVerifier?: string | null, token?: string | null, tokenExchangeType?: PostAccessTokenTokenExchangeTypeEnum, licenceKey?: string | null, endUser?: boolean | null, instanceId?: string | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
28566
28572
|
const localVarPath = `/oauth2/access_token`;
|
|
28567
28573
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
28568
28574
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -28624,6 +28630,10 @@ export const OAuth20ApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
28624
28630
|
if (endUser !== undefined) {
|
|
28625
28631
|
localVarFormParams.set('end_user', endUser as any);
|
|
28626
28632
|
}
|
|
28633
|
+
|
|
28634
|
+
if (instanceId !== undefined) {
|
|
28635
|
+
localVarFormParams.set('instance_id', instanceId as any);
|
|
28636
|
+
}
|
|
28627
28637
|
localVarHeaderParameter['Content-Type'] = 'application/x-www-form-urlencoded';
|
|
28628
28638
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
28629
28639
|
|
|
@@ -28846,11 +28856,12 @@ export const OAuth20ApiFp = function(configuration?: Configuration) {
|
|
|
28846
28856
|
* @param {PostAccessTokenTokenExchangeTypeEnum} [tokenExchangeType] Token Exchange Type (Only used in Token Exchange)
|
|
28847
28857
|
* @param {string | null} [licenceKey] 3CX Licence Key (Only used in Token Exchange)
|
|
28848
28858
|
* @param {boolean | null} [endUser] End User (Only used in Token Exchange)
|
|
28859
|
+
* @param {string | null} [instanceId] 3CX Instance ID (Only used in Token Exchange)
|
|
28849
28860
|
* @param {*} [options] Override http request option.
|
|
28850
28861
|
* @throws {RequiredError}
|
|
28851
28862
|
*/
|
|
28852
|
-
async postAccessToken(clientId?: string | null, clientSecret?: string | null, grantType?: PostAccessTokenGrantTypeEnum, scope?: PostAccessTokenScopeEnum, redirectUri?: string | null, code?: string | null, refreshToken?: string | null, codeVerifier?: string | null, token?: string | null, tokenExchangeType?: PostAccessTokenTokenExchangeTypeEnum, licenceKey?: string | null, endUser?: boolean | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TokenResponseModel>> {
|
|
28853
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.postAccessToken(clientId, clientSecret, grantType, scope, redirectUri, code, refreshToken, codeVerifier, token, tokenExchangeType, licenceKey, endUser, options);
|
|
28863
|
+
async postAccessToken(clientId?: string | null, clientSecret?: string | null, grantType?: PostAccessTokenGrantTypeEnum, scope?: PostAccessTokenScopeEnum, redirectUri?: string | null, code?: string | null, refreshToken?: string | null, codeVerifier?: string | null, token?: string | null, tokenExchangeType?: PostAccessTokenTokenExchangeTypeEnum, licenceKey?: string | null, endUser?: boolean | null, instanceId?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TokenResponseModel>> {
|
|
28864
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.postAccessToken(clientId, clientSecret, grantType, scope, redirectUri, code, refreshToken, codeVerifier, token, tokenExchangeType, licenceKey, endUser, instanceId, options);
|
|
28854
28865
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
28855
28866
|
const localVarOperationServerBasePath = operationServerMap['OAuth20Api.postAccessToken']?.[localVarOperationServerIndex]?.url;
|
|
28856
28867
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -28952,11 +28963,12 @@ export const OAuth20ApiFactory = function (configuration?: Configuration, basePa
|
|
|
28952
28963
|
* @param {PostAccessTokenTokenExchangeTypeEnum} [tokenExchangeType] Token Exchange Type (Only used in Token Exchange)
|
|
28953
28964
|
* @param {string | null} [licenceKey] 3CX Licence Key (Only used in Token Exchange)
|
|
28954
28965
|
* @param {boolean | null} [endUser] End User (Only used in Token Exchange)
|
|
28966
|
+
* @param {string | null} [instanceId] 3CX Instance ID (Only used in Token Exchange)
|
|
28955
28967
|
* @param {*} [options] Override http request option.
|
|
28956
28968
|
* @throws {RequiredError}
|
|
28957
28969
|
*/
|
|
28958
|
-
postAccessToken(clientId?: string | null, clientSecret?: string | null, grantType?: PostAccessTokenGrantTypeEnum, scope?: PostAccessTokenScopeEnum, redirectUri?: string | null, code?: string | null, refreshToken?: string | null, codeVerifier?: string | null, token?: string | null, tokenExchangeType?: PostAccessTokenTokenExchangeTypeEnum, licenceKey?: string | null, endUser?: boolean | null, options?: RawAxiosRequestConfig): AxiosPromise<TokenResponseModel> {
|
|
28959
|
-
return localVarFp.postAccessToken(clientId, clientSecret, grantType, scope, redirectUri, code, refreshToken, codeVerifier, token, tokenExchangeType, licenceKey, endUser, options).then((request) => request(axios, basePath));
|
|
28970
|
+
postAccessToken(clientId?: string | null, clientSecret?: string | null, grantType?: PostAccessTokenGrantTypeEnum, scope?: PostAccessTokenScopeEnum, redirectUri?: string | null, code?: string | null, refreshToken?: string | null, codeVerifier?: string | null, token?: string | null, tokenExchangeType?: PostAccessTokenTokenExchangeTypeEnum, licenceKey?: string | null, endUser?: boolean | null, instanceId?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<TokenResponseModel> {
|
|
28971
|
+
return localVarFp.postAccessToken(clientId, clientSecret, grantType, scope, redirectUri, code, refreshToken, codeVerifier, token, tokenExchangeType, licenceKey, endUser, instanceId, options).then((request) => request(axios, basePath));
|
|
28960
28972
|
},
|
|
28961
28973
|
/**
|
|
28962
28974
|
* Get an OAuth 2.0 auth code
|
|
@@ -29043,11 +29055,12 @@ export class OAuth20Api extends BaseAPI {
|
|
|
29043
29055
|
* @param {PostAccessTokenTokenExchangeTypeEnum} [tokenExchangeType] Token Exchange Type (Only used in Token Exchange)
|
|
29044
29056
|
* @param {string | null} [licenceKey] 3CX Licence Key (Only used in Token Exchange)
|
|
29045
29057
|
* @param {boolean | null} [endUser] End User (Only used in Token Exchange)
|
|
29058
|
+
* @param {string | null} [instanceId] 3CX Instance ID (Only used in Token Exchange)
|
|
29046
29059
|
* @param {*} [options] Override http request option.
|
|
29047
29060
|
* @throws {RequiredError}
|
|
29048
29061
|
*/
|
|
29049
|
-
public postAccessToken(clientId?: string | null, clientSecret?: string | null, grantType?: PostAccessTokenGrantTypeEnum, scope?: PostAccessTokenScopeEnum, redirectUri?: string | null, code?: string | null, refreshToken?: string | null, codeVerifier?: string | null, token?: string | null, tokenExchangeType?: PostAccessTokenTokenExchangeTypeEnum, licenceKey?: string | null, endUser?: boolean | null, options?: RawAxiosRequestConfig) {
|
|
29050
|
-
return OAuth20ApiFp(this.configuration).postAccessToken(clientId, clientSecret, grantType, scope, redirectUri, code, refreshToken, codeVerifier, token, tokenExchangeType, licenceKey, endUser, options).then((request) => request(this.axios, this.basePath));
|
|
29062
|
+
public postAccessToken(clientId?: string | null, clientSecret?: string | null, grantType?: PostAccessTokenGrantTypeEnum, scope?: PostAccessTokenScopeEnum, redirectUri?: string | null, code?: string | null, refreshToken?: string | null, codeVerifier?: string | null, token?: string | null, tokenExchangeType?: PostAccessTokenTokenExchangeTypeEnum, licenceKey?: string | null, endUser?: boolean | null, instanceId?: string | null, options?: RawAxiosRequestConfig) {
|
|
29063
|
+
return OAuth20ApiFp(this.configuration).postAccessToken(clientId, clientSecret, grantType, scope, redirectUri, code, refreshToken, codeVerifier, token, tokenExchangeType, licenceKey, endUser, instanceId, options).then((request) => request(this.axios, this.basePath));
|
|
29051
29064
|
}
|
|
29052
29065
|
|
|
29053
29066
|
/**
|
|
@@ -29141,12 +29154,14 @@ export const PostAccessTokenScopeEnum = {
|
|
|
29141
29154
|
TcxMtWrite: 'tcx_mt.write',
|
|
29142
29155
|
TicketsRead: 'tickets.read',
|
|
29143
29156
|
TicketsWrite: 'tickets.write',
|
|
29157
|
+
TccRead: 'tcc.read',
|
|
29144
29158
|
} as const;
|
|
29145
29159
|
export type PostAccessTokenScopeEnum = typeof PostAccessTokenScopeEnum[keyof typeof PostAccessTokenScopeEnum];
|
|
29146
29160
|
export const PostAccessTokenTokenExchangeTypeEnum = {
|
|
29147
29161
|
TcxWizard: 'tcx_wizard',
|
|
29148
29162
|
TcxWizardAdmin: 'tcx_wizard_admin',
|
|
29149
29163
|
Portal: 'portal',
|
|
29164
|
+
TcxTcc: 'tcx_tcc',
|
|
29150
29165
|
} as const;
|
|
29151
29166
|
export type PostAccessTokenTokenExchangeTypeEnum = typeof PostAccessTokenTokenExchangeTypeEnum[keyof typeof PostAccessTokenTokenExchangeTypeEnum];
|
|
29152
29167
|
export const PostAuthoriseScopeEnum = {
|
|
@@ -29182,6 +29197,7 @@ export const PostAuthoriseScopeEnum = {
|
|
|
29182
29197
|
TcxMtWrite: 'tcx_mt.write',
|
|
29183
29198
|
TicketsRead: 'tickets.read',
|
|
29184
29199
|
TicketsWrite: 'tickets.write',
|
|
29200
|
+
TccRead: 'tcc.read',
|
|
29185
29201
|
} as const;
|
|
29186
29202
|
export type PostAuthoriseScopeEnum = typeof PostAuthoriseScopeEnum[keyof typeof PostAuthoriseScopeEnum];
|
|
29187
29203
|
|
package/dist/api.d.ts
CHANGED
|
@@ -10714,6 +10714,10 @@ export interface TcxServicePrincipalEntity {
|
|
|
10714
10714
|
* id
|
|
10715
10715
|
*/
|
|
10716
10716
|
'id': string;
|
|
10717
|
+
/**
|
|
10718
|
+
* customerId
|
|
10719
|
+
*/
|
|
10720
|
+
'customerId': number;
|
|
10717
10721
|
/**
|
|
10718
10722
|
* pbxBase
|
|
10719
10723
|
*/
|
|
@@ -15700,7 +15704,7 @@ export declare const Class3CXApiFp: (configuration?: Configuration) => {
|
|
|
15700
15704
|
* @param {*} [options] Override http request option.
|
|
15701
15705
|
* @throws {RequiredError}
|
|
15702
15706
|
*/
|
|
15703
|
-
postAuthenticateInstanceWebsocket(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
15707
|
+
postAuthenticateInstanceWebsocket(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TcxInstallationModel>>;
|
|
15704
15708
|
/**
|
|
15705
15709
|
* Get Bulk 3CX Licence Details
|
|
15706
15710
|
* @summary Get bulk 3CX Licence Details
|
|
@@ -15785,7 +15789,7 @@ export declare const Class3CXApiFactory: (configuration?: Configuration, basePat
|
|
|
15785
15789
|
* @param {*} [options] Override http request option.
|
|
15786
15790
|
* @throws {RequiredError}
|
|
15787
15791
|
*/
|
|
15788
|
-
postAuthenticateInstanceWebsocket(id: string, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
15792
|
+
postAuthenticateInstanceWebsocket(id: string, options?: RawAxiosRequestConfig): AxiosPromise<TcxInstallationModel>;
|
|
15789
15793
|
/**
|
|
15790
15794
|
* Get Bulk 3CX Licence Details
|
|
15791
15795
|
* @summary Get bulk 3CX Licence Details
|
|
@@ -15870,7 +15874,7 @@ export declare class Class3CXApi extends BaseAPI {
|
|
|
15870
15874
|
* @param {*} [options] Override http request option.
|
|
15871
15875
|
* @throws {RequiredError}
|
|
15872
15876
|
*/
|
|
15873
|
-
postAuthenticateInstanceWebsocket(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<
|
|
15877
|
+
postAuthenticateInstanceWebsocket(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<TcxInstallationModel, any, {}, any>>;
|
|
15874
15878
|
/**
|
|
15875
15879
|
* Get Bulk 3CX Licence Details
|
|
15876
15880
|
* @summary Get bulk 3CX Licence Details
|
|
@@ -19185,10 +19189,11 @@ export declare const OAuth20ApiAxiosParamCreator: (configuration?: Configuration
|
|
|
19185
19189
|
* @param {PostAccessTokenTokenExchangeTypeEnum} [tokenExchangeType] Token Exchange Type (Only used in Token Exchange)
|
|
19186
19190
|
* @param {string | null} [licenceKey] 3CX Licence Key (Only used in Token Exchange)
|
|
19187
19191
|
* @param {boolean | null} [endUser] End User (Only used in Token Exchange)
|
|
19192
|
+
* @param {string | null} [instanceId] 3CX Instance ID (Only used in Token Exchange)
|
|
19188
19193
|
* @param {*} [options] Override http request option.
|
|
19189
19194
|
* @throws {RequiredError}
|
|
19190
19195
|
*/
|
|
19191
|
-
postAccessToken: (clientId?: string | null, clientSecret?: string | null, grantType?: PostAccessTokenGrantTypeEnum, scope?: PostAccessTokenScopeEnum, redirectUri?: string | null, code?: string | null, refreshToken?: string | null, codeVerifier?: string | null, token?: string | null, tokenExchangeType?: PostAccessTokenTokenExchangeTypeEnum, licenceKey?: string | null, endUser?: boolean | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
19196
|
+
postAccessToken: (clientId?: string | null, clientSecret?: string | null, grantType?: PostAccessTokenGrantTypeEnum, scope?: PostAccessTokenScopeEnum, redirectUri?: string | null, code?: string | null, refreshToken?: string | null, codeVerifier?: string | null, token?: string | null, tokenExchangeType?: PostAccessTokenTokenExchangeTypeEnum, licenceKey?: string | null, endUser?: boolean | null, instanceId?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
19192
19197
|
/**
|
|
19193
19198
|
* Get an OAuth 2.0 auth code
|
|
19194
19199
|
* @summary Get OAuth2.0 Auth Code
|
|
@@ -19258,10 +19263,11 @@ export declare const OAuth20ApiFp: (configuration?: Configuration) => {
|
|
|
19258
19263
|
* @param {PostAccessTokenTokenExchangeTypeEnum} [tokenExchangeType] Token Exchange Type (Only used in Token Exchange)
|
|
19259
19264
|
* @param {string | null} [licenceKey] 3CX Licence Key (Only used in Token Exchange)
|
|
19260
19265
|
* @param {boolean | null} [endUser] End User (Only used in Token Exchange)
|
|
19266
|
+
* @param {string | null} [instanceId] 3CX Instance ID (Only used in Token Exchange)
|
|
19261
19267
|
* @param {*} [options] Override http request option.
|
|
19262
19268
|
* @throws {RequiredError}
|
|
19263
19269
|
*/
|
|
19264
|
-
postAccessToken(clientId?: string | null, clientSecret?: string | null, grantType?: PostAccessTokenGrantTypeEnum, scope?: PostAccessTokenScopeEnum, redirectUri?: string | null, code?: string | null, refreshToken?: string | null, codeVerifier?: string | null, token?: string | null, tokenExchangeType?: PostAccessTokenTokenExchangeTypeEnum, licenceKey?: string | null, endUser?: boolean | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TokenResponseModel>>;
|
|
19270
|
+
postAccessToken(clientId?: string | null, clientSecret?: string | null, grantType?: PostAccessTokenGrantTypeEnum, scope?: PostAccessTokenScopeEnum, redirectUri?: string | null, code?: string | null, refreshToken?: string | null, codeVerifier?: string | null, token?: string | null, tokenExchangeType?: PostAccessTokenTokenExchangeTypeEnum, licenceKey?: string | null, endUser?: boolean | null, instanceId?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TokenResponseModel>>;
|
|
19265
19271
|
/**
|
|
19266
19272
|
* Get an OAuth 2.0 auth code
|
|
19267
19273
|
* @summary Get OAuth2.0 Auth Code
|
|
@@ -19331,10 +19337,11 @@ export declare const OAuth20ApiFactory: (configuration?: Configuration, basePath
|
|
|
19331
19337
|
* @param {PostAccessTokenTokenExchangeTypeEnum} [tokenExchangeType] Token Exchange Type (Only used in Token Exchange)
|
|
19332
19338
|
* @param {string | null} [licenceKey] 3CX Licence Key (Only used in Token Exchange)
|
|
19333
19339
|
* @param {boolean | null} [endUser] End User (Only used in Token Exchange)
|
|
19340
|
+
* @param {string | null} [instanceId] 3CX Instance ID (Only used in Token Exchange)
|
|
19334
19341
|
* @param {*} [options] Override http request option.
|
|
19335
19342
|
* @throws {RequiredError}
|
|
19336
19343
|
*/
|
|
19337
|
-
postAccessToken(clientId?: string | null, clientSecret?: string | null, grantType?: PostAccessTokenGrantTypeEnum, scope?: PostAccessTokenScopeEnum, redirectUri?: string | null, code?: string | null, refreshToken?: string | null, codeVerifier?: string | null, token?: string | null, tokenExchangeType?: PostAccessTokenTokenExchangeTypeEnum, licenceKey?: string | null, endUser?: boolean | null, options?: RawAxiosRequestConfig): AxiosPromise<TokenResponseModel>;
|
|
19344
|
+
postAccessToken(clientId?: string | null, clientSecret?: string | null, grantType?: PostAccessTokenGrantTypeEnum, scope?: PostAccessTokenScopeEnum, redirectUri?: string | null, code?: string | null, refreshToken?: string | null, codeVerifier?: string | null, token?: string | null, tokenExchangeType?: PostAccessTokenTokenExchangeTypeEnum, licenceKey?: string | null, endUser?: boolean | null, instanceId?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<TokenResponseModel>;
|
|
19338
19345
|
/**
|
|
19339
19346
|
* Get an OAuth 2.0 auth code
|
|
19340
19347
|
* @summary Get OAuth2.0 Auth Code
|
|
@@ -19404,10 +19411,11 @@ export declare class OAuth20Api extends BaseAPI {
|
|
|
19404
19411
|
* @param {PostAccessTokenTokenExchangeTypeEnum} [tokenExchangeType] Token Exchange Type (Only used in Token Exchange)
|
|
19405
19412
|
* @param {string | null} [licenceKey] 3CX Licence Key (Only used in Token Exchange)
|
|
19406
19413
|
* @param {boolean | null} [endUser] End User (Only used in Token Exchange)
|
|
19414
|
+
* @param {string | null} [instanceId] 3CX Instance ID (Only used in Token Exchange)
|
|
19407
19415
|
* @param {*} [options] Override http request option.
|
|
19408
19416
|
* @throws {RequiredError}
|
|
19409
19417
|
*/
|
|
19410
|
-
postAccessToken(clientId?: string | null, clientSecret?: string | null, grantType?: PostAccessTokenGrantTypeEnum, scope?: PostAccessTokenScopeEnum, redirectUri?: string | null, code?: string | null, refreshToken?: string | null, codeVerifier?: string | null, token?: string | null, tokenExchangeType?: PostAccessTokenTokenExchangeTypeEnum, licenceKey?: string | null, endUser?: boolean | null, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<TokenResponseModel, any, {}, any>>;
|
|
19418
|
+
postAccessToken(clientId?: string | null, clientSecret?: string | null, grantType?: PostAccessTokenGrantTypeEnum, scope?: PostAccessTokenScopeEnum, redirectUri?: string | null, code?: string | null, refreshToken?: string | null, codeVerifier?: string | null, token?: string | null, tokenExchangeType?: PostAccessTokenTokenExchangeTypeEnum, licenceKey?: string | null, endUser?: boolean | null, instanceId?: string | null, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<TokenResponseModel, any, {}, any>>;
|
|
19411
19419
|
/**
|
|
19412
19420
|
* Get an OAuth 2.0 auth code
|
|
19413
19421
|
* @summary Get OAuth2.0 Auth Code
|
|
@@ -19487,12 +19495,14 @@ export declare const PostAccessTokenScopeEnum: {
|
|
|
19487
19495
|
readonly TcxMtWrite: "tcx_mt.write";
|
|
19488
19496
|
readonly TicketsRead: "tickets.read";
|
|
19489
19497
|
readonly TicketsWrite: "tickets.write";
|
|
19498
|
+
readonly TccRead: "tcc.read";
|
|
19490
19499
|
};
|
|
19491
19500
|
export type PostAccessTokenScopeEnum = typeof PostAccessTokenScopeEnum[keyof typeof PostAccessTokenScopeEnum];
|
|
19492
19501
|
export declare const PostAccessTokenTokenExchangeTypeEnum: {
|
|
19493
19502
|
readonly TcxWizard: "tcx_wizard";
|
|
19494
19503
|
readonly TcxWizardAdmin: "tcx_wizard_admin";
|
|
19495
19504
|
readonly Portal: "portal";
|
|
19505
|
+
readonly TcxTcc: "tcx_tcc";
|
|
19496
19506
|
};
|
|
19497
19507
|
export type PostAccessTokenTokenExchangeTypeEnum = typeof PostAccessTokenTokenExchangeTypeEnum[keyof typeof PostAccessTokenTokenExchangeTypeEnum];
|
|
19498
19508
|
export declare const PostAuthoriseScopeEnum: {
|
|
@@ -19528,6 +19538,7 @@ export declare const PostAuthoriseScopeEnum: {
|
|
|
19528
19538
|
readonly TcxMtWrite: "tcx_mt.write";
|
|
19529
19539
|
readonly TicketsRead: "tickets.read";
|
|
19530
19540
|
readonly TicketsWrite: "tickets.write";
|
|
19541
|
+
readonly TccRead: "tcc.read";
|
|
19531
19542
|
};
|
|
19532
19543
|
export type PostAuthoriseScopeEnum = typeof PostAuthoriseScopeEnum[keyof typeof PostAuthoriseScopeEnum];
|
|
19533
19544
|
/**
|
package/dist/api.js
CHANGED
|
@@ -9381,6 +9381,7 @@ const Class3CXApiAxiosParamCreator = function (configuration) {
|
|
|
9381
9381
|
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
9382
9382
|
const localVarHeaderParameter = {};
|
|
9383
9383
|
const localVarQueryParameter = {};
|
|
9384
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
9384
9385
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
9385
9386
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
9386
9387
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -16256,10 +16257,11 @@ const OAuth20ApiAxiosParamCreator = function (configuration) {
|
|
|
16256
16257
|
* @param {PostAccessTokenTokenExchangeTypeEnum} [tokenExchangeType] Token Exchange Type (Only used in Token Exchange)
|
|
16257
16258
|
* @param {string | null} [licenceKey] 3CX Licence Key (Only used in Token Exchange)
|
|
16258
16259
|
* @param {boolean | null} [endUser] End User (Only used in Token Exchange)
|
|
16260
|
+
* @param {string | null} [instanceId] 3CX Instance ID (Only used in Token Exchange)
|
|
16259
16261
|
* @param {*} [options] Override http request option.
|
|
16260
16262
|
* @throws {RequiredError}
|
|
16261
16263
|
*/
|
|
16262
|
-
postAccessToken: async (clientId, clientSecret, grantType, scope, redirectUri, code, refreshToken, codeVerifier, token, tokenExchangeType, licenceKey, endUser, options = {}) => {
|
|
16264
|
+
postAccessToken: async (clientId, clientSecret, grantType, scope, redirectUri, code, refreshToken, codeVerifier, token, tokenExchangeType, licenceKey, endUser, instanceId, options = {}) => {
|
|
16263
16265
|
const localVarPath = `/oauth2/access_token`;
|
|
16264
16266
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
16265
16267
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -16307,6 +16309,9 @@ const OAuth20ApiAxiosParamCreator = function (configuration) {
|
|
|
16307
16309
|
if (endUser !== undefined) {
|
|
16308
16310
|
localVarFormParams.set('end_user', endUser);
|
|
16309
16311
|
}
|
|
16312
|
+
if (instanceId !== undefined) {
|
|
16313
|
+
localVarFormParams.set('instance_id', instanceId);
|
|
16314
|
+
}
|
|
16310
16315
|
localVarHeaderParameter['Content-Type'] = 'application/x-www-form-urlencoded';
|
|
16311
16316
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
16312
16317
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
@@ -16504,11 +16509,12 @@ const OAuth20ApiFp = function (configuration) {
|
|
|
16504
16509
|
* @param {PostAccessTokenTokenExchangeTypeEnum} [tokenExchangeType] Token Exchange Type (Only used in Token Exchange)
|
|
16505
16510
|
* @param {string | null} [licenceKey] 3CX Licence Key (Only used in Token Exchange)
|
|
16506
16511
|
* @param {boolean | null} [endUser] End User (Only used in Token Exchange)
|
|
16512
|
+
* @param {string | null} [instanceId] 3CX Instance ID (Only used in Token Exchange)
|
|
16507
16513
|
* @param {*} [options] Override http request option.
|
|
16508
16514
|
* @throws {RequiredError}
|
|
16509
16515
|
*/
|
|
16510
|
-
async postAccessToken(clientId, clientSecret, grantType, scope, redirectUri, code, refreshToken, codeVerifier, token, tokenExchangeType, licenceKey, endUser, options) {
|
|
16511
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.postAccessToken(clientId, clientSecret, grantType, scope, redirectUri, code, refreshToken, codeVerifier, token, tokenExchangeType, licenceKey, endUser, options);
|
|
16516
|
+
async postAccessToken(clientId, clientSecret, grantType, scope, redirectUri, code, refreshToken, codeVerifier, token, tokenExchangeType, licenceKey, endUser, instanceId, options) {
|
|
16517
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.postAccessToken(clientId, clientSecret, grantType, scope, redirectUri, code, refreshToken, codeVerifier, token, tokenExchangeType, licenceKey, endUser, instanceId, options);
|
|
16512
16518
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
16513
16519
|
const localVarOperationServerBasePath = base_1.operationServerMap['OAuth20Api.postAccessToken']?.[localVarOperationServerIndex]?.url;
|
|
16514
16520
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -16610,11 +16616,12 @@ const OAuth20ApiFactory = function (configuration, basePath, axios) {
|
|
|
16610
16616
|
* @param {PostAccessTokenTokenExchangeTypeEnum} [tokenExchangeType] Token Exchange Type (Only used in Token Exchange)
|
|
16611
16617
|
* @param {string | null} [licenceKey] 3CX Licence Key (Only used in Token Exchange)
|
|
16612
16618
|
* @param {boolean | null} [endUser] End User (Only used in Token Exchange)
|
|
16619
|
+
* @param {string | null} [instanceId] 3CX Instance ID (Only used in Token Exchange)
|
|
16613
16620
|
* @param {*} [options] Override http request option.
|
|
16614
16621
|
* @throws {RequiredError}
|
|
16615
16622
|
*/
|
|
16616
|
-
postAccessToken(clientId, clientSecret, grantType, scope, redirectUri, code, refreshToken, codeVerifier, token, tokenExchangeType, licenceKey, endUser, options) {
|
|
16617
|
-
return localVarFp.postAccessToken(clientId, clientSecret, grantType, scope, redirectUri, code, refreshToken, codeVerifier, token, tokenExchangeType, licenceKey, endUser, options).then((request) => request(axios, basePath));
|
|
16623
|
+
postAccessToken(clientId, clientSecret, grantType, scope, redirectUri, code, refreshToken, codeVerifier, token, tokenExchangeType, licenceKey, endUser, instanceId, options) {
|
|
16624
|
+
return localVarFp.postAccessToken(clientId, clientSecret, grantType, scope, redirectUri, code, refreshToken, codeVerifier, token, tokenExchangeType, licenceKey, endUser, instanceId, options).then((request) => request(axios, basePath));
|
|
16618
16625
|
},
|
|
16619
16626
|
/**
|
|
16620
16627
|
* Get an OAuth 2.0 auth code
|
|
@@ -16699,11 +16706,12 @@ class OAuth20Api extends base_1.BaseAPI {
|
|
|
16699
16706
|
* @param {PostAccessTokenTokenExchangeTypeEnum} [tokenExchangeType] Token Exchange Type (Only used in Token Exchange)
|
|
16700
16707
|
* @param {string | null} [licenceKey] 3CX Licence Key (Only used in Token Exchange)
|
|
16701
16708
|
* @param {boolean | null} [endUser] End User (Only used in Token Exchange)
|
|
16709
|
+
* @param {string | null} [instanceId] 3CX Instance ID (Only used in Token Exchange)
|
|
16702
16710
|
* @param {*} [options] Override http request option.
|
|
16703
16711
|
* @throws {RequiredError}
|
|
16704
16712
|
*/
|
|
16705
|
-
postAccessToken(clientId, clientSecret, grantType, scope, redirectUri, code, refreshToken, codeVerifier, token, tokenExchangeType, licenceKey, endUser, options) {
|
|
16706
|
-
return (0, exports.OAuth20ApiFp)(this.configuration).postAccessToken(clientId, clientSecret, grantType, scope, redirectUri, code, refreshToken, codeVerifier, token, tokenExchangeType, licenceKey, endUser, options).then((request) => request(this.axios, this.basePath));
|
|
16713
|
+
postAccessToken(clientId, clientSecret, grantType, scope, redirectUri, code, refreshToken, codeVerifier, token, tokenExchangeType, licenceKey, endUser, instanceId, options) {
|
|
16714
|
+
return (0, exports.OAuth20ApiFp)(this.configuration).postAccessToken(clientId, clientSecret, grantType, scope, redirectUri, code, refreshToken, codeVerifier, token, tokenExchangeType, licenceKey, endUser, instanceId, options).then((request) => request(this.axios, this.basePath));
|
|
16707
16715
|
}
|
|
16708
16716
|
/**
|
|
16709
16717
|
* Get an OAuth 2.0 auth code
|
|
@@ -16792,11 +16800,13 @@ exports.PostAccessTokenScopeEnum = {
|
|
|
16792
16800
|
TcxMtWrite: 'tcx_mt.write',
|
|
16793
16801
|
TicketsRead: 'tickets.read',
|
|
16794
16802
|
TicketsWrite: 'tickets.write',
|
|
16803
|
+
TccRead: 'tcc.read',
|
|
16795
16804
|
};
|
|
16796
16805
|
exports.PostAccessTokenTokenExchangeTypeEnum = {
|
|
16797
16806
|
TcxWizard: 'tcx_wizard',
|
|
16798
16807
|
TcxWizardAdmin: 'tcx_wizard_admin',
|
|
16799
16808
|
Portal: 'portal',
|
|
16809
|
+
TcxTcc: 'tcx_tcc',
|
|
16800
16810
|
};
|
|
16801
16811
|
exports.PostAuthoriseScopeEnum = {
|
|
16802
16812
|
Star: '*',
|
|
@@ -16831,6 +16841,7 @@ exports.PostAuthoriseScopeEnum = {
|
|
|
16831
16841
|
TcxMtWrite: 'tcx_mt.write',
|
|
16832
16842
|
TicketsRead: 'tickets.read',
|
|
16833
16843
|
TicketsWrite: 'tickets.write',
|
|
16844
|
+
TccRead: 'tcc.read',
|
|
16834
16845
|
};
|
|
16835
16846
|
/**
|
|
16836
16847
|
* OrdersApi - axios parameter creator
|
package/docs/Class3CXApi.md
CHANGED
|
@@ -471,7 +471,7 @@ No authorization required
|
|
|
471
471
|
[[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)
|
|
472
472
|
|
|
473
473
|
# **postAuthenticateInstanceWebsocket**
|
|
474
|
-
> postAuthenticateInstanceWebsocket()
|
|
474
|
+
> TcxInstallationModel postAuthenticateInstanceWebsocket()
|
|
475
475
|
|
|
476
476
|
Get 3CX service principals
|
|
477
477
|
|
|
@@ -502,7 +502,7 @@ const { status, data } = await apiInstance.postAuthenticateInstanceWebsocket(
|
|
|
502
502
|
|
|
503
503
|
### Return type
|
|
504
504
|
|
|
505
|
-
|
|
505
|
+
**TcxInstallationModel**
|
|
506
506
|
|
|
507
507
|
### Authorization
|
|
508
508
|
|
|
@@ -511,13 +511,13 @@ No authorization required
|
|
|
511
511
|
### HTTP request headers
|
|
512
512
|
|
|
513
513
|
- **Content-Type**: Not defined
|
|
514
|
-
- **Accept**:
|
|
514
|
+
- **Accept**: application/json
|
|
515
515
|
|
|
516
516
|
|
|
517
517
|
### HTTP response details
|
|
518
518
|
| Status code | Description | Response headers |
|
|
519
519
|
|-------------|-------------|------------------|
|
|
520
|
-
|**200** |
|
|
520
|
+
|**200** | Instance Details | - |
|
|
521
521
|
|**400** | Bad Request | - |
|
|
522
522
|
|**401** | Unauthorised | - |
|
|
523
523
|
|**403** | Access Denied | - |
|
package/docs/OAuth20Api.md
CHANGED
|
@@ -134,6 +134,7 @@ let token: string; //OAuth 2.0 Token (Only used in Token Exchange) (optional) (d
|
|
|
134
134
|
let tokenExchangeType: string; //Token Exchange Type (Only used in Token Exchange) (optional) (default to undefined)
|
|
135
135
|
let licenceKey: string; //3CX Licence Key (Only used in Token Exchange) (optional) (default to undefined)
|
|
136
136
|
let endUser: boolean; //End User (Only used in Token Exchange) (optional) (default to undefined)
|
|
137
|
+
let instanceId: string; //3CX Instance ID (Only used in Token Exchange) (optional) (default to undefined)
|
|
137
138
|
|
|
138
139
|
const { status, data } = await apiInstance.postAccessToken(
|
|
139
140
|
clientId,
|
|
@@ -147,7 +148,8 @@ const { status, data } = await apiInstance.postAccessToken(
|
|
|
147
148
|
token,
|
|
148
149
|
tokenExchangeType,
|
|
149
150
|
licenceKey,
|
|
150
|
-
endUser
|
|
151
|
+
endUser,
|
|
152
|
+
instanceId
|
|
151
153
|
);
|
|
152
154
|
```
|
|
153
155
|
|
|
@@ -158,15 +160,16 @@ const { status, data } = await apiInstance.postAccessToken(
|
|
|
158
160
|
| **clientId** | [**string**] | OAuth 2.0 Client ID | (optional) defaults to undefined|
|
|
159
161
|
| **clientSecret** | [**string**] | OAuth 2.0 Client Secret | (optional) defaults to undefined|
|
|
160
162
|
| **grantType** | [**string**]**Array<'client_credentials' | 'code' | 'refresh_token' | 'authorization_code' | 'ms_auth' | 'token_exchange' | 'password'>** | OAuth 2.0 Grant Type | (optional) defaults to undefined|
|
|
161
|
-
| **scope** | [**string**]**Array<'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'branded_videosread' | 'branded_videoswrite' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'rma.read' | 'rma.write' | 'sms.read' | 'sms.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'>** | OAuth 2.0 Scope | (optional) defaults to undefined|
|
|
163
|
+
| **scope** | [**string**]**Array<'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'branded_videosread' | 'branded_videoswrite' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'rma.read' | 'rma.write' | 'sms.read' | 'sms.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write' | 'tcc.read'>** | OAuth 2.0 Scope | (optional) defaults to undefined|
|
|
162
164
|
| **redirectUri** | [**string**] | OAuth 2.0 Redirect URI | (optional) defaults to undefined|
|
|
163
165
|
| **code** | [**string**] | OAuth 2.0 Auth Code | (optional) defaults to undefined|
|
|
164
166
|
| **refreshToken** | [**string**] | OAuth 2.0 Refresh Token | (optional) defaults to undefined|
|
|
165
167
|
| **codeVerifier** | [**string**] | OAuth 2.0 Code Verifier | (optional) defaults to undefined|
|
|
166
168
|
| **token** | [**string**] | OAuth 2.0 Token (Only used in Token Exchange) | (optional) defaults to undefined|
|
|
167
|
-
| **tokenExchangeType** | [**string**]**Array<'tcx_wizard' | 'tcx_wizard_admin' | 'portal'>** | Token Exchange Type (Only used in Token Exchange) | (optional) defaults to undefined|
|
|
169
|
+
| **tokenExchangeType** | [**string**]**Array<'tcx_wizard' | 'tcx_wizard_admin' | 'portal' | 'tcx_tcc'>** | Token Exchange Type (Only used in Token Exchange) | (optional) defaults to undefined|
|
|
168
170
|
| **licenceKey** | [**string**] | 3CX Licence Key (Only used in Token Exchange) | (optional) defaults to undefined|
|
|
169
171
|
| **endUser** | [**boolean**] | End User (Only used in Token Exchange) | (optional) defaults to undefined|
|
|
172
|
+
| **instanceId** | [**string**] | 3CX Instance ID (Only used in Token Exchange) | (optional) defaults to undefined|
|
|
170
173
|
|
|
171
174
|
|
|
172
175
|
### Return type
|
|
@@ -211,7 +214,7 @@ const apiInstance = new OAuth20Api(configuration);
|
|
|
211
214
|
|
|
212
215
|
let clientId: string; //OAuth 2.0 Client ID (default to undefined)
|
|
213
216
|
let responseType: string; //OAuth 2.0 Response Type (default to 'code')
|
|
214
|
-
let scope: '*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'branded_videosread' | 'branded_videoswrite' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'rma.read' | 'rma.write' | 'sms.read' | 'sms.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'; //OAuth 2.0 Scope (default to undefined)
|
|
217
|
+
let scope: '*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'branded_videosread' | 'branded_videoswrite' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'rma.read' | 'rma.write' | 'sms.read' | 'sms.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write' | 'tcc.read'; //OAuth 2.0 Scope (default to undefined)
|
|
215
218
|
let redirectUri: string; //OAuth 2.0 Redirect URI (optional) (default to undefined)
|
|
216
219
|
let state: string; //OAuth 2.0 State (optional) (default to undefined)
|
|
217
220
|
let codeChallenge: string; //OAuth 2.0 Code Challenge (optional) (default to undefined)
|
|
@@ -234,7 +237,7 @@ const { status, data } = await apiInstance.postAuthorise(
|
|
|
234
237
|
|------------- | ------------- | ------------- | -------------|
|
|
235
238
|
| **clientId** | [**string**] | OAuth 2.0 Client ID | defaults to undefined|
|
|
236
239
|
| **responseType** | [**string**] | OAuth 2.0 Response Type | defaults to 'code'|
|
|
237
|
-
| **scope** | [**'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'branded_videosread' | 'branded_videoswrite' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'rma.read' | 'rma.write' | 'sms.read' | 'sms.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'**]**Array<'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'branded_videosread' | 'branded_videoswrite' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'rma.read' | 'rma.write' | 'sms.read' | 'sms.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'>** | OAuth 2.0 Scope | defaults to undefined|
|
|
240
|
+
| **scope** | [**'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'branded_videosread' | 'branded_videoswrite' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'rma.read' | 'rma.write' | 'sms.read' | 'sms.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write' | 'tcc.read'**]**Array<'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'branded_videosread' | 'branded_videoswrite' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'rma.read' | 'rma.write' | 'sms.read' | 'sms.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write' | 'tcc.read'>** | OAuth 2.0 Scope | defaults to undefined|
|
|
238
241
|
| **redirectUri** | [**string**] | OAuth 2.0 Redirect URI | (optional) defaults to undefined|
|
|
239
242
|
| **state** | [**string**] | OAuth 2.0 State | (optional) defaults to undefined|
|
|
240
243
|
| **codeChallenge** | [**string**] | OAuth 2.0 Code Challenge | (optional) defaults to undefined|
|
|
@@ -7,6 +7,7 @@ TcxServicePrincipalsEntity
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**id** | **string** | id | [default to undefined]
|
|
10
|
+
**customerId** | **number** | customerId | [default to undefined]
|
|
10
11
|
**pbxBase** | **string** | pbxBase | [default to undefined]
|
|
11
12
|
**appId** | **string** | appId | [default to undefined]
|
|
12
13
|
**appSecret** | **string** | appSecret | [default to undefined]
|
|
@@ -18,6 +19,7 @@ import { TcxServicePrincipalEntity } from 'yellowgrid-api-ts';
|
|
|
18
19
|
|
|
19
20
|
const instance: TcxServicePrincipalEntity = {
|
|
20
21
|
id,
|
|
22
|
+
customerId,
|
|
21
23
|
pbxBase,
|
|
22
24
|
appId,
|
|
23
25
|
appSecret,
|