Class FactionBudgetsResource

Faction budgets resource

See

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

Hierarchy (View Summary)

BaseResource
- FactionBudgetsResource

Index

Constructors

Methods

Constructors

constructor

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

Methods

get

get(options: { budgetId: string; factionId: string }): Promise<Budget>
Get specific budget
Parameters
- options: { budgetId: string; factionId: string }
Returns Promise<Budget>
- Defined in src/resources/FactionResource.ts:117

list

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