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

Constructors

constructor

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

Methods

get

get(options: GetCityOptions): Promise<City>
Get city by UID.

Returns the City object directly — not wrapped in a Page.
Parameters
- options: GetCityOptions
Returns Promise<City>
The City entity.
Example
```
const city = await client.galaxy.cities.get({ uid: '13:123' });
console.log(city.name); // access properties directly, not city.data
```
- Defined in src/resources/GalaxyResource.ts:294

list

list(
    options?: {
        item_count?: number;
        pageDelay?: number;
        start_index?: number;
    },
): Promise<Page<GalaxyCityListItem>>
List all cities (paginated)
Parameters
- Optionaloptions: { item_count?: number; pageDelay?: number; start_index?: number }
  Optional pagination parameters
Returns Promise<Page<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:258