Class ParagonHubClient

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 paragonHubEndpoints>
- ParagonHubClient

Index

Constructors

constructor

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

Properties

`Protected`api

api: ClientMethods<T>

`Protected`_client

_client: ApiClient

`Protected`_endpoints

_endpoints: {
    getPublicListings: {
        path: "paragon-hub/skinr";
        method: "GET";
        requiresAuth: false;
        queryParams: { after: "after"; before: "before"; limit: "limit" };
        responseSchema: ZodObject<
            {
                cursor: ZodOptional<
                    ZodObject<
                        { after: ZodOptional<ZodString>; before: ZodOptional<ZodString> },
                        $loose,
                    >,
                >;
                listings: ZodArray<
                    ZodObject<
                        {
                            id: ZodString;
                            state: ZodType<
                                string & {}
                                | "expired"
                                | "removed"
                                | "listed"
                                | "sold_out",
                                unknown,
                                $ZodTypeInternals<
                                    (...) & (...)
                                    | "expired"
                                    | "removed"
                                    | "listed"
                                    | "sold_out",
                                    unknown,
                                >,
                            >;
                            last_modified: ZodString;
                            seller_id: ZodNumber;
                            skinr_id: ZodString;
                            created: ZodString;
                            expires: ZodString;
                            quantity: ZodNumber;
                            price: ZodObject<
                                { isk: ZodOptional<ZodNumber>; plex: ZodOptional<ZodNumber> },
                                $loose,
                            >;
                        },
                        $loose,
                    >,
                >;
            },
            $loose,
        >;
    };
    getCharacterListings: {
        path: "characters/{characterId}/paragon-hub/skinr";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["characterId"];
        queryParams: { after: "after"; before: "before"; limit: "limit" };
        responseSchema: ZodObject<
            {
                cursor: ZodOptional<
                    ZodObject<
                        { after: ZodOptional<ZodString>; before: ZodOptional<ZodString> },
                        $loose,
                    >,
                >;
                listings: ZodArray<
                    ZodObject<
                        {
                            id: ZodString;
                            state: ZodType<
                                string & {}
                                | "expired"
                                | "removed"
                                | "listed"
                                | "sold_out",
                                unknown,
                                $ZodTypeInternals<
                                    (...) & (...)
                                    | "expired"
                                    | "removed"
                                    | "listed"
                                    | "sold_out",
                                    unknown,
                                >,
                            >;
                            last_modified: ZodString;
                            seller_id: ZodNumber;
                            skinr_id: ZodString;
                            created: ZodString;
                            expires: ZodString;
                            quantity: ZodNumber;
                            price: ZodObject<
                                { isk: ZodOptional<ZodNumber>; plex: ZodOptional<ZodNumber> },
                                $loose,
                            >;
                            target: ZodObject<
                                {
                                    character_id: ZodOptional<ZodNumber>;
                                    corporation_id: ZodOptional<ZodNumber>;
                                    alliance_id: ZodOptional<ZodNumber>;
                                    public: ZodOptional<ZodBoolean>;
                                },
                                $loose,
                            >;
                        },
                        $loose,
                    >,
                >;
            },
            $loose,
        >;
    };
    getAllianceListings: {
        path: "paragon-hub/skinr/alliances/{allianceId}";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["allianceId"];
        queryParams: { after: "after"; before: "before"; limit: "limit" };
        responseSchema: ZodObject<
            {
                cursor: ZodOptional<
                    ZodObject<
                        { after: ZodOptional<ZodString>; before: ZodOptional<ZodString> },
                        $loose,
                    >,
                >;
                listings: ZodArray<
                    ZodObject<
                        {
                            id: ZodString;
                            state: ZodType<
                                string & {}
                                | "expired"
                                | "removed"
                                | "listed"
                                | "sold_out",
                                unknown,
                                $ZodTypeInternals<
                                    (...) & (...)
                                    | "expired"
                                    | "removed"
                                    | "listed"
                                    | "sold_out",
                                    unknown,
                                >,
                            >;
                            last_modified: ZodString;
                            seller_id: ZodNumber;
                            skinr_id: ZodString;
                            created: ZodString;
                            expires: ZodString;
                            quantity: ZodNumber;
                            price: ZodObject<
                                { isk: ZodOptional<ZodNumber>; plex: ZodOptional<ZodNumber> },
                                $loose,
                            >;
                        },
                        $loose,
                    >,
                >;
            },
            $loose,
        >;
    };
    getCharacterTargetedListings: {
        path: "paragon-hub/skinr/characters/{characterId}";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["characterId"];
        queryParams: { after: "after"; before: "before"; limit: "limit" };
        responseSchema: ZodObject<
            {
                cursor: ZodOptional<
                    ZodObject<
                        { after: ZodOptional<ZodString>; before: ZodOptional<ZodString> },
                        $loose,
                    >,
                >;
                listings: ZodArray<
                    ZodObject<
                        {
                            id: ZodString;
                            state: ZodType<
                                string & {}
                                | "expired"
                                | "removed"
                                | "listed"
                                | "sold_out",
                                unknown,
                                $ZodTypeInternals<
                                    (...) & (...)
                                    | "expired"
                                    | "removed"
                                    | "listed"
                                    | "sold_out",
                                    unknown,
                                >,
                            >;
                            last_modified: ZodString;
                            seller_id: ZodNumber;
                            skinr_id: ZodString;
                            created: ZodString;
                            expires: ZodString;
                            quantity: ZodNumber;
                            price: ZodObject<
                                { isk: ZodOptional<ZodNumber>; plex: ZodOptional<ZodNumber> },
                                $loose,
                            >;
                        },
                        $loose,
                    >,
                >;
            },
            $loose,
        >;
    };
    getCorporationListings: {
        path: "paragon-hub/skinr/corporations/{corporationId}";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["corporationId"];
        queryParams: { after: "after"; before: "before"; limit: "limit" };
        responseSchema: ZodObject<
            {
                cursor: ZodOptional<
                    ZodObject<
                        { after: ZodOptional<ZodString>; before: ZodOptional<ZodString> },
                        $loose,
                    >,
                >;
                listings: ZodArray<
                    ZodObject<
                        {
                            id: ZodString;
                            state: ZodType<
                                string & {}
                                | "expired"
                                | "removed"
                                | "listed"
                                | "sold_out",
                                unknown,
                                $ZodTypeInternals<
                                    (...) & (...)
                                    | "expired"
                                    | "removed"
                                    | "listed"
                                    | "sold_out",
                                    unknown,
                                >,
                            >;
                            last_modified: ZodString;
                            seller_id: ZodNumber;
                            skinr_id: ZodString;
                            created: ZodString;
                            expires: ZodString;
                            quantity: ZodNumber;
                            price: ZodObject<
                                { isk: ZodOptional<ZodNumber>; plex: ZodOptional<ZodNumber> },
                                $loose,
                            >;
                        },
                        $loose,
                    >,
                >;
            },
            $loose,
        >;
    };
}

Methods

streamEndpoint

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

fetchAllEndpoint

fetchAllEndpoint<R>(
    endpointName:
        | "getPublicListings"
        | "getCharacterListings"
        | "getAllianceListings"
        | "getCharacterTargetedListings"
        | "getCorporationListings",
    args: unknown[],
    concurrency?: number,
): Promise<R[]>
Type Parameters
- R
Parameters
- endpointName:
      | "getPublicListings"
      | "getCharacterListings"
      | "getAllianceListings"
      | "getCharacterTargetedListings"
      | "getCorporationListings"
- 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

getPublicListings

getPublicListings(
    after?: string,
    before?: string,
    limit?: number,
): Promise<
    {
        cursor?: { after?: string; before?: string; [key: string]: unknown };
        listings: {
            id: string;
            state: string & {} | "expired" | "removed" | "listed" | "sold_out";
            last_modified: string;
            seller_id: number;
            skinr_id: string;
            created: string;
            expires: string;
            quantity: number;
            price: { isk?: number; plex?: number; [key: string]: unknown };
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
Parameters
- Optionalafter: string
- Optionalbefore: string
- Optionallimit: number
Returns Promise<
    {
        cursor?: { after?: string; before?: string; [key: string]: unknown };
        listings: {
            id: string;
            state: string & {} | "expired" | "removed" | "listed" | "sold_out";
            last_modified: string;
            seller_id: number;
            skinr_id: string;
            created: string;
            expires: string;
            quantity: number;
            price: { isk?: number; plex?: number; [key: string]: unknown };
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
- Defined in src/clients/ParagonHubClient.ts:16

getCharacterListings

getCharacterListings(
    characterId: number,
    after?: string,
    before?: string,
    limit?: number,
): Promise<
    {
        cursor?: { after?: string; before?: string; [key: string]: unknown };
        listings: {
            id: string;
            state: string & {} | "expired" | "removed" | "listed" | "sold_out";
            last_modified: string;
            seller_id: number;
            skinr_id: string;
            created: string;
            expires: string;
            quantity: number;
            price: { isk?: number; plex?: number; [key: string]: unknown };
            target: {
                character_id?: number;
                corporation_id?: number;
                alliance_id?: number;
                public?: boolean;
                [key: string]: unknown;
            };
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
Parameters
- characterId: number
- Optionalafter: string
- Optionalbefore: string
- Optionallimit: number
Returns Promise<
    {
        cursor?: { after?: string; before?: string; [key: string]: unknown };
        listings: {
            id: string;
            state: string & {} | "expired" | "removed" | "listed" | "sold_out";
            last_modified: string;
            seller_id: number;
            skinr_id: string;
            created: string;
            expires: string;
            quantity: number;
            price: { isk?: number; plex?: number; [key: string]: unknown };
            target: {
                character_id?: number;
                corporation_id?: number;
                alliance_id?: number;
                public?: boolean;
                [key: string]: unknown;
            };
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
- Defined in src/clients/ParagonHubClient.ts:24

getAllianceListings

getAllianceListings(
    allianceId: number,
    after?: string,
    before?: string,
    limit?: number,
): Promise<
    {
        cursor?: { after?: string; before?: string; [key: string]: unknown };
        listings: {
            id: string;
            state: string & {} | "expired" | "removed" | "listed" | "sold_out";
            last_modified: string;
            seller_id: number;
            skinr_id: string;
            created: string;
            expires: string;
            quantity: number;
            price: { isk?: number; plex?: number; [key: string]: unknown };
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
Parameters
- allianceId: number
- Optionalafter: string
- Optionalbefore: string
- Optionallimit: number
Returns Promise<
    {
        cursor?: { after?: string; before?: string; [key: string]: unknown };
        listings: {
            id: string;
            state: string & {} | "expired" | "removed" | "listed" | "sold_out";
            last_modified: string;
            seller_id: number;
            skinr_id: string;
            created: string;
            expires: string;
            quantity: number;
            price: { isk?: number; plex?: number; [key: string]: unknown };
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
- Defined in src/clients/ParagonHubClient.ts:33

getCharacterTargetedListings

getCharacterTargetedListings(
    characterId: number,
    after?: string,
    before?: string,
    limit?: number,
): Promise<
    {
        cursor?: { after?: string; before?: string; [key: string]: unknown };
        listings: {
            id: string;
            state: string & {} | "expired" | "removed" | "listed" | "sold_out";
            last_modified: string;
            seller_id: number;
            skinr_id: string;
            created: string;
            expires: string;
            quantity: number;
            price: { isk?: number; plex?: number; [key: string]: unknown };
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
Parameters
- characterId: number
- Optionalafter: string
- Optionalbefore: string
- Optionallimit: number
Returns Promise<
    {
        cursor?: { after?: string; before?: string; [key: string]: unknown };
        listings: {
            id: string;
            state: string & {} | "expired" | "removed" | "listed" | "sold_out";
            last_modified: string;
            seller_id: number;
            skinr_id: string;
            created: string;
            expires: string;
            quantity: number;
            price: { isk?: number; plex?: number; [key: string]: unknown };
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
- Defined in src/clients/ParagonHubClient.ts:42

getCorporationListings

getCorporationListings(
    corporationId: number,
    after?: string,
    before?: string,
    limit?: number,
): Promise<
    {
        cursor?: { after?: string; before?: string; [key: string]: unknown };
        listings: {
            id: string;
            state: string & {} | "expired" | "removed" | "listed" | "sold_out";
            last_modified: string;
            seller_id: number;
            skinr_id: string;
            created: string;
            expires: string;
            quantity: number;
            price: { isk?: number; plex?: number; [key: string]: unknown };
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
Parameters
- corporationId: number
- Optionalafter: string
- Optionalbefore: string
- Optionallimit: number
Returns Promise<
    {
        cursor?: { after?: string; before?: string; [key: string]: unknown };
        listings: {
            id: string;
            state: string & {} | "expired" | "removed" | "listed" | "sold_out";
            last_modified: string;
            seller_id: number;
            skinr_id: string;
            created: string;
            expires: string;
            quantity: number;
            price: { isk?: number; plex?: number; [key: string]: unknown };
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
- Defined in src/clients/ParagonHubClient.ts:56

Class ParagonHubClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ParagonHubClient

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

getPublicListings

Parameters

getCharacterListings

Parameters

getAllianceListings

Parameters

getCharacterTargetedListings

Parameters

getCorporationListings

Parameters

Settings

On This Page

Class ParagonHubClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ParagonHubClient

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

getPublicListings

Parameters

getCharacterListings

Parameters

getAllianceListings

Parameters

getCharacterTargetedListings

Parameters

getCorporationListings

Parameters

Settings

On This Page

`Protected`api

`Protected`_client

`Protected`_endpoints