Class InventoryEntitiesResource

Inventory entities resource

See

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

Hierarchy (View Summary)

BaseResource
- InventoryEntitiesResource

Index

Constructors

constructor

Methods

addTag get list removeAllTags removeTag updateProperty

Constructors

constructor

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

Methods

addTag

addTag(options: { entityType: string; tag: string; uid: string }): Promise<void>
Add tag to entity
Parameters
- options: { entityType: string; tag: string; uid: string }
Returns Promise<void>
- Defined in src/resources/InventoryResource.ts:138

get

get(options: GetEntityOptions): Promise<Entity>
Get specific entity
Parameters
- options: GetEntityOptions
Returns Promise<Entity>
- Defined in src/resources/InventoryResource.ts:92

list

list<T extends InventoryEntityType>(
options: ListInventoryEntitiesOptions<T>,
): Promise<InventoryEntityTypeMap[T][]>
List entities in inventory (paginated with optional filtering)

Supports filtering by various entity properties. Filter arrays must have matching lengths.
Type Parameters
- T extends InventoryEntityType
Parameters
- options: ListInventoryEntitiesOptions<T>
  Inventory UID, entity type, assign type, and optional pagination/filtering parameters
  - assignType: InventoryAssignType
    Assignment type: 'owner', 'commander', or 'pilot'
  - entityType: T
    Entity type: 'ships', 'vehicles', 'stations', 'cities', 'facilities', 'planets', 'items', 'npcs', 'droids', 'creatures', or 'materials'
  - Optionalfilter_inclusion?: InventoryFilterInclusion[]
    Whether each filter should include or exclude matches. Default: 'includes'
  - Optionalfilter_type?: InventoryFilterType[]
    Filter types to apply to the query
  - Optionalfilter_value?: string[]
    Values corresponding to each filter type
  - Optionalitem_count?: number
    Number of items to retrieve. Default: 50, Max: 200
  - Optionalstart_index?: number
    Starting position for pagination (1-based). Default: 1
  - uid: string
Returns Promise<InventoryEntityTypeMap[T][]>
Example
```
const entities = await client.inventory.entities.list({ uid: '1:12345', entityType: 'vehicle', assignType: 'pilot' });
// Fetch up to 200 entities at once
const moreEntities = await client.inventory.entities.list({ uid: '1:12345', entityType: 'vehicle', assignType: 'pilot', start_index: 1, item_count: 200 });
// Filter by multiple criteria
const multiFiltered = await client.inventory.entities.list({
  uid: '1:12345',
  entityType: 'ships',
  assignType: 'owner',
  filter_type: ['class', 'powered'],
  filter_value: ['Fighter', '1'],
  filter_inclusion: ['includes', 'includes']
});
```
- Defined in src/resources/InventoryResource.ts:50

removeAllTags

removeAllTags(options: { entityType: string; uid: string }): Promise<void>
Remove all tags from entity
Parameters
- options: { entityType: string; uid: string }
Returns Promise<void>
- Defined in src/resources/InventoryResource.ts:158

removeTag

removeTag(
options: { entityType: string; tag: string; uid: string },
): Promise<void>
Remove tag from entity
Parameters
- options: { entityType: string; tag: string; uid: string }
Returns Promise<void>
- Defined in src/resources/InventoryResource.ts:148

updateProperty

updateProperty(
    options: {
        entityType: string;
        new_value: string;
        property:
            | "name"
            | "owner"
            | "infotext"
            | "commander"
            | "pilot"
            | "open-to"
            | "action"
            | "crewlist-add"
            | "crewlist-remove"
            | "crewlist-clear";
        reason?: string;
        uid: string;
    },
): Promise<Entity>
Update entity property
Parameters
- options: {
      entityType: string;
      new_value: string;
      property:
          | "name"
          | "owner"
          | "infotext"
          | "commander"
          | "pilot"
          | "open-to"
          | "action"
          | "crewlist-add"
          | "crewlist-remove"
          | "crewlist-clear";
      reason?: string;
      uid: string;
  }
  - entityType: string
    Entity type (ships, vehicles, stations, etc.)
  - new_value: string
    New value for the property
  - property:
        | "name"
        | "owner"
        | "infotext"
        | "commander"
        | "pilot"
        | "open-to"
        | "action"
        | "crewlist-add"
        | "crewlist-remove"
        | "crewlist-clear"
    Property to update
  - Optionalreason?: string
    Optional reason for the change
  - uid: string
    Entity UID
Returns Promise<Entity>
- Defined in src/resources/InventoryResource.ts:104

Class InventoryEntitiesResource

See

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns InventoryEntitiesResource

Methods

addTag

Parameters

Returns Promise<void>

get

Parameters

Returns Promise<Entity>

list

Type Parameters

Parameters

assignType: InventoryAssignType

entityType: T

Optionalfilter_inclusion?: InventoryFilterInclusion[]

Optionalfilter_type?: InventoryFilterType[]

Optionalfilter_value?: string[]

Optionalitem_count?: number

Optionalstart_index?: number

uid: string

Returns Promise<InventoryEntityTypeMap[T][]>

Example

removeAllTags

Parameters

Returns Promise<void>

removeTag

Parameters

Returns Promise<void>

updateProperty

Parameters

entityType: string

new_value: string

property: | "name" | "owner" | "infotext" | "commander" | "pilot" | "open-to" | "action" | "crewlist-add" | "crewlist-remove" | "crewlist-clear"

Optionalreason?: string

uid: string

Returns Promise<Entity>

Settings

On This Page

`Optional`filter_inclusion?: InventoryFilterInclusion[]

`Optional`filter_type?: InventoryFilterType[]

`Optional`filter_value?: string[]

`Optional`item_count?: number

`Optional`start_index?: number

property:
| "name"
| "owner"
| "infotext"
| "commander"
| "pilot"
| "open-to"
| "action"
| "crewlist-add"
| "crewlist-remove"
| "crewlist-clear"

`Optional`reason?: string