@streetlevel/api-clients 1.0.1

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

@@ -0,0 +1,41 @@
+
+# ListDocumentsResponse
+
+Paginated list of documents
+
+## Properties
+
+Name | Type
+------------ | -------------
+`documents` | [Array<DocumentResponse>](DocumentResponse.md)
+`total` | number
+`offset` | number
+`limit` | number
+
+## Example
+
+```typescript
+import type { ListDocumentsResponse } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "documents": null,
+  "total": null,
+  "offset": null,
+  "limit": null,
+} satisfies ListDocumentsResponse
+
+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 ListDocumentsResponse
+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/UpdateDocumentRequest.md

@@ -0,0 +1,39 @@
+
+# UpdateDocumentRequest
+
+Request to update a document
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`type` | [DocumentType](DocumentType.md)
+`description` | string
+
+## Example
+
+```typescript
+import type { UpdateDocumentRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "type": null,
+  "description": null,
+} satisfies UpdateDocumentRequest
+
+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 UpdateDocumentRequest
+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/UploadUrlResponse.md

@@ -0,0 +1,39 @@
+
+# UploadUrlResponse
+
+Presigned upload URL
+
+## Properties
+
+Name | Type
+------------ | -------------
+`uploadUrl` | string
+`fileKey` | string
+`expiresAt` | Date
+
+## Example
+
+```typescript
+import type { UploadUrlResponse } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "uploadUrl": null,
+  "fileKey": null,
+  "expiresAt": null,
+} satisfies UploadUrlResponse
+
+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 UploadUrlResponse
+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/index.ts

@@ -0,0 +1,5 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './runtime';
+export * from './apis/index';
+export * from './models/index';

package/src/generated/document/models/CreateDocument400Response.ts

@@ -0,0 +1,101 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Document API
+ * API for managing documents and attachments
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { CreateDocument400ResponseViolationsInner } from './CreateDocument400ResponseViolationsInner';
+import {
+    CreateDocument400ResponseViolationsInnerFromJSON,
+    CreateDocument400ResponseViolationsInnerFromJSONTyped,
+    CreateDocument400ResponseViolationsInnerToJSON,
+    CreateDocument400ResponseViolationsInnerToJSONTyped,
+} from './CreateDocument400ResponseViolationsInner';
+
+/**
+ * Validation error response
+ * @export
+ * @interface CreateDocument400Response
+ */
+export interface CreateDocument400Response {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateDocument400Response
+     */
+    errorCode: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateDocument400Response
+     */
+    message: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof CreateDocument400Response
+     */
+    timestamp: Date;
+    /**
+     * 
+     * @type {Array<CreateDocument400ResponseViolationsInner>}
+     * @memberof CreateDocument400Response
+     */
+    violations: Array<CreateDocument400ResponseViolationsInner>;
+}
+
+/**
+ * Check if a given object implements the CreateDocument400Response interface.
+ */
+export function instanceOfCreateDocument400Response(value: object): value is CreateDocument400Response {
+    if (!('errorCode' in value) || value['errorCode'] === undefined) return false;
+    if (!('message' in value) || value['message'] === undefined) return false;
+    if (!('timestamp' in value) || value['timestamp'] === undefined) return false;
+    if (!('violations' in value) || value['violations'] === undefined) return false;
+    return true;
+}
+
+export function CreateDocument400ResponseFromJSON(json: any): CreateDocument400Response {
+    return CreateDocument400ResponseFromJSONTyped(json, false);
+}
+
+export function CreateDocument400ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateDocument400Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'errorCode': json['error_code'],
+        'message': json['message'],
+        'timestamp': (new Date(json['timestamp'])),
+        'violations': ((json['violations'] as Array<any>).map(CreateDocument400ResponseViolationsInnerFromJSON)),
+    };
+}
+
+export function CreateDocument400ResponseToJSON(json: any): CreateDocument400Response {
+    return CreateDocument400ResponseToJSONTyped(json, false);
+}
+
+export function CreateDocument400ResponseToJSONTyped(value?: CreateDocument400Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'error_code': value['errorCode'],
+        'message': value['message'],
+        'timestamp': value['timestamp'].toISOString(),
+        'violations': ((value['violations'] as Array<any>).map(CreateDocument400ResponseViolationsInnerToJSON)),
+    };
+}
+

package/src/generated/document/models/CreateDocument400ResponseViolationsInner.ts

@@ -0,0 +1,75 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Document API
+ * API for managing documents and attachments
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Validation violation for a specific field
+ * @export
+ * @interface CreateDocument400ResponseViolationsInner
+ */
+export interface CreateDocument400ResponseViolationsInner {
+    /**
+     * Name of the field with violation
+     * @type {string}
+     * @memberof CreateDocument400ResponseViolationsInner
+     */
+    field: string;
+    /**
+     * Description of the violation
+     * @type {string}
+     * @memberof CreateDocument400ResponseViolationsInner
+     */
+    message: string;
+}
+
+/**
+ * Check if a given object implements the CreateDocument400ResponseViolationsInner interface.
+ */
+export function instanceOfCreateDocument400ResponseViolationsInner(value: object): value is CreateDocument400ResponseViolationsInner {
+    if (!('field' in value) || value['field'] === undefined) return false;
+    if (!('message' in value) || value['message'] === undefined) return false;
+    return true;
+}
+
+export function CreateDocument400ResponseViolationsInnerFromJSON(json: any): CreateDocument400ResponseViolationsInner {
+    return CreateDocument400ResponseViolationsInnerFromJSONTyped(json, false);
+}
+
+export function CreateDocument400ResponseViolationsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateDocument400ResponseViolationsInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'field': json['field'],
+        'message': json['message'],
+    };
+}
+
+export function CreateDocument400ResponseViolationsInnerToJSON(json: any): CreateDocument400ResponseViolationsInner {
+    return CreateDocument400ResponseViolationsInnerToJSONTyped(json, false);
+}
+
+export function CreateDocument400ResponseViolationsInnerToJSONTyped(value?: CreateDocument400ResponseViolationsInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'field': value['field'],
+        'message': value['message'],
+    };
+}
+

package/src/generated/document/models/CreateDocumentRequest.ts

@@ -0,0 +1,126 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Document API
+ * API for managing documents and attachments
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { DocumentType } from './DocumentType';
+import {
+    DocumentTypeFromJSON,
+    DocumentTypeFromJSONTyped,
+    DocumentTypeToJSON,
+    DocumentTypeToJSONTyped,
+} from './DocumentType';
+
+/**
+ * Request to create a document
+ * @export
+ * @interface CreateDocumentRequest
+ */
+export interface CreateDocumentRequest {
+    /**
+     * ID of the client this document belongs to
+     * @type {string}
+     * @memberof CreateDocumentRequest
+     */
+    clientId: string;
+    /**
+     * ID of the campaign this document is associated with
+     * @type {string}
+     * @memberof CreateDocumentRequest
+     */
+    campaignId?: string;
+    /**
+     * Document name
+     * @type {string}
+     * @memberof CreateDocumentRequest
+     */
+    name: string;
+    /**
+     * MIME type of the document
+     * @type {string}
+     * @memberof CreateDocumentRequest
+     */
+    contentType: string;
+    /**
+     * File size in bytes
+     * @type {number}
+     * @memberof CreateDocumentRequest
+     */
+    fileSize?: number;
+    /**
+     * 
+     * @type {DocumentType}
+     * @memberof CreateDocumentRequest
+     */
+    type?: DocumentType;
+    /**
+     * Document description
+     * @type {string}
+     * @memberof CreateDocumentRequest
+     */
+    description?: string;
+}
+
+
+
+/**
+ * Check if a given object implements the CreateDocumentRequest interface.
+ */
+export function instanceOfCreateDocumentRequest(value: object): value is CreateDocumentRequest {
+    if (!('clientId' in value) || value['clientId'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('contentType' in value) || value['contentType'] === undefined) return false;
+    return true;
+}
+
+export function CreateDocumentRequestFromJSON(json: any): CreateDocumentRequest {
+    return CreateDocumentRequestFromJSONTyped(json, false);
+}
+
+export function CreateDocumentRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateDocumentRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'clientId': json['client_id'],
+        'campaignId': json['campaign_id'] == null ? undefined : json['campaign_id'],
+        'name': json['name'],
+        'contentType': json['content_type'],
+        'fileSize': json['file_size'] == null ? undefined : json['file_size'],
+        'type': json['type'] == null ? undefined : DocumentTypeFromJSON(json['type']),
+        'description': json['description'] == null ? undefined : json['description'],
+    };
+}
+
+export function CreateDocumentRequestToJSON(json: any): CreateDocumentRequest {
+    return CreateDocumentRequestToJSONTyped(json, false);
+}
+
+export function CreateDocumentRequestToJSONTyped(value?: CreateDocumentRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'client_id': value['clientId'],
+        'campaign_id': value['campaignId'],
+        'name': value['name'],
+        'content_type': value['contentType'],
+        'file_size': value['fileSize'],
+        'type': DocumentTypeToJSON(value['type']),
+        'description': value['description'],
+    };
+}
+

package/src/generated/document/models/DocumentResponse.ts

@@ -0,0 +1,169 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Document API
+ * API for managing documents and attachments
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { DocumentType } from './DocumentType';
+import {
+    DocumentTypeFromJSON,
+    DocumentTypeFromJSONTyped,
+    DocumentTypeToJSON,
+    DocumentTypeToJSONTyped,
+} from './DocumentType';
+
+/**
+ * Document information
+ * @export
+ * @interface DocumentResponse
+ */
+export interface DocumentResponse {
+    /**
+     * Document unique identifier
+     * @type {string}
+     * @memberof DocumentResponse
+     */
+    id: string;
+    /**
+     * ID of the owning client
+     * @type {string}
+     * @memberof DocumentResponse
+     */
+    clientId: string;
+    /**
+     * ID of the associated campaign
+     * @type {string}
+     * @memberof DocumentResponse
+     */
+    campaignId?: string;
+    /**
+     * Document name
+     * @type {string}
+     * @memberof DocumentResponse
+     */
+    name: string;
+    /**
+     * S3 file key
+     * @type {string}
+     * @memberof DocumentResponse
+     */
+    fileKey?: string;
+    /**
+     * URL to access the document
+     * @type {string}
+     * @memberof DocumentResponse
+     */
+    fileUrl?: string;
+    /**
+     * MIME type of the document
+     * @type {string}
+     * @memberof DocumentResponse
+     */
+    contentType?: string;
+    /**
+     * File size in bytes
+     * @type {number}
+     * @memberof DocumentResponse
+     */
+    fileSize?: number;
+    /**
+     * 
+     * @type {DocumentType}
+     * @memberof DocumentResponse
+     */
+    type: DocumentType;
+    /**
+     * Document description
+     * @type {string}
+     * @memberof DocumentResponse
+     */
+    description?: string;
+    /**
+     * Creation timestamp
+     * @type {Date}
+     * @memberof DocumentResponse
+     */
+    createdAt: Date;
+    /**
+     * Last modification timestamp
+     * @type {Date}
+     * @memberof DocumentResponse
+     */
+    lastModifiedAt: Date;
+}
+
+
+
+/**
+ * Check if a given object implements the DocumentResponse interface.
+ */
+export function instanceOfDocumentResponse(value: object): value is DocumentResponse {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('clientId' in value) || value['clientId'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('lastModifiedAt' in value) || value['lastModifiedAt'] === undefined) return false;
+    return true;
+}
+
+export function DocumentResponseFromJSON(json: any): DocumentResponse {
+    return DocumentResponseFromJSONTyped(json, false);
+}
+
+export function DocumentResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DocumentResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'clientId': json['client_id'],
+        'campaignId': json['campaign_id'] == null ? undefined : json['campaign_id'],
+        'name': json['name'],
+        'fileKey': json['file_key'] == null ? undefined : json['file_key'],
+        'fileUrl': json['file_url'] == null ? undefined : json['file_url'],
+        'contentType': json['content_type'] == null ? undefined : json['content_type'],
+        'fileSize': json['file_size'] == null ? undefined : json['file_size'],
+        'type': DocumentTypeFromJSON(json['type']),
+        'description': json['description'] == null ? undefined : json['description'],
+        'createdAt': (new Date(json['created_at'])),
+        'lastModifiedAt': (new Date(json['last_modified_at'])),
+    };
+}
+
+export function DocumentResponseToJSON(json: any): DocumentResponse {
+    return DocumentResponseToJSONTyped(json, false);
+}
+
+export function DocumentResponseToJSONTyped(value?: DocumentResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'client_id': value['clientId'],
+        'campaign_id': value['campaignId'],
+        'name': value['name'],
+        'file_key': value['fileKey'],
+        'file_url': value['fileUrl'],
+        'content_type': value['contentType'],
+        'file_size': value['fileSize'],
+        'type': DocumentTypeToJSON(value['type']),
+        'description': value['description'],
+        'created_at': value['createdAt'].toISOString(),
+        'last_modified_at': value['lastModifiedAt'].toISOString(),
+    };
+}
+

package/src/generated/document/models/DocumentType.ts

@@ -0,0 +1,56 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Street Level - Document API
+ * API for managing documents and attachments
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * Type of document
+ * @export
+ */
+export const DocumentType = {
+    Contract: 'CONTRACT',
+    Invoice: 'INVOICE',
+    Receipt: 'RECEIPT',
+    Report: 'REPORT',
+    Other: 'OTHER'
+} as const;
+export type DocumentType = typeof DocumentType[keyof typeof DocumentType];
+
+
+export function instanceOfDocumentType(value: any): boolean {
+    for (const key in DocumentType) {
+        if (Object.prototype.hasOwnProperty.call(DocumentType, key)) {
+            if (DocumentType[key as keyof typeof DocumentType] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function DocumentTypeFromJSON(json: any): DocumentType {
+    return DocumentTypeFromJSONTyped(json, false);
+}
+
+export function DocumentTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): DocumentType {
+    return json as DocumentType;
+}
+
+export function DocumentTypeToJSON(value?: DocumentType | null): any {
+    return value as any;
+}
+
+export function DocumentTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): DocumentType {
+    return value as DocumentType;
+}
+