Class FreelanceJobsClient

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 freelanceJobsEndpoints>
- FreelanceJobsClient

Index

Constructors

constructor

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

Properties

`Protected`api

api: ClientMethods<T>

`Protected`_client

_client: ApiClient

`Protected`_endpoints

_endpoints: {
    getFreelanceJobs: {
        path: "freelance-jobs";
        method: "GET";
        requiresAuth: false;
        queryParams: { before: "before"; after: "after" };
        responseSchema: ZodObject<
            {
                cursor: ZodOptional<
                    ZodObject<
                        { before: ZodOptional<ZodString>; after: ZodOptional<ZodString> },
                        $loose,
                    >,
                >;
                freelance_jobs: ZodArray<
                    ZodObject<
                        {
                            id: ZodString;
                            name: ZodString;
                            state: ZodString;
                            last_modified: ZodString;
                            progress: ZodObject<
                                { current: ZodNumber; desired: ZodNumber },
                                $loose,
                            >;
                            reward: ZodOptional<
                                ZodObject<{ initial: ZodNumber; remaining: ZodNumber }, $loose>,
                            >;
                        },
                        $loose,
                    >,
                >;
            },
            $loose,
        >;
    };
    getFreelanceJobById: {
        path: "freelance-jobs/{jobId}";
        method: "GET";
        requiresAuth: false;
        pathParams: readonly ["jobId"];
        responseSchema: ZodObject<
            {
                id: ZodString;
                name: ZodString;
                state: ZodString;
                last_modified: ZodString;
                progress: ZodObject<{ current: ZodNumber; desired: ZodNumber }, $loose>;
                reward: ZodOptional<
                    ZodObject<{ initial: ZodNumber; remaining: ZodNumber }, $loose>,
                >;
                details: ZodObject<
                    {
                        description: ZodString;
                        career: ZodString;
                        created: ZodString;
                        expires: ZodOptional<ZodString>;
                        finished: ZodOptional<ZodString>;
                        creator: ZodObject<
                            {
                                character: ZodObject<{ id: ZodNumber; name: ZodString }, $loose>;
                                corporation: ZodObject<{ id: ZodNumber; name: ZodString }, $loose>;
                            },
                            $loose,
                        >;
                    },
                    $loose,
                >;
                configuration: ZodObject<
                    {
                        version: ZodNumber;
                        parameters: ZodRecord<ZodString, ZodUnknown>;
                        method: ZodString;
                    },
                    $loose,
                >;
                contribution: ZodOptional<
                    ZodObject<
                        {
                            max_committed_participants: ZodNumber;
                            contribution_per_participant_limit: ZodOptional<ZodNumber>;
                            reward_per_contribution: ZodOptional<ZodNumber>;
                            submission_limit: ZodOptional<ZodNumber>;
                            submission_multiplier: ZodOptional<ZodNumber>;
                        },
                        $loose,
                    >,
                >;
                access_and_visibility: ZodObject<
                    {
                        acl_protected: ZodBoolean;
                        broadcast_locations: ZodOptional<
                            ZodArray<ZodObject<{ id: ZodNumber; name: ZodString }, $loose>>,
                        >;
                        restrictions: ZodOptional<
                            ZodObject<
                                {
                                    minimum_age: ZodOptional<ZodNumber>;
                                    maximum_age: ZodOptional<ZodNumber>;
                                },
                                $loose,
                            >,
                        >;
                    },
                    $loose,
                >;
            },
            $loose,
        >;
    };
    getCharacterFreelanceJobs: {
        path: "characters/{characterId}/freelance-jobs";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["characterId"];
        queryParams: { before: "before"; after: "after" };
        responseSchema: ZodObject<
            {
                cursor: ZodOptional<
                    ZodObject<
                        { before: ZodOptional<ZodString>; after: ZodOptional<ZodString> },
                        $loose,
                    >,
                >;
                freelance_jobs: ZodArray<
                    ZodObject<
                        {
                            id: ZodString;
                            name: ZodString;
                            state: ZodString;
                            last_modified: ZodString;
                            progress: ZodObject<
                                { current: ZodNumber; desired: ZodNumber },
                                $loose,
                            >;
                            reward: ZodOptional<
                                ZodObject<{ initial: ZodNumber; remaining: ZodNumber }, $loose>,
                            >;
                        },
                        $loose,
                    >,
                >;
            },
            $loose,
        >;
    };
    getCharacterFreelanceJobParticipation: {
        path: "characters/{characterId}/freelance-jobs/{jobId}/participation";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["characterId", "jobId"];
        responseSchema: ZodObject<
            {
                state: ZodType<
                    string & {}
                    | "Unspecified"
                    | "Committed"
                    | "Kicked"
                    | "Resigned",
                    unknown,
                    $ZodTypeInternals<
                        string & {}
                        | "Unspecified"
                        | "Committed"
                        | "Kicked"
                        | "Resigned",
                        unknown,
                    >,
                >;
                contributed: ZodNumber;
                last_modified: ZodString;
            },
            $loose,
        >;
    };
    getCorporationFreelanceJobs: {
        path: "corporations/{corporationId}/freelance-jobs";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["corporationId"];
        queryParams: { before: "before"; after: "after" };
        responseSchema: ZodObject<
            {
                cursor: ZodOptional<
                    ZodObject<
                        { before: ZodOptional<ZodString>; after: ZodOptional<ZodString> },
                        $loose,
                    >,
                >;
                freelance_jobs: ZodArray<
                    ZodObject<
                        {
                            id: ZodString;
                            name: ZodString;
                            state: ZodString;
                            last_modified: ZodString;
                            progress: ZodObject<
                                { current: ZodNumber; desired: ZodNumber },
                                $loose,
                            >;
                            reward: ZodOptional<
                                ZodObject<{ initial: ZodNumber; remaining: ZodNumber }, $loose>,
                            >;
                        },
                        $loose,
                    >,
                >;
            },
            $loose,
        >;
    };
    getCorporationFreelanceJobParticipants: {
        path: "corporations/{corporationId}/freelance-jobs/{jobId}/participants";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["corporationId", "jobId"];
        responseSchema: ZodObject<
            {
                cursor: ZodOptional<
                    ZodObject<
                        { before: ZodOptional<ZodString>; after: ZodOptional<ZodString> },
                        $loose,
                    >,
                >;
                participants: ZodArray<
                    ZodObject<
                        {
                            id: ZodNumber;
                            name: ZodString;
                            state: ZodType<
                                string & {}
                                | "Unspecified"
                                | "Committed"
                                | "Kicked"
                                | "Resigned",
                                unknown,
                                $ZodTypeInternals<
                                    | (...) & (...)
                                    | "Unspecified"
                                    | "Committed"
                                    | "Kicked"
                                    | "Resigned",
                                    unknown,
                                >,
                            >;
                            contributed: ZodNumber;
                        },
                        $loose,
                    >,
                >;
            },
            $loose,
        >;
    };
}

Methods

streamEndpoint

streamEndpoint<R>(
    endpointName:
        | "getFreelanceJobs"
        | "getFreelanceJobById"
        | "getCharacterFreelanceJobs"
        | "getCharacterFreelanceJobParticipation"
        | "getCorporationFreelanceJobs"
        | "getCorporationFreelanceJobParticipants",
    ...args: unknown[],
): AsyncGenerator<PageResult<R>, void, undefined>
Type Parameters
- R
Parameters
- endpointName:
      | "getFreelanceJobs"
      | "getFreelanceJobById"
      | "getCharacterFreelanceJobs"
      | "getCharacterFreelanceJobParticipation"
      | "getCorporationFreelanceJobs"
      | "getCorporationFreelanceJobParticipants"
- ...args: unknown[]
Returns AsyncGenerator<PageResult<R>, void, undefined>
Inherited from BaseEsiClient.streamEndpoint
- Defined in src/clients/BaseEsiClient.ts:45

fetchAllEndpoint

fetchAllEndpoint<R>(
    endpointName:
        | "getFreelanceJobs"
        | "getFreelanceJobById"
        | "getCharacterFreelanceJobs"
        | "getCharacterFreelanceJobParticipation"
        | "getCorporationFreelanceJobs"
        | "getCorporationFreelanceJobParticipants",
    args: unknown[],
    concurrency?: number,
): Promise<R[]>
Type Parameters
- R
Parameters
- endpointName:
      | "getFreelanceJobs"
      | "getFreelanceJobById"
      | "getCharacterFreelanceJobs"
      | "getCharacterFreelanceJobParticipation"
      | "getCorporationFreelanceJobs"
      | "getCorporationFreelanceJobParticipants"
- 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

getFreelanceJobs

getFreelanceJobs(
    before?: string,
    after?: string,
): Promise<
    {
        cursor?: { before?: string; after?: string; [key: string]: unknown };
        freelance_jobs: {
            id: string;
            name: string;
            state: string;
            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 a paginated listing of all publicly available freelance jobs.
Parameters
- Optionalbefore: string
  Optional cursor token for fetching the previous page of results
- Optionalafter: string
  Optional cursor token for fetching the next page of results
Returns Promise<
    {
        cursor?: { before?: string; after?: string; [key: string]: unknown };
        freelance_jobs: {
            id: string;
            name: string;
            state: string;
            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 listing of freelance jobs with cursor pagination metadata
- Defined in src/clients/FreelanceJobsClient.ts:27

getFreelanceJobById

getFreelanceJobById(
    jobId: string,
): Promise<
    {
        id: string;
        name: string;
        state: string;
        last_modified: string;
        progress: { current: number; desired: number; [key: string]: unknown };
        reward?: { initial: number; remaining: number; [key: string]: unknown };
        details: {
            description: string;
            career: string;
            created: string;
            expires?: string;
            finished?: string;
            creator: {
                character: { id: number; name: string; [key: string]: unknown };
                corporation: { id: number; name: string; [key: string]: unknown };
                [key: string]: unknown;
            };
            [key: string]: unknown;
        };
        configuration: {
            version: number;
            parameters: Record<string, unknown>;
            method: string;
            [key: string]: unknown;
        };
        contribution?: {
            max_committed_participants: number;
            contribution_per_participant_limit?: number;
            reward_per_contribution?: number;
            submission_limit?: number;
            submission_multiplier?: number;
            [key: string]: unknown;
        };
        access_and_visibility: {
            acl_protected: boolean;
            broadcast_locations?: {
                id: number;
                name: string;
                [key: string]: unknown;
            }[];
            restrictions?: {
                minimum_age?: number;
                maximum_age?: number;
                [key: string]: unknown;
            };
            [key: string]: unknown;
        };
        [key: string]: unknown;
    },
>
Retrieves detailed information about a specific freelance job.
Parameters
- jobId: string
  The unique identifier of the freelance job
Returns Promise<
    {
        id: string;
        name: string;
        state: string;
        last_modified: string;
        progress: { current: number; desired: number; [key: string]: unknown };
        reward?: { initial: number; remaining: number; [key: string]: unknown };
        details: {
            description: string;
            career: string;
            created: string;
            expires?: string;
            finished?: string;
            creator: {
                character: { id: number; name: string; [key: string]: unknown };
                corporation: { id: number; name: string; [key: string]: unknown };
                [key: string]: unknown;
            };
            [key: string]: unknown;
        };
        configuration: {
            version: number;
            parameters: Record<string, unknown>;
            method: string;
            [key: string]: unknown;
        };
        contribution?: {
            max_committed_participants: number;
            contribution_per_participant_limit?: number;
            reward_per_contribution?: number;
            submission_limit?: number;
            submission_multiplier?: number;
            [key: string]: unknown;
        };
        access_and_visibility: {
            acl_protected: boolean;
            broadcast_locations?: {
                id: number;
                name: string;
                [key: string]: unknown;
            }[];
            restrictions?: {
                minimum_age?: number;
                maximum_age?: number;
                [key: string]: unknown;
            };
            [key: string]: unknown;
        };
        [key: string]: unknown;
    },
>
Detailed information about the freelance job
- Defined in src/clients/FreelanceJobsClient.ts:40

getCharacterFreelanceJobs

getCharacterFreelanceJobs(
    characterId: number,
    before?: string,
    after?: string,
): Promise<
    {
        cursor?: { before?: string; after?: string; [key: string]: unknown };
        freelance_jobs: {
            id: string;
            name: string;
            state: string;
            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 a paginated listing of freelance jobs associated with a specific character.
Parameters
- characterId: number
  The ID of the character
- Optionalbefore: string
  Optional cursor token for fetching the previous page of results
- Optionalafter: string
  Optional cursor token for fetching the next page of results
Returns Promise<
    {
        cursor?: { before?: string; after?: string; [key: string]: unknown };
        freelance_jobs: {
            id: string;
            name: string;
            state: string;
            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 listing of the character's freelance jobs with cursor pagination metadata

Requires
Authentication
- Defined in src/clients/FreelanceJobsClient.ts:53

getCharacterFreelanceJobParticipation

getCharacterFreelanceJobParticipation(
    characterId: number,
    jobId: string,
): Promise<
    {
        state: | string & {}
        | "Unspecified"
        | "Committed"
        | "Kicked"
        | "Resigned";
        contributed: number;
        last_modified: string;
        [key: string]: unknown;
    },
>
Retrieves a character's participation details for a specific freelance job.
Parameters
- characterId: number
  The ID of the character
- jobId: string
  The unique identifier of the freelance job
Returns Promise<
    {
        state: | string & {}
        | "Unspecified"
        | "Committed"
        | "Kicked"
        | "Resigned";
        contributed: number;
        last_modified: string;
        [key: string]: unknown;
    },
>
The character's participation details for the job

Requires
Authentication
- Defined in src/clients/FreelanceJobsClient.ts:69

getCorporationFreelanceJobs

getCorporationFreelanceJobs(
    corporationId: number,
    before?: string,
    after?: string,
): Promise<
    {
        cursor?: { before?: string; after?: string; [key: string]: unknown };
        freelance_jobs: {
            id: string;
            name: string;
            state: string;
            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 a paginated listing of freelance jobs associated with a specific corporation.
Parameters
- corporationId: number
  The ID of the corporation
- Optionalbefore: string
  Optional cursor token for fetching the previous page of results
- Optionalafter: string
  Optional cursor token for fetching the next page of results
Returns Promise<
    {
        cursor?: { before?: string; after?: string; [key: string]: unknown };
        freelance_jobs: {
            id: string;
            name: string;
            state: string;
            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 listing of the corporation's freelance jobs with cursor pagination metadata

Requires
Authentication
- Defined in src/clients/FreelanceJobsClient.ts:85

getCorporationFreelanceJobParticipants

getCorporationFreelanceJobParticipants(
    corporationId: number,
    jobId: string,
): Promise<
    {
        cursor?: { before?: string; after?: string; [key: string]: unknown };
        participants: {
            id: number;
            name: string;
            state: string & {} | "Unspecified" | "Committed" | "Kicked" | "Resigned";
            contributed: number;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
Retrieves the list of participants from a corporation in a specific freelance job.
Parameters
- corporationId: number
  The ID of the corporation
- jobId: string
  The unique identifier of the freelance job
Returns Promise<
    {
        cursor?: { before?: string; after?: string; [key: string]: unknown };
        participants: {
            id: number;
            name: string;
            state: string & {} | "Unspecified" | "Committed" | "Kicked" | "Resigned";
            contributed: number;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
A page holding the job's participants, with an optional cursor

Requires
Authentication
- Defined in src/clients/FreelanceJobsClient.ts:101

Class FreelanceJobsClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FreelanceJobsClient

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">>

getFreelanceJobs

Parameters

getFreelanceJobById

Parameters

getCharacterFreelanceJobs

Parameters

Requires

getCharacterFreelanceJobParticipation

Parameters

Returns Promise< { state: | string & {} | "Unspecified" | "Committed" | "Kicked" | "Resigned"; contributed: number; last_modified: string; [key: string]: unknown; },>

Requires

getCorporationFreelanceJobs

Parameters

Requires

getCorporationFreelanceJobParticipants

Parameters

Returns Promise< { cursor?: { before?: string; after?: string; [key: string]: unknown }; participants: { id: number; name: string; state: string & {} | "Unspecified" | "Committed" | "Kicked" | "Resigned"; contributed: number; [key: string]: unknown; }[]; [key: string]: unknown; },>

Requires

Settings

On This Page

`Protected`api

`Protected`_client

`Protected`_endpoints

Returns Promise<
{
state: | string & {}
| "Unspecified"
| "Committed"
| "Kicked"
| "Resigned";
contributed: number;
last_modified: string;
[key: string]: unknown;
},
>

Returns Promise<
{
cursor?: { before?: string; after?: string; [key: string]: unknown };
participants: {
id: number;
name: string;
state: string & {} | "Unspecified" | "Committed" | "Kicked" | "Resigned";
contributed: number;
[key: string]: unknown;
}[];
[key: string]: unknown;
},
>