@open-xchange/soap-client 0.0.10 → 0.0.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-xchange/soap-client",
-  "version": "0.0.10",
+  "version": "0.0.11",
   "description": "SOAP client for OX App Suite",
   "main": "index.js",
   "type": "module",

package/services/common/index.js

@@ -2,10 +2,12 @@ import * as contextService from './context.js'
 import * as userService from './user.js'
 import { getFilestorageId } from './util.js'
 import * as secondaryAccountService from '../secondaryAccount.js'
+import * as sharedAccountService from '../sharedAccount.js'
 
 export {
   contextService,
   userService,
   secondaryAccountService,
+  sharedAccountService,
   getFilestorageId
 }

package/services/sharedAccount.js

@@ -0,0 +1,110 @@
+/**
+ * @copyright Copyright (c) Open-Xchange GmbH, Germany <info@open-xchange.com>
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with OX App Suite. If not, see <https://www.gnu.org/licenses/agpl-3.0.txt>.
+ *
+ * Any use of the work other than as authorized under this license or copyright law is prohibited.
+ */
+
+import { createClientAsync } from '../soap.js'
+
+const OXSharedAccountService = createClientAsync('OXSharedAccountService')
+
+/**
+ * Creates a shared account using the OX Shared Account Service
+ *
+ * @param {Object} context - The context object where the account will be created
+ * @param {Object} sharedAccountData - The data for the shared account to be created
+ * @returns {Promise<Object>} The created shared account object
+ * @throws {Error} If the shared account creation fails
+ */
+export async function create (context, sharedAccountData) {
+  return (await OXSharedAccountService).createAsync({
+    ctx: { id: context.id },
+    sharedAccountData,  // display_name, given_name, imapServer, language, mailenabled, name, sur_name, primaryEmail, email1, smtpServer, timezone, password
+    auth: context.admin
+  })
+}
+
+/**
+ * Add users and groups with specified permissions and capabilities to an existing shared account using the OX Shared Account Service.
+ *
+ * @param {Object} context - The context of the users and groups
+ * @param {Object} sharedAccountContext - The context of the shared account
+ * @param {Object} sharedAccountData - The shared account
+ * @param {Object} mailConfig - The mail configuration (permissionLevel, grantedCapability, deniedCapability)
+ * @param {Object} calendarConfig - The calendar configuration (permissionLevel, grantedCapability, deniedCapability)
+ * @param {Object[]} users - The users to be added to the shared account
+ * @param {Object[]} groups - The groups to be added to the shared account
+ * @returns {Promise<Object>} The shared account object
+ * @throws {Error} If the creation of the shared account permissions fails
+ */
+export async function createSharedAccountPermissions (context, sharedAccountContext, sharedAccountData, mailConfig, calendarConfig, users = [], groups = []) {
+  return (await OXSharedAccountService).createSharedAccountPermissionsAsync({
+    ctx: { id: context.id },
+    groups,
+    users: users.map(user => { return { id: user.userdata.id } }),
+    mailConfig,
+    calendarConfig,
+    sharedAccountCtx: { id: sharedAccountContext.id },
+    sharedAccount: { id: sharedAccountData.id },
+    auth: context.admin
+  })
+}
+
+/**
+ * List all shared accounts in the specified context
+ *
+ * @param {Object} context - The context object whose shared account will be listed
+ * @param {*} pattern - An optional search pattern for the contexts
+ * @returns {Promise<Object[]>} The list of shared account objects
+ */
+export async function list (context, pattern = '*') {
+  return (await OXSharedAccountService).listAsync({
+    ctx: { id: context.id },
+    search_pattern: pattern,
+    auth: context.admin
+  })
+}
+
+/**
+ * Get all data of a specified shared account in the specified context
+ *
+ * @param {*} context - The context where the shared account exists
+ * @param {*} sharedAccountData - The requested shared account
+ * @returns {Promise<Object>} The shared account object
+ */
+export async function getData (context, sharedAccountData) {
+  return (await OXSharedAccountService).getDataAsync({
+    ctx: { id: context.id },
+    sharedAccount: { id: sharedAccountData.id },
+    auth: context.admin
+  })
+}
+
+/**
+ * Remove a specified shared account in the specified context
+ *
+ * @param {*} context - The context object where the account will be removed
+ * @param {*} sharedAccountData - The shared account to be removed
+ * @returns {Promise<void>}
+ */
+export async function remove (context, sharedAccountData) {
+  return (await OXSharedAccountService).deleteAsync({
+    ctx: { id: context.id },
+    sharedAccount: { id: sharedAccountData.id },
+    auth: context.admin
+  })
+}