Categories | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- Categories

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Categories(options: CategoriesOptions, http: Client): Categories

Overrides ThBaseHandler.constructor
- Defined in src/v0/categories.ts:51
Parameters
- options: CategoriesOptions
- http: Client
Returns Categories

Properties

endpoint

endpoint: string

http

http: Client

options

options: CategoriesOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

baseEndpoint: string = '/api/v0/categories'

Methods

create

create(category: Category): Promise<CategoryResponse>

- Defined in src/v0/categories.ts:124
Parameters
- category: Category
Returns Promise<CategoryResponse>

delete

delete(storefrontId: string): Promise<CategoryResponse>

- Defined in src/v0/categories.ts:138
Parameters
- storefrontId: string
Returns Promise<CategoryResponse>

get

get(categoryId: string): Promise<CategoryResponse>

- Defined in src/v0/categories.ts:92
Parameters
- categoryId: string
Returns Promise<CategoryResponse>

getAll

getAll(query?: CategoriesQuery): Promise<CategoriesResponse>

- Defined in src/v0/categories.ts:66
Parameters
- Optional query: CategoriesQuery
Returns Promise<CategoriesResponse>

put

put(categoryId: string, category: Category): Promise<CategoryResponse>

- Defined in src/v0/categories.ts:110
Parameters
- categoryId: string
- category: Category
Returns Promise<CategoryResponse>

Generated using TypeDoc