Class CalendarClient

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 calendarEndpoints>
- CalendarClient

Index

Constructors

constructor

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

Properties

`Protected`api

api: ClientMethods<T>

`Protected`_client

_client: ApiClient

`Protected`_endpoints

_endpoints: {
    getCalendarEvents: {
        path: "characters/{characterId}/calendar/";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["characterId"];
        responseSchema: ZodArray<
            ZodObject<
                {
                    event_id: ZodOptional<ZodNumber>;
                    event_date: ZodOptional<ZodString>;
                    title: ZodOptional<ZodString>;
                    importance: ZodOptional<ZodNumber>;
                    event_response: ZodOptional<
                        ZodType<
                            | string & {}
                            | "declined"
                            | "not_responded"
                            | "accepted"
                            | "tentative",
                            unknown,
                            $ZodTypeInternals<
                                | string & {}
                                | "declined"
                                | "not_responded"
                                | "accepted"
                                | "tentative",
                                unknown,
                            >,
                        >,
                    >;
                },
                $loose,
            >,
        >;
    };
    getCalendarEventById: {
        path: "characters/{characterId}/calendar/{eventId}/";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["characterId", "eventId"];
        responseSchema: ZodObject<
            {
                event_id: ZodNumber;
                date: ZodString;
                title: ZodString;
                text: ZodString;
                owner_id: ZodNumber;
                owner_name: ZodString;
                owner_type: ZodType<
                    | string & {}
                    | "faction"
                    | "character"
                    | "corporation"
                    | "alliance"
                    | "eve_server",
                    unknown,
                    $ZodTypeInternals<
                        | string & {}
                        | "faction"
                        | "character"
                        | "corporation"
                        | "alliance"
                        | "eve_server",
                        unknown,
                    >,
                >;
                duration: ZodNumber;
                importance: ZodNumber;
                response: ZodString;
            },
            $loose,
        >;
    };
    getEventAttendees: {
        path: "characters/{characterId}/calendar/{eventId}/attendees/";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["characterId", "eventId"];
        responseSchema: ZodArray<
            ZodObject<
                {
                    character_id: ZodOptional<ZodNumber>;
                    event_response: ZodOptional<
                        ZodType<
                            | string & {}
                            | "declined"
                            | "not_responded"
                            | "accepted"
                            | "tentative",
                            unknown,
                            $ZodTypeInternals<
                                | string & {}
                                | "declined"
                                | "not_responded"
                                | "accepted"
                                | "tentative",
                                unknown,
                            >,
                        >,
                    >;
                },
                $loose,
            >,
        >;
    };
    respondToCalendarEvent: {
        path: "characters/{characterId}/calendar/{eventId}/";
        method: "PUT";
        requiresAuth: true;
        pathParams: readonly ["characterId", "eventId"];
        bodyBuilder: (response: string) => { response: string };
    };
}

Methods

streamEndpoint

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

fetchAllEndpoint

fetchAllEndpoint<R>(
    endpointName:
        | "getCalendarEvents"
        | "getCalendarEventById"
        | "getEventAttendees"
        | "respondToCalendarEvent",
    args: unknown[],
    concurrency?: number,
): Promise<R[]>
Type Parameters
- R
Parameters
- endpointName:
      | "getCalendarEvents"
      | "getCalendarEventById"
      | "getEventAttendees"
      | "respondToCalendarEvent"
- 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

getCalendarEvents

getCalendarEvents(
    characterId: number,
): Promise<
    {
        event_id?: number;
        event_date?: string;
        title?: string;
        importance?: number;
        event_response?: | string & {}
        | "declined"
        | "not_responded"
        | "accepted"
        | "tentative";
        [key: string]: unknown;
    }[],
>
Retrieve a character's upcoming calendar events.
Parameters
- characterId: number
  The ID of the character whose calendar events to retrieve
Returns Promise<
    {
        event_id?: number;
        event_date?: string;
        title?: string;
        importance?: number;
        event_response?: | string & {}
        | "declined"
        | "not_responded"
        | "accepted"
        | "tentative";
        [key: string]: unknown;
    }[],
>
A list of upcoming calendar events

Requires
Authentication
- Defined in src/clients/CalendarClient.ts:23

getCalendarEventById

getCalendarEventById(
    characterId: number,
    eventId: number,
): Promise<
    {
        event_id: number;
        date: string;
        title: string;
        text: string;
        owner_id: number;
        owner_name: string;
        owner_type: | string & {}
        | "faction"
        | "character"
        | "corporation"
        | "alliance"
        | "eve_server";
        duration: number;
        importance: number;
        response: string;
        [key: string]: unknown;
    },
>
Retrieve detailed information about a specific calendar event for a character.
Parameters
- characterId: number
  The ID of the character who owns the event
- eventId: number
  The ID of the calendar event to retrieve
Returns Promise<
    {
        event_id: number;
        date: string;
        title: string;
        text: string;
        owner_id: number;
        owner_name: string;
        owner_type: | string & {}
        | "faction"
        | "character"
        | "corporation"
        | "alliance"
        | "eve_server";
        duration: number;
        importance: number;
        response: string;
        [key: string]: unknown;
    },
>
Detailed event information including title, description, and timing

Requires
Authentication
- Defined in src/clients/CalendarClient.ts:35

respondToCalendarEvent

respondToCalendarEvent(
    characterId: number,
    eventId: number,
    response: string,
): Promise<void>
Set a character's response to a calendar event (accepted, declined, or tentative).
Parameters
- characterId: number
  The ID of the character responding to the event
- eventId: number
  The ID of the calendar event to respond to
- response: string
  The response status to set for this event
Returns Promise<void>

Requires
Authentication
- Defined in src/clients/CalendarClient.ts:50

getEventAttendees

getEventAttendees(
    characterId: number,
    eventId: number,
): Promise<
    {
        character_id?: number;
        event_response?: | string & {}
        | "declined"
        | "not_responded"
        | "accepted"
        | "tentative";
        [key: string]: unknown;
    }[],
>
Retrieve the list of attendees and their response statuses for a calendar event.
Parameters
- characterId: number
  The ID of the character who owns the event
- eventId: number
  The ID of the calendar event whose attendees to retrieve
Returns Promise<
    {
        character_id?: number;
        event_response?: | string & {}
        | "declined"
        | "not_responded"
        | "accepted"
        | "tentative";
        [key: string]: unknown;
    }[],
>
A list of attendees with their response statuses

Requires
Authentication
- Defined in src/clients/CalendarClient.ts:70

fetchAllCalendarEvents

fetchAllCalendarEvents(
    characterId: number,
    concurrency?: number,
): Promise<
    {
        event_id?: number;
        event_date?: string;
        title?: string;
        importance?: number;
        event_response?: | string & {}
        | "declined"
        | "not_responded"
        | "accepted"
        | "tentative";
        [key: string]: unknown;
    }[],
>
Parameters
- characterId: number
- Optionalconcurrency: number
Returns Promise<
    {
        event_id?: number;
        event_date?: string;
        title?: string;
        importance?: number;
        event_response?: | string & {}
        | "declined"
        | "not_responded"
        | "accepted"
        | "tentative";
        [key: string]: unknown;
    }[],
>
- Defined in src/clients/CalendarClient.ts:77

fetchAllEventAttendees

fetchAllEventAttendees(
    characterId: number,
    eventId: number,
    concurrency?: number,
): Promise<
    {
        character_id?: number;
        event_response?: | string & {}
        | "declined"
        | "not_responded"
        | "accepted"
        | "tentative";
        [key: string]: unknown;
    }[],
>
Parameters
- characterId: number
- eventId: number
- Optionalconcurrency: number
Returns Promise<
    {
        character_id?: number;
        event_response?: | string & {}
        | "declined"
        | "not_responded"
        | "accepted"
        | "tentative";
        [key: string]: unknown;
    }[],
>
- Defined in src/clients/CalendarClient.ts:88

streamCalendarEvents

streamCalendarEvents(
    characterId: number,
): AsyncGenerator<
    PageResult<
        {
            event_id?: number;
            event_date?: string;
            title?: string;
            importance?: number;
            event_response?: | string & {}
            | "declined"
            | "not_responded"
            | "accepted"
            | "tentative";
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
Parameters
- characterId: number
Returns AsyncGenerator<
    PageResult<
        {
            event_id?: number;
            event_date?: string;
            title?: string;
            importance?: number;
            event_response?: | string & {}
            | "declined"
            | "not_responded"
            | "accepted"
            | "tentative";
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
- Defined in src/clients/CalendarClient.ts:100

streamEventAttendees

streamEventAttendees(
    characterId: number,
    eventId: number,
): AsyncGenerator<
    PageResult<
        {
            character_id?: number;
            event_response?: | string & {}
            | "declined"
            | "not_responded"
            | "accepted"
            | "tentative";
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
Parameters
- characterId: number
- eventId: number
Returns AsyncGenerator<
    PageResult<
        {
            character_id?: number;
            event_response?: | string & {}
            | "declined"
            | "not_responded"
            | "accepted"
            | "tentative";
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
- Defined in src/clients/CalendarClient.ts:106

Class CalendarClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CalendarClient

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

getCalendarEvents

Parameters

Returns Promise< { event_id?: number; event_date?: string; title?: string; importance?: number; event_response?: | string & {} | "declined" | "not_responded" | "accepted" | "tentative"; [key: string]: unknown; }[],>

Requires

getCalendarEventById

Parameters

Returns Promise< { event_id: number; date: string; title: string; text: string; owner_id: number; owner_name: string; owner_type: | string & {} | "faction" | "character" | "corporation" | "alliance" | "eve_server"; duration: number; importance: number; response: string; [key: string]: unknown; },>

Requires

respondToCalendarEvent

Parameters

Returns Promise<void>

Requires

getEventAttendees

Parameters

Returns Promise< { character_id?: number; event_response?: | string & {} | "declined" | "not_responded" | "accepted" | "tentative"; [key: string]: unknown; }[],>

Requires

fetchAllCalendarEvents

Parameters

Returns Promise< { event_id?: number; event_date?: string; title?: string; importance?: number; event_response?: | string & {} | "declined" | "not_responded" | "accepted" | "tentative"; [key: string]: unknown; }[],>

fetchAllEventAttendees

Parameters

Returns Promise< { character_id?: number; event_response?: | string & {} | "declined" | "not_responded" | "accepted" | "tentative"; [key: string]: unknown; }[],>

streamCalendarEvents

Parameters

Returns AsyncGenerator< PageResult< { event_id?: number; event_date?: string; title?: string; importance?: number; event_response?: | string & {} | "declined" | "not_responded" | "accepted" | "tentative"; [key: string]: unknown; }, >, void, undefined,>

streamEventAttendees

Parameters

Returns AsyncGenerator< PageResult< { character_id?: number; event_response?: | string & {} | "declined" | "not_responded" | "accepted" | "tentative"; [key: string]: unknown; }, >, void, undefined,>

Settings

On This Page

`Protected`api

`Protected`_client

`Protected`_endpoints

Returns Promise<
{
event_id?: number;
event_date?: string;
title?: string;
importance?: number;
event_response?: | string & {}
| "declined"
| "not_responded"
| "accepted"
| "tentative";
[key: string]: unknown;
}[],
>

Returns Promise<
{
event_id: number;
date: string;
title: string;
text: string;
owner_id: number;
owner_name: string;
owner_type: | string & {}
| "faction"
| "character"
| "corporation"
| "alliance"
| "eve_server";
duration: number;
importance: number;
response: string;
[key: string]: unknown;
},
>

Returns Promise<
{
character_id?: number;
event_response?: | string & {}
| "declined"
| "not_responded"
| "accepted"
| "tentative";
[key: string]: unknown;
}[],
>

Returns Promise<
{
event_id?: number;
event_date?: string;
title?: string;
importance?: number;
event_response?: | string & {}
| "declined"
| "not_responded"
| "accepted"
| "tentative";
[key: string]: unknown;
}[],
>

Returns Promise<
{
character_id?: number;
event_response?: | string & {}
| "declined"
| "not_responded"
| "accepted"
| "tentative";
[key: string]: unknown;
}[],
>

Returns AsyncGenerator<
PageResult<
{
event_id?: number;
event_date?: string;
title?: string;
importance?: number;
event_response?: | string & {}
| "declined"
| "not_responded"
| "accepted"
| "tentative";
[key: string]: unknown;
},
>,
void,
undefined,
>

Returns AsyncGenerator<
PageResult<
{
character_id?: number;
event_response?: | string & {}
| "declined"
| "not_responded"
| "accepted"
| "tentative";
[key: string]: unknown;
},
>,
void,
undefined,
>