inventora-shopify-admin-api/services/gift_cards.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 class GiftCards extends BaseService {
    constructor(shopDomain: string, accessToken: string) {
        super(shopDomain, accessToken, "gift_cards");
    }

    /**
     * Creates a new Gift Card.
     */
    public create(giftCard: Partial<GiftCard>) {
        return this.createRequest<GiftCard>("POST", ".json", "gift_card", { gift_card: giftCard });
    }

    /**
     * Deletes the Gift Card with the given id.
     */
    public count() {
        return this.createRequest<void>("GET", `count.json`, "count");
    }

    /**
     * Gets a paged list of up to 250 of the shop's Gift Cards
     * @param options Options for filtering the results.
     */
    public list(options?: Options.GiftCardOptions & Options.FieldOptions & Options.ListOptions) {
        return this.createRequest<GiftCard[]>("GET", ".json", "gift_cards", options);
    }

    /**
     * Retrieves the Gift Card with the given id.
     * @param options Options for filtering the results.
     */
    public get(id: number) {
        return this.createRequest<GiftCard>("GET", `${id}.json`, "gift_card");
    }

    /**
     * Disable a Gift Card.
     */
    public disable(id: number) {
        return this.createRequest<GiftCard>("POST", `${id}/disable.json`, "gift_card");
    }

    /**
     * Search for Giftcards matching the specified criteria
     * @param options Options for filtering the results.
     */
    public search(options?: Options.GiftCardOptions & Options.FieldOptions & Options.ListOptions) {
        return this.createRequest<GiftCard[]>("GET", "search.json", "gift_cards", options);
    }
}

export default GiftCards;