@dockflow/sdk 0.0.0-stage → 0.2.0

package/docs/V3DocumentApi.md

@@ -0,0 +1,361 @@
+# V3DocumentApi
+
+All URIs are relative to *https://api.dockflow.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**listDocumentTypes**](V3DocumentApi.md#listdocumenttypes) | **GET** /v3/downstream/documents/types | List document types |
+| [**v3DocumentDelete**](V3DocumentApi.md#v3documentdelete) | **DELETE** /v3/downstream/documents/{reference} | Delete a document |
+| [**v3DocumentGet**](V3DocumentApi.md#v3documentget) | **GET** /v3/downstream/documents/{reference} | List the documents of a tradeflow |
+| [**v3DocumentPatch**](V3DocumentApi.md#v3documentpatch) | **PATCH** /v3/downstream/documents/{reference} | Update a document |
+| [**v3DocumentPost**](V3DocumentApi.md#v3documentpost) | **POST** /v3/downstream/documents | Upload a document to a tradeflow |
+
+
+
+## listDocumentTypes
+
+> Array<ListDocumentTypes200ResponseInner> listDocumentTypes()
+
+List document types
+
+### Example
+
+```ts
+import {
+  Configuration,
+  V3DocumentApi,
+} from '@dockflow/sdk';
+import type { ListDocumentTypesRequest } from '@dockflow/sdk';
+
+async function example() {
+  console.log("🚀 Testing @dockflow/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: ApiKey
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new V3DocumentApi(config);
+
+  try {
+    const data = await api.listDocumentTypes();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<ListDocumentTypes200ResponseInner>**](ListDocumentTypes200ResponseInner.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | The document types a document can be uploaded as. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v3DocumentDelete
+
+> v3DocumentDelete(reference)
+
+Delete a document
+
+### Example
+
+```ts
+import {
+  Configuration,
+  V3DocumentApi,
+} from '@dockflow/sdk';
+import type { V3DocumentDeleteRequest } from '@dockflow/sdk';
+
+async function example() {
+  console.log("🚀 Testing @dockflow/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: ApiKey
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new V3DocumentApi(config);
+
+  const body = {
+    // string
+    reference: reference_example,
+  } satisfies V3DocumentDeleteRequest;
+
+  try {
+    const data = await api.v3DocumentDelete(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **reference** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **500** |  |  -  |
+| **204** | The document was deleted. |  -  |
+| **404** | No document with this id is visible to the token\'s entity. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v3DocumentGet
+
+> V3DocumentGet200Response v3DocumentGet(reference)
+
+List the documents of a tradeflow
+
+### Example
+
+```ts
+import {
+  Configuration,
+  V3DocumentApi,
+} from '@dockflow/sdk';
+import type { V3DocumentGetRequest } from '@dockflow/sdk';
+
+async function example() {
+  console.log("🚀 Testing @dockflow/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: ApiKey
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new V3DocumentApi(config);
+
+  const body = {
+    // string
+    reference: reference_example,
+  } satisfies V3DocumentGetRequest;
+
+  try {
+    const data = await api.v3DocumentGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **reference** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**V3DocumentGet200Response**](V3DocumentGet200Response.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | The documents attached to the tradeflow. |  -  |
+| **404** | No tradeflow with this reference belongs to the token\'s entity. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v3DocumentPatch
+
+> V3DocumentGet200ResponseDataInner v3DocumentPatch(reference, documentUpdate)
+
+Update a document
+
+### Example
+
+```ts
+import {
+  Configuration,
+  V3DocumentApi,
+} from '@dockflow/sdk';
+import type { V3DocumentPatchRequest } from '@dockflow/sdk';
+
+async function example() {
+  console.log("🚀 Testing @dockflow/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: ApiKey
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new V3DocumentApi(config);
+
+  const body = {
+    // string
+    reference: reference_example,
+    // DocumentUpdate
+    documentUpdate: ...,
+  } satisfies V3DocumentPatchRequest;
+
+  try {
+    const data = await api.v3DocumentPatch(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **reference** | `string` |  | [Defaults to `undefined`] |
+| **documentUpdate** | [DocumentUpdate](DocumentUpdate.md) |  | |
+
+### Return type
+
+[**V3DocumentGet200ResponseDataInner**](V3DocumentGet200ResponseDataInner.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **500** |  |  -  |
+| **200** | The updated document. |  -  |
+| **400** |  |  -  |
+| **404** | No document with this id is visible to the token\'s entity. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v3DocumentPost
+
+> V3DocumentPost202Response v3DocumentPost(documentUpload)
+
+Upload a document to a tradeflow
+
+### Example
+
+```ts
+import {
+  Configuration,
+  V3DocumentApi,
+} from '@dockflow/sdk';
+import type { V3DocumentPostRequest } from '@dockflow/sdk';
+
+async function example() {
+  console.log("🚀 Testing @dockflow/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: ApiKey
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new V3DocumentApi(config);
+
+  const body = {
+    // DocumentUpload
+    documentUpload: ...,
+  } satisfies V3DocumentPostRequest;
+
+  try {
+    const data = await api.v3DocumentPost(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **documentUpload** | [DocumentUpload](DocumentUpload.md) |  | |
+
+### Return type
+
+[**V3DocumentPost202Response**](V3DocumentPost202Response.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **202** | The document was stored on the tradeflow. |  -  |
+| **500** |  |  -  |
+| **400** |  |  -  |
+
+[[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/V3DocumentGet200Response.md

@@ -0,0 +1,38 @@
+
+# V3DocumentGet200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [Array<V3DocumentGet200ResponseDataInner>](V3DocumentGet200ResponseDataInner.md)
+`tradeflowReference` | string
+`count` | number
+
+## Example
+
+```typescript
+import type { V3DocumentGet200Response } from '@dockflow/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "tradeflowReference": null,
+  "count": null,
+} satisfies V3DocumentGet200Response
+
+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 V3DocumentGet200Response
+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/V3DocumentGet200ResponseDataInner.md

@@ -0,0 +1,50 @@
+
+# V3DocumentGet200ResponseDataInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`name` | string
+`filetype` | string
+`inputName` | string
+`version` | number
+`documentType` | [V3DocumentGet200ResponseDataInnerDocumentType](V3DocumentGet200ResponseDataInnerDocumentType.md)
+`metadata` | object
+`createdAt` | string
+`updatedAt` | string
+
+## Example
+
+```typescript
+import type { V3DocumentGet200ResponseDataInner } from '@dockflow/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "filetype": null,
+  "inputName": null,
+  "version": null,
+  "documentType": null,
+  "metadata": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies V3DocumentGet200ResponseDataInner
+
+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 V3DocumentGet200ResponseDataInner
+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/V3DocumentGet200ResponseDataInnerDocumentType.md

@@ -0,0 +1,36 @@
+
+# V3DocumentGet200ResponseDataInnerDocumentType
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`description` | string
+
+## Example
+
+```typescript
+import type { V3DocumentGet200ResponseDataInnerDocumentType } from '@dockflow/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "description": null,
+} satisfies V3DocumentGet200ResponseDataInnerDocumentType
+
+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 V3DocumentGet200ResponseDataInnerDocumentType
+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/V3DocumentPost202Response.md

@@ -0,0 +1,46 @@
+
+# V3DocumentPost202Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`tradeflowReference` | string
+`documentType` | string
+`filename` | string
+`filetype` | string
+`containerReference` | string
+`createdAt` | string
+
+## Example
+
+```typescript
+import type { V3DocumentPost202Response } from '@dockflow/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "tradeflowReference": null,
+  "documentType": null,
+  "filename": null,
+  "filetype": null,
+  "containerReference": null,
+  "createdAt": null,
+} satisfies V3DocumentPost202Response
+
+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 V3DocumentPost202Response
+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/V3DocumentPost400Response.md

@@ -0,0 +1,32 @@
+
+# V3DocumentPost400Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { V3DocumentPost400Response } from '@dockflow/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies V3DocumentPost400Response
+
+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 V3DocumentPost400Response
+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)
+
+