@testcollab/sdk 3.1.1

package/dist/models/ReusableStep.d.ts

@@ -0,0 +1,45 @@
+/**
+ * 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 { Step } from './Step';
+/**
+ *
+ * @export
+ * @interface ReusableStep
+ */
+export interface ReusableStep {
+    /**
+     * Reusable step ID
+     * @type {number}
+     * @memberof ReusableStep
+     */
+    id: number;
+    /**
+     * Name of step collection for reference
+     * @type {string}
+     * @memberof ReusableStep
+     */
+    name: string;
+    /**
+     *
+     * @type {Array<Step>}
+     * @memberof ReusableStep
+     */
+    steps: Array<Step>;
+}
+/**
+ * Check if a given object implements the ReusableStep interface.
+ */
+export declare function instanceOfReusableStep(value: object): value is ReusableStep;
+export declare function ReusableStepFromJSON(json: any): ReusableStep;
+export declare function ReusableStepFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReusableStep;
+export declare function ReusableStepToJSON(json: any): ReusableStep;
+export declare function ReusableStepToJSONTyped(value?: ReusableStep | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ReusableStep.js

@@ -0,0 +1,59 @@
+"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.instanceOfReusableStep = instanceOfReusableStep;
+exports.ReusableStepFromJSON = ReusableStepFromJSON;
+exports.ReusableStepFromJSONTyped = ReusableStepFromJSONTyped;
+exports.ReusableStepToJSON = ReusableStepToJSON;
+exports.ReusableStepToJSONTyped = ReusableStepToJSONTyped;
+const Step_1 = require("./Step");
+/**
+ * Check if a given object implements the ReusableStep interface.
+ */
+function instanceOfReusableStep(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('steps' in value) || value['steps'] === undefined)
+        return false;
+    return true;
+}
+function ReusableStepFromJSON(json) {
+    return ReusableStepFromJSONTyped(json, false);
+}
+function ReusableStepFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'steps': (json['steps'].map(Step_1.StepFromJSON)),
+    };
+}
+function ReusableStepToJSON(json) {
+    return ReusableStepToJSONTyped(json, false);
+}
+function ReusableStepToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'steps': (value['steps'].map(Step_1.StepToJSON)),
+    };
+}

package/dist/models/ReusableStepPayload.d.ts

@@ -0,0 +1,45 @@
+/**
+ * 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 { Step } from './Step';
+/**
+ *
+ * @export
+ * @interface ReusableStepPayload
+ */
+export interface ReusableStepPayload {
+    /**
+     *
+     * @type {number}
+     * @memberof ReusableStepPayload
+     */
+    project: number;
+    /**
+     * Name of step collection for reference
+     * @type {string}
+     * @memberof ReusableStepPayload
+     */
+    name: string;
+    /**
+     *
+     * @type {Array<Step>}
+     * @memberof ReusableStepPayload
+     */
+    steps: Array<Step>;
+}
+/**
+ * Check if a given object implements the ReusableStepPayload interface.
+ */
+export declare function instanceOfReusableStepPayload(value: object): value is ReusableStepPayload;
+export declare function ReusableStepPayloadFromJSON(json: any): ReusableStepPayload;
+export declare function ReusableStepPayloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReusableStepPayload;
+export declare function ReusableStepPayloadToJSON(json: any): ReusableStepPayload;
+export declare function ReusableStepPayloadToJSONTyped(value?: ReusableStepPayload | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ReusableStepPayload.js

@@ -0,0 +1,59 @@
+"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.instanceOfReusableStepPayload = instanceOfReusableStepPayload;
+exports.ReusableStepPayloadFromJSON = ReusableStepPayloadFromJSON;
+exports.ReusableStepPayloadFromJSONTyped = ReusableStepPayloadFromJSONTyped;
+exports.ReusableStepPayloadToJSON = ReusableStepPayloadToJSON;
+exports.ReusableStepPayloadToJSONTyped = ReusableStepPayloadToJSONTyped;
+const Step_1 = require("./Step");
+/**
+ * Check if a given object implements the ReusableStepPayload interface.
+ */
+function instanceOfReusableStepPayload(value) {
+    if (!('project' in value) || value['project'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('steps' in value) || value['steps'] === undefined)
+        return false;
+    return true;
+}
+function ReusableStepPayloadFromJSON(json) {
+    return ReusableStepPayloadFromJSONTyped(json, false);
+}
+function ReusableStepPayloadFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'project': json['project'],
+        'name': json['name'],
+        'steps': (json['steps'].map(Step_1.StepFromJSON)),
+    };
+}
+function ReusableStepPayloadToJSON(json) {
+    return ReusableStepPayloadToJSONTyped(json, false);
+}
+function ReusableStepPayloadToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'project': value['project'],
+        'name': value['name'],
+        'steps': (value['steps'].map(Step_1.StepToJSON)),
+    };
+}

package/dist/models/Role.d.ts

@@ -0,0 +1,62 @@
+/**
+ * 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 Role
+ */
+export interface Role {
+    /**
+     *
+     * @type {number}
+     * @memberof Role
+     */
+    id: number;
+    /**
+     *
+     * @type {string}
+     * @memberof Role
+     */
+    name: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof Role
+     */
+    permissions: Array<string>;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Role
+     */
+    readonly: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof Role
+     */
+    createdAt: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Role
+     */
+    updatedAt: string;
+}
+/**
+ * Check if a given object implements the Role interface.
+ */
+export declare function instanceOfRole(value: object): value is Role;
+export declare function RoleFromJSON(json: any): Role;
+export declare function RoleFromJSONTyped(json: any, ignoreDiscriminator: boolean): Role;
+export declare function RoleToJSON(json: any): Role;
+export declare function RoleToJSONTyped(value?: Role | null, ignoreDiscriminator?: boolean): any;

package/dist/models/Role.js

@@ -0,0 +1,70 @@
+"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.instanceOfRole = instanceOfRole;
+exports.RoleFromJSON = RoleFromJSON;
+exports.RoleFromJSONTyped = RoleFromJSONTyped;
+exports.RoleToJSON = RoleToJSON;
+exports.RoleToJSONTyped = RoleToJSONTyped;
+/**
+ * Check if a given object implements the Role interface.
+ */
+function instanceOfRole(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('permissions' in value) || value['permissions'] === undefined)
+        return false;
+    if (!('readonly' in value) || value['readonly'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    return true;
+}
+function RoleFromJSON(json) {
+    return RoleFromJSONTyped(json, false);
+}
+function RoleFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'permissions': json['permissions'],
+        'readonly': json['readonly'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+    };
+}
+function RoleToJSON(json) {
+    return RoleToJSONTyped(json, false);
+}
+function RoleToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'permissions': value['permissions'],
+        'readonly': value['readonly'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+    };
+}

package/dist/models/RoleMini.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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 RoleMini
+ */
+export interface RoleMini {
+    /**
+     *
+     * @type {number}
+     * @memberof RoleMini
+     */
+    id: number;
+    /**
+     *
+     * @type {string}
+     * @memberof RoleMini
+     */
+    name: string;
+}
+/**
+ * Check if a given object implements the RoleMini interface.
+ */
+export declare function instanceOfRoleMini(value: object): value is RoleMini;
+export declare function RoleMiniFromJSON(json: any): RoleMini;
+export declare function RoleMiniFromJSONTyped(json: any, ignoreDiscriminator: boolean): RoleMini;
+export declare function RoleMiniToJSON(json: any): RoleMini;
+export declare function RoleMiniToJSONTyped(value?: RoleMini | null, ignoreDiscriminator?: boolean): any;

package/dist/models/RoleMini.js

@@ -0,0 +1,54 @@
+"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.instanceOfRoleMini = instanceOfRoleMini;
+exports.RoleMiniFromJSON = RoleMiniFromJSON;
+exports.RoleMiniFromJSONTyped = RoleMiniFromJSONTyped;
+exports.RoleMiniToJSON = RoleMiniToJSON;
+exports.RoleMiniToJSONTyped = RoleMiniToJSONTyped;
+/**
+ * Check if a given object implements the RoleMini interface.
+ */
+function instanceOfRoleMini(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    return true;
+}
+function RoleMiniFromJSON(json) {
+    return RoleMiniFromJSONTyped(json, false);
+}
+function RoleMiniFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+    };
+}
+function RoleMiniToJSON(json) {
+    return RoleMiniToJSONTyped(json, false);
+}
+function RoleMiniToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+    };
+}

package/dist/models/RolePayload.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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 RolePayload
+ */
+export interface RolePayload {
+    /**
+     *
+     * @type {number}
+     * @memberof RolePayload
+     */
+    id?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof RolePayload
+     */
+    name: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof RolePayload
+     */
+    permissions: Array<string>;
+    /**
+     * Company ID
+     * @type {number}
+     * @memberof RolePayload
+     */
+    company: number;
+}
+/**
+ * Check if a given object implements the RolePayload interface.
+ */
+export declare function instanceOfRolePayload(value: object): value is RolePayload;
+export declare function RolePayloadFromJSON(json: any): RolePayload;
+export declare function RolePayloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): RolePayload;
+export declare function RolePayloadToJSON(json: any): RolePayload;
+export declare function RolePayloadToJSONTyped(value?: RolePayload | null, ignoreDiscriminator?: boolean): any;

package/dist/models/RolePayload.js

@@ -0,0 +1,60 @@
+"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.instanceOfRolePayload = instanceOfRolePayload;
+exports.RolePayloadFromJSON = RolePayloadFromJSON;
+exports.RolePayloadFromJSONTyped = RolePayloadFromJSONTyped;
+exports.RolePayloadToJSON = RolePayloadToJSON;
+exports.RolePayloadToJSONTyped = RolePayloadToJSONTyped;
+/**
+ * Check if a given object implements the RolePayload interface.
+ */
+function instanceOfRolePayload(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('permissions' in value) || value['permissions'] === undefined)
+        return false;
+    if (!('company' in value) || value['company'] === undefined)
+        return false;
+    return true;
+}
+function RolePayloadFromJSON(json) {
+    return RolePayloadFromJSONTyped(json, false);
+}
+function RolePayloadFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'name': json['name'],
+        'permissions': json['permissions'],
+        'company': json['company'],
+    };
+}
+function RolePayloadToJSON(json) {
+    return RolePayloadToJSONTyped(json, false);
+}
+function RolePayloadToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'permissions': value['permissions'],
+        'company': value['company'],
+    };
+}