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

    Class AccessListsClient

    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
    constructor
    api _client _endpoints
    getAccessList getCharacterAccessLists streamEndpoint fetchAllEndpoint withMetadata withSafeMode
    api: ClientMethods<T>

    Protected_client

    _client: ApiClient

    Protected_endpoints

    _endpoints: {
        getAccessList: {
            path: "characters/{characterId}/access-lists/{accessListId}";
            method: "GET";
            requiresAuth: true;
            pathParams: readonly ["characterId", "accessListId"];
            responseSchema: ZodObject<
                {
                    id: ZodNumber;
                    name: ZodString;
                    description: ZodString;
                    membership: ZodObject<
                        {
                            allow_everyone: ZodBoolean;
                            alliances: ZodArray<
                                ZodObject<
                                    {
                                        alliance_id: ZodNumber;
                                        access: ZodType<
                                            (...)
                                            | (...)
                                            | (...)
                                            | (...)
                                            | (...)
                                            | (...),
                                            unknown,
                                            $ZodTypeInternals<(...), (...)>,
                                        >;
                                    },
                                    $loose,
                                >,
                            >;
                            corporations: ZodArray<
                                ZodObject<
                                    {
                                        corporation_id: ZodNumber;
                                        access: ZodType<
                                            (...)
                                            | (...)
                                            | (...)
                                            | (...)
                                            | (...)
                                            | (...),
                                            unknown,
                                            $ZodTypeInternals<(...), (...)>,
                                        >;
                                    },
                                    $loose,
                                >,
                            >;
                            characters: ZodArray<
                                ZodObject<
                                    {
                                        character_id: ZodNumber;
                                        access: ZodType<
                                            (...)
                                            | (...)
                                            | (...)
                                            | (...)
                                            | (...)
                                            | (...),
                                            unknown,
                                            $ZodTypeInternals<(...), (...)>,
                                        >;
                                    },
                                    $loose,
                                >,
                            >;
                        },
                        $loose,
                    >;
                },
                $loose,
            >;
        };
        getCharacterAccessLists: {
            path: "characters/{characterId}/access-lists";
            method: "GET";
            requiresAuth: true;
            pathParams: readonly ["characterId"];
            responseSchema: ZodObject<
                { access_lists: ZodArray<ZodObject<{ id: ZodNumber }, $loose>> },
                $loose,
            >;
        };
    }

    • Retrieves an access list (ACL): its name, description and the characters, corporations and alliances it lists, each with an access level.

      Parameters

      • characterId: number

        The ID of the character who owns the access list

      • accessListId: number

        The ID of the access list to retrieve

      Returns Promise<
          {
              id: number;
              name: string;
              description: string;
              membership: {
                  allow_everyone: boolean;
                  alliances: {
                      alliance_id: number;
                      access: | string & {}
                      | "Unspecified"
                      | "Allowed"
                      | "Blocked"
                      | "Manager"
                      | "Admin";
                      [key: string]: unknown;
                  }[];
                  corporations: {
                      corporation_id: number;
                      access: | string & {}
                      | "Unspecified"
                      | "Allowed"
                      | "Blocked"
                      | "Manager"
                      | "Admin";
                      [key: string]: unknown;
                  }[];
                  characters: {
                      character_id: number;
                      access: | string & {}
                      | "Unspecified"
                      | "Allowed"
                      | "Blocked"
                      | "Manager"
                      | "Admin";
                      [key: string]: unknown;
                  }[];
                  [key: string]: unknown;
              };
              [key: string]: unknown;
          },
      >

      The access list: id, name, description and membership

      Authentication

    • Retrieves the IDs of a character's access lists. Call getAccessList for a list's contents.

      Parameters

      • characterId: number

        The ID of the character

      Returns Promise<
          {
              access_lists: { id: number; [key: string]: unknown }[];
              [key: string]: unknown;
          },
      >

      ESI's response as sent: access_lists, one entry per list with its id

      Authentication

    • Type Parameters

      • R

      Parameters

      • endpointName: "getAccessList" | "getCharacterAccessLists"
      • ...args: unknown[]

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

    • Type Parameters

      • R

      Parameters

      • endpointName: "getAccessList" | "getCharacterAccessLists"
      • args: unknown[]
      • Optionalconcurrency: number

      Returns Promise<R[]>

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods