Methods
static
create(createData) → {Promise.<CompanyModel>}
Create a Company [POST /companies]
Parameters
-
createData
CompanyController.CreateDataThe Company Create Data
Returns
-
Promise.<CompanyModel>
Source
static
delete(id) → {Promise.<boolean>}
Delete a Company [DELETE /companies/{id}]
Parameters
-
id
stringThe Company ID
Returns
-
Promise.<boolean>
Source
static
getAll(queryParametersopt) → {Promise.<Array.<CompanyModel>>}
List all Companies [GET /companies]
Parameters
-
queryParameters
CompanyController.GetAllQueryParameters<optional>
The Optional Query Parameters
Returns
-
Promise.<Array.<CompanyModel>>
Source
static
getOne(id) → {Promise.<CompanyModel>}
Retrieve a Company [GET /companies/{id}]
Parameters
-
id
stringThe Company ID
Returns
-
Promise.<CompanyModel>
Source
static
update(id, updateData) → {Promise.<CompanyModel>}
Update a Company [PATCH /companies/{id}]
Parameters
-
id
stringThe Company ID
-
updateData
CompanyController.UpdateDataThe Company Update Data
Returns
-
Promise.<CompanyModel>
Source
Type Definitions
CreateData
The Create Data for a Company
Type
-
Object
Properties
-
displayName
stringThe Company Display Name
-
legalName
stringThe Company Legal Name
Source
GetAllQueryParameters
The Optional Query Parameters for the getAll Function
Type
-
Object
Properties
-
displayName
string<optional>
The Company Display Name
-
legalName
string<optional>
The Company Legal Name
Source
UpdateData
The Update Data for a Company
Type
-
Object
Properties
-
displayName
string<optional>
The Company Display Name
-
legalName
string<optional>
The Company Legal Name