@streetlevel/api-clients 1.0.1

package/src/generated/document/docs/CreateDocumentRequest.md

@@ -0,0 +1,47 @@
+
+# CreateDocumentRequest
+
+Request to create a document
+
+## Properties
+
+Name | Type
+------------ | -------------
+`clientId` | string
+`campaignId` | string
+`name` | string
+`contentType` | string
+`fileSize` | number
+`type` | [DocumentType](DocumentType.md)
+`description` | string
+
+## Example
+
+```typescript
+import type { CreateDocumentRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "clientId": null,
+  "campaignId": null,
+  "name": null,
+  "contentType": null,
+  "fileSize": null,
+  "type": null,
+  "description": null,
+} satisfies CreateDocumentRequest
+
+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 CreateDocumentRequest
+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/src/generated/document/docs/DocumentResponse.md

@@ -0,0 +1,57 @@
+
+# DocumentResponse
+
+Document information
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`clientId` | string
+`campaignId` | string
+`name` | string
+`fileKey` | string
+`fileUrl` | string
+`contentType` | string
+`fileSize` | number
+`type` | [DocumentType](DocumentType.md)
+`description` | string
+`createdAt` | Date
+`lastModifiedAt` | Date
+
+## Example
+
+```typescript
+import type { DocumentResponse } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "clientId": null,
+  "campaignId": null,
+  "name": null,
+  "fileKey": null,
+  "fileUrl": null,
+  "contentType": null,
+  "fileSize": null,
+  "type": null,
+  "description": null,
+  "createdAt": null,
+  "lastModifiedAt": null,
+} satisfies DocumentResponse
+
+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 DocumentResponse
+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/src/generated/document/docs/DocumentType.md

@@ -0,0 +1,33 @@
+
+# DocumentType
+
+Type of document
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { DocumentType } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies DocumentType
+
+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 DocumentType
+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/src/generated/document/docs/DocumentsApi.md

@@ -0,0 +1,492 @@
+# DocumentsApi
+
+All URIs are relative to */api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createDocument**](DocumentsApi.md#createdocumentoperation) | **POST** /documents | Create a new document |
+| [**deleteDocument**](DocumentsApi.md#deletedocument) | **DELETE** /documents/{document_id} | Delete a document |
+| [**getDocument**](DocumentsApi.md#getdocument) | **GET** /documents/{document_id} | Get document by ID |
+| [**getDocumentDownloadUrl**](DocumentsApi.md#getdocumentdownloadurl) | **GET** /documents/{document_id}/download-url | Get presigned URL for document download |
+| [**getDocumentUploadUrl**](DocumentsApi.md#getdocumentuploadurl) | **GET** /documents/{document_id}/upload-url | Get presigned URL for document upload |
+| [**listDocuments**](DocumentsApi.md#listdocuments) | **GET** /documents | List documents |
+| [**updateDocument**](DocumentsApi.md#updatedocumentoperation) | **PUT** /documents/{document_id} | Update a document |
+
+
+
+## createDocument
+
+> DocumentResponse createDocument(createDocumentRequest)
+
+Create a new document
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DocumentsApi,
+} from '';
+import type { CreateDocumentOperationRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new DocumentsApi();
+
+  const body = {
+    // CreateDocumentRequest
+    createDocumentRequest: ...,
+  } satisfies CreateDocumentOperationRequest;
+
+  try {
+    const data = await api.createDocument(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createDocumentRequest** | [CreateDocumentRequest](CreateDocumentRequest.md) |  | |
+
+### Return type
+
+[**DocumentResponse**](DocumentResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Document created |  -  |
+| **400** | Validation error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deleteDocument
+
+> deleteDocument(documentId)
+
+Delete a document
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DocumentsApi,
+} from '';
+import type { DeleteDocumentRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new DocumentsApi();
+
+  const body = {
+    // string
+    documentId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DeleteDocumentRequest;
+
+  try {
+    const data = await api.deleteDocument(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **documentId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Document deleted |  -  |
+| **404** | Document not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getDocument
+
+> DocumentResponse getDocument(documentId)
+
+Get document by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DocumentsApi,
+} from '';
+import type { GetDocumentRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new DocumentsApi();
+
+  const body = {
+    // string
+    documentId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetDocumentRequest;
+
+  try {
+    const data = await api.getDocument(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **documentId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**DocumentResponse**](DocumentResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Document found |  -  |
+| **404** | Document not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getDocumentDownloadUrl
+
+> DownloadUrlResponse getDocumentDownloadUrl(documentId)
+
+Get presigned URL for document download
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DocumentsApi,
+} from '';
+import type { GetDocumentDownloadUrlRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new DocumentsApi();
+
+  const body = {
+    // string
+    documentId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetDocumentDownloadUrlRequest;
+
+  try {
+    const data = await api.getDocumentDownloadUrl(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **documentId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**DownloadUrlResponse**](DownloadUrlResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Download URL generated |  -  |
+| **404** | Document not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getDocumentUploadUrl
+
+> UploadUrlResponse getDocumentUploadUrl(documentId)
+
+Get presigned URL for document upload
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DocumentsApi,
+} from '';
+import type { GetDocumentUploadUrlRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new DocumentsApi();
+
+  const body = {
+    // string
+    documentId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetDocumentUploadUrlRequest;
+
+  try {
+    const data = await api.getDocumentUploadUrl(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **documentId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**UploadUrlResponse**](UploadUrlResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Upload URL generated |  -  |
+| **404** | Document not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listDocuments
+
+> ListDocumentsResponse listDocuments(clientId, campaignId, type, offset, limit)
+
+List documents
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DocumentsApi,
+} from '';
+import type { ListDocumentsRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new DocumentsApi();
+
+  const body = {
+    // string | Filter by client ID (optional)
+    clientId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string | Filter by campaign ID (optional)
+    campaignId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // DocumentType (optional)
+    type: ...,
+    // number (optional)
+    offset: 56,
+    // number (optional)
+    limit: 56,
+  } satisfies ListDocumentsRequest;
+
+  try {
+    const data = await api.listDocuments(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **clientId** | `string` | Filter by client ID | [Optional] [Defaults to `undefined`] |
+| **campaignId** | `string` | Filter by campaign ID | [Optional] [Defaults to `undefined`] |
+| **type** | `DocumentType` |  | [Optional] [Defaults to `undefined`] [Enum: CONTRACT, INVOICE, RECEIPT, REPORT, OTHER] |
+| **offset** | `number` |  | [Optional] [Defaults to `0`] |
+| **limit** | `number` |  | [Optional] [Defaults to `20`] |
+
+### Return type
+
+[**ListDocumentsResponse**](ListDocumentsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of documents |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updateDocument
+
+> DocumentResponse updateDocument(documentId, updateDocumentRequest)
+
+Update a document
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DocumentsApi,
+} from '';
+import type { UpdateDocumentOperationRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new DocumentsApi();
+
+  const body = {
+    // string
+    documentId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // UpdateDocumentRequest
+    updateDocumentRequest: ...,
+  } satisfies UpdateDocumentOperationRequest;
+
+  try {
+    const data = await api.updateDocument(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **documentId** | `string` |  | [Defaults to `undefined`] |
+| **updateDocumentRequest** | [UpdateDocumentRequest](UpdateDocumentRequest.md) |  | |
+
+### Return type
+
+[**DocumentResponse**](DocumentResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Document updated |  -  |
+| **400** | Validation error |  -  |
+| **404** | Document not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/src/generated/document/docs/DownloadUrlResponse.md

@@ -0,0 +1,37 @@
+
+# DownloadUrlResponse
+
+Presigned download URL
+
+## Properties
+
+Name | Type
+------------ | -------------
+`downloadUrl` | string
+`expiresAt` | Date
+
+## Example
+
+```typescript
+import type { DownloadUrlResponse } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "downloadUrl": null,
+  "expiresAt": null,
+} satisfies DownloadUrlResponse
+
+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 DownloadUrlResponse
+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/src/generated/document/docs/GetDocument404Response.md

@@ -0,0 +1,41 @@
+
+# GetDocument404Response
+
+Standard error response
+
+## Properties
+
+Name | Type
+------------ | -------------
+`errorCode` | string
+`message` | string
+`timestamp` | Date
+`details` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { GetDocument404Response } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "errorCode": null,
+  "message": null,
+  "timestamp": null,
+  "details": null,
+} satisfies GetDocument404Response
+
+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 GetDocument404Response
+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)
+
+