dalux-build-api 1.0.0 → 1.0.1

package/src/api/FileUploadApi.js

@@ -1,64 +1,64 @@
-'use strict';
-
-/**
- * API methods for chunked file uploads.
- */
-class FileUploadApi {
-  /**
-   * @param {import('../apiClient')} apiClient
-   */
-  constructor(apiClient) {
-    this._client = apiClient;
-  }
-
-  /**
-   * Create a new upload slot and return a GUID pointing to that slot.
-   * POST /1.0/projects/{projectId}/file_areas/{fileAreaId}/upload
-   * @param {string} projectId
-   * @param {string} fileAreaId
-   * @param {object} body
-   * @returns {Promise<object>}
-   */
-  createUpload(projectId, fileAreaId, body) {
-    return this._client.post(
-      `/1.0/projects/${projectId}/file_areas/${fileAreaId}/upload`,
-      body,
-    );
-  }
-
-  /**
-   * Upload a part of a file.
-   * POST /1.0/projects/{projectId}/file_areas/{fileAreaId}/upload/{uploadGuid}
-   * @param {string} projectId
-   * @param {string} fileAreaId
-   * @param {string} uploadGuid
-   * @param {Buffer|Uint8Array} chunk - Binary file chunk
-   * @returns {Promise<object>}
-   */
-  uploadFilePart(projectId, fileAreaId, uploadGuid, chunk) {
-    return this._client.post(
-      `/1.0/projects/${projectId}/file_areas/${fileAreaId}/upload/${uploadGuid}`,
-      chunk,
-      {},
-      { headers: { 'Content-Type': 'application/octet-stream' } },
-    );
-  }
-
-  /**
-   * Finish uploading a file (finalize the upload).
-   * POST /2.0/projects/{projectId}/file_areas/{fileAreaId}/upload/{uploadGuid}/finalize
-   * @param {string} projectId
-   * @param {string} fileAreaId
-   * @param {string} uploadGuid
-   * @param {object} body
-   * @returns {Promise<object>}
-   */
-  finishUpload(projectId, fileAreaId, uploadGuid, body) {
-    return this._client.post(
-      `/2.0/projects/${projectId}/file_areas/${fileAreaId}/upload/${uploadGuid}/finalize`,
-      body,
-    );
-  }
-}
-
-module.exports = FileUploadApi;
+'use strict';
+
+/**
+ * API methods for chunked file uploads.
+ */
+class FileUploadApi {
+  /**
+   * @param {import('../apiClient')} apiClient
+   */
+  constructor(apiClient) {
+    this._client = apiClient;
+  }
+
+  /**
+   * Create a new upload slot and return a GUID pointing to that slot.
+   * POST /1.0/projects/{projectId}/file_areas/{fileAreaId}/upload
+   * @param {string} projectId
+   * @param {string} fileAreaId
+   * @param {object} body
+   * @returns {Promise<object>}
+   */
+  createUpload(projectId, fileAreaId, body) {
+    return this._client.post(
+      `/1.0/projects/${projectId}/file_areas/${fileAreaId}/upload`,
+      body,
+    );
+  }
+
+  /**
+   * Upload a part of a file.
+   * POST /1.0/projects/{projectId}/file_areas/{fileAreaId}/upload/{uploadGuid}
+   * @param {string} projectId
+   * @param {string} fileAreaId
+   * @param {string} uploadGuid
+   * @param {Buffer|Uint8Array} chunk - Binary file chunk
+   * @returns {Promise<object>}
+   */
+  uploadFilePart(projectId, fileAreaId, uploadGuid, chunk) {
+    return this._client.post(
+      `/1.0/projects/${projectId}/file_areas/${fileAreaId}/upload/${uploadGuid}`,
+      chunk,
+      {},
+      { headers: { 'Content-Type': 'application/octet-stream' } },
+    );
+  }
+
+  /**
+   * Finish uploading a file (finalize the upload).
+   * POST /2.0/projects/{projectId}/file_areas/{fileAreaId}/upload/{uploadGuid}/finalize
+   * @param {string} projectId
+   * @param {string} fileAreaId
+   * @param {string} uploadGuid
+   * @param {object} body
+   * @returns {Promise<object>}
+   */
+  finishUpload(projectId, fileAreaId, uploadGuid, body) {
+    return this._client.post(
+      `/2.0/projects/${projectId}/file_areas/${fileAreaId}/upload/${uploadGuid}/finalize`,
+      body,
+    );
+  }
+}
+
+module.exports = FileUploadApi;

package/src/api/FilesApi.js

@@ -1,72 +1,72 @@
-'use strict';
-
-/**
- * API methods for files within a file area.
- */
-class FilesApi {
-  /**
-   * @param {import('../apiClient')} apiClient
-   */
-  constructor(apiClient) {
-    this._client = apiClient;
-  }
-
-  /**
-   * Browse all files on the given project and file area.
-   * GET /6.0/projects/{projectId}/file_areas/{fileAreaId}/files
-   * @param {string} projectId
-   * @param {string} fileAreaId
-   * @param {object} [params] - Optional filters (e.g. folderId, updatedAfter)
-   * @returns {Promise<object>}
-   */
-  listFiles(projectId, fileAreaId, params = {}) {
-    return this._client.get(
-      `/6.0/projects/${projectId}/file_areas/${fileAreaId}/files`,
-      params,
-    );
-  }
-
-  /**
-   * Retrieve a specific file.
-   * GET /5.0/projects/{projectId}/file_areas/{fileAreaId}/files/{fileId}
-   * @param {string} projectId
-   * @param {string} fileAreaId
-   * @param {string} fileId
-   * @returns {Promise<object>}
-   */
-  getFile(projectId, fileAreaId, fileId) {
-    return this._client.get(
-      `/5.0/projects/${projectId}/file_areas/${fileAreaId}/files/${fileId}`,
-    );
-  }
-
-  /**
-   * Retrieve properties mapping for a specific file.
-   * GET /1.0/projects/{projectId}/file_areas/{fileAreaId}/files/{fileId}/properties/1.0/mappings
-   * @param {string} projectId
-   * @param {string} fileAreaId
-   * @param {string} fileId
-   * @returns {Promise<object>}
-   */
-  getFilePropertiesMapping(projectId, fileAreaId, fileId) {
-    return this._client.get(
-      `/1.0/projects/${projectId}/file_areas/${fileAreaId}/files/${fileId}/properties/1.0/mappings`,
-    );
-  }
-
-  /**
-   * Retrieve valid property values for a specific file property mapping.
-   * GET /1.0/projects/{projectId}/file_areas/{fileAreaId}/files/properties/1.0/mappings/{filePropertyId}/values
-   * @param {string} projectId
-   * @param {string} fileAreaId
-   * @param {string} filePropertyId
-   * @returns {Promise<object>}
-   */
-  getFilePropertyMappingValues(projectId, fileAreaId, filePropertyId) {
-    return this._client.get(
-      `/1.0/projects/${projectId}/file_areas/${fileAreaId}/files/properties/1.0/mappings/${filePropertyId}/values`,
-    );
-  }
-}
-
-module.exports = FilesApi;
+'use strict';
+
+/**
+ * API methods for files within a file area.
+ */
+class FilesApi {
+  /**
+   * @param {import('../apiClient')} apiClient
+   */
+  constructor(apiClient) {
+    this._client = apiClient;
+  }
+
+  /**
+   * Browse all files on the given project and file area.
+   * GET /6.0/projects/{projectId}/file_areas/{fileAreaId}/files
+   * @param {string} projectId
+   * @param {string} fileAreaId
+   * @param {object} [params] - Optional filters (e.g. folderId, updatedAfter)
+   * @returns {Promise<object>}
+   */
+  listFiles(projectId, fileAreaId, params = {}) {
+    return this._client.get(
+      `/6.0/projects/${projectId}/file_areas/${fileAreaId}/files`,
+      params,
+    );
+  }
+
+  /**
+   * Retrieve a specific file.
+   * GET /5.0/projects/{projectId}/file_areas/{fileAreaId}/files/{fileId}
+   * @param {string} projectId
+   * @param {string} fileAreaId
+   * @param {string} fileId
+   * @returns {Promise<object>}
+   */
+  getFile(projectId, fileAreaId, fileId) {
+    return this._client.get(
+      `/5.0/projects/${projectId}/file_areas/${fileAreaId}/files/${fileId}`,
+    );
+  }
+
+  /**
+   * Retrieve properties mapping for a specific file.
+   * GET /1.0/projects/{projectId}/file_areas/{fileAreaId}/files/{fileId}/properties/1.0/mappings
+   * @param {string} projectId
+   * @param {string} fileAreaId
+   * @param {string} fileId
+   * @returns {Promise<object>}
+   */
+  getFilePropertiesMapping(projectId, fileAreaId, fileId) {
+    return this._client.get(
+      `/1.0/projects/${projectId}/file_areas/${fileAreaId}/files/${fileId}/properties/1.0/mappings`,
+    );
+  }
+
+  /**
+   * Retrieve valid property values for a specific file property mapping.
+   * GET /1.0/projects/{projectId}/file_areas/{fileAreaId}/files/properties/1.0/mappings/{filePropertyId}/values
+   * @param {string} projectId
+   * @param {string} fileAreaId
+   * @param {string} filePropertyId
+   * @returns {Promise<object>}
+   */
+  getFilePropertyMappingValues(projectId, fileAreaId, filePropertyId) {
+    return this._client.get(
+      `/1.0/projects/${projectId}/file_areas/${fileAreaId}/files/properties/1.0/mappings/${filePropertyId}/values`,
+    );
+  }
+}
+
+module.exports = FilesApi;

package/src/api/FoldersApi.js

@@ -1,58 +1,58 @@
-'use strict';
-
-/**
- * API methods for folders within a file area.
- */
-class FoldersApi {
-  /**
-   * @param {import('../apiClient')} apiClient
-   */
-  constructor(apiClient) {
-    this._client = apiClient;
-  }
-
-  /**
-   * Browse all folders on the given project and file area.
-   * GET /5.1/projects/{projectId}/file_areas/{fileAreaId}/folders
-   * @param {string} projectId
-   * @param {string} fileAreaId
-   * @param {object} [params]
-   * @returns {Promise<object>}
-   */
-  listFolders(projectId, fileAreaId, params = {}) {
-    return this._client.get(
-      `/5.1/projects/${projectId}/file_areas/${fileAreaId}/folders`,
-      params,
-    );
-  }
-
-  /**
-   * Retrieve a specific folder.
-   * GET /5.0/projects/{projectId}/file_areas/{fileAreaId}/folders/{folderId}
-   * @param {string} projectId
-   * @param {string} fileAreaId
-   * @param {string} folderId
-   * @returns {Promise<object>}
-   */
-  getFolder(projectId, fileAreaId, folderId) {
-    return this._client.get(
-      `/5.0/projects/${projectId}/file_areas/${fileAreaId}/folders/${folderId}`,
-    );
-  }
-
-  /**
-   * Retrieve all properties for each file type in a specific folder.
-   * GET /1.0/projects/{projectId}/file_areas/{fileAreaId}/folders/{folderId}/files/properties/1.0/mappings
-   * @param {string} projectId
-   * @param {string} fileAreaId
-   * @param {string} folderId
-   * @returns {Promise<object>}
-   */
-  getFolderFilesProperties(projectId, fileAreaId, folderId) {
-    return this._client.get(
-      `/1.0/projects/${projectId}/file_areas/${fileAreaId}/folders/${folderId}/files/properties/1.0/mappings`,
-    );
-  }
-}
-
-module.exports = FoldersApi;
+'use strict';
+
+/**
+ * API methods for folders within a file area.
+ */
+class FoldersApi {
+  /**
+   * @param {import('../apiClient')} apiClient
+   */
+  constructor(apiClient) {
+    this._client = apiClient;
+  }
+
+  /**
+   * Browse all folders on the given project and file area.
+   * GET /5.1/projects/{projectId}/file_areas/{fileAreaId}/folders
+   * @param {string} projectId
+   * @param {string} fileAreaId
+   * @param {object} [params]
+   * @returns {Promise<object>}
+   */
+  listFolders(projectId, fileAreaId, params = {}) {
+    return this._client.get(
+      `/5.1/projects/${projectId}/file_areas/${fileAreaId}/folders`,
+      params,
+    );
+  }
+
+  /**
+   * Retrieve a specific folder.
+   * GET /5.0/projects/{projectId}/file_areas/{fileAreaId}/folders/{folderId}
+   * @param {string} projectId
+   * @param {string} fileAreaId
+   * @param {string} folderId
+   * @returns {Promise<object>}
+   */
+  getFolder(projectId, fileAreaId, folderId) {
+    return this._client.get(
+      `/5.0/projects/${projectId}/file_areas/${fileAreaId}/folders/${folderId}`,
+    );
+  }
+
+  /**
+   * Retrieve all properties for each file type in a specific folder.
+   * GET /1.0/projects/{projectId}/file_areas/{fileAreaId}/folders/{folderId}/files/properties/1.0/mappings
+   * @param {string} projectId
+   * @param {string} fileAreaId
+   * @param {string} folderId
+   * @returns {Promise<object>}
+   */
+  getFolderFilesProperties(projectId, fileAreaId, folderId) {
+    return this._client.get(
+      `/1.0/projects/${projectId}/file_areas/${fileAreaId}/folders/${folderId}/files/properties/1.0/mappings`,
+    );
+  }
+}
+
+module.exports = FoldersApi;

package/src/api/FormsApi.js

@@ -1,48 +1,48 @@
-'use strict';
-
-/**
- * API methods for forms on a project.
- */
-class FormsApi {
-  /**
-   * @param {import('../apiClient')} apiClient
-   */
-  constructor(apiClient) {
-    this._client = apiClient;
-  }
-
-  /**
-   * Retrieve forms on a project.
-   * GET /2.1/projects/{projectId}/forms
-   * @param {string} projectId
-   * @param {object} [params] - Optional filters (e.g. updatedAfter)
-   * @returns {Promise<object>}
-   */
-  getProjectForms(projectId, params = {}) {
-    return this._client.get(`/2.1/projects/${projectId}/forms`, params);
-  }
-
-  /**
-   * Retrieve a specific form.
-   * GET /1.2/projects/{projectId}/forms/{formId}
-   * @param {string} projectId
-   * @param {string} formId
-   * @returns {Promise<object>}
-   */
-  getForm(projectId, formId) {
-    return this._client.get(`/1.2/projects/${projectId}/forms/${formId}`);
-  }
-
-  /**
-   * Retrieve attachments on forms on a project in incremental updates.
-   * GET /2.1/projects/{projectId}/forms/attachments
-   * @param {string} projectId
-   * @param {object} [params] - Optional filters (e.g. updatedAfter)
-   * @returns {Promise<object>}
-   */
-  getProjectFormAttachments(projectId, params = {}) {
-    return this._client.get(`/2.1/projects/${projectId}/forms/attachments`, params);
-  }
-}
-
-module.exports = FormsApi;
+'use strict';
+
+/**
+ * API methods for forms on a project.
+ */
+class FormsApi {
+  /**
+   * @param {import('../apiClient')} apiClient
+   */
+  constructor(apiClient) {
+    this._client = apiClient;
+  }
+
+  /**
+   * Retrieve forms on a project.
+   * GET /2.1/projects/{projectId}/forms
+   * @param {string} projectId
+   * @param {object} [params] - Optional filters (e.g. updatedAfter)
+   * @returns {Promise<object>}
+   */
+  getProjectForms(projectId, params = {}) {
+    return this._client.get(`/2.1/projects/${projectId}/forms`, params);
+  }
+
+  /**
+   * Retrieve a specific form.
+   * GET /1.2/projects/{projectId}/forms/{formId}
+   * @param {string} projectId
+   * @param {string} formId
+   * @returns {Promise<object>}
+   */
+  getForm(projectId, formId) {
+    return this._client.get(`/1.2/projects/${projectId}/forms/${formId}`);
+  }
+
+  /**
+   * Retrieve attachments on forms on a project in incremental updates.
+   * GET /2.1/projects/{projectId}/forms/attachments
+   * @param {string} projectId
+   * @param {object} [params] - Optional filters (e.g. updatedAfter)
+   * @returns {Promise<object>}
+   */
+  getProjectFormAttachments(projectId, params = {}) {
+    return this._client.get(`/2.1/projects/${projectId}/forms/attachments`, params);
+  }
+}
+
+module.exports = FormsApi;

package/src/api/InspectionPlansApi.js

@@ -1,62 +1,62 @@
-'use strict';
-
-/**
- * API methods for inspection plans.
- */
-class InspectionPlansApi {
-  /**
-   * @param {import('../apiClient')} apiClient
-   */
-  constructor(apiClient) {
-    this._client = apiClient;
-  }
-
-  /**
-   * Browse all inspection plans on the given project.
-   * GET /1.2/projects/{projectId}/inspectionPlans
-   * @param {string} projectId
-   * @param {object} [params]
-   * @returns {Promise<object>}
-   */
-  listInspectionPlans(projectId, params = {}) {
-    return this._client.get(`/1.2/projects/${projectId}/inspectionPlans`, params);
-  }
-
-  /**
-   * Browse all inspection plan items on the given project.
-   * GET /1.1/projects/{projectId}/inspectionPlanItems
-   * @param {string} projectId
-   * @param {object} [params]
-   * @returns {Promise<object>}
-   */
-  listInspectionPlanItems(projectId, params = {}) {
-    return this._client.get(`/1.1/projects/${projectId}/inspectionPlanItems`, params);
-  }
-
-  /**
-   * Browse all inspection plan item zones on the given project.
-   * GET /1.1/projects/{projectId}/inspectionPlanItemZones
-   * @param {string} projectId
-   * @param {object} [params]
-   * @returns {Promise<object>}
-   */
-  listInspectionPlanItemZones(projectId, params = {}) {
-    return this._client.get(`/1.1/projects/${projectId}/inspectionPlanItemZones`, params);
-  }
-
-  /**
-   * Browse all inspection plan registrations on the given project.
-   * GET /2.1/projects/{projectId}/inspectionPlanRegistrations
-   * @param {string} projectId
-   * @param {object} [params]
-   * @returns {Promise<object>}
-   */
-  listInspectionPlanRegistrations(projectId, params = {}) {
-    return this._client.get(
-      `/2.1/projects/${projectId}/inspectionPlanRegistrations`,
-      params,
-    );
-  }
-}
-
-module.exports = InspectionPlansApi;
+'use strict';
+
+/**
+ * API methods for inspection plans.
+ */
+class InspectionPlansApi {
+  /**
+   * @param {import('../apiClient')} apiClient
+   */
+  constructor(apiClient) {
+    this._client = apiClient;
+  }
+
+  /**
+   * Browse all inspection plans on the given project.
+   * GET /1.2/projects/{projectId}/inspectionPlans
+   * @param {string} projectId
+   * @param {object} [params]
+   * @returns {Promise<object>}
+   */
+  listInspectionPlans(projectId, params = {}) {
+    return this._client.get(`/1.2/projects/${projectId}/inspectionPlans`, params);
+  }
+
+  /**
+   * Browse all inspection plan items on the given project.
+   * GET /1.1/projects/{projectId}/inspectionPlanItems
+   * @param {string} projectId
+   * @param {object} [params]
+   * @returns {Promise<object>}
+   */
+  listInspectionPlanItems(projectId, params = {}) {
+    return this._client.get(`/1.1/projects/${projectId}/inspectionPlanItems`, params);
+  }
+
+  /**
+   * Browse all inspection plan item zones on the given project.
+   * GET /1.1/projects/{projectId}/inspectionPlanItemZones
+   * @param {string} projectId
+   * @param {object} [params]
+   * @returns {Promise<object>}
+   */
+  listInspectionPlanItemZones(projectId, params = {}) {
+    return this._client.get(`/1.1/projects/${projectId}/inspectionPlanItemZones`, params);
+  }
+
+  /**
+   * Browse all inspection plan registrations on the given project.
+   * GET /2.1/projects/{projectId}/inspectionPlanRegistrations
+   * @param {string} projectId
+   * @param {object} [params]
+   * @returns {Promise<object>}
+   */
+  listInspectionPlanRegistrations(projectId, params = {}) {
+    return this._client.get(
+      `/2.1/projects/${projectId}/inspectionPlanRegistrations`,
+      params,
+    );
+  }
+}
+
+module.exports = InspectionPlansApi;

package/src/api/ProjectTemplatesApi.js

@@ -1,25 +1,25 @@
-'use strict';
-
-/**
- * API methods for project templates.
- */
-class ProjectTemplatesApi {
-  /**
-   * @param {import('../apiClient')} apiClient
-   */
-  constructor(apiClient) {
-    this._client = apiClient;
-  }
-
-  /**
-   * Get all available project templates on the company profile.
-   * GET /1.1/projectTemplates
-   * @param {object} [params]
-   * @returns {Promise<object>}
-   */
-  listProjectTemplates(params = {}) {
-    return this._client.get('/1.1/projectTemplates', params);
-  }
-}
-
-module.exports = ProjectTemplatesApi;
+'use strict';
+
+/**
+ * API methods for project templates.
+ */
+class ProjectTemplatesApi {
+  /**
+   * @param {import('../apiClient')} apiClient
+   */
+  constructor(apiClient) {
+    this._client = apiClient;
+  }
+
+  /**
+   * Get all available project templates on the company profile.
+   * GET /1.1/projectTemplates
+   * @param {object} [params]
+   * @returns {Promise<object>}
+   */
+  listProjectTemplates(params = {}) {
+    return this._client.get('/1.1/projectTemplates', params);
+  }
+}
+
+module.exports = ProjectTemplatesApi;