@or-sdk/sdk-api 0.28.3-beta.4133.0 → 0.28.3-beta.4136.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.
@@ -3,6 +3,14 @@ import { GenerateLegacyTokenParams, GenerateLegacyTokenResponse, SdkApiConfig }
3
3
  export declare class SdkApi extends Base {
4
4
  constructor(params: SdkApiConfig);
5
5
  makeRequest<T>(params: CalApiParams): Promise<T>;
6
+ /**
7
+ * Exchange an API token for a 30-min legacy user token with USER role
8
+ *
9
+ * ```typescript
10
+ * const { token, expire } = await sdkApi.generateLegacyToken();
11
+ * const { token, expire } = await sdkApi.generateLegacyToken({ userId });
12
+ * ```
13
+ */
6
14
  generateLegacyToken(params?: GenerateLegacyTokenParams): Promise<GenerateLegacyTokenResponse>;
7
15
  protected normalizeRoute(route: string): string;
8
16
  }
@@ -1 +1 @@
1
- {"version":3,"file":"SdkApi.d.ts","sourceRoot":"","sources":["../../src/SdkApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAGlD,OAAO,EACL,yBAAyB,EACzB,2BAA2B,EAC3B,YAAY,EACb,MAAM,SAAS,CAAC;AAEjB,qBAAa,MAAO,SAAQ,IAAI;gBAElB,MAAM,EAAE,YAAY;IAYnB,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,CAAC,CAAC;IAYhD,mBAAmB,CAC9B,MAAM,GAAE,yBAA8B,GACrC,OAAO,CAAC,2BAA2B,CAAC;IAQvC,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;CAQhD"}
1
+ {"version":3,"file":"SdkApi.d.ts","sourceRoot":"","sources":["../../src/SdkApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAGlD,OAAO,EACL,yBAAyB,EACzB,2BAA2B,EAC3B,YAAY,EACb,MAAM,SAAS,CAAC;AAEjB,qBAAa,MAAO,SAAQ,IAAI;gBAElB,MAAM,EAAE,YAAY;IAYnB,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,CAAC,CAAC;IAI7D;;;;;;;OAOG;IACU,mBAAmB,CAC9B,MAAM,GAAE,yBAA8B,GACrC,OAAO,CAAC,2BAA2B,CAAC;IAQvC,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;CAQhD"}
@@ -1,15 +1,37 @@
1
1
  import { Token } from '@or-sdk/base';
2
2
  export type GenerateLegacyTokenParams = {
3
+ /**
4
+ * userId for the generated token – must be an active user with role USER in the api-token's account
5
+ * Optional when the api-token's `createdBy` user already satisfies that requirement
6
+ */
3
7
  userId?: string;
4
8
  };
5
9
  export type GenerateLegacyTokenResponse = {
10
+ /**
11
+ * Raw legacy user token
12
+ */
6
13
  token: string;
14
+ /**
15
+ * Unix-ms timestamp when the token expires
16
+ */
7
17
  expire: number;
8
18
  };
9
19
  export type SdkApiConfig = {
20
+ /**
21
+ * token
22
+ */
10
23
  token: Token;
24
+ /**
25
+ * Url of OneReach service discovery api
26
+ */
11
27
  discoveryUrl?: string;
28
+ /**
29
+ * Account ID for cross-account requests (super admin only)
30
+ */
12
31
  accountId?: string;
32
+ /**
33
+ * Url of OneReach SDK api
34
+ */
13
35
  sdkUrl?: string;
14
36
  };
15
37
  //# sourceMappingURL=types.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAErC,MAAM,MAAM,yBAAyB,GAAG;IAKtC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IAIxC,KAAK,EAAE,MAAM,CAAC;IAKd,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IAIzB,KAAK,EAAE,KAAK,CAAC;IAKb,YAAY,CAAC,EAAE,MAAM,CAAC;IAKtB,SAAS,CAAC,EAAE,MAAM,CAAC;IAKnB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAErC,MAAM,MAAM,yBAAyB,GAAG;IACtC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IAEb;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@or-sdk/sdk-api",
3
- "version": "0.28.3-beta.4133.0",
3
+ "version": "0.28.3-beta.4136.0",
4
4
  "license": "Apache-2.0",
5
5
  "main": "dist/cjs/index.js",
6
6
  "module": "dist/esm/index.js",