Class FactionIdContext

Context class for Faction API endpoints that require a "id"

Index

Constructors

constructor

Methods

basic chain chains get hof members raids rankedwars territory territorywars wars

Constructors

constructor

new FactionIdContext(
requester: Requester,
contextId: string | number,
): FactionIdContext
Parameters
- requester: Requester
- contextId: string | number
Returns FactionIdContext
- Defined in src/generated/endpoints/faction.ts:761

Methods

basic

basic(params?: { timestamp?: string }): Promise<FactionBasicResponse>
Get a faction's basic details
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<FactionBasicResponse>
- Defined in src/generated/endpoints/faction.ts:770

chain

chain(params?: { timestamp?: string }): Promise<FactionOngoingChainResponse>
Get a faction's current chain
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<FactionOngoingChainResponse>
- Defined in src/generated/endpoints/faction.ts:784

chains

chains(
    params?: {
        from?: number;
        limit?: number;
        sort?: "ASC" | "DESC";
        timestamp?: string;
        to?: number;
    },
): Promise<PaginatedResponse<FactionChainsResponse> & FactionChainsResponse>
Get a list of a faction's completed chains
Parameters
- Optionalparams: {
      from?: number;
      limit?: number;
      sort?: "ASC" | "DESC";
      timestamp?: string;
      to?: number;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<FactionChainsResponse> & FactionChainsResponse>
- Defined in src/generated/endpoints/faction.ts:798

get

get(): Promise<Faction>
Get faction by ID

Returns Promise<Faction>
- Defined in src/generated/endpoints/faction.ts:941

hof

hof(params?: { timestamp?: string }): Promise<FactionHofResponse>
Get a faction's hall of fame rankings.
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<FactionHofResponse>
- Defined in src/generated/endpoints/faction.ts:822

members

members(
params?: { striptags?: "true" | "false"; timestamp?: string },
): Promise<FactionMembersResponse>
Get a list of a faction's members
Parameters
- Optionalparams: { striptags?: "true" | "false"; timestamp?: string }
  Optional query parameters
Returns Promise<FactionMembersResponse>
- Defined in src/generated/endpoints/faction.ts:836

raids

raids(
    params?: {
        from?: number;
        limit?: number;
        sort?: "ASC" | "DESC";
        timestamp?: string;
        to?: number;
    },
): Promise<PaginatedResponse<FactionRaidsResponse> & FactionRaidsResponse>
Get a faction's raids history
Parameters
- Optionalparams: {
      from?: number;
      limit?: number;
      sort?: "ASC" | "DESC";
      timestamp?: string;
      to?: number;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<FactionRaidsResponse> & FactionRaidsResponse>
- Defined in src/generated/endpoints/faction.ts:852

rankedwars

rankedwars(
params?: { limit?: number; offset?: number; timestamp?: string },
): Promise<
PaginatedResponse<FactionRankedWarResponse> & FactionRankedWarResponse,
>
Get a faction's ranked wars history
Parameters
- Optionalparams: { limit?: number; offset?: number; timestamp?: string }
  Optional query parameters
Returns Promise<PaginatedResponse<FactionRankedWarResponse> & FactionRankedWarResponse>
- Defined in src/generated/endpoints/faction.ts:874

territory

territory(params?: { timestamp?: string }): Promise<FactionTerritoriesResponse>
Get a list of a faction's territories
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<FactionTerritoriesResponse>
- Defined in src/generated/endpoints/faction.ts:894

territorywars

territorywars(
    params?: {
        from?: number;
        limit?: number;
        sort?: "ASC" | "DESC";
        timestamp?: string;
        to?: number;
    },
): Promise<FactionTerritoryWarsHistoryResponse>
Get a faction's territory wars history
Parameters
- Optionalparams: {
      from?: number;
      limit?: number;
      sort?: "ASC" | "DESC";
      timestamp?: string;
      to?: number;
  }
  Optional query parameters
Returns Promise<FactionTerritoryWarsHistoryResponse>
- Defined in src/generated/endpoints/faction.ts:908

wars

wars(params?: { timestamp?: string }): Promise<FactionWarsResponse>
Get a faction's wars & pacts details
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<FactionWarsResponse>
- Defined in src/generated/endpoints/faction.ts:930

Class FactionIdContext

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns FactionIdContext

Methods

basic

Parameters

Returns Promise<FactionBasicResponse>

chain

Parameters

Returns Promise<FactionOngoingChainResponse>

chains

Parameters

Returns Promise<PaginatedResponse<FactionChainsResponse> & FactionChainsResponse>

get

Returns Promise<Faction>

hof

Parameters

Returns Promise<FactionHofResponse>

members

Parameters

Returns Promise<FactionMembersResponse>

raids

Parameters

Returns Promise<PaginatedResponse<FactionRaidsResponse> & FactionRaidsResponse>

rankedwars

Parameters

Returns Promise<PaginatedResponse<FactionRankedWarResponse> & FactionRankedWarResponse>

territory

Parameters

Returns Promise<FactionTerritoriesResponse>

territorywars

Parameters

Returns Promise<FactionTerritoryWarsHistoryResponse>

wars

Parameters

Returns Promise<FactionWarsResponse>

Settings

On This Page