@fern-api/venus-api-sdk 12.3.0 → 13.0.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/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/Client.d.ts +8 -16
- package/dist/cjs/Client.js +20 -33
- package/dist/cjs/api/client/index.d.ts +1 -1
- package/dist/cjs/api/client/index.js +2 -2
- package/dist/cjs/api/client/{pingPingGet.d.ts → metricsMetricsGet.d.ts} +4 -4
- package/dist/cjs/api/client/{pingPingGet.js → metricsMetricsGet.js} +1 -1
- package/dist/cjs/api/resources/apiKeys/client/Client.d.ts +0 -13
- package/dist/cjs/api/resources/apiKeys/client/Client.js +2 -18
- package/dist/cjs/api/resources/apiKeys/client/requests/RevokeTokenByIdApiKeysRevokeTokenIdPostRequest.d.ts +0 -1
- package/dist/cjs/api/resources/index.d.ts +0 -5
- package/dist/cjs/api/resources/index.js +1 -6
- package/dist/cjs/api/resources/organization/client/Client.d.ts +0 -124
- package/dist/cjs/api/resources/organization/client/Client.js +0 -593
- package/dist/cjs/api/resources/organization/client/index.d.ts +0 -7
- package/dist/cjs/api/resources/organization/client/index.js +1 -8
- package/dist/cjs/api/resources/organization/client/requests/index.d.ts +0 -4
- package/dist/cjs/api/types/Organization.d.ts +1 -1
- package/dist/cjs/api/types/TokenMetadata.d.ts +0 -1
- package/dist/cjs/api/types/index.d.ts +0 -36
- package/dist/cjs/api/types/index.js +0 -36
- package/dist/cjs/serialization/resources/index.d.ts +0 -5
- package/dist/cjs/serialization/resources/index.js +1 -6
- package/dist/cjs/serialization/resources/organization/client/requests/index.d.ts +0 -2
- package/dist/cjs/serialization/resources/organization/client/requests/index.js +1 -5
- package/dist/cjs/serialization/types/Organization.d.ts +1 -1
- package/dist/cjs/serialization/types/Organization.js +1 -1
- package/dist/cjs/serialization/types/TokenMetadata.d.ts +0 -1
- package/dist/cjs/serialization/types/TokenMetadata.js +0 -1
- package/dist/cjs/serialization/types/index.d.ts +0 -36
- package/dist/cjs/serialization/types/index.js +0 -36
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/Client.d.mts +8 -16
- package/dist/esm/Client.mjs +14 -27
- package/dist/esm/api/client/index.d.mts +1 -1
- package/dist/esm/api/client/index.mjs +1 -1
- package/dist/esm/api/client/{pingPingGet.d.mts → metricsMetricsGet.d.mts} +4 -4
- package/dist/esm/api/client/{pingPingGet.mjs → metricsMetricsGet.mjs} +1 -1
- package/dist/esm/api/resources/apiKeys/client/Client.d.mts +0 -13
- package/dist/esm/api/resources/apiKeys/client/Client.mjs +2 -18
- package/dist/esm/api/resources/apiKeys/client/requests/RevokeTokenByIdApiKeysRevokeTokenIdPostRequest.d.mts +0 -1
- package/dist/esm/api/resources/index.d.mts +0 -5
- package/dist/esm/api/resources/index.mjs +0 -5
- package/dist/esm/api/resources/organization/client/Client.d.mts +0 -124
- package/dist/esm/api/resources/organization/client/Client.mjs +0 -593
- package/dist/esm/api/resources/organization/client/index.d.mts +0 -7
- package/dist/esm/api/resources/organization/client/index.mjs +0 -7
- package/dist/esm/api/resources/organization/client/requests/index.d.mts +0 -4
- package/dist/esm/api/types/Organization.d.mts +1 -1
- package/dist/esm/api/types/TokenMetadata.d.mts +0 -1
- package/dist/esm/api/types/index.d.mts +0 -36
- package/dist/esm/api/types/index.mjs +0 -36
- package/dist/esm/serialization/resources/index.d.mts +0 -5
- package/dist/esm/serialization/resources/index.mjs +0 -5
- package/dist/esm/serialization/resources/organization/client/requests/index.d.mts +0 -2
- package/dist/esm/serialization/resources/organization/client/requests/index.mjs +0 -2
- package/dist/esm/serialization/types/Organization.d.mts +1 -1
- package/dist/esm/serialization/types/Organization.mjs +1 -1
- package/dist/esm/serialization/types/TokenMetadata.d.mts +0 -1
- package/dist/esm/serialization/types/TokenMetadata.mjs +0 -1
- package/dist/esm/serialization/types/index.d.mts +0 -36
- package/dist/esm/serialization/types/index.mjs +0 -36
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +87 -1081
- package/dist/cjs/api/resources/guestSession/client/Client.d.ts +0 -84
- package/dist/cjs/api/resources/guestSession/client/Client.js +0 -469
- package/dist/cjs/api/resources/guestSession/client/claim.d.ts +0 -25
- package/dist/cjs/api/resources/guestSession/client/claim.js +0 -66
- package/dist/cjs/api/resources/guestSession/client/create.d.ts +0 -37
- package/dist/cjs/api/resources/guestSession/client/create.js +0 -88
- package/dist/cjs/api/resources/guestSession/client/delete.d.ts +0 -25
- package/dist/cjs/api/resources/guestSession/client/delete.js +0 -66
- package/dist/cjs/api/resources/guestSession/client/get.d.ts +0 -43
- package/dist/cjs/api/resources/guestSession/client/get.js +0 -99
- package/dist/cjs/api/resources/guestSession/client/index.d.ts +0 -5
- package/dist/cjs/api/resources/guestSession/client/index.js +0 -44
- package/dist/cjs/api/resources/guestSession/client/requests/ClaimGuestSessionRequest.d.ts +0 -11
- package/dist/cjs/api/resources/guestSession/client/requests/ClaimGuestSessionRequest.js +0 -3
- package/dist/cjs/api/resources/guestSession/client/requests/CreateGuestSessionRequest.d.ts +0 -11
- package/dist/cjs/api/resources/guestSession/client/requests/CreateGuestSessionRequest.js +0 -3
- package/dist/cjs/api/resources/guestSession/client/requests/DeleteGuestSessionsSessionIdDeleteRequest.d.ts +0 -9
- package/dist/cjs/api/resources/guestSession/client/requests/DeleteGuestSessionsSessionIdDeleteRequest.js +0 -3
- package/dist/cjs/api/resources/guestSession/client/requests/GetGuestSessionsSessionIdGetRequest.d.ts +0 -11
- package/dist/cjs/api/resources/guestSession/client/requests/GetGuestSessionsSessionIdGetRequest.js +0 -3
- package/dist/cjs/api/resources/guestSession/client/requests/index.d.ts +0 -4
- package/dist/cjs/api/resources/guestSession/client/requests/index.js +0 -2
- package/dist/cjs/api/resources/guestSession/index.d.ts +0 -1
- package/dist/cjs/api/resources/guestSession/index.js +0 -17
- package/dist/cjs/api/resources/internalGuestSession/client/Client.d.ts +0 -55
- package/dist/cjs/api/resources/internalGuestSession/client/Client.js +0 -314
- package/dist/cjs/api/resources/internalGuestSession/client/index.d.ts +0 -4
- package/dist/cjs/api/resources/internalGuestSession/client/index.js +0 -43
- package/dist/cjs/api/resources/internalGuestSession/client/readByOrg.d.ts +0 -25
- package/dist/cjs/api/resources/internalGuestSession/client/readByOrg.js +0 -66
- package/dist/cjs/api/resources/internalGuestSession/client/requests/ReadByOrgInternalGuestSessionsByOrgOrgIdGetRequest.d.ts +0 -9
- package/dist/cjs/api/resources/internalGuestSession/client/requests/ReadByOrgInternalGuestSessionsByOrgOrgIdGetRequest.js +0 -3
- package/dist/cjs/api/resources/internalGuestSession/client/requests/ReserveRequest.d.ts +0 -14
- package/dist/cjs/api/resources/internalGuestSession/client/requests/ReserveRequest.js +0 -3
- package/dist/cjs/api/resources/internalGuestSession/client/requests/SettleRequest.d.ts +0 -14
- package/dist/cjs/api/resources/internalGuestSession/client/requests/SettleRequest.js +0 -3
- package/dist/cjs/api/resources/internalGuestSession/client/requests/index.d.ts +0 -3
- package/dist/cjs/api/resources/internalGuestSession/client/requests/index.js +0 -2
- package/dist/cjs/api/resources/internalGuestSession/client/reserve.d.ts +0 -25
- package/dist/cjs/api/resources/internalGuestSession/client/reserve.js +0 -66
- package/dist/cjs/api/resources/internalGuestSession/client/settle.d.ts +0 -25
- package/dist/cjs/api/resources/internalGuestSession/client/settle.js +0 -66
- package/dist/cjs/api/resources/internalGuestSession/index.d.ts +0 -2
- package/dist/cjs/api/resources/internalGuestSession/index.js +0 -18
- package/dist/cjs/api/resources/internalGuestSession/types/ReserveRequestKind.d.ts +0 -5
- package/dist/cjs/api/resources/internalGuestSession/types/ReserveRequestKind.js +0 -8
- package/dist/cjs/api/resources/internalGuestSession/types/SettleRequestOutcome.d.ts +0 -5
- package/dist/cjs/api/resources/internalGuestSession/types/SettleRequestOutcome.js +0 -8
- package/dist/cjs/api/resources/internalGuestSession/types/index.d.ts +0 -2
- package/dist/cjs/api/resources/internalGuestSession/types/index.js +0 -18
- package/dist/cjs/api/resources/organization/client/claim.d.ts +0 -25
- package/dist/cjs/api/resources/organization/client/claim.js +0 -66
- package/dist/cjs/api/resources/organization/client/claimFromDocsSite.d.ts +0 -25
- package/dist/cjs/api/resources/organization/client/claimFromDocsSite.js +0 -66
- package/dist/cjs/api/resources/organization/client/createClaimToken.d.ts +0 -25
- package/dist/cjs/api/resources/organization/client/createClaimToken.js +0 -66
- package/dist/cjs/api/resources/organization/client/getClaimStatus.d.ts +0 -25
- package/dist/cjs/api/resources/organization/client/getClaimStatus.js +0 -66
- package/dist/cjs/api/resources/organization/client/getPostmanTeamDocs.d.ts +0 -25
- package/dist/cjs/api/resources/organization/client/getPostmanTeamDocs.js +0 -66
- package/dist/cjs/api/resources/organization/client/previewClaim.d.ts +0 -25
- package/dist/cjs/api/resources/organization/client/previewClaim.js +0 -66
- package/dist/cjs/api/resources/organization/client/requests/CreateClaimTokenRequest.d.ts +0 -11
- package/dist/cjs/api/resources/organization/client/requests/CreateClaimTokenRequest.js +0 -3
- package/dist/cjs/api/resources/organization/client/requests/GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest.d.ts +0 -9
- package/dist/cjs/api/resources/organization/client/requests/GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest.js +0 -3
- package/dist/cjs/api/resources/organization/client/requests/GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest.d.ts +0 -9
- package/dist/cjs/api/resources/organization/client/requests/GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest.js +0 -3
- package/dist/cjs/api/resources/organization/client/requests/SetDocsUrlRequest.d.ts +0 -11
- package/dist/cjs/api/resources/organization/client/requests/SetDocsUrlRequest.js +0 -3
- package/dist/cjs/api/resources/organization/client/setDocsUrl.d.ts +0 -25
- package/dist/cjs/api/resources/organization/client/setDocsUrl.js +0 -66
- package/dist/cjs/api/types/ClaimGuestSessionResponse.d.ts +0 -10
- package/dist/cjs/api/types/ClaimGuestSessionResponse.js +0 -3
- package/dist/cjs/api/types/ClaimGuestSessionResponseStatus.d.ts +0 -9
- package/dist/cjs/api/types/ClaimGuestSessionResponseStatus.js +0 -12
- package/dist/cjs/api/types/ClaimOrganizationRequest.d.ts +0 -3
- package/dist/cjs/api/types/ClaimOrganizationRequest.js +0 -3
- package/dist/cjs/api/types/ClaimOrganizationResponse.d.ts +0 -5
- package/dist/cjs/api/types/ClaimOrganizationResponse.js +0 -3
- package/dist/cjs/api/types/ClaimPreviewResponse.d.ts +0 -8
- package/dist/cjs/api/types/ClaimPreviewResponse.js +0 -3
- package/dist/cjs/api/types/ClaimStatus.d.ts +0 -5
- package/dist/cjs/api/types/ClaimStatus.js +0 -8
- package/dist/cjs/api/types/ClaimStatusResponse.d.ts +0 -4
- package/dist/cjs/api/types/ClaimStatusResponse.js +0 -3
- package/dist/cjs/api/types/ClaimTokenResponse.d.ts +0 -5
- package/dist/cjs/api/types/ClaimTokenResponse.js +0 -3
- package/dist/cjs/api/types/CreateGuestSessionResponse.d.ts +0 -11
- package/dist/cjs/api/types/CreateGuestSessionResponse.js +0 -3
- package/dist/cjs/api/types/DeleteGuestSessionResponse.d.ts +0 -7
- package/dist/cjs/api/types/DeleteGuestSessionResponse.js +0 -3
- package/dist/cjs/api/types/DeleteGuestSessionResponseStatus.d.ts +0 -9
- package/dist/cjs/api/types/DeleteGuestSessionResponseStatus.js +0 -12
- package/dist/cjs/api/types/GetGuestSessionResponse.d.ts +0 -13
- package/dist/cjs/api/types/GetGuestSessionResponse.js +0 -3
- package/dist/cjs/api/types/GetGuestSessionResponseStatus.d.ts +0 -9
- package/dist/cjs/api/types/GetGuestSessionResponseStatus.js +0 -12
- package/dist/cjs/api/types/GoneErrorBody.d.ts +0 -5
- package/dist/cjs/api/types/GoneErrorBody.js +0 -3
- package/dist/cjs/api/types/GoneErrorBodyContent.d.ts +0 -8
- package/dist/cjs/api/types/GoneErrorBodyContent.js +0 -3
- package/dist/cjs/api/types/GoneErrorBodyContentCode.d.ts +0 -5
- package/dist/cjs/api/types/GoneErrorBodyContentCode.js +0 -8
- package/dist/cjs/api/types/GuestSessionLimits.d.ts +0 -6
- package/dist/cjs/api/types/GuestSessionLimits.js +0 -3
- package/dist/cjs/api/types/GuestSessionUsage.d.ts +0 -4
- package/dist/cjs/api/types/GuestSessionUsage.js +0 -3
- package/dist/cjs/api/types/InternalGuestSessionResponse.d.ts +0 -22
- package/dist/cjs/api/types/InternalGuestSessionResponse.js +0 -3
- package/dist/cjs/api/types/InternalGuestSessionResponseStatus.d.ts +0 -9
- package/dist/cjs/api/types/InternalGuestSessionResponseStatus.js +0 -12
- package/dist/cjs/api/types/Limit.d.ts +0 -6
- package/dist/cjs/api/types/Limit.js +0 -3
- package/dist/cjs/api/types/NotFoundErrorBody.d.ts +0 -5
- package/dist/cjs/api/types/NotFoundErrorBody.js +0 -3
- package/dist/cjs/api/types/NotFoundErrorBodyContent.d.ts +0 -8
- package/dist/cjs/api/types/NotFoundErrorBodyContent.js +0 -3
- package/dist/cjs/api/types/NotFoundErrorBodyContentCode.d.ts +0 -4
- package/dist/cjs/api/types/NotFoundErrorBodyContentCode.js +0 -7
- package/dist/cjs/api/types/PostmanTeamDocsResponse.d.ts +0 -6
- package/dist/cjs/api/types/PostmanTeamDocsResponse.js +0 -3
- package/dist/cjs/api/types/ReserveResponse.d.ts +0 -12
- package/dist/cjs/api/types/ReserveResponse.js +0 -3
- package/dist/cjs/api/types/ReserveResponseKind.d.ts +0 -5
- package/dist/cjs/api/types/ReserveResponseKind.js +0 -8
- package/dist/cjs/api/types/ReserveResponseState.d.ts +0 -6
- package/dist/cjs/api/types/ReserveResponseState.js +0 -9
- package/dist/cjs/api/types/ServiceUnavailableErrorBody.d.ts +0 -5
- package/dist/cjs/api/types/ServiceUnavailableErrorBody.js +0 -3
- package/dist/cjs/api/types/ServiceUnavailableErrorBodyContent.d.ts +0 -8
- package/dist/cjs/api/types/ServiceUnavailableErrorBodyContent.js +0 -3
- package/dist/cjs/api/types/ServiceUnavailableErrorBodyContentCode.d.ts +0 -6
- package/dist/cjs/api/types/ServiceUnavailableErrorBodyContentCode.js +0 -9
- package/dist/cjs/api/types/SettleResponse.d.ts +0 -5
- package/dist/cjs/api/types/SettleResponse.js +0 -3
- package/dist/cjs/api/types/SettleResponseReason.d.ts +0 -5
- package/dist/cjs/api/types/SettleResponseReason.js +0 -8
- package/dist/cjs/api/types/TooManyRequestsErrorBody.d.ts +0 -5
- package/dist/cjs/api/types/TooManyRequestsErrorBody.js +0 -3
- package/dist/cjs/api/types/TooManyRequestsErrorBodyContent.d.ts +0 -8
- package/dist/cjs/api/types/TooManyRequestsErrorBodyContent.js +0 -3
- package/dist/cjs/api/types/TooManyRequestsErrorBodyContentCode.d.ts +0 -4
- package/dist/cjs/api/types/TooManyRequestsErrorBodyContentCode.js +0 -7
- package/dist/cjs/serialization/resources/guestSession/client/index.d.ts +0 -1
- package/dist/cjs/serialization/resources/guestSession/client/index.js +0 -17
- package/dist/cjs/serialization/resources/guestSession/client/requests/ClaimGuestSessionRequest.d.ts +0 -10
- package/dist/cjs/serialization/resources/guestSession/client/requests/ClaimGuestSessionRequest.js +0 -42
- package/dist/cjs/serialization/resources/guestSession/client/requests/CreateGuestSessionRequest.d.ts +0 -11
- package/dist/cjs/serialization/resources/guestSession/client/requests/CreateGuestSessionRequest.js +0 -43
- package/dist/cjs/serialization/resources/guestSession/client/requests/index.d.ts +0 -2
- package/dist/cjs/serialization/resources/guestSession/client/requests/index.js +0 -7
- package/dist/cjs/serialization/resources/guestSession/index.d.ts +0 -1
- package/dist/cjs/serialization/resources/guestSession/index.js +0 -17
- package/dist/cjs/serialization/resources/internalGuestSession/client/index.d.ts +0 -1
- package/dist/cjs/serialization/resources/internalGuestSession/client/index.js +0 -17
- package/dist/cjs/serialization/resources/internalGuestSession/client/requests/ReserveRequest.d.ts +0 -12
- package/dist/cjs/serialization/resources/internalGuestSession/client/requests/ReserveRequest.js +0 -44
- package/dist/cjs/serialization/resources/internalGuestSession/client/requests/SettleRequest.d.ts +0 -11
- package/dist/cjs/serialization/resources/internalGuestSession/client/requests/SettleRequest.js +0 -43
- package/dist/cjs/serialization/resources/internalGuestSession/client/requests/index.d.ts +0 -2
- package/dist/cjs/serialization/resources/internalGuestSession/client/requests/index.js +0 -7
- package/dist/cjs/serialization/resources/internalGuestSession/index.d.ts +0 -2
- package/dist/cjs/serialization/resources/internalGuestSession/index.js +0 -18
- package/dist/cjs/serialization/resources/internalGuestSession/types/ReserveRequestKind.d.ts +0 -7
- package/dist/cjs/serialization/resources/internalGuestSession/types/ReserveRequestKind.js +0 -39
- package/dist/cjs/serialization/resources/internalGuestSession/types/SettleRequestOutcome.d.ts +0 -7
- package/dist/cjs/serialization/resources/internalGuestSession/types/SettleRequestOutcome.js +0 -39
- package/dist/cjs/serialization/resources/internalGuestSession/types/index.d.ts +0 -2
- package/dist/cjs/serialization/resources/internalGuestSession/types/index.js +0 -18
- package/dist/cjs/serialization/resources/organization/client/requests/CreateClaimTokenRequest.d.ts +0 -9
- package/dist/cjs/serialization/resources/organization/client/requests/CreateClaimTokenRequest.js +0 -41
- package/dist/cjs/serialization/resources/organization/client/requests/SetDocsUrlRequest.d.ts +0 -9
- package/dist/cjs/serialization/resources/organization/client/requests/SetDocsUrlRequest.js +0 -41
- package/dist/cjs/serialization/types/ClaimGuestSessionResponse.d.ts +0 -15
- package/dist/cjs/serialization/types/ClaimGuestSessionResponse.js +0 -48
- package/dist/cjs/serialization/types/ClaimGuestSessionResponseStatus.d.ts +0 -7
- package/dist/cjs/serialization/types/ClaimGuestSessionResponseStatus.js +0 -39
- package/dist/cjs/serialization/types/ClaimOrganizationRequest.d.ts +0 -9
- package/dist/cjs/serialization/types/ClaimOrganizationRequest.js +0 -41
- package/dist/cjs/serialization/types/ClaimOrganizationResponse.d.ts +0 -11
- package/dist/cjs/serialization/types/ClaimOrganizationResponse.js +0 -43
- package/dist/cjs/serialization/types/ClaimPreviewResponse.d.ts +0 -14
- package/dist/cjs/serialization/types/ClaimPreviewResponse.js +0 -46
- package/dist/cjs/serialization/types/ClaimStatus.d.ts +0 -7
- package/dist/cjs/serialization/types/ClaimStatus.js +0 -39
- package/dist/cjs/serialization/types/ClaimStatusResponse.d.ts +0 -10
- package/dist/cjs/serialization/types/ClaimStatusResponse.js +0 -42
- package/dist/cjs/serialization/types/ClaimTokenResponse.d.ts +0 -11
- package/dist/cjs/serialization/types/ClaimTokenResponse.js +0 -43
- package/dist/cjs/serialization/types/CreateGuestSessionResponse.d.ts +0 -17
- package/dist/cjs/serialization/types/CreateGuestSessionResponse.js +0 -49
- package/dist/cjs/serialization/types/DeleteGuestSessionResponse.d.ts +0 -12
- package/dist/cjs/serialization/types/DeleteGuestSessionResponse.js +0 -45
- package/dist/cjs/serialization/types/DeleteGuestSessionResponseStatus.d.ts +0 -7
- package/dist/cjs/serialization/types/DeleteGuestSessionResponseStatus.js +0 -39
- package/dist/cjs/serialization/types/GetGuestSessionResponse.d.ts +0 -20
- package/dist/cjs/serialization/types/GetGuestSessionResponse.js +0 -52
- package/dist/cjs/serialization/types/GetGuestSessionResponseStatus.d.ts +0 -7
- package/dist/cjs/serialization/types/GetGuestSessionResponseStatus.js +0 -39
- package/dist/cjs/serialization/types/GoneErrorBody.d.ts +0 -11
- package/dist/cjs/serialization/types/GoneErrorBody.js +0 -43
- package/dist/cjs/serialization/types/GoneErrorBodyContent.d.ts +0 -14
- package/dist/cjs/serialization/types/GoneErrorBodyContent.js +0 -46
- package/dist/cjs/serialization/types/GoneErrorBodyContentCode.d.ts +0 -7
- package/dist/cjs/serialization/types/GoneErrorBodyContentCode.js +0 -39
- package/dist/cjs/serialization/types/GuestSessionLimits.d.ts +0 -12
- package/dist/cjs/serialization/types/GuestSessionLimits.js +0 -44
- package/dist/cjs/serialization/types/GuestSessionUsage.d.ts +0 -10
- package/dist/cjs/serialization/types/GuestSessionUsage.js +0 -42
- package/dist/cjs/serialization/types/InternalGuestSessionResponse.d.ts +0 -16
- package/dist/cjs/serialization/types/InternalGuestSessionResponse.js +0 -48
- package/dist/cjs/serialization/types/InternalGuestSessionResponseStatus.d.ts +0 -7
- package/dist/cjs/serialization/types/InternalGuestSessionResponseStatus.js +0 -39
- package/dist/cjs/serialization/types/Limit.d.ts +0 -12
- package/dist/cjs/serialization/types/Limit.js +0 -44
- package/dist/cjs/serialization/types/NotFoundErrorBody.d.ts +0 -11
- package/dist/cjs/serialization/types/NotFoundErrorBody.js +0 -43
- package/dist/cjs/serialization/types/NotFoundErrorBodyContent.d.ts +0 -14
- package/dist/cjs/serialization/types/NotFoundErrorBodyContent.js +0 -46
- package/dist/cjs/serialization/types/NotFoundErrorBodyContentCode.d.ts +0 -7
- package/dist/cjs/serialization/types/NotFoundErrorBodyContentCode.js +0 -39
- package/dist/cjs/serialization/types/PostmanTeamDocsResponse.d.ts +0 -12
- package/dist/cjs/serialization/types/PostmanTeamDocsResponse.js +0 -44
- package/dist/cjs/serialization/types/ReserveResponse.d.ts +0 -20
- package/dist/cjs/serialization/types/ReserveResponse.js +0 -52
- package/dist/cjs/serialization/types/ReserveResponseKind.d.ts +0 -7
- package/dist/cjs/serialization/types/ReserveResponseKind.js +0 -39
- package/dist/cjs/serialization/types/ReserveResponseState.d.ts +0 -7
- package/dist/cjs/serialization/types/ReserveResponseState.js +0 -39
- package/dist/cjs/serialization/types/ServiceUnavailableErrorBody.d.ts +0 -11
- package/dist/cjs/serialization/types/ServiceUnavailableErrorBody.js +0 -43
- package/dist/cjs/serialization/types/ServiceUnavailableErrorBodyContent.d.ts +0 -14
- package/dist/cjs/serialization/types/ServiceUnavailableErrorBodyContent.js +0 -46
- package/dist/cjs/serialization/types/ServiceUnavailableErrorBodyContentCode.d.ts +0 -7
- package/dist/cjs/serialization/types/ServiceUnavailableErrorBodyContentCode.js +0 -39
- package/dist/cjs/serialization/types/SettleResponse.d.ts +0 -11
- package/dist/cjs/serialization/types/SettleResponse.js +0 -43
- package/dist/cjs/serialization/types/SettleResponseReason.d.ts +0 -7
- package/dist/cjs/serialization/types/SettleResponseReason.js +0 -39
- package/dist/cjs/serialization/types/TooManyRequestsErrorBody.d.ts +0 -11
- package/dist/cjs/serialization/types/TooManyRequestsErrorBody.js +0 -43
- package/dist/cjs/serialization/types/TooManyRequestsErrorBodyContent.d.ts +0 -14
- package/dist/cjs/serialization/types/TooManyRequestsErrorBodyContent.js +0 -46
- package/dist/cjs/serialization/types/TooManyRequestsErrorBodyContentCode.d.ts +0 -7
- package/dist/cjs/serialization/types/TooManyRequestsErrorBodyContentCode.js +0 -39
- package/dist/esm/api/resources/guestSession/client/Client.d.mts +0 -84
- package/dist/esm/api/resources/guestSession/client/Client.mjs +0 -432
- package/dist/esm/api/resources/guestSession/client/claim.d.mts +0 -25
- package/dist/esm/api/resources/guestSession/client/claim.mjs +0 -30
- package/dist/esm/api/resources/guestSession/client/create.d.mts +0 -37
- package/dist/esm/api/resources/guestSession/client/create.mjs +0 -52
- package/dist/esm/api/resources/guestSession/client/delete.d.mts +0 -25
- package/dist/esm/api/resources/guestSession/client/delete.mjs +0 -30
- package/dist/esm/api/resources/guestSession/client/get.d.mts +0 -43
- package/dist/esm/api/resources/guestSession/client/get.mjs +0 -63
- package/dist/esm/api/resources/guestSession/client/index.d.mts +0 -5
- package/dist/esm/api/resources/guestSession/client/index.mjs +0 -5
- package/dist/esm/api/resources/guestSession/client/requests/ClaimGuestSessionRequest.d.mts +0 -11
- package/dist/esm/api/resources/guestSession/client/requests/ClaimGuestSessionRequest.mjs +0 -2
- package/dist/esm/api/resources/guestSession/client/requests/CreateGuestSessionRequest.d.mts +0 -11
- package/dist/esm/api/resources/guestSession/client/requests/CreateGuestSessionRequest.mjs +0 -2
- package/dist/esm/api/resources/guestSession/client/requests/DeleteGuestSessionsSessionIdDeleteRequest.d.mts +0 -9
- package/dist/esm/api/resources/guestSession/client/requests/DeleteGuestSessionsSessionIdDeleteRequest.mjs +0 -2
- package/dist/esm/api/resources/guestSession/client/requests/GetGuestSessionsSessionIdGetRequest.d.mts +0 -11
- package/dist/esm/api/resources/guestSession/client/requests/GetGuestSessionsSessionIdGetRequest.mjs +0 -2
- package/dist/esm/api/resources/guestSession/client/requests/index.d.mts +0 -4
- package/dist/esm/api/resources/guestSession/client/requests/index.mjs +0 -1
- package/dist/esm/api/resources/guestSession/index.d.mts +0 -1
- package/dist/esm/api/resources/guestSession/index.mjs +0 -1
- package/dist/esm/api/resources/internalGuestSession/client/Client.d.mts +0 -55
- package/dist/esm/api/resources/internalGuestSession/client/Client.mjs +0 -277
- package/dist/esm/api/resources/internalGuestSession/client/index.d.mts +0 -4
- package/dist/esm/api/resources/internalGuestSession/client/index.mjs +0 -4
- package/dist/esm/api/resources/internalGuestSession/client/readByOrg.d.mts +0 -25
- package/dist/esm/api/resources/internalGuestSession/client/readByOrg.mjs +0 -30
- package/dist/esm/api/resources/internalGuestSession/client/requests/ReadByOrgInternalGuestSessionsByOrgOrgIdGetRequest.d.mts +0 -9
- package/dist/esm/api/resources/internalGuestSession/client/requests/ReadByOrgInternalGuestSessionsByOrgOrgIdGetRequest.mjs +0 -2
- package/dist/esm/api/resources/internalGuestSession/client/requests/ReserveRequest.d.mts +0 -14
- package/dist/esm/api/resources/internalGuestSession/client/requests/ReserveRequest.mjs +0 -2
- package/dist/esm/api/resources/internalGuestSession/client/requests/SettleRequest.d.mts +0 -14
- package/dist/esm/api/resources/internalGuestSession/client/requests/SettleRequest.mjs +0 -2
- package/dist/esm/api/resources/internalGuestSession/client/requests/index.d.mts +0 -3
- package/dist/esm/api/resources/internalGuestSession/client/requests/index.mjs +0 -1
- package/dist/esm/api/resources/internalGuestSession/client/reserve.d.mts +0 -25
- package/dist/esm/api/resources/internalGuestSession/client/reserve.mjs +0 -30
- package/dist/esm/api/resources/internalGuestSession/client/settle.d.mts +0 -25
- package/dist/esm/api/resources/internalGuestSession/client/settle.mjs +0 -30
- package/dist/esm/api/resources/internalGuestSession/index.d.mts +0 -2
- package/dist/esm/api/resources/internalGuestSession/index.mjs +0 -2
- package/dist/esm/api/resources/internalGuestSession/types/ReserveRequestKind.d.mts +0 -5
- package/dist/esm/api/resources/internalGuestSession/types/ReserveRequestKind.mjs +0 -5
- package/dist/esm/api/resources/internalGuestSession/types/SettleRequestOutcome.d.mts +0 -5
- package/dist/esm/api/resources/internalGuestSession/types/SettleRequestOutcome.mjs +0 -5
- package/dist/esm/api/resources/internalGuestSession/types/index.d.mts +0 -2
- package/dist/esm/api/resources/internalGuestSession/types/index.mjs +0 -2
- package/dist/esm/api/resources/organization/client/claim.d.mts +0 -25
- package/dist/esm/api/resources/organization/client/claim.mjs +0 -30
- package/dist/esm/api/resources/organization/client/claimFromDocsSite.d.mts +0 -25
- package/dist/esm/api/resources/organization/client/claimFromDocsSite.mjs +0 -30
- package/dist/esm/api/resources/organization/client/createClaimToken.d.mts +0 -25
- package/dist/esm/api/resources/organization/client/createClaimToken.mjs +0 -30
- package/dist/esm/api/resources/organization/client/getClaimStatus.d.mts +0 -25
- package/dist/esm/api/resources/organization/client/getClaimStatus.mjs +0 -30
- package/dist/esm/api/resources/organization/client/getPostmanTeamDocs.d.mts +0 -25
- package/dist/esm/api/resources/organization/client/getPostmanTeamDocs.mjs +0 -30
- package/dist/esm/api/resources/organization/client/previewClaim.d.mts +0 -25
- package/dist/esm/api/resources/organization/client/previewClaim.mjs +0 -30
- package/dist/esm/api/resources/organization/client/requests/CreateClaimTokenRequest.d.mts +0 -11
- package/dist/esm/api/resources/organization/client/requests/CreateClaimTokenRequest.mjs +0 -2
- package/dist/esm/api/resources/organization/client/requests/GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest.d.mts +0 -9
- package/dist/esm/api/resources/organization/client/requests/GetClaimStatusOrganizationsOrgIdClaimStatusGetRequest.mjs +0 -2
- package/dist/esm/api/resources/organization/client/requests/GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest.d.mts +0 -9
- package/dist/esm/api/resources/organization/client/requests/GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest.mjs +0 -2
- package/dist/esm/api/resources/organization/client/requests/SetDocsUrlRequest.d.mts +0 -11
- package/dist/esm/api/resources/organization/client/requests/SetDocsUrlRequest.mjs +0 -2
- package/dist/esm/api/resources/organization/client/setDocsUrl.d.mts +0 -25
- package/dist/esm/api/resources/organization/client/setDocsUrl.mjs +0 -30
- package/dist/esm/api/types/ClaimGuestSessionResponse.d.mts +0 -10
- package/dist/esm/api/types/ClaimGuestSessionResponse.mjs +0 -2
- package/dist/esm/api/types/ClaimGuestSessionResponseStatus.d.mts +0 -9
- package/dist/esm/api/types/ClaimGuestSessionResponseStatus.mjs +0 -9
- package/dist/esm/api/types/ClaimOrganizationRequest.d.mts +0 -3
- package/dist/esm/api/types/ClaimOrganizationRequest.mjs +0 -2
- package/dist/esm/api/types/ClaimOrganizationResponse.d.mts +0 -5
- package/dist/esm/api/types/ClaimOrganizationResponse.mjs +0 -2
- package/dist/esm/api/types/ClaimPreviewResponse.d.mts +0 -8
- package/dist/esm/api/types/ClaimPreviewResponse.mjs +0 -2
- package/dist/esm/api/types/ClaimStatus.d.mts +0 -5
- package/dist/esm/api/types/ClaimStatus.mjs +0 -5
- package/dist/esm/api/types/ClaimStatusResponse.d.mts +0 -4
- package/dist/esm/api/types/ClaimStatusResponse.mjs +0 -2
- package/dist/esm/api/types/ClaimTokenResponse.d.mts +0 -5
- package/dist/esm/api/types/ClaimTokenResponse.mjs +0 -2
- package/dist/esm/api/types/CreateGuestSessionResponse.d.mts +0 -11
- package/dist/esm/api/types/CreateGuestSessionResponse.mjs +0 -2
- package/dist/esm/api/types/DeleteGuestSessionResponse.d.mts +0 -7
- package/dist/esm/api/types/DeleteGuestSessionResponse.mjs +0 -2
- package/dist/esm/api/types/DeleteGuestSessionResponseStatus.d.mts +0 -9
- package/dist/esm/api/types/DeleteGuestSessionResponseStatus.mjs +0 -9
- package/dist/esm/api/types/GetGuestSessionResponse.d.mts +0 -13
- package/dist/esm/api/types/GetGuestSessionResponse.mjs +0 -2
- package/dist/esm/api/types/GetGuestSessionResponseStatus.d.mts +0 -9
- package/dist/esm/api/types/GetGuestSessionResponseStatus.mjs +0 -9
- package/dist/esm/api/types/GoneErrorBody.d.mts +0 -5
- package/dist/esm/api/types/GoneErrorBody.mjs +0 -2
- package/dist/esm/api/types/GoneErrorBodyContent.d.mts +0 -8
- package/dist/esm/api/types/GoneErrorBodyContent.mjs +0 -2
- package/dist/esm/api/types/GoneErrorBodyContentCode.d.mts +0 -5
- package/dist/esm/api/types/GoneErrorBodyContentCode.mjs +0 -5
- package/dist/esm/api/types/GuestSessionLimits.d.mts +0 -6
- package/dist/esm/api/types/GuestSessionLimits.mjs +0 -2
- package/dist/esm/api/types/GuestSessionUsage.d.mts +0 -4
- package/dist/esm/api/types/GuestSessionUsage.mjs +0 -2
- package/dist/esm/api/types/InternalGuestSessionResponse.d.mts +0 -22
- package/dist/esm/api/types/InternalGuestSessionResponse.mjs +0 -2
- package/dist/esm/api/types/InternalGuestSessionResponseStatus.d.mts +0 -9
- package/dist/esm/api/types/InternalGuestSessionResponseStatus.mjs +0 -9
- package/dist/esm/api/types/Limit.d.mts +0 -6
- package/dist/esm/api/types/Limit.mjs +0 -2
- package/dist/esm/api/types/NotFoundErrorBody.d.mts +0 -5
- package/dist/esm/api/types/NotFoundErrorBody.mjs +0 -2
- package/dist/esm/api/types/NotFoundErrorBodyContent.d.mts +0 -8
- package/dist/esm/api/types/NotFoundErrorBodyContent.mjs +0 -2
- package/dist/esm/api/types/NotFoundErrorBodyContentCode.d.mts +0 -4
- package/dist/esm/api/types/NotFoundErrorBodyContentCode.mjs +0 -4
- package/dist/esm/api/types/PostmanTeamDocsResponse.d.mts +0 -6
- package/dist/esm/api/types/PostmanTeamDocsResponse.mjs +0 -2
- package/dist/esm/api/types/ReserveResponse.d.mts +0 -12
- package/dist/esm/api/types/ReserveResponse.mjs +0 -2
- package/dist/esm/api/types/ReserveResponseKind.d.mts +0 -5
- package/dist/esm/api/types/ReserveResponseKind.mjs +0 -5
- package/dist/esm/api/types/ReserveResponseState.d.mts +0 -6
- package/dist/esm/api/types/ReserveResponseState.mjs +0 -6
- package/dist/esm/api/types/ServiceUnavailableErrorBody.d.mts +0 -5
- package/dist/esm/api/types/ServiceUnavailableErrorBody.mjs +0 -2
- package/dist/esm/api/types/ServiceUnavailableErrorBodyContent.d.mts +0 -8
- package/dist/esm/api/types/ServiceUnavailableErrorBodyContent.mjs +0 -2
- package/dist/esm/api/types/ServiceUnavailableErrorBodyContentCode.d.mts +0 -6
- package/dist/esm/api/types/ServiceUnavailableErrorBodyContentCode.mjs +0 -6
- package/dist/esm/api/types/SettleResponse.d.mts +0 -5
- package/dist/esm/api/types/SettleResponse.mjs +0 -2
- package/dist/esm/api/types/SettleResponseReason.d.mts +0 -5
- package/dist/esm/api/types/SettleResponseReason.mjs +0 -5
- package/dist/esm/api/types/TooManyRequestsErrorBody.d.mts +0 -5
- package/dist/esm/api/types/TooManyRequestsErrorBody.mjs +0 -2
- package/dist/esm/api/types/TooManyRequestsErrorBodyContent.d.mts +0 -8
- package/dist/esm/api/types/TooManyRequestsErrorBodyContent.mjs +0 -2
- package/dist/esm/api/types/TooManyRequestsErrorBodyContentCode.d.mts +0 -4
- package/dist/esm/api/types/TooManyRequestsErrorBodyContentCode.mjs +0 -4
- package/dist/esm/serialization/resources/guestSession/client/index.d.mts +0 -1
- package/dist/esm/serialization/resources/guestSession/client/index.mjs +0 -1
- package/dist/esm/serialization/resources/guestSession/client/requests/ClaimGuestSessionRequest.d.mts +0 -10
- package/dist/esm/serialization/resources/guestSession/client/requests/ClaimGuestSessionRequest.mjs +0 -6
- package/dist/esm/serialization/resources/guestSession/client/requests/CreateGuestSessionRequest.d.mts +0 -11
- package/dist/esm/serialization/resources/guestSession/client/requests/CreateGuestSessionRequest.mjs +0 -7
- package/dist/esm/serialization/resources/guestSession/client/requests/index.d.mts +0 -2
- package/dist/esm/serialization/resources/guestSession/client/requests/index.mjs +0 -2
- package/dist/esm/serialization/resources/guestSession/index.d.mts +0 -1
- package/dist/esm/serialization/resources/guestSession/index.mjs +0 -1
- package/dist/esm/serialization/resources/internalGuestSession/client/index.d.mts +0 -1
- package/dist/esm/serialization/resources/internalGuestSession/client/index.mjs +0 -1
- package/dist/esm/serialization/resources/internalGuestSession/client/requests/ReserveRequest.d.mts +0 -12
- package/dist/esm/serialization/resources/internalGuestSession/client/requests/ReserveRequest.mjs +0 -8
- package/dist/esm/serialization/resources/internalGuestSession/client/requests/SettleRequest.d.mts +0 -11
- package/dist/esm/serialization/resources/internalGuestSession/client/requests/SettleRequest.mjs +0 -7
- package/dist/esm/serialization/resources/internalGuestSession/client/requests/index.d.mts +0 -2
- package/dist/esm/serialization/resources/internalGuestSession/client/requests/index.mjs +0 -2
- package/dist/esm/serialization/resources/internalGuestSession/index.d.mts +0 -2
- package/dist/esm/serialization/resources/internalGuestSession/index.mjs +0 -2
- package/dist/esm/serialization/resources/internalGuestSession/types/ReserveRequestKind.d.mts +0 -7
- package/dist/esm/serialization/resources/internalGuestSession/types/ReserveRequestKind.mjs +0 -3
- package/dist/esm/serialization/resources/internalGuestSession/types/SettleRequestOutcome.d.mts +0 -7
- package/dist/esm/serialization/resources/internalGuestSession/types/SettleRequestOutcome.mjs +0 -3
- package/dist/esm/serialization/resources/internalGuestSession/types/index.d.mts +0 -2
- package/dist/esm/serialization/resources/internalGuestSession/types/index.mjs +0 -2
- package/dist/esm/serialization/resources/organization/client/requests/CreateClaimTokenRequest.d.mts +0 -9
- package/dist/esm/serialization/resources/organization/client/requests/CreateClaimTokenRequest.mjs +0 -5
- package/dist/esm/serialization/resources/organization/client/requests/SetDocsUrlRequest.d.mts +0 -9
- package/dist/esm/serialization/resources/organization/client/requests/SetDocsUrlRequest.mjs +0 -5
- package/dist/esm/serialization/types/ClaimGuestSessionResponse.d.mts +0 -15
- package/dist/esm/serialization/types/ClaimGuestSessionResponse.mjs +0 -12
- package/dist/esm/serialization/types/ClaimGuestSessionResponseStatus.d.mts +0 -7
- package/dist/esm/serialization/types/ClaimGuestSessionResponseStatus.mjs +0 -3
- package/dist/esm/serialization/types/ClaimOrganizationRequest.d.mts +0 -9
- package/dist/esm/serialization/types/ClaimOrganizationRequest.mjs +0 -5
- package/dist/esm/serialization/types/ClaimOrganizationResponse.d.mts +0 -11
- package/dist/esm/serialization/types/ClaimOrganizationResponse.mjs +0 -7
- package/dist/esm/serialization/types/ClaimPreviewResponse.d.mts +0 -14
- package/dist/esm/serialization/types/ClaimPreviewResponse.mjs +0 -10
- package/dist/esm/serialization/types/ClaimStatus.d.mts +0 -7
- package/dist/esm/serialization/types/ClaimStatus.mjs +0 -3
- package/dist/esm/serialization/types/ClaimStatusResponse.d.mts +0 -10
- package/dist/esm/serialization/types/ClaimStatusResponse.mjs +0 -6
- package/dist/esm/serialization/types/ClaimTokenResponse.d.mts +0 -11
- package/dist/esm/serialization/types/ClaimTokenResponse.mjs +0 -7
- package/dist/esm/serialization/types/CreateGuestSessionResponse.d.mts +0 -17
- package/dist/esm/serialization/types/CreateGuestSessionResponse.mjs +0 -13
- package/dist/esm/serialization/types/DeleteGuestSessionResponse.d.mts +0 -12
- package/dist/esm/serialization/types/DeleteGuestSessionResponse.mjs +0 -9
- package/dist/esm/serialization/types/DeleteGuestSessionResponseStatus.d.mts +0 -7
- package/dist/esm/serialization/types/DeleteGuestSessionResponseStatus.mjs +0 -3
- package/dist/esm/serialization/types/GetGuestSessionResponse.d.mts +0 -20
- package/dist/esm/serialization/types/GetGuestSessionResponse.mjs +0 -16
- package/dist/esm/serialization/types/GetGuestSessionResponseStatus.d.mts +0 -7
- package/dist/esm/serialization/types/GetGuestSessionResponseStatus.mjs +0 -3
- package/dist/esm/serialization/types/GoneErrorBody.d.mts +0 -11
- package/dist/esm/serialization/types/GoneErrorBody.mjs +0 -7
- package/dist/esm/serialization/types/GoneErrorBodyContent.d.mts +0 -14
- package/dist/esm/serialization/types/GoneErrorBodyContent.mjs +0 -10
- package/dist/esm/serialization/types/GoneErrorBodyContentCode.d.mts +0 -7
- package/dist/esm/serialization/types/GoneErrorBodyContentCode.mjs +0 -3
- package/dist/esm/serialization/types/GuestSessionLimits.d.mts +0 -12
- package/dist/esm/serialization/types/GuestSessionLimits.mjs +0 -8
- package/dist/esm/serialization/types/GuestSessionUsage.d.mts +0 -10
- package/dist/esm/serialization/types/GuestSessionUsage.mjs +0 -6
- package/dist/esm/serialization/types/InternalGuestSessionResponse.d.mts +0 -16
- package/dist/esm/serialization/types/InternalGuestSessionResponse.mjs +0 -12
- package/dist/esm/serialization/types/InternalGuestSessionResponseStatus.d.mts +0 -7
- package/dist/esm/serialization/types/InternalGuestSessionResponseStatus.mjs +0 -3
- package/dist/esm/serialization/types/Limit.d.mts +0 -12
- package/dist/esm/serialization/types/Limit.mjs +0 -8
- package/dist/esm/serialization/types/NotFoundErrorBody.d.mts +0 -11
- package/dist/esm/serialization/types/NotFoundErrorBody.mjs +0 -7
- package/dist/esm/serialization/types/NotFoundErrorBodyContent.d.mts +0 -14
- package/dist/esm/serialization/types/NotFoundErrorBodyContent.mjs +0 -10
- package/dist/esm/serialization/types/NotFoundErrorBodyContentCode.d.mts +0 -7
- package/dist/esm/serialization/types/NotFoundErrorBodyContentCode.mjs +0 -3
- package/dist/esm/serialization/types/PostmanTeamDocsResponse.d.mts +0 -12
- package/dist/esm/serialization/types/PostmanTeamDocsResponse.mjs +0 -8
- package/dist/esm/serialization/types/ReserveResponse.d.mts +0 -20
- package/dist/esm/serialization/types/ReserveResponse.mjs +0 -16
- package/dist/esm/serialization/types/ReserveResponseKind.d.mts +0 -7
- package/dist/esm/serialization/types/ReserveResponseKind.mjs +0 -3
- package/dist/esm/serialization/types/ReserveResponseState.d.mts +0 -7
- package/dist/esm/serialization/types/ReserveResponseState.mjs +0 -3
- package/dist/esm/serialization/types/ServiceUnavailableErrorBody.d.mts +0 -11
- package/dist/esm/serialization/types/ServiceUnavailableErrorBody.mjs +0 -7
- package/dist/esm/serialization/types/ServiceUnavailableErrorBodyContent.d.mts +0 -14
- package/dist/esm/serialization/types/ServiceUnavailableErrorBodyContent.mjs +0 -10
- package/dist/esm/serialization/types/ServiceUnavailableErrorBodyContentCode.d.mts +0 -7
- package/dist/esm/serialization/types/ServiceUnavailableErrorBodyContentCode.mjs +0 -3
- package/dist/esm/serialization/types/SettleResponse.d.mts +0 -11
- package/dist/esm/serialization/types/SettleResponse.mjs +0 -7
- package/dist/esm/serialization/types/SettleResponseReason.d.mts +0 -7
- package/dist/esm/serialization/types/SettleResponseReason.mjs +0 -3
- package/dist/esm/serialization/types/TooManyRequestsErrorBody.d.mts +0 -11
- package/dist/esm/serialization/types/TooManyRequestsErrorBody.mjs +0 -7
- package/dist/esm/serialization/types/TooManyRequestsErrorBodyContent.d.mts +0 -14
- package/dist/esm/serialization/types/TooManyRequestsErrorBodyContent.mjs +0 -10
- package/dist/esm/serialization/types/TooManyRequestsErrorBodyContentCode.d.mts +0 -7
- package/dist/esm/serialization/types/TooManyRequestsErrorBodyContentCode.mjs +0 -3
package/reference.md
CHANGED
|
@@ -1,8 +1,22 @@
|
|
|
1
1
|
# Reference
|
|
2
|
-
<details><summary><code>client.<a href="/src/Client.ts">
|
|
2
|
+
<details><summary><code>client.<a href="/src/Client.ts">metricsMetricsGet</a>() -> core.APIResponse<unknown, FernVenusApi.metricsMetricsGet.Error></code></summary>
|
|
3
|
+
<dl>
|
|
4
|
+
<dd>
|
|
5
|
+
|
|
6
|
+
#### 📝 Description
|
|
7
|
+
|
|
8
|
+
<dl>
|
|
9
|
+
<dd>
|
|
10
|
+
|
|
3
11
|
<dl>
|
|
4
12
|
<dd>
|
|
5
13
|
|
|
14
|
+
Endpoint that serves Prometheus metrics.
|
|
15
|
+
</dd>
|
|
16
|
+
</dl>
|
|
17
|
+
</dd>
|
|
18
|
+
</dl>
|
|
19
|
+
|
|
6
20
|
#### 🔌 Usage
|
|
7
21
|
|
|
8
22
|
<dl>
|
|
@@ -12,7 +26,7 @@
|
|
|
12
26
|
<dd>
|
|
13
27
|
|
|
14
28
|
```typescript
|
|
15
|
-
await client.
|
|
29
|
+
await client.metricsMetricsGet();
|
|
16
30
|
|
|
17
31
|
```
|
|
18
32
|
</dd>
|
|
@@ -40,7 +54,7 @@ await client.healthHealthGet();
|
|
|
40
54
|
</dl>
|
|
41
55
|
</details>
|
|
42
56
|
|
|
43
|
-
<details><summary><code>client.<a href="/src/Client.ts">
|
|
57
|
+
<details><summary><code>client.<a href="/src/Client.ts">healthHealthGet</a>() -> core.APIResponse<unknown, FernVenusApi.healthHealthGet.Error></code></summary>
|
|
44
58
|
<dl>
|
|
45
59
|
<dd>
|
|
46
60
|
|
|
@@ -53,7 +67,7 @@ await client.healthHealthGet();
|
|
|
53
67
|
<dd>
|
|
54
68
|
|
|
55
69
|
```typescript
|
|
56
|
-
await client.
|
|
70
|
+
await client.healthHealthGet();
|
|
57
71
|
|
|
58
72
|
```
|
|
59
73
|
</dd>
|
|
@@ -98,10 +112,6 @@ RDS smoke check: ping each configured RDS engine.
|
|
|
98
112
|
Returns 200 only if every configured RDS engine answers ``SELECT 1``;
|
|
99
113
|
503 if any engine is unhealthy. Returns 200 with ``configured: false``
|
|
100
114
|
when no RDS engines are configured.
|
|
101
|
-
|
|
102
|
-
``hosts_allowlisted`` is true only if every engine's host matches
|
|
103
|
-
RDS_ALLOWED_HOST_SUFFIXES. It is false when the allowlist is unset,
|
|
104
|
-
since nothing has then vouched for the hosts.
|
|
105
115
|
</dd>
|
|
106
116
|
</dl>
|
|
107
117
|
</dd>
|
|
@@ -149,22 +159,6 @@ await client.healthRdsHealthRdsGet();
|
|
|
149
159
|
<dl>
|
|
150
160
|
<dd>
|
|
151
161
|
|
|
152
|
-
#### 📝 Description
|
|
153
|
-
|
|
154
|
-
<dl>
|
|
155
|
-
<dd>
|
|
156
|
-
|
|
157
|
-
<dl>
|
|
158
|
-
<dd>
|
|
159
|
-
|
|
160
|
-
Creates an API key for an organization the caller is a member of. Called
|
|
161
|
-
with the provisioner token, it only works for an unclaimed organization
|
|
162
|
-
that was created with that token, and returns 403 for any other.
|
|
163
|
-
</dd>
|
|
164
|
-
</dl>
|
|
165
|
-
</dd>
|
|
166
|
-
</dl>
|
|
167
|
-
|
|
168
162
|
#### 🔌 Usage
|
|
169
163
|
|
|
170
164
|
<dl>
|
|
@@ -267,22 +261,6 @@ await client.apiKeys.getTokenMetadata({
|
|
|
267
261
|
<dl>
|
|
268
262
|
<dd>
|
|
269
263
|
|
|
270
|
-
#### 📝 Description
|
|
271
|
-
|
|
272
|
-
<dl>
|
|
273
|
-
<dd>
|
|
274
|
-
|
|
275
|
-
<dl>
|
|
276
|
-
<dd>
|
|
277
|
-
|
|
278
|
-
Lists an organization's API keys. Called with the provisioner token, it
|
|
279
|
-
only works for an unclaimed organization that was created with that
|
|
280
|
-
token, and returns 403 for any other.
|
|
281
|
-
</dd>
|
|
282
|
-
</dl>
|
|
283
|
-
</dd>
|
|
284
|
-
</dl>
|
|
285
|
-
|
|
286
264
|
#### 🔌 Usage
|
|
287
265
|
|
|
288
266
|
<dl>
|
|
@@ -334,23 +312,6 @@ await client.apiKeys.getTokensForOrganization({
|
|
|
334
312
|
<dl>
|
|
335
313
|
<dd>
|
|
336
314
|
|
|
337
|
-
#### 📝 Description
|
|
338
|
-
|
|
339
|
-
<dl>
|
|
340
|
-
<dd>
|
|
341
|
-
|
|
342
|
-
<dl>
|
|
343
|
-
<dd>
|
|
344
|
-
|
|
345
|
-
Revokes an API key by its ID. Called with the provisioner token,
|
|
346
|
-
organizationId is required and must be an unclaimed organization that
|
|
347
|
-
was created with that token (403 otherwise), and the key must be that
|
|
348
|
-
organization's (401 otherwise). Other callers don't need organizationId.
|
|
349
|
-
</dd>
|
|
350
|
-
</dl>
|
|
351
|
-
</dd>
|
|
352
|
-
</dl>
|
|
353
|
-
|
|
354
315
|
#### 🔌 Usage
|
|
355
316
|
|
|
356
317
|
<dl>
|
|
@@ -705,30 +666,11 @@ await client.auth.getJwt({
|
|
|
705
666
|
</dl>
|
|
706
667
|
</details>
|
|
707
668
|
|
|
708
|
-
##
|
|
709
|
-
<details><summary><code>client.
|
|
710
|
-
<dl>
|
|
711
|
-
<dd>
|
|
712
|
-
|
|
713
|
-
#### 📝 Description
|
|
714
|
-
|
|
715
|
-
<dl>
|
|
716
|
-
<dd>
|
|
717
|
-
|
|
669
|
+
## Organization
|
|
670
|
+
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">create</a>({ ...params }) -> core.APIResponse<FernVenusApi.CreateOrganizationResponse, FernVenusApi.organization.create.Error></code></summary>
|
|
718
671
|
<dl>
|
|
719
672
|
<dd>
|
|
720
673
|
|
|
721
|
-
Issue a guest session: a throwaway organization, a short-lived token bound to it, and
|
|
722
|
-
the secret needed to claim it later.
|
|
723
|
-
This endpoint is unauthenticated on purpose. It is the one way into Fern without a
|
|
724
|
-
login, so every decision about what the session may do, how long it lasts and how many
|
|
725
|
-
a caller may open is made here, on the server.
|
|
726
|
-
The token and the claim secret are returned once and stored only as hashes.
|
|
727
|
-
</dd>
|
|
728
|
-
</dl>
|
|
729
|
-
</dd>
|
|
730
|
-
</dl>
|
|
731
|
-
|
|
732
674
|
#### 🔌 Usage
|
|
733
675
|
|
|
734
676
|
<dl>
|
|
@@ -738,8 +680,8 @@ The token and the claim secret are returned once and stored only as hashes.
|
|
|
738
680
|
<dd>
|
|
739
681
|
|
|
740
682
|
```typescript
|
|
741
|
-
await client.
|
|
742
|
-
|
|
683
|
+
await client.organization.create({
|
|
684
|
+
organizationId: "organizationId"
|
|
743
685
|
});
|
|
744
686
|
|
|
745
687
|
```
|
|
@@ -756,7 +698,7 @@ await client.guestSession.create({
|
|
|
756
698
|
<dl>
|
|
757
699
|
<dd>
|
|
758
700
|
|
|
759
|
-
**request:** `FernVenusApi.
|
|
701
|
+
**request:** `FernVenusApi.CreateOrganizationRequest`
|
|
760
702
|
|
|
761
703
|
</dd>
|
|
762
704
|
</dl>
|
|
@@ -764,7 +706,7 @@ await client.guestSession.create({
|
|
|
764
706
|
<dl>
|
|
765
707
|
<dd>
|
|
766
708
|
|
|
767
|
-
**requestOptions:** `
|
|
709
|
+
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
768
710
|
|
|
769
711
|
</dd>
|
|
770
712
|
</dl>
|
|
@@ -776,28 +718,10 @@ await client.guestSession.create({
|
|
|
776
718
|
</dl>
|
|
777
719
|
</details>
|
|
778
720
|
|
|
779
|
-
<details><summary><code>client.
|
|
780
|
-
<dl>
|
|
781
|
-
<dd>
|
|
782
|
-
|
|
783
|
-
#### 📝 Description
|
|
784
|
-
|
|
785
|
-
<dl>
|
|
786
|
-
<dd>
|
|
787
|
-
|
|
721
|
+
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">update</a>({ ...params }) -> core.APIResponse<void, FernVenusApi.organization.update.Error></code></summary>
|
|
788
722
|
<dl>
|
|
789
723
|
<dd>
|
|
790
724
|
|
|
791
|
-
Read a guest session: where it is in its life, when it runs out and how much of its
|
|
792
|
-
budget is spent.
|
|
793
|
-
Opened by the session's own token, by the claim secret (sent as `X-Fern-Claim-Secret`,
|
|
794
|
-
which is what the claim page holds), or by the user who claimed it. Anything else is
|
|
795
|
-
told the session does not exist.
|
|
796
|
-
</dd>
|
|
797
|
-
</dl>
|
|
798
|
-
</dd>
|
|
799
|
-
</dl>
|
|
800
|
-
|
|
801
725
|
#### 🔌 Usage
|
|
802
726
|
|
|
803
727
|
<dl>
|
|
@@ -807,8 +731,8 @@ told the session does not exist.
|
|
|
807
731
|
<dd>
|
|
808
732
|
|
|
809
733
|
```typescript
|
|
810
|
-
await client.
|
|
811
|
-
|
|
734
|
+
await client.organization.update({
|
|
735
|
+
orgId: "org_id"
|
|
812
736
|
});
|
|
813
737
|
|
|
814
738
|
```
|
|
@@ -825,7 +749,7 @@ await client.guestSession.get({
|
|
|
825
749
|
<dl>
|
|
826
750
|
<dd>
|
|
827
751
|
|
|
828
|
-
**request:** `FernVenusApi.
|
|
752
|
+
**request:** `FernVenusApi.UpdateOrganizationRequest`
|
|
829
753
|
|
|
830
754
|
</dd>
|
|
831
755
|
</dl>
|
|
@@ -833,7 +757,7 @@ await client.guestSession.get({
|
|
|
833
757
|
<dl>
|
|
834
758
|
<dd>
|
|
835
759
|
|
|
836
|
-
**requestOptions:** `
|
|
760
|
+
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
837
761
|
|
|
838
762
|
</dd>
|
|
839
763
|
</dl>
|
|
@@ -845,29 +769,10 @@ await client.guestSession.get({
|
|
|
845
769
|
</dl>
|
|
846
770
|
</details>
|
|
847
771
|
|
|
848
|
-
<details><summary><code>client.
|
|
849
|
-
<dl>
|
|
850
|
-
<dd>
|
|
851
|
-
|
|
852
|
-
#### 📝 Description
|
|
853
|
-
|
|
854
|
-
<dl>
|
|
855
|
-
<dd>
|
|
856
|
-
|
|
772
|
+
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">get</a>({ ...params }) -> core.APIResponse<FernVenusApi.Organization, FernVenusApi.organization.get.Error></code></summary>
|
|
857
773
|
<dl>
|
|
858
774
|
<dd>
|
|
859
775
|
|
|
860
|
-
Take a guest session down. Its token stops working at once and nothing more can be
|
|
861
|
-
built or published with it.
|
|
862
|
-
The session's own token or its claim secret takes it down (`deleted`); a Fern operator's
|
|
863
|
-
service credential takes it down for abuse (`takenDown`). Anything else is told the
|
|
864
|
-
session does not exist. Calling it again answers the same; a claimed session cannot be
|
|
865
|
-
taken down here, its work belongs to an organization now.
|
|
866
|
-
</dd>
|
|
867
|
-
</dl>
|
|
868
|
-
</dd>
|
|
869
|
-
</dl>
|
|
870
|
-
|
|
871
776
|
#### 🔌 Usage
|
|
872
777
|
|
|
873
778
|
<dl>
|
|
@@ -877,8 +782,8 @@ taken down here, its work belongs to an organization now.
|
|
|
877
782
|
<dd>
|
|
878
783
|
|
|
879
784
|
```typescript
|
|
880
|
-
await client.
|
|
881
|
-
|
|
785
|
+
await client.organization.get({
|
|
786
|
+
orgId: "org_id"
|
|
882
787
|
});
|
|
883
788
|
|
|
884
789
|
```
|
|
@@ -895,7 +800,7 @@ await client.guestSession.delete({
|
|
|
895
800
|
<dl>
|
|
896
801
|
<dd>
|
|
897
802
|
|
|
898
|
-
**request:** `FernVenusApi.
|
|
803
|
+
**request:** `FernVenusApi.GetOrganizationsOrgIdGetRequest`
|
|
899
804
|
|
|
900
805
|
</dd>
|
|
901
806
|
</dl>
|
|
@@ -903,7 +808,7 @@ await client.guestSession.delete({
|
|
|
903
808
|
<dl>
|
|
904
809
|
<dd>
|
|
905
810
|
|
|
906
|
-
**requestOptions:** `
|
|
811
|
+
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
907
812
|
|
|
908
813
|
</dd>
|
|
909
814
|
</dl>
|
|
@@ -915,7 +820,7 @@ await client.guestSession.delete({
|
|
|
915
820
|
</dl>
|
|
916
821
|
</details>
|
|
917
822
|
|
|
918
|
-
<details><summary><code>client.
|
|
823
|
+
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">delete</a>({ ...params }) -> core.APIResponse<void, FernVenusApi.organization.delete.Error></code></summary>
|
|
919
824
|
<dl>
|
|
920
825
|
<dd>
|
|
921
826
|
|
|
@@ -927,12 +832,7 @@ await client.guestSession.delete({
|
|
|
927
832
|
<dl>
|
|
928
833
|
<dd>
|
|
929
834
|
|
|
930
|
-
|
|
931
|
-
Needs two things: the claim secret (`X-Fern-Claim-Secret`, from the claim URL) and a
|
|
932
|
-
signed-in person (`Authorization`). With `organizationId`, the caller must already be an
|
|
933
|
-
admin of that organization and the session's work is moved into it. Without, the
|
|
934
|
-
session's own organization becomes the caller's, with them as its first admin.
|
|
935
|
-
Claiming revokes the guest token. Safe to retry: the claimant may call it again.
|
|
835
|
+
Deletes an organization. Only users with admin role can delete organizations.
|
|
936
836
|
</dd>
|
|
937
837
|
</dl>
|
|
938
838
|
</dd>
|
|
@@ -947,8 +847,8 @@ Claiming revokes the guest token. Safe to retry: the claimant may call it again.
|
|
|
947
847
|
<dd>
|
|
948
848
|
|
|
949
849
|
```typescript
|
|
950
|
-
await client.
|
|
951
|
-
|
|
850
|
+
await client.organization.delete({
|
|
851
|
+
orgId: "org_id"
|
|
952
852
|
});
|
|
953
853
|
|
|
954
854
|
```
|
|
@@ -965,7 +865,7 @@ await client.guestSession.claim({
|
|
|
965
865
|
<dl>
|
|
966
866
|
<dd>
|
|
967
867
|
|
|
968
|
-
**request:** `FernVenusApi.
|
|
868
|
+
**request:** `FernVenusApi.DeleteOrganizationsOrgIdDeleteRequest`
|
|
969
869
|
|
|
970
870
|
</dd>
|
|
971
871
|
</dl>
|
|
@@ -973,7 +873,7 @@ await client.guestSession.claim({
|
|
|
973
873
|
<dl>
|
|
974
874
|
<dd>
|
|
975
875
|
|
|
976
|
-
**requestOptions:** `
|
|
876
|
+
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
977
877
|
|
|
978
878
|
</dd>
|
|
979
879
|
</dl>
|
|
@@ -985,8 +885,7 @@ await client.guestSession.claim({
|
|
|
985
885
|
</dl>
|
|
986
886
|
</details>
|
|
987
887
|
|
|
988
|
-
|
|
989
|
-
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">create</a>({ ...params }) -> core.APIResponse<FernVenusApi.CreateOrganizationResponse, FernVenusApi.organization.create.Error></code></summary>
|
|
888
|
+
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">getOrgIdsByPostmanTeamId</a>({ ...params }) -> core.APIResponse<FernVenusApi.Organization, FernVenusApi.organization.getOrgIdsByPostmanTeamId.Error></code></summary>
|
|
990
889
|
<dl>
|
|
991
890
|
<dd>
|
|
992
891
|
|
|
@@ -998,12 +897,7 @@ await client.guestSession.claim({
|
|
|
998
897
|
<dl>
|
|
999
898
|
<dd>
|
|
1000
899
|
|
|
1001
|
-
|
|
1002
|
-
provisioner token, it instead creates an unclaimed organization, with no
|
|
1003
|
-
Auth0 organization or members, linked to the required postmanTeamId.
|
|
1004
|
-
Creating it again for the same team returns the same organization.
|
|
1005
|
-
A normal signup gets 409 if its postmanTeamId is linked to an unclaimed
|
|
1006
|
-
organization, since that team claims its organization through Postman.
|
|
900
|
+
Look up an organization by its associated Postman team ID.
|
|
1007
901
|
</dd>
|
|
1008
902
|
</dl>
|
|
1009
903
|
</dd>
|
|
@@ -1018,8 +912,8 @@ organization, since that team claims its organization through Postman.
|
|
|
1018
912
|
<dd>
|
|
1019
913
|
|
|
1020
914
|
```typescript
|
|
1021
|
-
await client.organization.
|
|
1022
|
-
|
|
915
|
+
await client.organization.getOrgIdsByPostmanTeamId({
|
|
916
|
+
postmanTeamId: "postman_team_id"
|
|
1023
917
|
});
|
|
1024
918
|
|
|
1025
919
|
```
|
|
@@ -1036,7 +930,7 @@ await client.organization.create({
|
|
|
1036
930
|
<dl>
|
|
1037
931
|
<dd>
|
|
1038
932
|
|
|
1039
|
-
**request:** `FernVenusApi.
|
|
933
|
+
**request:** `FernVenusApi.GetOrgIdsByPostmanTeamIdOrganizationsPostmanTeamPostmanTeamIdGetRequest`
|
|
1040
934
|
|
|
1041
935
|
</dd>
|
|
1042
936
|
</dl>
|
|
@@ -1056,10 +950,24 @@ await client.organization.create({
|
|
|
1056
950
|
</dl>
|
|
1057
951
|
</details>
|
|
1058
952
|
|
|
1059
|
-
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">
|
|
953
|
+
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">getPostmanTeamIdByOrgId</a>({ ...params }) -> core.APIResponse<string, FernVenusApi.organization.getPostmanTeamIdByOrgId.Error></code></summary>
|
|
954
|
+
<dl>
|
|
955
|
+
<dd>
|
|
956
|
+
|
|
957
|
+
#### 📝 Description
|
|
958
|
+
|
|
959
|
+
<dl>
|
|
960
|
+
<dd>
|
|
961
|
+
|
|
1060
962
|
<dl>
|
|
1061
963
|
<dd>
|
|
1062
964
|
|
|
965
|
+
Get the Postman team ID associated with an organization ID.
|
|
966
|
+
</dd>
|
|
967
|
+
</dl>
|
|
968
|
+
</dd>
|
|
969
|
+
</dl>
|
|
970
|
+
|
|
1063
971
|
#### 🔌 Usage
|
|
1064
972
|
|
|
1065
973
|
<dl>
|
|
@@ -1069,7 +977,7 @@ await client.organization.create({
|
|
|
1069
977
|
<dd>
|
|
1070
978
|
|
|
1071
979
|
```typescript
|
|
1072
|
-
await client.organization.
|
|
980
|
+
await client.organization.getPostmanTeamIdByOrgId({
|
|
1073
981
|
orgId: "org_id"
|
|
1074
982
|
});
|
|
1075
983
|
|
|
@@ -1087,7 +995,7 @@ await client.organization.update({
|
|
|
1087
995
|
<dl>
|
|
1088
996
|
<dd>
|
|
1089
997
|
|
|
1090
|
-
**request:** `FernVenusApi.
|
|
998
|
+
**request:** `FernVenusApi.GetPostmanTeamIdByOrgIdOrganizationsOrgIdPostmanTeamIdGetRequest`
|
|
1091
999
|
|
|
1092
1000
|
</dd>
|
|
1093
1001
|
</dl>
|
|
@@ -1107,7 +1015,7 @@ await client.organization.update({
|
|
|
1107
1015
|
</dl>
|
|
1108
1016
|
</details>
|
|
1109
1017
|
|
|
1110
|
-
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">
|
|
1018
|
+
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">isMember</a>({ ...params }) -> core.APIResponse<boolean, FernVenusApi.organization.isMember.Error></code></summary>
|
|
1111
1019
|
<dl>
|
|
1112
1020
|
<dd>
|
|
1113
1021
|
|
|
@@ -1120,8 +1028,8 @@ await client.organization.update({
|
|
|
1120
1028
|
<dd>
|
|
1121
1029
|
|
|
1122
1030
|
```typescript
|
|
1123
|
-
await client.organization.
|
|
1124
|
-
|
|
1031
|
+
await client.organization.isMember({
|
|
1032
|
+
organizationId: "organization_id"
|
|
1125
1033
|
});
|
|
1126
1034
|
|
|
1127
1035
|
```
|
|
@@ -1138,7 +1046,7 @@ await client.organization.get({
|
|
|
1138
1046
|
<dl>
|
|
1139
1047
|
<dd>
|
|
1140
1048
|
|
|
1141
|
-
**request:** `FernVenusApi.
|
|
1049
|
+
**request:** `FernVenusApi.IsMemberOrganizationsBelongsToOrganizationOrganizationIdPostRequest`
|
|
1142
1050
|
|
|
1143
1051
|
</dd>
|
|
1144
1052
|
</dl>
|
|
@@ -1158,7 +1066,7 @@ await client.organization.get({
|
|
|
1158
1066
|
</dl>
|
|
1159
1067
|
</details>
|
|
1160
1068
|
|
|
1161
|
-
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">
|
|
1069
|
+
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">getMyOrganizationFromScopedToken</a>({ ...params }) -> core.APIResponse<FernVenusApi.Organization, FernVenusApi.organization.getMyOrganizationFromScopedToken.Error></code></summary>
|
|
1162
1070
|
<dl>
|
|
1163
1071
|
<dd>
|
|
1164
1072
|
|
|
@@ -1170,10 +1078,7 @@ await client.organization.get({
|
|
|
1170
1078
|
<dl>
|
|
1171
1079
|
<dd>
|
|
1172
1080
|
|
|
1173
|
-
|
|
1174
|
-
Called with the provisioner token, it only works for an unclaimed
|
|
1175
|
-
organization that was created with that token, and returns 403 for any
|
|
1176
|
-
other. It also revokes that organization's API keys.
|
|
1081
|
+
Returns the org for a scoped token. The token is limited to one organization.
|
|
1177
1082
|
</dd>
|
|
1178
1083
|
</dl>
|
|
1179
1084
|
</dd>
|
|
@@ -1188,9 +1093,7 @@ other. It also revokes that organization's API keys.
|
|
|
1188
1093
|
<dd>
|
|
1189
1094
|
|
|
1190
1095
|
```typescript
|
|
1191
|
-
await client.organization.
|
|
1192
|
-
orgId: "org_id"
|
|
1193
|
-
});
|
|
1096
|
+
await client.organization.getMyOrganizationFromScopedToken();
|
|
1194
1097
|
|
|
1195
1098
|
```
|
|
1196
1099
|
</dd>
|
|
@@ -1206,7 +1109,7 @@ await client.organization.delete({
|
|
|
1206
1109
|
<dl>
|
|
1207
1110
|
<dd>
|
|
1208
1111
|
|
|
1209
|
-
**request:** `FernVenusApi.
|
|
1112
|
+
**request:** `FernVenusApi.GetMyOrganizationFromScopedTokenOrganizationsMyselfPostRequest`
|
|
1210
1113
|
|
|
1211
1114
|
</dd>
|
|
1212
1115
|
</dl>
|
|
@@ -1226,24 +1129,10 @@ await client.organization.delete({
|
|
|
1226
1129
|
</dl>
|
|
1227
1130
|
</details>
|
|
1228
1131
|
|
|
1229
|
-
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">
|
|
1230
|
-
<dl>
|
|
1231
|
-
<dd>
|
|
1232
|
-
|
|
1233
|
-
#### 📝 Description
|
|
1234
|
-
|
|
1235
|
-
<dl>
|
|
1236
|
-
<dd>
|
|
1237
|
-
|
|
1132
|
+
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">getOrgIdsFromToken</a>() -> core.APIResponse<string[], FernVenusApi.organization.getOrgIdsFromToken.Error></code></summary>
|
|
1238
1133
|
<dl>
|
|
1239
1134
|
<dd>
|
|
1240
1135
|
|
|
1241
|
-
Look up an organization by its associated Postman team ID.
|
|
1242
|
-
</dd>
|
|
1243
|
-
</dl>
|
|
1244
|
-
</dd>
|
|
1245
|
-
</dl>
|
|
1246
|
-
|
|
1247
1136
|
#### 🔌 Usage
|
|
1248
1137
|
|
|
1249
1138
|
<dl>
|
|
@@ -1253,9 +1142,7 @@ Look up an organization by its associated Postman team ID.
|
|
|
1253
1142
|
<dd>
|
|
1254
1143
|
|
|
1255
1144
|
```typescript
|
|
1256
|
-
await client.organization.
|
|
1257
|
-
postmanTeamId: "postman_team_id"
|
|
1258
|
-
});
|
|
1145
|
+
await client.organization.getOrgIdsFromToken();
|
|
1259
1146
|
|
|
1260
1147
|
```
|
|
1261
1148
|
</dd>
|
|
@@ -1271,14 +1158,6 @@ await client.organization.getOrgIdsByPostmanTeamId({
|
|
|
1271
1158
|
<dl>
|
|
1272
1159
|
<dd>
|
|
1273
1160
|
|
|
1274
|
-
**request:** `FernVenusApi.GetOrgIdsByPostmanTeamIdOrganizationsPostmanTeamPostmanTeamIdGetRequest`
|
|
1275
|
-
|
|
1276
|
-
</dd>
|
|
1277
|
-
</dl>
|
|
1278
|
-
|
|
1279
|
-
<dl>
|
|
1280
|
-
<dd>
|
|
1281
|
-
|
|
1282
1161
|
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
1283
1162
|
|
|
1284
1163
|
</dd>
|
|
@@ -1291,27 +1170,10 @@ await client.organization.getOrgIdsByPostmanTeamId({
|
|
|
1291
1170
|
</dl>
|
|
1292
1171
|
</details>
|
|
1293
1172
|
|
|
1294
|
-
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">
|
|
1295
|
-
<dl>
|
|
1296
|
-
<dd>
|
|
1297
|
-
|
|
1298
|
-
#### 📝 Description
|
|
1299
|
-
|
|
1300
|
-
<dl>
|
|
1301
|
-
<dd>
|
|
1302
|
-
|
|
1173
|
+
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">addUser</a>({ ...params }) -> core.APIResponse<void, FernVenusApi.organization.addUser.Error></code></summary>
|
|
1303
1174
|
<dl>
|
|
1304
1175
|
<dd>
|
|
1305
1176
|
|
|
1306
|
-
The claimable organization linked to a Postman team, with its claim
|
|
1307
|
-
status and the address of its docs site. Only Postman's integration
|
|
1308
|
-
service token can call it. 404 when the team has no claimable
|
|
1309
|
-
organization, or its docs address isn't set.
|
|
1310
|
-
</dd>
|
|
1311
|
-
</dl>
|
|
1312
|
-
</dd>
|
|
1313
|
-
</dl>
|
|
1314
|
-
|
|
1315
1177
|
#### 🔌 Usage
|
|
1316
1178
|
|
|
1317
1179
|
<dl>
|
|
@@ -1321,8 +1183,9 @@ organization, or its docs address isn't set.
|
|
|
1321
1183
|
<dd>
|
|
1322
1184
|
|
|
1323
1185
|
```typescript
|
|
1324
|
-
await client.organization.
|
|
1325
|
-
|
|
1186
|
+
await client.organization.addUser({
|
|
1187
|
+
userId: "userId",
|
|
1188
|
+
orgId: "orgId"
|
|
1326
1189
|
});
|
|
1327
1190
|
|
|
1328
1191
|
```
|
|
@@ -1339,7 +1202,7 @@ await client.organization.getPostmanTeamDocs({
|
|
|
1339
1202
|
<dl>
|
|
1340
1203
|
<dd>
|
|
1341
1204
|
|
|
1342
|
-
**request:** `FernVenusApi.
|
|
1205
|
+
**request:** `FernVenusApi.AddUserToOrgRequest`
|
|
1343
1206
|
|
|
1344
1207
|
</dd>
|
|
1345
1208
|
</dl>
|
|
@@ -1359,24 +1222,10 @@ await client.organization.getPostmanTeamDocs({
|
|
|
1359
1222
|
</dl>
|
|
1360
1223
|
</details>
|
|
1361
1224
|
|
|
1362
|
-
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">
|
|
1363
|
-
<dl>
|
|
1364
|
-
<dd>
|
|
1365
|
-
|
|
1366
|
-
#### 📝 Description
|
|
1367
|
-
|
|
1368
|
-
<dl>
|
|
1369
|
-
<dd>
|
|
1370
|
-
|
|
1225
|
+
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">inviteUser</a>({ ...params }) -> core.APIResponse<void, FernVenusApi.organization.inviteUser.Error></code></summary>
|
|
1371
1226
|
<dl>
|
|
1372
1227
|
<dd>
|
|
1373
1228
|
|
|
1374
|
-
Get the Postman team ID associated with an organization ID.
|
|
1375
|
-
</dd>
|
|
1376
|
-
</dl>
|
|
1377
|
-
</dd>
|
|
1378
|
-
</dl>
|
|
1379
|
-
|
|
1380
1229
|
#### 🔌 Usage
|
|
1381
1230
|
|
|
1382
1231
|
<dl>
|
|
@@ -1386,8 +1235,9 @@ Get the Postman team ID associated with an organization ID.
|
|
|
1386
1235
|
<dd>
|
|
1387
1236
|
|
|
1388
1237
|
```typescript
|
|
1389
|
-
await client.organization.
|
|
1390
|
-
|
|
1238
|
+
await client.organization.inviteUser({
|
|
1239
|
+
emailAddress: "emailAddress",
|
|
1240
|
+
auth0OrgId: "auth0OrgId"
|
|
1391
1241
|
});
|
|
1392
1242
|
|
|
1393
1243
|
```
|
|
@@ -1404,7 +1254,7 @@ await client.organization.getPostmanTeamIdByOrgId({
|
|
|
1404
1254
|
<dl>
|
|
1405
1255
|
<dd>
|
|
1406
1256
|
|
|
1407
|
-
**request:** `FernVenusApi.
|
|
1257
|
+
**request:** `FernVenusApi.InviteUserToOrgRequest`
|
|
1408
1258
|
|
|
1409
1259
|
</dd>
|
|
1410
1260
|
</dl>
|
|
@@ -1424,26 +1274,10 @@ await client.organization.getPostmanTeamIdByOrgId({
|
|
|
1424
1274
|
</dl>
|
|
1425
1275
|
</details>
|
|
1426
1276
|
|
|
1427
|
-
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">
|
|
1428
|
-
<dl>
|
|
1429
|
-
<dd>
|
|
1430
|
-
|
|
1431
|
-
#### 📝 Description
|
|
1432
|
-
|
|
1433
|
-
<dl>
|
|
1434
|
-
<dd>
|
|
1435
|
-
|
|
1277
|
+
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">removeUser</a>({ ...params }) -> core.APIResponse<void, FernVenusApi.organization.removeUser.Error></code></summary>
|
|
1436
1278
|
<dl>
|
|
1437
1279
|
<dd>
|
|
1438
1280
|
|
|
1439
|
-
Whether a claimable organization has been claimed. Public, so a docs
|
|
1440
|
-
site can show a claim banner to signed-out visitors. Organizations
|
|
1441
|
-
that were never claimable return 404.
|
|
1442
|
-
</dd>
|
|
1443
|
-
</dl>
|
|
1444
|
-
</dd>
|
|
1445
|
-
</dl>
|
|
1446
|
-
|
|
1447
1281
|
#### 🔌 Usage
|
|
1448
1282
|
|
|
1449
1283
|
<dl>
|
|
@@ -1453,8 +1287,9 @@ that were never claimable return 404.
|
|
|
1453
1287
|
<dd>
|
|
1454
1288
|
|
|
1455
1289
|
```typescript
|
|
1456
|
-
await client.organization.
|
|
1457
|
-
|
|
1290
|
+
await client.organization.removeUser({
|
|
1291
|
+
userId: "userId",
|
|
1292
|
+
auth0OrgId: "auth0OrgId"
|
|
1458
1293
|
});
|
|
1459
1294
|
|
|
1460
1295
|
```
|
|
@@ -1471,661 +1306,7 @@ await client.organization.getClaimStatus({
|
|
|
1471
1306
|
<dl>
|
|
1472
1307
|
<dd>
|
|
1473
1308
|
|
|
1474
|
-
**request:** `FernVenusApi.
|
|
1475
|
-
|
|
1476
|
-
</dd>
|
|
1477
|
-
</dl>
|
|
1478
|
-
|
|
1479
|
-
<dl>
|
|
1480
|
-
<dd>
|
|
1481
|
-
|
|
1482
|
-
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
1483
|
-
|
|
1484
|
-
</dd>
|
|
1485
|
-
</dl>
|
|
1486
|
-
</dd>
|
|
1487
|
-
</dl>
|
|
1488
|
-
|
|
1489
|
-
|
|
1490
|
-
</dd>
|
|
1491
|
-
</dl>
|
|
1492
|
-
</details>
|
|
1493
|
-
|
|
1494
|
-
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">createClaimToken</a>({ ...params }) -> core.APIResponse<FernVenusApi.ClaimTokenResponse, FernVenusApi.organization.createClaimToken.Error></code></summary>
|
|
1495
|
-
<dl>
|
|
1496
|
-
<dd>
|
|
1497
|
-
|
|
1498
|
-
#### 📝 Description
|
|
1499
|
-
|
|
1500
|
-
<dl>
|
|
1501
|
-
<dd>
|
|
1502
|
-
|
|
1503
|
-
<dl>
|
|
1504
|
-
<dd>
|
|
1505
|
-
|
|
1506
|
-
Issues a claim link for an unclaimed organization, bound to one Postman
|
|
1507
|
-
user and valid for 15 minutes. Only the provisioner token and Postman's
|
|
1508
|
-
integration service token can call it.
|
|
1509
|
-
</dd>
|
|
1510
|
-
</dl>
|
|
1511
|
-
</dd>
|
|
1512
|
-
</dl>
|
|
1513
|
-
|
|
1514
|
-
#### 🔌 Usage
|
|
1515
|
-
|
|
1516
|
-
<dl>
|
|
1517
|
-
<dd>
|
|
1518
|
-
|
|
1519
|
-
<dl>
|
|
1520
|
-
<dd>
|
|
1521
|
-
|
|
1522
|
-
```typescript
|
|
1523
|
-
await client.organization.createClaimToken({
|
|
1524
|
-
orgId: "org_id",
|
|
1525
|
-
postmanUserId: "postmanUserId"
|
|
1526
|
-
});
|
|
1527
|
-
|
|
1528
|
-
```
|
|
1529
|
-
</dd>
|
|
1530
|
-
</dl>
|
|
1531
|
-
</dd>
|
|
1532
|
-
</dl>
|
|
1533
|
-
|
|
1534
|
-
#### ⚙️ Parameters
|
|
1535
|
-
|
|
1536
|
-
<dl>
|
|
1537
|
-
<dd>
|
|
1538
|
-
|
|
1539
|
-
<dl>
|
|
1540
|
-
<dd>
|
|
1541
|
-
|
|
1542
|
-
**request:** `FernVenusApi.CreateClaimTokenRequest`
|
|
1543
|
-
|
|
1544
|
-
</dd>
|
|
1545
|
-
</dl>
|
|
1546
|
-
|
|
1547
|
-
<dl>
|
|
1548
|
-
<dd>
|
|
1549
|
-
|
|
1550
|
-
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
1551
|
-
|
|
1552
|
-
</dd>
|
|
1553
|
-
</dl>
|
|
1554
|
-
</dd>
|
|
1555
|
-
</dl>
|
|
1556
|
-
|
|
1557
|
-
|
|
1558
|
-
</dd>
|
|
1559
|
-
</dl>
|
|
1560
|
-
</details>
|
|
1561
|
-
|
|
1562
|
-
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">setDocsUrl</a>({ ...params }) -> core.APIResponse<void, FernVenusApi.organization.setDocsUrl.Error></code></summary>
|
|
1563
|
-
<dl>
|
|
1564
|
-
<dd>
|
|
1565
|
-
|
|
1566
|
-
#### 📝 Description
|
|
1567
|
-
|
|
1568
|
-
<dl>
|
|
1569
|
-
<dd>
|
|
1570
|
-
|
|
1571
|
-
<dl>
|
|
1572
|
-
<dd>
|
|
1573
|
-
|
|
1574
|
-
Sets the address of an unclaimed organization's docs site, which the
|
|
1575
|
-
team docs lookup returns. Only the provisioner token can call it, and
|
|
1576
|
-
only until the organization is claimed.
|
|
1577
|
-
</dd>
|
|
1578
|
-
</dl>
|
|
1579
|
-
</dd>
|
|
1580
|
-
</dl>
|
|
1581
|
-
|
|
1582
|
-
#### 🔌 Usage
|
|
1583
|
-
|
|
1584
|
-
<dl>
|
|
1585
|
-
<dd>
|
|
1586
|
-
|
|
1587
|
-
<dl>
|
|
1588
|
-
<dd>
|
|
1589
|
-
|
|
1590
|
-
```typescript
|
|
1591
|
-
await client.organization.setDocsUrl({
|
|
1592
|
-
orgId: "org_id",
|
|
1593
|
-
docsUrl: "docsUrl"
|
|
1594
|
-
});
|
|
1595
|
-
|
|
1596
|
-
```
|
|
1597
|
-
</dd>
|
|
1598
|
-
</dl>
|
|
1599
|
-
</dd>
|
|
1600
|
-
</dl>
|
|
1601
|
-
|
|
1602
|
-
#### ⚙️ Parameters
|
|
1603
|
-
|
|
1604
|
-
<dl>
|
|
1605
|
-
<dd>
|
|
1606
|
-
|
|
1607
|
-
<dl>
|
|
1608
|
-
<dd>
|
|
1609
|
-
|
|
1610
|
-
**request:** `FernVenusApi.SetDocsUrlRequest`
|
|
1611
|
-
|
|
1612
|
-
</dd>
|
|
1613
|
-
</dl>
|
|
1614
|
-
|
|
1615
|
-
<dl>
|
|
1616
|
-
<dd>
|
|
1617
|
-
|
|
1618
|
-
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
1619
|
-
|
|
1620
|
-
</dd>
|
|
1621
|
-
</dl>
|
|
1622
|
-
</dd>
|
|
1623
|
-
</dl>
|
|
1624
|
-
|
|
1625
|
-
|
|
1626
|
-
</dd>
|
|
1627
|
-
</dl>
|
|
1628
|
-
</details>
|
|
1629
|
-
|
|
1630
|
-
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">claim</a>({ ...params }) -> core.APIResponse<FernVenusApi.ClaimOrganizationResponse, FernVenusApi.organization.claim.Error></code></summary>
|
|
1631
|
-
<dl>
|
|
1632
|
-
<dd>
|
|
1633
|
-
|
|
1634
|
-
#### 📝 Description
|
|
1635
|
-
|
|
1636
|
-
<dl>
|
|
1637
|
-
<dd>
|
|
1638
|
-
|
|
1639
|
-
<dl>
|
|
1640
|
-
<dd>
|
|
1641
|
-
|
|
1642
|
-
Redeems a claim link. The caller, signed in as the Postman user the link
|
|
1643
|
-
is for, becomes the admin of the organization. The first claim wins, and
|
|
1644
|
-
a retry by the same user finishes a claim that failed partway.
|
|
1645
|
-
</dd>
|
|
1646
|
-
</dl>
|
|
1647
|
-
</dd>
|
|
1648
|
-
</dl>
|
|
1649
|
-
|
|
1650
|
-
#### 🔌 Usage
|
|
1651
|
-
|
|
1652
|
-
<dl>
|
|
1653
|
-
<dd>
|
|
1654
|
-
|
|
1655
|
-
<dl>
|
|
1656
|
-
<dd>
|
|
1657
|
-
|
|
1658
|
-
```typescript
|
|
1659
|
-
await client.organization.claim({
|
|
1660
|
-
claimToken: "claimToken"
|
|
1661
|
-
});
|
|
1662
|
-
|
|
1663
|
-
```
|
|
1664
|
-
</dd>
|
|
1665
|
-
</dl>
|
|
1666
|
-
</dd>
|
|
1667
|
-
</dl>
|
|
1668
|
-
|
|
1669
|
-
#### ⚙️ Parameters
|
|
1670
|
-
|
|
1671
|
-
<dl>
|
|
1672
|
-
<dd>
|
|
1673
|
-
|
|
1674
|
-
<dl>
|
|
1675
|
-
<dd>
|
|
1676
|
-
|
|
1677
|
-
**request:** `FernVenusApi.ClaimOrganizationRequest`
|
|
1678
|
-
|
|
1679
|
-
</dd>
|
|
1680
|
-
</dl>
|
|
1681
|
-
|
|
1682
|
-
<dl>
|
|
1683
|
-
<dd>
|
|
1684
|
-
|
|
1685
|
-
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
1686
|
-
|
|
1687
|
-
</dd>
|
|
1688
|
-
</dl>
|
|
1689
|
-
</dd>
|
|
1690
|
-
</dl>
|
|
1691
|
-
|
|
1692
|
-
|
|
1693
|
-
</dd>
|
|
1694
|
-
</dl>
|
|
1695
|
-
</details>
|
|
1696
|
-
|
|
1697
|
-
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">previewClaim</a>({ ...params }) -> core.APIResponse<FernVenusApi.ClaimPreviewResponse, FernVenusApi.organization.previewClaim.Error></code></summary>
|
|
1698
|
-
<dl>
|
|
1699
|
-
<dd>
|
|
1700
|
-
|
|
1701
|
-
#### 📝 Description
|
|
1702
|
-
|
|
1703
|
-
<dl>
|
|
1704
|
-
<dd>
|
|
1705
|
-
|
|
1706
|
-
<dl>
|
|
1707
|
-
<dd>
|
|
1708
|
-
|
|
1709
|
-
What a claim link is for, without redeeming it, so the dashboard can show
|
|
1710
|
-
the organization and the link's state before the user signs in. Public:
|
|
1711
|
-
the link is the secret. The token is in the body to keep it out of
|
|
1712
|
-
request logs.
|
|
1713
|
-
</dd>
|
|
1714
|
-
</dl>
|
|
1715
|
-
</dd>
|
|
1716
|
-
</dl>
|
|
1717
|
-
|
|
1718
|
-
#### 🔌 Usage
|
|
1719
|
-
|
|
1720
|
-
<dl>
|
|
1721
|
-
<dd>
|
|
1722
|
-
|
|
1723
|
-
<dl>
|
|
1724
|
-
<dd>
|
|
1725
|
-
|
|
1726
|
-
```typescript
|
|
1727
|
-
await client.organization.previewClaim({
|
|
1728
|
-
claimToken: "claimToken"
|
|
1729
|
-
});
|
|
1730
|
-
|
|
1731
|
-
```
|
|
1732
|
-
</dd>
|
|
1733
|
-
</dl>
|
|
1734
|
-
</dd>
|
|
1735
|
-
</dl>
|
|
1736
|
-
|
|
1737
|
-
#### ⚙️ Parameters
|
|
1738
|
-
|
|
1739
|
-
<dl>
|
|
1740
|
-
<dd>
|
|
1741
|
-
|
|
1742
|
-
<dl>
|
|
1743
|
-
<dd>
|
|
1744
|
-
|
|
1745
|
-
**request:** `FernVenusApi.ClaimOrganizationRequest`
|
|
1746
|
-
|
|
1747
|
-
</dd>
|
|
1748
|
-
</dl>
|
|
1749
|
-
|
|
1750
|
-
<dl>
|
|
1751
|
-
<dd>
|
|
1752
|
-
|
|
1753
|
-
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
1754
|
-
|
|
1755
|
-
</dd>
|
|
1756
|
-
</dl>
|
|
1757
|
-
</dd>
|
|
1758
|
-
</dl>
|
|
1759
|
-
|
|
1760
|
-
|
|
1761
|
-
</dd>
|
|
1762
|
-
</dl>
|
|
1763
|
-
</details>
|
|
1764
|
-
|
|
1765
|
-
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">claimFromDocsSite</a>({ ...params }) -> core.APIResponse<FernVenusApi.ClaimOrganizationResponse, FernVenusApi.organization.claimFromDocsSite.Error></code></summary>
|
|
1766
|
-
<dl>
|
|
1767
|
-
<dd>
|
|
1768
|
-
|
|
1769
|
-
#### 📝 Description
|
|
1770
|
-
|
|
1771
|
-
<dl>
|
|
1772
|
-
<dd>
|
|
1773
|
-
|
|
1774
|
-
<dl>
|
|
1775
|
-
<dd>
|
|
1776
|
-
|
|
1777
|
-
Redeems a claim link without a Fern sign-in, for the Claim button on
|
|
1778
|
-
the organization's docs site. The organization is claimed for the
|
|
1779
|
-
Postman user the link was issued for, who becomes its admin if they
|
|
1780
|
-
already have a Fern account; otherwise the organization starts with
|
|
1781
|
-
no members, and the dashboard adds the team's Postman users when they
|
|
1782
|
-
sign in with Postman. Public: the link is the secret, and only the
|
|
1783
|
-
provisioner and Postman's integration service can get one. The first
|
|
1784
|
-
claim wins, and a retry finishes a claim that failed partway.
|
|
1785
|
-
</dd>
|
|
1786
|
-
</dl>
|
|
1787
|
-
</dd>
|
|
1788
|
-
</dl>
|
|
1789
|
-
|
|
1790
|
-
#### 🔌 Usage
|
|
1791
|
-
|
|
1792
|
-
<dl>
|
|
1793
|
-
<dd>
|
|
1794
|
-
|
|
1795
|
-
<dl>
|
|
1796
|
-
<dd>
|
|
1797
|
-
|
|
1798
|
-
```typescript
|
|
1799
|
-
await client.organization.claimFromDocsSite({
|
|
1800
|
-
claimToken: "claimToken"
|
|
1801
|
-
});
|
|
1802
|
-
|
|
1803
|
-
```
|
|
1804
|
-
</dd>
|
|
1805
|
-
</dl>
|
|
1806
|
-
</dd>
|
|
1807
|
-
</dl>
|
|
1808
|
-
|
|
1809
|
-
#### ⚙️ Parameters
|
|
1810
|
-
|
|
1811
|
-
<dl>
|
|
1812
|
-
<dd>
|
|
1813
|
-
|
|
1814
|
-
<dl>
|
|
1815
|
-
<dd>
|
|
1816
|
-
|
|
1817
|
-
**request:** `FernVenusApi.ClaimOrganizationRequest`
|
|
1818
|
-
|
|
1819
|
-
</dd>
|
|
1820
|
-
</dl>
|
|
1821
|
-
|
|
1822
|
-
<dl>
|
|
1823
|
-
<dd>
|
|
1824
|
-
|
|
1825
|
-
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
1826
|
-
|
|
1827
|
-
</dd>
|
|
1828
|
-
</dl>
|
|
1829
|
-
</dd>
|
|
1830
|
-
</dl>
|
|
1831
|
-
|
|
1832
|
-
|
|
1833
|
-
</dd>
|
|
1834
|
-
</dl>
|
|
1835
|
-
</details>
|
|
1836
|
-
|
|
1837
|
-
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">isMember</a>({ ...params }) -> core.APIResponse<boolean, FernVenusApi.organization.isMember.Error></code></summary>
|
|
1838
|
-
<dl>
|
|
1839
|
-
<dd>
|
|
1840
|
-
|
|
1841
|
-
#### 🔌 Usage
|
|
1842
|
-
|
|
1843
|
-
<dl>
|
|
1844
|
-
<dd>
|
|
1845
|
-
|
|
1846
|
-
<dl>
|
|
1847
|
-
<dd>
|
|
1848
|
-
|
|
1849
|
-
```typescript
|
|
1850
|
-
await client.organization.isMember({
|
|
1851
|
-
organizationId: "organization_id"
|
|
1852
|
-
});
|
|
1853
|
-
|
|
1854
|
-
```
|
|
1855
|
-
</dd>
|
|
1856
|
-
</dl>
|
|
1857
|
-
</dd>
|
|
1858
|
-
</dl>
|
|
1859
|
-
|
|
1860
|
-
#### ⚙️ Parameters
|
|
1861
|
-
|
|
1862
|
-
<dl>
|
|
1863
|
-
<dd>
|
|
1864
|
-
|
|
1865
|
-
<dl>
|
|
1866
|
-
<dd>
|
|
1867
|
-
|
|
1868
|
-
**request:** `FernVenusApi.IsMemberOrganizationsBelongsToOrganizationOrganizationIdPostRequest`
|
|
1869
|
-
|
|
1870
|
-
</dd>
|
|
1871
|
-
</dl>
|
|
1872
|
-
|
|
1873
|
-
<dl>
|
|
1874
|
-
<dd>
|
|
1875
|
-
|
|
1876
|
-
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
1877
|
-
|
|
1878
|
-
</dd>
|
|
1879
|
-
</dl>
|
|
1880
|
-
</dd>
|
|
1881
|
-
</dl>
|
|
1882
|
-
|
|
1883
|
-
|
|
1884
|
-
</dd>
|
|
1885
|
-
</dl>
|
|
1886
|
-
</details>
|
|
1887
|
-
|
|
1888
|
-
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">getMyOrganizationFromScopedToken</a>({ ...params }) -> core.APIResponse<FernVenusApi.Organization, FernVenusApi.organization.getMyOrganizationFromScopedToken.Error></code></summary>
|
|
1889
|
-
<dl>
|
|
1890
|
-
<dd>
|
|
1891
|
-
|
|
1892
|
-
#### 📝 Description
|
|
1893
|
-
|
|
1894
|
-
<dl>
|
|
1895
|
-
<dd>
|
|
1896
|
-
|
|
1897
|
-
<dl>
|
|
1898
|
-
<dd>
|
|
1899
|
-
|
|
1900
|
-
Returns the org for a scoped token. The token is limited to one organization.
|
|
1901
|
-
</dd>
|
|
1902
|
-
</dl>
|
|
1903
|
-
</dd>
|
|
1904
|
-
</dl>
|
|
1905
|
-
|
|
1906
|
-
#### 🔌 Usage
|
|
1907
|
-
|
|
1908
|
-
<dl>
|
|
1909
|
-
<dd>
|
|
1910
|
-
|
|
1911
|
-
<dl>
|
|
1912
|
-
<dd>
|
|
1913
|
-
|
|
1914
|
-
```typescript
|
|
1915
|
-
await client.organization.getMyOrganizationFromScopedToken();
|
|
1916
|
-
|
|
1917
|
-
```
|
|
1918
|
-
</dd>
|
|
1919
|
-
</dl>
|
|
1920
|
-
</dd>
|
|
1921
|
-
</dl>
|
|
1922
|
-
|
|
1923
|
-
#### ⚙️ Parameters
|
|
1924
|
-
|
|
1925
|
-
<dl>
|
|
1926
|
-
<dd>
|
|
1927
|
-
|
|
1928
|
-
<dl>
|
|
1929
|
-
<dd>
|
|
1930
|
-
|
|
1931
|
-
**request:** `FernVenusApi.GetMyOrganizationFromScopedTokenOrganizationsMyselfPostRequest`
|
|
1932
|
-
|
|
1933
|
-
</dd>
|
|
1934
|
-
</dl>
|
|
1935
|
-
|
|
1936
|
-
<dl>
|
|
1937
|
-
<dd>
|
|
1938
|
-
|
|
1939
|
-
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
1940
|
-
|
|
1941
|
-
</dd>
|
|
1942
|
-
</dl>
|
|
1943
|
-
</dd>
|
|
1944
|
-
</dl>
|
|
1945
|
-
|
|
1946
|
-
|
|
1947
|
-
</dd>
|
|
1948
|
-
</dl>
|
|
1949
|
-
</details>
|
|
1950
|
-
|
|
1951
|
-
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">getOrgIdsFromToken</a>() -> core.APIResponse<string[], FernVenusApi.organization.getOrgIdsFromToken.Error></code></summary>
|
|
1952
|
-
<dl>
|
|
1953
|
-
<dd>
|
|
1954
|
-
|
|
1955
|
-
#### 🔌 Usage
|
|
1956
|
-
|
|
1957
|
-
<dl>
|
|
1958
|
-
<dd>
|
|
1959
|
-
|
|
1960
|
-
<dl>
|
|
1961
|
-
<dd>
|
|
1962
|
-
|
|
1963
|
-
```typescript
|
|
1964
|
-
await client.organization.getOrgIdsFromToken();
|
|
1965
|
-
|
|
1966
|
-
```
|
|
1967
|
-
</dd>
|
|
1968
|
-
</dl>
|
|
1969
|
-
</dd>
|
|
1970
|
-
</dl>
|
|
1971
|
-
|
|
1972
|
-
#### ⚙️ Parameters
|
|
1973
|
-
|
|
1974
|
-
<dl>
|
|
1975
|
-
<dd>
|
|
1976
|
-
|
|
1977
|
-
<dl>
|
|
1978
|
-
<dd>
|
|
1979
|
-
|
|
1980
|
-
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
1981
|
-
|
|
1982
|
-
</dd>
|
|
1983
|
-
</dl>
|
|
1984
|
-
</dd>
|
|
1985
|
-
</dl>
|
|
1986
|
-
|
|
1987
|
-
|
|
1988
|
-
</dd>
|
|
1989
|
-
</dl>
|
|
1990
|
-
</details>
|
|
1991
|
-
|
|
1992
|
-
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">addUser</a>({ ...params }) -> core.APIResponse<void, FernVenusApi.organization.addUser.Error></code></summary>
|
|
1993
|
-
<dl>
|
|
1994
|
-
<dd>
|
|
1995
|
-
|
|
1996
|
-
#### 🔌 Usage
|
|
1997
|
-
|
|
1998
|
-
<dl>
|
|
1999
|
-
<dd>
|
|
2000
|
-
|
|
2001
|
-
<dl>
|
|
2002
|
-
<dd>
|
|
2003
|
-
|
|
2004
|
-
```typescript
|
|
2005
|
-
await client.organization.addUser({
|
|
2006
|
-
userId: "userId",
|
|
2007
|
-
orgId: "orgId"
|
|
2008
|
-
});
|
|
2009
|
-
|
|
2010
|
-
```
|
|
2011
|
-
</dd>
|
|
2012
|
-
</dl>
|
|
2013
|
-
</dd>
|
|
2014
|
-
</dl>
|
|
2015
|
-
|
|
2016
|
-
#### ⚙️ Parameters
|
|
2017
|
-
|
|
2018
|
-
<dl>
|
|
2019
|
-
<dd>
|
|
2020
|
-
|
|
2021
|
-
<dl>
|
|
2022
|
-
<dd>
|
|
2023
|
-
|
|
2024
|
-
**request:** `FernVenusApi.AddUserToOrgRequest`
|
|
2025
|
-
|
|
2026
|
-
</dd>
|
|
2027
|
-
</dl>
|
|
2028
|
-
|
|
2029
|
-
<dl>
|
|
2030
|
-
<dd>
|
|
2031
|
-
|
|
2032
|
-
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
2033
|
-
|
|
2034
|
-
</dd>
|
|
2035
|
-
</dl>
|
|
2036
|
-
</dd>
|
|
2037
|
-
</dl>
|
|
2038
|
-
|
|
2039
|
-
|
|
2040
|
-
</dd>
|
|
2041
|
-
</dl>
|
|
2042
|
-
</details>
|
|
2043
|
-
|
|
2044
|
-
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">inviteUser</a>({ ...params }) -> core.APIResponse<void, FernVenusApi.organization.inviteUser.Error></code></summary>
|
|
2045
|
-
<dl>
|
|
2046
|
-
<dd>
|
|
2047
|
-
|
|
2048
|
-
#### 🔌 Usage
|
|
2049
|
-
|
|
2050
|
-
<dl>
|
|
2051
|
-
<dd>
|
|
2052
|
-
|
|
2053
|
-
<dl>
|
|
2054
|
-
<dd>
|
|
2055
|
-
|
|
2056
|
-
```typescript
|
|
2057
|
-
await client.organization.inviteUser({
|
|
2058
|
-
emailAddress: "emailAddress",
|
|
2059
|
-
auth0OrgId: "auth0OrgId"
|
|
2060
|
-
});
|
|
2061
|
-
|
|
2062
|
-
```
|
|
2063
|
-
</dd>
|
|
2064
|
-
</dl>
|
|
2065
|
-
</dd>
|
|
2066
|
-
</dl>
|
|
2067
|
-
|
|
2068
|
-
#### ⚙️ Parameters
|
|
2069
|
-
|
|
2070
|
-
<dl>
|
|
2071
|
-
<dd>
|
|
2072
|
-
|
|
2073
|
-
<dl>
|
|
2074
|
-
<dd>
|
|
2075
|
-
|
|
2076
|
-
**request:** `FernVenusApi.InviteUserToOrgRequest`
|
|
2077
|
-
|
|
2078
|
-
</dd>
|
|
2079
|
-
</dl>
|
|
2080
|
-
|
|
2081
|
-
<dl>
|
|
2082
|
-
<dd>
|
|
2083
|
-
|
|
2084
|
-
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
2085
|
-
|
|
2086
|
-
</dd>
|
|
2087
|
-
</dl>
|
|
2088
|
-
</dd>
|
|
2089
|
-
</dl>
|
|
2090
|
-
|
|
2091
|
-
|
|
2092
|
-
</dd>
|
|
2093
|
-
</dl>
|
|
2094
|
-
</details>
|
|
2095
|
-
|
|
2096
|
-
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">removeUser</a>({ ...params }) -> core.APIResponse<void, FernVenusApi.organization.removeUser.Error></code></summary>
|
|
2097
|
-
<dl>
|
|
2098
|
-
<dd>
|
|
2099
|
-
|
|
2100
|
-
#### 🔌 Usage
|
|
2101
|
-
|
|
2102
|
-
<dl>
|
|
2103
|
-
<dd>
|
|
2104
|
-
|
|
2105
|
-
<dl>
|
|
2106
|
-
<dd>
|
|
2107
|
-
|
|
2108
|
-
```typescript
|
|
2109
|
-
await client.organization.removeUser({
|
|
2110
|
-
userId: "userId",
|
|
2111
|
-
auth0OrgId: "auth0OrgId"
|
|
2112
|
-
});
|
|
2113
|
-
|
|
2114
|
-
```
|
|
2115
|
-
</dd>
|
|
2116
|
-
</dl>
|
|
2117
|
-
</dd>
|
|
2118
|
-
</dl>
|
|
2119
|
-
|
|
2120
|
-
#### ⚙️ Parameters
|
|
2121
|
-
|
|
2122
|
-
<dl>
|
|
2123
|
-
<dd>
|
|
2124
|
-
|
|
2125
|
-
<dl>
|
|
2126
|
-
<dd>
|
|
2127
|
-
|
|
2128
|
-
**request:** `FernVenusApi.RemoveUserFromOrgRequest`
|
|
1309
|
+
**request:** `FernVenusApi.RemoveUserFromOrgRequest`
|
|
2129
1310
|
|
|
2130
1311
|
</dd>
|
|
2131
1312
|
</dl>
|
|
@@ -2455,181 +1636,6 @@ await client.user.linkAccounts({
|
|
|
2455
1636
|
</dl>
|
|
2456
1637
|
|
|
2457
1638
|
|
|
2458
|
-
</dd>
|
|
2459
|
-
</dl>
|
|
2460
|
-
</details>
|
|
2461
|
-
|
|
2462
|
-
## InternalGuestSession
|
|
2463
|
-
<details><summary><code>client.internalGuestSession.<a href="/src/api/resources/internalGuestSession/client/Client.ts">readByOrg</a>({ ...params }) -> core.APIResponse<FernVenusApi.InternalGuestSessionResponse, FernVenusApi.internalGuestSession.readByOrg.Error></code></summary>
|
|
2464
|
-
<dl>
|
|
2465
|
-
<dd>
|
|
2466
|
-
|
|
2467
|
-
#### 📝 Description
|
|
2468
|
-
|
|
2469
|
-
<dl>
|
|
2470
|
-
<dd>
|
|
2471
|
-
|
|
2472
|
-
<dl>
|
|
2473
|
-
<dd>
|
|
2474
|
-
|
|
2475
|
-
The session behind a guest organization, for the service holding
|
|
2476
|
-
its work. This is the read the pull model in ``guest_resources`` rests
|
|
2477
|
-
on: FDR and Fiddle know the ``guest-<id>`` org their rows belong to, not
|
|
2478
|
-
the session ID, token or claim secret, so this is keyed by the org and
|
|
2479
|
-
opened by the service credential alone.
|
|
2480
|
-
</dd>
|
|
2481
|
-
</dl>
|
|
2482
|
-
</dd>
|
|
2483
|
-
</dl>
|
|
2484
|
-
|
|
2485
|
-
#### 🔌 Usage
|
|
2486
|
-
|
|
2487
|
-
<dl>
|
|
2488
|
-
<dd>
|
|
2489
|
-
|
|
2490
|
-
<dl>
|
|
2491
|
-
<dd>
|
|
2492
|
-
|
|
2493
|
-
```typescript
|
|
2494
|
-
await client.internalGuestSession.readByOrg({
|
|
2495
|
-
orgId: "org_id"
|
|
2496
|
-
});
|
|
2497
|
-
|
|
2498
|
-
```
|
|
2499
|
-
</dd>
|
|
2500
|
-
</dl>
|
|
2501
|
-
</dd>
|
|
2502
|
-
</dl>
|
|
2503
|
-
|
|
2504
|
-
#### ⚙️ Parameters
|
|
2505
|
-
|
|
2506
|
-
<dl>
|
|
2507
|
-
<dd>
|
|
2508
|
-
|
|
2509
|
-
<dl>
|
|
2510
|
-
<dd>
|
|
2511
|
-
|
|
2512
|
-
**request:** `FernVenusApi.ReadByOrgInternalGuestSessionsByOrgOrgIdGetRequest`
|
|
2513
|
-
|
|
2514
|
-
</dd>
|
|
2515
|
-
</dl>
|
|
2516
|
-
|
|
2517
|
-
<dl>
|
|
2518
|
-
<dd>
|
|
2519
|
-
|
|
2520
|
-
**requestOptions:** `InternalGuestSessionClient.RequestOptions`
|
|
2521
|
-
|
|
2522
|
-
</dd>
|
|
2523
|
-
</dl>
|
|
2524
|
-
</dd>
|
|
2525
|
-
</dl>
|
|
2526
|
-
|
|
2527
|
-
|
|
2528
|
-
</dd>
|
|
2529
|
-
</dl>
|
|
2530
|
-
</details>
|
|
2531
|
-
|
|
2532
|
-
<details><summary><code>client.internalGuestSession.<a href="/src/api/resources/internalGuestSession/client/Client.ts">reserve</a>({ ...params }) -> core.APIResponse<FernVenusApi.ReserveResponse, FernVenusApi.internalGuestSession.reserve.Error></code></summary>
|
|
2533
|
-
<dl>
|
|
2534
|
-
<dd>
|
|
2535
|
-
|
|
2536
|
-
#### 🔌 Usage
|
|
2537
|
-
|
|
2538
|
-
<dl>
|
|
2539
|
-
<dd>
|
|
2540
|
-
|
|
2541
|
-
<dl>
|
|
2542
|
-
<dd>
|
|
2543
|
-
|
|
2544
|
-
```typescript
|
|
2545
|
-
await client.internalGuestSession.reserve({
|
|
2546
|
-
sessionId: "session_id",
|
|
2547
|
-
kind: "sdkBuild"
|
|
2548
|
-
});
|
|
2549
|
-
|
|
2550
|
-
```
|
|
2551
|
-
</dd>
|
|
2552
|
-
</dl>
|
|
2553
|
-
</dd>
|
|
2554
|
-
</dl>
|
|
2555
|
-
|
|
2556
|
-
#### ⚙️ Parameters
|
|
2557
|
-
|
|
2558
|
-
<dl>
|
|
2559
|
-
<dd>
|
|
2560
|
-
|
|
2561
|
-
<dl>
|
|
2562
|
-
<dd>
|
|
2563
|
-
|
|
2564
|
-
**request:** `FernVenusApi.ReserveRequest`
|
|
2565
|
-
|
|
2566
|
-
</dd>
|
|
2567
|
-
</dl>
|
|
2568
|
-
|
|
2569
|
-
<dl>
|
|
2570
|
-
<dd>
|
|
2571
|
-
|
|
2572
|
-
**requestOptions:** `InternalGuestSessionClient.RequestOptions`
|
|
2573
|
-
|
|
2574
|
-
</dd>
|
|
2575
|
-
</dl>
|
|
2576
|
-
</dd>
|
|
2577
|
-
</dl>
|
|
2578
|
-
|
|
2579
|
-
|
|
2580
|
-
</dd>
|
|
2581
|
-
</dl>
|
|
2582
|
-
</details>
|
|
2583
|
-
|
|
2584
|
-
<details><summary><code>client.internalGuestSession.<a href="/src/api/resources/internalGuestSession/client/Client.ts">settle</a>({ ...params }) -> core.APIResponse<FernVenusApi.SettleResponse, FernVenusApi.internalGuestSession.settle.Error></code></summary>
|
|
2585
|
-
<dl>
|
|
2586
|
-
<dd>
|
|
2587
|
-
|
|
2588
|
-
#### 🔌 Usage
|
|
2589
|
-
|
|
2590
|
-
<dl>
|
|
2591
|
-
<dd>
|
|
2592
|
-
|
|
2593
|
-
<dl>
|
|
2594
|
-
<dd>
|
|
2595
|
-
|
|
2596
|
-
```typescript
|
|
2597
|
-
await client.internalGuestSession.settle({
|
|
2598
|
-
sessionId: "session_id",
|
|
2599
|
-
reservationId: "reservationId",
|
|
2600
|
-
outcome: "succeeded"
|
|
2601
|
-
});
|
|
2602
|
-
|
|
2603
|
-
```
|
|
2604
|
-
</dd>
|
|
2605
|
-
</dl>
|
|
2606
|
-
</dd>
|
|
2607
|
-
</dl>
|
|
2608
|
-
|
|
2609
|
-
#### ⚙️ Parameters
|
|
2610
|
-
|
|
2611
|
-
<dl>
|
|
2612
|
-
<dd>
|
|
2613
|
-
|
|
2614
|
-
<dl>
|
|
2615
|
-
<dd>
|
|
2616
|
-
|
|
2617
|
-
**request:** `FernVenusApi.SettleRequest`
|
|
2618
|
-
|
|
2619
|
-
</dd>
|
|
2620
|
-
</dl>
|
|
2621
|
-
|
|
2622
|
-
<dl>
|
|
2623
|
-
<dd>
|
|
2624
|
-
|
|
2625
|
-
**requestOptions:** `InternalGuestSessionClient.RequestOptions`
|
|
2626
|
-
|
|
2627
|
-
</dd>
|
|
2628
|
-
</dl>
|
|
2629
|
-
</dd>
|
|
2630
|
-
</dl>
|
|
2631
|
-
|
|
2632
|
-
|
|
2633
1639
|
</dd>
|
|
2634
1640
|
</dl>
|
|
2635
1641
|
</details>
|