wallee
Version:
TypeScript/JavaScript client for wallee
83 lines (82 loc) • 3.58 kB
TypeScript
import http = require("http");
import Promise = require("bluebird");
import { Authentication } from '../auth/Authentication';
import { EntityQuery } from '../models/EntityQuery';
import { EntityQueryFilter } from '../models/EntityQueryFilter';
import { ShopifySubscriptionProduct } from '../models/ShopifySubscriptionProduct';
import { ShopifySubscriptionProductCreate } from '../models/ShopifySubscriptionProductCreate';
import { ShopifySubscriptionProductUpdate } from '../models/ShopifySubscriptionProductUpdate';
declare class ShopifySubscriptionProductService {
protected _basePath: string;
protected _defaultHeaders: any;
protected _useQuerystring: boolean;
protected _timeout: number;
protected _defaultAuthentication: Authentication;
constructor(configuration: any);
/**
* Set timeout in seconds. Default timeout: 25 seconds
* @param {number} timeout
*/
set timeout(timeout: number);
private setTimeout;
set basePath(basePath: string);
get basePath(): string;
protected setDefaultAuthentication(auth: Authentication): void;
private getVersion;
/**
* Counts the number of items in the database as restricted by the given filter.
* @summary Count
* @param spaceId
* @param filter The filter which restricts the entities which are used to calculate the count.
* @param {*} [options] Override http request options.
*/
count(spaceId: number, filter?: EntityQueryFilter, options?: any): Promise<{
response: http.IncomingMessage;
body: number;
}>;
/**
* Creates the entity with the given properties.
* @summary Create
* @param spaceId
* @param entity The Shopify subscription product object with the properties which should be created.
* @param {*} [options] Override http request options.
*/
create(spaceId: number, entity: ShopifySubscriptionProductCreate, options?: any): Promise<{
response: http.IncomingMessage;
body: ShopifySubscriptionProduct;
}>;
/**
* Reads the entity with the given 'id' and returns it.
* @summary Read
* @param spaceId
* @param id The id of the Shopify subscription product which should be returned.
* @param {*} [options] Override http request options.
*/
read(spaceId: number, id: number, options?: any): Promise<{
response: http.IncomingMessage;
body: ShopifySubscriptionProduct;
}>;
/**
* Searches for the entities as specified by the given query.
* @summary Search
* @param spaceId
* @param query The query restricts the Shopify subscription products which are returned by the search.
* @param {*} [options] Override http request options.
*/
search(spaceId: number, query: EntityQuery, options?: any): Promise<{
response: http.IncomingMessage;
body: Array<ShopifySubscriptionProduct>;
}>;
/**
* This updates the entity with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the entity.
* @summary Update
* @param spaceId
* @param entity The Shopify subscription product object with all the properties which should be updated. The id and the version are required properties.
* @param {*} [options] Override http request options.
*/
update(spaceId: number, entity: ShopifySubscriptionProductUpdate, options?: any): Promise<{
response: http.IncomingMessage;
body: ShopifySubscriptionProduct;
}>;
}
export { ShopifySubscriptionProductService };