ClientsApi
Defined in: packages/sdk/src/resources/ClientsApi.ts:6
Read-only browse of the agency’s client roster + their owned websites.
Extends
Section titled “Extends”Resource
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ClientsApi(
opts):ClientsApi
Defined in: packages/sdk/src/request.ts:93
Parameters
Section titled “Parameters”Returns
Section titled “Returns”ClientsApi
Inherited from
Section titled “Inherited from”Resource.constructor
Methods
Section titled “Methods”get(
clientId):Promise<Client>
Defined in: packages/sdk/src/resources/ClientsApi.ts:12
Fetch one client by id.
Parameters
Section titled “Parameters”clientId
Section titled “clientId”string
Returns
Section titled “Returns”Promise<Client>
list()
Section titled “list()”list():
Promise<{clients:Client[]; }>
Defined in: packages/sdk/src/resources/ClientsApi.ts:8
List every client account (admin only).
Returns
Section titled “Returns”Promise<{ clients: Client[]; }>
websites()
Section titled “websites()”websites(
clientId):Promise<{websites:Website[]; }>
Defined in: packages/sdk/src/resources/ClientsApi.ts:16
List websites owned by a given client.
Parameters
Section titled “Parameters”clientId
Section titled “clientId”string
Returns
Section titled “Returns”Promise<{ websites: Website[]; }>