@testcollab/sdk 3.1.1

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

@@ -0,0 +1,52 @@
+/**
+ * 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 SetNotificationPayloadInner
+ */
+export interface SetNotificationPayloadInner {
+    /**
+     *
+     * @type {string}
+     * @memberof SetNotificationPayloadInner
+     */
+    notification: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SetNotificationPayloadInner
+     */
+    scope: SetNotificationPayloadInnerScopeEnum;
+    /**
+     *
+     * @type {boolean}
+     * @memberof SetNotificationPayloadInner
+     */
+    enabled: boolean;
+}
+/**
+ * @export
+ */
+export declare const SetNotificationPayloadInnerScopeEnum: {
+    readonly AllProjects: "all-projects";
+    readonly MyProjects: "my-projects";
+};
+export type SetNotificationPayloadInnerScopeEnum = typeof SetNotificationPayloadInnerScopeEnum[keyof typeof SetNotificationPayloadInnerScopeEnum];
+/**
+ * Check if a given object implements the SetNotificationPayloadInner interface.
+ */
+export declare function instanceOfSetNotificationPayloadInner(value: object): value is SetNotificationPayloadInner;
+export declare function SetNotificationPayloadInnerFromJSON(json: any): SetNotificationPayloadInner;
+export declare function SetNotificationPayloadInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): SetNotificationPayloadInner;
+export declare function SetNotificationPayloadInnerToJSON(json: any): SetNotificationPayloadInner;
+export declare function SetNotificationPayloadInnerToJSONTyped(value?: SetNotificationPayloadInner | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/SetNotificationPayloadInner.js

@@ -0,0 +1,58 @@
+/* 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 SetNotificationPayloadInnerScopeEnum = {
+    AllProjects: 'all-projects',
+    MyProjects: 'my-projects'
+};
+/**
+ * Check if a given object implements the SetNotificationPayloadInner interface.
+ */
+export function instanceOfSetNotificationPayloadInner(value) {
+    if (!('notification' in value) || value['notification'] === undefined)
+        return false;
+    if (!('scope' in value) || value['scope'] === undefined)
+        return false;
+    if (!('enabled' in value) || value['enabled'] === undefined)
+        return false;
+    return true;
+}
+export function SetNotificationPayloadInnerFromJSON(json) {
+    return SetNotificationPayloadInnerFromJSONTyped(json, false);
+}
+export function SetNotificationPayloadInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'notification': json['notification'],
+        'scope': json['scope'],
+        'enabled': json['enabled'],
+    };
+}
+export function SetNotificationPayloadInnerToJSON(json) {
+    return SetNotificationPayloadInnerToJSONTyped(json, false);
+}
+export function SetNotificationPayloadInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'notification': value['notification'],
+        'scope': value['scope'],
+        'enabled': value['enabled'],
+    };
+}

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

@@ -0,0 +1,64 @@
+/**
+ * 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 Setting
+ */
+export interface Setting {
+    /**
+     *
+     * @type {string}
+     * @memberof Setting
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Setting
+     */
+    value: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Setting
+     */
+    label?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Setting
+     */
+    settingType?: SettingSettingTypeEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof Setting
+     */
+    company?: number;
+}
+/**
+ * @export
+ */
+export declare const SettingSettingTypeEnum: {
+    readonly General: "general";
+    readonly Email: "email";
+};
+export type SettingSettingTypeEnum = typeof SettingSettingTypeEnum[keyof typeof SettingSettingTypeEnum];
+/**
+ * Check if a given object implements the Setting interface.
+ */
+export declare function instanceOfSetting(value: object): value is Setting;
+export declare function SettingFromJSON(json: any): Setting;
+export declare function SettingFromJSONTyped(json: any, ignoreDiscriminator: boolean): Setting;
+export declare function SettingToJSON(json: any): Setting;
+export declare function SettingToJSONTyped(value?: Setting | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/Setting.js

@@ -0,0 +1,60 @@
+/* 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 SettingSettingTypeEnum = {
+    General: 'general',
+    Email: 'email'
+};
+/**
+ * Check if a given object implements the Setting interface.
+ */
+export function instanceOfSetting(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('value' in value) || value['value'] === undefined)
+        return false;
+    return true;
+}
+export function SettingFromJSON(json) {
+    return SettingFromJSONTyped(json, false);
+}
+export function SettingFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'value': json['value'],
+        'label': json['label'] == null ? undefined : json['label'],
+        'settingType': json['setting_type'] == null ? undefined : json['setting_type'],
+        'company': json['company'] == null ? undefined : json['company'],
+    };
+}
+export function SettingToJSON(json) {
+    return SettingToJSONTyped(json, false);
+}
+export function SettingToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'value': value['value'],
+        'label': value['label'],
+        'setting_type': value['settingType'],
+        'company': value['company'],
+    };
+}

package/dist/esm/models/SettingPayload.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 { Setting } from './Setting';
+/**
+ *
+ * @export
+ * @interface SettingPayload
+ */
+export interface SettingPayload {
+    /**
+     *
+     * @type {string}
+     * @memberof SettingPayload
+     */
+    settingType: string;
+    /**
+     *
+     * @type {Array<Setting>}
+     * @memberof SettingPayload
+     */
+    settings: Array<Setting>;
+    /**
+     *
+     * @type {number}
+     * @memberof SettingPayload
+     */
+    company: number;
+}
+/**
+ * Check if a given object implements the SettingPayload interface.
+ */
+export declare function instanceOfSettingPayload(value: object): value is SettingPayload;
+export declare function SettingPayloadFromJSON(json: any): SettingPayload;
+export declare function SettingPayloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): SettingPayload;
+export declare function SettingPayloadToJSON(json: any): SettingPayload;
+export declare function SettingPayloadToJSONTyped(value?: SettingPayload | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/SettingPayload.js

@@ -0,0 +1,52 @@
+/* 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 { SettingFromJSON, SettingToJSON, } from './Setting';
+/**
+ * Check if a given object implements the SettingPayload interface.
+ */
+export function instanceOfSettingPayload(value) {
+    if (!('settingType' in value) || value['settingType'] === undefined)
+        return false;
+    if (!('settings' in value) || value['settings'] === undefined)
+        return false;
+    if (!('company' in value) || value['company'] === undefined)
+        return false;
+    return true;
+}
+export function SettingPayloadFromJSON(json) {
+    return SettingPayloadFromJSONTyped(json, false);
+}
+export function SettingPayloadFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'settingType': json['setting_type'],
+        'settings': (json['settings'].map(SettingFromJSON)),
+        'company': json['company'],
+    };
+}
+export function SettingPayloadToJSON(json) {
+    return SettingPayloadToJSONTyped(json, false);
+}
+export function SettingPayloadToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'setting_type': value['settingType'],
+        'settings': (value['settings'].map(SettingToJSON)),
+        'company': value['company'],
+    };
+}

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

@@ -0,0 +1,44 @@
+/**
+ * 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 SetupProfilePayload
+ */
+export interface SetupProfilePayload {
+    /**
+     *
+     * @type {string}
+     * @memberof SetupProfilePayload
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SetupProfilePayload
+     */
+    inviteCode: string;
+    /**
+     * TODO- Encrypt this later. POST request shouldn't accept raw password maybe?
+     * @type {string}
+     * @memberof SetupProfilePayload
+     */
+    password: string;
+}
+/**
+ * Check if a given object implements the SetupProfilePayload interface.
+ */
+export declare function instanceOfSetupProfilePayload(value: object): value is SetupProfilePayload;
+export declare function SetupProfilePayloadFromJSON(json: any): SetupProfilePayload;
+export declare function SetupProfilePayloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): SetupProfilePayload;
+export declare function SetupProfilePayloadToJSON(json: any): SetupProfilePayload;
+export declare function SetupProfilePayloadToJSONTyped(value?: SetupProfilePayload | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/SetupProfilePayload.js

@@ -0,0 +1,51 @@
+/* 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 SetupProfilePayload interface.
+ */
+export function instanceOfSetupProfilePayload(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('inviteCode' in value) || value['inviteCode'] === undefined)
+        return false;
+    if (!('password' in value) || value['password'] === undefined)
+        return false;
+    return true;
+}
+export function SetupProfilePayloadFromJSON(json) {
+    return SetupProfilePayloadFromJSONTyped(json, false);
+}
+export function SetupProfilePayloadFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'inviteCode': json['invite_code'],
+        'password': json['password'],
+    };
+}
+export function SetupProfilePayloadToJSON(json) {
+    return SetupProfilePayloadToJSONTyped(json, false);
+}
+export function SetupProfilePayloadToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'invite_code': value['inviteCode'],
+        'password': value['password'],
+    };
+}

package/dist/esm/models/ShareEntityPayload.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 ShareEntityPayload
+ */
+export interface ShareEntityPayload {
+    /**
+     *
+     * @type {number}
+     * @memberof ShareEntityPayload
+     */
+    company: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ShareEntityPayload
+     */
+    project: number;
+    /**
+     *
+     * @type {string}
+     * @memberof ShareEntityPayload
+     */
+    entity: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ShareEntityPayload
+     */
+    entityId: number;
+    /**
+     *
+     * @type {string}
+     * @memberof ShareEntityPayload
+     */
+    expiresIn?: string;
+}
+/**
+ * Check if a given object implements the ShareEntityPayload interface.
+ */
+export declare function instanceOfShareEntityPayload(value: object): value is ShareEntityPayload;
+export declare function ShareEntityPayloadFromJSON(json: any): ShareEntityPayload;
+export declare function ShareEntityPayloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): ShareEntityPayload;
+export declare function ShareEntityPayloadToJSON(json: any): ShareEntityPayload;
+export declare function ShareEntityPayloadToJSONTyped(value?: ShareEntityPayload | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ShareEntityPayload.js

@@ -0,0 +1,57 @@
+/* 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 ShareEntityPayload interface.
+ */
+export function instanceOfShareEntityPayload(value) {
+    if (!('company' in value) || value['company'] === undefined)
+        return false;
+    if (!('project' in value) || value['project'] === undefined)
+        return false;
+    if (!('entity' in value) || value['entity'] === undefined)
+        return false;
+    if (!('entityId' in value) || value['entityId'] === undefined)
+        return false;
+    return true;
+}
+export function ShareEntityPayloadFromJSON(json) {
+    return ShareEntityPayloadFromJSONTyped(json, false);
+}
+export function ShareEntityPayloadFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'company': json['company'],
+        'project': json['project'],
+        'entity': json['entity'],
+        'entityId': json['entityId'],
+        'expiresIn': json['expiresIn'] == null ? undefined : json['expiresIn'],
+    };
+}
+export function ShareEntityPayloadToJSON(json) {
+    return ShareEntityPayloadToJSONTyped(json, false);
+}
+export function ShareEntityPayloadToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'company': value['company'],
+        'project': value['project'],
+        'entity': value['entity'],
+        'entityId': value['entityId'],
+        'expiresIn': value['expiresIn'],
+    };
+}

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

@@ -0,0 +1,44 @@
+/**
+ * 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 ShareEntityResult
+ */
+export interface ShareEntityResult {
+    /**
+     *
+     * @type {boolean}
+     * @memberof ShareEntityResult
+     */
+    status: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof ShareEntityResult
+     */
+    message?: string;
+    /**
+     * Public JWT
+     * @type {string}
+     * @memberof ShareEntityResult
+     */
+    jwt?: string;
+}
+/**
+ * Check if a given object implements the ShareEntityResult interface.
+ */
+export declare function instanceOfShareEntityResult(value: object): value is ShareEntityResult;
+export declare function ShareEntityResultFromJSON(json: any): ShareEntityResult;
+export declare function ShareEntityResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): ShareEntityResult;
+export declare function ShareEntityResultToJSON(json: any): ShareEntityResult;
+export declare function ShareEntityResultToJSONTyped(value?: ShareEntityResult | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ShareEntityResult.js

@@ -0,0 +1,47 @@
+/* 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 ShareEntityResult interface.
+ */
+export function instanceOfShareEntityResult(value) {
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    return true;
+}
+export function ShareEntityResultFromJSON(json) {
+    return ShareEntityResultFromJSONTyped(json, false);
+}
+export function ShareEntityResultFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'status': json['status'],
+        'message': json['message'] == null ? undefined : json['message'],
+        'jwt': json['jwt'] == null ? undefined : json['jwt'],
+    };
+}
+export function ShareEntityResultToJSON(json) {
+    return ShareEntityResultToJSONTyped(json, false);
+}
+export function ShareEntityResultToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'status': value['status'],
+        'message': value['message'],
+        'jwt': value['jwt'],
+    };
+}