Class IndustryClient

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 industryEndpoints>
- IndustryClient

Constructors

constructor

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

Properties

`Protected`api

api: ClientMethods<T>

`Protected`_client

_client: ApiClient

`Protected`_endpoints

_endpoints: {
    getCharacterIndustryJobs: {
        path: "characters/{characterId}/industry/jobs";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["characterId"];
        responseSchema: ZodArray<
            ZodObject<
                {
                    job_id: ZodNumber;
                    installer_id: ZodNumber;
                    facility_id: ZodNumber;
                    station_id: ZodNumber;
                    activity_id: ZodNumber;
                    blueprint_id: ZodNumber;
                    blueprint_type_id: ZodNumber;
                    blueprint_location_id: ZodNumber;
                    output_location_id: ZodNumber;
                    runs: ZodNumber;
                    cost: ZodOptional<ZodNumber>;
                    licensed_runs: ZodOptional<ZodNumber>;
                    probability: ZodOptional<ZodNumber>;
                    product_type_id: ZodOptional<ZodNumber>;
                    status: ZodType<
                        | string & {}
                        | "active"
                        | "cancelled"
                        | "delivered"
                        | "paused"
                        | "ready"
                        | "reverted",
                        unknown,
                        $ZodTypeInternals<
                            | string & {}
                            | "active"
                            | "cancelled"
                            | "delivered"
                            | "paused"
                            | "ready"
                            | "reverted",
                            unknown,
                        >,
                    >;
                    duration: ZodNumber;
                    start_date: ZodString;
                    end_date: ZodString;
                    pause_date: ZodOptional<ZodString>;
                    completed_date: ZodOptional<ZodString>;
                    completed_character_id: ZodOptional<ZodNumber>;
                    successful_runs: ZodOptional<ZodNumber>;
                },
                $loose,
            >,
        >;
    };
    getCharacterMiningLedger: {
        path: "characters/{characterId}/mining";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["characterId"];
        responseSchema: ZodArray<
            ZodObject<
                {
                    date: ZodString;
                    solar_system_id: ZodNumber;
                    type_id: ZodNumber;
                    quantity: ZodNumber;
                },
                $loose,
            >,
        >;
    };
    getCorporationIndustryJobs: {
        path: "corporations/{corporationId}/industry/jobs";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["corporationId"];
        responseSchema: ZodArray<
            ZodObject<
                {
                    job_id: ZodNumber;
                    installer_id: ZodNumber;
                    facility_id: ZodNumber;
                    activity_id: ZodNumber;
                    blueprint_id: ZodNumber;
                    blueprint_type_id: ZodNumber;
                    blueprint_location_id: ZodNumber;
                    output_location_id: ZodNumber;
                    runs: ZodNumber;
                    cost: ZodOptional<ZodNumber>;
                    licensed_runs: ZodOptional<ZodNumber>;
                    probability: ZodOptional<ZodNumber>;
                    product_type_id: ZodOptional<ZodNumber>;
                    status: ZodType<
                        | string & {}
                        | "active"
                        | "cancelled"
                        | "delivered"
                        | "paused"
                        | "ready"
                        | "reverted",
                        unknown,
                        $ZodTypeInternals<
                            | string & {}
                            | "active"
                            | "cancelled"
                            | "delivered"
                            | "paused"
                            | "ready"
                            | "reverted",
                            unknown,
                        >,
                    >;
                    duration: ZodNumber;
                    start_date: ZodString;
                    end_date: ZodString;
                    pause_date: ZodOptional<ZodString>;
                    completed_date: ZodOptional<ZodString>;
                    completed_character_id: ZodOptional<ZodNumber>;
                    successful_runs: ZodOptional<ZodNumber>;
                    location_id: ZodNumber;
                },
                $loose,
            >,
        >;
    };
    getMoonExtractionTimers: {
        path: "corporation/{corporationId}/mining/extractions";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["corporationId"];
        responseSchema: ZodArray<
            ZodObject<
                {
                    structure_id: ZodNumber;
                    moon_id: ZodNumber;
                    extraction_start_time: ZodString;
                    chunk_arrival_time: ZodString;
                    natural_decay_time: ZodString;
                },
                $loose,
            >,
        >;
    };
    getCorporationMiningObservers: {
        path: "corporation/{corporationId}/mining/observers";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["corporationId"];
        responseSchema: ZodArray<
            ZodObject<
                {
                    observer_id: ZodNumber;
                    observer_type: ZodString;
                    last_updated: ZodString;
                },
                $loose,
            >,
        >;
    };
    getCorporationMiningObserver: {
        path: "corporation/{corporationId}/mining/observers/{observerId}";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["corporationId", "observerId"];
        responseSchema: ZodArray<
            ZodObject<
                {
                    character_id: ZodNumber;
                    recorded_corporation_id: ZodNumber;
                    type_id: ZodNumber;
                    quantity: ZodNumber;
                    last_updated: ZodString;
                },
                $loose,
            >,
        >;
    };
    getIndustryFacilities: {
        path: "industry/facilities";
        method: "GET";
        requiresAuth: false;
        responseSchema: ZodArray<
            ZodObject<
                {
                    facility_id: ZodNumber;
                    owner_id: ZodNumber;
                    region_id: ZodNumber;
                    solar_system_id: ZodNumber;
                    tax: ZodOptional<ZodNumber>;
                    type_id: ZodNumber;
                },
                $loose,
            >,
        >;
    };
    getIndustrySystems: {
        path: "industry/systems";
        method: "GET";
        requiresAuth: false;
        responseSchema: ZodArray<
            ZodObject<
                {
                    solar_system_id: ZodNumber;
                    cost_indices: ZodArray<
                        ZodObject<{ activity: ZodString; cost_index: ZodNumber }, $loose>,
                    >;
                },
                $loose,
            >,
        >;
    };
}

Methods

streamEndpoint

streamEndpoint<R>(
    endpointName:
        | "getCharacterIndustryJobs"
        | "getCharacterMiningLedger"
        | "getCorporationIndustryJobs"
        | "getMoonExtractionTimers"
        | "getCorporationMiningObservers"
        | "getCorporationMiningObserver"
        | "getIndustryFacilities"
        | "getIndustrySystems",
    ...args: unknown[],
): AsyncGenerator<PageResult<R>, void, undefined>
Type Parameters
- R
Parameters
- endpointName:
      | "getCharacterIndustryJobs"
      | "getCharacterMiningLedger"
      | "getCorporationIndustryJobs"
      | "getMoonExtractionTimers"
      | "getCorporationMiningObservers"
      | "getCorporationMiningObserver"
      | "getIndustryFacilities"
      | "getIndustrySystems"
- ...args: unknown[]
Returns AsyncGenerator<PageResult<R>, void, undefined>
Inherited from BaseEsiClient.streamEndpoint
- Defined in src/clients/BaseEsiClient.ts:45

fetchAllEndpoint

fetchAllEndpoint<R>(
    endpointName:
        | "getCharacterIndustryJobs"
        | "getCharacterMiningLedger"
        | "getCorporationIndustryJobs"
        | "getMoonExtractionTimers"
        | "getCorporationMiningObservers"
        | "getCorporationMiningObserver"
        | "getIndustryFacilities"
        | "getIndustrySystems",
    args: unknown[],
    concurrency?: number,
): Promise<R[]>
Type Parameters
- R
Parameters
- endpointName:
      | "getCharacterIndustryJobs"
      | "getCharacterMiningLedger"
      | "getCorporationIndustryJobs"
      | "getMoonExtractionTimers"
      | "getCorporationMiningObservers"
      | "getCorporationMiningObserver"
      | "getIndustryFacilities"
      | "getIndustrySystems"
- 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

getCharacterIndustryJobs

getCharacterIndustryJobs(
    characterId: number,
): Promise<
    {
        job_id: number;
        installer_id: number;
        facility_id: number;
        station_id: number;
        activity_id: number;
        blueprint_id: number;
        blueprint_type_id: number;
        blueprint_location_id: number;
        output_location_id: number;
        runs: number;
        cost?: number;
        licensed_runs?: number;
        probability?: number;
        product_type_id?: number;
        status: | string & {}
        | "active"
        | "cancelled"
        | "delivered"
        | "paused"
        | "ready"
        | "reverted";
        duration: number;
        start_date: string;
        end_date: string;
        pause_date?: string;
        completed_date?: string;
        completed_character_id?: number;
        successful_runs?: number;
        [key: string]: unknown;
    }[],
>
Retrieves all industry jobs for a character, including manufacturing, research, and invention.
Parameters
- characterId: number
  The ID of the character
Returns Promise<
    {
        job_id: number;
        installer_id: number;
        facility_id: number;
        station_id: number;
        activity_id: number;
        blueprint_id: number;
        blueprint_type_id: number;
        blueprint_location_id: number;
        output_location_id: number;
        runs: number;
        cost?: number;
        licensed_runs?: number;
        probability?: number;
        product_type_id?: number;
        status: | string & {}
        | "active"
        | "cancelled"
        | "delivered"
        | "paused"
        | "ready"
        | "reverted";
        duration: number;
        start_date: string;
        end_date: string;
        pause_date?: string;
        completed_date?: string;
        completed_character_id?: number;
        successful_runs?: number;
        [key: string]: unknown;
    }[],
>
An array of the character's industry jobs

Requires
Authentication
- Defined in src/clients/IndustryClient.ts:28

getCharacterMiningLedger

getCharacterMiningLedger(
    characterId: number,
): Promise<
    {
        date: string;
        solar_system_id: number;
        type_id: number;
        quantity: number;
        [key: string]: unknown;
    }[],
>
Retrieves a character's personal mining ledger, showing ore mined per day.
Parameters
- characterId: number
  The ID of the character
Returns Promise<
    {
        date: string;
        solar_system_id: number;
        type_id: number;
        quantity: number;
        [key: string]: unknown;
    }[],
>
An array of mining ledger entries

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

getMoonExtractionTimers

getMoonExtractionTimers(
    corporationId: number,
): Promise<
    {
        structure_id: number;
        moon_id: number;
        extraction_start_time: string;
        chunk_arrival_time: string;
        natural_decay_time: string;
        [key: string]: unknown;
    }[],
>
Retrieves moon extraction timers for a corporation's refineries.
Parameters
- corporationId: number
  The ID of the corporation
Returns Promise<
    {
        structure_id: number;
        moon_id: number;
        extraction_start_time: string;
        chunk_arrival_time: string;
        natural_decay_time: string;
        [key: string]: unknown;
    }[],
>
An array of moon extraction timers

Requires
Authentication
- Defined in src/clients/IndustryClient.ts:50

getCorporationMiningObservers

getCorporationMiningObservers(
    corporationId: number,
): Promise<
    {
        observer_id: number;
        observer_type: string;
        last_updated: string;
        [key: string]: unknown;
    }[],
>
Retrieves the list of mining observers (e.g., refineries) owned by a corporation.
Parameters
- corporationId: number
  The ID of the corporation
Returns Promise<
    {
        observer_id: number;
        observer_type: string;
        last_updated: string;
        [key: string]: unknown;
    }[],
>
An array of mining observers

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

getCorporationMiningObserver

getCorporationMiningObserver(
    corporationId: number,
    observerId: number,
): Promise<
    {
        character_id: number;
        recorded_corporation_id: number;
        type_id: number;
        quantity: number;
        last_updated: string;
        [key: string]: unknown;
    }[],
>
Retrieves mining activity recorded by a specific corporation mining observer.
Parameters
- corporationId: number
  The ID of the corporation
- observerId: number
  The ID of the mining observer
Returns Promise<
    {
        character_id: number;
        recorded_corporation_id: number;
        type_id: number;
        quantity: number;
        last_updated: string;
        [key: string]: unknown;
    }[],
>
An array of mining activity entries for the observer

Requires
Authentication
- Defined in src/clients/IndustryClient.ts:77

getCorporationIndustryJobs

getCorporationIndustryJobs(
    corporationId: number,
): Promise<
    {
        job_id: number;
        installer_id: number;
        facility_id: number;
        activity_id: number;
        blueprint_id: number;
        blueprint_type_id: number;
        blueprint_location_id: number;
        output_location_id: number;
        runs: number;
        cost?: number;
        licensed_runs?: number;
        probability?: number;
        product_type_id?: number;
        status: | string & {}
        | "active"
        | "cancelled"
        | "delivered"
        | "paused"
        | "ready"
        | "reverted";
        duration: number;
        start_date: string;
        end_date: string;
        pause_date?: string;
        completed_date?: string;
        completed_character_id?: number;
        successful_runs?: number;
        location_id: number;
        [key: string]: unknown;
    }[],
>
Retrieves all industry jobs for a corporation, including manufacturing, research, and invention.
Parameters
- corporationId: number
  The ID of the corporation
Returns Promise<
    {
        job_id: number;
        installer_id: number;
        facility_id: number;
        activity_id: number;
        blueprint_id: number;
        blueprint_type_id: number;
        blueprint_location_id: number;
        output_location_id: number;
        runs: number;
        cost?: number;
        licensed_runs?: number;
        probability?: number;
        product_type_id?: number;
        status: | string & {}
        | "active"
        | "cancelled"
        | "delivered"
        | "paused"
        | "ready"
        | "reverted";
        duration: number;
        start_date: string;
        end_date: string;
        pause_date?: string;
        completed_date?: string;
        completed_character_id?: number;
        successful_runs?: number;
        location_id: number;
        [key: string]: unknown;
    }[],
>
An array of the corporation's industry jobs

Requires
Authentication
- Defined in src/clients/IndustryClient.ts:91

getIndustryFacilities

getIndustryFacilities(): Promise<
    {
        facility_id: number;
        owner_id: number;
        region_id: number;
        solar_system_id: number;
        tax?: number;
        type_id: number;
        [key: string]: unknown;
    }[],
>
Retrieves a list of all publicly available industry facilities in the universe.

Returns Promise<
    {
        facility_id: number;
        owner_id: number;
        region_id: number;
        solar_system_id: number;
        tax?: number;
        type_id: number;
        [key: string]: unknown;
    }[],
>
An array of industry facilities
- Defined in src/clients/IndustryClient.ts:102

getIndustrySystems

getIndustrySystems(): Promise<
    {
        solar_system_id: number;
        cost_indices: {
            activity: string;
            cost_index: number;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    }[],
>
Retrieves cost indices for solar systems with industry activity, used to calculate job installation fees.

Returns Promise<
    {
        solar_system_id: number;
        cost_indices: {
            activity: string;
            cost_index: number;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    }[],
>
An array of industry system cost indices
- Defined in src/clients/IndustryClient.ts:111

fetchAllCharacterIndustryJobs

fetchAllCharacterIndustryJobs(
    characterId: number,
    concurrency?: number,
): Promise<
    {
        job_id: number;
        installer_id: number;
        facility_id: number;
        station_id: number;
        activity_id: number;
        blueprint_id: number;
        blueprint_type_id: number;
        blueprint_location_id: number;
        output_location_id: number;
        runs: number;
        cost?: number;
        licensed_runs?: number;
        probability?: number;
        product_type_id?: number;
        status: | string & {}
        | "active"
        | "cancelled"
        | "delivered"
        | "paused"
        | "ready"
        | "reverted";
        duration: number;
        start_date: string;
        end_date: string;
        pause_date?: string;
        completed_date?: string;
        completed_character_id?: number;
        successful_runs?: number;
        [key: string]: unknown;
    }[],
>
Parameters
- characterId: number
- Optionalconcurrency: number
Returns Promise<
    {
        job_id: number;
        installer_id: number;
        facility_id: number;
        station_id: number;
        activity_id: number;
        blueprint_id: number;
        blueprint_type_id: number;
        blueprint_location_id: number;
        output_location_id: number;
        runs: number;
        cost?: number;
        licensed_runs?: number;
        probability?: number;
        product_type_id?: number;
        status: | string & {}
        | "active"
        | "cancelled"
        | "delivered"
        | "paused"
        | "ready"
        | "reverted";
        duration: number;
        start_date: string;
        end_date: string;
        pause_date?: string;
        completed_date?: string;
        completed_character_id?: number;
        successful_runs?: number;
        [key: string]: unknown;
    }[],
>
- Defined in src/clients/IndustryClient.ts:115

fetchAllCharacterMiningLedger

fetchAllCharacterMiningLedger(
    characterId: number,
    concurrency?: number,
): Promise<
    {
        date: string;
        solar_system_id: number;
        type_id: number;
        quantity: number;
        [key: string]: unknown;
    }[],
>
Parameters
- characterId: number
- Optionalconcurrency: number
Returns Promise<
    {
        date: string;
        solar_system_id: number;
        type_id: number;
        quantity: number;
        [key: string]: unknown;
    }[],
>
- Defined in src/clients/IndustryClient.ts:126

fetchAllCorporationIndustryJobs

fetchAllCorporationIndustryJobs(
    corporationId: number,
    concurrency?: number,
): Promise<
    {
        job_id: number;
        installer_id: number;
        facility_id: number;
        activity_id: number;
        blueprint_id: number;
        blueprint_type_id: number;
        blueprint_location_id: number;
        output_location_id: number;
        runs: number;
        cost?: number;
        licensed_runs?: number;
        probability?: number;
        product_type_id?: number;
        status: | string & {}
        | "active"
        | "cancelled"
        | "delivered"
        | "paused"
        | "ready"
        | "reverted";
        duration: number;
        start_date: string;
        end_date: string;
        pause_date?: string;
        completed_date?: string;
        completed_character_id?: number;
        successful_runs?: number;
        location_id: number;
        [key: string]: unknown;
    }[],
>
Parameters
- corporationId: number
- Optionalconcurrency: number
Returns Promise<
    {
        job_id: number;
        installer_id: number;
        facility_id: number;
        activity_id: number;
        blueprint_id: number;
        blueprint_type_id: number;
        blueprint_location_id: number;
        output_location_id: number;
        runs: number;
        cost?: number;
        licensed_runs?: number;
        probability?: number;
        product_type_id?: number;
        status: | string & {}
        | "active"
        | "cancelled"
        | "delivered"
        | "paused"
        | "ready"
        | "reverted";
        duration: number;
        start_date: string;
        end_date: string;
        pause_date?: string;
        completed_date?: string;
        completed_character_id?: number;
        successful_runs?: number;
        location_id: number;
        [key: string]: unknown;
    }[],
>
- Defined in src/clients/IndustryClient.ts:137

fetchAllMoonExtractionTimers

fetchAllMoonExtractionTimers(
    corporationId: number,
    concurrency?: number,
): Promise<
    {
        structure_id: number;
        moon_id: number;
        extraction_start_time: string;
        chunk_arrival_time: string;
        natural_decay_time: string;
        [key: string]: unknown;
    }[],
>
Parameters
- corporationId: number
- Optionalconcurrency: number
Returns Promise<
    {
        structure_id: number;
        moon_id: number;
        extraction_start_time: string;
        chunk_arrival_time: string;
        natural_decay_time: string;
        [key: string]: unknown;
    }[],
>
- Defined in src/clients/IndustryClient.ts:148

fetchAllCorporationMiningObservers

fetchAllCorporationMiningObservers(
    corporationId: number,
    concurrency?: number,
): Promise<
    {
        observer_id: number;
        observer_type: string;
        last_updated: string;
        [key: string]: unknown;
    }[],
>
Parameters
- corporationId: number
- Optionalconcurrency: number
Returns Promise<
    {
        observer_id: number;
        observer_type: string;
        last_updated: string;
        [key: string]: unknown;
    }[],
>
- Defined in src/clients/IndustryClient.ts:159

fetchAllCorporationMiningObserver

fetchAllCorporationMiningObserver(
    corporationId: number,
    observerId: number,
    concurrency?: number,
): Promise<
    {
        character_id: number;
        recorded_corporation_id: number;
        type_id: number;
        quantity: number;
        last_updated: string;
        [key: string]: unknown;
    }[],
>
Parameters
- corporationId: number
- observerId: number
- Optionalconcurrency: number
Returns Promise<
    {
        character_id: number;
        recorded_corporation_id: number;
        type_id: number;
        quantity: number;
        last_updated: string;
        [key: string]: unknown;
    }[],
>
- Defined in src/clients/IndustryClient.ts:170

fetchAllIndustryFacilities

fetchAllIndustryFacilities(
    concurrency?: number,
): Promise<
    {
        facility_id: number;
        owner_id: number;
        region_id: number;
        solar_system_id: number;
        tax?: number;
        type_id: number;
        [key: string]: unknown;
    }[],
>
Parameters
- Optionalconcurrency: number
Returns Promise<
    {
        facility_id: number;
        owner_id: number;
        region_id: number;
        solar_system_id: number;
        tax?: number;
        type_id: number;
        [key: string]: unknown;
    }[],
>
- Defined in src/clients/IndustryClient.ts:182

fetchAllIndustrySystems

fetchAllIndustrySystems(
    concurrency?: number,
): Promise<
    {
        solar_system_id: number;
        cost_indices: {
            activity: string;
            cost_index: number;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    }[],
>
Parameters
- Optionalconcurrency: number
Returns Promise<
    {
        solar_system_id: number;
        cost_indices: {
            activity: string;
            cost_index: number;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    }[],
>
- Defined in src/clients/IndustryClient.ts:192

streamCharacterIndustryJobs

streamCharacterIndustryJobs(
    characterId: number,
): AsyncGenerator<
    PageResult<
        {
            job_id: number;
            installer_id: number;
            facility_id: number;
            station_id: number;
            activity_id: number;
            blueprint_id: number;
            blueprint_type_id: number;
            blueprint_location_id: number;
            output_location_id: number;
            runs: number;
            cost?: number;
            licensed_runs?: number;
            probability?: number;
            product_type_id?: number;
            status: | string & {}
            | "active"
            | "cancelled"
            | "delivered"
            | "paused"
            | "ready"
            | "reverted";
            duration: number;
            start_date: string;
            end_date: string;
            pause_date?: string;
            completed_date?: string;
            completed_character_id?: number;
            successful_runs?: number;
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
Parameters
- characterId: number
Returns AsyncGenerator<
    PageResult<
        {
            job_id: number;
            installer_id: number;
            facility_id: number;
            station_id: number;
            activity_id: number;
            blueprint_id: number;
            blueprint_type_id: number;
            blueprint_location_id: number;
            output_location_id: number;
            runs: number;
            cost?: number;
            licensed_runs?: number;
            probability?: number;
            product_type_id?: number;
            status: | string & {}
            | "active"
            | "cancelled"
            | "delivered"
            | "paused"
            | "ready"
            | "reverted";
            duration: number;
            start_date: string;
            end_date: string;
            pause_date?: string;
            completed_date?: string;
            completed_character_id?: number;
            successful_runs?: number;
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
- Defined in src/clients/IndustryClient.ts:200

streamCharacterMiningLedger

streamCharacterMiningLedger(
    characterId: number,
): AsyncGenerator<
    PageResult<
        {
            date: string;
            solar_system_id: number;
            type_id: number;
            quantity: number;
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
Parameters
- characterId: number
Returns AsyncGenerator<
    PageResult<
        {
            date: string;
            solar_system_id: number;
            type_id: number;
            quantity: number;
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
- Defined in src/clients/IndustryClient.ts:209

streamCorporationIndustryJobs

streamCorporationIndustryJobs(
    corporationId: number,
): AsyncGenerator<
    PageResult<
        {
            job_id: number;
            installer_id: number;
            facility_id: number;
            activity_id: number;
            blueprint_id: number;
            blueprint_type_id: number;
            blueprint_location_id: number;
            output_location_id: number;
            runs: number;
            cost?: number;
            licensed_runs?: number;
            probability?: number;
            product_type_id?: number;
            status: | string & {}
            | "active"
            | "cancelled"
            | "delivered"
            | "paused"
            | "ready"
            | "reverted";
            duration: number;
            start_date: string;
            end_date: string;
            pause_date?: string;
            completed_date?: string;
            completed_character_id?: number;
            successful_runs?: number;
            location_id: number;
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
Parameters
- corporationId: number
Returns AsyncGenerator<
    PageResult<
        {
            job_id: number;
            installer_id: number;
            facility_id: number;
            activity_id: number;
            blueprint_id: number;
            blueprint_type_id: number;
            blueprint_location_id: number;
            output_location_id: number;
            runs: number;
            cost?: number;
            licensed_runs?: number;
            probability?: number;
            product_type_id?: number;
            status: | string & {}
            | "active"
            | "cancelled"
            | "delivered"
            | "paused"
            | "ready"
            | "reverted";
            duration: number;
            start_date: string;
            end_date: string;
            pause_date?: string;
            completed_date?: string;
            completed_character_id?: number;
            successful_runs?: number;
            location_id: number;
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
- Defined in src/clients/IndustryClient.ts:218

streamMoonExtractionTimers

streamMoonExtractionTimers(
    corporationId: number,
): AsyncGenerator<
    PageResult<
        {
            structure_id: number;
            moon_id: number;
            extraction_start_time: string;
            chunk_arrival_time: string;
            natural_decay_time: string;
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
Parameters
- corporationId: number
Returns AsyncGenerator<
    PageResult<
        {
            structure_id: number;
            moon_id: number;
            extraction_start_time: string;
            chunk_arrival_time: string;
            natural_decay_time: string;
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
- Defined in src/clients/IndustryClient.ts:227

streamCorporationMiningObservers

streamCorporationMiningObservers(
    corporationId: number,
): AsyncGenerator<
    PageResult<
        {
            observer_id: number;
            observer_type: string;
            last_updated: string;
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
Parameters
- corporationId: number
Returns AsyncGenerator<
    PageResult<
        {
            observer_id: number;
            observer_type: string;
            last_updated: string;
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
- Defined in src/clients/IndustryClient.ts:236

streamCorporationMiningObserver

streamCorporationMiningObserver(
    corporationId: number,
    observerId: number,
): AsyncGenerator<
    PageResult<
        {
            character_id: number;
            recorded_corporation_id: number;
            type_id: number;
            quantity: number;
            last_updated: string;
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
Parameters
- corporationId: number
- observerId: number
Returns AsyncGenerator<
    PageResult<
        {
            character_id: number;
            recorded_corporation_id: number;
            type_id: number;
            quantity: number;
            last_updated: string;
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
- Defined in src/clients/IndustryClient.ts:245

streamIndustryFacilities

streamIndustryFacilities(): AsyncGenerator<
    PageResult<
        {
            facility_id: number;
            owner_id: number;
            region_id: number;
            solar_system_id: number;
            tax?: number;
            type_id: number;
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
Returns AsyncGenerator<
    PageResult<
        {
            facility_id: number;
            owner_id: number;
            region_id: number;
            solar_system_id: number;
            tax?: number;
            type_id: number;
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
- Defined in src/clients/IndustryClient.ts:256

streamIndustrySystems

streamIndustrySystems(): AsyncGenerator<
    PageResult<
        {
            solar_system_id: number;
            cost_indices: {
                activity: string;
                cost_index: number;
                [key: string]: unknown;
            }[];
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
Returns AsyncGenerator<
    PageResult<
        {
            solar_system_id: number;
            cost_indices: {
                activity: string;
                cost_index: number;
                [key: string]: unknown;
            }[];
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
- Defined in src/clients/IndustryClient.ts:264

Class IndustryClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns IndustryClient

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

getCharacterIndustryJobs

Parameters

Requires

getCharacterMiningLedger

Parameters

Returns Promise< { date: string; solar_system_id: number; type_id: number; quantity: number; [key: string]: unknown; }[],>

Requires

getMoonExtractionTimers

Parameters

Returns Promise< { structure_id: number; moon_id: number; extraction_start_time: string; chunk_arrival_time: string; natural_decay_time: string; [key: string]: unknown; }[],>

Requires

getCorporationMiningObservers

Parameters

Returns Promise< { observer_id: number; observer_type: string; last_updated: string; [key: string]: unknown; }[],>

Requires

getCorporationMiningObserver

Parameters

Returns Promise< { character_id: number; recorded_corporation_id: number; type_id: number; quantity: number; last_updated: string; [key: string]: unknown; }[],>

Requires

getCorporationIndustryJobs

Parameters

Requires

getIndustryFacilities

Returns Promise< { facility_id: number; owner_id: number; region_id: number; solar_system_id: number; tax?: number; type_id: number; [key: string]: unknown; }[],>

getIndustrySystems

Returns Promise< { solar_system_id: number; cost_indices: { activity: string; cost_index: number; [key: string]: unknown; }[]; [key: string]: unknown; }[],>

fetchAllCharacterIndustryJobs

Parameters

fetchAllCharacterMiningLedger

Parameters

Returns Promise< { date: string; solar_system_id: number; type_id: number; quantity: number; [key: string]: unknown; }[],>

fetchAllCorporationIndustryJobs

Parameters

fetchAllMoonExtractionTimers

Parameters

Returns Promise< { structure_id: number; moon_id: number; extraction_start_time: string; chunk_arrival_time: string; natural_decay_time: string; [key: string]: unknown; }[],>

fetchAllCorporationMiningObservers

Parameters

Returns Promise< { observer_id: number; observer_type: string; last_updated: string; [key: string]: unknown; }[],>

fetchAllCorporationMiningObserver

Parameters

Returns Promise< { character_id: number; recorded_corporation_id: number; type_id: number; quantity: number; last_updated: string; [key: string]: unknown; }[],>

fetchAllIndustryFacilities

Parameters

Returns Promise< { facility_id: number; owner_id: number; region_id: number; solar_system_id: number; tax?: number; type_id: number; [key: string]: unknown; }[],>

fetchAllIndustrySystems

Parameters

Returns Promise< { solar_system_id: number; cost_indices: { activity: string; cost_index: number; [key: string]: unknown; }[]; [key: string]: unknown; }[],>

streamCharacterIndustryJobs

Parameters

streamCharacterMiningLedger

Parameters

Returns AsyncGenerator< PageResult< { date: string; solar_system_id: number; type_id: number; quantity: number; [key: string]: unknown; }, >, void, undefined,>

`Protected`api

`Protected`_client

`Protected`_endpoints

Returns Promise<
{
date: string;
solar_system_id: number;
type_id: number;
quantity: number;
[key: string]: unknown;
}[],
>

Returns Promise<
{
structure_id: number;
moon_id: number;
extraction_start_time: string;
chunk_arrival_time: string;
natural_decay_time: string;
[key: string]: unknown;
}[],
>

Returns Promise<
{
observer_id: number;
observer_type: string;
last_updated: string;
[key: string]: unknown;
}[],
>

Returns Promise<
{
character_id: number;
recorded_corporation_id: number;
type_id: number;
quantity: number;
last_updated: string;
[key: string]: unknown;
}[],
>

Returns Promise<
{
facility_id: number;
owner_id: number;
region_id: number;
solar_system_id: number;
tax?: number;
type_id: number;
[key: string]: unknown;
}[],
>

Returns Promise<
{
solar_system_id: number;
cost_indices: {
activity: string;
cost_index: number;
[key: string]: unknown;
}[];
[key: string]: unknown;
}[],
>

Returns Promise<
{
date: string;
solar_system_id: number;
type_id: number;
quantity: number;
[key: string]: unknown;
}[],
>

Returns Promise<
{
structure_id: number;
moon_id: number;
extraction_start_time: string;
chunk_arrival_time: string;
natural_decay_time: string;
[key: string]: unknown;
}[],
>

Returns Promise<
{
observer_id: number;
observer_type: string;
last_updated: string;
[key: string]: unknown;
}[],
>

Returns Promise<
{
character_id: number;
recorded_corporation_id: number;
type_id: number;
quantity: number;
last_updated: string;
[key: string]: unknown;
}[],
>

Returns Promise<
{
facility_id: number;
owner_id: number;
region_id: number;
solar_system_id: number;
tax?: number;
type_id: number;
[key: string]: unknown;
}[],
>

Returns Promise<
{
solar_system_id: number;
cost_indices: {
activity: string;
cost_index: number;
[key: string]: unknown;
}[];
[key: string]: unknown;
}[],
>

Returns AsyncGenerator<
PageResult<
{
date: string;
solar_system_id: number;
type_id: number;
quantity: number;
[key: string]: unknown;
},
>,
void,
undefined,
>

Returns AsyncGenerator<
PageResult<
{
structure_id: number;
moon_id: number;
extraction_start_time: string;
chunk_arrival_time: string;
natural_decay_time: string;
[key: string]: unknown;
},
>,
void,
undefined,
>

Returns AsyncGenerator<
PageResult<
{
observer_id: number;
observer_type: string;
last_updated: string;
[key: string]: unknown;
},
>,
void,
undefined,
>

Returns AsyncGenerator<
PageResult<
{
character_id: number;
recorded_corporation_id: number;
type_id: number;
quantity: number;
last_updated: string;
[key: string]: unknown;
},
>,
void,
undefined,
>

Returns AsyncGenerator<
PageResult<
{
facility_id: number;
owner_id: number;
region_id: number;
solar_system_id: number;
tax?: number;
type_id: number;
[key: string]: unknown;
},
>,
void,
undefined,
>

Returns AsyncGenerator<
PageResult<
{
solar_system_id: number;
cost_indices: {
activity: string;
cost_index: number;
[key: string]: unknown;
}[];
[key: string]: unknown;
},
>,
void,
undefined,
>