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

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

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

get

get(options: { uid: string }): Promise<Datacard>
Get specific datacard
Parameters
- options: { uid: string }
Returns Promise<Datacard>
- Defined in src/resources/DatacardResource.ts:37

list

list(options: { factionId: string }): Promise<Datacard[]>
List datacards owned by faction
Parameters
- options: { factionId: string }
Returns Promise<Datacard[]>
- Defined in src/resources/DatacardResource.ts:23