yellowgrid-api-ts 3.2.357 → 3.2.358
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 +18 -7
- package/dist/api.d.ts +11 -4
- package/dist/api.js +17 -7
- package/docs/OAuth20Api.md +8 -5
- package/package.json +1 -1
package/README.md
CHANGED
package/api.ts
CHANGED
|
@@ -28559,10 +28559,11 @@ export const OAuth20ApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
28559
28559
|
* @param {PostAccessTokenTokenExchangeTypeEnum} [tokenExchangeType] Token Exchange Type (Only used in Token Exchange)
|
|
28560
28560
|
* @param {string | null} [licenceKey] 3CX Licence Key (Only used in Token Exchange)
|
|
28561
28561
|
* @param {boolean | null} [endUser] End User (Only used in Token Exchange)
|
|
28562
|
+
* @param {string | null} [instanceId] 3CX Instance ID (Only used in Token Exchange)
|
|
28562
28563
|
* @param {*} [options] Override http request option.
|
|
28563
28564
|
* @throws {RequiredError}
|
|
28564
28565
|
*/
|
|
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> => {
|
|
28566
|
+
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
28567
|
const localVarPath = `/oauth2/access_token`;
|
|
28567
28568
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
28568
28569
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -28624,6 +28625,10 @@ export const OAuth20ApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
28624
28625
|
if (endUser !== undefined) {
|
|
28625
28626
|
localVarFormParams.set('end_user', endUser as any);
|
|
28626
28627
|
}
|
|
28628
|
+
|
|
28629
|
+
if (instanceId !== undefined) {
|
|
28630
|
+
localVarFormParams.set('instance_id', instanceId as any);
|
|
28631
|
+
}
|
|
28627
28632
|
localVarHeaderParameter['Content-Type'] = 'application/x-www-form-urlencoded';
|
|
28628
28633
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
28629
28634
|
|
|
@@ -28846,11 +28851,12 @@ export const OAuth20ApiFp = function(configuration?: Configuration) {
|
|
|
28846
28851
|
* @param {PostAccessTokenTokenExchangeTypeEnum} [tokenExchangeType] Token Exchange Type (Only used in Token Exchange)
|
|
28847
28852
|
* @param {string | null} [licenceKey] 3CX Licence Key (Only used in Token Exchange)
|
|
28848
28853
|
* @param {boolean | null} [endUser] End User (Only used in Token Exchange)
|
|
28854
|
+
* @param {string | null} [instanceId] 3CX Instance ID (Only used in Token Exchange)
|
|
28849
28855
|
* @param {*} [options] Override http request option.
|
|
28850
28856
|
* @throws {RequiredError}
|
|
28851
28857
|
*/
|
|
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);
|
|
28858
|
+
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>> {
|
|
28859
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.postAccessToken(clientId, clientSecret, grantType, scope, redirectUri, code, refreshToken, codeVerifier, token, tokenExchangeType, licenceKey, endUser, instanceId, options);
|
|
28854
28860
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
28855
28861
|
const localVarOperationServerBasePath = operationServerMap['OAuth20Api.postAccessToken']?.[localVarOperationServerIndex]?.url;
|
|
28856
28862
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -28952,11 +28958,12 @@ export const OAuth20ApiFactory = function (configuration?: Configuration, basePa
|
|
|
28952
28958
|
* @param {PostAccessTokenTokenExchangeTypeEnum} [tokenExchangeType] Token Exchange Type (Only used in Token Exchange)
|
|
28953
28959
|
* @param {string | null} [licenceKey] 3CX Licence Key (Only used in Token Exchange)
|
|
28954
28960
|
* @param {boolean | null} [endUser] End User (Only used in Token Exchange)
|
|
28961
|
+
* @param {string | null} [instanceId] 3CX Instance ID (Only used in Token Exchange)
|
|
28955
28962
|
* @param {*} [options] Override http request option.
|
|
28956
28963
|
* @throws {RequiredError}
|
|
28957
28964
|
*/
|
|
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));
|
|
28965
|
+
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> {
|
|
28966
|
+
return localVarFp.postAccessToken(clientId, clientSecret, grantType, scope, redirectUri, code, refreshToken, codeVerifier, token, tokenExchangeType, licenceKey, endUser, instanceId, options).then((request) => request(axios, basePath));
|
|
28960
28967
|
},
|
|
28961
28968
|
/**
|
|
28962
28969
|
* Get an OAuth 2.0 auth code
|
|
@@ -29043,11 +29050,12 @@ export class OAuth20Api extends BaseAPI {
|
|
|
29043
29050
|
* @param {PostAccessTokenTokenExchangeTypeEnum} [tokenExchangeType] Token Exchange Type (Only used in Token Exchange)
|
|
29044
29051
|
* @param {string | null} [licenceKey] 3CX Licence Key (Only used in Token Exchange)
|
|
29045
29052
|
* @param {boolean | null} [endUser] End User (Only used in Token Exchange)
|
|
29053
|
+
* @param {string | null} [instanceId] 3CX Instance ID (Only used in Token Exchange)
|
|
29046
29054
|
* @param {*} [options] Override http request option.
|
|
29047
29055
|
* @throws {RequiredError}
|
|
29048
29056
|
*/
|
|
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));
|
|
29057
|
+
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) {
|
|
29058
|
+
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
29059
|
}
|
|
29052
29060
|
|
|
29053
29061
|
/**
|
|
@@ -29141,12 +29149,14 @@ export const PostAccessTokenScopeEnum = {
|
|
|
29141
29149
|
TcxMtWrite: 'tcx_mt.write',
|
|
29142
29150
|
TicketsRead: 'tickets.read',
|
|
29143
29151
|
TicketsWrite: 'tickets.write',
|
|
29152
|
+
TccRead: 'tcc.read',
|
|
29144
29153
|
} as const;
|
|
29145
29154
|
export type PostAccessTokenScopeEnum = typeof PostAccessTokenScopeEnum[keyof typeof PostAccessTokenScopeEnum];
|
|
29146
29155
|
export const PostAccessTokenTokenExchangeTypeEnum = {
|
|
29147
29156
|
TcxWizard: 'tcx_wizard',
|
|
29148
29157
|
TcxWizardAdmin: 'tcx_wizard_admin',
|
|
29149
29158
|
Portal: 'portal',
|
|
29159
|
+
TcxTcc: 'tcx_tcc',
|
|
29150
29160
|
} as const;
|
|
29151
29161
|
export type PostAccessTokenTokenExchangeTypeEnum = typeof PostAccessTokenTokenExchangeTypeEnum[keyof typeof PostAccessTokenTokenExchangeTypeEnum];
|
|
29152
29162
|
export const PostAuthoriseScopeEnum = {
|
|
@@ -29182,6 +29192,7 @@ export const PostAuthoriseScopeEnum = {
|
|
|
29182
29192
|
TcxMtWrite: 'tcx_mt.write',
|
|
29183
29193
|
TicketsRead: 'tickets.read',
|
|
29184
29194
|
TicketsWrite: 'tickets.write',
|
|
29195
|
+
TccRead: 'tcc.read',
|
|
29185
29196
|
} as const;
|
|
29186
29197
|
export type PostAuthoriseScopeEnum = typeof PostAuthoriseScopeEnum[keyof typeof PostAuthoriseScopeEnum];
|
|
29187
29198
|
|
package/dist/api.d.ts
CHANGED
|
@@ -19185,10 +19185,11 @@ export declare const OAuth20ApiAxiosParamCreator: (configuration?: Configuration
|
|
|
19185
19185
|
* @param {PostAccessTokenTokenExchangeTypeEnum} [tokenExchangeType] Token Exchange Type (Only used in Token Exchange)
|
|
19186
19186
|
* @param {string | null} [licenceKey] 3CX Licence Key (Only used in Token Exchange)
|
|
19187
19187
|
* @param {boolean | null} [endUser] End User (Only used in Token Exchange)
|
|
19188
|
+
* @param {string | null} [instanceId] 3CX Instance ID (Only used in Token Exchange)
|
|
19188
19189
|
* @param {*} [options] Override http request option.
|
|
19189
19190
|
* @throws {RequiredError}
|
|
19190
19191
|
*/
|
|
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>;
|
|
19192
|
+
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
19193
|
/**
|
|
19193
19194
|
* Get an OAuth 2.0 auth code
|
|
19194
19195
|
* @summary Get OAuth2.0 Auth Code
|
|
@@ -19258,10 +19259,11 @@ export declare const OAuth20ApiFp: (configuration?: Configuration) => {
|
|
|
19258
19259
|
* @param {PostAccessTokenTokenExchangeTypeEnum} [tokenExchangeType] Token Exchange Type (Only used in Token Exchange)
|
|
19259
19260
|
* @param {string | null} [licenceKey] 3CX Licence Key (Only used in Token Exchange)
|
|
19260
19261
|
* @param {boolean | null} [endUser] End User (Only used in Token Exchange)
|
|
19262
|
+
* @param {string | null} [instanceId] 3CX Instance ID (Only used in Token Exchange)
|
|
19261
19263
|
* @param {*} [options] Override http request option.
|
|
19262
19264
|
* @throws {RequiredError}
|
|
19263
19265
|
*/
|
|
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>>;
|
|
19266
|
+
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
19267
|
/**
|
|
19266
19268
|
* Get an OAuth 2.0 auth code
|
|
19267
19269
|
* @summary Get OAuth2.0 Auth Code
|
|
@@ -19331,10 +19333,11 @@ export declare const OAuth20ApiFactory: (configuration?: Configuration, basePath
|
|
|
19331
19333
|
* @param {PostAccessTokenTokenExchangeTypeEnum} [tokenExchangeType] Token Exchange Type (Only used in Token Exchange)
|
|
19332
19334
|
* @param {string | null} [licenceKey] 3CX Licence Key (Only used in Token Exchange)
|
|
19333
19335
|
* @param {boolean | null} [endUser] End User (Only used in Token Exchange)
|
|
19336
|
+
* @param {string | null} [instanceId] 3CX Instance ID (Only used in Token Exchange)
|
|
19334
19337
|
* @param {*} [options] Override http request option.
|
|
19335
19338
|
* @throws {RequiredError}
|
|
19336
19339
|
*/
|
|
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>;
|
|
19340
|
+
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
19341
|
/**
|
|
19339
19342
|
* Get an OAuth 2.0 auth code
|
|
19340
19343
|
* @summary Get OAuth2.0 Auth Code
|
|
@@ -19404,10 +19407,11 @@ export declare class OAuth20Api extends BaseAPI {
|
|
|
19404
19407
|
* @param {PostAccessTokenTokenExchangeTypeEnum} [tokenExchangeType] Token Exchange Type (Only used in Token Exchange)
|
|
19405
19408
|
* @param {string | null} [licenceKey] 3CX Licence Key (Only used in Token Exchange)
|
|
19406
19409
|
* @param {boolean | null} [endUser] End User (Only used in Token Exchange)
|
|
19410
|
+
* @param {string | null} [instanceId] 3CX Instance ID (Only used in Token Exchange)
|
|
19407
19411
|
* @param {*} [options] Override http request option.
|
|
19408
19412
|
* @throws {RequiredError}
|
|
19409
19413
|
*/
|
|
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>>;
|
|
19414
|
+
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
19415
|
/**
|
|
19412
19416
|
* Get an OAuth 2.0 auth code
|
|
19413
19417
|
* @summary Get OAuth2.0 Auth Code
|
|
@@ -19487,12 +19491,14 @@ export declare const PostAccessTokenScopeEnum: {
|
|
|
19487
19491
|
readonly TcxMtWrite: "tcx_mt.write";
|
|
19488
19492
|
readonly TicketsRead: "tickets.read";
|
|
19489
19493
|
readonly TicketsWrite: "tickets.write";
|
|
19494
|
+
readonly TccRead: "tcc.read";
|
|
19490
19495
|
};
|
|
19491
19496
|
export type PostAccessTokenScopeEnum = typeof PostAccessTokenScopeEnum[keyof typeof PostAccessTokenScopeEnum];
|
|
19492
19497
|
export declare const PostAccessTokenTokenExchangeTypeEnum: {
|
|
19493
19498
|
readonly TcxWizard: "tcx_wizard";
|
|
19494
19499
|
readonly TcxWizardAdmin: "tcx_wizard_admin";
|
|
19495
19500
|
readonly Portal: "portal";
|
|
19501
|
+
readonly TcxTcc: "tcx_tcc";
|
|
19496
19502
|
};
|
|
19497
19503
|
export type PostAccessTokenTokenExchangeTypeEnum = typeof PostAccessTokenTokenExchangeTypeEnum[keyof typeof PostAccessTokenTokenExchangeTypeEnum];
|
|
19498
19504
|
export declare const PostAuthoriseScopeEnum: {
|
|
@@ -19528,6 +19534,7 @@ export declare const PostAuthoriseScopeEnum: {
|
|
|
19528
19534
|
readonly TcxMtWrite: "tcx_mt.write";
|
|
19529
19535
|
readonly TicketsRead: "tickets.read";
|
|
19530
19536
|
readonly TicketsWrite: "tickets.write";
|
|
19537
|
+
readonly TccRead: "tcc.read";
|
|
19531
19538
|
};
|
|
19532
19539
|
export type PostAuthoriseScopeEnum = typeof PostAuthoriseScopeEnum[keyof typeof PostAuthoriseScopeEnum];
|
|
19533
19540
|
/**
|
package/dist/api.js
CHANGED
|
@@ -16256,10 +16256,11 @@ const OAuth20ApiAxiosParamCreator = function (configuration) {
|
|
|
16256
16256
|
* @param {PostAccessTokenTokenExchangeTypeEnum} [tokenExchangeType] Token Exchange Type (Only used in Token Exchange)
|
|
16257
16257
|
* @param {string | null} [licenceKey] 3CX Licence Key (Only used in Token Exchange)
|
|
16258
16258
|
* @param {boolean | null} [endUser] End User (Only used in Token Exchange)
|
|
16259
|
+
* @param {string | null} [instanceId] 3CX Instance ID (Only used in Token Exchange)
|
|
16259
16260
|
* @param {*} [options] Override http request option.
|
|
16260
16261
|
* @throws {RequiredError}
|
|
16261
16262
|
*/
|
|
16262
|
-
postAccessToken: async (clientId, clientSecret, grantType, scope, redirectUri, code, refreshToken, codeVerifier, token, tokenExchangeType, licenceKey, endUser, options = {}) => {
|
|
16263
|
+
postAccessToken: async (clientId, clientSecret, grantType, scope, redirectUri, code, refreshToken, codeVerifier, token, tokenExchangeType, licenceKey, endUser, instanceId, options = {}) => {
|
|
16263
16264
|
const localVarPath = `/oauth2/access_token`;
|
|
16264
16265
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
16265
16266
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -16307,6 +16308,9 @@ const OAuth20ApiAxiosParamCreator = function (configuration) {
|
|
|
16307
16308
|
if (endUser !== undefined) {
|
|
16308
16309
|
localVarFormParams.set('end_user', endUser);
|
|
16309
16310
|
}
|
|
16311
|
+
if (instanceId !== undefined) {
|
|
16312
|
+
localVarFormParams.set('instance_id', instanceId);
|
|
16313
|
+
}
|
|
16310
16314
|
localVarHeaderParameter['Content-Type'] = 'application/x-www-form-urlencoded';
|
|
16311
16315
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
16312
16316
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
@@ -16504,11 +16508,12 @@ const OAuth20ApiFp = function (configuration) {
|
|
|
16504
16508
|
* @param {PostAccessTokenTokenExchangeTypeEnum} [tokenExchangeType] Token Exchange Type (Only used in Token Exchange)
|
|
16505
16509
|
* @param {string | null} [licenceKey] 3CX Licence Key (Only used in Token Exchange)
|
|
16506
16510
|
* @param {boolean | null} [endUser] End User (Only used in Token Exchange)
|
|
16511
|
+
* @param {string | null} [instanceId] 3CX Instance ID (Only used in Token Exchange)
|
|
16507
16512
|
* @param {*} [options] Override http request option.
|
|
16508
16513
|
* @throws {RequiredError}
|
|
16509
16514
|
*/
|
|
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);
|
|
16515
|
+
async postAccessToken(clientId, clientSecret, grantType, scope, redirectUri, code, refreshToken, codeVerifier, token, tokenExchangeType, licenceKey, endUser, instanceId, options) {
|
|
16516
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.postAccessToken(clientId, clientSecret, grantType, scope, redirectUri, code, refreshToken, codeVerifier, token, tokenExchangeType, licenceKey, endUser, instanceId, options);
|
|
16512
16517
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
16513
16518
|
const localVarOperationServerBasePath = base_1.operationServerMap['OAuth20Api.postAccessToken']?.[localVarOperationServerIndex]?.url;
|
|
16514
16519
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -16610,11 +16615,12 @@ const OAuth20ApiFactory = function (configuration, basePath, axios) {
|
|
|
16610
16615
|
* @param {PostAccessTokenTokenExchangeTypeEnum} [tokenExchangeType] Token Exchange Type (Only used in Token Exchange)
|
|
16611
16616
|
* @param {string | null} [licenceKey] 3CX Licence Key (Only used in Token Exchange)
|
|
16612
16617
|
* @param {boolean | null} [endUser] End User (Only used in Token Exchange)
|
|
16618
|
+
* @param {string | null} [instanceId] 3CX Instance ID (Only used in Token Exchange)
|
|
16613
16619
|
* @param {*} [options] Override http request option.
|
|
16614
16620
|
* @throws {RequiredError}
|
|
16615
16621
|
*/
|
|
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));
|
|
16622
|
+
postAccessToken(clientId, clientSecret, grantType, scope, redirectUri, code, refreshToken, codeVerifier, token, tokenExchangeType, licenceKey, endUser, instanceId, options) {
|
|
16623
|
+
return localVarFp.postAccessToken(clientId, clientSecret, grantType, scope, redirectUri, code, refreshToken, codeVerifier, token, tokenExchangeType, licenceKey, endUser, instanceId, options).then((request) => request(axios, basePath));
|
|
16618
16624
|
},
|
|
16619
16625
|
/**
|
|
16620
16626
|
* Get an OAuth 2.0 auth code
|
|
@@ -16699,11 +16705,12 @@ class OAuth20Api extends base_1.BaseAPI {
|
|
|
16699
16705
|
* @param {PostAccessTokenTokenExchangeTypeEnum} [tokenExchangeType] Token Exchange Type (Only used in Token Exchange)
|
|
16700
16706
|
* @param {string | null} [licenceKey] 3CX Licence Key (Only used in Token Exchange)
|
|
16701
16707
|
* @param {boolean | null} [endUser] End User (Only used in Token Exchange)
|
|
16708
|
+
* @param {string | null} [instanceId] 3CX Instance ID (Only used in Token Exchange)
|
|
16702
16709
|
* @param {*} [options] Override http request option.
|
|
16703
16710
|
* @throws {RequiredError}
|
|
16704
16711
|
*/
|
|
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));
|
|
16712
|
+
postAccessToken(clientId, clientSecret, grantType, scope, redirectUri, code, refreshToken, codeVerifier, token, tokenExchangeType, licenceKey, endUser, instanceId, options) {
|
|
16713
|
+
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
16714
|
}
|
|
16708
16715
|
/**
|
|
16709
16716
|
* Get an OAuth 2.0 auth code
|
|
@@ -16792,11 +16799,13 @@ exports.PostAccessTokenScopeEnum = {
|
|
|
16792
16799
|
TcxMtWrite: 'tcx_mt.write',
|
|
16793
16800
|
TicketsRead: 'tickets.read',
|
|
16794
16801
|
TicketsWrite: 'tickets.write',
|
|
16802
|
+
TccRead: 'tcc.read',
|
|
16795
16803
|
};
|
|
16796
16804
|
exports.PostAccessTokenTokenExchangeTypeEnum = {
|
|
16797
16805
|
TcxWizard: 'tcx_wizard',
|
|
16798
16806
|
TcxWizardAdmin: 'tcx_wizard_admin',
|
|
16799
16807
|
Portal: 'portal',
|
|
16808
|
+
TcxTcc: 'tcx_tcc',
|
|
16800
16809
|
};
|
|
16801
16810
|
exports.PostAuthoriseScopeEnum = {
|
|
16802
16811
|
Star: '*',
|
|
@@ -16831,6 +16840,7 @@ exports.PostAuthoriseScopeEnum = {
|
|
|
16831
16840
|
TcxMtWrite: 'tcx_mt.write',
|
|
16832
16841
|
TicketsRead: 'tickets.read',
|
|
16833
16842
|
TicketsWrite: 'tickets.write',
|
|
16843
|
+
TccRead: 'tcc.read',
|
|
16834
16844
|
};
|
|
16835
16845
|
/**
|
|
16836
16846
|
* OrdersApi - axios parameter creator
|
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|
|