Class MilitaryCampaignsClient

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 militaryCampaignEndpoints>
- MilitaryCampaignsClient

Index

Constructors

constructor

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

Properties

`Protected`api

api: ClientMethods<T>

`Protected`_client

_client: ApiClient

`Protected`_endpoints

_endpoints: {
    getMilitaryCampaigns: {
        path: "military-campaigns";
        method: "GET";
        requiresAuth: false;
        responseSchema: ZodObject<
            {
                campaigns: ZodArray<
                    ZodObject<
                        {
                            id: ZodString;
                            state: ZodType<
                                string & {}
                                | "Unspecified"
                                | "Active"
                                | "Completed"
                                | "Expired",
                                unknown,
                                $ZodTypeInternals<
                                    | (...) & (...)
                                    | "Unspecified"
                                    | "Active"
                                    | "Completed"
                                    | "Expired",
                                    unknown,
                                >,
                            >;
                            progress: ZodNumber;
                            started: ZodOptional<ZodString>;
                            finished: ZodOptional<ZodString>;
                        },
                        $loose,
                    >,
                >;
            },
            $loose,
        >;
    };
    getMilitaryCampaign: {
        path: "military-campaigns/{campaignId}";
        method: "GET";
        requiresAuth: false;
        pathParams: readonly ["campaignId"];
        responseSchema: ZodObject<
            {
                id: ZodString;
                state: ZodType<
                    string & {}
                    | "Unspecified"
                    | "Active"
                    | "Completed"
                    | "Expired",
                    unknown,
                    $ZodTypeInternals<
                        string & {}
                        | "Unspecified"
                        | "Active"
                        | "Completed"
                        | "Expired",
                        unknown,
                    >,
                >;
                progress: ZodNumber;
                started: ZodOptional<ZodString>;
                finished: ZodOptional<ZodString>;
            },
            $loose,
        >;
    };
    getMilitaryCampaignObjectives: {
        path: "military-campaigns/{campaignId}/objectives";
        method: "GET";
        requiresAuth: false;
        pathParams: readonly ["campaignId"];
        queryParams: { after: "after"; before: "before"; limit: "limit" };
        responseSchema: ZodObject<
            {
                objectives: ZodArray<
                    ZodObject<
                        {
                            id: ZodString;
                            state: ZodType<
                                string & {}
                                | "Unspecified"
                                | "Active"
                                | "Completed"
                                | "Expired",
                                unknown,
                                $ZodTypeInternals<
                                    | (...) & (...)
                                    | "Unspecified"
                                    | "Active"
                                    | "Completed"
                                    | "Expired",
                                    unknown,
                                >,
                            >;
                            progress: ZodNumber;
                            last_modified: ZodString;
                            started: ZodOptional<ZodString>;
                            finished: ZodOptional<ZodString>;
                            participants: ZodObject<
                                {
                                    total: ZodNumber;
                                    committed: ZodNumber;
                                    contributors: ZodNumber;
                                },
                                $loose,
                            >;
                        },
                        $loose,
                    >,
                >;
                cursor: ZodOptional<
                    ZodObject<
                        { before: ZodOptional<ZodString>; after: ZodOptional<ZodString> },
                        $loose,
                    >,
                >;
            },
            $loose,
        >;
    };
    getMilitaryCampaignObjective: {
        path: "military-campaigns/{campaignId}/objectives/{objectiveId}";
        method: "GET";
        requiresAuth: false;
        pathParams: readonly ["campaignId", "objectiveId"];
        responseSchema: ZodObject<
            {
                id: ZodString;
                state: ZodType<
                    string & {}
                    | "Unspecified"
                    | "Active"
                    | "Completed"
                    | "Expired",
                    unknown,
                    $ZodTypeInternals<
                        string & {}
                        | "Unspecified"
                        | "Active"
                        | "Completed"
                        | "Expired",
                        unknown,
                    >,
                >;
                progress: ZodNumber;
                last_modified: ZodString;
                started: ZodOptional<ZodString>;
                finished: ZodOptional<ZodString>;
                participants: ZodObject<
                    { total: ZodNumber; committed: ZodNumber; contributors: ZodNumber },
                    $loose,
                >;
            },
            $loose,
        >;
    };
    getCharacterMilitaryCampaignObjectives: {
        path: "characters/{characterId}/military-campaigns/objectives";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["characterId"];
        queryParams: { after: "after"; before: "before"; limit: "limit" };
        responseSchema: ZodObject<
            {
                objectives: ZodArray<
                    ZodObject<
                        {
                            id: ZodString;
                            campaign_id: ZodString;
                            is_committed: ZodBoolean;
                            contributed: ZodNumber;
                            last_modified: ZodString;
                        },
                        $loose,
                    >,
                >;
                cursor: ZodOptional<
                    ZodObject<
                        { before: ZodOptional<ZodString>; after: ZodOptional<ZodString> },
                        $loose,
                    >,
                >;
            },
            $loose,
        >;
    };
    getCharacterMilitaryCampaignObjective: {
        path: "characters/{characterId}/military-campaigns/objectives/{objectiveId}";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["characterId", "objectiveId"];
        responseSchema: ZodObject<
            {
                id: ZodString;
                campaign_id: ZodString;
                is_committed: ZodBoolean;
                contributed: ZodNumber;
                last_modified: ZodString;
            },
            $loose,
        >;
    };
}

Methods

streamEndpoint

streamEndpoint<R>(
    endpointName:
        | "getMilitaryCampaigns"
        | "getMilitaryCampaign"
        | "getMilitaryCampaignObjectives"
        | "getMilitaryCampaignObjective"
        | "getCharacterMilitaryCampaignObjectives"
        | "getCharacterMilitaryCampaignObjective",
    ...args: unknown[],
): AsyncGenerator<PageResult<R>, void, undefined>
Type Parameters
- R
Parameters
- endpointName:
      | "getMilitaryCampaigns"
      | "getMilitaryCampaign"
      | "getMilitaryCampaignObjectives"
      | "getMilitaryCampaignObjective"
      | "getCharacterMilitaryCampaignObjectives"
      | "getCharacterMilitaryCampaignObjective"
- ...args: unknown[]
Returns AsyncGenerator<PageResult<R>, void, undefined>
Inherited from BaseEsiClient.streamEndpoint
- Defined in src/clients/BaseEsiClient.ts:45

fetchAllEndpoint

fetchAllEndpoint<R>(
    endpointName:
        | "getMilitaryCampaigns"
        | "getMilitaryCampaign"
        | "getMilitaryCampaignObjectives"
        | "getMilitaryCampaignObjective"
        | "getCharacterMilitaryCampaignObjectives"
        | "getCharacterMilitaryCampaignObjective",
    args: unknown[],
    concurrency?: number,
): Promise<R[]>
Type Parameters
- R
Parameters
- endpointName:
      | "getMilitaryCampaigns"
      | "getMilitaryCampaign"
      | "getMilitaryCampaignObjectives"
      | "getMilitaryCampaignObjective"
      | "getCharacterMilitaryCampaignObjectives"
      | "getCharacterMilitaryCampaignObjective"
- 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

getMilitaryCampaigns

getMilitaryCampaigns(): Promise<
    {
        campaigns: {
            id: string;
            state: string & {}
            | "Unspecified"
            | "Active"
            | "Completed"
            | "Expired";
            progress: number;
            started?: string;
            finished?: string;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
Retrieves a list of all active, completed, and expired military campaigns.

Returns Promise<
    {
        campaigns: {
            id: string;
            state: string & {}
            | "Unspecified"
            | "Active"
            | "Completed"
            | "Expired";
            progress: number;
            started?: string;
            finished?: string;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
{ campaigns }, one entry per campaign
- Defined in src/clients/MilitaryCampaignsClient.ts:25

getMilitaryCampaign

getMilitaryCampaign(
    campaignId: string,
): Promise<
    {
        id: string;
        state: string & {}
        | "Unspecified"
        | "Active"
        | "Completed"
        | "Expired";
        progress: number;
        started?: string;
        finished?: string;
        [key: string]: unknown;
    },
>
Retrieves detailed information about a specific military campaign.
Parameters
- campaignId: string
  The UUID of the military campaign
Returns Promise<
    {
        id: string;
        state: string & {}
        | "Unspecified"
        | "Active"
        | "Completed"
        | "Expired";
        progress: number;
        started?: string;
        finished?: string;
        [key: string]: unknown;
    },
>
Detailed information about the campaign
- Defined in src/clients/MilitaryCampaignsClient.ts:35

getMilitaryCampaignObjectives

getMilitaryCampaignObjectives(
    campaignId: string,
    after?: string,
    before?: string,
    limit?: number,
): Promise<
    {
        objectives: {
            id: string;
            state: string & {}
            | "Unspecified"
            | "Active"
            | "Completed"
            | "Expired";
            progress: number;
            last_modified: string;
            started?: string;
            finished?: string;
            participants: {
                total: number;
                committed: number;
                contributors: number;
                [key: string]: unknown;
            };
            [key: string]: unknown;
        }[];
        cursor?: { before?: string; after?: string; [key: string]: unknown };
        [key: string]: unknown;
    },
>
Retrieves all objectives for a specific military campaign.
Parameters
- campaignId: string
  The UUID of the military campaign
- Optionalafter: string
  cursor.after from a previous page, for the page after it
- Optionalbefore: string
  cursor.before from a previous page, for the page before it
- Optionallimit: number
  Maximum number of objectives on the page
Returns Promise<
    {
        objectives: {
            id: string;
            state: string & {}
            | "Unspecified"
            | "Active"
            | "Completed"
            | "Expired";
            progress: number;
            last_modified: string;
            started?: string;
            finished?: string;
            participants: {
                total: number;
                committed: number;
                contributors: number;
                [key: string]: unknown;
            };
            [key: string]: unknown;
        }[];
        cursor?: { before?: string; after?: string; [key: string]: unknown };
        [key: string]: unknown;
    },
>
{ objectives, cursor } for one page of the campaign's objectives
- Defined in src/clients/MilitaryCampaignsClient.ts:48

getMilitaryCampaignObjective

getMilitaryCampaignObjective(
    campaignId: string,
    objectiveId: string,
): Promise<
    {
        id: string;
        state: string & {}
        | "Unspecified"
        | "Active"
        | "Completed"
        | "Expired";
        progress: number;
        last_modified: string;
        started?: string;
        finished?: string;
        participants: {
            total: number;
            committed: number;
            contributors: number;
            [key: string]: unknown;
        };
        [key: string]: unknown;
    },
>
Retrieves detailed information about a specific objective in a military campaign.
Parameters
- campaignId: string
  The UUID of the military campaign
- objectiveId: string
  The UUID of the objective
Returns Promise<
    {
        id: string;
        state: string & {}
        | "Unspecified"
        | "Active"
        | "Completed"
        | "Expired";
        progress: number;
        last_modified: string;
        started?: string;
        finished?: string;
        participants: {
            total: number;
            committed: number;
            contributors: number;
            [key: string]: unknown;
        };
        [key: string]: unknown;
    },
>
Detailed information about the objective
- Defined in src/clients/MilitaryCampaignsClient.ts:69

getCharacterMilitaryCampaignObjectives

getCharacterMilitaryCampaignObjectives(
    characterId: number,
    after?: string,
    before?: string,
    limit?: number,
): Promise<
    {
        objectives: {
            id: string;
            campaign_id: string;
            is_committed: boolean;
            contributed: number;
            last_modified: string;
            [key: string]: unknown;
        }[];
        cursor?: { before?: string; after?: string; [key: string]: unknown };
        [key: string]: unknown;
    },
>
Retrieves a character's participated objectives across military campaigns.
Parameters
- characterId: number
  The ID of the character
- Optionalafter: string
  cursor.after from a previous page, for the page after it
- Optionalbefore: string
  cursor.before from a previous page, for the page before it
- Optionallimit: number
  Maximum number of objectives on the page
Returns Promise<
    {
        objectives: {
            id: string;
            campaign_id: string;
            is_committed: boolean;
            contributed: number;
            last_modified: string;
            [key: string]: unknown;
        }[];
        cursor?: { before?: string; after?: string; [key: string]: unknown };
        [key: string]: unknown;
    },
>
{ objectives, cursor } for one page of the character's campaign objective participations

Requires
Authentication with scope esi.activity.char:read
- Defined in src/clients/MilitaryCampaignsClient.ts:87

getCharacterMilitaryCampaignObjective

getCharacterMilitaryCampaignObjective(
    characterId: number,
    objectiveId: string,
): Promise<
    {
        id: string;
        campaign_id: string;
        is_committed: boolean;
        contributed: number;
        last_modified: string;
        [key: string]: unknown;
    },
>
Retrieves a character's participation details for a specific campaign objective.
Parameters
- characterId: number
  The ID of the character
- objectiveId: string
  The UUID of the objective
Returns Promise<
    {
        id: string;
        campaign_id: string;
        is_committed: boolean;
        contributed: number;
        last_modified: string;
        [key: string]: unknown;
    },
>
The character's participation details for the objective

Requires
Authentication with scope esi.activity.char:read
- Defined in src/clients/MilitaryCampaignsClient.ts:109

Class MilitaryCampaignsClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MilitaryCampaignsClient

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

getMilitaryCampaigns

Returns Promise< { campaigns: { id: string; state: string & {} | "Unspecified" | "Active" | "Completed" | "Expired"; progress: number; started?: string; finished?: string; [key: string]: unknown; }[]; [key: string]: unknown; },>

getMilitaryCampaign

Parameters

Returns Promise< { id: string; state: string & {} | "Unspecified" | "Active" | "Completed" | "Expired"; progress: number; started?: string; finished?: string; [key: string]: unknown; },>

getMilitaryCampaignObjectives

Parameters

getMilitaryCampaignObjective

Parameters

getCharacterMilitaryCampaignObjectives

Parameters

Returns Promise< { objectives: { id: string; campaign_id: string; is_committed: boolean; contributed: number; last_modified: string; [key: string]: unknown; }[]; cursor?: { before?: string; after?: string; [key: string]: unknown }; [key: string]: unknown; },>

Requires

getCharacterMilitaryCampaignObjective

Parameters

Returns Promise< { id: string; campaign_id: string; is_committed: boolean; contributed: number; last_modified: string; [key: string]: unknown; },>

Requires

Settings

On This Page

`Protected`api

`Protected`_client

`Protected`_endpoints

Returns Promise<
{
campaigns: {
id: string;
state: string & {}
| "Unspecified"
| "Active"
| "Completed"
| "Expired";
progress: number;
started?: string;
finished?: string;
[key: string]: unknown;
}[];
[key: string]: unknown;
},
>

Returns Promise<
{
id: string;
state: string & {}
| "Unspecified"
| "Active"
| "Completed"
| "Expired";
progress: number;
started?: string;
finished?: string;
[key: string]: unknown;
},
>

Returns Promise<
{
objectives: {
id: string;
campaign_id: string;
is_committed: boolean;
contributed: number;
last_modified: string;
[key: string]: unknown;
}[];
cursor?: { before?: string; after?: string; [key: string]: unknown };
[key: string]: unknown;
},
>

Returns Promise<
{
id: string;
campaign_id: string;
is_committed: boolean;
contributed: number;
last_modified: string;
[key: string]: unknown;
},
>