Storefronts | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- Storefronts

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Storefronts(options: StorefrontsOptions, http: Client): Storefronts

Overrides ThBaseHandler.constructor
- Defined in src/v0/storefronts.ts:210
Parameters
- options: StorefrontsOptions
- http: Client
Returns Storefronts

Properties

endpoint

endpoint: string

http

http: Client

options

options: StorefrontsOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

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

Methods

availableProducts

availableProducts(storefrontId: string, query?: ProductsOptions): Promise<StorefrontAvailableProductsResponse>

- Defined in src/v0/storefronts.ts:425
Parameters
- storefrontId: string
- Optional query: ProductsOptions
Returns Promise<StorefrontAvailableProductsResponse>

availableProductsMeta

availableProductsMeta(storefrontId: string, query?: ProductsOptions): Promise<StorefrontAvailableProductsResponse>

- Defined in src/v0/storefronts.ts:451
Parameters
- storefrontId: string
- Optional query: ProductsOptions
Returns Promise<StorefrontAvailableProductsResponse>

create

create(storefront: Storefront): Promise<StorefrontResponse>

- Defined in src/v0/storefronts.ts:274
Parameters
- storefront: Storefront
Returns Promise<StorefrontResponse>

delete

delete(storefrontId: string): Promise<StorefrontResponse>

- Defined in src/v0/storefronts.ts:288
Parameters
- storefrontId: string
Returns Promise<StorefrontResponse>

delta

delta(storefrontId: string): Promise<StorefrontDeltaResponse>

- Defined in src/v0/storefronts.ts:354
Parameters
- storefrontId: string
Returns Promise<StorefrontDeltaResponse>

get

get(storefrontId: string): Promise<StorefrontResponse>

- Defined in src/v0/storefronts.ts:244
Parameters
- storefrontId: string
Returns Promise<StorefrontResponse>

getAll

getAll(queryOrOptions?: StorefrontsQuery): Promise<StorefrontsResponse>

- Defined in src/v0/storefronts.ts:225
Parameters
- Optional queryOrOptions: StorefrontsQuery
Returns Promise<StorefrontsResponse>

getWhitelisted

getWhitelisted(storefrontId: string): Promise<StorefrontWhitelistResponse>

- Defined in src/v0/storefronts.ts:390
Parameters
- storefrontId: string
Returns Promise<StorefrontWhitelistResponse>

getWhitelistedMeta

getWhitelistedMeta(storefrontId: string): Promise<StorefrontWhitelistMetaResponse>

- Defined in src/v0/storefronts.ts:408
Parameters
- storefrontId: string
Returns Promise<StorefrontWhitelistMetaResponse>

profile

profile(storefrontId: string): Promise<StorefrontProfileResponse>

- Defined in src/v0/storefronts.ts:302
Parameters
- storefrontId: string
Returns Promise<StorefrontProfileResponse>

put

put(storefrontId: string, storefront: Storefront): Promise<StorefrontResponse>

- Defined in src/v0/storefronts.ts:260
Parameters
- storefrontId: string
- storefront: Storefront
Returns Promise<StorefrontResponse>

sync

sync(storefrontId: string): Promise<StorefrontSyncAllResponse>

- Defined in src/v0/storefronts.ts:320
Parameters
- storefrontId: string
Returns Promise<StorefrontSyncAllResponse>

syncStatus

syncStatus(storefrontId: string): Promise<StorefrontSyncStatusResponse>

- Defined in src/v0/storefronts.ts:336
Parameters
- storefrontId: string
Returns Promise<StorefrontSyncStatusResponse>

whitelist

whitelist(storefrontId: string, products: string[]): Promise<StorefrontWhitelistResponse>

- Defined in src/v0/storefronts.ts:372
Parameters
- storefrontId: string
- products: string[]
Returns Promise<StorefrontWhitelistResponse>

Generated using TypeDoc