Skip to content

Commit

Permalink
Fix organization.invite.create and application.invite.create desc…
Browse files Browse the repository at this point in the history
…riptions incorrectly saying usernames can be used for the `invitee` option

Change-type: patch
  • Loading branch information
myarmolinsky committed Nov 26, 2024
1 parent f87ee9f commit b0f9e23
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -1527,7 +1527,7 @@ This method invites a user by their email to an application.
| --- | --- | --- | --- |
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
| options | <code>Object</code> | | invite creation parameters |
| options.invitee | <code>String</code> | | the email/balena_username of the invitee |
| options.invitee | <code>String</code> | | the email of the invitee |
| [options.roleName] | <code>String</code> | <code>&quot;developer&quot;</code> | the role name to be granted to the invitee |
| [message] | <code>String</code> | <code></code> | the message to send along with the invite |

Expand Down Expand Up @@ -5104,7 +5104,7 @@ This method invites a user by their email to an organization.
| --- | --- | --- | --- |
| handleOrId | <code>String</code> \| <code>Number</code> | | organization handle (string), or id (number) |
| options | <code>Object</code> | | invite creation parameters |
| options.invitee | <code>String</code> | | the email/balena_username of the invitee |
| options.invitee | <code>String</code> | | the email of the invitee |
| [options.roleName] | <code>String</code> | <code>&quot;developer&quot;</code> | the role name to be granted to the invitee |
| [message] | <code>String</code> | <code></code> | the message to send along with the invite |

Expand Down
2 changes: 1 addition & 1 deletion src/models/application-invite.ts
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ const getApplicationInviteModel = function (
*
* @param {String|Number} slugOrUuidOrId - application slug (string), uuid (string) or id (number)
* @param {Object} options - invite creation parameters
* @param {String} options.invitee - the email/balena_username of the invitee
* @param {String} options.invitee - the email of the invitee
* @param {String} [options.roleName="developer"] - the role name to be granted to the invitee
* @param {String} [message=null] - the message to send along with the invite
*
Expand Down
2 changes: 1 addition & 1 deletion src/models/organization-invite.ts
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ const getOrganizationInviteModel = function (
*
* @param {String|Number} handleOrId - organization handle (string), or id (number)
* @param {Object} options - invite creation parameters
* @param {String} options.invitee - the email/balena_username of the invitee
* @param {String} options.invitee - the email of the invitee
* @param {String} [options.roleName="developer"] - the role name to be granted to the invitee
* @param {String} [message=null] - the message to send along with the invite
*
Expand Down

0 comments on commit b0f9e23

Please sign in to comment.