Class CorporationProjectsClient

The base of the custom domain clients: an endpoint map turned into methods, plus the stream*/fetchAll* page helpers and withMetadata/withSafeMode. Extend it for a custom domain client of your own.

Hierarchy (View Summary)

BaseEsiClient<typeof corporationProjectEndpoints>
- CorporationProjectsClient

Index

Constructors

constructor

new CorporationProjectsClient(client: ApiClient): CorporationProjectsClient
Parameters
- client: ApiClient
Returns CorporationProjectsClient
Overrides BaseEsiClient.constructor
- Defined in src/clients/CorporationProjectsClient.ts:14

Properties

`Protected`api

api: ClientMethods<T>

`Protected`_client

_client: ApiClient

`Protected`_endpoints

_endpoints: {
    getCorporationProjects: {
        path: "corporations/{corporationId}/projects";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["corporationId"];
        queryParams: { before: "before"; after: "after" };
        responseSchema: ZodObject<
            {
                cursor: ZodOptional<
                    ZodObject<
                        { before: ZodOptional<ZodString>; after: ZodOptional<ZodString> },
                        $loose,
                    >,
                >;
                projects: ZodArray<
                    ZodObject<
                        {
                            id: ZodString;
                            name: ZodString;
                            state: ZodType<
                                | string & {}
                                | "Unspecified"
                                | "Active"
                                | "Closed"
                                | "Completed"
                                | "Expired"
                                | "Deleted",
                                unknown,
                                $ZodTypeInternals<
                                    | (...) & (...)
                                    | "Unspecified"
                                    | "Active"
                                    | "Closed"
                                    | "Completed"
                                    | "Expired"
                                    | "Deleted",
                                    unknown,
                                >,
                            >;
                            last_modified: ZodString;
                            progress: ZodObject<
                                { current: ZodNumber; desired: ZodNumber },
                                $loose,
                            >;
                            reward: ZodOptional<
                                ZodObject<{ initial: ZodNumber; remaining: ZodNumber }, $loose>,
                            >;
                        },
                        $loose,
                    >,
                >;
            },
            $loose,
        >;
    };
    getCorporationProject: {
        path: "corporations/{corporationId}/projects/{projectId}";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["corporationId", "projectId"];
        responseSchema: ZodObject<
            {
                id: ZodString;
                name: ZodString;
                state: ZodType<
                    | string & {}
                    | "Unspecified"
                    | "Active"
                    | "Closed"
                    | "Completed"
                    | "Expired"
                    | "Deleted",
                    unknown,
                    $ZodTypeInternals<
                        | string & {}
                        | "Unspecified"
                        | "Active"
                        | "Closed"
                        | "Completed"
                        | "Expired"
                        | "Deleted",
                        unknown,
                    >,
                >;
                last_modified: ZodString;
                progress: ZodObject<{ current: ZodNumber; desired: ZodNumber }, $loose>;
                reward: ZodOptional<
                    ZodObject<{ initial: ZodNumber; remaining: ZodNumber }, $loose>,
                >;
                creator: ZodObject<{ id: ZodNumber; name: ZodString }, $loose>;
                details: ZodObject<
                    {
                        career: ZodType<
                            | string & {}
                            | "Unspecified"
                            | "Explorer"
                            | "Industrialist"
                            | "Enforcer"
                            | "Soldier of Fortune",
                            unknown,
                            $ZodTypeInternals<
                                | string & {}
                                | "Unspecified"
                                | "Explorer"
                                | "Industrialist"
                                | "Enforcer"
                                | "Soldier of Fortune",
                                unknown,
                            >,
                        >;
                        created: ZodString;
                        description: ZodString;
                        expires: ZodOptional<ZodString>;
                        finished: ZodOptional<ZodString>;
                    },
                    $loose,
                >;
                configuration: ZodRecord<ZodString, ZodUnknown>;
                contribution: ZodOptional<
                    ZodObject<
                        {
                            participation_limit: ZodOptional<ZodNumber>;
                            reward_per_contribution: ZodOptional<ZodNumber>;
                            submission_limit: ZodOptional<ZodNumber>;
                            submission_multiplier: ZodOptional<ZodNumber>;
                        },
                        $loose,
                    >,
                >;
            },
            $loose,
        >;
    };
    getCorporationProjectContribution: {
        path: "corporations/{corporationId}/projects/{projectId}/contribution/{characterId}";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["corporationId", "projectId", "characterId"];
        responseSchema: ZodObject<
            { contributed: ZodNumber; last_modified: ZodOptional<ZodString> },
            $loose,
        >;
    };
    getCorporationProjectContributors: {
        path: "corporations/{corporationId}/projects/{projectId}/contributors";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["corporationId", "projectId"];
        queryParams: { before: "before"; after: "after" };
        responseSchema: ZodObject<
            {
                contributors: ZodArray<
                    ZodObject<
                        { id: ZodNumber; name: ZodString; contributed: ZodNumber },
                        $loose,
                    >,
                >;
                cursor: ZodOptional<
                    ZodObject<
                        { before: ZodOptional<ZodString>; after: ZodOptional<ZodString> },
                        $loose,
                    >,
                >;
            },
            $loose,
        >;
    };
}

Methods

streamEndpoint

streamEndpoint<R>(
    endpointName:
        | "getCorporationProjects"
        | "getCorporationProject"
        | "getCorporationProjectContribution"
        | "getCorporationProjectContributors",
    ...args: unknown[],
): AsyncGenerator<PageResult<R>, void, undefined>
Type Parameters
- R
Parameters
- endpointName:
      | "getCorporationProjects"
      | "getCorporationProject"
      | "getCorporationProjectContribution"
      | "getCorporationProjectContributors"
- ...args: unknown[]
Returns AsyncGenerator<PageResult<R>, void, undefined>
Inherited from BaseEsiClient.streamEndpoint
- Defined in src/clients/BaseEsiClient.ts:45

fetchAllEndpoint

fetchAllEndpoint<R>(
    endpointName:
        | "getCorporationProjects"
        | "getCorporationProject"
        | "getCorporationProjectContribution"
        | "getCorporationProjectContributors",
    args: unknown[],
    concurrency?: number,
): Promise<R[]>
Type Parameters
- R
Parameters
- endpointName:
      | "getCorporationProjects"
      | "getCorporationProject"
      | "getCorporationProjectContribution"
      | "getCorporationProjectContributors"
- args: unknown[]
- Optionalconcurrency: number
Returns Promise<R[]>
Inherited from BaseEsiClient.fetchAllEndpoint
- Defined in src/clients/BaseEsiClient.ts:71

withMetadata

withMetadata(): WithMetadata<Omit<this, "withMetadata" | "withSafeMode">>
Returns WithMetadata<Omit<this, "withMetadata" | "withSafeMode">>
Inherited from BaseEsiClient.withMetadata
- Defined in src/clients/BaseEsiClient.ts:99

withSafeMode

withSafeMode(): WithSafeMode<Omit<this, "withMetadata" | "withSafeMode">>
Returns WithSafeMode<Omit<this, "withMetadata" | "withSafeMode">>
Inherited from BaseEsiClient.withSafeMode
- Defined in src/clients/BaseEsiClient.ts:110

getCorporationProjects

getCorporationProjects(
    corporationId: number,
    before?: string,
    after?: string,
): Promise<
    {
        cursor?: { before?: string; after?: string; [key: string]: unknown };
        projects: {
            id: string;
            name: string;
            state:
                | string & {}
                | "Unspecified"
                | "Active"
                | "Closed"
                | "Completed"
                | "Expired"
                | "Deleted";
            last_modified: string;
            progress: { current: number; desired: number; [key: string]: unknown };
            reward?: { initial: number; remaining: number; [key: string]: unknown };
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
Retrieves one page of a corporation's projects.

The list is cursor paginated: pass cursor.after from one page as after to read the next. Tokens are opaque; an empty projects array marks the end of the list.
Parameters
- corporationId: number
  The ID of the corporation
- Optionalbefore: string
  Optional cursor token to read records before
- Optionalafter: string
  Optional cursor token to read records after
Returns Promise<
    {
        cursor?: { before?: string; after?: string; [key: string]: unknown };
        projects: {
            id: string;
            name: string;
            state:
                | string & {}
                | "Unspecified"
                | "Active"
                | "Closed"
                | "Completed"
                | "Expired"
                | "Deleted";
            last_modified: string;
            progress: { current: number; desired: number; [key: string]: unknown };
            reward?: { initial: number; remaining: number; [key: string]: unknown };
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
A page of projects and its cursor

Requires
Authentication
- Defined in src/clients/CorporationProjectsClient.ts:31

getCorporationProject

getCorporationProject(
    corporationId: number,
    projectId: string,
): Promise<
    {
        id: string;
        name: string;
        state: | string & {}
        | "Unspecified"
        | "Active"
        | "Closed"
        | "Completed"
        | "Expired"
        | "Deleted";
        last_modified: string;
        progress: { current: number; desired: number; [key: string]: unknown };
        reward?: { initial: number; remaining: number; [key: string]: unknown };
        creator: { id: number; name: string; [key: string]: unknown };
        details: {
            career:
                | string & {}
                | "Unspecified"
                | "Explorer"
                | "Industrialist"
                | "Enforcer"
                | "Soldier of Fortune";
            created: string;
            description: string;
            expires?: string;
            finished?: string;
            [key: string]: unknown;
        };
        configuration: Record<string, unknown>;
        contribution?: {
            participation_limit?: number;
            reward_per_contribution?: number;
            submission_limit?: number;
            submission_multiplier?: number;
            [key: string]: unknown;
        };
        [key: string]: unknown;
    },
>
Retrieves details of a specific corporation project.
Parameters
- corporationId: number
  The ID of the corporation
- projectId: string
  The project's UUID
Returns Promise<
    {
        id: string;
        name: string;
        state: | string & {}
        | "Unspecified"
        | "Active"
        | "Closed"
        | "Completed"
        | "Expired"
        | "Deleted";
        last_modified: string;
        progress: { current: number; desired: number; [key: string]: unknown };
        reward?: { initial: number; remaining: number; [key: string]: unknown };
        creator: { id: number; name: string; [key: string]: unknown };
        details: {
            career:
                | string & {}
                | "Unspecified"
                | "Explorer"
                | "Industrialist"
                | "Enforcer"
                | "Soldier of Fortune";
            created: string;
            description: string;
            expires?: string;
            finished?: string;
            [key: string]: unknown;
        };
        configuration: Record<string, unknown>;
        contribution?: {
            participation_limit?: number;
            reward_per_contribution?: number;
            submission_limit?: number;
            submission_multiplier?: number;
            [key: string]: unknown;
        };
        [key: string]: unknown;
    },
>
The corporation project details

Requires
Authentication
- Defined in src/clients/CorporationProjectsClient.ts:47

getCorporationProjectContribution

getCorporationProjectContribution(
    corporationId: number,
    projectId: string,
    characterId: number,
): Promise<
    { contributed: number; last_modified?: string; [key: string]: unknown },
>
Retrieves a character's contribution to a specific corporation project.
Parameters
- corporationId: number
  The ID of the corporation
- projectId: string
  The project's UUID
- characterId: number
  The ID of the character
Returns Promise<{ contributed: number; last_modified?: string; [key: string]: unknown }>
The character's contribution details

Requires
Authentication
- Defined in src/clients/CorporationProjectsClient.ts:63

getCorporationProjectContributors

getCorporationProjectContributors(
    corporationId: number,
    projectId: string,
    before?: string,
    after?: string,
): Promise<
    {
        contributors: {
            id: number;
            name: string;
            contributed: number;
            [key: string]: unknown;
        }[];
        cursor?: { before?: string; after?: string; [key: string]: unknown };
        [key: string]: unknown;
    },
>
Retrieves one page of the contributors to a corporation project.

Cursor paginated in the same way as getCorporationProjects.
Parameters
- corporationId: number
  The ID of the corporation
- projectId: string
  The project's UUID
- Optionalbefore: string
  Optional cursor token to read records before
- Optionalafter: string
  Optional cursor token to read records after
Returns Promise<
    {
        contributors: {
            id: number;
            name: string;
            contributed: number;
            [key: string]: unknown;
        }[];
        cursor?: { before?: string; after?: string; [key: string]: unknown };
        [key: string]: unknown;
    },
>
A page of contributors and its cursor

Requires
Authentication
- Defined in src/clients/CorporationProjectsClient.ts:87

Class CorporationProjectsClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CorporationProjectsClient

Properties

Protectedapi

Protected_client

Protected_endpoints

Methods

streamEndpoint

Type Parameters

Parameters

Returns AsyncGenerator<PageResult<R>, void, undefined>

fetchAllEndpoint

Type Parameters

Parameters

Returns Promise<R[]>

withMetadata

Returns WithMetadata<Omit<this, "withMetadata" | "withSafeMode">>

withSafeMode

Returns WithSafeMode<Omit<this, "withMetadata" | "withSafeMode">>

getCorporationProjects

Parameters

Requires

getCorporationProject

Parameters

Requires

getCorporationProjectContribution

Parameters

Returns Promise<{ contributed: number; last_modified?: string; [key: string]: unknown }>

Requires

getCorporationProjectContributors

Parameters

Returns Promise< { contributors: { id: number; name: string; contributed: number; [key: string]: unknown; }[]; cursor?: { before?: string; after?: string; [key: string]: unknown }; [key: string]: unknown; },>

Requires

Settings

On This Page

`Protected`api

`Protected`_client

`Protected`_endpoints

Returns Promise<
{
contributors: {
id: number;
name: string;
contributed: number;
[key: string]: unknown;
}[];
cursor?: { before?: string; after?: string; [key: string]: unknown };
[key: string]: unknown;
},
>