@fern-api/venus-api-sdk 11.1.0 → 11.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.
Files changed (12) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/organization/client/Client.d.ts +7 -0
  3. package/dist/cjs/api/resources/organization/client/Client.js +7 -0
  4. package/dist/cjs/version.d.ts +1 -1
  5. package/dist/cjs/version.js +1 -1
  6. package/dist/esm/BaseClient.mjs +2 -2
  7. package/dist/esm/api/resources/organization/client/Client.d.mts +7 -0
  8. package/dist/esm/api/resources/organization/client/Client.mjs +7 -0
  9. package/dist/esm/version.d.mts +1 -1
  10. package/dist/esm/version.mjs +1 -1
  11. package/package.json +1 -1
  12. package/reference.md +19 -0
package/dist/cjs/BaseClient.js CHANGED
@@ -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.1",
47
+ "User-Agent": "@fern-api/venus-api-sdk/11.1.1",
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);
package/dist/cjs/api/resources/organization/client/Client.d.ts CHANGED
@@ -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
  *
package/dist/cjs/api/resources/organization/client/Client.js CHANGED
@@ -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
  *
package/dist/cjs/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "11.1.0";
1
+ export declare const SDK_VERSION = "11.1.1";
package/dist/cjs/version.js CHANGED
@@ -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.1";
package/dist/esm/BaseClient.mjs CHANGED
@@ -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.1",
10
+ "User-Agent": "@fern-api/venus-api-sdk/11.1.1",
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);
package/dist/esm/api/resources/organization/client/Client.d.mts CHANGED
@@ -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
  *
package/dist/esm/api/resources/organization/client/Client.mjs CHANGED
@@ -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
  *
package/dist/esm/version.d.mts CHANGED
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "11.1.0";
1
+ export declare const SDK_VERSION = "11.1.1";
package/dist/esm/version.mjs CHANGED
@@ -1 +1 @@
1
- export const SDK_VERSION = "11.1.0";
1
+ export const SDK_VERSION = "11.1.1";
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.1",
4
4
  "private": false,
5
5
  "repository": {
6
6
  "type": "git",
package/reference.md CHANGED
@@ -657,6 +657,25 @@ await client.auth.getJwt({
657
657
  <dl>
658
658
  <dd>
659
659
 
660
+ #### 📝 Description
661
+
662
+ <dl>
663
+ <dd>
664
+
665
+ <dl>
666
+ <dd>
667
+
668
+ Creates an organization with the caller as its admin. Called with the
669
+ provisioner token, it instead creates an unclaimed organization, with no
670
+ Auth0 organization or members, linked to the required postmanTeamId.
671
+ Creating it again for the same team returns the same organization.
672
+ A normal signup gets 409 if its postmanTeamId is linked to an unclaimed
673
+ organization, since that team claims its organization through Postman.
674
+ </dd>
675
+ </dl>
676
+ </dd>
677
+ </dl>
678
+
660
679
  #### 🔌 Usage
661
680
 
662
681
  <dl>