shopify-admin-api
Version:
Shopify Admin API is a NodeJS library built to help developers easily authenticate and make calls against the Shopify API. It was inspired by and borrows heavily from ShopifySharp.
77 lines (76 loc) • 2.52 kB
TypeScript
import { PublishedStatus } from "../enums/published_status";
export interface FieldOptions {
/**
* A comma-separated list of fields that will be returned instead of the whole object.
*/
fields?: string;
}
export interface UpdatedAtOptions {
/**
* Retrieve only objects that were created after the given date and time (format: 2014-04-25T16:15:47-04:00).
*/
updated_at_min?: string;
/**
* Retrieve only objects that were created before the given date and time (format: 2014-04-25T16:15:47-04:00).
*/
updated_at_max?: string;
}
export interface CreatedAtOptions {
/**
* Retrieve only objects that were created after the given date and time (format: 2014-04-25T16:15:47-04:00).
*/
created_at_min?: string;
/**
* Retrieve only objects that were created before the given date and time (format: 2014-04-25T16:15:47-04:00).
*/
created_at_max?: string;
}
export interface DateOptions extends UpdatedAtOptions, CreatedAtOptions {
}
export interface ProcessedOptions {
/**
* Show objects imported or processed after date (format: 2014-04-25T16:15:47-04:00).
*/
processed_at_min?: string;
/**
* Show objects imported or processed before date (format: 2014-04-25T16:15:47-04:00).
*/
processed_at_max?: string;
}
export interface BasicListOptions {
/**
* The maximum number of objects that should be returned, up to 250. Setting this parameter above 250 will result in an error.
*/
limit?: number;
/**
* The page number of the result list to retrieve. Use this in tandem with limit to page through the webhooks in a shop.
*/
page?: number;
}
export interface SinceIdOptions {
/**
* Restricts results to those created after the given id.
*/
since_id?: number;
}
export interface ListOptions extends BasicListOptions, SinceIdOptions {
}
export interface PublishedOptions {
/**
* Filter results to those published after date (format: 2014-04-25T16:15:47-04:00)
*/
published_at_min?: string;
/**
* Filter results to those published before date (format: 2014-04-25T16:15:47-04:00)
*/
published_at_max?: string;
/**
* Filter results to those with the given publish status.
*
* (default: `any`)
* * **published**: Show only published pages.
* * **unpublished**: Show only unpublished pages.
* * **any**: Show published and unpublished pages.
*/
published_status?: PublishedStatus;
}