Class MarketVendorsResource

Market vendors resource

See

https://www.swcombine.com/ws/v2.0/documentation/market/vendors/ SW Combine API Documentation

Hierarchy (View Summary)

BaseResource
- MarketVendorsResource

Index

Constructors

Methods

Constructors

constructor

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

Methods

get

get(options: GetVendorOptions): Promise<Vendor>
Get a specific vendor by UID.

Returns the Vendor object directly — not wrapped in a Page.
Parameters
- options: GetVendorOptions
Returns Promise<Vendor>
The Vendor entity.
Example
```
const vendor = await client.market.vendors.get({ uid: 'vendor-uid' });
console.log(vendor.name); // access properties directly, not vendor.data
```
- Defined in src/resources/MarketResource.ts:63

list

list(
    options?: {
        item_count?: number;
        pageDelay?: number;
        start_index?: number;
    },
): Promise<Page<Vendor>>
List all public vendors (paginated)
Parameters
- Optionaloptions: { item_count?: number; pageDelay?: number; start_index?: number }
  Optional pagination parameters
Returns Promise<Page<Vendor>>
Example
```
const vendors = await client.market.vendors.list();
const moreVendors = await client.market.vendors.list({ start_index: 51, item_count: 50 });
```
- Defined in src/resources/MarketResource.ts:23