@gohighlevel/api-client
Version:
Official SDK for HighLevel Public APIs
156 lines • 6.15 kB
TypeScript
import { AxiosInstance, AxiosRequestConfig } from 'axios';
import * as Models from './models/store';
/**
* Store Service
* Documentation for store API
*/
export declare class Store {
private client;
constructor(httpClient: AxiosInstance);
/**
* Create Shipping Zone
* The "Create Shipping Zone" API allows adding a new shipping zone.
*/
createShippingZone(requestBody: Models.CreateShippingZoneDto, options?: AxiosRequestConfig): Promise<Models.CreateShippingZoneResponseDto>;
/**
* List Shipping Zones
* The "List Shipping Zone" API allows to retrieve a list of shipping zone.
*/
listShippingZones(params: {
altId: string;
altType: string;
limit?: number;
offset?: number;
withShippingRate?: boolean;
}, options?: AxiosRequestConfig): Promise<Models.ListShippingZoneResponseDto>;
/**
* Get Shipping Zone
* The "List Shipping Zone" API allows to retrieve a paginated list of shipping zone.
*/
getShippingZones(params: {
shippingZoneId: string;
altId: string;
altType: string;
withShippingRate?: boolean;
}, options?: AxiosRequestConfig): Promise<Models.GetShippingZoneResponseDto>;
/**
* Update Shipping Zone
* The "update Shipping Zone" API allows update a shipping zone to the system.
*/
updateShippingZone(params: {
shippingZoneId: string;
}, requestBody: Models.UpdateShippingZoneDto, options?: AxiosRequestConfig): Promise<Models.UpdateShippingZoneResponseDto>;
/**
* Delete shipping zone
* Delete specific shipping zone with Id :shippingZoneId
*/
deleteShippingZone(params: {
shippingZoneId: string;
altId: string;
altType: string;
}, options?: AxiosRequestConfig): Promise<Models.DeleteShippingZoneResponseDto>;
/**
* Get available shipping rates
* This return available shipping rates for country based on order amount
*/
getAvailableShippingZones(requestBody: Models.GetAvailableShippingRates, options?: AxiosRequestConfig): Promise<Models.GetAvailableShippingRatesResponseDto>;
/**
* Create Shipping Rate
* The "Create Shipping Rate" API allows adding a new shipping rate.
*/
createShippingRate(params: {
shippingZoneId: string;
}, requestBody: Models.CreateShippingRateDto, options?: AxiosRequestConfig): Promise<Models.CreateShippingRateResponseDto>;
/**
* List Shipping Rates
* The "List Shipping Rate" API allows to retrieve a list of shipping rate.
*/
listShippingRates(params: {
shippingZoneId: string;
altId: string;
altType: string;
limit?: number;
offset?: number;
}, options?: AxiosRequestConfig): Promise<Models.ListShippingRateResponseDto>;
/**
* Get Shipping Rate
* The "List Shipping Rate" API allows to retrieve a paginated list of shipping rate.
*/
getShippingRates(params: {
shippingZoneId: string;
shippingRateId: string;
altId: string;
altType: string;
}, options?: AxiosRequestConfig): Promise<Models.GetShippingRateResponseDto>;
/**
* Update Shipping Rate
* The "update Shipping Rate" API allows update a shipping rate to the system.
*/
updateShippingRate(params: {
shippingZoneId: string;
shippingRateId: string;
}, requestBody: Models.UpdateShippingRateDto, options?: AxiosRequestConfig): Promise<Models.UpdateShippingRateResponseDto>;
/**
* Delete shipping rate
* Delete specific shipping rate with Id :shippingRateId
*/
deleteShippingRate(params: {
shippingZoneId: string;
shippingRateId: string;
altId: string;
altType: string;
}, options?: AxiosRequestConfig): Promise<Models.DeleteShippingRateResponseDto>;
/**
* Create Shipping Carrier
* The "Create Shipping Carrier" API allows adding a new shipping carrier.
*/
createShippingCarrier(requestBody: Models.CreateShippingCarrierDto, options?: AxiosRequestConfig): Promise<Models.CreateShippingCarrierResponseDto>;
/**
* List Shipping Carriers
* The "List Shipping Carrier" API allows to retrieve a list of shipping carrier.
*/
listShippingCarriers(params: {
altId: string;
altType: string;
}, options?: AxiosRequestConfig): Promise<Models.ListShippingCarrierResponseDto>;
/**
* Get Shipping Carrier
* The "List Shipping Carrier" API allows to retrieve a paginated list of shipping carrier.
*/
getShippingCarriers(params: {
shippingCarrierId: string;
altId: string;
altType: string;
}, options?: AxiosRequestConfig): Promise<Models.GetShippingCarrierResponseDto>;
/**
* Update Shipping Carrier
* The "update Shipping Carrier" API allows update a shipping carrier to the system.
*/
updateShippingCarrier(params: {
shippingCarrierId: string;
}, requestBody: Models.UpdateShippingCarrierDto, options?: AxiosRequestConfig): Promise<Models.UpdateShippingCarrierResponseDto>;
/**
* Delete shipping carrier
* Delete specific shipping carrier with Id :shippingCarrierId
*/
deleteShippingCarrier(params: {
shippingCarrierId: string;
altId: string;
altType: string;
}, options?: AxiosRequestConfig): Promise<Models.DeleteShippingCarrierResponseDto>;
/**
* Create/Update Store Settings
* Create or update store settings by altId and altType.
*/
createStoreSetting(requestBody: Models.CreateStoreSettingDto, options?: AxiosRequestConfig): Promise<Models.CreateStoreSettingResponseDto>;
/**
* Get Store Settings
* Get store settings by altId and altType.
*/
getStoreSettings(params: {
altId: string;
altType: string;
}, options?: AxiosRequestConfig): Promise<Models.GetStoreSettingResponseDto>;
}
export default Store;
//# sourceMappingURL=store.d.ts.map