envoyuserapi.md

@envoy/envoy-integrations-sdk / EnvoyUserAPI

Class: EnvoyUserAPI

API endpoints for user-scoped tokens. To access Envoy resources, this is the API you'd want.

Hierarchy

• EnvoyAPI

  ↳ EnvoyUserAPI

Table of contents

Constructors

• constructor

Properties

• axios

Methods

• createInvite
• getAgreement
• getAgreementPage
• getCompany
• getEmployee
• getEmployeeByEmail
• getEmployees
• getFlow
• getFlows
• getInvites
• getLocation
• getLocations
• getSignInField
• getSignInFieldPage
• getSignInFields
• me
• partialUpdateInvite
• removeInvite
• updateInvite
• getAuthorizeURL
• loginAsPluginInstaller
• loginAsUserWithCode
• loginAsUserWithPassword

Constructors

constructor

• new EnvoyUserAPI(accessToken)

Parameters

Name	Type
accessToken	string

Inherited from

EnvoyAPI.constructor

Defined in

base/EnvoyAPI.ts:59

Properties

axios

• Readonly axios: AxiosInstance

HTTP Client with Envoy's defaults.

Inherited from

EnvoyAPI.axios

Defined in

base/EnvoyAPI.ts:32

Methods

createInvite

▸ createInvite(invite): Promise<InviteModel>

Requires invites.write scope. May also require invites.attest scope if setting attested: true.

Parameters

Name	Type
invite	InviteCreationModel

Returns

Promise<InviteModel>

Defined in

sdk/EnvoyUserAPI.ts:188

---

getAgreement

▸ getAgreement(id, include?): Promise<AgreementModel>

Requires agreements.read scope.

Parameters

Name	Type
id	string
include?	string

Returns

Promise<AgreementModel>

Defined in

sdk/EnvoyUserAPI.ts:65

---

getAgreementPage

▸ getAgreementPage(id, include?): Promise<AgreementPageModel>

AgreementPageModel

Parameters

Name	Type
id	string
include?	string

Returns

Promise<AgreementPageModel>

Defined in

sdk/EnvoyUserAPI.ts:58

---

getCompany

▸ getCompany(id, include?): Promise<CompanyModel>

Requires companies.read scope.

Parameters

Name	Type
id	string
include?	string

Returns

Promise<CompanyModel>

Defined in

sdk/EnvoyUserAPI.ts:72

---

getEmployee

▸ getEmployee(id, include?): Promise<EmployeeModel>

Requires employees.read scope.

Parameters

Name	Type
id	string
include?	string

Returns

Promise<EmployeeModel>

Defined in

sdk/EnvoyUserAPI.ts:79

---

getEmployeeByEmail

▸ getEmployeeByEmail(email, include?): Promise<EmployeeModel>

Requires employees.read scope.

Parameters

Name	Type
email	string
include?	string

Returns

Promise<EmployeeModel>

Defined in

sdk/EnvoyUserAPI.ts:114

---

getEmployees

▸ getEmployees(params?): Promise<EmployeeModel[]>

Requires employees.read scope.

Parameters

Name	Type
params?	default<EmployeeFilterFields, EmployeeSortFields>

Returns

Promise<EmployeeModel[]>

Defined in

sdk/EnvoyUserAPI.ts:136

---

getFlow

▸ getFlow(id, include?): Promise<FlowModel>

Requires flows.read scope.

Parameters

Name	Type
id	string
include?	string

Returns

Promise<FlowModel>

Defined in

sdk/EnvoyUserAPI.ts:86

---

getFlows

▸ getFlows(params?): Promise<FlowModel[]>

Requires flows.read scope.

Parameters

Name	Type
params?	default<FlowFilterFields, FlowSortFields>

Returns

Promise<FlowModel[]>

Defined in

sdk/EnvoyUserAPI.ts:146

---

getInvites

▸ getInvites(params?): Promise<InviteModel[]>

Requires invites.read scope.

Parameters

Name	Type
params?	default<InviteFilterFields, InviteSortFields>

Returns

Promise<InviteModel[]>

Defined in

sdk/EnvoyUserAPI.ts:172

---

getLocation

▸ getLocation(id, include?): Promise<LocationModel>

Requires locations.read scope.

Parameters

Name	Type
id	string
include?	string

Returns

Promise<LocationModel>

Defined in

sdk/EnvoyUserAPI.ts:93

---

getLocations

▸ getLocations(params?): Promise<LocationModel[]>

Requires locations.read scope.

Parameters

Name	Type
params?	default<LocationFilterFields, LocationSortFields>

Returns

Promise<LocationModel[]>

Defined in

sdk/EnvoyUserAPI.ts:154

---

getSignInField

▸ getSignInField(id, include?): Promise<SignInFieldModel>

Requires sign-in-fields.read scope.

Parameters

Name	Type
id	string
include?	string

Returns

Promise<SignInFieldModel>

Defined in

sdk/EnvoyUserAPI.ts:107

---

getSignInFieldPage

▸ getSignInFieldPage(id, include?): Promise<SignInFieldPageModel>

Requires sign-in-field-pages.read scope.

Parameters

Name	Type
id	string
include?	string

Returns

Promise<SignInFieldPageModel>

Defined in

sdk/EnvoyUserAPI.ts:100

---

getSignInFields

▸ getSignInFields(signInFieldPageId): Promise<SignInFieldModel[]>

Requires sign-in-fields.read scope.

Parameters

Name	Type
signInFieldPageId	string

Returns

Promise<SignInFieldModel[]>

Defined in

sdk/EnvoyUserAPI.ts:164

---

me

▸ me(): Promise<UserModel>

Returns

Promise<UserModel>

Defined in

sdk/EnvoyUserAPI.ts:179

---

partialUpdateInvite

▸ partialUpdateInvite(inviteId, invite): Promise<InviteModel>

Requires invites.write scope.

Parameters

Name	Type
inviteId	string
invite	InviteCreationModel

Returns

Promise<InviteModel>

Defined in

sdk/EnvoyUserAPI.ts:213

---

removeInvite

▸ removeInvite(inviteId): Promise<void>

Requires invites.write scope.

Parameters

Name	Type
inviteId	string

Returns

Promise<void>

Defined in

sdk/EnvoyUserAPI.ts:226

---

updateInvite

▸ updateInvite(inviteId, invite): Promise<InviteModel>

Requires invites.write scope.

Parameters

Name	Type
inviteId	string
invite	InviteCreationModel

Returns

Promise<InviteModel>

Defined in

sdk/EnvoyUserAPI.ts:200

---

getAuthorizeURL

▸ Static getAuthorizeURL(redirectURL, scope, clientId?): string

Builds the authorize URL to redirect a user to initiate the auth code oauth2 flow.

Upon completion, they will be redirected to redirectURL, with a code query param in the url.

Use the loginAsUserWithCode method to exchange that code for an access token.

Parameters

Name	Type
redirectURL	string
scope	string[]
clientId	string

Returns

string

Defined in

sdk/EnvoyUserAPI.ts:240

---

loginAsPluginInstaller

▸ Static loginAsPluginInstaller(installId, clientId?, clientSecret?): Promise<EnvoyMetaAuth>

Gets a user access token using plugin_install as the grant type.

Parameters

Name	Type
installId	string
clientId	string
clientSecret	string

Returns

Promise<EnvoyMetaAuth>

Defined in

sdk/EnvoyUserAPI.ts:306

---

loginAsUserWithCode

▸ Static loginAsUserWithCode(code, scope, clientId?, clientSecret?): Promise<EnvoyMetaAuth>

Gets a user access token using code as the grant type.

Parameters

Name	Type
code	string
scope	string[]
clientId	string
clientSecret	string

Returns

Promise<EnvoyMetaAuth>

Defined in

sdk/EnvoyUserAPI.ts:280

---

loginAsUserWithPassword

▸ Static loginAsUserWithPassword(username, password, scope, clientId?, clientSecret?): Promise<EnvoyMetaAuth>

Gets a user access token using password as the grant type (discouraged - use loginAsUserWithCode below).

Parameters

Name	Type
username	string
password	string
scope	string[]
clientId	string
clientSecret	string

Returns

Promise<EnvoyMetaAuth>

Defined in

sdk/EnvoyUserAPI.ts:252