inventora-shopify-admin-api/dist/services/gift_cards.d.ts

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.

import * as Options from '../options';
import { BaseService } from '../infrastructure';
import { GiftCard } from '../interfaces';
/**
 * A service for manipulating Shopify Gift Cards
 */
export declare class GiftCards extends BaseService {
    constructor(shopDomain: string, accessToken: string);
    /**
     * Creates a new Gift Card.
     */
    create(giftCard: Partial<GiftCard>): Promise<GiftCard>;
    /**
     * Deletes the Gift Card with the given id.
     */
    count(): Promise<void>;
    /**
     * Gets a paged list of up to 250 of the shop's Gift Cards
     * @param options Options for filtering the results.
     */
    list(options?: Options.GiftCardOptions & Options.FieldOptions & Options.ListOptions): Promise<GiftCard[]>;
    /**
     * Retrieves the Gift Card with the given id.
     * @param options Options for filtering the results.
     */
    get(id: number): Promise<GiftCard>;
    /**
     * Disable a Gift Card.
     */
    disable(id: number): Promise<GiftCard>;
    /**
     * Search for Giftcards matching the specified criteria
     * @param options Options for filtering the results.
     */
    search(options?: Options.GiftCardOptions & Options.FieldOptions & Options.ListOptions): Promise<GiftCard[]>;
}
export default GiftCards;