@dynamic-labs/sdk-api 0.97.0 → 0.99.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dynamic-labs/sdk-api",
3
- "version": "0.97.0",
3
+ "version": "0.99.0",
4
4
  "author": "Dynamic Labs",
5
5
  "license": "Apache-2.0",
6
6
  "publishConfig": {
@@ -234,7 +234,7 @@ require('../models/YieldProviderEnum.cjs');
234
234
  */
235
235
  class WaasApi extends runtime.BaseAPI {
236
236
  /**
237
- * Authenticates for WaaS using an API key. With a `serverIdentifier` (UUID of a server identity) in the JSON body, authenticates as that identity, provided it still holds an active Server Signing Key. Without it, authenticates as the environment\'s default server identity. The body is not declared in this contract, so that clients that send none keep working.
237
+ * For legacy server SDKs: authenticates for WaaS using an API key, as the environment\'s default server identity. Server signers do not use this endpoint; they sign each request with their registered key. A `serverIdentifier` in the JSON body is refused with 401. The body is not declared in this contract, so that clients that send none keep working.
238
238
  * Authenticate for WAAS using an API key
239
239
  */
240
240
  async authenticateWaasRaw(requestParameters, initOverrides) {
@@ -259,7 +259,7 @@ class WaasApi extends runtime.BaseAPI {
259
259
  return new runtime.JSONApiResponse(response, (jsonValue) => WaasAuthenticateResponse.WaasAuthenticateResponseFromJSON(jsonValue));
260
260
  }
261
261
  /**
262
- * Authenticates for WaaS using an API key. With a `serverIdentifier` (UUID of a server identity) in the JSON body, authenticates as that identity, provided it still holds an active Server Signing Key. Without it, authenticates as the environment\'s default server identity. The body is not declared in this contract, so that clients that send none keep working.
262
+ * For legacy server SDKs: authenticates for WaaS using an API key, as the environment\'s default server identity. Server signers do not use this endpoint; they sign each request with their registered key. A `serverIdentifier` in the JSON body is refused with 401. The body is not declared in this contract, so that clients that send none keep working.
263
263
  * Authenticate for WAAS using an API key
264
264
  */
265
265
  async authenticateWaas(requestParameters, initOverrides) {
@@ -925,7 +925,7 @@ class WaasApi extends runtime.BaseAPI {
925
925
  await this.optionsDelegatedAccessEncryptionPublicKeyRaw(requestParameters, initOverrides);
926
926
  }
927
927
  /**
928
- * Registers a P-256 public key for a server identity (`serverIdentifier`), creating the identity when it does not exist yet or when `serverIdentifier` is omitted. An identity can hold several keys. A server authenticates by presenting its `serverIdentifier`, while it holds an active key. Dashboard admin JWT only; API tokens are rejected. Registering the same key again returns it. An identifier already used by another environment\'s identity is a 409. Revoked keys cannot be re-registered.
928
+ * Registers a P-256 public key for a server signer (`serverIdentifier`), creating the signer when it does not exist yet or when `serverIdentifier` is omitted. A server signer can hold several keys and signs its requests with them. Dashboard admin JWT only; API tokens are rejected. Registering the same key again returns it. An identifier already used by another environment\'s signer is a 409. Revoked keys cannot be re-registered.
929
929
  * Register a Server Signing Key for a server identity
930
930
  */
931
931
  async registerServerSigningKeyRaw(requestParameters, initOverrides) {
@@ -948,7 +948,7 @@ class WaasApi extends runtime.BaseAPI {
948
948
  return new runtime.JSONApiResponse(response, (jsonValue) => ServerSigningKeySummary.ServerSigningKeySummaryFromJSON(jsonValue));
949
949
  }
950
950
  /**
951
- * Registers a P-256 public key for a server identity (`serverIdentifier`), creating the identity when it does not exist yet or when `serverIdentifier` is omitted. An identity can hold several keys. A server authenticates by presenting its `serverIdentifier`, while it holds an active key. Dashboard admin JWT only; API tokens are rejected. Registering the same key again returns it. An identifier already used by another environment\'s identity is a 409. Revoked keys cannot be re-registered.
951
+ * Registers a P-256 public key for a server signer (`serverIdentifier`), creating the signer when it does not exist yet or when `serverIdentifier` is omitted. A server signer can hold several keys and signs its requests with them. Dashboard admin JWT only; API tokens are rejected. Registering the same key again returns it. An identifier already used by another environment\'s signer is a 409. Revoked keys cannot be re-registered.
952
952
  * Register a Server Signing Key for a server identity
953
953
  */
954
954
  async registerServerSigningKey(requestParameters, initOverrides) {
@@ -145,12 +145,12 @@ export interface WaasVerifyApiKeyRequest {
145
145
  */
146
146
  export declare class WaasApi extends runtime.BaseAPI {
147
147
  /**
148
- * Authenticates for WaaS using an API key. With a `serverIdentifier` (UUID of a server identity) in the JSON body, authenticates as that identity, provided it still holds an active Server Signing Key. Without it, authenticates as the environment\'s default server identity. The body is not declared in this contract, so that clients that send none keep working.
148
+ * For legacy server SDKs: authenticates for WaaS using an API key, as the environment\'s default server identity. Server signers do not use this endpoint; they sign each request with their registered key. A `serverIdentifier` in the JSON body is refused with 401. The body is not declared in this contract, so that clients that send none keep working.
149
149
  * Authenticate for WAAS using an API key
150
150
  */
151
151
  authenticateWaasRaw(requestParameters: AuthenticateWaasRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<WaasAuthenticateResponse>>;
152
152
  /**
153
- * Authenticates for WaaS using an API key. With a `serverIdentifier` (UUID of a server identity) in the JSON body, authenticates as that identity, provided it still holds an active Server Signing Key. Without it, authenticates as the environment\'s default server identity. The body is not declared in this contract, so that clients that send none keep working.
153
+ * For legacy server SDKs: authenticates for WaaS using an API key, as the environment\'s default server identity. Server signers do not use this endpoint; they sign each request with their registered key. A `serverIdentifier` in the JSON body is refused with 401. The body is not declared in this contract, so that clients that send none keep working.
154
154
  * Authenticate for WAAS using an API key
155
155
  */
156
156
  authenticateWaas(requestParameters: AuthenticateWaasRequest, initOverrides?: RequestInit): Promise<WaasAuthenticateResponse>;
@@ -373,12 +373,12 @@ export declare class WaasApi extends runtime.BaseAPI {
373
373
  */
374
374
  optionsDelegatedAccessEncryptionPublicKey(requestParameters: OptionsDelegatedAccessEncryptionPublicKeyRequest, initOverrides?: RequestInit): Promise<void>;
375
375
  /**
376
- * Registers a P-256 public key for a server identity (`serverIdentifier`), creating the identity when it does not exist yet or when `serverIdentifier` is omitted. An identity can hold several keys. A server authenticates by presenting its `serverIdentifier`, while it holds an active key. Dashboard admin JWT only; API tokens are rejected. Registering the same key again returns it. An identifier already used by another environment\'s identity is a 409. Revoked keys cannot be re-registered.
376
+ * Registers a P-256 public key for a server signer (`serverIdentifier`), creating the signer when it does not exist yet or when `serverIdentifier` is omitted. A server signer can hold several keys and signs its requests with them. Dashboard admin JWT only; API tokens are rejected. Registering the same key again returns it. An identifier already used by another environment\'s signer is a 409. Revoked keys cannot be re-registered.
377
377
  * Register a Server Signing Key for a server identity
378
378
  */
379
379
  registerServerSigningKeyRaw(requestParameters: RegisterServerSigningKeyOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ServerSigningKeySummary>>;
380
380
  /**
381
- * Registers a P-256 public key for a server identity (`serverIdentifier`), creating the identity when it does not exist yet or when `serverIdentifier` is omitted. An identity can hold several keys. A server authenticates by presenting its `serverIdentifier`, while it holds an active key. Dashboard admin JWT only; API tokens are rejected. Registering the same key again returns it. An identifier already used by another environment\'s identity is a 409. Revoked keys cannot be re-registered.
381
+ * Registers a P-256 public key for a server signer (`serverIdentifier`), creating the signer when it does not exist yet or when `serverIdentifier` is omitted. A server signer can hold several keys and signs its requests with them. Dashboard admin JWT only; API tokens are rejected. Registering the same key again returns it. An identifier already used by another environment\'s signer is a 409. Revoked keys cannot be re-registered.
382
382
  * Register a Server Signing Key for a server identity
383
383
  */
384
384
  registerServerSigningKey(requestParameters: RegisterServerSigningKeyOperationRequest, initOverrides?: RequestInit): Promise<ServerSigningKeySummary>;
@@ -230,7 +230,7 @@ import '../models/YieldProviderEnum.js';
230
230
  */
231
231
  class WaasApi extends BaseAPI {
232
232
  /**
233
- * Authenticates for WaaS using an API key. With a `serverIdentifier` (UUID of a server identity) in the JSON body, authenticates as that identity, provided it still holds an active Server Signing Key. Without it, authenticates as the environment\'s default server identity. The body is not declared in this contract, so that clients that send none keep working.
233
+ * For legacy server SDKs: authenticates for WaaS using an API key, as the environment\'s default server identity. Server signers do not use this endpoint; they sign each request with their registered key. A `serverIdentifier` in the JSON body is refused with 401. The body is not declared in this contract, so that clients that send none keep working.
234
234
  * Authenticate for WAAS using an API key
235
235
  */
236
236
  async authenticateWaasRaw(requestParameters, initOverrides) {
@@ -255,7 +255,7 @@ class WaasApi extends BaseAPI {
255
255
  return new JSONApiResponse(response, (jsonValue) => WaasAuthenticateResponseFromJSON(jsonValue));
256
256
  }
257
257
  /**
258
- * Authenticates for WaaS using an API key. With a `serverIdentifier` (UUID of a server identity) in the JSON body, authenticates as that identity, provided it still holds an active Server Signing Key. Without it, authenticates as the environment\'s default server identity. The body is not declared in this contract, so that clients that send none keep working.
258
+ * For legacy server SDKs: authenticates for WaaS using an API key, as the environment\'s default server identity. Server signers do not use this endpoint; they sign each request with their registered key. A `serverIdentifier` in the JSON body is refused with 401. The body is not declared in this contract, so that clients that send none keep working.
259
259
  * Authenticate for WAAS using an API key
260
260
  */
261
261
  async authenticateWaas(requestParameters, initOverrides) {
@@ -921,7 +921,7 @@ class WaasApi extends BaseAPI {
921
921
  await this.optionsDelegatedAccessEncryptionPublicKeyRaw(requestParameters, initOverrides);
922
922
  }
923
923
  /**
924
- * Registers a P-256 public key for a server identity (`serverIdentifier`), creating the identity when it does not exist yet or when `serverIdentifier` is omitted. An identity can hold several keys. A server authenticates by presenting its `serverIdentifier`, while it holds an active key. Dashboard admin JWT only; API tokens are rejected. Registering the same key again returns it. An identifier already used by another environment\'s identity is a 409. Revoked keys cannot be re-registered.
924
+ * Registers a P-256 public key for a server signer (`serverIdentifier`), creating the signer when it does not exist yet or when `serverIdentifier` is omitted. A server signer can hold several keys and signs its requests with them. Dashboard admin JWT only; API tokens are rejected. Registering the same key again returns it. An identifier already used by another environment\'s signer is a 409. Revoked keys cannot be re-registered.
925
925
  * Register a Server Signing Key for a server identity
926
926
  */
927
927
  async registerServerSigningKeyRaw(requestParameters, initOverrides) {
@@ -944,7 +944,7 @@ class WaasApi extends BaseAPI {
944
944
  return new JSONApiResponse(response, (jsonValue) => ServerSigningKeySummaryFromJSON(jsonValue));
945
945
  }
946
946
  /**
947
- * Registers a P-256 public key for a server identity (`serverIdentifier`), creating the identity when it does not exist yet or when `serverIdentifier` is omitted. An identity can hold several keys. A server authenticates by presenting its `serverIdentifier`, while it holds an active key. Dashboard admin JWT only; API tokens are rejected. Registering the same key again returns it. An identifier already used by another environment\'s identity is a 409. Revoked keys cannot be re-registered.
947
+ * Registers a P-256 public key for a server signer (`serverIdentifier`), creating the signer when it does not exist yet or when `serverIdentifier` is omitted. A server signer can hold several keys and signs its requests with them. Dashboard admin JWT only; API tokens are rejected. Registering the same key again returns it. An identifier already used by another environment\'s signer is a 409. Revoked keys cannot be re-registered.
948
948
  * Register a Server Signing Key for a server identity
949
949
  */
950
950
  async registerServerSigningKey(requestParameters, initOverrides) {
@@ -44,6 +44,7 @@ exports.TokenScope = void 0;
44
44
  TokenScope["Consolesettingsupdate"] = "console:settings:update";
45
45
  TokenScope["Consolessoupdate"] = "console:sso:update";
46
46
  TokenScope["Consoleuserdelete"] = "console:user:delete";
47
+ TokenScope["ConsolewebhookSecretreveal"] = "console:webhook_secret:reveal";
47
48
  TokenScope["Credentiallink"] = "credential:link";
48
49
  TokenScope["Credentialupdate"] = "credential:update";
49
50
  TokenScope["Credentialunlink"] = "credential:unlink";
@@ -37,6 +37,7 @@ export declare enum TokenScope {
37
37
  Consolesettingsupdate = "console:settings:update",
38
38
  Consolessoupdate = "console:sso:update",
39
39
  Consoleuserdelete = "console:user:delete",
40
+ ConsolewebhookSecretreveal = "console:webhook_secret:reveal",
40
41
  Credentiallink = "credential:link",
41
42
  Credentialupdate = "credential:update",
42
43
  Credentialunlink = "credential:unlink",
@@ -40,6 +40,7 @@ var TokenScope;
40
40
  TokenScope["Consolesettingsupdate"] = "console:settings:update";
41
41
  TokenScope["Consolessoupdate"] = "console:sso:update";
42
42
  TokenScope["Consoleuserdelete"] = "console:user:delete";
43
+ TokenScope["ConsolewebhookSecretreveal"] = "console:webhook_secret:reveal";
43
44
  TokenScope["Credentiallink"] = "credential:link";
44
45
  TokenScope["Credentialupdate"] = "credential:update";
45
46
  TokenScope["Credentialunlink"] = "credential:unlink";