Class GalaxyCitiesResource

Galaxy cities resource

See

https://www.swcombine.com/ws/v2.0/documentation/galaxy/cities/ SW Combine API Documentation

Hierarchy (View Summary)

BaseResource
- GalaxyCitiesResource

Index

Constructors

Methods

get list listRaw

Constructors

constructor

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

Methods

get

get(options: GetCityOptions): Promise<City>
Get city by UID
Parameters
- options: GetCityOptions
Returns Promise<City>
- Defined in src/resources/GalaxyResource.ts:203

list

list(
options?: { item_count?: number; start_index?: number },
): Promise<GalaxyCityListItem[]>
List all cities (paginated)
Parameters
- Optionaloptions: { item_count?: number; start_index?: number }
  Optional pagination parameters
Returns Promise<GalaxyCityListItem[]>
Example
```
const cities = await client.galaxy.cities.list();
const moreCities = await client.galaxy.cities.list({ start_index: 51, item_count: 50 });
```
- Defined in src/resources/GalaxyResource.ts:194

listRaw

listRaw(
options?: { item_count?: number; start_index?: number },
): Promise<GalaxyCityListRawResponse>
Parameters
- Optionaloptions: { item_count?: number; start_index?: number }
Returns Promise<GalaxyCityListRawResponse>
- Defined in src/resources/GalaxyResource.ts:179