Class FactionStockholdersResource

Faction stockholders resource

See

https://www.swcombine.com/ws/v2.0/documentation/faction/uid/stockholders/ SW Combine API Documentation

Hierarchy (View Summary)

BaseResource
- FactionStockholdersResource

Index

Constructors

Methods

Constructors

constructor

new FactionStockholdersResource(http: HttpClient): FactionStockholdersResource
Parameters
- http: HttpClient
Returns FactionStockholdersResource
Inherited from BaseResource.constructor
- Defined in src/resources/BaseResource.ts:13

Methods

list

list(
    options: {
        factionId: string;
        item_count?: number;
        start_index?: number;
    },
): Promise<Stockholder[]>
List faction stockholders (paginated)
Parameters
- options: { factionId: string; item_count?: number; start_index?: number }
  Faction ID and optional pagination parameters
Returns Promise<Stockholder[]>
Example
```
const stockholders = await client.faction.stockholders.list({ factionId: '20:123' });
const moreStockholders = await client.faction.stockholders.list({ factionId: '20:123', start_index: 51, item_count: 50 });
```
- Defined in src/resources/FactionResource.ts:135