@testcollab/sdk 3.1.1

package/dist/models/Requirement.js

@@ -0,0 +1,90 @@
+"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.instanceOfRequirement = instanceOfRequirement;
+exports.RequirementFromJSON = RequirementFromJSON;
+exports.RequirementFromJSONTyped = RequirementFromJSONTyped;
+exports.RequirementToJSON = RequirementToJSON;
+exports.RequirementToJSONTyped = RequirementToJSONTyped;
+const UserMinified_1 = require("./UserMinified");
+const Upload_1 = require("./Upload");
+const CustomFieldCollectionOutput_1 = require("./CustomFieldCollectionOutput");
+const GenericFolder_1 = require("./GenericFolder");
+/**
+ * Check if a given object implements the Requirement interface.
+ */
+function instanceOfRequirement(value) {
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('requirementId' in value) || value['requirementId'] === undefined)
+        return false;
+    if (!('project' in value) || value['project'] === undefined)
+        return false;
+    return true;
+}
+function RequirementFromJSON(json) {
+    return RequirementFromJSONTyped(json, false);
+}
+function RequirementFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'title': json['title'],
+        'requirementManager': json['requirementManager'] == null ? undefined : json['requirementManager'],
+        'requirementId': json['requirement_id'],
+        'requirementKey': json['requirement_key'] == null ? undefined : json['requirement_key'],
+        'requirementUrl': json['requirement_url'] == null ? undefined : json['requirement_url'],
+        'project': json['project'],
+        'status': json['status'] == null ? undefined : json['status'],
+        'reqInfo': json['req_info'] == null ? undefined : json['req_info'],
+        'testcaseCount': json['testcase_count'] == null ? undefined : json['testcase_count'],
+        'customFields': json['custom_fields'] == null ? undefined : (json['custom_fields'].map(CustomFieldCollectionOutput_1.CustomFieldCollectionOutputFromJSON)),
+        'requirementFolder': json['requirement_folder'] == null ? undefined : (0, GenericFolder_1.GenericFolderFromJSON)(json['requirement_folder']),
+        'attachments': json['attachments'] == null ? undefined : (json['attachments'].map(Upload_1.UploadFromJSON)),
+        'description': json['description'] == null ? undefined : json['description'],
+        'createdAt': json['created_at'] == null ? undefined : json['created_at'],
+        'updatedAt': json['updated_at'] == null ? undefined : json['updated_at'],
+        'createdBy': json['created_by'] == null ? undefined : (0, UserMinified_1.UserMinifiedFromJSON)(json['created_by']),
+    };
+}
+function RequirementToJSON(json) {
+    return RequirementToJSONTyped(json, false);
+}
+function RequirementToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'title': value['title'],
+        'requirementManager': value['requirementManager'],
+        'requirement_id': value['requirementId'],
+        'requirement_key': value['requirementKey'],
+        'requirement_url': value['requirementUrl'],
+        'project': value['project'],
+        'status': value['status'],
+        'req_info': value['reqInfo'],
+        'testcase_count': value['testcaseCount'],
+        'custom_fields': value['customFields'] == null ? undefined : (value['customFields'].map(CustomFieldCollectionOutput_1.CustomFieldCollectionOutputToJSON)),
+        'requirement_folder': (0, GenericFolder_1.GenericFolderToJSON)(value['requirementFolder']),
+        'attachments': value['attachments'] == null ? undefined : (value['attachments'].map(Upload_1.UploadToJSON)),
+        'description': value['description'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+        'created_by': (0, UserMinified_1.UserMinifiedToJSON)(value['createdBy']),
+    };
+}

package/dist/models/RequirementFolderCopyPayload.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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 RequirementFolderCopyPayload
+ */
+export interface RequirementFolderCopyPayload {
+    /**
+     *
+     * @type {number}
+     * @memberof RequirementFolderCopyPayload
+     */
+    requirementFolder: number;
+}
+/**
+ * Check if a given object implements the RequirementFolderCopyPayload interface.
+ */
+export declare function instanceOfRequirementFolderCopyPayload(value: object): value is RequirementFolderCopyPayload;
+export declare function RequirementFolderCopyPayloadFromJSON(json: any): RequirementFolderCopyPayload;
+export declare function RequirementFolderCopyPayloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): RequirementFolderCopyPayload;
+export declare function RequirementFolderCopyPayloadToJSON(json: any): RequirementFolderCopyPayload;
+export declare function RequirementFolderCopyPayloadToJSONTyped(value?: RequirementFolderCopyPayload | null, ignoreDiscriminator?: boolean): any;

package/dist/models/RequirementFolderCopyPayload.js

@@ -0,0 +1,50 @@
+"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.instanceOfRequirementFolderCopyPayload = instanceOfRequirementFolderCopyPayload;
+exports.RequirementFolderCopyPayloadFromJSON = RequirementFolderCopyPayloadFromJSON;
+exports.RequirementFolderCopyPayloadFromJSONTyped = RequirementFolderCopyPayloadFromJSONTyped;
+exports.RequirementFolderCopyPayloadToJSON = RequirementFolderCopyPayloadToJSON;
+exports.RequirementFolderCopyPayloadToJSONTyped = RequirementFolderCopyPayloadToJSONTyped;
+/**
+ * Check if a given object implements the RequirementFolderCopyPayload interface.
+ */
+function instanceOfRequirementFolderCopyPayload(value) {
+    if (!('requirementFolder' in value) || value['requirementFolder'] === undefined)
+        return false;
+    return true;
+}
+function RequirementFolderCopyPayloadFromJSON(json) {
+    return RequirementFolderCopyPayloadFromJSONTyped(json, false);
+}
+function RequirementFolderCopyPayloadFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'requirementFolder': json['requirementFolder'],
+    };
+}
+function RequirementFolderCopyPayloadToJSON(json) {
+    return RequirementFolderCopyPayloadToJSONTyped(json, false);
+}
+function RequirementFolderCopyPayloadToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'requirementFolder': value['requirementFolder'],
+    };
+}

package/dist/models/RequirementMinified.d.ts

@@ -0,0 +1,92 @@
+/**
+ * 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 RequirementMinified
+ */
+export interface RequirementMinified {
+    /**
+     *
+     * @type {number}
+     * @memberof RequirementMinified
+     */
+    id?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof RequirementMinified
+     */
+    title: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RequirementMinified
+     */
+    requirementManager?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RequirementMinified
+     */
+    requirementId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RequirementMinified
+     */
+    requirementKey?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RequirementMinified
+     */
+    requirementUrl?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof RequirementMinified
+     */
+    project: number;
+    /**
+     *
+     * @type {number}
+     * @memberof RequirementMinified
+     */
+    status?: number;
+    /**
+     * Stringified JSON object
+     * @type {string}
+     * @memberof RequirementMinified
+     */
+    reqInfo?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RequirementMinified
+     */
+    createdAt?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RequirementMinified
+     */
+    updatedAt?: string;
+}
+/**
+ * Check if a given object implements the RequirementMinified interface.
+ */
+export declare function instanceOfRequirementMinified(value: object): value is RequirementMinified;
+export declare function RequirementMinifiedFromJSON(json: any): RequirementMinified;
+export declare function RequirementMinifiedFromJSONTyped(json: any, ignoreDiscriminator: boolean): RequirementMinified;
+export declare function RequirementMinifiedToJSON(json: any): RequirementMinified;
+export declare function RequirementMinifiedToJSONTyped(value?: RequirementMinified | null, ignoreDiscriminator?: boolean): any;

package/dist/models/RequirementMinified.js

@@ -0,0 +1,74 @@
+"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.instanceOfRequirementMinified = instanceOfRequirementMinified;
+exports.RequirementMinifiedFromJSON = RequirementMinifiedFromJSON;
+exports.RequirementMinifiedFromJSONTyped = RequirementMinifiedFromJSONTyped;
+exports.RequirementMinifiedToJSON = RequirementMinifiedToJSON;
+exports.RequirementMinifiedToJSONTyped = RequirementMinifiedToJSONTyped;
+/**
+ * Check if a given object implements the RequirementMinified interface.
+ */
+function instanceOfRequirementMinified(value) {
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('requirementId' in value) || value['requirementId'] === undefined)
+        return false;
+    if (!('project' in value) || value['project'] === undefined)
+        return false;
+    return true;
+}
+function RequirementMinifiedFromJSON(json) {
+    return RequirementMinifiedFromJSONTyped(json, false);
+}
+function RequirementMinifiedFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'title': json['title'],
+        'requirementManager': json['requirementManager'] == null ? undefined : json['requirementManager'],
+        'requirementId': json['requirement_id'],
+        'requirementKey': json['requirement_key'] == null ? undefined : json['requirement_key'],
+        'requirementUrl': json['requirement_url'] == null ? undefined : json['requirement_url'],
+        'project': json['project'],
+        'status': json['status'] == null ? undefined : json['status'],
+        'reqInfo': json['req_info'] == null ? undefined : json['req_info'],
+        'createdAt': json['created_at'] == null ? undefined : json['created_at'],
+        'updatedAt': json['updated_at'] == null ? undefined : json['updated_at'],
+    };
+}
+function RequirementMinifiedToJSON(json) {
+    return RequirementMinifiedToJSONTyped(json, false);
+}
+function RequirementMinifiedToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'title': value['title'],
+        'requirementManager': value['requirementManager'],
+        'requirement_id': value['requirementId'],
+        'requirement_key': value['requirementKey'],
+        'requirement_url': value['requirementUrl'],
+        'project': value['project'],
+        'status': value['status'],
+        'req_info': value['reqInfo'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+    };
+}

package/dist/models/RequirementPayload.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 { CustomFieldInputPayload } from './CustomFieldInputPayload';
+/**
+ *
+ * @export
+ * @interface RequirementPayload
+ */
+export interface RequirementPayload {
+    /**
+     *
+     * @type {number}
+     * @memberof RequirementPayload
+     */
+    id?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof RequirementPayload
+     */
+    requirementManager?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RequirementPayload
+     */
+    title?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RequirementPayload
+     */
+    externalId: string;
+    /**
+     *
+     * @type {number}
+     * @memberof RequirementPayload
+     */
+    project: number;
+    /**
+     * Stringified JSON object
+     * @type {string}
+     * @memberof RequirementPayload
+     */
+    requirementData?: string;
+    /**
+     * Requirement description - applicable only for inbuilt requirementManager
+     * @type {string}
+     * @memberof RequirementPayload
+     */
+    description?: string;
+    /**
+     * Requirement folder id - applicable only for inbuilt requirementManager
+     * @type {number}
+     * @memberof RequirementPayload
+     */
+    requirementFolder?: number;
+    /**
+     * Array of custom fields - applicable only for inbuilt requirementManager
+     * @type {Array<CustomFieldInputPayload>}
+     * @memberof RequirementPayload
+     */
+    customFields?: Array<CustomFieldInputPayload>;
+    /**
+     * Array of file ids - applicable only for inbuilt requirementManager
+     * @type {Array<string>}
+     * @memberof RequirementPayload
+     */
+    attachments?: Array<string>;
+    /**
+     * Array of testcase ids - applicable only for inbuilt requirementManager
+     * @type {Array<number>}
+     * @memberof RequirementPayload
+     */
+    testcases?: Array<number>;
+}
+/**
+ * Check if a given object implements the RequirementPayload interface.
+ */
+export declare function instanceOfRequirementPayload(value: object): value is RequirementPayload;
+export declare function RequirementPayloadFromJSON(json: any): RequirementPayload;
+export declare function RequirementPayloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): RequirementPayload;
+export declare function RequirementPayloadToJSON(json: any): RequirementPayload;
+export declare function RequirementPayloadToJSONTyped(value?: RequirementPayload | null, ignoreDiscriminator?: boolean): any;

package/dist/models/RequirementPayload.js

@@ -0,0 +1,73 @@
+"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.instanceOfRequirementPayload = instanceOfRequirementPayload;
+exports.RequirementPayloadFromJSON = RequirementPayloadFromJSON;
+exports.RequirementPayloadFromJSONTyped = RequirementPayloadFromJSONTyped;
+exports.RequirementPayloadToJSON = RequirementPayloadToJSON;
+exports.RequirementPayloadToJSONTyped = RequirementPayloadToJSONTyped;
+const CustomFieldInputPayload_1 = require("./CustomFieldInputPayload");
+/**
+ * Check if a given object implements the RequirementPayload interface.
+ */
+function instanceOfRequirementPayload(value) {
+    if (!('externalId' in value) || value['externalId'] === undefined)
+        return false;
+    if (!('project' in value) || value['project'] === undefined)
+        return false;
+    return true;
+}
+function RequirementPayloadFromJSON(json) {
+    return RequirementPayloadFromJSONTyped(json, false);
+}
+function RequirementPayloadFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'requirementManager': json['requirementManager'] == null ? undefined : json['requirementManager'],
+        'title': json['title'] == null ? undefined : json['title'],
+        'externalId': json['external_id'],
+        'project': json['project'],
+        'requirementData': json['requirement_data'] == null ? undefined : json['requirement_data'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'requirementFolder': json['requirement_folder'] == null ? undefined : json['requirement_folder'],
+        'customFields': json['custom_fields'] == null ? undefined : (json['custom_fields'].map(CustomFieldInputPayload_1.CustomFieldInputPayloadFromJSON)),
+        'attachments': json['attachments'] == null ? undefined : json['attachments'],
+        'testcases': json['testcases'] == null ? undefined : json['testcases'],
+    };
+}
+function RequirementPayloadToJSON(json) {
+    return RequirementPayloadToJSONTyped(json, false);
+}
+function RequirementPayloadToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'requirementManager': value['requirementManager'],
+        'title': value['title'],
+        'external_id': value['externalId'],
+        'project': value['project'],
+        'requirement_data': value['requirementData'],
+        'description': value['description'],
+        'requirement_folder': value['requirementFolder'],
+        'custom_fields': value['customFields'] == null ? undefined : (value['customFields'].map(CustomFieldInputPayload_1.CustomFieldInputPayloadToJSON)),
+        'attachments': value['attachments'],
+        'testcases': value['testcases'],
+    };
+}

package/dist/models/RequirementProfile.d.ts

@@ -0,0 +1,56 @@
+/**
+ * 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 RequirementProfile
+ */
+export interface RequirementProfile {
+    /**
+     *
+     * @type {number}
+     * @memberof RequirementProfile
+     */
+    id: number;
+    /**
+     * User specified name
+     * @type {string}
+     * @memberof RequirementProfile
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RequirementProfile
+     */
+    requirementManager: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RequirementProfile
+     */
+    createdAt: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RequirementProfile
+     */
+    updatedAt: string;
+}
+/**
+ * Check if a given object implements the RequirementProfile interface.
+ */
+export declare function instanceOfRequirementProfile(value: object): value is RequirementProfile;
+export declare function RequirementProfileFromJSON(json: any): RequirementProfile;
+export declare function RequirementProfileFromJSONTyped(json: any, ignoreDiscriminator: boolean): RequirementProfile;
+export declare function RequirementProfileToJSON(json: any): RequirementProfile;
+export declare function RequirementProfileToJSONTyped(value?: RequirementProfile | null, ignoreDiscriminator?: boolean): any;

package/dist/models/RequirementProfile.js

@@ -0,0 +1,66 @@
+"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.instanceOfRequirementProfile = instanceOfRequirementProfile;
+exports.RequirementProfileFromJSON = RequirementProfileFromJSON;
+exports.RequirementProfileFromJSONTyped = RequirementProfileFromJSONTyped;
+exports.RequirementProfileToJSON = RequirementProfileToJSON;
+exports.RequirementProfileToJSONTyped = RequirementProfileToJSONTyped;
+/**
+ * Check if a given object implements the RequirementProfile interface.
+ */
+function instanceOfRequirementProfile(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('requirementManager' in value) || value['requirementManager'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    return true;
+}
+function RequirementProfileFromJSON(json) {
+    return RequirementProfileFromJSONTyped(json, false);
+}
+function RequirementProfileFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'requirementManager': json['requirementManager'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+    };
+}
+function RequirementProfileToJSON(json) {
+    return RequirementProfileToJSONTyped(json, false);
+}
+function RequirementProfileToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'requirementManager': value['requirementManager'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+    };
+}