ProductGroups | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- ProductGroups

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ProductGroups(options: ProductGroupsOptions, http: Client): ProductGroups

Overrides ThBaseHandler.constructor
- Defined in src/v0/product_groups.ts:54
Parameters
- options: ProductGroupsOptions
- http: Client
Returns ProductGroups

Properties

endpoint

endpoint: string

http

http: Client

options

options: ProductGroupsOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

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

Methods

create

create(productGroup: ProductGroup): Promise<ProductGroupResponse>

- Defined in src/v0/product_groups.ts:124
Parameters
- productGroup: ProductGroup
Returns Promise<ProductGroupResponse>

delete

delete(taxId: string): Promise<ProductGroupResponse>

- Defined in src/v0/product_groups.ts:138
Parameters
- taxId: string
Returns Promise<ProductGroupResponse>

get

get(productGroupId: string, queryOrOptions?: ProductGroupsQuery): Promise<ProductGroupResponse>

- Defined in src/v0/product_groups.ts:88
Parameters
- productGroupId: string
- Optional queryOrOptions: ProductGroupsQuery
Returns Promise<ProductGroupResponse>

getAll

getAll(queryOrOptions?: ProductGroupsQuery): Promise<ProductGroupsResponse>

- Defined in src/v0/product_groups.ts:69
Parameters
- Optional queryOrOptions: ProductGroupsQuery
Returns Promise<ProductGroupsResponse>

put

put(productGroupId: string, productGroup: ProductGroup): Promise<ProductGroupResponse>

- Defined in src/v0/product_groups.ts:109
Parameters
- productGroupId: string
- productGroup: ProductGroup
Returns Promise<ProductGroupResponse>

search

search(searchTerm: string): Promise<ProductGroupsResponse>

- Defined in src/v0/product_groups.ts:152
Parameters
- searchTerm: string
Returns Promise<ProductGroupsResponse>

Generated using TypeDoc