@fern-api/venus-api-sdk 11.1.0 → 11.1.2

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.
@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
43
43
  const headers = (0, headers_js_1.mergeHeaders)({
44
44
  "X-Fern-Language": "JavaScript",
45
45
  "X-Fern-SDK-Name": "@fern-api/venus-api-sdk",
46
- "X-Fern-SDK-Version": "11.1.0",
47
- "User-Agent": "@fern-api/venus-api-sdk/11.1.0",
46
+ "X-Fern-SDK-Version": "11.1.2",
47
+ "User-Agent": "@fern-api/venus-api-sdk/11.1.2",
48
48
  "X-Fern-Runtime": core.RUNTIME.type,
49
49
  "X-Fern-Runtime-Version": core.RUNTIME.version,
50
50
  }, options === null || options === void 0 ? void 0 : options.headers);
@@ -11,6 +11,10 @@ export declare class ApiKeysClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<ApiKeysClient.Options>;
12
12
  constructor(options: ApiKeysClient.Options);
13
13
  /**
14
+ * Creates an API key for an organization the caller is a member of. Called
15
+ * with the provisioner token, it only works for an unclaimed organization
16
+ * that was created with that token, and returns 403 for any other.
17
+ *
14
18
  * @param {FernVenusApi.CreateApiKeyRequest} request
15
19
  * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
16
20
  *
@@ -65,6 +65,10 @@ class ApiKeysClient {
65
65
  this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
66
66
  }
67
67
  /**
68
+ * Creates an API key for an organization the caller is a member of. Called
69
+ * with the provisioner token, it only works for an unclaimed organization
70
+ * that was created with that token, and returns 403 for any other.
71
+ *
68
72
  * @param {FernVenusApi.CreateApiKeyRequest} request
69
73
  * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
70
74
  *
@@ -11,6 +11,13 @@ export declare class OrganizationClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<OrganizationClient.Options>;
12
12
  constructor(options: OrganizationClient.Options);
13
13
  /**
14
+ * Creates an organization with the caller as its admin. Called with the
15
+ * provisioner token, it instead creates an unclaimed organization, with no
16
+ * Auth0 organization or members, linked to the required postmanTeamId.
17
+ * Creating it again for the same team returns the same organization.
18
+ * A normal signup gets 409 if its postmanTeamId is linked to an unclaimed
19
+ * organization, since that team claims its organization through Postman.
20
+ *
14
21
  * @param {FernVenusApi.CreateOrganizationRequest} request
15
22
  * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
16
23
  *
@@ -65,6 +65,13 @@ class OrganizationClient {
65
65
  this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
66
66
  }
67
67
  /**
68
+ * Creates an organization with the caller as its admin. Called with the
69
+ * provisioner token, it instead creates an unclaimed organization, with no
70
+ * Auth0 organization or members, linked to the required postmanTeamId.
71
+ * Creating it again for the same team returns the same organization.
72
+ * A normal signup gets 409 if its postmanTeamId is linked to an unclaimed
73
+ * organization, since that team claims its organization through Postman.
74
+ *
68
75
  * @param {FernVenusApi.CreateOrganizationRequest} request
69
76
  * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
70
77
  *
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "11.1.0";
1
+ export declare const SDK_VERSION = "11.1.2";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "11.1.0";
4
+ exports.SDK_VERSION = "11.1.2";
@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
6
6
  const headers = mergeHeaders({
7
7
  "X-Fern-Language": "JavaScript",
8
8
  "X-Fern-SDK-Name": "@fern-api/venus-api-sdk",
9
- "X-Fern-SDK-Version": "11.1.0",
10
- "User-Agent": "@fern-api/venus-api-sdk/11.1.0",
9
+ "X-Fern-SDK-Version": "11.1.2",
10
+ "User-Agent": "@fern-api/venus-api-sdk/11.1.2",
11
11
  "X-Fern-Runtime": core.RUNTIME.type,
12
12
  "X-Fern-Runtime-Version": core.RUNTIME.version,
13
13
  }, options === null || options === void 0 ? void 0 : options.headers);
@@ -11,6 +11,10 @@ export declare class ApiKeysClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<ApiKeysClient.Options>;
12
12
  constructor(options: ApiKeysClient.Options);
13
13
  /**
14
+ * Creates an API key for an organization the caller is a member of. Called
15
+ * with the provisioner token, it only works for an unclaimed organization
16
+ * that was created with that token, and returns 403 for any other.
17
+ *
14
18
  * @param {FernVenusApi.CreateApiKeyRequest} request
15
19
  * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
16
20
  *
@@ -29,6 +29,10 @@ export class ApiKeysClient {
29
29
  this._options = normalizeClientOptionsWithAuth(options);
30
30
  }
31
31
  /**
32
+ * Creates an API key for an organization the caller is a member of. Called
33
+ * with the provisioner token, it only works for an unclaimed organization
34
+ * that was created with that token, and returns 403 for any other.
35
+ *
32
36
  * @param {FernVenusApi.CreateApiKeyRequest} request
33
37
  * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
34
38
  *
@@ -11,6 +11,13 @@ export declare class OrganizationClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<OrganizationClient.Options>;
12
12
  constructor(options: OrganizationClient.Options);
13
13
  /**
14
+ * Creates an organization with the caller as its admin. Called with the
15
+ * provisioner token, it instead creates an unclaimed organization, with no
16
+ * Auth0 organization or members, linked to the required postmanTeamId.
17
+ * Creating it again for the same team returns the same organization.
18
+ * A normal signup gets 409 if its postmanTeamId is linked to an unclaimed
19
+ * organization, since that team claims its organization through Postman.
20
+ *
14
21
  * @param {FernVenusApi.CreateOrganizationRequest} request
15
22
  * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
16
23
  *
@@ -29,6 +29,13 @@ export class OrganizationClient {
29
29
  this._options = normalizeClientOptionsWithAuth(options);
30
30
  }
31
31
  /**
32
+ * Creates an organization with the caller as its admin. Called with the
33
+ * provisioner token, it instead creates an unclaimed organization, with no
34
+ * Auth0 organization or members, linked to the required postmanTeamId.
35
+ * Creating it again for the same team returns the same organization.
36
+ * A normal signup gets 409 if its postmanTeamId is linked to an unclaimed
37
+ * organization, since that team claims its organization through Postman.
38
+ *
32
39
  * @param {FernVenusApi.CreateOrganizationRequest} request
33
40
  * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
34
41
  *
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "11.1.0";
1
+ export declare const SDK_VERSION = "11.1.2";
@@ -1 +1 @@
1
- export const SDK_VERSION = "11.1.0";
1
+ export const SDK_VERSION = "11.1.2";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fern-api/venus-api-sdk",
3
- "version": "11.1.0",
3
+ "version": "11.1.2",
4
4
  "private": false,
5
5
  "repository": {
6
6
  "type": "git",
package/reference.md CHANGED
@@ -145,6 +145,22 @@ await client.healthRdsHealthRdsGet();
145
145
  <dl>
146
146
  <dd>
147
147
 
148
+ #### 📝 Description
149
+
150
+ <dl>
151
+ <dd>
152
+
153
+ <dl>
154
+ <dd>
155
+
156
+ Creates an API key for an organization the caller is a member of. Called
157
+ with the provisioner token, it only works for an unclaimed organization
158
+ that was created with that token, and returns 403 for any other.
159
+ </dd>
160
+ </dl>
161
+ </dd>
162
+ </dl>
163
+
148
164
  #### 🔌 Usage
149
165
 
150
166
  <dl>
@@ -657,6 +673,25 @@ await client.auth.getJwt({
657
673
  <dl>
658
674
  <dd>
659
675
 
676
+ #### 📝 Description
677
+
678
+ <dl>
679
+ <dd>
680
+
681
+ <dl>
682
+ <dd>
683
+
684
+ Creates an organization with the caller as its admin. Called with the
685
+ provisioner token, it instead creates an unclaimed organization, with no
686
+ Auth0 organization or members, linked to the required postmanTeamId.
687
+ Creating it again for the same team returns the same organization.
688
+ A normal signup gets 409 if its postmanTeamId is linked to an unclaimed
689
+ organization, since that team claims its organization through Postman.
690
+ </dd>
691
+ </dl>
692
+ </dd>
693
+ </dl>
694
+
660
695
  #### 🔌 Usage
661
696
 
662
697
  <dl>