@testcollab/sdk 3.1.1

package/docs/StatusesApi.md

@@ -0,0 +1,427 @@
+# StatusesApi
+
+All URIs are relative to *https://api.testcollab.io*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createStatus**](StatusesApi.md#createstatus) | **POST** /statuses | Create a custom status |
+| [**deleteStatusById**](StatusesApi.md#deletestatusbyid) | **DELETE** /statuses/{statusId} | Delete a custom status by ID |
+| [**getStatusById**](StatusesApi.md#getstatusbyid) | **GET** /statuses/{statusId} | Get a specific status by ID |
+| [**getStatuses**](StatusesApi.md#getstatuses) | **GET** /statuses | List statuses |
+| [**updateStatusById**](StatusesApi.md#updatestatusbyid) | **PUT** /statuses/{statusId} | Update a status by ID |
+
+
+
+## createStatus
+
+> Status createStatus(statusCreatePayload, project)
+
+Create a custom status
+
+Adds a new custom status, associating it with a project specified in the payload or query.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  StatusesApi,
+} from '@testcollab/sdk';
+import type { CreateStatusRequest } from '@testcollab/sdk';
+
+async function example() {
+  console.log("🚀 Testing @testcollab/sdk SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: bearerAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new StatusesApi(config);
+
+  const body = {
+    // StatusCreatePayload
+    statusCreatePayload: ...,
+    // number | ID of the project this status belongs to.
+    project: 789,
+  } satisfies CreateStatusRequest;
+
+  try {
+    const data = await api.createStatus(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **statusCreatePayload** | [StatusCreatePayload](StatusCreatePayload.md) |  | |
+| **project** | `number` | ID of the project this status belongs to. | [Defaults to `undefined`] |
+
+### Return type
+
+[**Status**](Status.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Custom status created successfully. |  -  |
+| **400** | Bad request - Invalid input data or missing project ID |  -  |
+| **401** | Unauthorized - Authentication required |  -  |
+| **403** | Forbidden - User does not have permission to create statuses |  -  |
+| **0** | Unexpected error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deleteStatusById
+
+> deleteStatusById(statusId, project)
+
+Delete a custom status by ID
+
+Deletes a custom status. System statuses cannot be deleted. Project context might be required.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  StatusesApi,
+} from '@testcollab/sdk';
+import type { DeleteStatusByIdRequest } from '@testcollab/sdk';
+
+async function example() {
+  console.log("🚀 Testing @testcollab/sdk SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: bearerAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new StatusesApi(config);
+
+  const body = {
+    // number | ID of the custom status to delete.
+    statusId: 789,
+    // number | ID of the project for context (if status is project-specific and needs auth check). (optional)
+    project: 789,
+  } satisfies DeleteStatusByIdRequest;
+
+  try {
+    const data = await api.deleteStatusById(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **statusId** | `number` | ID of the custom status to delete. | [Defaults to `undefined`] |
+| **project** | `number` | ID of the project for context (if status is project-specific and needs auth check). | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Status deleted successfully. |  -  |
+| **400** | Bad request - Cannot delete a system status. |  -  |
+| **401** | Unauthorized - Authentication required |  -  |
+| **403** | Forbidden - User does not have permission to delete this status |  -  |
+| **404** | Status not found |  -  |
+| **0** | Unexpected error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getStatusById
+
+> Status getStatusById(statusId, project)
+
+Get a specific status by ID
+
+Retrieves details of a specific status by its ID. Project context might be required for authorization.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  StatusesApi,
+} from '@testcollab/sdk';
+import type { GetStatusByIdRequest } from '@testcollab/sdk';
+
+async function example() {
+  console.log("🚀 Testing @testcollab/sdk SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: bearerAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new StatusesApi(config);
+
+  const body = {
+    // number | ID of the status to retrieve.
+    statusId: 789,
+    // number | ID of the project for context (if status is project-specific and needs auth check). (optional)
+    project: 789,
+  } satisfies GetStatusByIdRequest;
+
+  try {
+    const data = await api.getStatusById(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **statusId** | `number` | ID of the status to retrieve. | [Defaults to `undefined`] |
+| **project** | `number` | ID of the project for context (if status is project-specific and needs auth check). | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**Status**](Status.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Details of the status. |  -  |
+| **401** | Unauthorized - Authentication required |  -  |
+| **403** | Forbidden - User does not have access |  -  |
+| **404** | Status not found |  -  |
+| **0** | Unexpected error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getStatuses
+
+> Array<Status> getStatuses(project, isActive, limit, start, sort)
+
+List statuses
+
+Retrieves all statuses (system and custom), optionally filtered by project.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  StatusesApi,
+} from '@testcollab/sdk';
+import type { GetStatusesRequest } from '@testcollab/sdk';
+
+async function example() {
+  console.log("🚀 Testing @testcollab/sdk SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: bearerAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new StatusesApi(config);
+
+  const body = {
+    // number | ID of the project to filter statuses for.
+    project: 789,
+    // boolean | Filter statuses by active state. (optional)
+    isActive: true,
+    // number (optional)
+    limit: 56,
+    // number (optional)
+    start: 56,
+    // string (optional)
+    sort: sort_example,
+  } satisfies GetStatusesRequest;
+
+  try {
+    const data = await api.getStatuses(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **project** | `number` | ID of the project to filter statuses for. | [Defaults to `undefined`] |
+| **isActive** | `boolean` | Filter statuses by active state. | [Optional] [Defaults to `undefined`] |
+| **limit** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **start** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **sort** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<Status>**](Status.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | A list of statuses. |  -  |
+| **400** | Bad request - Missing or invalid project ID |  -  |
+| **401** | Unauthorized - Authentication required |  -  |
+| **403** | Forbidden - User does not have access |  -  |
+| **0** | Unexpected error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updateStatusById
+
+> Status updateStatusById(statusUpdatePayload, statusId, project)
+
+Update a status by ID
+
+Updates an existing status. System statuses have restrictions. Project context might be required.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  StatusesApi,
+} from '@testcollab/sdk';
+import type { UpdateStatusByIdRequest } from '@testcollab/sdk';
+
+async function example() {
+  console.log("🚀 Testing @testcollab/sdk SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: bearerAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new StatusesApi(config);
+
+  const body = {
+    // StatusUpdatePayload
+    statusUpdatePayload: ...,
+    // number | ID of the status to update.
+    statusId: 789,
+    // number | ID of the project for context (if status is project-specific and needs auth check). (optional)
+    project: 789,
+  } satisfies UpdateStatusByIdRequest;
+
+  try {
+    const data = await api.updateStatusById(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **statusUpdatePayload** | [StatusUpdatePayload](StatusUpdatePayload.md) |  | |
+| **statusId** | `number` | ID of the status to update. | [Defaults to `undefined`] |
+| **project** | `number` | ID of the project for context (if status is project-specific and needs auth check). | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**Status**](Status.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Status updated successfully. |  -  |
+| **400** | Bad request - Invalid input data or attempt to modify a restricted field on a system status |  -  |
+| **401** | Unauthorized - Authentication required |  -  |
+| **403** | Forbidden - User does not have permission to update this status |  -  |
+| **404** | Status not found |  -  |
+| **0** | Unexpected 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/Step.md

@@ -0,0 +1,38 @@
+
+# Step
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`step` | string
+`expectedResult` | string
+`reusableStepId` | number
+
+## Example
+
+```typescript
+import type { Step } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "step": Step 1,
+  "expectedResult": Expected result 1,
+  "reusableStepId": null,
+} satisfies Step
+
+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 Step
+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/StepParsed.md

@@ -0,0 +1,42 @@
+
+# StepParsed
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`step` | string
+`stepId` | number
+`expectedResult` | string
+`stepIndex` | number
+`parsedReusableStepId` | number
+
+## Example
+
+```typescript
+import type { StepParsed } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "step": Step 1,
+  "stepId": 1,
+  "expectedResult": Expected result 1,
+  "stepIndex": null,
+  "parsedReusableStepId": null,
+} satisfies StepParsed
+
+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 StepParsed
+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/StepWiseResult.md

@@ -0,0 +1,46 @@
+
+# StepWiseResult
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`stepIndex` | number
+`step` | string
+`expectedResult` | string
+`status` | string
+`comment` | string
+`mentions` | Array<string>
+`attachments` | Array<string>
+
+## Example
+
+```typescript
+import type { StepWiseResult } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "stepIndex": 1,
+  "step": Step 1,
+  "expectedResult": Expected result 1,
+  "status": unexecuted,
+  "comment": My comment,
+  "mentions": null,
+  "attachments": null,
+} satisfies StepWiseResult
+
+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 StepWiseResult
+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/StripeCustomer.md

@@ -0,0 +1,46 @@
+
+# StripeCustomer
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`address` | [SubscriptionBillingDetails](SubscriptionBillingDetails.md)
+`created` | string
+`email` | string
+`name` | string
+`invoiceSettings` | [StripeCustomerInvoiceSettings](StripeCustomerInvoiceSettings.md)
+`phone` | string
+
+## Example
+
+```typescript
+import type { StripeCustomer } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": cus_i89j4f94jf94,
+  "address": null,
+  "created": 1588593473,
+  "email": contact@gigapromoters.com,
+  "name": My company,
+  "invoiceSettings": null,
+  "phone": null,
+} satisfies StripeCustomer
+
+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 StripeCustomer
+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/StripeCustomerInvoiceSettings.md

@@ -0,0 +1,34 @@
+
+# StripeCustomerInvoiceSettings
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`defaultPaymentMethod` | [SubscriptionPaymentMethod](SubscriptionPaymentMethod.md)
+
+## Example
+
+```typescript
+import type { StripeCustomerInvoiceSettings } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "defaultPaymentMethod": null,
+} satisfies StripeCustomerInvoiceSettings
+
+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 StripeCustomerInvoiceSettings
+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/StripeInvoice.md

@@ -0,0 +1,64 @@
+
+# StripeInvoice
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`paid` | boolean
+`periodStart` | string
+`periodEnd` | string
+`total` | number
+`postPaymentCreditNotesAmount` | string
+`prePaymentCreditNotesAmount` | string
+`receiptNumber` | string
+`startingBalance` | string
+`statementDescriptor` | string
+`status` | string
+`subscriptionProrationDate` | string
+`subtotal` | number
+`tax` | number
+`taxPercent` | string
+`created` | string
+
+## Example
+
+```typescript
+import type { StripeInvoice } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": in_dfkjr9ur3,
+  "paid": true,
+  "periodStart": 1561117418,
+  "periodEnd": 1563709418,
+  "total": 1500,
+  "postPaymentCreditNotesAmount": 0,
+  "prePaymentCreditNotesAmount": 0,
+  "receiptNumber": null,
+  "startingBalance": 0,
+  "statementDescriptor": null,
+  "status": draft,
+  "subscriptionProrationDate": 1588902209 (Unix timestamp),
+  "subtotal": 89493,
+  "tax": null,
+  "taxPercent": null,
+  "created": 1563709418,
+} satisfies StripeInvoice
+
+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 StripeInvoice
+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)
+
+