Class DatacardResource

Datacard resource for managing datacards

See

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

Hierarchy (View Summary)

BaseResource
- DatacardResource

Index

Constructors

Methods

create delete get list

Constructors

constructor

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

Methods

create

create(
    options: {
        production_entity_uid: string;
        uid: string;
        unlimited?: boolean;
        uses?: number;
    },
): Promise<Datacard>
Create/assign datacard to production entity
Parameters
- options: {
      production_entity_uid: string;
      uid: string;
      unlimited?: boolean;
      uses?: number;
  }
  - production_entity_uid: string
    The entity UID to assign this datacard to
  - uid: string
    Datacard UID
  - Optionalunlimited?: boolean
    Set to true for unlimited uses (optional, use this OR uses)
  - Optionaluses?: number
    Number of uses (optional, use this OR unlimited)
Returns Promise<Datacard>
- Defined in src/resources/DatacardResource.ts:93

delete

delete(options: { production_entity_uid: string; uid: string }): Promise<void>
Delete datacard assignment
Parameters
- options: { production_entity_uid: string; uid: string }
  - production_entity_uid: string
    Production entity UID to revoke from (required)
  - uid: string
    Datacard UID
Returns Promise<void>
- Defined in src/resources/DatacardResource.ts:117

get

get(options: { uid: string }): Promise<Datacard>
Get a specific datacard by UID.

Returns the Datacard object directly — not wrapped in a Page. Access properties like .name and .uid on the result itself.
Parameters
- options: { uid: string }
Returns Promise<Datacard>
The Datacard entity.
Example
```
const card = await client.datacard.get({ uid: 'datacard-uid' });
console.log(card.name); // access properties directly, not card.data
```
- Defined in src/resources/DatacardResource.ts:82

list

list(
options: { factionId: string; pageDelay?: number },
): Promise<Page<Datacard>>
List datacards owned by faction.

Returns a Page<Datacard> — access the array of datacards via .data.
Parameters
- options: { factionId: string; pageDelay?: number }
Returns Promise<Page<Datacard>>
A Page<Datacard> with .data, .total, .hasMore, and .getNextPage().
Example
```
const page = await client.datacard.list({ factionId: '20:123' });
console.log(page.data);   // Datacard[] — items on this page
console.log(page.total);  // total datacards across all pages

for await (const card of page) {
  console.log(card.name); // auto-paginates
}
```
- Defined in src/resources/DatacardResource.ts:39