@fern-api/venus-api-sdk 12.3.0 → 13.0.0

package/dist/esm/api/client/{pingPingGet.mjs → metricsMetricsGet.mjs}

@@ -6,7 +6,7 @@ export const Error = {
             statusCode: undefined,
             content: fetcherError,
             _visit: function (visitor) {
-                return FernVenusApi.pingPingGet.Error._visit(this, visitor);
+                return FernVenusApi.metricsMetricsGet.Error._visit(this, visitor);
             },
         };
     },

package/dist/esm/api/resources/apiKeys/client/Client.d.mts

@@ -11,10 +11,6 @@ export declare class ApiKeysClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<ApiKeysClient.Options>;
     constructor(options: ApiKeysClient.Options);
     /**
-     * Creates an API key for an organization the caller is a member of. Called
-     * with the provisioner token, it only works for an unclaimed organization
-     * that was created with that token, and returns 403 for any other.
-     *
      * @param {FernVenusApi.CreateApiKeyRequest} request
      * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -37,10 +33,6 @@ export declare class ApiKeysClient {
     getTokenMetadata(request: FernVenusApi.GetTokenMetadataRequest, requestOptions?: ApiKeysClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.TokenMetadata, FernVenusApi.apiKeys.getTokenMetadata.Error>>;
     private __getTokenMetadata;
     /**
-     * Lists an organization's API keys. Called with the provisioner token, it
-     * only works for an unclaimed organization that was created with that
-     * token, and returns 403 for any other.
-     *
      * @param {FernVenusApi.GetTokensForOrganizationApiKeysOrganizationOrganizationIdGetRequest} request
      * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -52,11 +44,6 @@ export declare class ApiKeysClient {
     getTokensForOrganization(request: FernVenusApi.GetTokensForOrganizationApiKeysOrganizationOrganizationIdGetRequest, requestOptions?: ApiKeysClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.TokenMetadata[], FernVenusApi.apiKeys.getTokensForOrganization.Error>>;
     private __getTokensForOrganization;
     /**
-     * Revokes an API key by its ID. Called with the provisioner token,
-     * organizationId is required and must be an unclaimed organization that
-     * was created with that token (403 otherwise), and the key must be that
-     * organization's (401 otherwise). Other callers don't need organizationId.
-     *
      * @param {FernVenusApi.RevokeTokenByIdApiKeysRevokeTokenIdPostRequest} request
      * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
      *

package/dist/esm/api/resources/apiKeys/client/Client.mjs

@@ -29,10 +29,6 @@ export class ApiKeysClient {
         this._options = normalizeClientOptionsWithAuth(options);
     }
     /**
-     * Creates an API key for an organization the caller is a member of. Called
-     * with the provisioner token, it only works for an unclaimed organization
-     * that was created with that token, and returns 403 for any other.
-     *
      * @param {FernVenusApi.CreateApiKeyRequest} request
      * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -193,10 +189,6 @@ export class ApiKeysClient {
         });
     }
     /**
-     * Lists an organization's API keys. Called with the provisioner token, it
-     * only works for an unclaimed organization that was created with that
-     * token, and returns 403 for any other.
-     *
      * @param {FernVenusApi.GetTokensForOrganizationApiKeysOrganizationOrganizationIdGetRequest} request
      * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -272,11 +264,6 @@ export class ApiKeysClient {
         });
     }
     /**
-     * Revokes an API key by its ID. Called with the provisioner token,
-     * organizationId is required and must be an unclaimed organization that
-     * was created with that token (403 otherwise), and the key must be that
-     * organization's (401 otherwise). Other callers don't need organizationId.
-     *
      * @param {FernVenusApi.RevokeTokenByIdApiKeysRevokeTokenIdPostRequest} request
      * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -291,17 +278,14 @@ export class ApiKeysClient {
     __revokeTokenById(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h;
-            const { tokenId, organizationId } = request;
-            const _queryParams = {
-                organizationId,
-            };
+            const { tokenId } = request;
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
                 url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment)), `api-keys/revoke/${core.url.encodePathParam(tokenId)}`),
                 method: "POST",
                 headers: _headers,
-                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
                 timeoutMs: ((_e = (_c = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _c !== void 0 ? _c : (_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) !== null && _e !== void 0 ? _e : 60) * 1000,
                 maxRetries: (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,

package/dist/esm/api/resources/apiKeys/client/requests/RevokeTokenByIdApiKeysRevokeTokenIdPostRequest.d.mts

@@ -6,5 +6,4 @@
  */
 export interface RevokeTokenByIdApiKeysRevokeTokenIdPostRequest {
     tokenId: string;
-    organizationId?: string | null;
 }

package/dist/esm/api/resources/index.d.mts

@@ -2,11 +2,6 @@ export * from "./apiKeys/client/requests/index.mjs";
 export * as apiKeys from "./apiKeys/index.mjs";
 export * from "./auth/client/requests/index.mjs";
 export * as auth from "./auth/index.mjs";
-export * from "./guestSession/client/requests/index.mjs";
-export * as guestSession from "./guestSession/index.mjs";
-export * from "./internalGuestSession/client/requests/index.mjs";
-export * as internalGuestSession from "./internalGuestSession/index.mjs";
-export * from "./internalGuestSession/types/index.mjs";
 export * from "./organization/client/requests/index.mjs";
 export * as organization from "./organization/index.mjs";
 export * from "./registry/client/requests/index.mjs";

package/dist/esm/api/resources/index.mjs

@@ -2,11 +2,6 @@ export * from "./apiKeys/client/requests/index.mjs";
 export * as apiKeys from "./apiKeys/index.mjs";
 export * from "./auth/client/requests/index.mjs";
 export * as auth from "./auth/index.mjs";
-export * from "./guestSession/client/requests/index.mjs";
-export * as guestSession from "./guestSession/index.mjs";
-export * from "./internalGuestSession/client/requests/index.mjs";
-export * as internalGuestSession from "./internalGuestSession/index.mjs";
-export * from "./internalGuestSession/types/index.mjs";
 export * from "./organization/client/requests/index.mjs";
 export * as organization from "./organization/index.mjs";
 export * from "./registry/client/requests/index.mjs";

package/dist/esm/api/resources/organization/client/Client.d.mts

@@ -11,13 +11,6 @@ export declare class OrganizationClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<OrganizationClient.Options>;
     constructor(options: OrganizationClient.Options);
     /**
-     * Creates an organization with the caller as its admin. Called with the
-     * provisioner token, it instead creates an unclaimed organization, with no
-     * Auth0 organization or members, linked to the required postmanTeamId.
-     * Creating it again for the same team returns the same organization.
-     * A normal signup gets 409 if its postmanTeamId is linked to an unclaimed
-     * organization, since that team claims its organization through Postman.
-     *
      * @param {FernVenusApi.CreateOrganizationRequest} request
      * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -52,9 +45,6 @@ export declare class OrganizationClient {
     private __get;
     /**
      * Deletes an organization. Only users with admin role can delete organizations.
-     * Called with the provisioner token, it only works for an unclaimed
-     * organization that was created with that token, and returns 403 for any
-     * other. It also revokes that organization's API keys.
      *
      * @param {FernVenusApi.DeleteOrganizationsOrgIdDeleteRequest} request
      * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -79,22 +69,6 @@ export declare class OrganizationClient {
      */
     getOrgIdsByPostmanTeamId(request: FernVenusApi.GetOrgIdsByPostmanTeamIdOrganizationsPostmanTeamPostmanTeamIdGetRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.Organization, FernVenusApi.organization.getOrgIdsByPostmanTeamId.Error>>;
     private __getOrgIdsByPostmanTeamId;
-    /**
-     * The claimable organization linked to a Postman team, with its claim
-     * status and the address of its docs site. Only Postman's integration
-     * service token can call it. 404 when the team has no claimable
-     * organization, or its docs address isn't set.
-     *
-     * @param {FernVenusApi.GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest} request
-     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.organization.getPostmanTeamDocs({
-     *         postmanTeamId: "postman_team_id"
-     *     })
-     */
-    getPostmanTeamDocs(request: FernVenusApi.GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.PostmanTeamDocsResponse, FernVenusApi.organization.getPostmanTeamDocs.Error>>;
-    private __getPostmanTeamDocs;
     /**
      * Get the Postman team ID associated with an organization ID.
      *
@@ -108,104 +82,6 @@ export declare class OrganizationClient {
      */
     getPostmanTeamIdByOrgId(request: FernVenusApi.GetPostmanTeamIdByOrgIdOrganizationsOrgIdPostmanTeamIdGetRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<string, FernVenusApi.organization.getPostmanTeamIdByOrgId.Error>>;
     private __getPostmanTeamIdByOrgId;
-    /**
-     * Whether a claimable organization has been claimed. Public, so a docs
-     * site can show a claim banner to signed-out visitors. Organizations
-     * that were never claimable return 404.
-     *
-     * @param {FernVenusApi.GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest} request
-     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.organization.getClaimStatus({
-     *         orgId: "org_id"
-     *     })
-     */
-    getClaimStatus(request: FernVenusApi.GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.ClaimStatusResponse, FernVenusApi.organization.getClaimStatus.Error>>;
-    private __getClaimStatus;
-    /**
-     * Issues a claim link for an unclaimed organization, bound to one Postman
-     * user and valid for 15 minutes. Only the provisioner token and Postman's
-     * integration service token can call it.
-     *
-     * @param {FernVenusApi.CreateClaimTokenRequest} request
-     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.organization.createClaimToken({
-     *         orgId: "org_id",
-     *         postmanUserId: "postmanUserId"
-     *     })
-     */
-    createClaimToken(request: FernVenusApi.CreateClaimTokenRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.ClaimTokenResponse, FernVenusApi.organization.createClaimToken.Error>>;
-    private __createClaimToken;
-    /**
-     * Sets the address of an unclaimed organization's docs site, which the
-     * team docs lookup returns. Only the provisioner token can call it, and
-     * only until the organization is claimed.
-     *
-     * @param {FernVenusApi.SetDocsUrlRequest} request
-     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.organization.setDocsUrl({
-     *         orgId: "org_id",
-     *         docsUrl: "docsUrl"
-     *     })
-     */
-    setDocsUrl(request: FernVenusApi.SetDocsUrlRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, FernVenusApi.organization.setDocsUrl.Error>>;
-    private __setDocsUrl;
-    /**
-     * Redeems a claim link. The caller, signed in as the Postman user the link
-     * is for, becomes the admin of the organization. The first claim wins, and
-     * a retry by the same user finishes a claim that failed partway.
-     *
-     * @param {FernVenusApi.ClaimOrganizationRequest} request
-     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.organization.claim({
-     *         claimToken: "claimToken"
-     *     })
-     */
-    claim(request: FernVenusApi.ClaimOrganizationRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.ClaimOrganizationResponse, FernVenusApi.organization.claim.Error>>;
-    private __claim;
-    /**
-     * What a claim link is for, without redeeming it, so the dashboard can show
-     * the organization and the link's state before the user signs in. Public:
-     * the link is the secret. The token is in the body to keep it out of
-     * request logs.
-     *
-     * @param {FernVenusApi.ClaimOrganizationRequest} request
-     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.organization.previewClaim({
-     *         claimToken: "claimToken"
-     *     })
-     */
-    previewClaim(request: FernVenusApi.ClaimOrganizationRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.ClaimPreviewResponse, FernVenusApi.organization.previewClaim.Error>>;
-    private __previewClaim;
-    /**
-     * Redeems a claim link without a Fern sign-in, for the Claim button on
-     * the organization's docs site. The organization is claimed for the
-     * Postman user the link was issued for, who becomes its admin if they
-     * already have a Fern account; otherwise the organization starts with
-     * no members, and the dashboard adds the team's Postman users when they
-     * sign in with Postman. Public: the link is the secret, and only the
-     * provisioner and Postman's integration service can get one. The first
-     * claim wins, and a retry finishes a claim that failed partway.
-     *
-     * @param {FernVenusApi.ClaimOrganizationRequest} request
-     * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.organization.claimFromDocsSite({
-     *         claimToken: "claimToken"
-     *     })
-     */
-    claimFromDocsSite(request: FernVenusApi.ClaimOrganizationRequest, requestOptions?: OrganizationClient.RequestOptions): core.HttpResponsePromise<core.APIResponse<FernVenusApi.ClaimOrganizationResponse, FernVenusApi.organization.claimFromDocsSite.Error>>;
-    private __claimFromDocsSite;
     /**
      * @param {FernVenusApi.IsMemberOrganizationsBelongsToOrganizationOrganizationIdPostRequest} request
      * @param {OrganizationClient.RequestOptions} requestOptions - Request-specific configuration.