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

    Class LoyaltyClient

    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
    streamEndpoint fetchAllEndpoint withMetadata withSafeMode getLoyaltyPoints getLoyaltyStoreOffers fetchAllLoyaltyPoints fetchAllLoyaltyStoreOffers streamLoyaltyPoints streamLoyaltyStoreOffers
    api: ClientMethods<T>

    Protected_client

    _client: ApiClient

    Protected_endpoints

    _endpoints: {
        getLoyaltyPoints: {
            path: "characters/{characterId}/loyalty/points";
            method: "GET";
            requiresAuth: true;
            pathParams: readonly ["characterId"];
            responseSchema: ZodArray<
                ZodObject<
                    { corporation_id: ZodNumber; loyalty_points: ZodNumber },
                    $loose,
                >,
            >;
        };
        getLoyaltyStoreOffers: {
            path: "loyalty/stores/{corporationId}/offers";
            method: "GET";
            requiresAuth: false;
            pathParams: readonly ["corporationId"];
            responseSchema: ZodArray<
                ZodObject<
                    {
                        offer_id: ZodNumber;
                        type_id: ZodNumber;
                        quantity: ZodNumber;
                        lp_cost: ZodNumber;
                        isk_cost: ZodNumber;
                        ak_cost: ZodOptional<ZodNumber>;
                        required_items: ZodArray<
                            ZodObject<{ type_id: ZodNumber; quantity: ZodNumber }, $loose>,
                        >;
                    },
                    $loose,
                >,
            >;
        };
    }

    • Type Parameters

      • R

      Parameters

      • endpointName: "getLoyaltyPoints" | "getLoyaltyStoreOffers"
      • ...args: unknown[]

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

    • Type Parameters

      • R

      Parameters

      • endpointName: "getLoyaltyPoints" | "getLoyaltyStoreOffers"
      • args: unknown[]
      • Optionalconcurrency: number

      Returns Promise<R[]>

    • Retrieves the loyalty points a character has earned with each NPC corporation.

      Parameters

      • characterId: number

        The ID of the character to fetch loyalty points for

      Returns Promise<
          {
              corporation_id: number;
              loyalty_points: number;
              [key: string]: unknown;
          }[],
      >

      A list of loyalty point balances per corporation

      Authentication

    • Retrieves the list of items available in an NPC corporation's loyalty point store.

      Parameters

      • corporationId: number

        The ID of the NPC corporation whose LP store to query

      Returns Promise<
          {
              offer_id: number;
              type_id: number;
              quantity: number;
              lp_cost: number;
              isk_cost: number;
              ak_cost?: number;
              required_items: {
                  type_id: number;
                  quantity: number;
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          }[],
      >

      A list of offers available in the loyalty store

    • Parameters

      • characterId: number
      • Optionalconcurrency: number

      Returns Promise<
          {
              corporation_id: number;
              loyalty_points: number;
              [key: string]: unknown;
          }[],
      >

    • Parameters

      • corporationId: number
      • Optionalconcurrency: number

      Returns Promise<
          {
              offer_id: number;
              type_id: number;
              quantity: number;
              lp_cost: number;
              isk_cost: number;
              ak_cost?: number;
              required_items: {
                  type_id: number;
                  quantity: number;
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          }[],
      >

    • Parameters

      • characterId: number

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

    • Parameters

      • corporationId: number

      Returns AsyncGenerator<
          PageResult<
              {
                  offer_id: number;
                  type_id: number;
                  quantity: number;
                  lp_cost: number;
                  isk_cost: number;
                  ak_cost?: number;
                  required_items: {
                      type_id: number;
                      quantity: number;
                      [key: string]: unknown;
                  }[];
                  [key: string]: unknown;
              },
          >,
          void,
          undefined,
      >

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods