inventora-shopify-admin-api/dist/services/application_credits.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 { ApplicationCredit } from '../interfaces';
import { BaseService } from '../infrastructure';
/**
 * A service for offering credits for payments made via the Application Charge, Recurring Application Charge, and Usage Charge APIs.
 */
export declare class ApplicationCredits extends BaseService {
    constructor(shopDomain: string, accessToken: string);
    /**
     * Creates a new Application Credit.
     */
    create(credit: Partial<ApplicationCredit>): Promise<ApplicationCredit>;
    /**
     * Gets an application credit with the given id.
     * @param id The id of the credit to get.
     * @param options Options for filtering the result.
     */
    get(id: number, options?: Options.FieldOptions): Promise<ApplicationCredit>;
    /**
     * Retrieves a list of all past and present application credits.
     * @param options Options for filtering the result.
     */
    list(options?: Options.FieldOptions): Promise<ApplicationCredit[]>;
}
export default ApplicationCredits;