From b0f9e23dc9ff99a6d5d5c7a231a6d871e6d78413 Mon Sep 17 00:00:00 2001 From: myarmolinsky Date: Tue, 26 Nov 2024 14:27:33 -0500 Subject: [PATCH] Fix `organization.invite.create` and `application.invite.create` descriptions incorrectly saying usernames can be used for the `invitee` option Change-type: patch --- DOCUMENTATION.md | 4 ++-- src/models/application-invite.ts | 2 +- src/models/organization-invite.ts | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index 639ff002f..679dcac39 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -1527,7 +1527,7 @@ This method invites a user by their email to an application. | --- | --- | --- | --- | | slugOrUuidOrId | String \| Number | | application slug (string), uuid (string) or id (number) | | options | Object | | invite creation parameters | -| options.invitee | String | | the email/balena_username of the invitee | +| options.invitee | String | | the email of the invitee | | [options.roleName] | String | "developer" | the role name to be granted to the invitee | | [message] | String | | the message to send along with the invite | @@ -5104,7 +5104,7 @@ This method invites a user by their email to an organization. | --- | --- | --- | --- | | handleOrId | String \| Number | | organization handle (string), or id (number) | | options | Object | | invite creation parameters | -| options.invitee | String | | the email/balena_username of the invitee | +| options.invitee | String | | the email of the invitee | | [options.roleName] | String | "developer" | the role name to be granted to the invitee | | [message] | String | | the message to send along with the invite | diff --git a/src/models/application-invite.ts b/src/models/application-invite.ts index 0ef05e87e..ab97b0098 100644 --- a/src/models/application-invite.ts +++ b/src/models/application-invite.ts @@ -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 * diff --git a/src/models/organization-invite.ts b/src/models/organization-invite.ts index 7debb6b5b..c8d7a7e6d 100644 --- a/src/models/organization-invite.ts +++ b/src/models/organization-invite.ts @@ -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 *