shipstation-node
Version:
Unofficial Node.js wrapper for the ShipStation API
26 lines (25 loc) • 1.08 kB
TypeScript
import type ShipStation from '../../BaseAPI';
import { BaseResource } from '../../BaseResource';
import type { CustomerResponseItem, ListCustomersOptions, ListCustomersResponse } from '../types';
export declare class Customers extends BaseResource {
constructor(shipstation: ShipStation);
/**
* [Official Documentation](https://www.shipstation.com/docs/api/customers/get-customer/)
*
* To find a specific customerId, make an API Call to
* [list customers](https://www.shipstation.com/docs/api/customers/list/) associated with your account.
*
* @param customerId The system-generated identifier for the Customer.
*
* @returns The details of the customer.
*/
get(customerId: number): Promise<CustomerResponseItem>;
/**
* [Official Documentation](https://www.shipstation.com/docs/api/customers/list/)
*
* Obtains a list of customers that match the specified criteria.
*
* @returns A list of tags for the account.
*/
list(params: ListCustomersOptions): Promise<ListCustomersResponse>;
}