@experteam-mx/ngx-services 20.8.0 → 20.8.2

package/fesm2022/experteam-mx-ngx-services.mjs

@@ -4838,41 +4838,63 @@ class ApiShipmentsService {
             .pipe(map(({ data }) => data));
     }
     /**
-     * Retrieves a paginated list of signature page settings
-     * @param {QueryParams} params - Query parameters for filtering and pagination
-     * @returns {Observable<SignaturePageSettingsOut>} Observable containing the list of signature page settings and pagination metadata
+     * Retrieves a paginated list of document configurations.
+     *
+     * @param {QueryParams} params - Query parameters used for filtering, sorting, and pagination.
+     * @returns {Observable<DocumentConfigurationsOut>} An observable containing the list of document configurations and pagination metadata.
      */
-    getSignaturePageSettings(params) {
-        return this.http.get(`${this.url}/signature-page-settings`, {
+    getDocumentConfigurations(params) {
+        return this.http.get(`${this.url}/document-configurations`, {
             params
         }).pipe(map(({ data }) => data));
     }
     /**
-     * Retrieves the details of a signature page setting based on its ID.
+     * Retrieves a document configuration by its identifier.
+     *
+     * @param {number} id - The unique identifier of the document configuration.
+     * @returns {Observable<DocumentConfigurationOut>} An observable containing the document configuration details.
+     */
+    getDocumentConfiguration(id) {
+        return this.http.get(`${this.url}/document-configurations/${id}`).pipe(map(({ data }) => data));
+    }
+    /**
+     * Creates a new document configuration.
      *
-     * @param {number} id - The identifier of the signature page setting to fetch.
-     * @return {Observable<SignaturePageSettingOut>} An observable that emits the signature page setting data.
+     * @param {DocumentConfigurationIn} body - The document configuration data to create.
+     * @returns {Observable<DocumentConfigurationOut>} An observable containing the newly created document configuration.
      */
-    getSignaturePageSetting(id) {
-        return this.http.get(`${this.url}/signature-page-settings/${id}`).pipe(map(({ data }) => data));
+    postDocumentConfiguration(body) {
+        return this.http.post(`${this.url}/document-configurations`, body)
+            .pipe(map(({ data }) => data));
     }
     /**
-     * Creates a new signature page setting
-     * @param {SignaturePageSettingIn} body - The signature page setting data to create
-     * @returns {Observable<SignaturePageSettingOut>} Observable containing the created signature page setting with its assigned ID
+     * Updates an existing document configuration.
+     *
+     * @param {number} id - The unique identifier of the document configuration to update.
+     * @param {DocumentConfigurationIn} body - The updated document configuration data.
+     * @returns {Observable<DocumentConfigurationOut>} An observable containing the updated document configuration.
      */
-    postSignaturePageSetting(body) {
-        return this.http.post(`${this.url}/signature-page-settings`, body)
+    putDocumentConfiguration(id, body) {
+        return this.http.put(`${this.url}/document-configurations/${id}`, body)
             .pipe(map(({ data }) => data));
     }
     /**
-     * Updates an existing signature page setting
-     * @param {number} id - The unique identifier of the signature page setting to update
-     * @param {SignaturePageSettingIn} body - The updated signature page setting data
-     * @returns {Observable<SignaturePageSettingOut>} Observable containing the updated signature page setting
+     * Generates a preview for a document configuration.
+     *
+     * @param {DocumentConfigurationsPreviewIn} body - The data used to generate the document preview.
+     * @returns {Observable<DocumentConfigurationsPreviewOut>} An observable containing the generated document preview.
      */
-    putSignaturePageSetting(id, body) {
-        return this.http.put(`${this.url}/signature-page-settings/${id}`, body)
+    postDocumentConfigurationPreview(body) {
+        return this.http.post(`${this.url}/document-configurations/preview`, body)
+            .pipe(map(({ data }) => data));
+    }
+    /**
+     * Retrieves the shipment documents associated with a document configuration
+     * @param {number} id - The unique identifier of the document configuration
+     * @returns {Observable<ShipmentDocumentsOut>} observable containing the shipment documents
+     * */
+    getDocuments(id) {
+        return this.http.get(`${this.url}/shipments/${id}/documents`)
             .pipe(map(({ data }) => data));
     }
     static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.3.25", ngImport: i0, type: ApiShipmentsService, deps: [], target: i0.ɵɵFactoryTarget.Injectable });