Class MercenaryClient

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 mercenaryEndpoints>
- MercenaryClient

Index

Constructors

constructor

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

Properties

`Protected`api

api: ClientMethods<T>

`Protected`_client

_client: ApiClient

`Protected`_endpoints

_endpoints: {
    getMercenaryDens: {
        path: "characters/{characterId}/structures/mercenary-dens";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["characterId"];
        responseSchema: ZodObject<
            {
                mercenary_dens: ZodArray<
                    ZodObject<{ id: ZodNumber; planet_id: ZodNumber }, $loose>,
                >;
            },
            $loose,
        >;
    };
    getMercenaryTacticalOperations: {
        path: "characters/{characterId}/mercenary-tactical-operations";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["characterId"];
        responseSchema: ZodObject<
            {
                operations: ZodArray<
                    ZodObject<{ id: ZodString; mercenary_den_id: ZodNumber }, $loose>,
                >;
            },
            $loose,
        >;
    };
    getMercenaryDenDetail: {
        path: "characters/{characterId}/structures/mercenary-dens/{mercenaryDenId}";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["characterId", "mercenaryDenId"];
        responseSchema: ZodObject<
            {
                id: ZodNumber;
                type_id: ZodNumber;
                state: ZodType<
                    string & {}
                    | "Unspecified"
                    | "Running"
                    | "Paused"
                    | "Disabled",
                    unknown,
                    $ZodTypeInternals<
                        string & {}
                        | "Unspecified"
                        | "Running"
                        | "Paused"
                        | "Disabled",
                        unknown,
                    >,
                >;
                skyhook: ZodObject<
                    { id: ZodNumber; planet_id: ZodNumber; corporation_id: ZodNumber },
                    $loose,
                >;
                infomorphs: ZodObject<{ amount: ZodNumber }, $loose>;
                evolution: ZodObject<
                    {
                        development: ZodObject<
                            {
                                amount: ZodNumber;
                                level: ZodType<
                                    | (...) & (...)
                                    | "Unspecified"
                                    | "Level0"
                                    | "Level1"
                                    | "Level2"
                                    | "Level3"
                                    | "Level4",
                                    unknown,
                                    $ZodTypeInternals<
                                        (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...),
                                        unknown,
                                    >,
                                >;
                            },
                            $loose,
                        >;
                        anarchy: ZodObject<
                            {
                                amount: ZodNumber;
                                level: ZodType<
                                    | (...) & (...)
                                    | "Unspecified"
                                    | "Level0"
                                    | "Level1"
                                    | "Level2"
                                    | "Level3"
                                    | "Level4",
                                    unknown,
                                    $ZodTypeInternals<
                                        (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...),
                                        unknown,
                                    >,
                                >;
                            },
                            $loose,
                        >;
                    },
                    $loose,
                >;
                reinforcement_timer: ZodOptional<ZodObject<{ end: ZodString }, $loose>>;
            },
            $loose,
        >;
    };
    getMercenaryTacticalOperationDetail: {
        path: "characters/{characterId}/mercenary-tactical-operations/{operationId}";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["characterId", "operationId"];
        responseSchema: ZodObject<
            {
                id: ZodString;
                mercenary_den_id: ZodNumber;
                state: ZodType<
                    | string & {}
                    | "Unspecified"
                    | "Completed"
                    | "Expired"
                    | "Available"
                    | "Started"
                    | "Removed",
                    unknown,
                    $ZodTypeInternals<
                        | string & {}
                        | "Unspecified"
                        | "Completed"
                        | "Expired"
                        | "Available"
                        | "Started"
                        | "Removed",
                        unknown,
                    >,
                >;
                dungeon_type_id: ZodNumber;
                expires: ZodString;
            },
            $loose,
        >;
    };
}

Methods

streamEndpoint

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

fetchAllEndpoint

fetchAllEndpoint<R>(
    endpointName:
        | "getMercenaryDens"
        | "getMercenaryTacticalOperations"
        | "getMercenaryDenDetail"
        | "getMercenaryTacticalOperationDetail",
    args: unknown[],
    concurrency?: number,
): Promise<R[]>
Type Parameters
- R
Parameters
- endpointName:
      | "getMercenaryDens"
      | "getMercenaryTacticalOperations"
      | "getMercenaryDenDetail"
      | "getMercenaryTacticalOperationDetail"
- 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

getMercenaryDens

getMercenaryDens(
    characterId: number,
): Promise<
    {
        mercenary_dens: {
            id: number;
            planet_id: number;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
Retrieves the mercenary dens a character owns. Call getMercenaryDenDetail for a den's evolution, infomorphs and skyhook.
Parameters
- characterId: number
  The ID of the character to query mercenary dens for
Returns Promise<
    {
        mercenary_dens: {
            id: number;
            planet_id: number;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
ESI's response as sent: mercenary_dens, one entry per den with its id and planet_id

Requires
Authentication
- Defined in src/clients/MercenaryClient.ts:25

getMercenaryTacticalOperations

getMercenaryTacticalOperations(
    characterId: number,
): Promise<
    {
        operations: {
            id: string;
            mercenary_den_id: number;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
Retrieves all mercenary tactical operations (MTOs) spawned from mercenary dens.
Parameters
- characterId: number
  The ID of the character to query tactical operations for
Returns Promise<
    {
        operations: {
            id: string;
            mercenary_den_id: number;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
ESI's response as sent: operations, one entry per operation with its UUID id and the mercenary_den_id it spawned from

Requires
Authentication
- Defined in src/clients/MercenaryClient.ts:37

getMercenaryDenDetail

getMercenaryDenDetail(
    characterId: number,
    mercenaryDenId: number,
): Promise<
    {
        id: number;
        type_id: number;
        state: string & {}
        | "Unspecified"
        | "Running"
        | "Paused"
        | "Disabled";
        skyhook: {
            id: number;
            planet_id: number;
            corporation_id: number;
            [key: string]: unknown;
        };
        infomorphs: { amount: number; [key: string]: unknown };
        evolution: {
            development: {
                amount: number;
                level:
                    | string & {}
                    | "Unspecified"
                    | "Level0"
                    | "Level1"
                    | "Level2"
                    | "Level3"
                    | "Level4";
                [key: string]: unknown;
            };
            anarchy: {
                amount: number;
                level: | string & {}
                | "Unspecified"
                | "Level0"
                | "Level1"
                | "Level2"
                | "Level3"
                | "Level4";
                [key: string]: unknown;
            };
            [key: string]: unknown;
        };
        reinforcement_timer?: { end: string; [key: string]: unknown };
        [key: string]: unknown;
    },
>
Retrieves detail for a specific mercenary den including evolution, infomorphs, and skyhook attachment.
Parameters
- characterId: number
  The ID of the character
- mercenaryDenId: number
  The ID of the mercenary den
Returns Promise<
    {
        id: number;
        type_id: number;
        state: string & {}
        | "Unspecified"
        | "Running"
        | "Paused"
        | "Disabled";
        skyhook: {
            id: number;
            planet_id: number;
            corporation_id: number;
            [key: string]: unknown;
        };
        infomorphs: { amount: number; [key: string]: unknown };
        evolution: {
            development: {
                amount: number;
                level:
                    | string & {}
                    | "Unspecified"
                    | "Level0"
                    | "Level1"
                    | "Level2"
                    | "Level3"
                    | "Level4";
                [key: string]: unknown;
            };
            anarchy: {
                amount: number;
                level: | string & {}
                | "Unspecified"
                | "Level0"
                | "Level1"
                | "Level2"
                | "Level3"
                | "Level4";
                [key: string]: unknown;
            };
            [key: string]: unknown;
        };
        reinforcement_timer?: { end: string; [key: string]: unknown };
        [key: string]: unknown;
    },
>
Mercenary den detail

Requires
Authentication
- Defined in src/clients/MercenaryClient.ts:51

getMercenaryTacticalOperationDetail

getMercenaryTacticalOperationDetail(
    characterId: number,
    operationId: string,
): Promise<
    {
        id: string;
        mercenary_den_id: number;
        state: | string & {}
        | "Unspecified"
        | "Completed"
        | "Expired"
        | "Available"
        | "Started"
        | "Removed";
        dungeon_type_id: number;
        expires: string;
        [key: string]: unknown;
    },
>
Retrieves detail for a specific mercenary tactical operation.
Parameters
- characterId: number
  The ID of the character
- operationId: string
  The UUID of the tactical operation
Returns Promise<
    {
        id: string;
        mercenary_den_id: number;
        state: | string & {}
        | "Unspecified"
        | "Completed"
        | "Expired"
        | "Available"
        | "Started"
        | "Removed";
        dungeon_type_id: number;
        expires: string;
        [key: string]: unknown;
    },
>
Mercenary tactical operation detail

Requires
Authentication
- Defined in src/clients/MercenaryClient.ts:66

Class MercenaryClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MercenaryClient

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

getMercenaryDens

Parameters

Returns Promise< { mercenary_dens: { id: number; planet_id: number; [key: string]: unknown; }[]; [key: string]: unknown; },>

Requires

getMercenaryTacticalOperations

Parameters

Returns Promise< { operations: { id: string; mercenary_den_id: number; [key: string]: unknown; }[]; [key: string]: unknown; },>

Requires

getMercenaryDenDetail

Parameters

Requires

getMercenaryTacticalOperationDetail

Parameters

Returns Promise< { id: string; mercenary_den_id: number; state: | string & {} | "Unspecified" | "Completed" | "Expired" | "Available" | "Started" | "Removed"; dungeon_type_id: number; expires: string; [key: string]: unknown; },>

Requires

Settings

On This Page

`Protected`api

`Protected`_client

`Protected`_endpoints

Returns Promise<
{
mercenary_dens: {
id: number;
planet_id: number;
[key: string]: unknown;
}[];
[key: string]: unknown;
},
>

Returns Promise<
{
operations: {
id: string;
mercenary_den_id: number;
[key: string]: unknown;
}[];
[key: string]: unknown;
},
>

Returns Promise<
{
id: string;
mercenary_den_id: number;
state: | string & {}
| "Unspecified"
| "Completed"
| "Expired"
| "Available"
| "Started"
| "Removed";
dungeon_type_id: number;
expires: string;
[key: string]: unknown;
},
>