Class FactionCreditsResource

Faction credits resource

See

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

Hierarchy (View Summary)

BaseResource
- FactionCreditsResource

Index

Constructors

Methods

Constructors

constructor

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

Methods

get

get(options: GetFactionCreditsOptions): Promise<FactionCredits>
Get faction credit balance.

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

transfer

transfer(options: TransferFactionCreditsOptions): Promise<unknown>
Transfer faction credits
Parameters
- options: TransferFactionCreditsOptions
  - amount: number
  - Optionalbudget?: string
  - factionId: string
  - Optionalreason?: string
  - recipient: string
Returns Promise<unknown>
- Defined in src/resources/FactionResource.ts:245