Class CosmeticsClient

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 cosmeticsEndpoints>
- CosmeticsClient

Index

Constructors

constructor

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

Properties

`Protected`api

api: ClientMethods<T>

`Protected`_client

_client: ApiClient

`Protected`_endpoints

_endpoints: {
    getCharacterSkinr: {
        path: "characters/{characterId}/cosmetics/skinr";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["characterId"];
        responseSchema: ZodObject<
            {
                licenses: ZodArray<
                    ZodObject<
                        {
                            skinr_id: ZodString;
                            activated: ZodBoolean;
                            unactivated: ZodNumber;
                        },
                        $loose,
                    >,
                >;
            },
            $loose,
        >;
    };
    getCharacterSkinrComponents: {
        path: "characters/{characterId}/cosmetics/skinr/components";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["characterId"];
        responseSchema: ZodObject<
            {
                licenses: ZodArray<
                    ZodObject<
                        {
                            component_id: ZodNumber;
                            type: ZodType<
                                string & {}
                                | "pattern"
                                | "nanocoating",
                                unknown,
                                $ZodTypeInternals<
                                    (...) & (...)
                                    | "pattern"
                                    | "nanocoating",
                                    unknown,
                                >,
                            >;
                            runs: ZodObject<
                                {
                                    remaining: ZodOptional<ZodNumber>;
                                    unlimited: ZodOptional<ZodBoolean>;
                                },
                                $loose,
                            >;
                        },
                        $loose,
                    >,
                >;
            },
            $loose,
        >;
    };
    getSkinr: {
        path: "cosmetics/skinr/{skinrId}";
        method: "GET";
        requiresAuth: false;
        pathParams: readonly ["skinrId"];
        responseSchema: ZodObject<
            {
                id: ZodString;
                name: ZodString;
                creator_id: ZodNumber;
                ship_type_id: ZodNumber;
                line: ZodOptional<ZodString>;
                tier: ZodObject<{ level: ZodNumber }, $loose>;
                layout: ZodObject<
                    {
                        slots: ZodArray<
                            ZodObject<
                                { id: ZodNumber; configuration: ZodObject<{}, $loose> },
                                $loose,
                            >,
                        >;
                        pattern_blend_mode: ZodType<
                            | string & {}
                            | "normal"
                            | "subtract"
                            | "exclusion"
                            | "nested"
                            | "nested_inverted",
                            unknown,
                            $ZodTypeInternals<
                                | string & {}
                                | "normal"
                                | "subtract"
                                | "exclusion"
                                | "nested"
                                | "nested_inverted",
                                unknown,
                            >,
                        >;
                    },
                    $loose,
                >;
            },
            $loose,
        >;
    };
}

Methods

streamEndpoint

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

fetchAllEndpoint

fetchAllEndpoint<R>(
    endpointName:
        | "getCharacterSkinr"
        | "getCharacterSkinrComponents"
        | "getSkinr",
    args: unknown[],
    concurrency?: number,
): Promise<R[]>
Type Parameters
- R
Parameters
- endpointName: "getCharacterSkinr" | "getCharacterSkinrComponents" | "getSkinr"
- 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

getCharacterSkinr

getCharacterSkinr(
    characterId: number,
): Promise<
    {
        licenses: {
            skinr_id: string;
            activated: boolean;
            unactivated: number;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
Parameters
- characterId: number
Returns Promise<
    {
        licenses: {
            skinr_id: string;
            activated: boolean;
            unactivated: number;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
- Defined in src/clients/CosmeticsClient.ts:15

getCharacterSkinrComponents

getCharacterSkinrComponents(
    characterId: number,
): Promise<
    {
        licenses: {
            component_id: number;
            type: string & {}
            | "pattern"
            | "nanocoating";
            runs: { remaining?: number; unlimited?: boolean; [key: string]: unknown };
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
Parameters
- characterId: number
Returns Promise<
    {
        licenses: {
            component_id: number;
            type: string & {}
            | "pattern"
            | "nanocoating";
            runs: { remaining?: number; unlimited?: boolean; [key: string]: unknown };
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
- Defined in src/clients/CosmeticsClient.ts:19

getSkinr

getSkinr(
    skinrId: string,
): Promise<
    {
        id: string;
        name: string;
        creator_id: number;
        ship_type_id: number;
        line?: string;
        tier: { level: number; [key: string]: unknown };
        layout: {
            slots: {
                id: number;
                configuration: { [key: string]: unknown };
                [key: string]: unknown;
            }[];
            pattern_blend_mode: | string & {}
            | "normal"
            | "subtract"
            | "exclusion"
            | "nested"
            | "nested_inverted";
            [key: string]: unknown;
        };
        [key: string]: unknown;
    },
>
Parameters
- skinrId: string
Returns Promise<
    {
        id: string;
        name: string;
        creator_id: number;
        ship_type_id: number;
        line?: string;
        tier: { level: number; [key: string]: unknown };
        layout: {
            slots: {
                id: number;
                configuration: { [key: string]: unknown };
                [key: string]: unknown;
            }[];
            pattern_blend_mode: | string & {}
            | "normal"
            | "subtract"
            | "exclusion"
            | "nested"
            | "nested_inverted";
            [key: string]: unknown;
        };
        [key: string]: unknown;
    },
>
- Defined in src/clients/CosmeticsClient.ts:25

Class CosmeticsClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CosmeticsClient

Properties

`Protected`api

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

getCharacterSkinr

Parameters

Returns Promise<
    {
        licenses: {
            skinr_id: string;
            activated: boolean;
            unactivated: number;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>

getCharacterSkinrComponents

Parameters

getSkinr

Parameters

Settings

On This Page

Class CosmeticsClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CosmeticsClient

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

getCharacterSkinr

Parameters

Returns Promise< { licenses: { skinr_id: string; activated: boolean; unactivated: number; [key: string]: unknown; }[]; [key: string]: unknown; },>

getCharacterSkinrComponents

Parameters

Returns Promise< { licenses: { component_id: number; type: string & {} | "pattern" | "nanocoating"; runs: { remaining?: number; unlimited?: boolean; [key: string]: unknown }; [key: string]: unknown; }[]; [key: string]: unknown; },>

getSkinr

Parameters

Settings

On This Page

`Protected`api

`Protected`_client

`Protected`_endpoints

Returns Promise<
{
licenses: {
skinr_id: string;
activated: boolean;
unactivated: number;
[key: string]: unknown;
}[];
[key: string]: unknown;
},
>

Returns Promise<
{
licenses: {
component_id: number;
type: string & {}
| "pattern"
| "nanocoating";
runs: { remaining?: number; unlimited?: boolean; [key: string]: unknown };
[key: string]: unknown;
}[];
[key: string]: unknown;
},
>