lightrail-client/dist/programs.d.ts

A Javascript and Typescript client for Lightrail

import { CreateIssuanceParams, CreateIssuanceResponse, CreateProgramParams, CreateProgramResponse, DeleteProgramResponse, GetIssuanceResponse, GetProgramResponse, ListIssuancesParams, ListIssuancesResponse, ListProgramsParams, ListProgramsResponse, UpdateProgramParams, UpdateProgramResponse } from "./params";
import { Issuance, Program } from "./model";
/**
 * See: https://apidocs.lightrail.com/#operation/CreateProgram
 *
 * Example:
 * ```js
 * const program = await Lightrail.programs.createProgram({
 *     id: "abcdefg",
 *     currency: "USD",
 *     name: "Gift Cards",
 *     minInitialBalance: 250,
 *     maxInitialBalance: 50000
 * });
 * ```
 */
export declare function createProgram(params: CreateProgramParams): Promise<CreateProgramResponse>;
/**
 * See: https://apidocs.lightrail.com/#operation/ListPrograms
 *
 * Example:
 * ```js
 * const programs = await Lightrail.programs.listPrograms();
 * const programsLimited = await Lightrail.programs.listPrograms({limit: 5});
 * ```
 */
export declare function listPrograms(params?: ListProgramsParams): Promise<ListProgramsResponse>;
/**
 * See: https://apidocs.lightrail.com/#operation/GetaProgram
 *
 * Example:
 * ```js
 * const program = await Lightrail.programs.getProgram("abcdefg");
 * ```
 */
export declare function getProgram(program: string | Program): Promise<GetProgramResponse>;
/**
 * See: https://apidocs.lightrail.com/#operation/UpdateProgram
 *
 * Example:
 * ```js
 * const program = await Lightrail.programs.updateProgram("abcdefg", {name: "Awesome Gift Cards"});
 * ```
 */
export declare function updateProgram(program: string | Program, params: UpdateProgramParams): Promise<UpdateProgramResponse>;
/**
 * See: https://apidocs.lightrail.com/#operation/DeleteProgram
 *
 * Example:
 * ```js
 * await Lightrail.programs.deleteProgram("abcdefg");
 * ```
 */
export declare function deleteProgram(program: string | Program): Promise<DeleteProgramResponse>;
/**
 * See: https://apidocs.lightrail.com/#operation/CreateIssuance
 *
 * Example:
 * ```js
 * const issuance = await Lightrail.programs.createIssuance("abcdefg", {
 *     id: "hijklmnop",
 *     name: "Some cards",
 *     count: 500,
 *     generateCode: {},
 *     balance: 5000
 * });
 * ```
 */
export declare function createIssuance(program: string | Program, params: CreateIssuanceParams): Promise<CreateIssuanceResponse>;
/**
 * See: https://apidocs.lightrail.com/#operation/ListIssuances
 *
 * Example:
 * ```js
 * const issuances = await Lightrail.programs.listIssuances("abcdefg");
 * const issuancesLimited = await Lightrail.programs.listIssuances("abcdefg", {limit: 5});
 * ```
 */
export declare function listIssuances(program: string | Program, params?: ListIssuancesParams): Promise<ListIssuancesResponse>;
/**
 * See: https://apidocs.lightrail.com/#operation/GetanIssuance
 *
 * Example:
 * ```js
 * const issuance = await Lightrail.programs.getIssuance("abcdefg", "hijklmnop");
 * ```
 */
export declare function getIssuance(program: string | Program, issuance: string | Issuance): Promise<GetIssuanceResponse>;
/**
 * @internal
 * Get programId from the string (as the ID itself) or Program object.
 */
export declare function getProgramId(program: string | Program): string;
/**
 * @internal
 * Get issuanceId from the string (as the ID itself) or Issuance object.
 */
export declare function getIssuanceId(issuance: string | Issuance): string;