@vaultgig/vaultgig-api-client 0.0.1

package/docs/ResponseContractorData.md

@@ -0,0 +1,38 @@
+
+# ResponseContractorData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`data` | [ContractorData](ContractorData.md)
+`error` | string
+
+## Example
+
+```typescript
+import type { ResponseContractorData } from '@vaultgig/vaultgig-api-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": null,
+  "data": null,
+  "error": null,
+} satisfies ResponseContractorData
+
+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 ResponseContractorData
+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/ResponsePaginatedResponseContractorResponse.md

@@ -0,0 +1,38 @@
+
+# ResponsePaginatedResponseContractorResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`data` | [PaginatedResponseContractorResponse](PaginatedResponseContractorResponse.md)
+`error` | string
+
+## Example
+
+```typescript
+import type { ResponsePaginatedResponseContractorResponse } from '@vaultgig/vaultgig-api-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": null,
+  "data": null,
+  "error": null,
+} satisfies ResponsePaginatedResponseContractorResponse
+
+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 ResponsePaginatedResponseContractorResponse
+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/SchemaApi.md

@@ -0,0 +1,68 @@
+# SchemaApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getYamlSchema**](SchemaApi.md#getyamlschema) | **GET** /openapi.yaml | Get Yaml Schema |
+
+
+
+## getYamlSchema
+
+> any getYamlSchema()
+
+Get Yaml Schema
+
+Get the YAML representation of the OpenAPI schema. Used by the client SDK builder.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SchemaApi,
+} from '@vaultgig/vaultgig-api-client';
+import type { GetYamlSchemaRequest } from '@vaultgig/vaultgig-api-client';
+
+async function example() {
+  console.log("🚀 Testing @vaultgig/vaultgig-api-client SDK...");
+  const api = new SchemaApi();
+
+  try {
+    const data = await api.getYamlSchema();
+    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
+
+**any**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+
+[[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/SuccessResponse.md

@@ -0,0 +1,37 @@
+
+# SuccessResponse
+
+Success response without data.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`error` | string
+
+## Example
+
+```typescript
+import type { SuccessResponse } from '@vaultgig/vaultgig-api-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": null,
+  "error": null,
+} satisfies SuccessResponse
+
+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 SuccessResponse
+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/TinType.md

@@ -0,0 +1,33 @@
+
+# TinType
+
+TIN type.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { TinType } from '@vaultgig/vaultgig-api-client'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies TinType
+
+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 TinType
+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/ValidationError.md

@@ -0,0 +1,38 @@
+
+# ValidationError
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`loc` | [Array<ValidationErrorLocInner>](ValidationErrorLocInner.md)
+`msg` | string
+`type` | string
+
+## Example
+
+```typescript
+import type { ValidationError } from '@vaultgig/vaultgig-api-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "loc": null,
+  "msg": null,
+  "type": null,
+} satisfies ValidationError
+
+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 ValidationError
+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/ValidationErrorLocInner.md

@@ -0,0 +1,32 @@
+
+# ValidationErrorLocInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { ValidationErrorLocInner } from '@vaultgig/vaultgig-api-client'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies ValidationErrorLocInner
+
+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 ValidationErrorLocInner
+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/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@vaultgig/vaultgig-api-client",
+  "version": "0.0.1",
+  "description": "OpenAPI client for @vaultgig/vaultgig-api-client",
+  "author": "OpenAPI-Generator",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "prepare": "npm run build"
+  },
+  "devDependencies": {
+    "typescript": "^4.0 || ^5.0"
+  }
+}

package/src/apis/ContractorsApi.ts

@@ -0,0 +1,280 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * VaultGig API
+ * API for VaultGig contractor management system
+ *
+ * The version of the OpenAPI document: 1.0.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 * as runtime from '../runtime';
+import type {
+  ContractorCreatePayload,
+  ContractorUpdatePayload,
+  HTTPValidationError,
+  ResponseContractorCreateData,
+  ResponseContractorData,
+  ResponsePaginatedResponseContractorResponse,
+  SuccessResponse,
+} from '../models/index';
+import {
+    ContractorCreatePayloadFromJSON,
+    ContractorCreatePayloadToJSON,
+    ContractorUpdatePayloadFromJSON,
+    ContractorUpdatePayloadToJSON,
+    HTTPValidationErrorFromJSON,
+    HTTPValidationErrorToJSON,
+    ResponseContractorCreateDataFromJSON,
+    ResponseContractorCreateDataToJSON,
+    ResponseContractorDataFromJSON,
+    ResponseContractorDataToJSON,
+    ResponsePaginatedResponseContractorResponseFromJSON,
+    ResponsePaginatedResponseContractorResponseToJSON,
+    SuccessResponseFromJSON,
+    SuccessResponseToJSON,
+} from '../models/index';
+
+export interface CreateContractorRequest {
+    organizationId: string;
+    contractorCreatePayload: ContractorCreatePayload;
+}
+
+export interface GetContractorRequest {
+    contractorId: string;
+    organizationId: string;
+}
+
+export interface GetContractorsRequest {
+    organizationId: string;
+    limit?: number;
+    offset?: number;
+    tag?: string | null;
+    search?: string | null;
+}
+
+export interface UpdateContractorRequest {
+    contractorId: string;
+    organizationId: string;
+    contractorUpdatePayload: ContractorUpdatePayload;
+}
+
+/**
+ * 
+ */
+export class ContractorsApi extends runtime.BaseAPI {
+
+    /**
+     * Create a contractor.  Args:     organization: The organization to update     contractor: The contractor data to update
+     * Create Contractor
+     */
+    async createContractorRaw(requestParameters: CreateContractorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResponseContractorCreateData>> {
+        if (requestParameters['organizationId'] == null) {
+            throw new runtime.RequiredError(
+                'organizationId',
+                'Required parameter "organizationId" was null or undefined when calling createContractor().'
+            );
+        }
+
+        if (requestParameters['contractorCreatePayload'] == null) {
+            throw new runtime.RequiredError(
+                'contractorCreatePayload',
+                'Required parameter "contractorCreatePayload" was null or undefined when calling createContractor().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/organization/{organization_id}/contractors`;
+        urlPath = urlPath.replace(`{${"organization_id"}}`, encodeURIComponent(String(requestParameters['organizationId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ContractorCreatePayloadToJSON(requestParameters['contractorCreatePayload']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ResponseContractorCreateDataFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a contractor.  Args:     organization: The organization to update     contractor: The contractor data to update
+     * Create Contractor
+     */
+    async createContractor(requestParameters: CreateContractorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResponseContractorCreateData> {
+        const response = await this.createContractorRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get a contractor by ID.
+     * Get Contractor
+     */
+    async getContractorRaw(requestParameters: GetContractorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResponseContractorData>> {
+        if (requestParameters['contractorId'] == null) {
+            throw new runtime.RequiredError(
+                'contractorId',
+                'Required parameter "contractorId" was null or undefined when calling getContractor().'
+            );
+        }
+
+        if (requestParameters['organizationId'] == null) {
+            throw new runtime.RequiredError(
+                'organizationId',
+                'Required parameter "organizationId" was null or undefined when calling getContractor().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/organization/{organization_id}/contractors/{contractor_id}`;
+        urlPath = urlPath.replace(`{${"contractor_id"}}`, encodeURIComponent(String(requestParameters['contractorId'])));
+        urlPath = urlPath.replace(`{${"organization_id"}}`, encodeURIComponent(String(requestParameters['organizationId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ResponseContractorDataFromJSON(jsonValue));
+    }
+
+    /**
+     * Get a contractor by ID.
+     * Get Contractor
+     */
+    async getContractor(requestParameters: GetContractorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResponseContractorData> {
+        const response = await this.getContractorRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get all contractors for an organization.  Args:     organization: The organization to get contractors for     session: The database session
+     * Get Contractors
+     */
+    async getContractorsRaw(requestParameters: GetContractorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResponsePaginatedResponseContractorResponse>> {
+        if (requestParameters['organizationId'] == null) {
+            throw new runtime.RequiredError(
+                'organizationId',
+                'Required parameter "organizationId" was null or undefined when calling getContractors().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        if (requestParameters['offset'] != null) {
+            queryParameters['offset'] = requestParameters['offset'];
+        }
+
+        if (requestParameters['tag'] != null) {
+            queryParameters['tag'] = requestParameters['tag'];
+        }
+
+        if (requestParameters['search'] != null) {
+            queryParameters['search'] = requestParameters['search'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/organization/{organization_id}/contractors`;
+        urlPath = urlPath.replace(`{${"organization_id"}}`, encodeURIComponent(String(requestParameters['organizationId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ResponsePaginatedResponseContractorResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Get all contractors for an organization.  Args:     organization: The organization to get contractors for     session: The database session
+     * Get Contractors
+     */
+    async getContractors(requestParameters: GetContractorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResponsePaginatedResponseContractorResponse> {
+        const response = await this.getContractorsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Update a contractor.  Args:     organization: The organization to update     contractor_id: The ID of the contractor to update     contractor: The contractor data to update
+     * Update Contractor
+     */
+    async updateContractorRaw(requestParameters: UpdateContractorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessResponse>> {
+        if (requestParameters['contractorId'] == null) {
+            throw new runtime.RequiredError(
+                'contractorId',
+                'Required parameter "contractorId" was null or undefined when calling updateContractor().'
+            );
+        }
+
+        if (requestParameters['organizationId'] == null) {
+            throw new runtime.RequiredError(
+                'organizationId',
+                'Required parameter "organizationId" was null or undefined when calling updateContractor().'
+            );
+        }
+
+        if (requestParameters['contractorUpdatePayload'] == null) {
+            throw new runtime.RequiredError(
+                'contractorUpdatePayload',
+                'Required parameter "contractorUpdatePayload" was null or undefined when calling updateContractor().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/organization/{organization_id}/contractors/{contractor_id}`;
+        urlPath = urlPath.replace(`{${"contractor_id"}}`, encodeURIComponent(String(requestParameters['contractorId'])));
+        urlPath = urlPath.replace(`{${"organization_id"}}`, encodeURIComponent(String(requestParameters['organizationId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ContractorUpdatePayloadToJSON(requestParameters['contractorUpdatePayload']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SuccessResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Update a contractor.  Args:     organization: The organization to update     contractor_id: The ID of the contractor to update     contractor: The contractor data to update
+     * Update Contractor
+     */
+    async updateContractor(requestParameters: UpdateContractorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessResponse> {
+        const response = await this.updateContractorRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/SchemaApi.ts

@@ -0,0 +1,58 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * VaultGig API
+ * API for VaultGig contractor management system
+ *
+ * The version of the OpenAPI document: 1.0.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 * as runtime from '../runtime';
+
+/**
+ * 
+ */
+export class SchemaApi extends runtime.BaseAPI {
+
+    /**
+     * Get the YAML representation of the OpenAPI schema. Used by the client SDK builder.
+     * Get Yaml Schema
+     */
+    async getYamlSchemaRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<any>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/openapi.yaml`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        if (this.isJsonMime(response.headers.get('content-type'))) {
+            return new runtime.JSONApiResponse<any>(response);
+        } else {
+            return new runtime.TextApiResponse(response) as any;
+        }
+    }
+
+    /**
+     * Get the YAML representation of the OpenAPI schema. Used by the client SDK builder.
+     * Get Yaml Schema
+     */
+    async getYamlSchema(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<any> {
+        const response = await this.getYamlSchemaRaw(initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -0,0 +1,4 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './ContractorsApi';
+export * from './SchemaApi';

package/src/index.ts

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