Class SkyhooksClient

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 skyhookEndpoints>
- SkyhooksClient

Index

Constructors

constructor

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

Properties

`Protected`api

api: ClientMethods<T>

`Protected`_client

_client: ApiClient

`Protected`_endpoints

_endpoints: {
    getSovereigntyHubs: {
        path: "corporations/{corporationId}/structures/sovereignty-hubs";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["corporationId"];
        responseSchema: ZodObject<
            {
                sovereignty_hubs: ZodArray<
                    ZodObject<{ id: ZodNumber; solar_system_id: ZodNumber }, $loose>,
                >;
            },
            $loose,
        >;
    };
    getOrbitalSkyhooks: {
        path: "corporations/{corporationId}/structures/skyhooks";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["corporationId"];
        responseSchema: ZodObject<
            {
                skyhooks: ZodArray<
                    ZodObject<{ id: ZodNumber; planet_id: ZodNumber }, $loose>,
                >;
            },
            $loose,
        >;
    };
    getRaidableSkyhooks: {
        path: "skyhooks/raidable";
        method: "GET";
        requiresAuth: false;
        responseSchema: ZodObject<
            {
                skyhooks: ZodArray<
                    ZodObject<
                        {
                            planet_id: ZodNumber;
                            solar_system_id: ZodNumber;
                            theft_vulnerability: ZodObject<
                                { start: ZodString; end: ZodString },
                                $loose,
                            >;
                        },
                        $loose,
                    >,
                >;
            },
            $loose,
        >;
    };
    getSkyhookDetail: {
        path: "corporations/{corporationId}/structures/skyhooks/{skyhookId}";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["corporationId", "skyhookId"];
        responseSchema: ZodObject<
            {
                id: ZodNumber;
                planet_id: ZodNumber;
                state: ZodType<
                    | string & {}
                    | "Unspecified"
                    | "ShieldVulnerable"
                    | "ArmorReinforced"
                    | "ArmorVulnerable"
                    | "HullReinforced"
                    | "HullVulnerable",
                    unknown,
                    $ZodTypeInternals<
                        | string & {}
                        | "Unspecified"
                        | "ShieldVulnerable"
                        | "ArmorReinforced"
                        | "ArmorVulnerable"
                        | "HullReinforced"
                        | "HullVulnerable",
                        unknown,
                    >,
                >;
                is_active: ZodBoolean;
                effective_workforce: ZodOptional<ZodNumber>;
                reagents: ZodOptional<
                    ZodArray<
                        ZodObject<
                            {
                                type_id: ZodNumber;
                                secured_stock: ZodNumber;
                                unsecured_stock: ZodNumber;
                                last_cycle: ZodString;
                            },
                            $loose,
                        >,
                    >,
                >;
                reinforcement_timer: ZodOptional<ZodObject<{ end: ZodString }, $loose>>;
                theft_vulnerability: ZodOptional<
                    ZodObject<{ start: ZodString; end: ZodString }, $loose>,
                >;
            },
            $loose,
        >;
    };
    getSovereigntyHubDetail: {
        path: "corporations/{corporationId}/structures/sovereignty-hubs/{sovereigntyHubId}";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["corporationId", "sovereigntyHubId"];
        responseSchema: ZodObject<
            {
                id: ZodNumber;
                solar_system_id: ZodNumber;
                upgrades: ZodArray<
                    ZodObject<
                        {
                            type_id: ZodNumber;
                            power_state: ZodType<
                                | string & {}
                                | "Unspecified"
                                | "Online"
                                | "Offline"
                                | "Low"
                                | "Pending",
                                unknown,
                                $ZodTypeInternals<
                                    | (...) & (...)
                                    | "Unspecified"
                                    | "Online"
                                    | "Offline"
                                    | "Low"
                                    | "Pending",
                                    unknown,
                                >,
                            >;
                        },
                        $loose,
                    >,
                >;
                reagent_bay: ZodObject<
                    {
                        last_updated: ZodString;
                        reagents: ZodArray<
                            ZodObject<
                                {
                                    type_id: ZodNumber;
                                    amount: ZodNumber;
                                    burning_per_hour: ZodNumber;
                                },
                                $loose,
                            >,
                        >;
                    },
                    $loose,
                >;
                resources: ZodObject<
                    {
                        power: ZodObject<
                            { available: ZodNumber; allocated: ZodNumber },
                            $loose,
                        >;
                        workforce: ZodObject<
                            { available: ZodNumber; allocated: ZodNumber },
                            $loose,
                        >;
                    },
                    $loose,
                >;
                workforce_transport: ZodObject<
                    {
                        configuration: ZodObject<{}, $loose>;
                        state: ZodObject<{}, $loose>;
                    },
                    $loose,
                >;
                fuel_access_list_id: ZodOptional<ZodNumber>;
                vulnerability_window: ZodOptional<
                    ZodObject<{ start: ZodString; end: ZodString }, $loose>,
                >;
            },
            $loose,
        >;
    };
}

Methods

streamEndpoint

streamEndpoint<R>(
    endpointName:
        | "getSovereigntyHubs"
        | "getOrbitalSkyhooks"
        | "getRaidableSkyhooks"
        | "getSkyhookDetail"
        | "getSovereigntyHubDetail",
    ...args: unknown[],
): AsyncGenerator<PageResult<R>, void, undefined>
Type Parameters
- R
Parameters
- endpointName:
      | "getSovereigntyHubs"
      | "getOrbitalSkyhooks"
      | "getRaidableSkyhooks"
      | "getSkyhookDetail"
      | "getSovereigntyHubDetail"
- ...args: unknown[]
Returns AsyncGenerator<PageResult<R>, void, undefined>
Inherited from BaseEsiClient.streamEndpoint
- Defined in src/clients/BaseEsiClient.ts:45

fetchAllEndpoint

fetchAllEndpoint<R>(
    endpointName:
        | "getSovereigntyHubs"
        | "getOrbitalSkyhooks"
        | "getRaidableSkyhooks"
        | "getSkyhookDetail"
        | "getSovereigntyHubDetail",
    args: unknown[],
    concurrency?: number,
): Promise<R[]>
Type Parameters
- R
Parameters
- endpointName:
      | "getSovereigntyHubs"
      | "getOrbitalSkyhooks"
      | "getRaidableSkyhooks"
      | "getSkyhookDetail"
      | "getSovereigntyHubDetail"
- 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

getSovereigntyHubs

getSovereigntyHubs(
    corporationId: number,
): Promise<
    {
        sovereignty_hubs: {
            id: number;
            solar_system_id: number;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
Retrieves the sovereignty hubs a corporation owns. Call getSovereigntyHubDetail for a hub's upgrades, reagent bay and resources.
Parameters
- corporationId: number
  The ID of the corporation to query sovereignty hubs for
Returns Promise<
    {
        sovereignty_hubs: {
            id: number;
            solar_system_id: number;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
ESI's response as sent: sovereignty_hubs, one entry per hub with its id and solar_system_id

Requires
Authentication
- Defined in src/clients/SkyhooksClient.ts:26

getOrbitalSkyhooks

getOrbitalSkyhooks(
    corporationId: number,
): Promise<
    {
        skyhooks: { id: number; planet_id: number; [key: string]: unknown }[];
        [key: string]: unknown;
    },
>
Retrieves the orbital skyhooks a corporation owns. Call getSkyhookDetail for a skyhook's state, reagent stock and theft window.
Parameters
- corporationId: number
  The ID of the corporation to query skyhooks for
Returns Promise<
    {
        skyhooks: { id: number; planet_id: number; [key: string]: unknown }[];
        [key: string]: unknown;
    },
>
ESI's response as sent: skyhooks, one entry per skyhook with its id and planet_id

Requires
Authentication
- Defined in src/clients/SkyhooksClient.ts:39

getRaidableSkyhooks

getRaidableSkyhooks(): Promise<
    {
        skyhooks: {
            planet_id: number;
            solar_system_id: number;
            theft_vulnerability: {
                start: string;
                end: string;
                [key: string]: unknown;
            };
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
Retrieves the rolling list of skyhooks that are currently or becoming raidable across New Eden.

Returns Promise<
    {
        skyhooks: {
            planet_id: number;
            solar_system_id: number;
            theft_vulnerability: {
                start: string;
                end: string;
                [key: string]: unknown;
            };
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
ESI's response as sent: skyhooks, one entry per skyhook with its planet, solar system and theft vulnerability window
- Defined in src/clients/SkyhooksClient.ts:49

getSkyhookDetail

getSkyhookDetail(
    corporationId: number,
    skyhookId: number,
): Promise<
    {
        id: number;
        planet_id: number;
        state: | string & {}
        | "Unspecified"
        | "ShieldVulnerable"
        | "ArmorReinforced"
        | "ArmorVulnerable"
        | "HullReinforced"
        | "HullVulnerable";
        is_active: boolean;
        effective_workforce?: number;
        reagents?: {
            type_id: number;
            secured_stock: number;
            unsecured_stock: number;
            last_cycle: string;
            [key: string]: unknown;
        }[];
        reinforcement_timer?: { end: string; [key: string]: unknown };
        theft_vulnerability?: {
            start: string;
            end: string;
            [key: string]: unknown;
        };
        [key: string]: unknown;
    },
>
Retrieves detail for a specific skyhook including reagents, reinforcement timer, and theft vulnerability.
Parameters
- corporationId: number
  The ID of the corporation
- skyhookId: number
  The ID of the skyhook
Returns Promise<
    {
        id: number;
        planet_id: number;
        state: | string & {}
        | "Unspecified"
        | "ShieldVulnerable"
        | "ArmorReinforced"
        | "ArmorVulnerable"
        | "HullReinforced"
        | "HullVulnerable";
        is_active: boolean;
        effective_workforce?: number;
        reagents?: {
            type_id: number;
            secured_stock: number;
            unsecured_stock: number;
            last_cycle: string;
            [key: string]: unknown;
        }[];
        reinforcement_timer?: { end: string; [key: string]: unknown };
        theft_vulnerability?: {
            start: string;
            end: string;
            [key: string]: unknown;
        };
        [key: string]: unknown;
    },
>
Skyhook detail

Requires
Authentication
- Defined in src/clients/SkyhooksClient.ts:61

getSovereigntyHubDetail

getSovereigntyHubDetail(
    corporationId: number,
    sovereigntyHubId: number,
): Promise<
    {
        id: number;
        solar_system_id: number;
        upgrades: {
            type_id: number;
            power_state: | string & {}
            | "Unspecified"
            | "Online"
            | "Offline"
            | "Low"
            | "Pending";
            [key: string]: unknown;
        }[];
        reagent_bay: {
            last_updated: string;
            reagents: {
                type_id: number;
                amount: number;
                burning_per_hour: number;
                [key: string]: unknown;
            }[];
            [key: string]: unknown;
        };
        resources: {
            power: {
                available: number;
                allocated: number;
                [key: string]: unknown;
            };
            workforce: {
                available: number;
                allocated: number;
                [key: string]: unknown;
            };
            [key: string]: unknown;
        };
        workforce_transport: {
            configuration: { [key: string]: unknown };
            state: { [key: string]: unknown };
            [key: string]: unknown;
        };
        fuel_access_list_id?: number;
        vulnerability_window?: {
            start: string;
            end: string;
            [key: string]: unknown;
        };
        [key: string]: unknown;
    },
>
Retrieves detail for a specific sovereignty hub including reagent bay, resources, upgrades, and vulnerability window.
Parameters
- corporationId: number
  The ID of the corporation
- sovereigntyHubId: number
  The ID of the sovereignty hub
Returns Promise<
    {
        id: number;
        solar_system_id: number;
        upgrades: {
            type_id: number;
            power_state: | string & {}
            | "Unspecified"
            | "Online"
            | "Offline"
            | "Low"
            | "Pending";
            [key: string]: unknown;
        }[];
        reagent_bay: {
            last_updated: string;
            reagents: {
                type_id: number;
                amount: number;
                burning_per_hour: number;
                [key: string]: unknown;
            }[];
            [key: string]: unknown;
        };
        resources: {
            power: {
                available: number;
                allocated: number;
                [key: string]: unknown;
            };
            workforce: {
                available: number;
                allocated: number;
                [key: string]: unknown;
            };
            [key: string]: unknown;
        };
        workforce_transport: {
            configuration: { [key: string]: unknown };
            state: { [key: string]: unknown };
            [key: string]: unknown;
        };
        fuel_access_list_id?: number;
        vulnerability_window?: {
            start: string;
            end: string;
            [key: string]: unknown;
        };
        [key: string]: unknown;
    },
>
Sovereignty hub detail

Requires
Authentication
- Defined in src/clients/SkyhooksClient.ts:76

Class SkyhooksClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SkyhooksClient

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

getSovereigntyHubs

Parameters

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

Requires

getOrbitalSkyhooks

Parameters

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

Requires

getRaidableSkyhooks

Returns Promise< { skyhooks: { planet_id: number; solar_system_id: number; theft_vulnerability: { start: string; end: string; [key: string]: unknown; }; [key: string]: unknown; }[]; [key: string]: unknown; },>

getSkyhookDetail

Parameters

Requires

getSovereigntyHubDetail

Parameters

Requires

Settings

On This Page

`Protected`api

`Protected`_client

`Protected`_endpoints

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

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

Returns Promise<
{
skyhooks: {
planet_id: number;
solar_system_id: number;
theft_vulnerability: {
start: string;
end: string;
[key: string]: unknown;
};
[key: string]: unknown;
}[];
[key: string]: unknown;
},
>