@api-client/core 0.13.0 → 0.13.2

package/data/models/example-generator-api.json

@@ -41722,10 +41722,13 @@
 "@id": "#209"
 },
 {
+"@id": "#191"
+},
+{
 "@id": "#194"
 },
 {
-"@id": "#191"
+"@id": "#203"
 },
 {
 "@id": "#197"
@@ -41734,9 +41737,6 @@
 "@id": "#200"
 },
 {
-"@id": "#203"
-},
-{
 "@id": "#206"
 },
 {
@@ -42470,16 +42470,16 @@
 "@id": "#219"
 },
 {
-"@id": "#219"
+"@id": "#210"
 },
 {
 "@id": "#213"
 },
 {
-"@id": "#210"
+"@id": "#216"
 },
 {
-"@id": "#216"
+"@id": "#219"
 }
 ],
 "doc:root": false,
@@ -43096,7 +43096,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "addressType: 'REGISTERED-OFFICE-ADDRESS'\nstreetName: 'UITBREIDINGSTRAAT'\nhouseNumber: '84'\nhouseNumberAddition: '/1'\npostalCode: '2600'\ncity: 'BERCHEM (ANTWERPEN)'\ncountry: 'Belgium'\ncountryCode: 'BE'\nfullFormatedAddress: \"UITBREIDINGSTRAAT 84 /1, 2600 BERCHEM (ANTWERPEN), BELIUM\"\n",
+"doc:raw": "countryCode: \"BE\"\ngraydonEnterpriseId: 1057155523\nregistrationId: \"0422319093\"\nvatNumber: \"BE0422319093\"\ngraydonCompanyId: \"0422319093\"\nisBranchOffice: false\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43117,7 +43117,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "countryCode: \"BE\"\ngraydonEnterpriseId: 1057155523\nregistrationId: \"0422319093\"\nvatNumber: \"BE0422319093\"\ngraydonCompanyId: \"0422319093\"\nisBranchOffice: false\n",
+"doc:raw": "addressType: 'REGISTERED-OFFICE-ADDRESS'\nstreetName: 'UITBREIDINGSTRAAT'\nhouseNumber: '84'\nhouseNumberAddition: '/1'\npostalCode: '2600'\ncity: 'BERCHEM (ANTWERPEN)'\ncountry: 'Belgium'\ncountryCode: 'BE'\nfullFormatedAddress: \"UITBREIDINGSTRAAT 84 /1, 2600 BERCHEM (ANTWERPEN), BELIUM\"\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43138,7 +43138,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "code: '5'\ndescription: 'Limited company'\n",
+"doc:raw": "class: '3'\ndescription: '150 - 300'\nnumberOfFte: 5500\nnumberOfEmployees: 5232\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43159,7 +43159,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "class: '3'\ndescription: '150 - 300'\nnumberOfFte: 5500\nnumberOfEmployees: 5232\n",
+"doc:raw": "code: 'J'\ndescription: 'Information and communication'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43180,7 +43180,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "code: 'J'\ndescription: 'Information and communication'\n",
+"doc:raw": "code: '5'\ndescription: 'Limited company'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43892,7 +43892,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "-\n  type: 'GENERAL'\n  value: 'info@company.be'\n-\n  type: 'IT_DEPT'\n  value: 'it-service@company.be'\n",
+"doc:raw": "type: 'GENERAL'\ncountryDialCode : '+32'\nareaCode : '22'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)22 000000'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43934,7 +43934,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "type: \"GENERAL\"\nvalue: \"www.company.be\"\n",
+"doc:raw": "-\n  type: 'GENERAL'\n  value: 'info@company.be'\n-\n  type: 'IT_DEPT'\n  value: 'it-service@company.be'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43955,7 +43955,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "type: 'GENERAL'\ncountryDialCode : '+32'\nareaCode : '22'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)22 000000'\n",
+"doc:raw": "type: \"GENERAL\"\nvalue: \"www.company.be\"\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -44416,22 +44416,22 @@
 {
 "@id": "#193/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#193",
-"sourcemaps:value": "[(1,0)-(10,0)]"
+"sourcemaps:value": "[(1,0)-(7,0)]"
 },
 {
 "@id": "#196/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#196",
-"sourcemaps:value": "[(1,0)-(7,0)]"
+"sourcemaps:value": "[(1,0)-(10,0)]"
 },
 {
 "@id": "#199/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#199",
-"sourcemaps:value": "[(1,0)-(3,0)]"
+"sourcemaps:value": "[(1,0)-(5,0)]"
 },
 {
 "@id": "#202/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#202",
-"sourcemaps:value": "[(1,0)-(5,0)]"
+"sourcemaps:value": "[(1,0)-(3,0)]"
 },
 {
 "@id": "#205/source-map/lexical/element_0",
@@ -44776,7 +44776,7 @@
 {
 "@id": "#212/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#212",
-"sourcemaps:value": "[(1,0)-(7,0)]"
+"sourcemaps:value": "[(1,0)-(6,0)]"
 },
 {
 "@id": "#215/source-map/lexical/element_0",
@@ -44786,12 +44786,12 @@
 {
 "@id": "#218/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#218",
-"sourcemaps:value": "[(1,0)-(3,0)]"
+"sourcemaps:value": "[(1,0)-(7,0)]"
 },
 {
 "@id": "#221/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#221",
-"sourcemaps:value": "[(1,0)-(6,0)]"
+"sourcemaps:value": "[(1,0)-(3,0)]"
 },
 {
 "@id": "#338/source-map/synthesized-field/element_1",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@api-client/core",
   "description": "The API Client's core client library. Works in NodeJS and in a ES enabled browser.",
-  "version": "0.13.0",
+  "version": "0.13.2",
   "license": "Apache-2.0",
   "exports": {
     "./browser.js": {

package/src/sdk/HttpWeb.ts

@@ -16,6 +16,9 @@ export class HttpWeb extends Http {
     if (token) {
       requestHeaders.append('Authorization', `Bearer ${token}`)
     }
+    if (!requestHeaders.has('Accept')) {
+      requestHeaders.append('Accept', 'application/json')
+    }
     const init: RequestInit = {
       method,
       headers: requestHeaders.toJSON(),
@@ -53,6 +56,9 @@ export class HttpWeb extends Http {
     if (!requestHeaders.has('Content-Type')) {
       requestHeaders.append('Content-Type', 'application/json')
     }
+    if (!requestHeaders.has('Accept')) {
+      requestHeaders.append('Accept', 'application/json')
+    }
     const init: RequestInit = {
       method,
       headers: requestHeaders.toJSON(),

package/src/sdk/OrganizationsSdk.ts

@@ -401,6 +401,46 @@ export class OrganizationsSdk extends SdkBase {
       return data
     },
 
+    /**
+     * Reads user objects in the organization by their keys.
+     * Note that the API returns only the users that are part of the organization.
+     * If a user is not part of the organization, it will not be ignored. It is up to the caller to handle this case.
+     * @param oid The key of the organization parent organization.
+     * @param eys A list of user keys to read.
+     * @param request Optional request options.
+     * @returns The created user object.
+     */
+    readBatch: async (oid: string, keys: string[], request: SdkOptions = {}): Promise<ContextListResult<IUser>> => {
+      const { token } = request
+      const url = this.sdk.getUrl(RouteBuilder.organizationUserBatch(oid))
+      const body = {
+        ids: keys,
+      }
+      const result = await this.sdk.http.post(url.toString(), {
+        body: JSON.stringify(body),
+        token,
+      })
+      this.inspectCommonStatusCodes(result)
+      const E_PREFIX = 'Unable to read the user batch info. '
+      if (result.status !== 200) {
+        this.logInvalidResponse(result)
+        throw this.createApiError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.body)
+      }
+      if (!result.body) {
+        throw new Exception(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`, { code: 'E_RESPONSE_NO_VALUE', status: result.status })
+      }
+      let data: ContextListResult<IUser>
+      try {
+        data = JSON.parse(result.body)
+      } catch {
+        throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
+      }
+      if (!Array.isArray(data.items)) {
+        throw new Exception(`${E_PREFIX}${E_RESPONSE_UNKNOWN}`, { code: 'E_RESPONSE_UNKNOWN', status: result.status })
+      }
+      return data
+    },
+
     /**
      * Activates a user in the organization.
      * If the user is already active the API will respond with an error.

package/src/sdk/RouteBuilder.ts

@@ -27,10 +27,10 @@ export class RouteBuilder {
   }
 
   /**
-   * @returns The path to the /files/{oid}/batch route.
+   * @returns The path to the /files/{oid}/batch/read-meta route.
    */
   static filesBatch(oid: string): string {
-    return `${RouteBuilder.files(oid)}/batch`
+    return `${RouteBuilder.files(oid)}/batch/read-meta`
   }
 
   /**
@@ -166,6 +166,10 @@ export class RouteBuilder {
     return `${this.organization(oid)}/users`
   }
 
+  static organizationUserBatch(oid: string): string {
+    return `${this.organization(oid)}/batch/read`
+  }
+
   static organizationUser(oid: string, key: string): string {
     return `${this.organization(oid)}/users/${key}`
   }

package/src/sdk/SharedSdk.ts

@@ -8,7 +8,6 @@ import {
 } from './SdkBase.js'
 import { RouteBuilder } from './RouteBuilder.js'
 import { IFile } from '../models/store/File.js'
-import { ListFileKind } from './FilesSdk.js'
 import { ContextListOptions, ContextListResult } from '../events/BaseEvents.js'
 import { Exception } from '../exceptions/exception.js'
 
@@ -22,16 +21,12 @@ export class SharedSdk extends SdkBase {
    */
   async list(
     organization: string,
-    kinds?: ListFileKind[],
     options?: ContextListOptions,
     request: SdkOptions = {}
   ): Promise<ContextListResult<IFile>> {
     const { token } = request
     const url = this.sdk.getUrl(RouteBuilder.shared(organization))
     this.sdk.appendListOptions(url, options)
-    if (Array.isArray(kinds)) {
-      kinds.forEach((k) => url.searchParams.append('kind', k))
-    }
     const result = await this.sdk.http.get(url.toString(), { token })
     this.inspectCommonStatusCodes(result)
     const E_PREFIX = 'Unable to list organizations. '