@affinidi/cli 2.12.0 → 2.14.0

package/dist/services/affinidi/iam/iam.api.d.ts

@@ -1,475 +0,0 @@
-export interface ServiceErrorResponse {
-    /**
-     * unique id for correlating this specific error to logs
-     * @format uuid
-     */
-    debugId: string;
-    /** name of the error */
-    name: string;
-    /** backwards compatible Affinidi error code */
-    code: string;
-    details?: {
-        issue: string;
-        field?: string;
-        value?: string;
-        location?: string;
-    }[];
-}
-export interface UserDto {
-    principalId: string;
-}
-export interface TypedPricipalId {
-    principalId: string;
-}
-export interface AddUserToProjectInput {
-    principalId: string;
-    principalType: string;
-}
-export interface CreateProjectScopedTokenInput {
-    projectId: string;
-}
-export interface CreateProjectScopedTokenOutput {
-    accessToken: string;
-    expiresIn: number;
-    scope: string;
-}
-export interface ProjectDto {
-    id: string;
-    name: string;
-    description?: string;
-    /** creation date and time in ISO-8601 format, e.g. 2023-09-20T07:12:13 */
-    createdAt?: string;
-}
-export interface CreateProjectInput {
-    name: string;
-    description?: string;
-}
-export interface UpdateProjectInput {
-    id: string;
-    name?: string;
-    description?: string;
-}
-export interface ProjectList {
-    projects: ProjectDto[];
-}
-export interface UserList {
-    records: UserDto[];
-}
-export interface PolicyStatementDto {
-    action: string[];
-    effect: string;
-    principal: string[];
-    resource: string[];
-}
-export interface WhoamiDto {
-    principalId: string;
-    principalType: string;
-}
-export interface PolicyDto {
-    principalId?: string;
-    projectId?: string;
-    version: string;
-    statement: PolicyStatementDto[];
-}
-export interface JsonWebKeyDto {
-    kid: string;
-    kty: string;
-    n?: string;
-    e?: string;
-    x?: string;
-    y?: string;
-    crv?: string;
-    alg: string;
-    use: string;
-}
-export interface JsonWebKeySetDto {
-    /** @minItems 1 */
-    keys: JsonWebKeyDto[];
-}
-/**
- * Private Key JWT Authentication of Client with `private_key_jwt` oAuth Method
- * @example "{"type": "PRIVATE_KEY", "signingAlgorithm": "RS256", "publicKeyInfo": { "jwks": {"keys":[{"use":"sig","kty":"RSA","kid":"some-kid","alg":"RS256","n":"some-n-value","e":"some-e-value"}]} }}"
- */
-export interface TokenPrivateKeyAuthenticationMethodDto {
-    type: 'PRIVATE_KEY';
-    signingAlgorithm: 'RS256' | 'RS512' | 'ES256' | 'ES512';
-    /** Corresponding Public Key Info provided either as a URL or a Hardcoded Object */
-    publicKeyInfo: {
-        jwks: JsonWebKeySetDto;
-    } | {
-        /** @format url */
-        jwksUri: string;
-    };
-}
-/** How the Token will be authenticate against our Authorization Server */
-export type TokenAuthenticationMethodDto = TokenPrivateKeyAuthenticationMethodDto;
-export interface TokenDto {
-    /**
-     * Token Id
-     * @format uuid
-     * @example "c5817ea6-8367-4458-9131-54cd2c5b9b48"
-     */
-    id: string;
-    /**
-     * Token ARI
-     * @example "token/c5817ea6-8367-4458-9131-54cd2c5b9b48"
-     */
-    ari: string;
-    /**
-     * The Token owner's ARI
-     * @example "ari:iam:::user/2f4b3468-516f-4af3-87db-8816b0d320cc"
-     */
-    ownerAri: string;
-    /**
-     * Owner defined Token display name
-     * @example "AIV/Concierge API - affinidi-elements-iam-dev"
-     */
-    name: string;
-    /** How the Token will be authenticate against our Authorization Server */
-    authenticationMethod: TokenAuthenticationMethodDto;
-    /** Scopes that will be assigned to the Token on authentication */
-    scopes: string[];
-}
-export interface TokenList {
-    tokens: TokenDto[];
-}
-export interface CreateTokenInput {
-    /**
-     * @pattern .{3,}
-     * @example "AIV/Concierge API - affinidi-elements-iam-dev"
-     */
-    name: string;
-    /** How the Token will be authenticate against our Authorization Server */
-    authenticationMethod: TokenAuthenticationMethodDto;
-}
-export interface UpdateTokenInput {
-    /**
-     * @pattern .{3,}
-     * @example "AIV/Concierge API - affinidi-elements-iam-dev"
-     */
-    name: string;
-    /** How the Token will be authenticate against our Authorization Server */
-    authenticationMethod: TokenAuthenticationMethodDto;
-}
-export interface UnexpectedError {
-    name: 'UnexpectedError';
-    message: 'Unexpected Error Occurred.';
-    httpStatusCode: 500;
-    traceId: string;
-    details?: {
-        issue: string;
-        field?: string;
-        value?: string;
-        location?: string;
-    }[];
-}
-export interface InvalidParameterError {
-    name: 'InvalidParameterError';
-    message: 'Invalid parameter: ${param}.';
-    httpStatusCode: 400;
-    traceId: string;
-    details?: {
-        issue: string;
-        field?: string;
-        value?: string;
-        location?: string;
-    }[];
-}
-export interface NotFoundError {
-    name: 'NotFoundError';
-    message: 'Not found: ${param}.';
-    httpStatusCode: 404;
-    traceId: string;
-    details?: {
-        issue: string;
-        field?: string;
-        value?: string;
-        location?: string;
-    }[];
-}
-export interface PrincipalDoesNotBelongToProjectError {
-    name: 'PrincipalDoesNotBelongToProjectError';
-    message: 'Principal does not belong to the given project';
-    httpStatusCode: 403;
-    traceId: string;
-    details?: {
-        issue: string;
-        field?: string;
-        value?: string;
-        location?: string;
-    }[];
-}
-export interface ActionForbiddenError {
-    name: 'ActionForbiddenError';
-    message: 'Principal can not execute action on given resource';
-    httpStatusCode: 403;
-    traceId: string;
-    details?: {
-        issue: string;
-        field?: string;
-        value?: string;
-        location?: string;
-    }[];
-}
-export interface ConsumerAuthTokenEndpointInput {
-    grant_type: string;
-    code?: string;
-    refresh_token?: string;
-    redirect_uri?: string;
-    client_id?: string;
-    [key: string]: any;
-}
-export interface ConsumerAuthTokenEndpointOutput {
-    /** The access token issued by the authorization server. */
-    access_token?: string;
-    /**
-     * The lifetime in seconds of the access token. For
-     * example, the value "3600" denotes that the access token will
-     * expire in one hour from the time the response was generated.
-     * @format int64
-     */
-    expires_in?: number;
-    /**
-     * To retrieve a refresh token request the id_token scope.
-     * @format int64
-     */
-    id_token?: number;
-    /**
-     * The refresh token, which can be used to obtain new
-     * access tokens. To retrieve it add the scope "offline" to your access token request.
-     */
-    refresh_token?: string;
-    /** The scope of the access token */
-    scope?: string;
-    /** The type of the token issued */
-    token_type?: string;
-}
-export interface InvalidJwtTokenError {
-    name: 'InvalidJwtTokenError';
-    message: 'JWT token is invalid';
-    httpStatusCode: 401;
-    traceId: string;
-    details?: {
-        issue: string;
-        field?: string;
-        value?: string;
-        location?: string;
-    }[];
-}
-export interface UnauthorizedError {
-    name: 'UnauthorizedError';
-    message: 'Unauthorized';
-    httpStatusCode: 403;
-    traceId: string;
-    details?: {
-        issue: string;
-        field?: string;
-        value?: string;
-        location?: string;
-    }[];
-}
-import { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from 'axios';
-export type QueryParamsType = Record<string | number, any>;
-export interface FullRequestParams extends Omit<AxiosRequestConfig, 'data' | 'params' | 'url' | 'responseType'> {
-    /** set parameter to `true` for call `securityWorker` for this request */
-    secure?: boolean;
-    /** request path */
-    path: string;
-    /** content type of request body */
-    type?: ContentType;
-    /** query params */
-    query?: QueryParamsType;
-    /** format of response (i.e. response.json() -> format: "json") */
-    format?: ResponseType;
-    /** request body */
-    body?: unknown;
-}
-export type RequestParams = Omit<FullRequestParams, 'body' | 'method' | 'query' | 'path'>;
-export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequestConfig, 'data' | 'cancelToken'> {
-    securityWorker?: (securityData: SecurityDataType | null) => Promise<AxiosRequestConfig | void> | AxiosRequestConfig | void;
-    secure?: boolean;
-    format?: ResponseType;
-}
-export declare enum ContentType {
-    Json = "application/json",
-    FormData = "multipart/form-data",
-    UrlEncoded = "application/x-www-form-urlencoded",
-    Text = "text/plain"
-}
-export declare class HttpClient<SecurityDataType = unknown> {
-    instance: AxiosInstance;
-    private securityData;
-    private securityWorker?;
-    private secure?;
-    private format?;
-    constructor({ securityWorker, secure, format, ...axiosConfig }?: ApiConfig<SecurityDataType>);
-    setSecurityData: (data: SecurityDataType | null) => void;
-    protected mergeRequestParams(params1: AxiosRequestConfig, params2?: AxiosRequestConfig): AxiosRequestConfig;
-    protected stringifyFormItem(formItem: unknown): string;
-    protected createFormData(input: Record<string, unknown>): FormData;
-    request: <T = any, _E = any>({ secure, path, type, query, format, body, ...params }: FullRequestParams) => Promise<AxiosResponse<T>>;
-}
-/**
- * @title Iam
- * @version 1.0.0
- * @baseUrl /
- * @contact nucleus <nucleus.team@affinidi.com>
- *
- * Affinidi IAM
- */
-export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
-    wellKnown: {
-        /**
-         * No description
-         *
-         * @tags well-known
-         * @name GetWellKnownJwks
-         * @request GET:/.well-known/jwks.json
-         */
-        getWellKnownJwks: (params?: RequestParams) => Promise<AxiosResponse<JsonWebKeySetDto, any>>;
-    };
-    v1: {
-        /**
-         * No description
-         *
-         * @tags sts
-         * @name CreateProjectScopedToken
-         * @request POST:/v1/sts/create-project-scoped-token
-         * @secure
-         */
-        createProjectScopedToken: (data: CreateProjectScopedTokenInput, params?: RequestParams) => Promise<AxiosResponse<CreateProjectScopedTokenOutput, any>>;
-        /**
-         * No description
-         *
-         * @tags sts
-         * @name Whoami
-         * @request GET:/v1/sts/whoami
-         * @secure
-         */
-        whoami: (params?: RequestParams) => Promise<AxiosResponse<WhoamiDto, any>>;
-        /**
-         * No description
-         *
-         * @tags projects
-         * @name CreateProject
-         * @request POST:/v1/projects
-         * @secure
-         */
-        createProject: (data: CreateProjectInput, params?: RequestParams) => Promise<AxiosResponse<ProjectDto, any>>;
-        /**
-         * No description
-         *
-         * @tags projects
-         * @name ListProject
-         * @request GET:/v1/projects
-         * @secure
-         */
-        listProject: (params?: RequestParams) => Promise<AxiosResponse<ProjectList, any>>;
-        /**
-         * No description
-         *
-         * @tags projects
-         * @name ListPrincipalsOfProject
-         * @request GET:/v1/projects/principals
-         * @secure
-         */
-        listPrincipalsOfProject: (params?: RequestParams) => Promise<AxiosResponse<UserList, any>>;
-        /**
-         * No description
-         *
-         * @tags projects
-         * @name AddPrincipalToProject
-         * @request POST:/v1/projects/principals
-         * @secure
-         */
-        addPrincipalToProject: (data: AddUserToProjectInput, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
-        /**
-         * No description
-         *
-         * @tags projects
-         * @name DeletePrincipalFromProject
-         * @request DELETE:/v1/projects/principals/{principalId}
-         * @secure
-         */
-        deletePrincipalFromProject: (principalId: string, query: {
-            /** type of principal */
-            principalType: "user" | "token";
-        }, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
-        /**
-         * No description
-         *
-         * @tags policies
-         * @name GetPolicies
-         * @request GET:/v1/policies/principals/{principalId}
-         * @secure
-         */
-        getPolicies: (principalId: string, query: {
-            principalType: "user" | "token";
-        }, params?: RequestParams) => Promise<AxiosResponse<PolicyDto, any>>;
-        /**
-         * No description
-         *
-         * @tags policies
-         * @name UpdatePolicies
-         * @request PUT:/v1/policies/principals/{principalId}
-         * @secure
-         */
-        updatePolicies: (principalId: string, query: {
-            principalType: "user" | "token";
-        }, data: PolicyDto, params?: RequestParams) => Promise<AxiosResponse<PolicyDto, any>>;
-        /**
-         * No description
-         *
-         * @tags tokens
-         * @name CreateToken
-         * @request POST:/v1/tokens
-         * @secure
-         */
-        createToken: (data: CreateTokenInput, params?: RequestParams) => Promise<AxiosResponse<TokenDto, any>>;
-        /**
-         * No description
-         *
-         * @tags tokens
-         * @name ListToken
-         * @request GET:/v1/tokens
-         * @secure
-         */
-        listToken: (params?: RequestParams) => Promise<AxiosResponse<TokenList, any>>;
-        /**
-         * No description
-         *
-         * @tags tokens
-         * @name GetToken
-         * @request GET:/v1/tokens/{tokenId}
-         * @secure
-         */
-        getToken: (tokenId: string, params?: RequestParams) => Promise<AxiosResponse<TokenDto, any>>;
-        /**
-         * No description
-         *
-         * @tags tokens
-         * @name UpdateToken
-         * @request PATCH:/v1/tokens/{tokenId}
-         * @secure
-         */
-        updateToken: (tokenId: string, data: UpdateTokenInput, params?: RequestParams) => Promise<AxiosResponse<TokenDto, any>>;
-        /**
-         * No description
-         *
-         * @tags tokens
-         * @name DeleteToken
-         * @request DELETE:/v1/tokens/{tokenId}
-         * @secure
-         */
-        deleteToken: (tokenId: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
-        /**
-         * @description Use open source libraries to perform OAuth 2.0 and OpenID Connect available for any programming language. You can find a list of libraries here https://oauth.net/code/ The Ory SDK is not yet able to this endpoint properly.
-         *
-         * @tags consumerAuth
-         * @name ConsumerAuthTokenEndpoint
-         * @summary The Consumer OAuth 2.0 Token Endpoint
-         * @request POST:/v1/consumer/oauth2/token
-         */
-        consumerAuthTokenEndpoint: (data: ConsumerAuthTokenEndpointInput, params?: RequestParams) => Promise<AxiosResponse<ConsumerAuthTokenEndpointOutput, any>>;
-    };
-}