Skip to content

Commit ba9037f

Browse files
JSRedsJSReds
authored
Merge pull request #1520 from balena-io/add-team-model
Add methods for the team model
2 parents 39a4995 + 8e1e3cb commit ba9037f

File tree

7 files changed

+1096
-0
lines changed

7 files changed

+1096
-0
lines changed

‎DOCUMENTATION.md

+236
Original file line numberDiff line numberDiff line change
@@ -352,6 +352,17 @@ const sdk = fromSharedOptions();
352352
* [.getAll([options])](#balena.models.organization.getAll) ⇒ <code>Promise</code>
353353
* [.get(handleOrId, [options])](#balena.models.organization.get) ⇒ <code>Promise</code>
354354
* [.remove(handleOrId)](#balena.models.organization.remove) ⇒ <code>Promise</code>
355+
* [.team](#balena.models.team) : <code>object</code>
356+
* [.applicationAccess](#balena.models.team.applicationAccess) : <code>object</code>
357+
* [.getAllByTeam(teamId, [options])](#balena.models.team.applicationAccess.getAllByTeam) ⇒ <code>Promise</code>
358+
* [.get(teamApplicationAccessId, [options])](#balena.models.team.applicationAccess.get) ⇒ <code>Promise</code>
359+
* [.update(teamApplicationAccessId, roleName)](#balena.models.team.applicationAccess.update) ⇒ <code>Promise</code>
360+
* [.remove(teamApplicationAccessId)](#balena.models.team.applicationAccess.remove) ⇒ <code>Promise</code>
361+
* [.create(organizationSlugOrId, name)](#balena.models.team.create) ⇒ <code>Promise</code>
362+
* [.getAllByOrganization(organizationSlugOrId, [options])](#balena.models.team.getAllByOrganization) ⇒ <code>Promise</code>
363+
* [.get(teamId, [options])](#balena.models.team.get) ⇒ <code>Promise</code>
364+
* [.rename(teamId, newName)](#balena.models.team.rename) ⇒ <code>Promise</code>
365+
* [.remove(teamId)](#balena.models.team.remove) ⇒ <code>Promise</code>
355366
* [.os](#balena.models.os) : <code>object</code>
356367
* [.getAvailableOsVersions(deviceTypes, [options])](#balena.models.os.getAvailableOsVersions) ⇒ <code>Promise</code>
357368
* [.getAllOsVersions(deviceTypes, [options])](#balena.models.os.getAllOsVersions) ⇒ <code>Promise</code>
@@ -754,6 +765,17 @@ balena.models.device.get(123).catch(function (error) {
754765
* [.getAll([options])](#balena.models.organization.getAll) ⇒ <code>Promise</code>
755766
* [.get(handleOrId, [options])](#balena.models.organization.get) ⇒ <code>Promise</code>
756767
* [.remove(handleOrId)](#balena.models.organization.remove) ⇒ <code>Promise</code>
768+
* [.team](#balena.models.team) : <code>object</code>
769+
* [.applicationAccess](#balena.models.team.applicationAccess) : <code>object</code>
770+
* [.getAllByTeam(teamId, [options])](#balena.models.team.applicationAccess.getAllByTeam) ⇒ <code>Promise</code>
771+
* [.get(teamApplicationAccessId, [options])](#balena.models.team.applicationAccess.get) ⇒ <code>Promise</code>
772+
* [.update(teamApplicationAccessId, roleName)](#balena.models.team.applicationAccess.update) ⇒ <code>Promise</code>
773+
* [.remove(teamApplicationAccessId)](#balena.models.team.applicationAccess.remove) ⇒ <code>Promise</code>
774+
* [.create(organizationSlugOrId, name)](#balena.models.team.create) ⇒ <code>Promise</code>
775+
* [.getAllByOrganization(organizationSlugOrId, [options])](#balena.models.team.getAllByOrganization) ⇒ <code>Promise</code>
776+
* [.get(teamId, [options])](#balena.models.team.get) ⇒ <code>Promise</code>
777+
* [.rename(teamId, newName)](#balena.models.team.rename) ⇒ <code>Promise</code>
778+
* [.remove(teamId)](#balena.models.team.remove) ⇒ <code>Promise</code>
757779
* [.os](#balena.models.os) : <code>object</code>
758780
* [.getAvailableOsVersions(deviceTypes, [options])](#balena.models.os.getAvailableOsVersions) ⇒ <code>Promise</code>
759781
* [.getAllOsVersions(deviceTypes, [options])](#balena.models.os.getAllOsVersions) ⇒ <code>Promise</code>
@@ -5079,6 +5101,220 @@ balena.models.organization.get(123).then(function(organization) {
50795101
```js
50805102
balena.models.organization.remove(123);
50815103
```
5104+
<a name="balena.models.team"></a>
5105+
5106+
#### models.team : <code>object</code>
5107+
**Kind**: static namespace of [<code>models</code>](#balena.models)
5108+
5109+
* [.team](#balena.models.team) : <code>object</code>
5110+
* [.applicationAccess](#balena.models.team.applicationAccess) : <code>object</code>
5111+
* [.getAllByTeam(teamId, [options])](#balena.models.team.applicationAccess.getAllByTeam) ⇒ <code>Promise</code>
5112+
* [.get(teamApplicationAccessId, [options])](#balena.models.team.applicationAccess.get) ⇒ <code>Promise</code>
5113+
* [.update(teamApplicationAccessId, roleName)](#balena.models.team.applicationAccess.update) ⇒ <code>Promise</code>
5114+
* [.remove(teamApplicationAccessId)](#balena.models.team.applicationAccess.remove) ⇒ <code>Promise</code>
5115+
* [.create(organizationSlugOrId, name)](#balena.models.team.create) ⇒ <code>Promise</code>
5116+
* [.getAllByOrganization(organizationSlugOrId, [options])](#balena.models.team.getAllByOrganization) ⇒ <code>Promise</code>
5117+
* [.get(teamId, [options])](#balena.models.team.get) ⇒ <code>Promise</code>
5118+
* [.rename(teamId, newName)](#balena.models.team.rename) ⇒ <code>Promise</code>
5119+
* [.remove(teamId)](#balena.models.team.remove) ⇒ <code>Promise</code>
5120+
5121+
<a name="balena.models.team.applicationAccess"></a>
5122+
5123+
##### team.applicationAccess : <code>object</code>
5124+
**Kind**: static namespace of [<code>team</code>](#balena.models.team)
5125+
5126+
* [.applicationAccess](#balena.models.team.applicationAccess) : <code>object</code>
5127+
* [.getAllByTeam(teamId, [options])](#balena.models.team.applicationAccess.getAllByTeam) ⇒ <code>Promise</code>
5128+
* [.get(teamApplicationAccessId, [options])](#balena.models.team.applicationAccess.get) ⇒ <code>Promise</code>
5129+
* [.update(teamApplicationAccessId, roleName)](#balena.models.team.applicationAccess.update) ⇒ <code>Promise</code>
5130+
* [.remove(teamApplicationAccessId)](#balena.models.team.applicationAccess.remove) ⇒ <code>Promise</code>
5131+
5132+
<a name="balena.models.team.applicationAccess.getAllByTeam"></a>
5133+
5134+
###### applicationAccess.getAllByTeam(teamId, [options]) ⇒ <code>Promise</code>
5135+
This method get all team application access.
5136+
5137+
**Kind**: static method of [<code>applicationAccess</code>](#balena.models.team.applicationAccess)
5138+
**Summary**: Get all team applications access
5139+
**Access**: public
5140+
**Fulfil**: <code>Object[]</code> - team application access
5141+
5142+
| Param | Type | Default | Description |
5143+
| --- | --- | --- | --- |
5144+
| teamId | <code>Number</code> | | Required: the team id. |
5145+
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
5146+
5147+
**Example**
5148+
```js
5149+
balena.models.team.applicationAccess.getAllByTeam(1239948).then(function(teamApplicationAccesses) {
5150+
console.log(teamApplicationAccesses);
5151+
});
5152+
```
5153+
<a name="balena.models.team.applicationAccess.get"></a>
5154+
5155+
###### applicationAccess.get(teamApplicationAccessId, [options]) ⇒ <code>Promise</code>
5156+
This method get specific team application access.
5157+
5158+
**Kind**: static method of [<code>applicationAccess</code>](#balena.models.team.applicationAccess)
5159+
**Summary**: Get team applications access
5160+
**Access**: public
5161+
**Fulfil**: <code>Object</code> - TeamApplicationAccess
5162+
5163+
| Param | Type | Default | Description |
5164+
| --- | --- | --- | --- |
5165+
| teamApplicationAccessId | <code>Number</code> | | Required: the team application access id. |
5166+
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
5167+
5168+
**Example**
5169+
```js
5170+
balena.models.team.applicationAccess.get(1239948).then(function(teamApplicationAccess) {
5171+
console.log(teamApplicationAccess);
5172+
});
5173+
```
5174+
<a name="balena.models.team.applicationAccess.update"></a>
5175+
5176+
###### applicationAccess.update(teamApplicationAccessId, roleName) ⇒ <code>Promise</code>
5177+
This method update a team application access role.
5178+
5179+
**Kind**: static method of [<code>applicationAccess</code>](#balena.models.team.applicationAccess)
5180+
**Summary**: Update team application access
5181+
**Access**: public
5182+
**Fulfil**: <code>Object</code> - TeamApplicationAccess
5183+
5184+
| Param | Type | Description |
5185+
| --- | --- | --- |
5186+
| teamApplicationAccessId | <code>Number</code> | Required: the team application access id. |
5187+
| roleName | <code>String</code> | Required: The new role to assing (ApplicationMembershipRoles). |
5188+
5189+
**Example**
5190+
```js
5191+
balena.models.team.update(123, 'developer').then(function(teamApplicationAccess) {
5192+
console.log(teamApplicationAccess);
5193+
});
5194+
```
5195+
<a name="balena.models.team.applicationAccess.remove"></a>
5196+
5197+
###### applicationAccess.remove(teamApplicationAccessId) ⇒ <code>Promise</code>
5198+
This remove a team application access.
5199+
5200+
**Kind**: static method of [<code>applicationAccess</code>](#balena.models.team.applicationAccess)
5201+
**Summary**: Remove team application access
5202+
**Access**: public
5203+
**Fulfil**: <code>void</code>
5204+
5205+
| Param | Type | Description |
5206+
| --- | --- | --- |
5207+
| teamApplicationAccessId | <code>Number</code> | Required: the team application access id. |
5208+
5209+
**Example**
5210+
```js
5211+
balena.models.team.remove(123).then(function(teams) {
5212+
console.log(teams);
5213+
});
5214+
```
5215+
<a name="balena.models.team.create"></a>
5216+
5217+
##### team.create(organizationSlugOrId, name) ⇒ <code>Promise</code>
5218+
This method creates a new team.
5219+
5220+
**Kind**: static method of [<code>team</code>](#balena.models.team)
5221+
**Summary**: Creates a new Team
5222+
**Access**: public
5223+
**Fulfil**: <code>Object</code> - Team
5224+
5225+
| Param | Type | Description |
5226+
| --- | --- | --- |
5227+
| organizationSlugOrId | <code>Number</code> | Required: the organization slug or id the team will be part of. |
5228+
| name | <code>String</code> | Required: the name of the team that will be created. |
5229+
5230+
**Example**
5231+
```js
5232+
balena.models.team.create(1239948, 'MyTeam').then(function(team) {
5233+
console.log(team);
5234+
});
5235+
```
5236+
**Example**
5237+
```js
5238+
balena.models.team.create('myOrgHandle', 'MyTeam')
5239+
.then(function(team) {
5240+
console.log(team);
5241+
});
5242+
```
5243+
<a name="balena.models.team.getAllByOrganization"></a>
5244+
5245+
##### team.getAllByOrganization(organizationSlugOrId, [options]) ⇒ <code>Promise</code>
5246+
**Kind**: static method of [<code>team</code>](#balena.models.team)
5247+
**Summary**: Get all Teams of a specific Organization
5248+
**Access**: public
5249+
**Fulfil**: <code>Object[]</code> - Teams
5250+
5251+
| Param | Type | Default | Description |
5252+
| --- | --- | --- | --- |
5253+
| organizationSlugOrId | <code>Number</code> | | Required: the organization slug or id the team is part of. |
5254+
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
5255+
5256+
**Example**
5257+
```js
5258+
balena.models.team.getAllByOrganization(123).then(function(teams) {
5259+
console.log(teams);
5260+
});
5261+
```
5262+
**Example**
5263+
```js
5264+
balena.models.team.getAllByOrganization('MyOrganizationHandle').then(function(teams) {
5265+
console.log(teams);
5266+
});
5267+
```
5268+
<a name="balena.models.team.get"></a>
5269+
5270+
##### team.get(teamId, [options]) ⇒ <code>Promise</code>
5271+
**Kind**: static method of [<code>team</code>](#balena.models.team)
5272+
**Summary**: Get a single Team
5273+
**Access**: public
5274+
**Fulfil**: <code>Object</code> - Team
5275+
5276+
| Param | Type | Default | Description |
5277+
| --- | --- | --- | --- |
5278+
| teamId | <code>Number</code> | | team id (number). |
5279+
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
5280+
5281+
**Example**
5282+
```js
5283+
balena.models.team.get(123).then(function(team) {
5284+
console.log(team);
5285+
});
5286+
```
5287+
<a name="balena.models.team.rename"></a>
5288+
5289+
##### team.rename(teamId, newName) ⇒ <code>Promise</code>
5290+
**Kind**: static method of [<code>team</code>](#balena.models.team)
5291+
**Summary**: Rename Team
5292+
**Access**: public
5293+
5294+
| Param | Type | Description |
5295+
| --- | --- | --- |
5296+
| teamId | <code>Number</code> | team id (number) |
5297+
| newName | <code>String</code> | new team name (string) |
5298+
5299+
**Example**
5300+
```js
5301+
balena.models.team.rename(123, 'MyNewTeamName');
5302+
```
5303+
<a name="balena.models.team.remove"></a>
5304+
5305+
##### team.remove(teamId) ⇒ <code>Promise</code>
5306+
**Kind**: static method of [<code>team</code>](#balena.models.team)
5307+
**Summary**: Remove a Team
5308+
**Access**: public
5309+
5310+
| Param | Type | Description |
5311+
| --- | --- | --- |
5312+
| teamId | <code>Number</code> | team id (number). |
5313+
5314+
**Example**
5315+
```js
5316+
balena.models.team.remove(123);
5317+
```
50825318
<a name="balena.models.os"></a>
50835319

50845320
#### models.os : <code>object</code>

‎src/models/index.ts

+6
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,12 @@ const modelsTemplate = {
5757
organization: () =>
5858
(require('./organization') as typeof import('./organization')).default,
5959

60+
/**
61+
* @namespace team
62+
* @memberof balena.models
63+
*/
64+
team: () => (require('./team') as typeof import('./team')).default,
65+
6066
/**
6167
* @namespace os
6268
* @memberof balena.models

0 commit comments

Comments
 (0)