lightrail-client/dist/values.d.ts

A Javascript and Typescript client for Lightrail

import { ChangeValuesCodeParams, ChangeValuesCodeResponse, CreateValueParams, CreateValueQueryParams, CreateValueResponse, DeleteValueResponse, GetValueParams, GetValueResponse, ListContactsParams, ListContactsResponse, ListTransactionsParams, ListTransactionsResponse, ListValuesParams, ListValuesResponse, UpdateValueParams, UpdateValueResponse } from "./params";
import { Value } from "./model";
import { ContentType } from "./params/ContentType";
/**
 * See: https://apidocs.lightrail.com/#operation/CreateValue
 *
 * Example:
 * ```js
 * const value = await Lightrail.values.createValue({
 *      id: "abcdefg",
 *      currency: "USD",
 *      balance: 500
 *  });
 *  const valueWithGeneratedCode = await Lightrail.values.createValue({
 *      id: "hijklmnop",
 *      currency: "USD",
 *      balance: 500,
 *      generateCode: {}
 *  }, {codeCode: true});
 * ```
 */
export declare function createValue(params: CreateValueParams, queryParams?: CreateValueQueryParams): Promise<CreateValueResponse>;
/**
 * See: https://apidocs.lightrail.com/#operation/ListValues
 *
 * Example:
 * ```js
 * const values = await Lightrail.values.listValues();
 * const valuesLimited = await Lightrail.values.listValues({limit: 5});
 * ```
 */
export declare function listValues(params?: ListValuesParams, contentType?: ContentType): Promise<ListValuesResponse>;
/**
 * See: https://apidocs.lightrail.com/#operation/GetValue
 *
 * Example:
 * ```js
 * const value = await Lightrail.values.getValue("abcdefg");
 * ```
 */
export declare function getValue(value: string | Value, params?: GetValueParams): Promise<GetValueResponse>;
/**
 * See: https://apidocs.lightrail.com/#operation/UpdateValue
 *
 * Example:
 * ```js
 * const updatedValue = await Lightrail.values.updateValue("abcdefg", {frozen: true});
 * ```
 */
export declare function updateValue(value: string | Value, params: UpdateValueParams): Promise<UpdateValueResponse>;
/**
 * See: https://apidocs.lightrail.com/#operation/ChangeValueCode
 *
 * Example:
 * ```js
 * const updatedValue = await Lightrail.values.changeValuesCode("abcdefg", {code: "PROMOCODE"});
 * ```
 */
export declare function changeValuesCode(value: string | Value, params: ChangeValuesCodeParams): Promise<ChangeValuesCodeResponse>;
/**
 * Example:
 * ```js
 * await Lightrail.values.deleteValue("abcdefg");
 * ```
 */
export declare function deleteValue(value: string | Value): Promise<DeleteValueResponse>;
/**
 * See: https://apidocs.lightrail.com/#operation/ListValueTransactions
 *
 * Example:
 * ```js
 * const transactions = await Lightrail.values.listValuesTransactions("abcdefg");
 * ```
 */
export declare function listValuesTransactions(value: string | Value, params?: ListTransactionsParams): Promise<ListTransactionsResponse>;
/**
 * See: https://apidocs.lightrail.com/#operation/ListValueAttachedContacts
 *
 * Example:
 * ```js
 * const contacts = await Lightrail.values.listValuesAttachedContacts("abcdefg");
 * ```
 */
export declare function listValuesAttachedContacts(value: string | Value, params?: ListContactsParams): Promise<ListContactsResponse>;
/**
 * @internal
 * Get contactId from the string (as the ID itself) or Contact object.
 */
export declare function getValueId(value: string | Value): string;