Class CharacterCreditsResource

Character credits resource

See

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

Hierarchy (View Summary)

BaseResource
- CharacterCreditsResource

Index

Constructors

constructor

Methods

get transfer

Constructors

constructor

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

Methods

get

get(options: GetCharacterCreditsOptions): Promise<number>
Get character's credit balance @requires_auth Yes @requires_scope CHARACTER_CREDITS
Parameters
- options: GetCharacterCreditsOptions
Returns Promise<number>
Credit balance as a plain number
Example
```
const credits = await client.character.credits.get({ uid: '1:12345' });
console.log(`Credits: ${credits}`); // Credits: 320089347
```
- Defined in src/resources/CharacterResource.ts:373

transfer

transfer(
    options: {
        amount: number;
        reason?: string;
        recipient: string;
        uid: string;
    },
): Promise<unknown>
Transfer credits from character to another character or faction
Parameters
- options: { amount: number; reason?: string; recipient: string; uid: string }
  - amount: number
    Amount to transfer
  - Optionalreason?: string
    Reason for transfer (optional, API will auto-append client name) @requires_auth Yes @requires_scope CHARACTER_CREDITS_WRITE
  - recipient: string
    Recipient character or faction name/UID (REQUIRED)
  - uid: string
    Character UID
Returns Promise<unknown>
- Defined in src/resources/CharacterResource.ts:386

Class CharacterCreditsResource

See

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CharacterCreditsResource

Methods

get

Parameters

Returns Promise<number>

Example

transfer

Parameters

amount: number

`Optional`reason?: string

recipient: string

uid: string

Returns Promise<unknown>

Settings

On This Page

Class CharacterCreditsResource

See

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CharacterCreditsResource

Methods

get

Parameters

Returns Promise<number>

Example

transfer

Parameters

amount: number

Optionalreason?: string

recipient: string

uid: string

Returns Promise<unknown>

Settings

On This Page

`Optional`reason?: string