channel3-sdk
Version:
The official TypeScript/JavaScript SDK for Channel3 AI Shopping API
139 lines • 6.3 kB
TypeScript
/**
* FastAPI
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*
* The version of the OpenAPI document: 0.1.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import * as runtime from '../runtime';
import type { Brand, PaginatedResponseBrand, Product, ProductDetail, SearchRequest } from '../models/index';
export interface GetBrandDetailV0BrandsBrandIdGetRequest {
brandId: string;
}
export interface GetBrandsV0BrandsGetRequest {
query?: string | null;
page?: number;
size?: number;
}
export interface GetProductDetailV0ProductsProductIdGetRequest {
productId: string;
}
export interface SearchV0SearchPostRequest {
searchRequest: SearchRequest;
}
/**
* Channel3ApiApi - interface
*
* @export
* @interface Channel3ApiApiInterface
*/
export interface Channel3ApiApiInterface {
/**
* Get detailed information for a specific brand by its ID.
* @summary Get Brand Detail
* @param {string} brandId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof Channel3ApiApiInterface
*/
getBrandDetailV0BrandsBrandIdGetRaw(requestParameters: GetBrandDetailV0BrandsBrandIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Brand>>;
/**
* Get detailed information for a specific brand by its ID.
* Get Brand Detail
*/
getBrandDetailV0BrandsBrandIdGet(requestParameters: GetBrandDetailV0BrandsBrandIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Brand>;
/**
* Get all brands that the vendor currently sells.
* @summary Get Brands
* @param {string} [query]
* @param {number} [page]
* @param {number} [size]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof Channel3ApiApiInterface
*/
getBrandsV0BrandsGetRaw(requestParameters: GetBrandsV0BrandsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseBrand>>;
/**
* Get all brands that the vendor currently sells.
* Get Brands
*/
getBrandsV0BrandsGet(requestParameters: GetBrandsV0BrandsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseBrand>;
/**
* Get detailed information about a specific product by its ID.
* @summary Get Product Detail
* @param {string} productId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof Channel3ApiApiInterface
*/
getProductDetailV0ProductsProductIdGetRaw(requestParameters: GetProductDetailV0ProductsProductIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProductDetail>>;
/**
* Get detailed information about a specific product by its ID.
* Get Product Detail
*/
getProductDetailV0ProductsProductIdGet(requestParameters: GetProductDetailV0ProductsProductIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProductDetail>;
/**
* Search for products.
* @summary Search
* @param {SearchRequest} searchRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof Channel3ApiApiInterface
*/
searchV0SearchPostRaw(requestParameters: SearchV0SearchPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Product>>>;
/**
* Search for products.
* Search
*/
searchV0SearchPost(requestParameters: SearchV0SearchPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Product>>;
}
/**
*
*/
export declare class Channel3ApiApi extends runtime.BaseAPI implements Channel3ApiApiInterface {
/**
* Get detailed information for a specific brand by its ID.
* Get Brand Detail
*/
getBrandDetailV0BrandsBrandIdGetRaw(requestParameters: GetBrandDetailV0BrandsBrandIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Brand>>;
/**
* Get detailed information for a specific brand by its ID.
* Get Brand Detail
*/
getBrandDetailV0BrandsBrandIdGet(requestParameters: GetBrandDetailV0BrandsBrandIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Brand>;
/**
* Get all brands that the vendor currently sells.
* Get Brands
*/
getBrandsV0BrandsGetRaw(requestParameters: GetBrandsV0BrandsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseBrand>>;
/**
* Get all brands that the vendor currently sells.
* Get Brands
*/
getBrandsV0BrandsGet(requestParameters?: GetBrandsV0BrandsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseBrand>;
/**
* Get detailed information about a specific product by its ID.
* Get Product Detail
*/
getProductDetailV0ProductsProductIdGetRaw(requestParameters: GetProductDetailV0ProductsProductIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProductDetail>>;
/**
* Get detailed information about a specific product by its ID.
* Get Product Detail
*/
getProductDetailV0ProductsProductIdGet(requestParameters: GetProductDetailV0ProductsProductIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProductDetail>;
/**
* Search for products.
* Search
*/
searchV0SearchPostRaw(requestParameters: SearchV0SearchPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Product>>>;
/**
* Search for products.
* Search
*/
searchV0SearchPost(requestParameters: SearchV0SearchPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Product>>;
}
//# sourceMappingURL=Channel3ApiApi.d.ts.map