Home Identifier Source Repository

public class | source

Customer

Extends:

Base → Customer

The Customer resource

Constructor Summary

Public Constructor
public	constructor

Member Summary

Public Members
public get	apiMethods: *

Method Summary

Public Methods
public	search(query: ResourceQuery): RequestPromise Searches for customers

Inherited Summary

From class Base
public get	actions: Actions: * Returns an object that supplies the clear, count and merge actions for this resource
public get	apiMethods: Array<string>: * An array of methods to be exposed via APIProxy
public	clear() Dispatches the clear action for this resource.
public	create(resource: object, options: object): RequestPromise Performs a POST request, sending the resource along as the request body
public	destroy(id: number \| string, options: object): RequestPromise Destroys the resource
public	fetch(query: ResourceQuery): RequestPromise Performs a GET request for the specified query.
public	fetchCount(query: ResourceQuery): RequestPromise Performs a GET request for the resource's count endpoint
public	update(id: number \| string, resource: object, options: object): RequestPromise Updates the given resource
protected	urlFor(query: ResourceQuery, params: ResourceQuery): string

Public Constructors

public constructor source

Override:

Base#constructor

Public Members

public get apiMethods: * source

Override:

Base#apiMethods

Public Methods

public search(query: ResourceQuery): RequestPromise source

Searches for customers

Params:

Name	Type	Attribute	Description
query	ResourceQuery		Query parameters
query.query	string		What to search for (e.g.`Bob country:United States`)
query.order	string	optional	Field and direction (default `last_order_date DESC`)
query.fields	string	optional	Comma-delimeted set of fields to include in results

Return: