Carts | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- Carts

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Carts(options: CartsOptions, http: Client): Carts

Overrides ThBaseHandler.constructor
- Defined in src/v1/carts.ts:73
Parameters
- options: CartsOptions
- http: Client
Returns Carts

Properties

endpoint

endpoint: string

http

http: Client

options

options: CartsOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

baseEndpoint: string = '/api/v1/carts'

Methods

create

create(cart: Cart, query?: Record<string, unknown>): Promise<CartResponse>

- Defined in src/v1/carts.ts:85
Parameters
- cart: Cart
- Optional query: Record<string, unknown>
Returns Promise<CartResponse>

delete

delete(cartId: string, deleteOptions?: CartDeleteOptions): Promise<CartsResponse>

- Defined in src/v1/carts.ts:190
Parameters
- cartId: string
- Optional deleteOptions: CartDeleteOptions
Returns Promise<CartsResponse>

get

get(cartId: string): Promise<CartResponse>

- Defined in src/v1/carts.ts:131
Parameters
- cartId: string
Returns Promise<CartResponse>

getAll

getAll(options?: CartsOptions): Promise<CartsResponse>

- Defined in src/v1/carts.ts:105
Parameters
- Optional options: CartsOptions
Returns Promise<CartsResponse>

meta

meta(): Promise<CartsResponse>

- Defined in src/v1/carts.ts:149
Returns Promise<CartsResponse>

put

put(cartId: string, cart: Cart): Promise<CartResponse>

- Defined in src/v1/carts.ts:172
Parameters
- cartId: string
- cart: Cart
Returns Promise<CartResponse>

search

search(searchTerm: string): Promise<CartsResponse>

- Defined in src/v1/carts.ts:208
Parameters
- searchTerm: string
Returns Promise<CartsResponse>

Generated using TypeDoc