@snokam/platform-client 3.1.0 → 3.1.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/CHANGELOG.md +11 -0
- package/README.md +4 -4
- package/dist/apis/PlatformClient.d.ts +8 -8
- package/dist/apis/PlatformClient.js +8 -8
- package/dist/esm/apis/PlatformClient.d.ts +8 -8
- package/dist/esm/apis/PlatformClient.js +8 -8
- package/dist/esm/models/index.d.ts +6 -0
- package/dist/models/index.d.ts +6 -0
- package/docs/AuthorizationRequest.md +1 -0
- package/docs/PlatformClient.md +6 -6
- package/package.json +1 -1
- package/src/apis/PlatformClient.ts +8 -8
- package/src/models/index.ts +6 -0
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,17 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [3.1.1](https://github.com/GIT_USER_ID/GIT_REPO_ID/compare/@snokam/platform-client@3.1.0...@snokam/platform-client@3.1.1) (2026-10-02)
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
### Bug Fixes
|
|
10
|
+
|
|
11
|
+
* **auth:** harden app sign-in after a security review, and give sign-in one home ([#2543](https://github.com/GIT_USER_ID/GIT_REPO_ID/issues/2543)) ([7100eb7](https://github.com/GIT_USER_ID/GIT_REPO_ID/commit/7100eb79ce278875eafe75228ab496dedc0ae151))
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
6
17
|
# [3.1.0](https://github.com/GIT_USER_ID/GIT_REPO_ID/compare/@snokam/platform-client@3.0.0...@snokam/platform-client@3.1.0) (2026-10-02)
|
|
7
18
|
|
|
8
19
|
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @snokam/platform-client@3.
|
|
1
|
+
# @snokam/platform-client@3.1.0
|
|
2
2
|
|
|
3
3
|
A TypeScript SDK client for the snokam.snosky.no API.
|
|
4
4
|
|
|
@@ -58,7 +58,7 @@ All URIs are relative to *https://snokam.snosky.no/api/platform*
|
|
|
58
58
|
| ----- | ------ | ------------ | -------------
|
|
59
59
|
*PlatformClient* | [**addCustomDomain**](docs/PlatformClient.md#addcustomdomainoperation) | **POST** /v1.0/protected/businesses/{id}/custom-domains | Add a custom domain
|
|
60
60
|
*PlatformClient* | [**approveDevice**](docs/PlatformClient.md#approvedeviceoperation) | **POST** /v1.0/protected/businesses/{id}/devices | Approve a screen into this business
|
|
61
|
-
*PlatformClient* | [**approveOAuthAuthorization**](docs/PlatformClient.md#approveoauthauthorization) | **POST** /v1.0/protected/oauth/authorization |
|
|
61
|
+
*PlatformClient* | [**approveOAuthAuthorization**](docs/PlatformClient.md#approveoauthauthorization) | **POST** /v1.0/protected/oauth/authorization | Record the user\'s approval of an app\'s sign-in request
|
|
62
62
|
*PlatformClient* | [**assignBusinessEmployeeSystem**](docs/PlatformClient.md#assignbusinessemployeesystem) | **POST** /v1.0/protected/businesses/{id}/employees/{upn}/systems/{systemKey} | Grant an employee a seat in a third-party system
|
|
63
63
|
*PlatformClient* | [**backfillBridgeWebhook**](docs/PlatformClient.md#backfillbridgewebhook) | **POST** /v1.0/protected/businesses/{id}/bridge-webhook | Re-create a business\'s Sanity bridge webhook with a managed API key
|
|
64
64
|
*PlatformClient* | [**checkIntegration**](docs/PlatformClient.md#checkintegration) | **POST** /v1.0/protected/businesses/{id}/integrations/{key}/check | Run a live integration connectivity check
|
|
@@ -149,7 +149,7 @@ All URIs are relative to *https://snokam.snosky.no/api/platform*
|
|
|
149
149
|
*PlatformClient* | [**powerOfficeOnboardingReturn**](docs/PlatformClient.md#powerofficeonboardingreturn) | **GET** /v1.0/connect/poweroffice/return/{reference} | PowerOffice onboarding return
|
|
150
150
|
*PlatformClient* | [**previewBillingInvoice**](docs/PlatformClient.md#previewbillinginvoice) | **POST** /v1.0/protected/businesses/{id}/billing/invoice-preview | Preview a month\'s invoice basis
|
|
151
151
|
*PlatformClient* | [**previewDevice**](docs/PlatformClient.md#previewdevice) | **GET** /v1.0/protected/businesses/{id}/devices/preview | Look up a pairing code before approving
|
|
152
|
-
*PlatformClient* | [**previewOAuthAuthorization**](docs/PlatformClient.md#previewoauthauthorization) | **POST** /v1.0/protected/oauth/authorization/preview | Describe an
|
|
152
|
+
*PlatformClient* | [**previewOAuthAuthorization**](docs/PlatformClient.md#previewoauthauthorization) | **POST** /v1.0/protected/oauth/authorization/preview | Describe an app\'s sign-in request before the user approves it
|
|
153
153
|
*PlatformClient* | [**provisionBusiness**](docs/PlatformClient.md#provisionbusiness) | **POST** /v1.0/protected/businesses/{id}/provision | Provision a business
|
|
154
154
|
*PlatformClient* | [**publicCapabilities**](docs/PlatformClient.md#publiccapabilities) | **GET** /v1.0/public/capabilities | Get capabilities
|
|
155
155
|
*PlatformClient* | [**publicModules**](docs/PlatformClient.md#publicmodules) | **GET** /v1.0/public/modules | Get available modules
|
|
@@ -389,7 +389,7 @@ and is automatically generated by the
|
|
|
389
389
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
390
390
|
|
|
391
391
|
- API version: `v1.0.0`
|
|
392
|
-
- Package version: `3.
|
|
392
|
+
- Package version: `3.1.0`
|
|
393
393
|
- Generator version: `7.23.0`
|
|
394
394
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
395
395
|
|
|
@@ -440,13 +440,13 @@ export declare class PlatformClient extends runtime.BaseAPI {
|
|
|
440
440
|
*/
|
|
441
441
|
approveOAuthAuthorizationRequestOpts(requestParameters: ApproveOAuthAuthorizationRequest): Promise<runtime.RequestOpts>;
|
|
442
442
|
/**
|
|
443
|
-
* Issues a single-use authorization code the
|
|
444
|
-
*
|
|
443
|
+
* Called by the login site after the user consents. Issues a single-use authorization code the app redeems at the token endpoint.
|
|
444
|
+
* Record the user\'s approval of an app\'s sign-in request
|
|
445
445
|
*/
|
|
446
446
|
approveOAuthAuthorizationRaw(requestParameters: ApproveOAuthAuthorizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IssuedAuthorizationCode>>;
|
|
447
447
|
/**
|
|
448
|
-
* Issues a single-use authorization code the
|
|
449
|
-
*
|
|
448
|
+
* Called by the login site after the user consents. Issues a single-use authorization code the app redeems at the token endpoint.
|
|
449
|
+
* Record the user\'s approval of an app\'s sign-in request
|
|
450
450
|
*/
|
|
451
451
|
approveOAuthAuthorization(requestParameters: ApproveOAuthAuthorizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IssuedAuthorizationCode>;
|
|
452
452
|
/**
|
|
@@ -1710,13 +1710,13 @@ export declare class PlatformClient extends runtime.BaseAPI {
|
|
|
1710
1710
|
*/
|
|
1711
1711
|
previewOAuthAuthorizationRequestOpts(requestParameters: PreviewOAuthAuthorizationRequest): Promise<runtime.RequestOpts>;
|
|
1712
1712
|
/**
|
|
1713
|
-
* Validates the
|
|
1714
|
-
* Describe an
|
|
1713
|
+
* Called by the login site. Validates the app, redirect URI and resource for the user whose access token is in the body, and names the app.
|
|
1714
|
+
* Describe an app\'s sign-in request before the user approves it
|
|
1715
1715
|
*/
|
|
1716
1716
|
previewOAuthAuthorizationRaw(requestParameters: PreviewOAuthAuthorizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuthorizationPreview>>;
|
|
1717
1717
|
/**
|
|
1718
|
-
* Validates the
|
|
1719
|
-
* Describe an
|
|
1718
|
+
* Called by the login site. Validates the app, redirect URI and resource for the user whose access token is in the body, and names the app.
|
|
1719
|
+
* Describe an app\'s sign-in request before the user approves it
|
|
1720
1720
|
*/
|
|
1721
1721
|
previewOAuthAuthorization(requestParameters: PreviewOAuthAuthorizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuthorizationPreview>;
|
|
1722
1722
|
/**
|
|
@@ -154,8 +154,8 @@ class PlatformClient extends runtime.BaseAPI {
|
|
|
154
154
|
});
|
|
155
155
|
}
|
|
156
156
|
/**
|
|
157
|
-
* Issues a single-use authorization code the
|
|
158
|
-
*
|
|
157
|
+
* Called by the login site after the user consents. Issues a single-use authorization code the app redeems at the token endpoint.
|
|
158
|
+
* Record the user\'s approval of an app\'s sign-in request
|
|
159
159
|
*/
|
|
160
160
|
approveOAuthAuthorizationRaw(requestParameters, initOverrides) {
|
|
161
161
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -165,8 +165,8 @@ class PlatformClient extends runtime.BaseAPI {
|
|
|
165
165
|
});
|
|
166
166
|
}
|
|
167
167
|
/**
|
|
168
|
-
* Issues a single-use authorization code the
|
|
169
|
-
*
|
|
168
|
+
* Called by the login site after the user consents. Issues a single-use authorization code the app redeems at the token endpoint.
|
|
169
|
+
* Record the user\'s approval of an app\'s sign-in request
|
|
170
170
|
*/
|
|
171
171
|
approveOAuthAuthorization(requestParameters, initOverrides) {
|
|
172
172
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -4239,8 +4239,8 @@ class PlatformClient extends runtime.BaseAPI {
|
|
|
4239
4239
|
});
|
|
4240
4240
|
}
|
|
4241
4241
|
/**
|
|
4242
|
-
* Validates the
|
|
4243
|
-
* Describe an
|
|
4242
|
+
* Called by the login site. Validates the app, redirect URI and resource for the user whose access token is in the body, and names the app.
|
|
4243
|
+
* Describe an app\'s sign-in request before the user approves it
|
|
4244
4244
|
*/
|
|
4245
4245
|
previewOAuthAuthorizationRaw(requestParameters, initOverrides) {
|
|
4246
4246
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -4250,8 +4250,8 @@ class PlatformClient extends runtime.BaseAPI {
|
|
|
4250
4250
|
});
|
|
4251
4251
|
}
|
|
4252
4252
|
/**
|
|
4253
|
-
* Validates the
|
|
4254
|
-
* Describe an
|
|
4253
|
+
* Called by the login site. Validates the app, redirect URI and resource for the user whose access token is in the body, and names the app.
|
|
4254
|
+
* Describe an app\'s sign-in request before the user approves it
|
|
4255
4255
|
*/
|
|
4256
4256
|
previewOAuthAuthorization(requestParameters, initOverrides) {
|
|
4257
4257
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -440,13 +440,13 @@ export declare class PlatformClient extends runtime.BaseAPI {
|
|
|
440
440
|
*/
|
|
441
441
|
approveOAuthAuthorizationRequestOpts(requestParameters: ApproveOAuthAuthorizationRequest): Promise<runtime.RequestOpts>;
|
|
442
442
|
/**
|
|
443
|
-
* Issues a single-use authorization code the
|
|
444
|
-
*
|
|
443
|
+
* Called by the login site after the user consents. Issues a single-use authorization code the app redeems at the token endpoint.
|
|
444
|
+
* Record the user\'s approval of an app\'s sign-in request
|
|
445
445
|
*/
|
|
446
446
|
approveOAuthAuthorizationRaw(requestParameters: ApproveOAuthAuthorizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IssuedAuthorizationCode>>;
|
|
447
447
|
/**
|
|
448
|
-
* Issues a single-use authorization code the
|
|
449
|
-
*
|
|
448
|
+
* Called by the login site after the user consents. Issues a single-use authorization code the app redeems at the token endpoint.
|
|
449
|
+
* Record the user\'s approval of an app\'s sign-in request
|
|
450
450
|
*/
|
|
451
451
|
approveOAuthAuthorization(requestParameters: ApproveOAuthAuthorizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IssuedAuthorizationCode>;
|
|
452
452
|
/**
|
|
@@ -1710,13 +1710,13 @@ export declare class PlatformClient extends runtime.BaseAPI {
|
|
|
1710
1710
|
*/
|
|
1711
1711
|
previewOAuthAuthorizationRequestOpts(requestParameters: PreviewOAuthAuthorizationRequest): Promise<runtime.RequestOpts>;
|
|
1712
1712
|
/**
|
|
1713
|
-
* Validates the
|
|
1714
|
-
* Describe an
|
|
1713
|
+
* Called by the login site. Validates the app, redirect URI and resource for the user whose access token is in the body, and names the app.
|
|
1714
|
+
* Describe an app\'s sign-in request before the user approves it
|
|
1715
1715
|
*/
|
|
1716
1716
|
previewOAuthAuthorizationRaw(requestParameters: PreviewOAuthAuthorizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuthorizationPreview>>;
|
|
1717
1717
|
/**
|
|
1718
|
-
* Validates the
|
|
1719
|
-
* Describe an
|
|
1718
|
+
* Called by the login site. Validates the app, redirect URI and resource for the user whose access token is in the body, and names the app.
|
|
1719
|
+
* Describe an app\'s sign-in request before the user approves it
|
|
1720
1720
|
*/
|
|
1721
1721
|
previewOAuthAuthorization(requestParameters: PreviewOAuthAuthorizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuthorizationPreview>;
|
|
1722
1722
|
/**
|
|
@@ -151,8 +151,8 @@ export class PlatformClient extends runtime.BaseAPI {
|
|
|
151
151
|
});
|
|
152
152
|
}
|
|
153
153
|
/**
|
|
154
|
-
* Issues a single-use authorization code the
|
|
155
|
-
*
|
|
154
|
+
* Called by the login site after the user consents. Issues a single-use authorization code the app redeems at the token endpoint.
|
|
155
|
+
* Record the user\'s approval of an app\'s sign-in request
|
|
156
156
|
*/
|
|
157
157
|
approveOAuthAuthorizationRaw(requestParameters, initOverrides) {
|
|
158
158
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -162,8 +162,8 @@ export class PlatformClient extends runtime.BaseAPI {
|
|
|
162
162
|
});
|
|
163
163
|
}
|
|
164
164
|
/**
|
|
165
|
-
* Issues a single-use authorization code the
|
|
166
|
-
*
|
|
165
|
+
* Called by the login site after the user consents. Issues a single-use authorization code the app redeems at the token endpoint.
|
|
166
|
+
* Record the user\'s approval of an app\'s sign-in request
|
|
167
167
|
*/
|
|
168
168
|
approveOAuthAuthorization(requestParameters, initOverrides) {
|
|
169
169
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -4236,8 +4236,8 @@ export class PlatformClient extends runtime.BaseAPI {
|
|
|
4236
4236
|
});
|
|
4237
4237
|
}
|
|
4238
4238
|
/**
|
|
4239
|
-
* Validates the
|
|
4240
|
-
* Describe an
|
|
4239
|
+
* Called by the login site. Validates the app, redirect URI and resource for the user whose access token is in the body, and names the app.
|
|
4240
|
+
* Describe an app\'s sign-in request before the user approves it
|
|
4241
4241
|
*/
|
|
4242
4242
|
previewOAuthAuthorizationRaw(requestParameters, initOverrides) {
|
|
4243
4243
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -4247,8 +4247,8 @@ export class PlatformClient extends runtime.BaseAPI {
|
|
|
4247
4247
|
});
|
|
4248
4248
|
}
|
|
4249
4249
|
/**
|
|
4250
|
-
* Validates the
|
|
4251
|
-
* Describe an
|
|
4250
|
+
* Called by the login site. Validates the app, redirect URI and resource for the user whose access token is in the body, and names the app.
|
|
4251
|
+
* Describe an app\'s sign-in request before the user approves it
|
|
4252
4252
|
*/
|
|
4253
4253
|
previewOAuthAuthorization(requestParameters, initOverrides) {
|
|
4254
4254
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -332,6 +332,12 @@ export interface AuthorizationRequest {
|
|
|
332
332
|
* @memberof AuthorizationRequest
|
|
333
333
|
*/
|
|
334
334
|
resource?: string | null;
|
|
335
|
+
/**
|
|
336
|
+
*
|
|
337
|
+
* @type {string}
|
|
338
|
+
* @memberof AuthorizationRequest
|
|
339
|
+
*/
|
|
340
|
+
userToken?: string | null;
|
|
335
341
|
}
|
|
336
342
|
/**
|
|
337
343
|
*
|
package/dist/models/index.d.ts
CHANGED
|
@@ -332,6 +332,12 @@ export interface AuthorizationRequest {
|
|
|
332
332
|
* @memberof AuthorizationRequest
|
|
333
333
|
*/
|
|
334
334
|
resource?: string | null;
|
|
335
|
+
/**
|
|
336
|
+
*
|
|
337
|
+
* @type {string}
|
|
338
|
+
* @memberof AuthorizationRequest
|
|
339
|
+
*/
|
|
340
|
+
userToken?: string | null;
|
|
335
341
|
}
|
|
336
342
|
/**
|
|
337
343
|
*
|
|
@@ -11,6 +11,7 @@ Name | Type
|
|
|
11
11
|
`codeChallengeMethod` | string
|
|
12
12
|
`redirectUri` | string
|
|
13
13
|
`resource` | string
|
|
14
|
+
`userToken` | string
|
|
14
15
|
|
|
15
16
|
|
|
16
17
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
package/docs/PlatformClient.md
CHANGED
|
@@ -6,7 +6,7 @@ All URIs are relative to *https://snokam.snosky.no/api/platform*
|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
| [**addCustomDomain**](PlatformClient.md#addcustomdomainoperation) | **POST** /v1.0/protected/businesses/{id}/custom-domains | Add a custom domain |
|
|
8
8
|
| [**approveDevice**](PlatformClient.md#approvedeviceoperation) | **POST** /v1.0/protected/businesses/{id}/devices | Approve a screen into this business |
|
|
9
|
-
| [**approveOAuthAuthorization**](PlatformClient.md#approveoauthauthorization) | **POST** /v1.0/protected/oauth/authorization |
|
|
9
|
+
| [**approveOAuthAuthorization**](PlatformClient.md#approveoauthauthorization) | **POST** /v1.0/protected/oauth/authorization | Record the user\'s approval of an app\'s sign-in request |
|
|
10
10
|
| [**assignBusinessEmployeeSystem**](PlatformClient.md#assignbusinessemployeesystem) | **POST** /v1.0/protected/businesses/{id}/employees/{upn}/systems/{systemKey} | Grant an employee a seat in a third-party system |
|
|
11
11
|
| [**backfillBridgeWebhook**](PlatformClient.md#backfillbridgewebhook) | **POST** /v1.0/protected/businesses/{id}/bridge-webhook | Re-create a business\'s Sanity bridge webhook with a managed API key |
|
|
12
12
|
| [**checkIntegration**](PlatformClient.md#checkintegration) | **POST** /v1.0/protected/businesses/{id}/integrations/{key}/check | Run a live integration connectivity check |
|
|
@@ -97,7 +97,7 @@ All URIs are relative to *https://snokam.snosky.no/api/platform*
|
|
|
97
97
|
| [**powerOfficeOnboardingReturn**](PlatformClient.md#powerofficeonboardingreturn) | **GET** /v1.0/connect/poweroffice/return/{reference} | PowerOffice onboarding return |
|
|
98
98
|
| [**previewBillingInvoice**](PlatformClient.md#previewbillinginvoice) | **POST** /v1.0/protected/businesses/{id}/billing/invoice-preview | Preview a month\'s invoice basis |
|
|
99
99
|
| [**previewDevice**](PlatformClient.md#previewdevice) | **GET** /v1.0/protected/businesses/{id}/devices/preview | Look up a pairing code before approving |
|
|
100
|
-
| [**previewOAuthAuthorization**](PlatformClient.md#previewoauthauthorization) | **POST** /v1.0/protected/oauth/authorization/preview | Describe an
|
|
100
|
+
| [**previewOAuthAuthorization**](PlatformClient.md#previewoauthauthorization) | **POST** /v1.0/protected/oauth/authorization/preview | Describe an app\'s sign-in request before the user approves it |
|
|
101
101
|
| [**provisionBusiness**](PlatformClient.md#provisionbusiness) | **POST** /v1.0/protected/businesses/{id}/provision | Provision a business |
|
|
102
102
|
| [**publicCapabilities**](PlatformClient.md#publiccapabilities) | **GET** /v1.0/public/capabilities | Get capabilities |
|
|
103
103
|
| [**publicModules**](PlatformClient.md#publicmodules) | **GET** /v1.0/public/modules | Get available modules |
|
|
@@ -294,9 +294,9 @@ example().catch(console.error);
|
|
|
294
294
|
|
|
295
295
|
> IssuedAuthorizationCode approveOAuthAuthorization(authorizationRequest)
|
|
296
296
|
|
|
297
|
-
|
|
297
|
+
Record the user\'s approval of an app\'s sign-in request
|
|
298
298
|
|
|
299
|
-
Issues a single-use authorization code the
|
|
299
|
+
Called by the login site after the user consents. Issues a single-use authorization code the app redeems at the token endpoint.
|
|
300
300
|
|
|
301
301
|
### Example
|
|
302
302
|
|
|
@@ -6712,9 +6712,9 @@ example().catch(console.error);
|
|
|
6712
6712
|
|
|
6713
6713
|
> AuthorizationPreview previewOAuthAuthorization(authorizationRequest)
|
|
6714
6714
|
|
|
6715
|
-
Describe an
|
|
6715
|
+
Describe an app\'s sign-in request before the user approves it
|
|
6716
6716
|
|
|
6717
|
-
Validates the
|
|
6717
|
+
Called by the login site. Validates the app, redirect URI and resource for the user whose access token is in the body, and names the app.
|
|
6718
6718
|
|
|
6719
6719
|
### Example
|
|
6720
6720
|
|
package/package.json
CHANGED
|
@@ -794,8 +794,8 @@ export class PlatformClient extends runtime.BaseAPI {
|
|
|
794
794
|
}
|
|
795
795
|
|
|
796
796
|
/**
|
|
797
|
-
* Issues a single-use authorization code the
|
|
798
|
-
*
|
|
797
|
+
* Called by the login site after the user consents. Issues a single-use authorization code the app redeems at the token endpoint.
|
|
798
|
+
* Record the user\'s approval of an app\'s sign-in request
|
|
799
799
|
*/
|
|
800
800
|
async approveOAuthAuthorizationRaw(requestParameters: ApproveOAuthAuthorizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IssuedAuthorizationCode>> {
|
|
801
801
|
const requestOptions = await this.approveOAuthAuthorizationRequestOpts(requestParameters);
|
|
@@ -805,8 +805,8 @@ export class PlatformClient extends runtime.BaseAPI {
|
|
|
805
805
|
}
|
|
806
806
|
|
|
807
807
|
/**
|
|
808
|
-
* Issues a single-use authorization code the
|
|
809
|
-
*
|
|
808
|
+
* Called by the login site after the user consents. Issues a single-use authorization code the app redeems at the token endpoint.
|
|
809
|
+
* Record the user\'s approval of an app\'s sign-in request
|
|
810
810
|
*/
|
|
811
811
|
async approveOAuthAuthorization(requestParameters: ApproveOAuthAuthorizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IssuedAuthorizationCode> {
|
|
812
812
|
const response = await this.approveOAuthAuthorizationRaw(requestParameters, initOverrides);
|
|
@@ -5534,8 +5534,8 @@ export class PlatformClient extends runtime.BaseAPI {
|
|
|
5534
5534
|
}
|
|
5535
5535
|
|
|
5536
5536
|
/**
|
|
5537
|
-
* Validates the
|
|
5538
|
-
* Describe an
|
|
5537
|
+
* Called by the login site. Validates the app, redirect URI and resource for the user whose access token is in the body, and names the app.
|
|
5538
|
+
* Describe an app\'s sign-in request before the user approves it
|
|
5539
5539
|
*/
|
|
5540
5540
|
async previewOAuthAuthorizationRaw(requestParameters: PreviewOAuthAuthorizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuthorizationPreview>> {
|
|
5541
5541
|
const requestOptions = await this.previewOAuthAuthorizationRequestOpts(requestParameters);
|
|
@@ -5545,8 +5545,8 @@ export class PlatformClient extends runtime.BaseAPI {
|
|
|
5545
5545
|
}
|
|
5546
5546
|
|
|
5547
5547
|
/**
|
|
5548
|
-
* Validates the
|
|
5549
|
-
* Describe an
|
|
5548
|
+
* Called by the login site. Validates the app, redirect URI and resource for the user whose access token is in the body, and names the app.
|
|
5549
|
+
* Describe an app\'s sign-in request before the user approves it
|
|
5550
5550
|
*/
|
|
5551
5551
|
async previewOAuthAuthorization(requestParameters: PreviewOAuthAuthorizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuthorizationPreview> {
|
|
5552
5552
|
const response = await this.previewOAuthAuthorizationRaw(requestParameters, initOverrides);
|
package/src/models/index.ts
CHANGED
|
@@ -334,6 +334,12 @@ export interface AuthorizationRequest {
|
|
|
334
334
|
* @memberof AuthorizationRequest
|
|
335
335
|
*/
|
|
336
336
|
resource?: string | null;
|
|
337
|
+
/**
|
|
338
|
+
*
|
|
339
|
+
* @type {string}
|
|
340
|
+
* @memberof AuthorizationRequest
|
|
341
|
+
*/
|
|
342
|
+
userToken?: string | null;
|
|
337
343
|
}
|
|
338
344
|
/**
|
|
339
345
|
*
|