@lgriffin/esi.ts - EVE Online ESI API Client - v12.3.0
    Preparing search index...

    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)

    Index
    api: ClientMethods<T>
    _client: ApiClient
    _endpoints: {
        getAllianceContacts: {
            path: "alliances/{allianceId}/contacts";
            method: "GET";
            requiresAuth: true;
            pathParams: readonly ["allianceId"];
            responseSchema: ZodArray<
                ZodObject<
                    {
                        contact_id: ZodNumber;
                        contact_type: ZodType<
                            string & {}
                            | "faction"
                            | "character"
                            | "corporation"
                            | "alliance",
                            unknown,
                            $ZodTypeInternals<
                                string & {}
                                | "faction"
                                | "character"
                                | "corporation"
                                | "alliance",
                                unknown,
                            >,
                        >;
                        standing: ZodNumber;
                        label_ids: ZodOptional<ZodArray<ZodNumber>>;
                        is_blocked: ZodOptional<ZodBoolean>;
                        is_watched: ZodOptional<ZodBoolean>;
                    },
                    $loose,
                >,
            >;
        };
        getAllianceContactLabels: {
            path: "alliances/{allianceId}/contacts/labels";
            method: "GET";
            requiresAuth: true;
            pathParams: readonly ["allianceId"];
            responseSchema: ZodArray<
                ZodObject<{ label_id: ZodNumber; label_name: ZodString }, $loose>,
            >;
        };
        getCharacterContacts: {
            path: "characters/{characterId}/contacts";
            method: "GET";
            requiresAuth: true;
            pathParams: readonly ["characterId"];
            responseSchema: ZodArray<
                ZodObject<
                    {
                        contact_id: ZodNumber;
                        contact_type: ZodType<
                            string & {}
                            | "faction"
                            | "character"
                            | "corporation"
                            | "alliance",
                            unknown,
                            $ZodTypeInternals<
                                string & {}
                                | "faction"
                                | "character"
                                | "corporation"
                                | "alliance",
                                unknown,
                            >,
                        >;
                        standing: ZodNumber;
                        label_ids: ZodOptional<ZodArray<ZodNumber>>;
                        is_blocked: ZodOptional<ZodBoolean>;
                        is_watched: ZodOptional<ZodBoolean>;
                    },
                    $loose,
                >,
            >;
        };
        getCharacterContactLabels: {
            path: "characters/{characterId}/contacts/labels";
            method: "GET";
            requiresAuth: true;
            pathParams: readonly ["characterId"];
            responseSchema: ZodArray<
                ZodObject<{ label_id: ZodNumber; label_name: ZodString }, $loose>,
            >;
        };
        getCorporationContacts: {
            path: "corporations/{corporationId}/contacts";
            method: "GET";
            requiresAuth: true;
            pathParams: readonly ["corporationId"];
            responseSchema: ZodArray<
                ZodObject<
                    {
                        contact_id: ZodNumber;
                        contact_type: ZodType<
                            string & {}
                            | "faction"
                            | "character"
                            | "corporation"
                            | "alliance",
                            unknown,
                            $ZodTypeInternals<
                                string & {}
                                | "faction"
                                | "character"
                                | "corporation"
                                | "alliance",
                                unknown,
                            >,
                        >;
                        standing: ZodNumber;
                        label_ids: ZodOptional<ZodArray<ZodNumber>>;
                        is_blocked: ZodOptional<ZodBoolean>;
                        is_watched: ZodOptional<ZodBoolean>;
                    },
                    $loose,
                >,
            >;
        };
        getCorporationContactLabels: {
            path: "corporations/{corporationId}/contacts/labels";
            method: "GET";
            requiresAuth: true;
            pathParams: readonly ["corporationId"];
            responseSchema: ZodArray<
                ZodObject<{ label_id: ZodNumber; label_name: ZodString }, $loose>,
            >;
        };
        addContacts: {
            path: "characters/{characterId}/contacts";
            method: "POST";
            responseSchema: ZodArray<ZodNumber>;
            requiresAuth: true;
            pathParams: readonly ["characterId"];
            queryParams: { standing: "standing" };
            bodyBuilder: (contactIds: number[]) => number[];
            requestSchema: ZodArray<ZodNumber>;
        };
        editContacts: {
            path: "characters/{characterId}/contacts";
            method: "PUT";
            requiresAuth: true;
            pathParams: readonly ["characterId"];
            queryParams: { standing: "standing" };
            bodyBuilder: (contactIds: number[]) => number[];
        };
        deleteCharacterContacts: {
            path: "characters/{characterId}/contacts";
            method: "DELETE";
            requiresAuth: true;
            pathParams: readonly ["characterId"];
            queryParams: { contactIds: "contact_ids" };
        };
    }
    • Type Parameters

      • R

      Parameters

      • endpointName:
            | "getAllianceContacts"
            | "getAllianceContactLabels"
            | "getCharacterContacts"
            | "getCharacterContactLabels"
            | "getCorporationContacts"
            | "getCorporationContactLabels"
            | "addContacts"
            | "editContacts"
            | "deleteCharacterContacts"
      • ...args: unknown[]

      Returns AsyncGenerator<PageResult<R>, void, undefined>

    • Type Parameters

      • R

      Parameters

      • endpointName:
            | "getAllianceContacts"
            | "getAllianceContactLabels"
            | "getCharacterContacts"
            | "getCharacterContactLabels"
            | "getCorporationContacts"
            | "getCorporationContactLabels"
            | "addContacts"
            | "editContacts"
            | "deleteCharacterContacts"
      • args: unknown[]
      • Optionalconcurrency: number

      Returns Promise<R[]>

    • Retrieve contacts for an alliance.

      Parameters

      • allianceId: number

        The ID of the alliance whose contacts to retrieve

      Returns Promise<
          {
              contact_id: number;
              contact_type: | string & {}
              | "faction"
              | "character"
              | "corporation"
              | "alliance";
              standing: number;
              label_ids?: number[];
              is_blocked?: boolean;
              is_watched?: boolean;
              [key: string]: unknown;
          }[],
      >

      A list of alliance contacts with standings and contact types

      Authentication

    • Retrieve custom contact labels for an alliance.

      Parameters

      • allianceId: number

        The ID of the alliance whose contact labels to retrieve

      Returns Promise<{ label_id: number; label_name: string; [key: string]: unknown }[]>

      A list of custom labels used to categorize alliance contacts

      Authentication

    • Delete contacts from a character's contact list.

      Parameters

      • characterId: number

        The ID of the character whose contacts to delete

      • contactIds: number[]

        An array of contact IDs to remove

      Returns Promise<void>

      Authentication

    • Retrieve a character's contact list.

      Parameters

      • characterId: number

        The ID of the character whose contacts to retrieve

      Returns Promise<
          {
              contact_id: number;
              contact_type: | string & {}
              | "faction"
              | "character"
              | "corporation"
              | "alliance";
              standing: number;
              label_ids?: number[];
              is_blocked?: boolean;
              is_watched?: boolean;
              [key: string]: unknown;
          }[],
      >

      A list of character contacts with standings, labels, and contact types

      Authentication

    • Add contacts to a character's contact list via a POST request.

      Parameters

      • characterId: number

        The ID of the character to add contacts for

      • standing: number

        Standing value for the contacts (-10 to 10)

      • contactIds: number[]

        Array of character/corporation/alliance IDs to add

      Returns Promise<number[]>

      An array of contact IDs that were successfully added

      Authentication

    • Update existing contacts in a character's contact list via a PUT request.

      Parameters

      • characterId: number

        The ID of the character whose contacts to update

      • standing: number

        New standing value for the contacts (-10 to 10)

      • contactIds: number[]

        Array of contact IDs to update

      Returns Promise<void>

      Authentication

    • Retrieve custom contact labels for a character.

      Parameters

      • characterId: number

        The ID of the character whose contact labels to retrieve

      Returns Promise<{ label_id: number; label_name: string; [key: string]: unknown }[]>

      A list of custom labels used to categorize character contacts

      Authentication

    • Retrieve contacts for a corporation.

      Parameters

      • corporationId: number

        The ID of the corporation whose contacts to retrieve

      Returns Promise<
          {
              contact_id: number;
              contact_type: | string & {}
              | "faction"
              | "character"
              | "corporation"
              | "alliance";
              standing: number;
              label_ids?: number[];
              is_blocked?: boolean;
              is_watched?: boolean;
              [key: string]: unknown;
          }[],
      >

      A list of corporation contacts with standings and contact types

      Authentication

    • Retrieve custom contact labels for a corporation.

      Parameters

      • corporationId: number

        The ID of the corporation whose contact labels to retrieve

      Returns Promise<{ label_id: number; label_name: string; [key: string]: unknown }[]>

      A list of custom labels used to categorize corporation contacts

      Authentication

    • Parameters

      • allianceId: number
      • Optionalconcurrency: number

      Returns Promise<
          {
              contact_id: number;
              contact_type: | string & {}
              | "faction"
              | "character"
              | "corporation"
              | "alliance";
              standing: number;
              label_ids?: number[];
              is_blocked?: boolean;
              is_watched?: boolean;
              [key: string]: unknown;
          }[],
      >

    • Parameters

      • allianceId: number
      • Optionalconcurrency: number

      Returns Promise<{ label_id: number; label_name: string; [key: string]: unknown }[]>

    • Parameters

      • characterId: number
      • Optionalconcurrency: number

      Returns Promise<
          {
              contact_id: number;
              contact_type: | string & {}
              | "faction"
              | "character"
              | "corporation"
              | "alliance";
              standing: number;
              label_ids?: number[];
              is_blocked?: boolean;
              is_watched?: boolean;
              [key: string]: unknown;
          }[],
      >

    • Parameters

      • characterId: number
      • Optionalconcurrency: number

      Returns Promise<{ label_id: number; label_name: string; [key: string]: unknown }[]>

    • Parameters

      • corporationId: number
      • Optionalconcurrency: number

      Returns Promise<
          {
              contact_id: number;
              contact_type: | string & {}
              | "faction"
              | "character"
              | "corporation"
              | "alliance";
              standing: number;
              label_ids?: number[];
              is_blocked?: boolean;
              is_watched?: boolean;
              [key: string]: unknown;
          }[],
      >

    • Parameters

      • corporationId: number
      • Optionalconcurrency: number

      Returns Promise<{ label_id: number; label_name: string; [key: string]: unknown }[]>

    • Parameters

      • allianceId: number

      Returns AsyncGenerator<
          PageResult<
              {
                  contact_id: number;
                  contact_type: | string & {}
                  | "faction"
                  | "character"
                  | "corporation"
                  | "alliance";
                  standing: number;
                  label_ids?: number[];
                  is_blocked?: boolean;
                  is_watched?: boolean;
                  [key: string]: unknown;
              },
          >,
          void,
          undefined,
      >

    • Parameters

      • allianceId: number

      Returns AsyncGenerator<
          PageResult<
              { label_id: number; label_name: string; [key: string]: unknown },
          >,
          void,
          undefined,
      >

    • Parameters

      • characterId: number

      Returns AsyncGenerator<
          PageResult<
              {
                  contact_id: number;
                  contact_type: | string & {}
                  | "faction"
                  | "character"
                  | "corporation"
                  | "alliance";
                  standing: number;
                  label_ids?: number[];
                  is_blocked?: boolean;
                  is_watched?: boolean;
                  [key: string]: unknown;
              },
          >,
          void,
          undefined,
      >

    • Parameters

      • characterId: number

      Returns AsyncGenerator<
          PageResult<
              { label_id: number; label_name: string; [key: string]: unknown },
          >,
          void,
          undefined,
      >

    • Parameters

      • corporationId: number

      Returns AsyncGenerator<
          PageResult<
              {
                  contact_id: number;
                  contact_type: | string & {}
                  | "faction"
                  | "character"
                  | "corporation"
                  | "alliance";
                  standing: number;
                  label_ids?: number[];
                  is_blocked?: boolean;
                  is_watched?: boolean;
                  [key: string]: unknown;
              },
          >,
          void,
          undefined,
      >

    • Parameters

      • corporationId: number

      Returns AsyncGenerator<
          PageResult<
              { label_id: number; label_name: string; [key: string]: unknown },
          >,
          void,
          undefined,
      >