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:14

Methods

get

get(options: { budgetId: string; factionId: string }): Promise<Budget>
Get a specific faction budget.

Returns the Budget object directly — not wrapped in a Page.
Parameters
- options: { budgetId: string; factionId: string }
Returns Promise<Budget>
The Budget entity.
Example
```
const budget = await client.faction.budgets.get({ factionId: '20:123', budgetId: 'budget-uid' });
console.log(budget); // access properties directly, not budget.data
```
- Defined in src/resources/FactionResource.ts:166

list

list(
    options: {
        factionId: string;
        item_count?: number;
        pageDelay?: number;
        start_index?: number;
    },
): Promise<Page<Budget>>
List faction budgets (paginated)
Parameters
- options: {
      factionId: string;
      item_count?: number;
      pageDelay?: number;
      start_index?: number;
  }
  Faction ID and optional pagination parameters
Returns Promise<Page<Budget>>
Example
```
const page = await client.faction.budgets.list({ factionId: '20:123' });
console.log(page.data); // Budget[]
// Iterate all pages:
for await (const budget of page) { console.log(budget); }
```
- Defined in src/resources/FactionResource.ts:126