diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md
index 8b5129f4a..d0d39677f 100644
--- a/DOCUMENTATION.md
+++ b/DOCUMENTATION.md
@@ -340,7 +340,6 @@ const sdk = fromSharedOptions();
* [.get(membershipId, [options])](#balena.models.organization.membership.get) ⇒ Promise
* [.getAllByOrganization(handleOrId, [options])](#balena.models.organization.membership.getAllByOrganization) ⇒ Promise
* [.getAllByUser(usernameOrId, [options])](#balena.models.organization.membership.getAllByUser) ⇒ Promise
- * ~~[.create(options)](#balena.models.organization.membership.create) ⇒ Promise~~
* [.changeRole(idOrUniqueKey, roleName)](#balena.models.organization.membership.changeRole) ⇒ Promise
* [.remove(id)](#balena.models.organization.membership.remove) ⇒ Promise
* [.invite](#balena.models.organization.invite) : object
@@ -743,7 +742,6 @@ balena.models.device.get(123).catch(function (error) {
* [.get(membershipId, [options])](#balena.models.organization.membership.get) ⇒ Promise
* [.getAllByOrganization(handleOrId, [options])](#balena.models.organization.membership.getAllByOrganization) ⇒ Promise
* [.getAllByUser(usernameOrId, [options])](#balena.models.organization.membership.getAllByUser) ⇒ Promise
- * ~~[.create(options)](#balena.models.organization.membership.create) ⇒ Promise~~
* [.changeRole(idOrUniqueKey, roleName)](#balena.models.organization.membership.changeRole) ⇒ Promise
* [.remove(id)](#balena.models.organization.membership.remove) ⇒ Promise
* [.invite](#balena.models.organization.invite) : object
@@ -4706,7 +4704,6 @@ balena.models.key.create('Main', 'ssh-rsa AAAAB....').then(function(key) {
* [.get(membershipId, [options])](#balena.models.organization.membership.get) ⇒ Promise
* [.getAllByOrganization(handleOrId, [options])](#balena.models.organization.membership.getAllByOrganization) ⇒ Promise
* [.getAllByUser(usernameOrId, [options])](#balena.models.organization.membership.getAllByUser) ⇒ Promise
- * ~~[.create(options)](#balena.models.organization.membership.create) ⇒ Promise~~
* [.changeRole(idOrUniqueKey, roleName)](#balena.models.organization.membership.changeRole) ⇒ Promise
* [.remove(id)](#balena.models.organization.membership.remove) ⇒ Promise
* [.invite](#balena.models.organization.invite) : object
@@ -4729,7 +4726,6 @@ balena.models.key.create('Main', 'ssh-rsa AAAAB....').then(function(key) {
* [.get(membershipId, [options])](#balena.models.organization.membership.get) ⇒ Promise
* [.getAllByOrganization(handleOrId, [options])](#balena.models.organization.membership.getAllByOrganization) ⇒ Promise
* [.getAllByUser(usernameOrId, [options])](#balena.models.organization.membership.getAllByUser) ⇒ Promise
- * ~~[.create(options)](#balena.models.organization.membership.create) ⇒ Promise~~
* [.changeRole(idOrUniqueKey, roleName)](#balena.models.organization.membership.changeRole) ⇒ Promise
* [.remove(id)](#balena.models.organization.membership.remove) ⇒ Promise
@@ -4808,32 +4804,6 @@ balena.models.organization.membership.getAllByUser(123).then(function(membership
console.log(memberships);
});
```
-
-
-###### ~~membership.create(options) ⇒ Promise~~
-***use balena.models.organization.invite.create instead***
-
-This method adds a user to an organization by their usename.
-WARNING: This method is deprecated, use balena.models.organization.invite.create instead.
-
-**Kind**: static method of [membership](#balena.models.organization.membership)
-**Summary**: Creates a new membership for an organization
-**Access**: public
-**Fulfil**: Object - organization membership
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| options | Object | | membership creation parameters |
-| options.organization | String \| Number | | organization handle (string), or id (number) |
-| options.username | String | | the username of the balena user that will become a member |
-| [options.roleName] | String | "member" | the role name to be granted to the membership |
-
-**Example**
-```js
-balena.models.organization.membership.create({ organization: "myorg", username: "user123", roleName: "member" }).then(function(membership) {
- console.log(membership);
-});
-```
###### membership.changeRole(idOrUniqueKey, roleName) ⇒ Promise
diff --git a/src/models/organization-membership.ts b/src/models/organization-membership.ts
index aa9267f30..c588a3dac 100644
--- a/src/models/organization-membership.ts
+++ b/src/models/organization-membership.ts
@@ -22,9 +22,7 @@ import type {
OrganizationMembershipRoles,
OrganizationMembershipTag,
PineOptions,
- PineSubmitBody,
InjectedDependenciesParam,
- PinePostResult,
} from '..';
import { mergePineOptions } from '../util';
@@ -241,58 +239,6 @@ const getOrganizationMembershipModel = function (
});
},
- /**
- * @summary Creates a new membership for an organization
- * @name create
- * @public
- * @function
- * @memberof balena.models.organization.membership
- *
- * @deprecated use balena.models.organization.invite.create instead
- * @description This method adds a user to an organization by their usename.
- * WARNING: This method is deprecated, use balena.models.organization.invite.create instead.
- *
- * @param {Object} options - membership creation parameters
- * @param {String|Number} options.organization - organization handle (string), or id (number)
- * @param {String} options.username - the username of the balena user that will become a member
- * @param {String} [options.roleName="member"] - the role name to be granted to the membership
- *
- * @fulfil {Object} - organization membership
- * @returns {Promise}
- *
- * @example
- * balena.models.organization.membership.create({ organization: "myorg", username: "user123", roleName: "member" }).then(function(membership) {
- * console.log(membership);
- * });
- */
- async create({
- organization,
- username,
- roleName,
- }: OrganizationMembershipCreationOptions): Promise<
- PinePostResult
- > {
- const [{ id }, roleId] = await Promise.all([
- getOrganization(organization, { $select: 'id' }),
- roleName ? getRoleId(roleName) : undefined,
- ]);
- type OrganizationMembershipBase = Omit;
- type OrganizationMembershipPostBody = OrganizationMembershipBase & {
- username: string;
- };
- const body: PineSubmitBody = {
- username,
- is_member_of__organization: id,
- };
- if (roleName) {
- body.organization_membership_role = roleId;
- }
- return (await pine.post({
- resource: RESOURCE,
- body,
- })) as PinePostResult;
- },
-
/**
* @summary Changes the role of an organization member
* @name changeRole
diff --git a/tests/integration/models/organization-membership.spec.ts b/tests/integration/models/organization-membership.spec.ts
index 9557985e2..5525af814 100644
--- a/tests/integration/models/organization-membership.spec.ts
+++ b/tests/integration/models/organization-membership.spec.ts
@@ -7,7 +7,6 @@ import {
credentials,
givenInitialOrganization,
givenLoggedInUser,
- organizationRetrievalFields,
TEST_ORGANIZATION_NAME,
} from '../setup';
import type * as BalenaSdk from '../../..';
@@ -180,105 +179,11 @@ describe('Organization Membership Model', function () {
});
});
- describe('balena.models.organization.membership.create()', function () {
- before(function () {
- ctx = this;
- });
-
- parallel('[read operations]', function () {
- it(`should not be able to add a new member to the organization usign a wrong role name`, async function () {
- const promise = balena.models.organization.membership.create({
- organization: ctx.organization.id,
- username: credentials.member.username,
- // @ts-expect-error invalid value
- roleName: 'unknown role',
- });
- await expect(promise).to.be.rejected.and.eventually.have.property(
- 'code',
- 'BalenaOrganizationMembershipRoleNotFound',
- );
- });
-
- const randomOrdInfo = {
- id: Math.floor(Date.now() / 1000),
- handle: `random_sdk_test_org_handle_${Math.floor(Date.now() / 1000)}`,
- };
-
- organizationRetrievalFields.forEach((field) => {
- it(`should not be able to add a new member when using an not existing organization ${field}`, async function () {
- const promise = balena.models.organization.membership.create({
- organization: randomOrdInfo[field],
- username: credentials.member.username,
- roleName: 'member',
- });
- await expect(promise).to.be.rejected.and.eventually.have.property(
- 'code',
- 'BalenaOrganizationNotFound',
- );
- });
- });
- });
-
- describe('[mutating operations]', function () {
- let membership:
- | BalenaSdk.PinePostResult
- | undefined;
- afterEach(async function () {
- await balena.models.organization.membership.remove(membership!.id);
- });
- organizationRetrievalFields.forEach(function (field) {
- it(`should be able to add a new member to the organization by ${field}`, async function () {
- membership = await balena.models.organization.membership.create({
- organization: this.organization[field],
- username: credentials.member.username,
- });
-
- expect(membership)
- .to.be.an('object')
- .that.has.nested.property('organization_membership_role.__id')
- .that.equals(this.orgMemberRole.id);
- });
- });
-
- it(`should be able to add a new member to the organization without providing a role`, async function () {
- membership = await balena.models.organization.membership.create({
- organization: this.organization.id,
- username: credentials.member.username,
- });
-
- expect(membership)
- .to.be.an('object')
- .that.has.nested.property('organization_membership_role.__id')
- .that.equals(this.orgMemberRole.id);
- });
-
- (['member', 'administrator'] as const).forEach(function (roleName) {
- it(`should be able to add a new member to the organization with a given role [${roleName}]`, async function () {
- membership = await balena.models.organization.membership.create({
- organization: this.organization.id,
- username: credentials.member.username,
- roleName,
- });
-
- expect(membership)
- .to.be.an('object')
- .that.has.nested.property('organization_membership_role.__id')
- .that.equals(this.orgRoleMap[roleName].id);
- });
- });
- });
- });
-
- describe('given a member organization membership [contained scenario]', function () {
+ // TODO: re-add this test in the future, we need to add a second user that is a member of the organization from the start
+ describe.skip('given a member organization membership [contained scenario]', function () {
let membership:
| BalenaSdk.PinePostResult
| undefined;
- beforeEach(async function () {
- membership = await balena.models.organization.membership.create({
- organization: this.organization.id,
- username: credentials.member.username,
- });
- });
describe('balena.models.organization.membership.remove()', function () {
keyAlternatives.forEach(([title, keyGetter]) => {
@@ -297,7 +202,8 @@ describe('Organization Membership Model', function () {
});
});
- describe('given an organization with an administrator organization membership [contained scenario]', function () {
+ // TODO: re-add this test in the future, we need to add a second user that is a member of the organization from the start
+ describe.skip('given an organization with an administrator organization membership [contained scenario]', function () {
const testOrg1Name = `${TEST_ORGANIZATION_NAME}_org_member_tests_${Date.now()}`;
let testOrg: BalenaSdk.PinePostResult | undefined;
let membership:
@@ -308,11 +214,6 @@ describe('Organization Membership Model', function () {
testOrg = await balena.models.organization.create({
name: testOrg1Name,
});
- membership = await balena.models.organization.membership.create({
- organization: testOrg.id,
- username: credentials.member.username,
- roleName: 'administrator',
- });
});
after(async function () {
diff --git a/tests/integration/models/organizationInvite.spec.ts b/tests/integration/models/organizationInvite.spec.ts
index 331c3d3aa..62fbe50b0 100644
--- a/tests/integration/models/organizationInvite.spec.ts
+++ b/tests/integration/models/organizationInvite.spec.ts
@@ -1,8 +1,14 @@
import { expect } from 'chai';
import parallel from 'mocha.parallel';
-import { balena, givenInitialOrganization, givenLoggedInUser } from '../setup';
-import { timeSuite } from '../../util';
-import { assertDeepMatchAndLength } from '../../util';
+import {
+ balena,
+ givenInitialOrganization,
+ givenLoggedInUser,
+ credentials,
+ organizationRetrievalFields,
+} from '../setup';
+import { timeSuite, assertDeepMatchAndLength } from '../../util';
+import type * as BalenaSdk from '../../..';
const TEST_EMAIL = 'user.test@example.org';
const TEST_MESSAGE = 'Hey!, Join my org on balenaCloud';
const TEST_ROLE = 'member';
@@ -119,6 +125,84 @@ describe('Organization Invite Model', function () {
});
});
});
+
+ parallel('[read operations]', function () {
+ const randomOrdInfo = {
+ id: Math.floor(Date.now() / 1000),
+ handle: `random_sdk_test_org_handle_${Math.floor(Date.now() / 1000)}`,
+ };
+
+ organizationRetrievalFields.forEach((field) => {
+ it(`should not be able to invite a new member when using an not existing organization ${field}`, async function () {
+ const promise = balena.models.organization.invite.create(
+ randomOrdInfo[field],
+ {
+ invitee: credentials.member.email,
+ roleName: 'member',
+ },
+ );
+ await expect(promise).to.be.rejected.and.eventually.have.property(
+ 'code',
+ 'BalenaOrganizationNotFound',
+ );
+ });
+ });
+ });
+
+ describe('[mutating operations]', function () {
+ let membership:
+ | BalenaSdk.PinePostResult
+ | undefined;
+ afterEach(async function () {
+ await balena.models.organization.membership.remove(membership!.id);
+ });
+ organizationRetrievalFields.forEach(function (field) {
+ it(`should be able to invite a new member to the organization by ${field}`, async function () {
+ membership = await balena.models.organization.invite.create(
+ this.organization[field],
+ {
+ invitee: credentials.member.email,
+ },
+ );
+
+ expect(membership)
+ .to.be.an('object')
+ .that.has.nested.property('organization_membership_role.__id')
+ .that.equals(this.orgMemberRole.id);
+ });
+ });
+
+ it(`should be able to invite a new member to the organization without providing a role`, async function () {
+ membership = await balena.models.organization.invite.create(
+ this.organization.id,
+ {
+ invitee: credentials.member.email,
+ },
+ );
+
+ expect(membership)
+ .to.be.an('object')
+ .that.has.nested.property('organization_membership_role.__id')
+ .that.equals(this.orgMemberRole.id);
+ });
+
+ (['member', 'administrator'] as const).forEach(function (roleName) {
+ it(`should be able to invite a new member to the organization with a given role [${roleName}]`, async function () {
+ membership = await balena.models.organization.invite.create(
+ this.organization.id,
+ {
+ invitee: credentials.member.email,
+ roleName,
+ },
+ );
+
+ expect(membership)
+ .to.be.an('object')
+ .that.has.nested.property('organization_membership_role.__id')
+ .that.equals(this.orgRoleMap[roleName].id);
+ });
+ });
+ });
});
describe('given a single organization invite [contained scenario]', function () {