lightrail-client/dist/contacts.d.ts

A Javascript and Typescript client for Lightrail

import { AttachContactToValueParams, AttachContactToValueResponse, CreateContactParams, CreateContactResponse, DeleteContactResponse, GetContactResponse, ListContactsParams, ListContactsResponse, ListContactsValuesParams, ListContactsValuesResponse, UpdateContactParams, UpdateContactResponse } from "./params";
import { Contact } from "./model";
import { DetachContactFromValueParams, DetachContactFromValueResponse } from "./params/contacts/DetachContactFromValueParams";
/**
 * See: https://apidocs.lightrail.com/#operation/CreateContact
 *
 * Example:
 * ```js
 * const contact = await Lightrail.contacts.createContact({
 *     id: "abcdefg",
 *     email: "ex@example.com"
 * });
 * ```
 */
export declare function createContact(params: CreateContactParams): Promise<CreateContactResponse>;
/**
 * See: https://apidocs.lightrail.com/#operation/GetaContact
 *
 * Example:
 * ```js
 * const contact = await Lightrail.contacts.getContact("abcdefg");
 * ```
 */
export declare function getContact(contact: string | Contact): Promise<GetContactResponse>;
/**
 * See: https://apidocs.lightrail.com/#operation/ListContacts
 *
 * Example:
 * ```js
 * const contacts = await Lightrail.contacts.listContacts({limit: 5});
 * const contactsLimited = await Lightrail.contacts.listContacts({limit: 5});
 * ```
 */
export declare function listContacts(params?: ListContactsParams): Promise<ListContactsResponse>;
/**
 * See: https://apidocs.lightrail.com/#operation/ListaContactsValues
 *
 * Example:
 * ```js
 * const values = await Lightrail.contacts.listContactsValues("abcdefg");
 * const valuesLimited = await Lightrail.contacts.listContactsValues("abcdefg", {limit: 5});
 * ```
 */
export declare function listContactsValues(contact: string | Contact, params?: ListContactsValuesParams): Promise<ListContactsValuesResponse>;
/**
 * See: https://apidocs.lightrail.com/#operation/UpdateContact
 *
 * Example:
 * ```js
 * const updatedContact = await Lightrail.contacts.updateContact("abcdefg", {email: "new.ex@example.com"});
 * ```
 */
export declare function updateContact(contact: string | Contact, params: UpdateContactParams): Promise<UpdateContactResponse>;
/**
 * See: https://apidocs.lightrail.com/#operation/AttachContactToValue
 *
 * Example:
 * ```js
 * const valueAttachedById = await Lightrail.contacts.attachContactToValue("abcdefg", {valueId: "hijklmnop"});
 * const valueAttachedByCode = await Lightrail.contacts.attachContactToValue("abcdefg", {code: "PROMOCODE"});
 * ```
 */
export declare function attachContactToValue(contact: string | Contact, params: AttachContactToValueParams): Promise<AttachContactToValueResponse>;
/**
 * See: https://apidocs.lightrail.com/#operation/DetachContactFromValue
 *
 * Example:
 * ```js
 * const valueDetached = await Lightrail.contacts.detachContactFromValue("abcdefg", {valueId: "hijklmnop"});
 * ```
 */
export declare function detachContactFromValue(contact: string | Contact, params: DetachContactFromValueParams): Promise<DetachContactFromValueResponse>;
/**
 * See: https://apidocs.lightrail.com/#operation/DeleteContact
 *
 * Example:
 * ```js
 * await Lightrail.contacts.deleteContact("abcdefg"});
 * ```
 */
export declare function deleteContact(contact: string | Contact): Promise<DeleteContactResponse>;
/**
 * @internal
 * Get contactId from the string (as the ID itself) or Contact object.
 */
export declare function getContactId(contact: string | Contact): string;