@testcollab/sdk 3.1.1

package/dist/esm/models/PreferencePayload.js

@@ -0,0 +1,56 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const PreferencePayloadSelectionTypeEnum = {
+    All: 'all',
+    OnlyMe: 'onlyMe'
+};
+/**
+ * Check if a given object implements the PreferencePayload interface.
+ */
+export function instanceOfPreferencePayload(value) {
+    if (!('notification' in value) || value['notification'] === undefined)
+        return false;
+    if (!('selectionType' in value) || value['selectionType'] === undefined)
+        return false;
+    return true;
+}
+export function PreferencePayloadFromJSON(json) {
+    return PreferencePayloadFromJSONTyped(json, false);
+}
+export function PreferencePayloadFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'notification': json['notification'],
+        'selectionType': json['selectionType'],
+        'hide': json['hide'] == null ? undefined : json['hide'],
+    };
+}
+export function PreferencePayloadToJSON(json) {
+    return PreferencePayloadToJSONTyped(json, false);
+}
+export function PreferencePayloadToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'notification': value['notification'],
+        'selectionType': value['selectionType'],
+        'hide': value['hide'],
+    };
+}

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

@@ -0,0 +1,75 @@
+/**
+ * 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 Project
+ */
+export interface Project {
+    /**
+     *
+     * @type {number}
+     * @memberof Project
+     */
+    id: number;
+    /**
+     *
+     * @type {string}
+     * @memberof Project
+     */
+    name: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Project
+     */
+    archived: boolean;
+    /**
+     *
+     * @type {Array<ProjectUserMinified>}
+     * @memberof Project
+     */
+    team?: Array<ProjectUserMinified>;
+    /**
+     *
+     * @type {string}
+     * @memberof Project
+     */
+    activity?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Project
+     */
+    createdAt: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Project
+     */
+    updatedAt: string;
+    /**
+     * Indicates that the project is a sample project or not
+     * @type {boolean}
+     * @memberof Project
+     */
+    isSample?: boolean;
+}
+/**
+ * Check if a given object implements the Project interface.
+ */
+export declare function instanceOfProject(value: object): value is Project;
+export declare function ProjectFromJSON(json: any): Project;
+export declare function ProjectFromJSONTyped(json: any, ignoreDiscriminator: boolean): Project;
+export declare function ProjectToJSON(json: any): Project;
+export declare function ProjectToJSONTyped(value?: Project | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/Project.js

@@ -0,0 +1,66 @@
+/* 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 Project interface.
+ */
+export function instanceOfProject(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 ProjectFromJSON(json) {
+    return ProjectFromJSONTyped(json, false);
+}
+export function ProjectFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        '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'],
+    };
+}
+export function ProjectToJSON(json) {
+    return ProjectToJSONTyped(json, false);
+}
+export function ProjectToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        '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'],
+    };
+}

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

@@ -0,0 +1,69 @@
+/**
+ * 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 { User } from './User';
+/**
+ *
+ * @export
+ * @interface ProjectActivity
+ */
+export interface ProjectActivity {
+    /**
+     * Type of entity
+     * @type {string}
+     * @memberof ProjectActivity
+     */
+    entity: string;
+    /**
+     * Activity Type
+     * @type {string}
+     * @memberof ProjectActivity
+     */
+    activityType?: ProjectActivityActivityTypeEnum;
+    /**
+     *
+     * @type {User}
+     * @memberof ProjectActivity
+     */
+    user?: User;
+    /**
+     * Time when the activity was performed
+     * @type {string}
+     * @memberof ProjectActivity
+     */
+    time: string;
+    /**
+     * A hyperlinked title
+     * @type {string}
+     * @memberof ProjectActivity
+     */
+    title: string;
+}
+/**
+ * @export
+ */
+export declare const ProjectActivityActivityTypeEnum: {
+    readonly Add: "add";
+    readonly Edit: "edit";
+    readonly Delete: "delete";
+    readonly Run: "run";
+    readonly FinishedRun: "finished_run";
+    readonly Comment: "comment";
+};
+export type ProjectActivityActivityTypeEnum = typeof ProjectActivityActivityTypeEnum[keyof typeof ProjectActivityActivityTypeEnum];
+/**
+ * Check if a given object implements the ProjectActivity interface.
+ */
+export declare function instanceOfProjectActivity(value: object): value is ProjectActivity;
+export declare function ProjectActivityFromJSON(json: any): ProjectActivity;
+export declare function ProjectActivityFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProjectActivity;
+export declare function ProjectActivityToJSON(json: any): ProjectActivity;
+export declare function ProjectActivityToJSONTyped(value?: ProjectActivity | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ProjectActivity.js

@@ -0,0 +1,67 @@
+/* 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 { UserFromJSON, UserToJSON, } from './User';
+/**
+ * @export
+ */
+export const ProjectActivityActivityTypeEnum = {
+    Add: 'add',
+    Edit: 'edit',
+    Delete: 'delete',
+    Run: 'run',
+    FinishedRun: 'finished_run',
+    Comment: 'comment'
+};
+/**
+ * Check if a given object implements the ProjectActivity interface.
+ */
+export function instanceOfProjectActivity(value) {
+    if (!('entity' in value) || value['entity'] === undefined)
+        return false;
+    if (!('time' in value) || value['time'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    return true;
+}
+export function ProjectActivityFromJSON(json) {
+    return ProjectActivityFromJSONTyped(json, false);
+}
+export function ProjectActivityFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'entity': json['entity'],
+        'activityType': json['activity_type'] == null ? undefined : json['activity_type'],
+        'user': json['user'] == null ? undefined : UserFromJSON(json['user']),
+        'time': json['time'],
+        'title': json['title'],
+    };
+}
+export function ProjectActivityToJSON(json) {
+    return ProjectActivityToJSONTyped(json, false);
+}
+export function ProjectActivityToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'entity': value['entity'],
+        'activity_type': value['activityType'],
+        'user': UserToJSON(value['user']),
+        'time': value['time'],
+        'title': value['title'],
+    };
+}

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

@@ -0,0 +1,63 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface ProjectCreatePayload
+ */
+export interface ProjectCreatePayload {
+    /**
+     *
+     * @type {number}
+     * @memberof ProjectCreatePayload
+     */
+    id?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectCreatePayload
+     */
+    name: string;
+    /**
+     * Project ID to import users from (only allowed at the time of project create)
+     * @type {number}
+     * @memberof ProjectCreatePayload
+     */
+    importUsers?: number | null;
+    /**
+     * Issue Manager Profile ID for the desired integration
+     * @type {number}
+     * @memberof ProjectCreatePayload
+     */
+    issueManagerProfile?: number | null;
+    /**
+     * Project ID to import issue manager settings from (only allowed at the time of project create)
+     * @type {number}
+     * @memberof ProjectCreatePayload
+     * @deprecated
+     */
+    importIssueManagerSettings?: number | null;
+    /**
+     * Company ID
+     * @type {number}
+     * @memberof ProjectCreatePayload
+     */
+    company: number;
+}
+/**
+ * Check if a given object implements the ProjectCreatePayload interface.
+ */
+export declare function instanceOfProjectCreatePayload(value: object): value is ProjectCreatePayload;
+export declare function ProjectCreatePayloadFromJSON(json: any): ProjectCreatePayload;
+export declare function ProjectCreatePayloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProjectCreatePayload;
+export declare function ProjectCreatePayloadToJSON(json: any): ProjectCreatePayload;
+export declare function ProjectCreatePayloadToJSONTyped(value?: ProjectCreatePayload | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ProjectCreatePayload.js

@@ -0,0 +1,55 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the ProjectCreatePayload interface.
+ */
+export function instanceOfProjectCreatePayload(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('company' in value) || value['company'] === undefined)
+        return false;
+    return true;
+}
+export function ProjectCreatePayloadFromJSON(json) {
+    return ProjectCreatePayloadFromJSONTyped(json, false);
+}
+export function ProjectCreatePayloadFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'name': json['name'],
+        'importUsers': json['importUsers'] == null ? undefined : json['importUsers'],
+        'issueManagerProfile': json['issueManagerProfile'] == null ? undefined : json['issueManagerProfile'],
+        'importIssueManagerSettings': json['importIssueManagerSettings'] == null ? undefined : json['importIssueManagerSettings'],
+        'company': json['company'],
+    };
+}
+export function ProjectCreatePayloadToJSON(json) {
+    return ProjectCreatePayloadToJSONTyped(json, false);
+}
+export function ProjectCreatePayloadToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'importUsers': value['importUsers'],
+        'issueManagerProfile': value['issueManagerProfile'],
+        'importIssueManagerSettings': value['importIssueManagerSettings'],
+        'company': value['company'],
+    };
+}

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

@@ -0,0 +1,63 @@
+/**
+ * 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 { CasesPassed } from './CasesPassed';
+/**
+ *
+ * @export
+ * @interface ProjectMetrics
+ */
+export interface ProjectMetrics {
+    /**
+     * The number of defects reported from within the project
+     * @type {number}
+     * @memberof ProjectMetrics
+     */
+    defectCount: number;
+    /**
+     * Total time spent testing (in seconds)
+     * @type {number}
+     * @memberof ProjectMetrics
+     */
+    timeTakenInSeconds: number;
+    /**
+     * The number of test cases created in project
+     * @type {number}
+     * @memberof ProjectMetrics
+     */
+    totalCasesCreated: number;
+    /**
+     *
+     * @type {CasesPassed}
+     * @memberof ProjectMetrics
+     */
+    casesPassed: CasesPassed;
+    /**
+     * Time spent per execution
+     * @type {number}
+     * @memberof ProjectMetrics
+     */
+    avgTimePerExec: number;
+    /**
+     * The number of test executions created in project
+     * @type {number}
+     * @memberof ProjectMetrics
+     */
+    executionCount: number;
+}
+/**
+ * Check if a given object implements the ProjectMetrics interface.
+ */
+export declare function instanceOfProjectMetrics(value: object): value is ProjectMetrics;
+export declare function ProjectMetricsFromJSON(json: any): ProjectMetrics;
+export declare function ProjectMetricsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProjectMetrics;
+export declare function ProjectMetricsToJSON(json: any): ProjectMetrics;
+export declare function ProjectMetricsToJSONTyped(value?: ProjectMetrics | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ProjectMetrics.js

@@ -0,0 +1,64 @@
+/* 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 { CasesPassedFromJSON, CasesPassedToJSON, } from './CasesPassed';
+/**
+ * Check if a given object implements the ProjectMetrics interface.
+ */
+export function instanceOfProjectMetrics(value) {
+    if (!('defectCount' in value) || value['defectCount'] === undefined)
+        return false;
+    if (!('timeTakenInSeconds' in value) || value['timeTakenInSeconds'] === undefined)
+        return false;
+    if (!('totalCasesCreated' in value) || value['totalCasesCreated'] === undefined)
+        return false;
+    if (!('casesPassed' in value) || value['casesPassed'] === undefined)
+        return false;
+    if (!('avgTimePerExec' in value) || value['avgTimePerExec'] === undefined)
+        return false;
+    if (!('executionCount' in value) || value['executionCount'] === undefined)
+        return false;
+    return true;
+}
+export function ProjectMetricsFromJSON(json) {
+    return ProjectMetricsFromJSONTyped(json, false);
+}
+export function ProjectMetricsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'defectCount': json['defectCount'],
+        'timeTakenInSeconds': json['timeTakenInSeconds'],
+        'totalCasesCreated': json['totalCasesCreated'],
+        'casesPassed': CasesPassedFromJSON(json['casesPassed']),
+        'avgTimePerExec': json['avgTimePerExec'],
+        'executionCount': json['executionCount'],
+    };
+}
+export function ProjectMetricsToJSON(json) {
+    return ProjectMetricsToJSONTyped(json, false);
+}
+export function ProjectMetricsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'defectCount': value['defectCount'],
+        'timeTakenInSeconds': value['timeTakenInSeconds'],
+        'totalCasesCreated': value['totalCasesCreated'],
+        'casesPassed': CasesPassedToJSON(value['casesPassed']),
+        'avgTimePerExec': value['avgTimePerExec'],
+        'executionCount': value['executionCount'],
+    };
+}