@equisoft/equisoft-connect-sdk-typescript 13.59.1-snapshot.20261008140706 → 13.60.0

package/docs/ExtractionApi.md

@@ -5,12 +5,16 @@ All URIs are relative to *http://localhost*
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
 | [**addExtraction**](ExtractionApi.md#addextraction) | **POST** /crm/api/v1/extractions | Add an extraction |
+| [**deleteExtraction**](ExtractionApi.md#deleteextraction) | **DELETE** /crm/api/v1/extractions/{uuid} | Delete an extraction |
+| [**getExtraction**](ExtractionApi.md#getextraction) | **GET** /crm/api/v1/extractions/{uuid} | Get an extraction |
+| [**listExtractions**](ExtractionApi.md#listextractions) | **GET** /crm/api/v1/extractions | List extractions |
+| [**resumeExtraction**](ExtractionApi.md#resumeextraction) | **POST** /crm/api/v1/extractions/{uuid}/resume | Resume an extraction |
 
 
 
 ## addExtraction
 
-> ExtractionAddExtractionResponse addExtraction(extractionAddExtractionPayload)
+> addExtraction(extractionsAddExtractionPayload)
 
 Add an extraction
 
@@ -32,8 +36,8 @@ async function example() {
   const api = new ExtractionApi(config);
 
   const body = {
-    // ExtractionAddExtractionPayload
-    extractionAddExtractionPayload: ...,
+    // ExtractionsAddExtractionPayload
+    extractionsAddExtractionPayload: ...,
   } satisfies AddExtractionRequest;
 
   try {
@@ -53,11 +57,11 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **extractionAddExtractionPayload** | [ExtractionAddExtractionPayload](ExtractionAddExtractionPayload.md) |  | |
+| **extractionsAddExtractionPayload** | [ExtractionsAddExtractionPayload](ExtractionsAddExtractionPayload.md) |  | |
 
 ### Return type
 
-[**ExtractionAddExtractionResponse**](ExtractionAddExtractionResponse.md)
+`void` (Empty response body)
 
 ### Authorization
 
@@ -69,10 +73,321 @@ example().catch(console.error);
 - **Accept**: `application/json`
 
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Created |  * Location - The URI of the created resource <br>  |
+| **422** | Unprocessable Content |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **500** | Internal Server Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deleteExtraction
+
+> deleteExtraction(uuid)
+
+Delete an extraction
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ExtractionApi,
+} from '@equisoft/equisoft-connect-sdk-typescript';
+import type { DeleteExtractionRequest } from '@equisoft/equisoft-connect-sdk-typescript';
+
+async function example() {
+  console.log("🚀 Testing @equisoft/equisoft-connect-sdk-typescript SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: OAuth2 accessCode
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new ExtractionApi(config);
+
+  const body = {
+    // string | Unique identifier.
+    uuid: uuid_example,
+  } satisfies DeleteExtractionRequest;
+
+  try {
+    const data = await api.deleteExtraction(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **uuid** | `string` | Unique identifier. | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[OAuth2 accessCode](../README.md#OAuth2-accessCode)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | No Content |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **500** | Internal Server Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getExtraction
+
+> ExtractionsExtraction getExtraction(uuid)
+
+Get an extraction
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ExtractionApi,
+} from '@equisoft/equisoft-connect-sdk-typescript';
+import type { GetExtractionRequest } from '@equisoft/equisoft-connect-sdk-typescript';
+
+async function example() {
+  console.log("🚀 Testing @equisoft/equisoft-connect-sdk-typescript SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: OAuth2 accessCode
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new ExtractionApi(config);
+
+  const body = {
+    // string | Unique identifier.
+    uuid: uuid_example,
+  } satisfies GetExtractionRequest;
+
+  try {
+    const data = await api.getExtraction(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **uuid** | `string` | Unique identifier. | [Defaults to `undefined`] |
+
+### Return type
+
+[**ExtractionsExtraction**](ExtractionsExtraction.md)
+
+### Authorization
+
+[OAuth2 accessCode](../README.md#OAuth2-accessCode)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** | Ok |  -  |
+| **404** | Not Found |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **500** | Internal Server Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listExtractions
+
+> ExtractionsListExtractionResponse listExtractions(extractionsAddExtractionPayload, status, today, includeDeleted, pageToken, maxResults)
+
+List extractions
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ExtractionApi,
+} from '@equisoft/equisoft-connect-sdk-typescript';
+import type { ListExtractionsRequest } from '@equisoft/equisoft-connect-sdk-typescript';
+
+async function example() {
+  console.log("🚀 Testing @equisoft/equisoft-connect-sdk-typescript SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: OAuth2 accessCode
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new ExtractionApi(config);
+
+  const body = {
+    // ExtractionsAddExtractionPayload
+    extractionsAddExtractionPayload: ...,
+    // string | Filter extraction status. (optional)
+    status: status_example,
+    // boolean | Filter by today only. Default: false. (optional)
+    today: true,
+    // boolean | Filter by including deleted extractions. Default: false. (optional)
+    includeDeleted: true,
+    // string | Token to specify which page to fetch. (optional)
+    pageToken: MjUwMDszMDAK,
+    // string | Maximum number of records for one result page. If the query return more records, nextPageToken will be specified in the result to get the records of the next page. Defaults to 250 records. Can never be more than 2500 records. (optional)
+    maxResults: maxResults_example,
+  } satisfies ListExtractionsRequest;
+
+  try {
+    const data = await api.listExtractions(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **extractionsAddExtractionPayload** | [ExtractionsAddExtractionPayload](ExtractionsAddExtractionPayload.md) |  | |
+| **status** | `string` | Filter extraction status. | [Optional] [Defaults to `undefined`] |
+| **today** | `boolean` | Filter by today only. Default: false. | [Optional] [Defaults to `undefined`] |
+| **includeDeleted** | `boolean` | Filter by including deleted extractions. Default: false. | [Optional] [Defaults to `undefined`] |
+| **pageToken** | `string` | Token to specify which page to fetch. | [Optional] [Defaults to `undefined`] |
+| **maxResults** | `string` | Maximum number of records for one result page. If the query return more records, nextPageToken will be specified in the result to get the records of the next page. Defaults to 250 records. Can never be more than 2500 records. | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**ExtractionsListExtractionResponse**](ExtractionsListExtractionResponse.md)
+
+### Authorization
+
+[OAuth2 accessCode](../README.md#OAuth2-accessCode)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Ok |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **500** | Internal Server Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## resumeExtraction
+
+> resumeExtraction(uuid, extractionsResumeExtractionPayload)
+
+Resume an extraction
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ExtractionApi,
+} from '@equisoft/equisoft-connect-sdk-typescript';
+import type { ResumeExtractionRequest } from '@equisoft/equisoft-connect-sdk-typescript';
+
+async function example() {
+  console.log("🚀 Testing @equisoft/equisoft-connect-sdk-typescript SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: OAuth2 accessCode
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new ExtractionApi(config);
+
+  const body = {
+    // string | Unique identifier.
+    uuid: uuid_example,
+    // ExtractionsResumeExtractionPayload
+    extractionsResumeExtractionPayload: ...,
+  } satisfies ResumeExtractionRequest;
+
+  try {
+    const data = await api.resumeExtraction(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **uuid** | `string` | Unique identifier. | [Defaults to `undefined`] |
+| **extractionsResumeExtractionPayload** | [ExtractionsResumeExtractionPayload](ExtractionsResumeExtractionPayload.md) |  | |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[OAuth2 accessCode](../README.md#OAuth2-accessCode)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | No Content |  -  |
+| **404** | Not Found |  -  |
+| **422** | Unprocessable Content |  -  |
+| **409** | Conflict |  -  |
 | **400** | Bad Request |  -  |
 | **401** | Unauthorized |  -  |
 | **500** | Internal Server Error |  -  |

package/docs/{ExtractionAddExtractionPayload.md → ExtractionsAddExtractionPayload.md}

@@ -1,5 +1,5 @@
 
-# ExtractionAddExtractionPayload
+# ExtractionsAddExtractionPayload
 
 
 ## Properties
@@ -16,7 +16,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { ExtractionAddExtractionPayload } from '@equisoft/equisoft-connect-sdk-typescript'
+import type { ExtractionsAddExtractionPayload } from '@equisoft/equisoft-connect-sdk-typescript'
 
 // TODO: Update the object below with actual values
 const example = {
@@ -26,7 +26,7 @@ const example = {
   "users": null,
   "includeDocument": null,
   "includeGroup": null,
-} satisfies ExtractionAddExtractionPayload
+} satisfies ExtractionsAddExtractionPayload
 
 console.log(example)
 
@@ -35,7 +35,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as ExtractionAddExtractionPayload
+const exampleParsed = JSON.parse(exampleJSON) as ExtractionsAddExtractionPayload
 console.log(exampleParsed)
 ```
 

package/docs/ExtractionsDetails.md

@@ -0,0 +1,44 @@
+
+# ExtractionsDetails
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`database` | string
+`recipient` | string
+`users` | [Array<UsersUserIdentity>](UsersUserIdentity.md)
+`includeDocuments` | boolean
+`includeGroups` | boolean
+`resume` | boolean
+
+## Example
+
+```typescript
+import type { ExtractionsDetails } from '@equisoft/equisoft-connect-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "database": null,
+  "recipient": null,
+  "users": null,
+  "includeDocuments": null,
+  "includeGroups": null,
+  "resume": null,
+} satisfies ExtractionsDetails
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ExtractionsDetails
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ExtractionsExtraction.md

@@ -0,0 +1,44 @@
+
+# ExtractionsExtraction
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`uuid` | string
+`status` | string
+`scheduledAt` | Date
+`details` | [ExtractionsDetails](ExtractionsDetails.md)
+`changeMetadata` | [ChangeMetadata](ChangeMetadata.md)
+`processedAt` | Date
+
+## Example
+
+```typescript
+import type { ExtractionsExtraction } from '@equisoft/equisoft-connect-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "uuid": null,
+  "status": null,
+  "scheduledAt": null,
+  "details": null,
+  "changeMetadata": null,
+  "processedAt": null,
+} satisfies ExtractionsExtraction
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ExtractionsExtraction
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ExtractionsListExtractionResponse.md

@@ -0,0 +1,38 @@
+
+# ExtractionsListExtractionResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`nextPageToken` | string
+`previousPageToken` | string
+`items` | [Array<ExtractionsExtraction>](ExtractionsExtraction.md)
+
+## Example
+
+```typescript
+import type { ExtractionsListExtractionResponse } from '@equisoft/equisoft-connect-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "nextPageToken": MjUwMDszMDAK,
+  "previousPageToken": MjUwMDszMDAK,
+  "items": null,
+} satisfies ExtractionsListExtractionResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ExtractionsListExtractionResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ExtractionsResumeExtractionPayload.md

@@ -0,0 +1,34 @@
+
+# ExtractionsResumeExtractionPayload
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`resumeDate` | string
+
+## Example
+
+```typescript
+import type { ExtractionsResumeExtractionPayload } from '@equisoft/equisoft-connect-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "resumeDate": null,
+} satisfies ExtractionsResumeExtractionPayload
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ExtractionsResumeExtractionPayload
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/{ExtractionAddExtractionResponse.md → ExtraxtionsStatus.md}

@@ -1,22 +1,21 @@
 
-# ExtractionAddExtractionResponse
+# ExtraxtionsStatus
 
+Extraction\'s status.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`id` | number
 
 ## Example
 
 ```typescript
-import type { ExtractionAddExtractionResponse } from '@equisoft/equisoft-connect-sdk-typescript'
+import type { ExtraxtionsStatus } from '@equisoft/equisoft-connect-sdk-typescript'
 
 // TODO: Update the object below with actual values
 const example = {
-  "id": null,
-} satisfies ExtractionAddExtractionResponse
+} satisfies ExtraxtionsStatus
 
 console.log(example)
 
@@ -25,7 +24,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as ExtractionAddExtractionResponse
+const exampleParsed = JSON.parse(exampleJSON) as ExtraxtionsStatus
 console.log(exampleParsed)
 ```
 

package/docs/UsersUserIdentity.md

@@ -8,6 +8,7 @@ Name | Type
 ------------ | -------------
 `uuid` | string
 `displayName` | string
+`email` | string
 
 ## Example
 
@@ -18,6 +19,7 @@ import type { UsersUserIdentity } from '@equisoft/equisoft-connect-sdk-typescrip
 const example = {
   "uuid": null,
   "displayName": null,
+  "email": null,
 } satisfies UsersUserIdentity
 
 console.log(example)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equisoft/equisoft-connect-sdk-typescript",
-  "version": "13.59.1-snapshot.20261008140706",
+  "version": "13.60.0",
   "description": "OpenAPI client for @equisoft/equisoft-connect-sdk-typescript",
   "author": "OpenAPI-Generator",
   "repository": {