Class TypesClassesResource

Entity classes resource

See

https://www.swcombine.com/ws/v2.0/documentation/types/classes/entity_type/ SW Combine API Documentation

Hierarchy (View Summary)

BaseResource
- TypesClassesResource

Index

Constructors

Methods

Constructors

constructor

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

Methods

list

list(
    options: {
        entityType: TypesEntityType;
        item_count?: number;
        pageDelay?: number;
        start_index?: number;
    },
): Promise<Page<EntityClass>>
Get all classes for a specific entity type (paginated)

NOTE: Official API documentation states "Query String: N/A" and "Parameters: N/A", but empirical testing suggests pagination parameters may be required to avoid 404 errors. The SDK includes pagination parameters by default for safety.
Parameters
- options: {
      entityType: TypesEntityType;
      item_count?: number;
      pageDelay?: number;
      start_index?: number;
  }
  Entity type (plural, e.g., 'vehicles', 'ships') and optional pagination parameters
Returns Promise<Page<EntityClass>>
Example
```
const classes = await client.types.classes.list({ entityType: 'vehicles' });
const moreClasses = await client.types.classes.list({ entityType: 'vehicles', start_index: 51, item_count: 50 });
```
- Defined in src/resources/TypesResource.ts:54