Class AssetsClient

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 assetEndpoints>
- AssetsClient

Constructors

constructor

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

Properties

`Protected`api

api: ClientMethods<T>

`Protected`_client

_client: ApiClient

`Protected`_endpoints

_endpoints: {
    getCharacterAssets: {
        path: "characters/{characterId}/assets/";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["characterId"];
        responseSchema: ZodArray<
            ZodObject<
                {
                    item_id: ZodNumber;
                    type_id: ZodNumber;
                    quantity: ZodNumber;
                    location_id: ZodNumber;
                    location_type: ZodType<
                        string & {}
                        | "other"
                        | "solar_system"
                        | "station"
                        | "item",
                        unknown,
                        $ZodTypeInternals<
                            string & {}
                            | "other"
                            | "solar_system"
                            | "station"
                            | "item",
                            unknown,
                        >,
                    >;
                    location_flag: ZodString;
                    is_singleton: ZodBoolean;
                    is_blueprint_copy: ZodOptional<ZodBoolean>;
                },
                $loose,
            >,
        >;
    };
    getCorporationAssets: {
        path: "corporations/{corporationId}/assets/";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["corporationId"];
        responseSchema: ZodArray<
            ZodObject<
                {
                    item_id: ZodNumber;
                    type_id: ZodNumber;
                    quantity: ZodNumber;
                    location_id: ZodNumber;
                    location_type: ZodType<
                        string & {}
                        | "other"
                        | "solar_system"
                        | "station"
                        | "item",
                        unknown,
                        $ZodTypeInternals<
                            string & {}
                            | "other"
                            | "solar_system"
                            | "station"
                            | "item",
                            unknown,
                        >,
                    >;
                    location_flag: ZodString;
                    is_singleton: ZodBoolean;
                    is_blueprint_copy: ZodOptional<ZodBoolean>;
                },
                $loose,
            >,
        >;
    };
    postCharacterAssetLocations: {
        path: "characters/{characterId}/assets/locations/";
        method: "POST";
        requiresAuth: true;
        pathParams: readonly ["characterId"];
        bodyBuilder: (itemIds: number[]) => number[];
        responseSchema: ZodArray<
            ZodObject<
                {
                    item_id: ZodNumber;
                    position: ZodObject<
                        { x: ZodNumber; y: ZodNumber; z: ZodNumber },
                        $loose,
                    >;
                },
                $loose,
            >,
        >;
    };
    postCharacterAssetNames: {
        path: "characters/{characterId}/assets/names/";
        method: "POST";
        requiresAuth: true;
        pathParams: readonly ["characterId"];
        bodyBuilder: (itemIds: number[]) => number[];
        responseSchema: ZodArray<
            ZodObject<{ item_id: ZodNumber; name: ZodString }, $loose>,
        >;
    };
    postCorporationAssetLocations: {
        path: "corporations/{corporationId}/assets/locations/";
        method: "POST";
        responseSchema: ZodArray<
            ZodObject<
                {
                    item_id: ZodNumber;
                    position: ZodObject<
                        { x: ZodNumber; y: ZodNumber; z: ZodNumber },
                        $loose,
                    >;
                },
                $loose,
            >,
        >;
        requiresAuth: true;
        pathParams: readonly ["corporationId"];
        bodyBuilder: (itemIds: number[]) => number[];
    };
    postCorporationAssetNames: {
        path: "corporations/{corporationId}/assets/names/";
        method: "POST";
        responseSchema: ZodArray<
            ZodObject<{ item_id: ZodNumber; name: ZodString }, $loose>,
        >;
        requiresAuth: true;
        pathParams: readonly ["corporationId"];
        bodyBuilder: (itemIds: number[]) => number[];
    };
}

Methods

getCharacterAssets

getCharacterAssets(
    characterId: number,
): Promise<
    {
        item_id: number;
        type_id: number;
        quantity: number;
        location_id: number;
        location_type: string & {}
        | "other"
        | "solar_system"
        | "station"
        | "item";
        location_flag: string;
        is_singleton: boolean;
        is_blueprint_copy?: boolean;
        [key: string]: unknown;
    }[],
>
Retrieve a list of assets owned by a character.
Parameters
- characterId: number
  The ID of the character whose assets to retrieve
Returns Promise<
    {
        item_id: number;
        type_id: number;
        quantity: number;
        location_id: number;
        location_type: string & {}
        | "other"
        | "solar_system"
        | "station"
        | "item";
        location_flag: string;
        is_singleton: boolean;
        is_blueprint_copy?: boolean;
        [key: string]: unknown;
    }[],
>
A list of the character's assets including type, quantity, and location

Requires
Authentication
- Defined in src/clients/AssetsClient.ts:23

postCharacterAssetLocations

postCharacterAssetLocations(
    characterId: number,
    itemIds: number[],
): Promise<
    {
        item_id: number;
        position: { x: number; y: number; z: number; [key: string]: unknown };
        [key: string]: unknown;
    }[],
>
Look up the locations of specific assets owned by a character via a bulk POST request.
Parameters
- characterId: number
  The ID of the character who owns the assets
- itemIds: number[]
  An array of item IDs to look up locations for
Returns Promise<
    {
        item_id: number;
        position: { x: number; y: number; z: number; [key: string]: unknown };
        [key: string]: unknown;
    }[],
>
Location information for each requested asset

Requires
Authentication
- Defined in src/clients/AssetsClient.ts:35

postCharacterAssetNames

postCharacterAssetNames(
characterId: number,
itemIds: number[],
): Promise<{ item_id: number; name: string; [key: string]: unknown }[]>
Look up the names of specific assets owned by a character via a bulk POST request.
Parameters
- characterId: number
  The ID of the character who owns the assets
- itemIds: number[]
  An array of item IDs to look up names for
Returns Promise<{ item_id: number; name: string; [key: string]: unknown }[]>
The user-assigned names for each requested asset

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

getCorporationAssets

getCorporationAssets(
    corporationId: number,
): Promise<
    {
        item_id: number;
        type_id: number;
        quantity: number;
        location_id: number;
        location_type: string & {}
        | "other"
        | "solar_system"
        | "station"
        | "item";
        location_flag: string;
        is_singleton: boolean;
        is_blueprint_copy?: boolean;
        [key: string]: unknown;
    }[],
>
Retrieve a list of assets owned by a corporation.
Parameters
- corporationId: number
  The ID of the corporation whose assets to retrieve
Returns Promise<
    {
        item_id: number;
        type_id: number;
        quantity: number;
        location_id: number;
        location_type: string & {}
        | "other"
        | "solar_system"
        | "station"
        | "item";
        location_flag: string;
        is_singleton: boolean;
        is_blueprint_copy?: boolean;
        [key: string]: unknown;
    }[],
>
A list of the corporation's assets including type, quantity, and location

Requires
Authentication
- Defined in src/clients/AssetsClient.ts:64

postCorporationAssetLocations

postCorporationAssetLocations(
    corporationId: number,
    itemIds: number[],
): Promise<
    {
        item_id: number;
        position: { x: number; y: number; z: number; [key: string]: unknown };
        [key: string]: unknown;
    }[],
>
Look up the locations of specific assets owned by a corporation via a bulk POST request.
Parameters
- corporationId: number
  The ID of the corporation that owns the assets
- itemIds: number[]
  An array of item IDs to look up locations for
Returns Promise<
    {
        item_id: number;
        position: { x: number; y: number; z: number; [key: string]: unknown };
        [key: string]: unknown;
    }[],
>
Location information for each requested asset

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

postCorporationAssetNames

postCorporationAssetNames(
corporationId: number,
itemIds: number[],
): Promise<{ item_id: number; name: string; [key: string]: unknown }[]>
Look up the names of specific assets owned by a corporation via a bulk POST request.
Parameters
- corporationId: number
  The ID of the corporation that owns the assets
- itemIds: number[]
  An array of item IDs to look up names for
Returns Promise<{ item_id: number; name: string; [key: string]: unknown }[]>
The user-assigned names for each requested asset

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

fetchAllCharacterAssets

fetchAllCharacterAssets(
    characterId: number,
    concurrency?: number,
): Promise<
    {
        item_id: number;
        type_id: number;
        quantity: number;
        location_id: number;
        location_type: string & {}
        | "other"
        | "solar_system"
        | "station"
        | "item";
        location_flag: string;
        is_singleton: boolean;
        is_blueprint_copy?: boolean;
        [key: string]: unknown;
    }[],
>
Parameters
- characterId: number
- Optionalconcurrency: number
Returns Promise<
    {
        item_id: number;
        type_id: number;
        quantity: number;
        location_id: number;
        location_type: string & {}
        | "other"
        | "solar_system"
        | "station"
        | "item";
        location_flag: string;
        is_singleton: boolean;
        is_blueprint_copy?: boolean;
        [key: string]: unknown;
    }[],
>
- Defined in src/clients/AssetsClient.ts:98

fetchAllCorporationAssets

fetchAllCorporationAssets(
    corporationId: number,
    concurrency?: number,
): Promise<
    {
        item_id: number;
        type_id: number;
        quantity: number;
        location_id: number;
        location_type: string & {}
        | "other"
        | "solar_system"
        | "station"
        | "item";
        location_flag: string;
        is_singleton: boolean;
        is_blueprint_copy?: boolean;
        [key: string]: unknown;
    }[],
>
Parameters
- corporationId: number
- Optionalconcurrency: number
Returns Promise<
    {
        item_id: number;
        type_id: number;
        quantity: number;
        location_id: number;
        location_type: string & {}
        | "other"
        | "solar_system"
        | "station"
        | "item";
        location_flag: string;
        is_singleton: boolean;
        is_blueprint_copy?: boolean;
        [key: string]: unknown;
    }[],
>
- Defined in src/clients/AssetsClient.ts:109

streamCharacterAssets

streamCharacterAssets(
    characterId: number,
): AsyncGenerator<
    PageResult<
        {
            item_id: number;
            type_id: number;
            quantity: number;
            location_id: number;
            location_type: | string & {}
            | "other"
            | "solar_system"
            | "station"
            | "item";
            location_flag: string;
            is_singleton: boolean;
            is_blueprint_copy?: boolean;
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
Parameters
- characterId: number
Returns AsyncGenerator<
    PageResult<
        {
            item_id: number;
            type_id: number;
            quantity: number;
            location_id: number;
            location_type: | string & {}
            | "other"
            | "solar_system"
            | "station"
            | "item";
            location_flag: string;
            is_singleton: boolean;
            is_blueprint_copy?: boolean;
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
- Defined in src/clients/AssetsClient.ts:120

streamCorporationAssets

streamCorporationAssets(
    corporationId: number,
): AsyncGenerator<
    PageResult<
        {
            item_id: number;
            type_id: number;
            quantity: number;
            location_id: number;
            location_type: | string & {}
            | "other"
            | "solar_system"
            | "station"
            | "item";
            location_flag: string;
            is_singleton: boolean;
            is_blueprint_copy?: boolean;
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
Parameters
- corporationId: number
Returns AsyncGenerator<
    PageResult<
        {
            item_id: number;
            type_id: number;
            quantity: number;
            location_id: number;
            location_type: | string & {}
            | "other"
            | "solar_system"
            | "station"
            | "item";
            location_flag: string;
            is_singleton: boolean;
            is_blueprint_copy?: boolean;
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
- Defined in src/clients/AssetsClient.ts:129

streamEndpoint

streamEndpoint<R>(
    endpointName:
        | "getCharacterAssets"
        | "getCorporationAssets"
        | "postCharacterAssetLocations"
        | "postCharacterAssetNames"
        | "postCorporationAssetLocations"
        | "postCorporationAssetNames",
    ...args: unknown[],
): AsyncGenerator<PageResult<R>, void, undefined>
Type Parameters
- R
Parameters
- endpointName:
      | "getCharacterAssets"
      | "getCorporationAssets"
      | "postCharacterAssetLocations"
      | "postCharacterAssetNames"
      | "postCorporationAssetLocations"
      | "postCorporationAssetNames"
- ...args: unknown[]
Returns AsyncGenerator<PageResult<R>, void, undefined>
Inherited from BaseEsiClient.streamEndpoint
- Defined in src/clients/BaseEsiClient.ts:45

fetchAllEndpoint

fetchAllEndpoint<R>(
    endpointName:
        | "getCharacterAssets"
        | "getCorporationAssets"
        | "postCharacterAssetLocations"
        | "postCharacterAssetNames"
        | "postCorporationAssetLocations"
        | "postCorporationAssetNames",
    args: unknown[],
    concurrency?: number,
): Promise<R[]>
Type Parameters
- R
Parameters
- endpointName:
      | "getCharacterAssets"
      | "getCorporationAssets"
      | "postCharacterAssetLocations"
      | "postCharacterAssetNames"
      | "postCorporationAssetLocations"
      | "postCorporationAssetNames"
- 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

Class AssetsClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AssetsClient

Properties

Protectedapi

Protected_client

Protected_endpoints

Methods

getCharacterAssets

Parameters

Returns Promise< { item_id: number; type_id: number; quantity: number; location_id: number; location_type: string & {} | "other" | "solar_system" | "station" | "item"; location_flag: string; is_singleton: boolean; is_blueprint_copy?: boolean; [key: string]: unknown; }[],>

Requires

postCharacterAssetLocations

Parameters

Returns Promise< { item_id: number; position: { x: number; y: number; z: number; [key: string]: unknown }; [key: string]: unknown; }[],>

Requires

postCharacterAssetNames

Parameters

Returns Promise<{ item_id: number; name: string; [key: string]: unknown }[]>

Requires

getCorporationAssets

Parameters

Returns Promise< { item_id: number; type_id: number; quantity: number; location_id: number; location_type: string & {} | "other" | "solar_system" | "station" | "item"; location_flag: string; is_singleton: boolean; is_blueprint_copy?: boolean; [key: string]: unknown; }[],>

Requires

postCorporationAssetLocations

Parameters

Returns Promise< { item_id: number; position: { x: number; y: number; z: number; [key: string]: unknown }; [key: string]: unknown; }[],>

Requires

postCorporationAssetNames

Parameters

Returns Promise<{ item_id: number; name: string; [key: string]: unknown }[]>

Requires

fetchAllCharacterAssets

Parameters

Returns Promise< { item_id: number; type_id: number; quantity: number; location_id: number; location_type: string & {} | "other" | "solar_system" | "station" | "item"; location_flag: string; is_singleton: boolean; is_blueprint_copy?: boolean; [key: string]: unknown; }[],>

fetchAllCorporationAssets

Parameters

Returns Promise< { item_id: number; type_id: number; quantity: number; location_id: number; location_type: string & {} | "other" | "solar_system" | "station" | "item"; location_flag: string; is_singleton: boolean; is_blueprint_copy?: boolean; [key: string]: unknown; }[],>

streamCharacterAssets

Parameters

streamCorporationAssets

Parameters

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

Settings

On This Page

`Protected`api

`Protected`_client

`Protected`_endpoints

Returns Promise<
{
item_id: number;
type_id: number;
quantity: number;
location_id: number;
location_type: string & {}
| "other"
| "solar_system"
| "station"
| "item";
location_flag: string;
is_singleton: boolean;
is_blueprint_copy?: boolean;
[key: string]: unknown;
}[],
>

Returns Promise<
{
item_id: number;
position: { x: number; y: number; z: number; [key: string]: unknown };
[key: string]: unknown;
}[],
>

Returns Promise<
{
item_id: number;
type_id: number;
quantity: number;
location_id: number;
location_type: string & {}
| "other"
| "solar_system"
| "station"
| "item";
location_flag: string;
is_singleton: boolean;
is_blueprint_copy?: boolean;
[key: string]: unknown;
}[],
>

Returns Promise<
{
item_id: number;
position: { x: number; y: number; z: number; [key: string]: unknown };
[key: string]: unknown;
}[],
>

Returns Promise<
{
item_id: number;
type_id: number;
quantity: number;
location_id: number;
location_type: string & {}
| "other"
| "solar_system"
| "station"
| "item";
location_flag: string;
is_singleton: boolean;
is_blueprint_copy?: boolean;
[key: string]: unknown;
}[],
>

Returns Promise<
{
item_id: number;
type_id: number;
quantity: number;
location_id: number;
location_type: string & {}
| "other"
| "solar_system"
| "station"
| "item";
location_flag: string;
is_singleton: boolean;
is_blueprint_copy?: boolean;
[key: string]: unknown;
}[],
>