Constructor

# new CustomersService(tokenSource, serviceUrl)

Parameters:

Name	Type	Description
`tokenSource`	`string` \| `function`
`serviceUrl`	`string`

View Source services/CustomersService.class.js, line 43

Example

const customers = sdk.asAdmin().Customers()

const { result } = await customers.Entity.get('person-abc123')
const { result: ou } = await customers.OU.create({ data: { name: 'Engineering' } }, { return: true })

Extends

ScenidCloudService

Namespaces

Entities
Entity
Group
Journal
OU
Person

Methods

# delete(call, bodyopt) → {Promise.<ServiceResponse>}

Sends an authenticated DELETE request.

Parameters:

Name	Type	Attributes	Description
`call`	`string`		Path relative to `serviceUrl`.
`body`	`*`	<optional>	Optional request body, serialised to JSON.

Overrides:

ScenidCloudService#delete

View Source services/ScenidCloudService.class.js, line 152

Returns:

Type: Promise.<ServiceResponse>

# get(call) → {Promise.<ServiceResponse>}

Sends an authenticated GET request.

Parameters:

Name	Type	Description
`call`	`string`	Path relative to `serviceUrl`.

Overrides:

ScenidCloudService#get

View Source services/ScenidCloudService.class.js, line 122

Returns:

Type: Promise.<ServiceResponse>

# async makeRequest(method, call, bodyopt) → {Promise.<ServiceResponse>}

Makes an authenticated HTTP request to the service and returns the parsed response.

Acquires a token, constructs the full endpoint URL, serialises the body as JSON when provided, and parses the JSON response. Throws a typed error on network failure or non-JSON responses.

Parameters:

Name	Type	Attributes	Description
`method`	`string`		HTTP method (`GET`, `POST`, `PUT`, or `DELETE`).
`call`	`string`		Path to call relative to `serviceUrl` (leading `/` optional).
`body`	`*`	<optional>	Request body. Serialised to JSON unless already a string.