@testcollab/sdk 3.9.0 → 3.11.0

package/.openapi-generator/FILES

@@ -162,6 +162,7 @@ docs/PreferencePayload.md
 docs/Project.md
 docs/ProjectActivity.md
 docs/ProjectCreatePayload.md
+docs/ProjectListItem.md
 docs/ProjectMetrics.md
 docs/ProjectMini.md
 docs/ProjectMinified.md
@@ -588,6 +589,7 @@ src/models/PreferencePayload.ts
 src/models/Project.ts
 src/models/ProjectActivity.ts
 src/models/ProjectCreatePayload.ts
+src/models/ProjectListItem.ts
 src/models/ProjectMetrics.ts
 src/models/ProjectMini.ts
 src/models/ProjectMinified.ts

package/dist/apis/ProjectsApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { BulkActionResult, Count, Project, ProjectCreatePayload, ProjectPayload } from '../models/index';
+import type { BulkActionResult, Count, Project, ProjectCreatePayload, ProjectListItem, ProjectPayload } from '../models/index';
 export interface ArchiveProjectRequest {
     id: number;
 }
@@ -134,12 +134,12 @@ export interface ProjectsApiInterface {
      * @throws {RequiredError}
      * @memberof ProjectsApiInterface
      */
-    getProjectsRaw(requestParameters: GetProjectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Project>>>;
+    getProjectsRaw(requestParameters: GetProjectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ProjectListItem>>>;
     /**
      * Fetches list of projects
      * Get list of projects
      */
-    getProjects(requestParameters: GetProjectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Project>>;
+    getProjects(requestParameters: GetProjectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ProjectListItem>>;
     /**
      * Populate sample data in project
      * @summary Populate sample data in project
@@ -242,12 +242,12 @@ export declare class ProjectsApi extends runtime.BaseAPI implements ProjectsApiI
      * Fetches list of projects
      * Get list of projects
      */
-    getProjectsRaw(requestParameters: GetProjectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Project>>>;
+    getProjectsRaw(requestParameters: GetProjectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ProjectListItem>>>;
     /**
      * Fetches list of projects
      * Get list of projects
      */
-    getProjects(requestParameters: GetProjectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Project>>;
+    getProjects(requestParameters: GetProjectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ProjectListItem>>;
     /**
      * Populate sample data in project
      * Populate sample data in project

package/dist/apis/ProjectsApi.js

@@ -261,7 +261,7 @@ class ProjectsApi extends runtime.BaseAPI {
                 headers: headerParameters,
                 query: queryParameters,
             }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.ProjectFromJSON));
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.ProjectListItemFromJSON));
         });
     }
     /**

package/dist/esm/apis/ProjectsApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { BulkActionResult, Count, Project, ProjectCreatePayload, ProjectPayload } from '../models/index';
+import type { BulkActionResult, Count, Project, ProjectCreatePayload, ProjectListItem, ProjectPayload } from '../models/index';
 export interface ArchiveProjectRequest {
     id: number;
 }
@@ -134,12 +134,12 @@ export interface ProjectsApiInterface {
      * @throws {RequiredError}
      * @memberof ProjectsApiInterface
      */
-    getProjectsRaw(requestParameters: GetProjectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Project>>>;
+    getProjectsRaw(requestParameters: GetProjectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ProjectListItem>>>;
     /**
      * Fetches list of projects
      * Get list of projects
      */
-    getProjects(requestParameters: GetProjectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Project>>;
+    getProjects(requestParameters: GetProjectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ProjectListItem>>;
     /**
      * Populate sample data in project
      * @summary Populate sample data in project
@@ -242,12 +242,12 @@ export declare class ProjectsApi extends runtime.BaseAPI implements ProjectsApiI
      * Fetches list of projects
      * Get list of projects
      */
-    getProjectsRaw(requestParameters: GetProjectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Project>>>;
+    getProjectsRaw(requestParameters: GetProjectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ProjectListItem>>>;
     /**
      * Fetches list of projects
      * Get list of projects
      */
-    getProjects(requestParameters: GetProjectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Project>>;
+    getProjects(requestParameters: GetProjectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ProjectListItem>>;
     /**
      * Populate sample data in project
      * Populate sample data in project

package/dist/esm/apis/ProjectsApi.js

@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { BulkActionResultFromJSON, CountFromJSON, ProjectFromJSON, ProjectCreatePayloadToJSON, ProjectPayloadToJSON, } from '../models/index';
+import { BulkActionResultFromJSON, CountFromJSON, ProjectFromJSON, ProjectCreatePayloadToJSON, ProjectListItemFromJSON, ProjectPayloadToJSON, } from '../models/index';
 /**
  *
  */
@@ -258,7 +258,7 @@ export class ProjectsApi extends runtime.BaseAPI {
                 headers: headerParameters,
                 query: queryParameters,
             }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ProjectFromJSON));
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ProjectListItemFromJSON));
         });
     }
     /**

package/dist/esm/models/Project.d.ts

@@ -28,6 +28,12 @@ export interface Project {
      * @memberof Project
      */
     name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Project
+     */
+    description?: string;
     /**
      *
      * @type {boolean}

package/dist/esm/models/Project.js

@@ -38,6 +38,7 @@ export function ProjectFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'id': json['id'],
         'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
         'archived': json['archived'],
         'team': json['team'] == null ? undefined : (json['team'].map(ProjectUserMinifiedFromJSON)),
         'activity': json['activity'] == null ? undefined : json['activity'],
@@ -56,6 +57,7 @@ export function ProjectToJSONTyped(value, ignoreDiscriminator = false) {
     return {
         'id': value['id'],
         'name': value['name'],
+        'description': value['description'],
         'archived': value['archived'],
         'team': value['team'] == null ? undefined : (value['team'].map(ProjectUserMinifiedToJSON)),
         'activity': value['activity'],

package/dist/esm/models/ProjectCreatePayload.d.ts

@@ -27,6 +27,12 @@ export interface ProjectCreatePayload {
      * @memberof ProjectCreatePayload
      */
     name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectCreatePayload
+     */
+    description?: string;
     /**
      * Project ID to import users from (only allowed at the time of project create)
      * @type {number}

package/dist/esm/models/ProjectCreatePayload.js

@@ -31,6 +31,7 @@ export function ProjectCreatePayloadFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'id': json['id'] == null ? undefined : json['id'],
         'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
         'importUsers': json['importUsers'] == null ? undefined : json['importUsers'],
         'issueManagerProfile': json['issueManagerProfile'] == null ? undefined : json['issueManagerProfile'],
         'importIssueManagerSettings': json['importIssueManagerSettings'] == null ? undefined : json['importIssueManagerSettings'],
@@ -47,6 +48,7 @@ export function ProjectCreatePayloadToJSONTyped(value, ignoreDiscriminator = fal
     return {
         'id': value['id'],
         'name': value['name'],
+        'description': value['description'],
         'importUsers': value['importUsers'],
         'issueManagerProfile': value['issueManagerProfile'],
         'importIssueManagerSettings': value['importIssueManagerSettings'],

package/dist/esm/models/ProjectListItem.d.ts

@@ -0,0 +1,93 @@
+/**
+ * TC API
+ * TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2.   # Authentication TestCollab supports two forms of authentication:   - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token>    - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API.     Send this token as the Authorization header while making requests to protected resources:     `Authorization: Bearer <token>`    For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it.      # Error Handling Error responses   - `Not Found` - Error is sent when requested resource is not available.   - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401        - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
+ *
+ * The version of the OpenAPI document: 2.3.1
+ * Contact: support@testcollab.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { ProjectUserMinified } from './ProjectUserMinified';
+/**
+ *
+ * @export
+ * @interface ProjectListItem
+ */
+export interface ProjectListItem {
+    /**
+     *
+     * @type {number}
+     * @memberof ProjectListItem
+     */
+    id: number;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectListItem
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectListItem
+     */
+    description?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ProjectListItem
+     */
+    archived: boolean;
+    /**
+     *
+     * @type {Array<ProjectUserMinified>}
+     * @memberof ProjectListItem
+     */
+    team?: Array<ProjectUserMinified>;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectListItem
+     */
+    activity?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectListItem
+     */
+    createdAt: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectListItem
+     */
+    updatedAt: string;
+    /**
+     * Indicates that the project is a sample project or not
+     * @type {boolean}
+     * @memberof ProjectListItem
+     */
+    isSample?: boolean;
+    /**
+     * Number of test cases in the project
+     * @type {number}
+     * @memberof ProjectListItem
+     */
+    testCaseCount?: number;
+    /**
+     * Number of active test plans in the project
+     * @type {number}
+     * @memberof ProjectListItem
+     */
+    testPlanCount?: number;
+}
+/**
+ * Check if a given object implements the ProjectListItem interface.
+ */
+export declare function instanceOfProjectListItem(value: object): value is ProjectListItem;
+export declare function ProjectListItemFromJSON(json: any): ProjectListItem;
+export declare function ProjectListItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProjectListItem;
+export declare function ProjectListItemToJSON(json: any): ProjectListItem;
+export declare function ProjectListItemToJSONTyped(value?: ProjectListItem | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ProjectListItem.js

@@ -0,0 +1,72 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * TC API
+ * TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2.   # Authentication TestCollab supports two forms of authentication:   - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token>    - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API.     Send this token as the Authorization header while making requests to protected resources:     `Authorization: Bearer <token>`    For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it.      # Error Handling Error responses   - `Not Found` - Error is sent when requested resource is not available.   - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401        - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
+ *
+ * The version of the OpenAPI document: 2.3.1
+ * Contact: support@testcollab.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ProjectUserMinifiedFromJSON, ProjectUserMinifiedToJSON, } from './ProjectUserMinified';
+/**
+ * Check if a given object implements the ProjectListItem interface.
+ */
+export function instanceOfProjectListItem(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('archived' in value) || value['archived'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    return true;
+}
+export function ProjectListItemFromJSON(json) {
+    return ProjectListItemFromJSONTyped(json, false);
+}
+export function ProjectListItemFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'archived': json['archived'],
+        'team': json['team'] == null ? undefined : (json['team'].map(ProjectUserMinifiedFromJSON)),
+        'activity': json['activity'] == null ? undefined : json['activity'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+        'isSample': json['is_sample'] == null ? undefined : json['is_sample'],
+        'testCaseCount': json['test_case_count'] == null ? undefined : json['test_case_count'],
+        'testPlanCount': json['test_plan_count'] == null ? undefined : json['test_plan_count'],
+    };
+}
+export function ProjectListItemToJSON(json) {
+    return ProjectListItemToJSONTyped(json, false);
+}
+export function ProjectListItemToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'description': value['description'],
+        'archived': value['archived'],
+        'team': value['team'] == null ? undefined : (value['team'].map(ProjectUserMinifiedToJSON)),
+        'activity': value['activity'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+        'is_sample': value['isSample'],
+        'test_case_count': value['testCaseCount'],
+        'test_plan_count': value['testPlanCount'],
+    };
+}

package/dist/esm/models/ProjectPayload.d.ts

@@ -27,6 +27,12 @@ export interface ProjectPayload {
      * @memberof ProjectPayload
      */
     name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectPayload
+     */
+    description?: string;
     /**
      *
      * @type {boolean}

package/dist/esm/models/ProjectPayload.js

@@ -31,6 +31,7 @@ export function ProjectPayloadFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'id': json['id'] == null ? undefined : json['id'],
         'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
         'archived': json['archived'] == null ? undefined : json['archived'],
         'company': json['company'],
     };
@@ -45,6 +46,7 @@ export function ProjectPayloadToJSONTyped(value, ignoreDiscriminator = false) {
     return {
         'id': value['id'],
         'name': value['name'],
+        'description': value['description'],
         'archived': value['archived'],
         'company': value['company'],
     };

package/dist/esm/models/index.d.ts

@@ -145,6 +145,7 @@ export * from './PreferencePayload';
 export * from './Project';
 export * from './ProjectActivity';
 export * from './ProjectCreatePayload';
+export * from './ProjectListItem';
 export * from './ProjectMetrics';
 export * from './ProjectMini';
 export * from './ProjectMinified';

package/dist/esm/models/index.js

@@ -147,6 +147,7 @@ export * from './PreferencePayload';
 export * from './Project';
 export * from './ProjectActivity';
 export * from './ProjectCreatePayload';
+export * from './ProjectListItem';
 export * from './ProjectMetrics';
 export * from './ProjectMini';
 export * from './ProjectMinified';

package/dist/models/Project.d.ts

@@ -28,6 +28,12 @@ export interface Project {
      * @memberof Project
      */
     name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Project
+     */
+    description?: string;
     /**
      *
      * @type {boolean}

package/dist/models/Project.js

@@ -45,6 +45,7 @@ function ProjectFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'id': json['id'],
         'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
         'archived': json['archived'],
         'team': json['team'] == null ? undefined : (json['team'].map(ProjectUserMinified_1.ProjectUserMinifiedFromJSON)),
         'activity': json['activity'] == null ? undefined : json['activity'],
@@ -63,6 +64,7 @@ function ProjectToJSONTyped(value, ignoreDiscriminator = false) {
     return {
         'id': value['id'],
         'name': value['name'],
+        'description': value['description'],
         'archived': value['archived'],
         'team': value['team'] == null ? undefined : (value['team'].map(ProjectUserMinified_1.ProjectUserMinifiedToJSON)),
         'activity': value['activity'],

package/dist/models/ProjectCreatePayload.d.ts

@@ -27,6 +27,12 @@ export interface ProjectCreatePayload {
      * @memberof ProjectCreatePayload
      */
     name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectCreatePayload
+     */
+    description?: string;
     /**
      * Project ID to import users from (only allowed at the time of project create)
      * @type {number}

package/dist/models/ProjectCreatePayload.js

@@ -38,6 +38,7 @@ function ProjectCreatePayloadFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'id': json['id'] == null ? undefined : json['id'],
         'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
         'importUsers': json['importUsers'] == null ? undefined : json['importUsers'],
         'issueManagerProfile': json['issueManagerProfile'] == null ? undefined : json['issueManagerProfile'],
         'importIssueManagerSettings': json['importIssueManagerSettings'] == null ? undefined : json['importIssueManagerSettings'],
@@ -54,6 +55,7 @@ function ProjectCreatePayloadToJSONTyped(value, ignoreDiscriminator = false) {
     return {
         'id': value['id'],
         'name': value['name'],
+        'description': value['description'],
         'importUsers': value['importUsers'],
         'issueManagerProfile': value['issueManagerProfile'],
         'importIssueManagerSettings': value['importIssueManagerSettings'],

package/dist/models/ProjectListItem.d.ts

@@ -0,0 +1,93 @@
+/**
+ * TC API
+ * TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2.   # Authentication TestCollab supports two forms of authentication:   - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token>    - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API.     Send this token as the Authorization header while making requests to protected resources:     `Authorization: Bearer <token>`    For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it.      # Error Handling Error responses   - `Not Found` - Error is sent when requested resource is not available.   - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401        - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
+ *
+ * The version of the OpenAPI document: 2.3.1
+ * Contact: support@testcollab.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { ProjectUserMinified } from './ProjectUserMinified';
+/**
+ *
+ * @export
+ * @interface ProjectListItem
+ */
+export interface ProjectListItem {
+    /**
+     *
+     * @type {number}
+     * @memberof ProjectListItem
+     */
+    id: number;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectListItem
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectListItem
+     */
+    description?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ProjectListItem
+     */
+    archived: boolean;
+    /**
+     *
+     * @type {Array<ProjectUserMinified>}
+     * @memberof ProjectListItem
+     */
+    team?: Array<ProjectUserMinified>;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectListItem
+     */
+    activity?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectListItem
+     */
+    createdAt: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectListItem
+     */
+    updatedAt: string;
+    /**
+     * Indicates that the project is a sample project or not
+     * @type {boolean}
+     * @memberof ProjectListItem
+     */
+    isSample?: boolean;
+    /**
+     * Number of test cases in the project
+     * @type {number}
+     * @memberof ProjectListItem
+     */
+    testCaseCount?: number;
+    /**
+     * Number of active test plans in the project
+     * @type {number}
+     * @memberof ProjectListItem
+     */
+    testPlanCount?: number;
+}
+/**
+ * Check if a given object implements the ProjectListItem interface.
+ */
+export declare function instanceOfProjectListItem(value: object): value is ProjectListItem;
+export declare function ProjectListItemFromJSON(json: any): ProjectListItem;
+export declare function ProjectListItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProjectListItem;
+export declare function ProjectListItemToJSON(json: any): ProjectListItem;
+export declare function ProjectListItemToJSONTyped(value?: ProjectListItem | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ProjectListItem.js

@@ -0,0 +1,79 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * TC API
+ * TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2.   # Authentication TestCollab supports two forms of authentication:   - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token>    - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API.     Send this token as the Authorization header while making requests to protected resources:     `Authorization: Bearer <token>`    For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it.      # Error Handling Error responses   - `Not Found` - Error is sent when requested resource is not available.   - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401        - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
+ *
+ * The version of the OpenAPI document: 2.3.1
+ * Contact: support@testcollab.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfProjectListItem = instanceOfProjectListItem;
+exports.ProjectListItemFromJSON = ProjectListItemFromJSON;
+exports.ProjectListItemFromJSONTyped = ProjectListItemFromJSONTyped;
+exports.ProjectListItemToJSON = ProjectListItemToJSON;
+exports.ProjectListItemToJSONTyped = ProjectListItemToJSONTyped;
+const ProjectUserMinified_1 = require("./ProjectUserMinified");
+/**
+ * Check if a given object implements the ProjectListItem interface.
+ */
+function instanceOfProjectListItem(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('archived' in value) || value['archived'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    return true;
+}
+function ProjectListItemFromJSON(json) {
+    return ProjectListItemFromJSONTyped(json, false);
+}
+function ProjectListItemFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'archived': json['archived'],
+        'team': json['team'] == null ? undefined : (json['team'].map(ProjectUserMinified_1.ProjectUserMinifiedFromJSON)),
+        'activity': json['activity'] == null ? undefined : json['activity'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+        'isSample': json['is_sample'] == null ? undefined : json['is_sample'],
+        'testCaseCount': json['test_case_count'] == null ? undefined : json['test_case_count'],
+        'testPlanCount': json['test_plan_count'] == null ? undefined : json['test_plan_count'],
+    };
+}
+function ProjectListItemToJSON(json) {
+    return ProjectListItemToJSONTyped(json, false);
+}
+function ProjectListItemToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'description': value['description'],
+        'archived': value['archived'],
+        'team': value['team'] == null ? undefined : (value['team'].map(ProjectUserMinified_1.ProjectUserMinifiedToJSON)),
+        'activity': value['activity'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+        'is_sample': value['isSample'],
+        'test_case_count': value['testCaseCount'],
+        'test_plan_count': value['testPlanCount'],
+    };
+}

package/dist/models/ProjectPayload.d.ts

@@ -27,6 +27,12 @@ export interface ProjectPayload {
      * @memberof ProjectPayload
      */
     name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectPayload
+     */
+    description?: string;
     /**
      *
      * @type {boolean}

package/dist/models/ProjectPayload.js

@@ -38,6 +38,7 @@ function ProjectPayloadFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'id': json['id'] == null ? undefined : json['id'],
         'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
         'archived': json['archived'] == null ? undefined : json['archived'],
         'company': json['company'],
     };
@@ -52,6 +53,7 @@ function ProjectPayloadToJSONTyped(value, ignoreDiscriminator = false) {
     return {
         'id': value['id'],
         'name': value['name'],
+        'description': value['description'],
         'archived': value['archived'],
         'company': value['company'],
     };

package/dist/models/index.d.ts

@@ -145,6 +145,7 @@ export * from './PreferencePayload';
 export * from './Project';
 export * from './ProjectActivity';
 export * from './ProjectCreatePayload';
+export * from './ProjectListItem';
 export * from './ProjectMetrics';
 export * from './ProjectMini';
 export * from './ProjectMinified';

package/dist/models/index.js

@@ -163,6 +163,7 @@ __exportStar(require("./PreferencePayload"), exports);
 __exportStar(require("./Project"), exports);
 __exportStar(require("./ProjectActivity"), exports);
 __exportStar(require("./ProjectCreatePayload"), exports);
+__exportStar(require("./ProjectListItem"), exports);
 __exportStar(require("./ProjectMetrics"), exports);
 __exportStar(require("./ProjectMini"), exports);
 __exportStar(require("./ProjectMinified"), exports);

package/docs/Project.md

@@ -8,6 +8,7 @@ Name | Type
 ------------ | -------------
 `id` | number
 `name` | string
+`description` | string
 `archived` | boolean
 `team` | [Array<ProjectUserMinified>](ProjectUserMinified.md)
 `activity` | string
@@ -24,6 +25,7 @@ import type { Project } from '@testcollab/sdk'
 const example = {
   "id": 1,
   "name": Crowd Vox,
+  "description": QA workspace for the customer web app,
   "archived": false,
   "team": null,
   "activity": 2017-06-05,

package/docs/ProjectCreatePayload.md

@@ -8,6 +8,7 @@ Name | Type
 ------------ | -------------
 `id` | number
 `name` | string
+`description` | string
 `importUsers` | number
 `issueManagerProfile` | number
 `importIssueManagerSettings` | number
@@ -22,6 +23,7 @@ import type { ProjectCreatePayload } from '@testcollab/sdk'
 const example = {
   "id": 1,
   "name": Crowd Vox,
+  "description": QA workspace for the customer web app,
   "importUsers": 2,
   "issueManagerProfile": null,
   "importIssueManagerSettings": 2,

package/docs/ProjectListItem.md

@@ -0,0 +1,54 @@
+
+# ProjectListItem
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`name` | string
+`description` | string
+`archived` | boolean
+`team` | [Array<ProjectUserMinified>](ProjectUserMinified.md)
+`activity` | string
+`createdAt` | string
+`updatedAt` | string
+`isSample` | boolean
+`testCaseCount` | number
+`testPlanCount` | number
+
+## Example
+
+```typescript
+import type { ProjectListItem } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": 1,
+  "name": Crowd Vox,
+  "description": QA workspace for the customer web app,
+  "archived": false,
+  "team": null,
+  "activity": 2017-06-05,
+  "createdAt": 2019-04-30T17:11:24.000Z,
+  "updatedAt": 2019-04-30T17:11:24.000Z,
+  "isSample": false,
+  "testCaseCount": 128,
+  "testPlanCount": 7,
+} satisfies ProjectListItem
+
+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 ProjectListItem
+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/ProjectPayload.md

@@ -8,6 +8,7 @@ Name | Type
 ------------ | -------------
 `id` | number
 `name` | string
+`description` | string
 `archived` | boolean
 `company` | number
 
@@ -20,6 +21,7 @@ import type { ProjectPayload } from '@testcollab/sdk'
 const example = {
   "id": 1,
   "name": Crowd Vox,
+  "description": QA workspace for the customer web app,
   "archived": false,
   "company": 1,
 } satisfies ProjectPayload

package/docs/ProjectsApi.md

@@ -407,7 +407,7 @@ example().catch(console.error);
 
 ## getProjects
 
-> Array<Project> getProjects(company, limit, start, sort, filter)
+> Array<ProjectListItem> getProjects(company, limit, start, sort, filter)
 
 Get list of projects
 
@@ -470,7 +470,7 @@ example().catch(console.error);
 
 ### Return type
 
-[**Array<Project>**](Project.md)
+[**Array<ProjectListItem>**](ProjectListItem.md)
 
 ### Authorization
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testcollab/sdk",
-  "version": "3.9.0",
+  "version": "3.11.0",
   "description": "TestCollab SDK for public API",
   "author": "Test Collab Software LLC.",
   "repository": {

package/src/apis/ProjectsApi.ts

@@ -21,6 +21,7 @@ import type {
   ForbiddenError,
   Project,
   ProjectCreatePayload,
+  ProjectListItem,
   ProjectPayload,
   TCError,
 } from '../models/index';
@@ -37,6 +38,8 @@ import {
     ProjectToJSON,
     ProjectCreatePayloadFromJSON,
     ProjectCreatePayloadToJSON,
+    ProjectListItemFromJSON,
+    ProjectListItemToJSON,
     ProjectPayloadFromJSON,
     ProjectPayloadToJSON,
     TCErrorFromJSON,
@@ -185,13 +188,13 @@ export interface ProjectsApiInterface {
      * @throws {RequiredError}
      * @memberof ProjectsApiInterface
      */
-    getProjectsRaw(requestParameters: GetProjectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Project>>>;
+    getProjectsRaw(requestParameters: GetProjectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ProjectListItem>>>;
 
     /**
      * Fetches list of projects
      * Get list of projects
      */
-    getProjects(requestParameters: GetProjectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Project>>;
+    getProjects(requestParameters: GetProjectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ProjectListItem>>;
 
     /**
      * Populate sample data in project
@@ -490,7 +493,7 @@ export class ProjectsApi extends runtime.BaseAPI implements ProjectsApiInterface
      * Fetches list of projects
      * Get list of projects
      */
-    async getProjectsRaw(requestParameters: GetProjectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Project>>> {
+    async getProjectsRaw(requestParameters: GetProjectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ProjectListItem>>> {
         if (requestParameters['company'] == null) {
             throw new runtime.RequiredError(
                 'company',
@@ -540,14 +543,14 @@ export class ProjectsApi extends runtime.BaseAPI implements ProjectsApiInterface
             query: queryParameters,
         }, initOverrides);
 
-        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ProjectFromJSON));
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ProjectListItemFromJSON));
     }
 
     /**
      * Fetches list of projects
      * Get list of projects
      */
-    async getProjects(requestParameters: GetProjectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Project>> {
+    async getProjects(requestParameters: GetProjectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ProjectListItem>> {
         const response = await this.getProjectsRaw(requestParameters, initOverrides);
         return await response.value();
     }

package/src/models/Project.ts

@@ -39,6 +39,12 @@ export interface Project {
      * @memberof Project
      */
     name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Project
+     */
+    description?: string;
     /**
      * 
      * @type {boolean}
@@ -101,6 +107,7 @@ export function ProjectFromJSONTyped(json: any, ignoreDiscriminator: boolean): P
         
         'id': json['id'],
         'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
         'archived': json['archived'],
         'team': json['team'] == null ? undefined : ((json['team'] as Array<any>).map(ProjectUserMinifiedFromJSON)),
         'activity': json['activity'] == null ? undefined : json['activity'],
@@ -123,6 +130,7 @@ export function ProjectToJSONTyped(value?: Project | null, ignoreDiscriminator:
         
         'id': value['id'],
         'name': value['name'],
+        'description': value['description'],
         'archived': value['archived'],
         'team': value['team'] == null ? undefined : ((value['team'] as Array<any>).map(ProjectUserMinifiedToJSON)),
         'activity': value['activity'],

package/src/models/ProjectCreatePayload.ts

@@ -31,6 +31,12 @@ export interface ProjectCreatePayload {
      * @memberof ProjectCreatePayload
      */
     name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ProjectCreatePayload
+     */
+    description?: string;
     /**
      * Project ID to import users from (only allowed at the time of project create)
      * @type {number}
@@ -79,6 +85,7 @@ export function ProjectCreatePayloadFromJSONTyped(json: any, ignoreDiscriminator
         
         'id': json['id'] == null ? undefined : json['id'],
         'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
         'importUsers': json['importUsers'] == null ? undefined : json['importUsers'],
         'issueManagerProfile': json['issueManagerProfile'] == null ? undefined : json['issueManagerProfile'],
         'importIssueManagerSettings': json['importIssueManagerSettings'] == null ? undefined : json['importIssueManagerSettings'],
@@ -99,6 +106,7 @@ export function ProjectCreatePayloadToJSONTyped(value?: ProjectCreatePayload | n
         
         'id': value['id'],
         'name': value['name'],
+        'description': value['description'],
         'importUsers': value['importUsers'],
         'issueManagerProfile': value['issueManagerProfile'],
         'importIssueManagerSettings': value['importIssueManagerSettings'],

package/src/models/ProjectListItem.ts

@@ -0,0 +1,158 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * TC API
+ * TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2.   # Authentication TestCollab supports two forms of authentication:   - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token>    - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API.     Send this token as the Authorization header while making requests to protected resources:     `Authorization: Bearer <token>`    For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it.      # Error Handling Error responses   - `Not Found` - Error is sent when requested resource is not available.   - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401        - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message. 
+ *
+ * The version of the OpenAPI document: 2.3.1
+ * Contact: support@testcollab.com
+ *
+ * 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 { ProjectUserMinified } from './ProjectUserMinified';
+import {
+    ProjectUserMinifiedFromJSON,
+    ProjectUserMinifiedFromJSONTyped,
+    ProjectUserMinifiedToJSON,
+    ProjectUserMinifiedToJSONTyped,
+} from './ProjectUserMinified';
+
+/**
+ * 
+ * @export
+ * @interface ProjectListItem
+ */
+export interface ProjectListItem {
+    /**
+     * 
+     * @type {number}
+     * @memberof ProjectListItem
+     */
+    id: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof ProjectListItem
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ProjectListItem
+     */
+    description?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ProjectListItem
+     */
+    archived: boolean;
+    /**
+     * 
+     * @type {Array<ProjectUserMinified>}
+     * @memberof ProjectListItem
+     */
+    team?: Array<ProjectUserMinified>;
+    /**
+     * 
+     * @type {string}
+     * @memberof ProjectListItem
+     */
+    activity?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ProjectListItem
+     */
+    createdAt: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ProjectListItem
+     */
+    updatedAt: string;
+    /**
+     * Indicates that the project is a sample project or not
+     * @type {boolean}
+     * @memberof ProjectListItem
+     */
+    isSample?: boolean;
+    /**
+     * Number of test cases in the project
+     * @type {number}
+     * @memberof ProjectListItem
+     */
+    testCaseCount?: number;
+    /**
+     * Number of active test plans in the project
+     * @type {number}
+     * @memberof ProjectListItem
+     */
+    testPlanCount?: number;
+}
+
+/**
+ * Check if a given object implements the ProjectListItem interface.
+ */
+export function instanceOfProjectListItem(value: object): value is ProjectListItem {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('archived' in value) || value['archived'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    return true;
+}
+
+export function ProjectListItemFromJSON(json: any): ProjectListItem {
+    return ProjectListItemFromJSONTyped(json, false);
+}
+
+export function ProjectListItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProjectListItem {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'archived': json['archived'],
+        'team': json['team'] == null ? undefined : ((json['team'] as Array<any>).map(ProjectUserMinifiedFromJSON)),
+        'activity': json['activity'] == null ? undefined : json['activity'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+        'isSample': json['is_sample'] == null ? undefined : json['is_sample'],
+        'testCaseCount': json['test_case_count'] == null ? undefined : json['test_case_count'],
+        'testPlanCount': json['test_plan_count'] == null ? undefined : json['test_plan_count'],
+    };
+}
+
+export function ProjectListItemToJSON(json: any): ProjectListItem {
+    return ProjectListItemToJSONTyped(json, false);
+}
+
+export function ProjectListItemToJSONTyped(value?: ProjectListItem | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'description': value['description'],
+        'archived': value['archived'],
+        'team': value['team'] == null ? undefined : ((value['team'] as Array<any>).map(ProjectUserMinifiedToJSON)),
+        'activity': value['activity'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+        'is_sample': value['isSample'],
+        'test_case_count': value['testCaseCount'],
+        'test_plan_count': value['testPlanCount'],
+    };
+}
+

package/src/models/ProjectPayload.ts

@@ -31,6 +31,12 @@ export interface ProjectPayload {
      * @memberof ProjectPayload
      */
     name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ProjectPayload
+     */
+    description?: string;
     /**
      * 
      * @type {boolean}
@@ -66,6 +72,7 @@ export function ProjectPayloadFromJSONTyped(json: any, ignoreDiscriminator: bool
         
         'id': json['id'] == null ? undefined : json['id'],
         'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
         'archived': json['archived'] == null ? undefined : json['archived'],
         'company': json['company'],
     };
@@ -84,6 +91,7 @@ export function ProjectPayloadToJSONTyped(value?: ProjectPayload | null, ignoreD
         
         'id': value['id'],
         'name': value['name'],
+        'description': value['description'],
         'archived': value['archived'],
         'company': value['company'],
     };

package/src/models/index.ts

@@ -147,6 +147,7 @@ export * from './PreferencePayload';
 export * from './Project';
 export * from './ProjectActivity';
 export * from './ProjectCreatePayload';
+export * from './ProjectListItem';
 export * from './ProjectMetrics';
 export * from './ProjectMini';
 export * from './ProjectMinified';