@vaultgig/vaultgig-api-client 0.0.1

package/docs/ContractorData.md

@@ -0,0 +1,35 @@
+
+# ContractorData
+
+Model representing a contractor response.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`contractor` | [ContractorResponse](ContractorResponse.md)
+
+## Example
+
+```typescript
+import type { ContractorData } from '@vaultgig/vaultgig-api-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "contractor": null,
+} satisfies ContractorData
+
+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 ContractorData
+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/ContractorResponse.md

@@ -0,0 +1,53 @@
+
+# ContractorResponse
+
+Response model representing a contractor.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`clerkUserId` | string
+`fullName` | string
+`businessName` | string
+`email` | string
+`phoneNumber` | string
+`status` | [ContractorStatus](ContractorStatus.md)
+`contractorType` | [ContractorType](ContractorType.md)
+`lastPayment` | Date
+`organizationId` | string
+
+## Example
+
+```typescript
+import type { ContractorResponse } from '@vaultgig/vaultgig-api-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "clerkUserId": null,
+  "fullName": null,
+  "businessName": null,
+  "email": null,
+  "phoneNumber": null,
+  "status": null,
+  "contractorType": null,
+  "lastPayment": null,
+  "organizationId": null,
+} satisfies ContractorResponse
+
+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 ContractorResponse
+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/ContractorStatus.md

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

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

@@ -0,0 +1,59 @@
+
+# ContractorUpdatePayload
+
+Model representing contractor data received from the client to update.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`userId` | string
+`name` | string
+`email` | string
+`country` | string
+`phoneNumber` | string
+`taxId` | string
+`tinType` | [TinType](TinType.md)
+`address` | string
+`state` | string
+`zipCode` | string
+`city` | string
+`classificationType` | [BusinessClassification](BusinessClassification.md)
+`businessName` | string
+
+## Example
+
+```typescript
+import type { ContractorUpdatePayload } from '@vaultgig/vaultgig-api-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "userId": null,
+  "name": null,
+  "email": null,
+  "country": null,
+  "phoneNumber": null,
+  "taxId": null,
+  "tinType": null,
+  "address": null,
+  "state": null,
+  "zipCode": null,
+  "city": null,
+  "classificationType": null,
+  "businessName": null,
+} satisfies ContractorUpdatePayload
+
+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 ContractorUpdatePayload
+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/ContractorsApi.md

@@ -0,0 +1,308 @@
+# ContractorsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createContractor**](ContractorsApi.md#createcontractor) | **POST** /organization/{organization_id}/contractors | Create Contractor |
+| [**getContractor**](ContractorsApi.md#getcontractor) | **GET** /organization/{organization_id}/contractors/{contractor_id} | Get Contractor |
+| [**getContractors**](ContractorsApi.md#getcontractors) | **GET** /organization/{organization_id}/contractors | Get Contractors |
+| [**updateContractor**](ContractorsApi.md#updatecontractor) | **PUT** /organization/{organization_id}/contractors/{contractor_id} | Update Contractor |
+
+
+
+## createContractor
+
+> ResponseContractorCreateData createContractor(organizationId, contractorCreatePayload)
+
+Create Contractor
+
+Create a contractor.  Args:     organization: The organization to update     contractor: The contractor data to update
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContractorsApi,
+} from '@vaultgig/vaultgig-api-client';
+import type { CreateContractorRequest } from '@vaultgig/vaultgig-api-client';
+
+async function example() {
+  console.log("🚀 Testing @vaultgig/vaultgig-api-client SDK...");
+  const api = new ContractorsApi();
+
+  const body = {
+    // string
+    organizationId: organizationId_example,
+    // ContractorCreatePayload
+    contractorCreatePayload: ...,
+  } satisfies CreateContractorRequest;
+
+  try {
+    const data = await api.createContractor(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **organizationId** | `string` |  | [Defaults to `undefined`] |
+| **contractorCreatePayload** | [ContractorCreatePayload](ContractorCreatePayload.md) |  | |
+
+### Return type
+
+[**ResponseContractorCreateData**](ResponseContractorCreateData.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **422** | 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)
+
+
+## getContractor
+
+> ResponseContractorData getContractor(contractorId, organizationId)
+
+Get Contractor
+
+Get a contractor by ID.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContractorsApi,
+} from '@vaultgig/vaultgig-api-client';
+import type { GetContractorRequest } from '@vaultgig/vaultgig-api-client';
+
+async function example() {
+  console.log("🚀 Testing @vaultgig/vaultgig-api-client SDK...");
+  const api = new ContractorsApi();
+
+  const body = {
+    // string
+    contractorId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string
+    organizationId: organizationId_example,
+  } satisfies GetContractorRequest;
+
+  try {
+    const data = await api.getContractor(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **contractorId** | `string` |  | [Defaults to `undefined`] |
+| **organizationId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**ResponseContractorData**](ResponseContractorData.md)
+
+### 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 |  -  |
+| **422** | 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)
+
+
+## getContractors
+
+> ResponsePaginatedResponseContractorResponse getContractors(organizationId, limit, offset, tag, search)
+
+Get Contractors
+
+Get all contractors for an organization.  Args:     organization: The organization to get contractors for     session: The database session
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContractorsApi,
+} from '@vaultgig/vaultgig-api-client';
+import type { GetContractorsRequest } from '@vaultgig/vaultgig-api-client';
+
+async function example() {
+  console.log("🚀 Testing @vaultgig/vaultgig-api-client SDK...");
+  const api = new ContractorsApi();
+
+  const body = {
+    // string
+    organizationId: organizationId_example,
+    // number (optional)
+    limit: 56,
+    // number (optional)
+    offset: 56,
+    // string | Filter contractors by tag (optional)
+    tag: tag_example,
+    // string | Search contractors by full name (optional)
+    search: search_example,
+  } satisfies GetContractorsRequest;
+
+  try {
+    const data = await api.getContractors(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **organizationId** | `string` |  | [Defaults to `undefined`] |
+| **limit** | `number` |  | [Optional] [Defaults to `20`] |
+| **offset** | `number` |  | [Optional] [Defaults to `0`] |
+| **tag** | `string` | Filter contractors by tag | [Optional] [Defaults to `undefined`] |
+| **search** | `string` | Search contractors by full name | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**ResponsePaginatedResponseContractorResponse**](ResponsePaginatedResponseContractorResponse.md)
+
+### 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 |  -  |
+| **422** | 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)
+
+
+## updateContractor
+
+> SuccessResponse updateContractor(contractorId, organizationId, contractorUpdatePayload)
+
+Update Contractor
+
+Update a contractor.  Args:     organization: The organization to update     contractor_id: The ID of the contractor to update     contractor: The contractor data to update
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContractorsApi,
+} from '@vaultgig/vaultgig-api-client';
+import type { UpdateContractorRequest } from '@vaultgig/vaultgig-api-client';
+
+async function example() {
+  console.log("🚀 Testing @vaultgig/vaultgig-api-client SDK...");
+  const api = new ContractorsApi();
+
+  const body = {
+    // string
+    contractorId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string
+    organizationId: organizationId_example,
+    // ContractorUpdatePayload
+    contractorUpdatePayload: ...,
+  } satisfies UpdateContractorRequest;
+
+  try {
+    const data = await api.updateContractor(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **contractorId** | `string` |  | [Defaults to `undefined`] |
+| **organizationId** | `string` |  | [Defaults to `undefined`] |
+| **contractorUpdatePayload** | [ContractorUpdatePayload](ContractorUpdatePayload.md) |  | |
+
+### Return type
+
+[**SuccessResponse**](SuccessResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **422** | 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)
+

package/docs/HTTPValidationError.md

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

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

@@ -0,0 +1,39 @@
+
+# PaginationMeta
+
+Pagination metadata model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`offset` | number
+`limit` | number
+`total` | number
+
+## Example
+
+```typescript
+import type { PaginationMeta } from '@vaultgig/vaultgig-api-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "offset": null,
+  "limit": null,
+  "total": null,
+} satisfies PaginationMeta
+
+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 PaginationMeta
+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/ResponseContractorCreateData.md

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