@thoughtspot/rest-api-sdk
Advanced tools
| /** | ||
| * ThoughtSpot Public REST API | ||
| * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) | ||
| * | ||
| * OpenAPI spec version: 2.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| */ | ||
| import { HttpFile } from '../http/http'; | ||
| /** | ||
| * Cluster-level non-embed access configuration. | ||
| */ | ||
| export class ClusterNonEmbedAccess { | ||
| /** | ||
| * Block full application access for non-embedded usage. | ||
| */ | ||
| 'block_full_app_access'?: boolean | null; | ||
| static readonly discriminator: string | undefined = undefined; | ||
| static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ | ||
| { | ||
| "name": "block_full_app_access", | ||
| "baseName": "block_full_app_access", | ||
| "type": "boolean", | ||
| "format": "" | ||
| } ]; | ||
| static getAttributeTypeMap() { | ||
| return ClusterNonEmbedAccess.attributeTypeMap; | ||
| } | ||
| public constructor() { | ||
| } | ||
| } | ||
| /** | ||
| * ThoughtSpot Public REST API | ||
| * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) | ||
| * | ||
| * OpenAPI spec version: 2.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| */ | ||
| import { HttpFile } from '../http/http'; | ||
| /** | ||
| * Input for cluster-level non-embed access configuration. | ||
| */ | ||
| export class ClusterNonEmbedAccessInput { | ||
| /** | ||
| * Block full application access for non-embedded usage. | ||
| */ | ||
| 'block_full_app_access'?: boolean | null; | ||
| static readonly discriminator: string | undefined = undefined; | ||
| static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ | ||
| { | ||
| "name": "block_full_app_access", | ||
| "baseName": "block_full_app_access", | ||
| "type": "boolean", | ||
| "format": "" | ||
| } ]; | ||
| static getAttributeTypeMap() { | ||
| return ClusterNonEmbedAccessInput.attributeTypeMap; | ||
| } | ||
| public constructor() { | ||
| } | ||
| } | ||
| /** | ||
| * ThoughtSpot Public REST API | ||
| * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) | ||
| * | ||
| * OpenAPI spec version: 2.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| */ | ||
| import { ConfigureSecuritySettingsRequestClusterPreferences } from '../models/ConfigureSecuritySettingsRequestClusterPreferences'; | ||
| import { SecuritySettingsOrgPreferencesInput } from '../models/SecuritySettingsOrgPreferencesInput'; | ||
| import { HttpFile } from '../http/http'; | ||
| export class ConfigureSecuritySettingsRequest { | ||
| 'cluster_preferences'?: ConfigureSecuritySettingsRequestClusterPreferences; | ||
| /** | ||
| * Org-level security preferences for the current org. | ||
| */ | ||
| 'org_preferences'?: Array<SecuritySettingsOrgPreferencesInput>; | ||
| static readonly discriminator: string | undefined = undefined; | ||
| static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ | ||
| { | ||
| "name": "cluster_preferences", | ||
| "baseName": "cluster_preferences", | ||
| "type": "ConfigureSecuritySettingsRequestClusterPreferences", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "org_preferences", | ||
| "baseName": "org_preferences", | ||
| "type": "Array<SecuritySettingsOrgPreferencesInput>", | ||
| "format": "" | ||
| } ]; | ||
| static getAttributeTypeMap() { | ||
| return ConfigureSecuritySettingsRequest.attributeTypeMap; | ||
| } | ||
| public constructor() { | ||
| } | ||
| } | ||
| /** | ||
| * ThoughtSpot Public REST API | ||
| * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) | ||
| * | ||
| * OpenAPI spec version: 2.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| */ | ||
| import { ClusterNonEmbedAccessInput } from '../models/ClusterNonEmbedAccessInput'; | ||
| import { CspSettingsInput } from '../models/CspSettingsInput'; | ||
| import { HttpFile } from '../http/http'; | ||
| /** | ||
| * Cluster-level security preferences. | ||
| */ | ||
| export class ConfigureSecuritySettingsRequestClusterPreferences { | ||
| /** | ||
| * Support embedded access when third-party cookies are blocked. | ||
| */ | ||
| 'enable_partitioned_cookies'?: boolean | null; | ||
| /** | ||
| * Allowed origins for CORS. | ||
| */ | ||
| 'cors_whitelisted_urls'?: Array<string> | null; | ||
| 'csp_settings'?: CspSettingsInput; | ||
| /** | ||
| * Allowed redirect hosts for SAML login. | ||
| */ | ||
| 'saml_redirect_urls'?: Array<string> | null; | ||
| 'non_embed_access'?: ClusterNonEmbedAccessInput; | ||
| static readonly discriminator: string | undefined = undefined; | ||
| static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ | ||
| { | ||
| "name": "enable_partitioned_cookies", | ||
| "baseName": "enable_partitioned_cookies", | ||
| "type": "boolean", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "cors_whitelisted_urls", | ||
| "baseName": "cors_whitelisted_urls", | ||
| "type": "Array<string>", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "csp_settings", | ||
| "baseName": "csp_settings", | ||
| "type": "CspSettingsInput", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "saml_redirect_urls", | ||
| "baseName": "saml_redirect_urls", | ||
| "type": "Array<string>", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "non_embed_access", | ||
| "baseName": "non_embed_access", | ||
| "type": "ClusterNonEmbedAccessInput", | ||
| "format": "" | ||
| } ]; | ||
| static getAttributeTypeMap() { | ||
| return ConfigureSecuritySettingsRequestClusterPreferences.attributeTypeMap; | ||
| } | ||
| public constructor() { | ||
| } | ||
| } | ||
| /** | ||
| * ThoughtSpot Public REST API | ||
| * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) | ||
| * | ||
| * OpenAPI spec version: 2.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| */ | ||
| import { HttpFile } from '../http/http'; | ||
| /** | ||
| * This attribute is only applicable to parameterized connections. Ensure that the policy is set to Processes to allow the configuration to be used exclusively for system processes. Version: 26.2.0.cl or later | ||
| */ | ||
| export class CreateConnectionConfigurationRequestPolicyProcessOptions { | ||
| 'impersonate_user'?: string | null; | ||
| static readonly discriminator: string | undefined = undefined; | ||
| static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ | ||
| { | ||
| "name": "impersonate_user", | ||
| "baseName": "impersonate_user", | ||
| "type": "string", | ||
| "format": "" | ||
| } ]; | ||
| static getAttributeTypeMap() { | ||
| return CreateConnectionConfigurationRequestPolicyProcessOptions.attributeTypeMap; | ||
| } | ||
| public constructor() { | ||
| } | ||
| } | ||
| /** | ||
| * ThoughtSpot Public REST API | ||
| * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) | ||
| * | ||
| * OpenAPI spec version: 2.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| */ | ||
| import { ScriptSrcUrls } from '../models/ScriptSrcUrls'; | ||
| import { HttpFile } from '../http/http'; | ||
| /** | ||
| * CSP (Content Security Policy) settings. | ||
| */ | ||
| export class CspSettings { | ||
| /** | ||
| * Allowed URLs for connect-src directive. | ||
| */ | ||
| 'connect_src_urls'?: Array<string> | null; | ||
| /** | ||
| * Allowed URLs for font-src directive. | ||
| */ | ||
| 'font_src_urls'?: Array<string> | null; | ||
| /** | ||
| * Allowed hosts for visual embed (frame-ancestors directive). | ||
| */ | ||
| 'visual_embed_hosts'?: Array<string> | null; | ||
| /** | ||
| * Allowed URLs for frame-src directive. | ||
| */ | ||
| 'iframe_src_urls'?: Array<string> | null; | ||
| /** | ||
| * Allowed URLs for img-src directive. | ||
| */ | ||
| 'img_src_urls'?: Array<string> | null; | ||
| 'script_src_urls'?: ScriptSrcUrls; | ||
| /** | ||
| * Allowed URLs for style-src directive. | ||
| */ | ||
| 'style_src_urls'?: Array<string> | null; | ||
| static readonly discriminator: string | undefined = undefined; | ||
| static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ | ||
| { | ||
| "name": "connect_src_urls", | ||
| "baseName": "connect_src_urls", | ||
| "type": "Array<string>", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "font_src_urls", | ||
| "baseName": "font_src_urls", | ||
| "type": "Array<string>", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "visual_embed_hosts", | ||
| "baseName": "visual_embed_hosts", | ||
| "type": "Array<string>", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "iframe_src_urls", | ||
| "baseName": "iframe_src_urls", | ||
| "type": "Array<string>", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "img_src_urls", | ||
| "baseName": "img_src_urls", | ||
| "type": "Array<string>", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "script_src_urls", | ||
| "baseName": "script_src_urls", | ||
| "type": "ScriptSrcUrls", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "style_src_urls", | ||
| "baseName": "style_src_urls", | ||
| "type": "Array<string>", | ||
| "format": "" | ||
| } ]; | ||
| static getAttributeTypeMap() { | ||
| return CspSettings.attributeTypeMap; | ||
| } | ||
| public constructor() { | ||
| } | ||
| } | ||
| /** | ||
| * ThoughtSpot Public REST API | ||
| * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) | ||
| * | ||
| * OpenAPI spec version: 2.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| */ | ||
| import { ScriptSrcUrlsInput } from '../models/ScriptSrcUrlsInput'; | ||
| import { HttpFile } from '../http/http'; | ||
| /** | ||
| * Input for CSP (Content Security Policy) settings. | ||
| */ | ||
| export class CspSettingsInput { | ||
| /** | ||
| * Allowed URLs for connect-src directive. | ||
| */ | ||
| 'connect_src_urls'?: Array<string> | null; | ||
| /** | ||
| * Allowed URLs for font-src directive. | ||
| */ | ||
| 'font_src_urls'?: Array<string> | null; | ||
| /** | ||
| * Allowed hosts for visual embed (frame-ancestors directive). | ||
| */ | ||
| 'visual_embed_hosts'?: Array<string> | null; | ||
| /** | ||
| * Allowed URLs for frame-src directive. | ||
| */ | ||
| 'iframe_src_urls'?: Array<string> | null; | ||
| /** | ||
| * Allowed URLs for img-src directive. | ||
| */ | ||
| 'img_src_urls'?: Array<string> | null; | ||
| 'script_src_urls'?: ScriptSrcUrlsInput; | ||
| /** | ||
| * Allowed URLs for style-src directive. | ||
| */ | ||
| 'style_src_urls'?: Array<string> | null; | ||
| static readonly discriminator: string | undefined = undefined; | ||
| static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ | ||
| { | ||
| "name": "connect_src_urls", | ||
| "baseName": "connect_src_urls", | ||
| "type": "Array<string>", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "font_src_urls", | ||
| "baseName": "font_src_urls", | ||
| "type": "Array<string>", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "visual_embed_hosts", | ||
| "baseName": "visual_embed_hosts", | ||
| "type": "Array<string>", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "iframe_src_urls", | ||
| "baseName": "iframe_src_urls", | ||
| "type": "Array<string>", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "img_src_urls", | ||
| "baseName": "img_src_urls", | ||
| "type": "Array<string>", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "script_src_urls", | ||
| "baseName": "script_src_urls", | ||
| "type": "ScriptSrcUrlsInput", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "style_src_urls", | ||
| "baseName": "style_src_urls", | ||
| "type": "Array<string>", | ||
| "format": "" | ||
| } ]; | ||
| static getAttributeTypeMap() { | ||
| return CspSettingsInput.attributeTypeMap; | ||
| } | ||
| public constructor() { | ||
| } | ||
| } | ||
| /** | ||
| * ThoughtSpot Public REST API | ||
| * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) | ||
| * | ||
| * OpenAPI spec version: 2.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| */ | ||
| import { HttpFile } from '../http/http'; | ||
| /** | ||
| * Group information for non-embed access. | ||
| */ | ||
| export class GroupInfo { | ||
| /** | ||
| * Unique identifier of the group. | ||
| */ | ||
| 'id'?: string | null; | ||
| /** | ||
| * Name of the group. | ||
| */ | ||
| 'name'?: string | null; | ||
| static readonly discriminator: string | undefined = undefined; | ||
| static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ | ||
| { | ||
| "name": "id", | ||
| "baseName": "id", | ||
| "type": "string", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "name", | ||
| "baseName": "name", | ||
| "type": "string", | ||
| "format": "" | ||
| } ]; | ||
| static getAttributeTypeMap() { | ||
| return GroupInfo.attributeTypeMap; | ||
| } | ||
| public constructor() { | ||
| } | ||
| } | ||
| /** | ||
| * ThoughtSpot Public REST API | ||
| * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) | ||
| * | ||
| * OpenAPI spec version: 2.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| */ | ||
| import { GroupInfo } from '../models/GroupInfo'; | ||
| import { HttpFile } from '../http/http'; | ||
| /** | ||
| * Org-level non-embed access configuration. | ||
| */ | ||
| export class OrgNonEmbedAccess { | ||
| /** | ||
| * Block full application access for non-embedded usage. | ||
| */ | ||
| 'block_full_app_access'?: boolean | null; | ||
| /** | ||
| * Groups that have non-embed full app access. | ||
| */ | ||
| 'groups_with_access'?: Array<GroupInfo> | null; | ||
| static readonly discriminator: string | undefined = undefined; | ||
| static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ | ||
| { | ||
| "name": "block_full_app_access", | ||
| "baseName": "block_full_app_access", | ||
| "type": "boolean", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "groups_with_access", | ||
| "baseName": "groups_with_access", | ||
| "type": "Array<GroupInfo>", | ||
| "format": "" | ||
| } ]; | ||
| static getAttributeTypeMap() { | ||
| return OrgNonEmbedAccess.attributeTypeMap; | ||
| } | ||
| public constructor() { | ||
| } | ||
| } | ||
| /** | ||
| * ThoughtSpot Public REST API | ||
| * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) | ||
| * | ||
| * OpenAPI spec version: 2.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| */ | ||
| import { HttpFile } from '../http/http'; | ||
| /** | ||
| * Input for org-level non-embed access configuration. | ||
| */ | ||
| export class OrgNonEmbedAccessInput { | ||
| /** | ||
| * Block full application access for non-embedded usage. | ||
| */ | ||
| 'block_full_app_access'?: boolean | null; | ||
| /** | ||
| * Group identifiers that are allowed non-embed full app access. Can only be set if block_full_app_access is true. | ||
| */ | ||
| 'groups_identifiers_with_access'?: Array<string> | null; | ||
| static readonly discriminator: string | undefined = undefined; | ||
| static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ | ||
| { | ||
| "name": "block_full_app_access", | ||
| "baseName": "block_full_app_access", | ||
| "type": "boolean", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "groups_identifiers_with_access", | ||
| "baseName": "groups_identifiers_with_access", | ||
| "type": "Array<string>", | ||
| "format": "" | ||
| } ]; | ||
| static getAttributeTypeMap() { | ||
| return OrgNonEmbedAccessInput.attributeTypeMap; | ||
| } | ||
| public constructor() { | ||
| } | ||
| } | ||
| /** | ||
| * ThoughtSpot Public REST API | ||
| * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) | ||
| * | ||
| * OpenAPI spec version: 2.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| */ | ||
| import { HttpFile } from '../http/http'; | ||
| export class PolicyProcessOptions { | ||
| 'impersonate_user'?: string | null; | ||
| static readonly discriminator: string | undefined = undefined; | ||
| static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ | ||
| { | ||
| "name": "impersonate_user", | ||
| "baseName": "impersonate_user", | ||
| "type": "string", | ||
| "format": "" | ||
| } ]; | ||
| static getAttributeTypeMap() { | ||
| return PolicyProcessOptions.attributeTypeMap; | ||
| } | ||
| public constructor() { | ||
| } | ||
| } | ||
| /** | ||
| * ThoughtSpot Public REST API | ||
| * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) | ||
| * | ||
| * OpenAPI spec version: 2.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| */ | ||
| import { HttpFile } from '../http/http'; | ||
| export class PolicyProcessOptionsInput { | ||
| 'impersonate_user'?: string | null; | ||
| static readonly discriminator: string | undefined = undefined; | ||
| static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ | ||
| { | ||
| "name": "impersonate_user", | ||
| "baseName": "impersonate_user", | ||
| "type": "string", | ||
| "format": "" | ||
| } ]; | ||
| static getAttributeTypeMap() { | ||
| return PolicyProcessOptionsInput.attributeTypeMap; | ||
| } | ||
| public constructor() { | ||
| } | ||
| } | ||
| /** | ||
| * ThoughtSpot Public REST API | ||
| * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) | ||
| * | ||
| * OpenAPI spec version: 2.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| */ | ||
| import { HttpFile } from '../http/http'; | ||
| export class RevokeRefreshTokensRequest { | ||
| /** | ||
| * Unique ID or name of the configuration. When provided, the refresh tokens of the users associated with the connection configuration will be revoked. | ||
| */ | ||
| 'configuration_identifiers'?: Array<string>; | ||
| /** | ||
| * Unique ID or name of the users. When provided, the refresh tokens of the specified users will be revoked. If the request includes the user ID or name of the connection author, their token will also be revoked. | ||
| */ | ||
| 'user_identifiers'?: Array<string>; | ||
| /** | ||
| * Unique ID or name of the Org. When provided, the refresh tokens of all users associated with the published connection in the Org will be revoked. This parameter is valid only for published connections. Using it with unpublished connections will result in an error. | ||
| */ | ||
| 'org_identifiers'?: Array<string>; | ||
| static readonly discriminator: string | undefined = undefined; | ||
| static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ | ||
| { | ||
| "name": "configuration_identifiers", | ||
| "baseName": "configuration_identifiers", | ||
| "type": "Array<string>", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "user_identifiers", | ||
| "baseName": "user_identifiers", | ||
| "type": "Array<string>", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "org_identifiers", | ||
| "baseName": "org_identifiers", | ||
| "type": "Array<string>", | ||
| "format": "" | ||
| } ]; | ||
| static getAttributeTypeMap() { | ||
| return RevokeRefreshTokensRequest.attributeTypeMap; | ||
| } | ||
| public constructor() { | ||
| } | ||
| } | ||
| /** | ||
| * ThoughtSpot Public REST API | ||
| * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) | ||
| * | ||
| * OpenAPI spec version: 2.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| */ | ||
| import { HttpFile } from '../http/http'; | ||
| export class RevokeRefreshTokensResponse { | ||
| /** | ||
| * Result message describing the outcome of the refresh token revocation operation. | ||
| */ | ||
| 'data': string; | ||
| static readonly discriminator: string | undefined = undefined; | ||
| static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ | ||
| { | ||
| "name": "data", | ||
| "baseName": "data", | ||
| "type": "string", | ||
| "format": "" | ||
| } ]; | ||
| static getAttributeTypeMap() { | ||
| return RevokeRefreshTokensResponse.attributeTypeMap; | ||
| } | ||
| public constructor() { | ||
| } | ||
| } | ||
| /** | ||
| * ThoughtSpot Public REST API | ||
| * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) | ||
| * | ||
| * OpenAPI spec version: 2.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| */ | ||
| import { HttpFile } from '../http/http'; | ||
| /** | ||
| * Script-src CSP settings. | ||
| */ | ||
| export class ScriptSrcUrls { | ||
| /** | ||
| * Whether script-src customization is enabled. | ||
| */ | ||
| 'enabled'?: boolean | null; | ||
| /** | ||
| * Allowed URLs for script-src directive. Can only be set if enabled is true. | ||
| */ | ||
| 'urls'?: Array<string> | null; | ||
| static readonly discriminator: string | undefined = undefined; | ||
| static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ | ||
| { | ||
| "name": "enabled", | ||
| "baseName": "enabled", | ||
| "type": "boolean", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "urls", | ||
| "baseName": "urls", | ||
| "type": "Array<string>", | ||
| "format": "" | ||
| } ]; | ||
| static getAttributeTypeMap() { | ||
| return ScriptSrcUrls.attributeTypeMap; | ||
| } | ||
| public constructor() { | ||
| } | ||
| } | ||
| /** | ||
| * ThoughtSpot Public REST API | ||
| * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) | ||
| * | ||
| * OpenAPI spec version: 2.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| */ | ||
| import { HttpFile } from '../http/http'; | ||
| /** | ||
| * Input for script-src CSP settings. | ||
| */ | ||
| export class ScriptSrcUrlsInput { | ||
| /** | ||
| * Whether script-src customization is enabled. | ||
| */ | ||
| 'enabled'?: boolean | null; | ||
| /** | ||
| * Allowed URLs for script-src directive. Can only be set if enabled is true. | ||
| */ | ||
| 'urls'?: Array<string> | null; | ||
| static readonly discriminator: string | undefined = undefined; | ||
| static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ | ||
| { | ||
| "name": "enabled", | ||
| "baseName": "enabled", | ||
| "type": "boolean", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "urls", | ||
| "baseName": "urls", | ||
| "type": "Array<string>", | ||
| "format": "" | ||
| } ]; | ||
| static getAttributeTypeMap() { | ||
| return ScriptSrcUrlsInput.attributeTypeMap; | ||
| } | ||
| public constructor() { | ||
| } | ||
| } | ||
| /** | ||
| * ThoughtSpot Public REST API | ||
| * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) | ||
| * | ||
| * OpenAPI spec version: 2.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| */ | ||
| import { HttpFile } from '../http/http'; | ||
| export class SearchSecuritySettingsRequest { | ||
| /** | ||
| * Scope of security settings to retrieve. CLUSTER returns cluster-level settings, ORG returns org-level settings for the current org. If not specified, returns both cluster and org settings based on user privileges. | ||
| */ | ||
| 'scope'?: SearchSecuritySettingsRequestScopeEnum; | ||
| static readonly discriminator: string | undefined = undefined; | ||
| static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ | ||
| { | ||
| "name": "scope", | ||
| "baseName": "scope", | ||
| "type": "SearchSecuritySettingsRequestScopeEnum", | ||
| "format": "" | ||
| } ]; | ||
| static getAttributeTypeMap() { | ||
| return SearchSecuritySettingsRequest.attributeTypeMap; | ||
| } | ||
| public constructor() { | ||
| } | ||
| } | ||
| export type SearchSecuritySettingsRequestScopeEnum = "CLUSTER" | "ORG" ; | ||
| /** | ||
| * ThoughtSpot Public REST API | ||
| * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) | ||
| * | ||
| * OpenAPI spec version: 2.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| */ | ||
| import { ClusterNonEmbedAccess } from '../models/ClusterNonEmbedAccess'; | ||
| import { CspSettings } from '../models/CspSettings'; | ||
| import { HttpFile } from '../http/http'; | ||
| /** | ||
| * Cluster-level security preferences. | ||
| */ | ||
| export class SecuritySettingsClusterPreferences { | ||
| /** | ||
| * Support embedded access when third-party cookies are blocked. | ||
| */ | ||
| 'enable_partitioned_cookies'?: boolean | null; | ||
| /** | ||
| * Allowed origins for CORS. | ||
| */ | ||
| 'cors_whitelisted_urls'?: Array<string> | null; | ||
| 'csp_settings'?: CspSettings; | ||
| /** | ||
| * Allowed redirect hosts for SAML login. | ||
| */ | ||
| 'saml_redirect_urls'?: Array<string> | null; | ||
| 'non_embed_access'?: ClusterNonEmbedAccess; | ||
| static readonly discriminator: string | undefined = undefined; | ||
| static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ | ||
| { | ||
| "name": "enable_partitioned_cookies", | ||
| "baseName": "enable_partitioned_cookies", | ||
| "type": "boolean", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "cors_whitelisted_urls", | ||
| "baseName": "cors_whitelisted_urls", | ||
| "type": "Array<string>", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "csp_settings", | ||
| "baseName": "csp_settings", | ||
| "type": "CspSettings", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "saml_redirect_urls", | ||
| "baseName": "saml_redirect_urls", | ||
| "type": "Array<string>", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "non_embed_access", | ||
| "baseName": "non_embed_access", | ||
| "type": "ClusterNonEmbedAccess", | ||
| "format": "" | ||
| } ]; | ||
| static getAttributeTypeMap() { | ||
| return SecuritySettingsClusterPreferences.attributeTypeMap; | ||
| } | ||
| public constructor() { | ||
| } | ||
| } | ||
| /** | ||
| * ThoughtSpot Public REST API | ||
| * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) | ||
| * | ||
| * OpenAPI spec version: 2.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| */ | ||
| import { ClusterNonEmbedAccessInput } from '../models/ClusterNonEmbedAccessInput'; | ||
| import { CspSettingsInput } from '../models/CspSettingsInput'; | ||
| import { HttpFile } from '../http/http'; | ||
| /** | ||
| * Input for cluster-level security preferences configuration. | ||
| */ | ||
| export class SecuritySettingsClusterPreferencesInput { | ||
| /** | ||
| * Support embedded access when third-party cookies are blocked. | ||
| */ | ||
| 'enable_partitioned_cookies'?: boolean | null; | ||
| /** | ||
| * Allowed origins for CORS. | ||
| */ | ||
| 'cors_whitelisted_urls'?: Array<string> | null; | ||
| 'csp_settings'?: CspSettingsInput; | ||
| /** | ||
| * Allowed redirect hosts for SAML login. | ||
| */ | ||
| 'saml_redirect_urls'?: Array<string> | null; | ||
| 'non_embed_access'?: ClusterNonEmbedAccessInput; | ||
| static readonly discriminator: string | undefined = undefined; | ||
| static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ | ||
| { | ||
| "name": "enable_partitioned_cookies", | ||
| "baseName": "enable_partitioned_cookies", | ||
| "type": "boolean", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "cors_whitelisted_urls", | ||
| "baseName": "cors_whitelisted_urls", | ||
| "type": "Array<string>", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "csp_settings", | ||
| "baseName": "csp_settings", | ||
| "type": "CspSettingsInput", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "saml_redirect_urls", | ||
| "baseName": "saml_redirect_urls", | ||
| "type": "Array<string>", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "non_embed_access", | ||
| "baseName": "non_embed_access", | ||
| "type": "ClusterNonEmbedAccessInput", | ||
| "format": "" | ||
| } ]; | ||
| static getAttributeTypeMap() { | ||
| return SecuritySettingsClusterPreferencesInput.attributeTypeMap; | ||
| } | ||
| public constructor() { | ||
| } | ||
| } | ||
| /** | ||
| * ThoughtSpot Public REST API | ||
| * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) | ||
| * | ||
| * OpenAPI spec version: 2.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| */ | ||
| import { HttpFile } from '../http/http'; | ||
| /** | ||
| * Org details for security settings. | ||
| */ | ||
| export class SecuritySettingsOrgDetails { | ||
| /** | ||
| * Unique identifier of the org. | ||
| */ | ||
| 'id'?: number | null; | ||
| /** | ||
| * Name of the org. | ||
| */ | ||
| 'name'?: string | null; | ||
| static readonly discriminator: string | undefined = undefined; | ||
| static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ | ||
| { | ||
| "name": "id", | ||
| "baseName": "id", | ||
| "type": "number", | ||
| "format": "int32" | ||
| }, | ||
| { | ||
| "name": "name", | ||
| "baseName": "name", | ||
| "type": "string", | ||
| "format": "" | ||
| } ]; | ||
| static getAttributeTypeMap() { | ||
| return SecuritySettingsOrgDetails.attributeTypeMap; | ||
| } | ||
| public constructor() { | ||
| } | ||
| } | ||
| /** | ||
| * ThoughtSpot Public REST API | ||
| * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) | ||
| * | ||
| * OpenAPI spec version: 2.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| */ | ||
| import { OrgNonEmbedAccess } from '../models/OrgNonEmbedAccess'; | ||
| import { SecuritySettingsOrgDetails } from '../models/SecuritySettingsOrgDetails'; | ||
| import { HttpFile } from '../http/http'; | ||
| /** | ||
| * Org-level security preferences. | ||
| */ | ||
| export class SecuritySettingsOrgPreferences { | ||
| 'org'?: SecuritySettingsOrgDetails; | ||
| /** | ||
| * Allowed origins for CORS for this org. | ||
| */ | ||
| 'cors_whitelisted_urls'?: Array<string> | null; | ||
| 'non_embed_access'?: OrgNonEmbedAccess; | ||
| static readonly discriminator: string | undefined = undefined; | ||
| static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ | ||
| { | ||
| "name": "org", | ||
| "baseName": "org", | ||
| "type": "SecuritySettingsOrgDetails", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "cors_whitelisted_urls", | ||
| "baseName": "cors_whitelisted_urls", | ||
| "type": "Array<string>", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "non_embed_access", | ||
| "baseName": "non_embed_access", | ||
| "type": "OrgNonEmbedAccess", | ||
| "format": "" | ||
| } ]; | ||
| static getAttributeTypeMap() { | ||
| return SecuritySettingsOrgPreferences.attributeTypeMap; | ||
| } | ||
| public constructor() { | ||
| } | ||
| } | ||
| /** | ||
| * ThoughtSpot Public REST API | ||
| * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) | ||
| * | ||
| * OpenAPI spec version: 2.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| */ | ||
| import { OrgNonEmbedAccessInput } from '../models/OrgNonEmbedAccessInput'; | ||
| import { HttpFile } from '../http/http'; | ||
| /** | ||
| * Input for org-level security preferences configuration. Note: cross-org operations are not supported currently. | ||
| */ | ||
| export class SecuritySettingsOrgPreferencesInput { | ||
| /** | ||
| * Unique identifier or name of the org | ||
| */ | ||
| 'org_identifier': string; | ||
| /** | ||
| * Allowed origins for CORS for this org. | ||
| */ | ||
| 'cors_whitelisted_urls'?: Array<string> | null; | ||
| 'non_embed_access'?: OrgNonEmbedAccessInput; | ||
| static readonly discriminator: string | undefined = undefined; | ||
| static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ | ||
| { | ||
| "name": "org_identifier", | ||
| "baseName": "org_identifier", | ||
| "type": "string", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "cors_whitelisted_urls", | ||
| "baseName": "cors_whitelisted_urls", | ||
| "type": "Array<string>", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "non_embed_access", | ||
| "baseName": "non_embed_access", | ||
| "type": "OrgNonEmbedAccessInput", | ||
| "format": "" | ||
| } ]; | ||
| static getAttributeTypeMap() { | ||
| return SecuritySettingsOrgPreferencesInput.attributeTypeMap; | ||
| } | ||
| public constructor() { | ||
| } | ||
| } | ||
| /** | ||
| * ThoughtSpot Public REST API | ||
| * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) | ||
| * | ||
| * OpenAPI spec version: 2.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| */ | ||
| import { SecuritySettingsClusterPreferences } from '../models/SecuritySettingsClusterPreferences'; | ||
| import { SecuritySettingsOrgPreferences } from '../models/SecuritySettingsOrgPreferences'; | ||
| import { HttpFile } from '../http/http'; | ||
| /** | ||
| * Response type for security settings search. | ||
| */ | ||
| export class SecuritySettingsResponse { | ||
| 'cluster_preferences'?: SecuritySettingsClusterPreferences; | ||
| /** | ||
| * Org-level security preferences. | ||
| */ | ||
| 'org_preferences'?: Array<SecuritySettingsOrgPreferences> | null; | ||
| static readonly discriminator: string | undefined = undefined; | ||
| static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ | ||
| { | ||
| "name": "cluster_preferences", | ||
| "baseName": "cluster_preferences", | ||
| "type": "SecuritySettingsClusterPreferences", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "org_preferences", | ||
| "baseName": "org_preferences", | ||
| "type": "Array<SecuritySettingsOrgPreferences>", | ||
| "format": "" | ||
| } ]; | ||
| static getAttributeTypeMap() { | ||
| return SecuritySettingsResponse.attributeTypeMap; | ||
| } | ||
| public constructor() { | ||
| } | ||
| } | ||
| import chai from "chai"; | ||
| import chaiAsPromised from "chai-as-promised"; | ||
| import { createBearerAuthenticationConfig } from "../utils/config"; | ||
| import { PromiseWebhooksApi } from "../types/PromiseAPI"; | ||
| import requestBodies from "./testDataUpdated.json"; | ||
| chai.use(chaiAsPromised); | ||
| const expect = chai.expect; | ||
| const baseUrlFromCli = process.argv.filter(s => s.startsWith("--baseUrl="))?.[0]?.split("=")?.[1] | ||
| const BASE_URL = baseUrlFromCli || "http://127.0.0.1:4123" | ||
| const config = createBearerAuthenticationConfig(BASE_URL, { | ||
| username: "tsadmin", | ||
| password: "admin", | ||
| }); | ||
| const instance = new PromiseWebhooksApi(config); | ||
| describe('WebhooksApi', function() { | ||
| describe('createWebhookConfiguration', function() { | ||
| const testReqBodies = requestBodies.filter( | ||
| (body: any) => body.Metadata.operationId === "createWebhookConfiguration" | ||
| ); | ||
| testReqBodies.forEach(async (test: any) => { | ||
| it(`${test.Metadata.operationId} - ${test.Metadata.scenario} : Testid - ${test.Metadata.testId}`, async function () { | ||
| if (test.Metadata.scenario === "positive") { | ||
| var data; | ||
| try { | ||
| data = await instance.createWebhookConfiguration( | ||
| // createWebhookConfigurationRequest CreateWebhookConfigurationRequest | ||
| test.Body | ||
| ) | ||
| } catch (er) { | ||
| console.error(er, "Response", data) | ||
| expect(er).to.be.undefined | ||
| } | ||
| } else { | ||
| await expect( | ||
| instance.createWebhookConfiguration( | ||
| // createWebhookConfigurationRequest CreateWebhookConfigurationRequest | ||
| test.Body | ||
| ) | ||
| ).to.be.rejectedWith(Error); | ||
| } | ||
| }); | ||
| }); | ||
| }); | ||
| describe('deleteWebhookConfigurations', function() { | ||
| const testReqBodies = requestBodies.filter( | ||
| (body: any) => body.Metadata.operationId === "deleteWebhookConfigurations" | ||
| ); | ||
| testReqBodies.forEach(async (test: any) => { | ||
| it(`${test.Metadata.operationId} - ${test.Metadata.scenario} : Testid - ${test.Metadata.testId}`, async function () { | ||
| if (test.Metadata.scenario === "positive") { | ||
| var data; | ||
| try { | ||
| data = await instance.deleteWebhookConfigurations( | ||
| // deleteWebhookConfigurationsRequest DeleteWebhookConfigurationsRequest | ||
| test.Body | ||
| ) | ||
| } catch (er) { | ||
| console.error(er, "Response", data) | ||
| expect(er).to.be.undefined | ||
| } | ||
| } else { | ||
| await expect( | ||
| instance.deleteWebhookConfigurations( | ||
| // deleteWebhookConfigurationsRequest DeleteWebhookConfigurationsRequest | ||
| test.Body | ||
| ) | ||
| ).to.be.rejectedWith(Error); | ||
| } | ||
| }); | ||
| }); | ||
| }); | ||
| describe('searchWebhookConfigurations', function() { | ||
| const testReqBodies = requestBodies.filter( | ||
| (body: any) => body.Metadata.operationId === "searchWebhookConfigurations" | ||
| ); | ||
| testReqBodies.forEach(async (test: any) => { | ||
| it(`${test.Metadata.operationId} - ${test.Metadata.scenario} : Testid - ${test.Metadata.testId}`, async function () { | ||
| if (test.Metadata.scenario === "positive") { | ||
| var data; | ||
| try { | ||
| data = await instance.searchWebhookConfigurations( | ||
| // searchWebhookConfigurationsRequest SearchWebhookConfigurationsRequest | ||
| test.Body | ||
| ) | ||
| } catch (er) { | ||
| console.error(er, "Response", data) | ||
| expect(er).to.be.undefined | ||
| } | ||
| } else { | ||
| await expect( | ||
| instance.searchWebhookConfigurations( | ||
| // searchWebhookConfigurationsRequest SearchWebhookConfigurationsRequest | ||
| test.Body | ||
| ) | ||
| ).to.be.rejectedWith(Error); | ||
| } | ||
| }); | ||
| }); | ||
| }); | ||
| describe('updateWebhookConfiguration', function() { | ||
| const testReqBodies = requestBodies.filter( | ||
| (body: any) => body.Metadata.operationId === "updateWebhookConfiguration" | ||
| ); | ||
| testReqBodies.forEach(async (test: any) => { | ||
| it(`${test.Metadata.operationId} - ${test.Metadata.scenario} : Testid - ${test.Metadata.testId}`, async function () { | ||
| if (test.Metadata.scenario === "positive") { | ||
| var data; | ||
| try { | ||
| data = await instance.updateWebhookConfiguration( | ||
| // webhookIdentifier webhook_identifier | ||
| test.Path_Variables.webhook_identifier , | ||
| // updateWebhookConfigurationRequest UpdateWebhookConfigurationRequest | ||
| test.Body | ||
| ) | ||
| } catch (er) { | ||
| console.error(er, "Response", data) | ||
| expect(er).to.be.undefined | ||
| } | ||
| } else { | ||
| await expect( | ||
| instance.updateWebhookConfiguration( | ||
| // webhookIdentifier webhook_identifier | ||
| test.Path_Variables.webhook_identifier , | ||
| // updateWebhookConfigurationRequest UpdateWebhookConfigurationRequest | ||
| test.Body | ||
| ) | ||
| ).to.be.rejectedWith(Error); | ||
| } | ||
| }); | ||
| }); | ||
| }); | ||
| }); |
+4
-4
@@ -147,3 +147,3 @@ # ThoughtSpotRestApiSdk.AIApi | ||
| Version: 10.13.0.cl or later Provides relevant data source recommendations for a user-submitted natural language query. To use this API, the user must have at least view-level access to the underlying metadata entities referenced in the response. #### Usage guidelines The request must include a `query` string via the request body. The returned results include metadata such as: - `confidence`: a float indicating the model\'s confidence in the relevance of each recommendation - `details`: includes `data_source_identifier`, `data_source_name`, and `description` of each recommended data source - `reasoning`: rationale provided by the LLM to explain why each data source was recommended If the API request is successful, ThoughtSpot returns a ranked list of data sources, each annotated with relevant reasoning. > ###### Note: > * This endpoint is currently in Beta. Breaking changes may be introduced before it is made Generally Available. > * This endpoint requires Spotter — please contact ThoughtSpot Support to enable Spotter on your cluster. | ||
| Version: 10.15.0.cl or later Provides relevant data source recommendations for a user-submitted natural language query. To use this API, the user must have at least view-level access to the underlying metadata entities referenced in the response. #### Usage guidelines The request must include a `query` string via the request body. The returned results include metadata such as: - `confidence`: a float indicating the model\'s confidence in the relevance of each recommendation - `details`: includes `data_source_identifier`, `data_source_name`, and `description` of each recommended data source - `reasoning`: rationale provided by the LLM to explain why each data source was recommended If the API request is successful, ThoughtSpot returns a ranked list of data sources, each annotated with relevant reasoning. > ###### Note: > * This endpoint is currently in Beta. Breaking changes may be introduced before it is made Generally Available. > * This endpoint requires Spotter — please contact ThoughtSpot Support to enable Spotter on your cluster. | ||
@@ -209,3 +209,3 @@ ### Example | ||
| Version: 10.15.0.cl or later This API allows users to retrieve existing natural language (NL) instructions for a specific data-model. These instructions guide the AI system in understanding data context and generating more accurate responses when processing natural language queries. #### Usage guidelines To retrieve NL instructions for a data-model, the request must include: - `data_source_identifier`: The unique ID or name of the data-model to retrieve NL instructions The API returns a response object with: - `nl_instructions_info`: An array of instruction objects, each containing: - `instructions`: Array of text instructions for natural language processing - `scope`: The scope of the instruction (`GLOBAL`). It can be extended to data-model-user scope in future. #### Instructions Scope - **GLOBAL**: Instructions that apply globally across the system on the given data-model (currently only global instructions are supported) > ###### Note: > * To use this API, the user needs atleast view access on the data-model and they must use corresponding org related bearerToken where the data-model exists. > * This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available. > * Available from version 10.15.0.cl and later. > * This endpoint requires Spotter — please contact ThoughtSpot Support to enable Spotter on your cluster. > * Use this API to view currently configured instructions before modifying them with `setNLInstructions`. | ||
| Version: 10.15.0.cl or later This API allows users to retrieve existing natural language (NL) instructions for a specific data-model. These instructions guide the AI system in understanding data context and generating more accurate responses when processing natural language queries. #### Usage guidelines To retrieve NL instructions for a data-model, the request must include: - `data_source_identifier`: The unique ID of the data-model to retrieve NL instructions The API returns a response object with: - `nl_instructions_info`: An array of instruction objects, each containing: - `instructions`: Array of text instructions for natural language processing - `scope`: The scope of the instruction (`GLOBAL`). It can be extended to data-model-user scope in future. #### Instructions Scope - **GLOBAL**: Instructions that apply globally across the system on the given data-model (currently only global instructions are supported) > ###### Note: > * To use this API, the user needs atleast view access on the data-model and they must use corresponding org related bearerToken where the data-model exists. > * This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available. > * Available from version 10.15.0.cl and later. > * This endpoint requires Spotter — please contact ThoughtSpot Support to enable Spotter on your cluster. > * Use this API to view currently configured instructions before modifying them with `setNLInstructions`. | ||
@@ -411,3 +411,3 @@ ### Example | ||
| Version: 10.13.0.cl or later This API allows users to initiate or continue an agent (Spotter) conversation by submitting one or more natural language messages. To use this API, the user must have access to the relevant conversational session (via conversation_identifier) and submit at least one message. #### Usage guidelines To initiate or continue a conversation, the request must include: - `conversation_identifier`: a unique session ID for continuity and message tracking - `messages`: an array of one or more text messages, each with a value and type The API returns a array of object with a type, message, and metadata. - `type`: Type of the message — text, answer, or error. - `message`: Main content of the response. - `metadata`: Additional info depending on the message type. > ###### Note: > * This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available. > * This endpoint requires Spotter - please contact ThoughtSpot support to enable Spotter on your cluster. | ||
| Version: 10.15.0.cl or later This API allows users to initiate or continue an agent (Spotter) conversation by submitting one or more natural language messages. To use this API, the user must have access to the relevant conversational session (via conversation_identifier) and submit at least one message. #### Usage guidelines To initiate or continue a conversation, the request must include: - `conversation_identifier`: a unique session ID for continuity and message tracking - `messages`: an array of one or more text messages, each with a value and type The API returns a array of object with a type, message, and metadata. - `type`: Type of the message — text, answer, or error. - `message`: Main content of the response. - `metadata`: Additional info depending on the message type. > ###### Note: > * This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available. > * This endpoint requires Spotter - please contact ThoughtSpot support to enable Spotter on your cluster. | ||
@@ -607,3 +607,3 @@ ### Example | ||
| Version: 10.15.0.cl or later This API allows users to set natural language (NL) instructions for a specific data-model to improve AI-generated answers and query processing. These instructions help guide the AI system to better understand the data context and provide more accurate responses. #### Usage guidelines To set NL instructions for a data-model, the request must include: - `data_source_identifier`: The unique ID or name of the data-model for which to set NL instructions - `nl_instructions_info`: An array of instruction objects, each containing: - `instructions`: Array of text instructions for the LLM - `scope`: The scope of the instruction (`GLOBAL`). Currently only `GLOBAL` is supported. It can be extended to data-model-user scope in future. The API returns a response object with: - `success`: Boolean indicating whether the operation was successful #### Instructions Scope - **GLOBAL**: Instructions that apply globally for that data-model across the system > ###### Note: > * To use this API, the user needs either edit access or SPOTTER_COACHING_PRIVILEGE on the data-model and they must use corresponding org related bearerToken where the data-model exists. > * This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available. > * Available from version 10.15.0.cl and later. > * This endpoint requires Spotter — please contact ThoughtSpot Support to enable Spotter on your cluster. > * Instructions help improve the accuracy and relevance of AI-generated responses for the specified data-model. | ||
| Version: 10.15.0.cl or later This API allows users to set natural language (NL) instructions for a specific data-model to improve AI-generated answers and query processing. These instructions help guide the AI system to better understand the data context and provide more accurate responses. #### Usage guidelines To set NL instructions for a data-model, the request must include: - `data_source_identifier`: The unique ID of the data-model for which to set NL instructions - `nl_instructions_info`: An array of instruction objects, each containing: - `instructions`: Array of text instructions for the LLM - `scope`: The scope of the instruction (`GLOBAL`). Currently only `GLOBAL` is supported. It can be extended to data-model-user scope in future. The API returns a response object with: - `success`: Boolean indicating whether the operation was successful #### Instructions Scope - **GLOBAL**: Instructions that apply globally for that data-model across the system > ###### Note: > * To use this API, the user needs either edit access or SPOTTER_COACHING_PRIVILEGE on the data-model and they must use corresponding org related bearerToken where the data-model exists. > * This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available. > * Available from version 10.15.0.cl and later. > * This endpoint requires Spotter — please contact ThoughtSpot Support to enable Spotter on your cluster. > * Instructions help improve the accuracy and relevance of AI-generated responses for the specified data-model. | ||
@@ -610,0 +610,0 @@ ### Example |
@@ -41,3 +41,4 @@ // TODO: better import syntax? | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -74,3 +75,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -114,3 +116,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -159,3 +162,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -204,3 +208,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -249,3 +254,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -293,3 +299,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -333,3 +340,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -384,3 +392,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -387,0 +396,0 @@ |
@@ -42,3 +42,4 @@ // TODO: better import syntax? | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -75,3 +76,3 @@ | ||
| /** | ||
| * Version: 10.12.0.cl or later Creates an additional configuration to an existing connection to a data warehouse. Requires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required. #### Usage guidelines * A JSON map of configuration attributes in `configuration`. The following example shows the configuration attributes: ``` { \"user\":\"DEV_USER\", \"password\":\"TestConn123\", \"role\":\"DEV\", \"warehouse\":\"DEV_WH\" } ``` * If the `policy_type` is `PRINCIPALS`, then `policy_principals` is a required field. * If the `policy_type` is `PROCESSES`, then `policy_processes` is a required field. * If the `policy_type` is `NO_POLICY`, then `policy_principals` and `policy_processes` are not required fields. | ||
| * Version: 10.12.0.cl or later Creates an additional configuration to an existing connection to a data warehouse. Requires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required. #### Usage guidelines * A JSON map of configuration attributes in `configuration`. The following example shows the configuration attributes: ``` { \"user\":\"DEV_USER\", \"password\":\"TestConn123\", \"role\":\"DEV\", \"warehouse\":\"DEV_WH\" } ``` * If the `policy_type` is `PRINCIPALS`, then `policy_principals` is a required field. * If the `policy_type` is `PROCESSES`, then `policy_processes` is a required field. * If the `policy_type` is `NO_POLICY`, then `policy_principals` and `policy_processes` are not required fields. #### Parameterized Connection Support For parameterized connections that use OAuth authentication, only the same_as_parent and policy_process_options attributes are allowed in the API request. These attributes are not applicable to connections that are not parameterized. | ||
| * @param createConnectionConfigurationRequest | ||
@@ -94,3 +95,4 @@ */ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -145,3 +147,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -178,3 +181,3 @@ | ||
| /** | ||
| * Version: 10.12.0.cl or later Updates a connection configuration object. Requires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required. #### Supported operations This API endpoint lets you perform the following operations in a single API request: * Edit the name or description of the configuration * Edit the configuration properties * Edit the `policy_type` * Edit the type of authentication * Enable or disable a configuration **NOTE**: When updating a configuration where `disabled` is `true`, you must reset `disabled` to `true` in your update request payload. If not explicitly set again, the API will default `disabled` to `false`. | ||
| * Version: 10.12.0.cl or later Updates a connection configuration object. Requires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required. #### Supported operations This API endpoint lets you perform the following operations in a single API request: * Edit the name or description of the configuration * Edit the configuration properties * Edit the `policy_type` * Edit the type of authentication * Enable or disable a configuration #### Parameterized Connection Support For parameterized oauth based connections, only the `same_as_parent` and `policy_process_options` attributes are allowed. These attributes are not applicable to connections that are not parameterized. **NOTE**: When updating a configuration where `disabled` is `true`, you must reset `disabled` to `true` in your update request payload. If not explicitly set again, the API will default `disabled` to `false`. | ||
| * @param configurationIdentifier Unique ID or name of the configuration. | ||
@@ -205,3 +208,4 @@ * @param updateConnectionConfigurationRequest | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -208,0 +212,0 @@ |
@@ -41,3 +41,4 @@ // TODO: better import syntax? | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -93,3 +94,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -133,3 +135,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -192,3 +195,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -195,0 +199,0 @@ |
@@ -42,3 +42,4 @@ // TODO: better import syntax? | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -94,3 +95,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -134,3 +136,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -185,3 +188,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -244,3 +248,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -247,0 +252,0 @@ |
+6
-3
@@ -43,3 +43,4 @@ // TODO: better import syntax? | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -94,3 +95,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -145,3 +147,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -148,0 +151,0 @@ |
+12
-6
@@ -61,3 +61,4 @@ // TODO: better import syntax? | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -166,3 +167,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -255,3 +257,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -331,3 +334,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -372,3 +376,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -432,3 +437,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -435,0 +441,0 @@ |
@@ -42,3 +42,4 @@ // TODO: better import syntax? | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -94,3 +95,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -134,3 +136,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -185,3 +188,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -236,3 +240,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -280,3 +285,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -283,0 +289,0 @@ |
+10
-5
@@ -43,3 +43,4 @@ // TODO: better import syntax? | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -95,3 +96,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -135,3 +137,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -186,3 +189,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -245,3 +249,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -248,0 +253,0 @@ |
+2
-1
@@ -39,3 +39,4 @@ // TODO: better import syntax? | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -42,0 +43,0 @@ |
+8
-4
@@ -41,3 +41,4 @@ // TODO: better import syntax? | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -93,3 +94,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -133,3 +135,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -192,3 +195,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -195,0 +199,0 @@ |
@@ -39,3 +39,4 @@ // TODO: better import syntax? | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -72,3 +73,3 @@ | ||
| /** | ||
| * Version: 9.0.0.cl or later Exports a Liveboard and its visualizations in PDF or PNG file format. Requires at least view access to the Liveboard. #### Usage guidelines In the request body, specify the GUID or name of the Liveboard. To generate a Liveboard report with specific visualizations, add GUIDs or names of the visualizations. The default `file_format` is PDF. For PDF downloads, you can specify additional parameters to customize the page orientation and include or exclude the cover page, logo, footer text, and page numbers. Similar customization options are also available for PNG output. **NOTE**: The downloadable file returned in API response file is extensionless. Please rename the downloaded file by typing in the relevant extension. Optionally, you can define [runtime overrides](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_overrides) to apply to the Answer data. To include unsaved changes in the report, pass the `transient_pinboard_content` script generated from the `getExportRequestForCurrentPinboard` method in the Visual Embed SDK. Upon successful execution, the API returns the report with unsaved changes, including ad hoc changes to visualizations. For more information, see [Liveboard Report API](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_liveboard_report_api). **NOTE**: Starting with ThoughtSpot Cloud 10.9.0.cl release, the Liveboard can be exported in the PNG format in the resolution of your choice. To enable this on your instance, contact ThoughtSpot support. When this feature is enabled, the options `include_cover_page`,`include_filter_page` within the `png_options` will not be available for PNG exports. | ||
| * Version: 9.0.0.cl or later Exports a Liveboard and its visualizations in PDF, PNG, CSV, or XLSX file format. Requires at least view access to the Liveboard. #### Usage guidelines In the request body, specify the GUID or name of the Liveboard. To generate a Liveboard report with specific visualizations, add GUIDs or names of the visualizations. The default `file_format` is CSV. For PDF exports, you can specify additional parameters to customize the page orientation and include or exclude the cover page, logo, footer text, and page numbers. Similar customization options are available for PNG exports. CSV and XLSX exports do not support customization options. **NOTE**: The downloadable file returned in API response file is extensionless. Please rename the downloaded file by typing in the relevant extension. Optionally, you can define [runtime overrides](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_overrides) to apply to the Answer data. To include unsaved changes in the report, pass the `transient_pinboard_content` script generated from the `getExportRequestForCurrentPinboard` method in the Visual Embed SDK. Upon successful execution, the API returns the report with unsaved changes, including ad hoc changes to visualizations. For more information, see [Liveboard Report API](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_liveboard_report_api). **NOTE**: Starting with ThoughtSpot Cloud 10.9.0.cl release, the Liveboard can be exported in the PNG format in the resolution of your choice. To enable this on your instance, contact ThoughtSpot support. When this feature is enabled, the options `include_cover_page`,`include_filter_page` within the `png_options` will not be available for PNG exports. **NOTE**: Starting with the ThoughtSpot Cloud 26.2.0.cl release, Liveboards can be exported in CSV format. All visualizations in the Liveboard can be exported as individual CSV files. If multiple visualizations are selected or if the entire Liveboard is exported, the output is returned as a .zip file containing the CSV files for each visualization. **NOTE**: Starting with the ThoughtSpot Cloud 26.2.0.cl release, Liveboards can be exported in XLSX format. All selected visualizations are consolidated into a single Excel workbook (.xlsx), with each visualization placed in its own worksheet (tab). XLSX exports are limited to 255 worksheets (tabs) per workbook. | ||
| * @param exportLiveboardReportRequest | ||
@@ -91,3 +92,4 @@ */ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -94,0 +96,0 @@ |
+8
-4
@@ -42,3 +42,4 @@ // TODO: better import syntax? | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -94,3 +95,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -134,3 +136,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -193,3 +196,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -196,0 +200,0 @@ |
@@ -41,3 +41,4 @@ // TODO: better import syntax? | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -93,3 +94,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -133,3 +135,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -192,3 +195,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -195,0 +199,0 @@ |
+16
-8
@@ -48,3 +48,4 @@ // TODO: better import syntax? | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -99,3 +100,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -150,3 +152,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -201,3 +204,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -252,3 +256,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -303,3 +308,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -354,3 +360,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -405,3 +412,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -408,0 +416,0 @@ |
+227
-6
@@ -13,4 +13,7 @@ // TODO: better import syntax? | ||
| import { ConfigureCommunicationChannelPreferencesRequest } from '../models/ConfigureCommunicationChannelPreferencesRequest'; | ||
| import { ConfigureSecuritySettingsRequest } from '../models/ConfigureSecuritySettingsRequest'; | ||
| import { ErrorResponse } from '../models/ErrorResponse'; | ||
| import { SearchCommunicationChannelPreferencesRequest } from '../models/SearchCommunicationChannelPreferencesRequest'; | ||
| import { SearchSecuritySettingsRequest } from '../models/SearchSecuritySettingsRequest'; | ||
| import { SecuritySettingsResponse } from '../models/SecuritySettingsResponse'; | ||
| import { SystemConfig } from '../models/SystemConfig'; | ||
@@ -45,3 +48,4 @@ import { SystemInfo } from '../models/SystemInfo'; | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -78,2 +82,53 @@ | ||
| /** | ||
| * Version: 26.2.0.cl or later Configure security settings for your ThoughtSpot application instance. - Use `cluster_preferences` to update cluster-level security settings including CORS whitelisted URLs, CSP settings, SAML redirect URLs, partitioned cookies, and non-embed access configuration. - Use `org_preferences` to configure Org-specific security settings. If your instance has [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview), this allows configuring CORS and non-embed access settings specific to the Org. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. Cluster-level SAML and script-src settings require `ADMINISTRATION` privilege. See [Security Settings](https://developers.thoughtspot.com/docs/security-settings) for more details. | ||
| * @param configureSecuritySettingsRequest | ||
| */ | ||
| public async configureSecuritySettings(configureSecuritySettingsRequest: ConfigureSecuritySettingsRequest, _options?: Configuration): Promise<RequestContext> { | ||
| let _config = _options || this.configuration; | ||
| // verify required parameter 'configureSecuritySettingsRequest' is not null or undefined | ||
| if (configureSecuritySettingsRequest === null || configureSecuritySettingsRequest === undefined) { | ||
| throw new RequiredError("SystemApi", "configureSecuritySettings", "configureSecuritySettingsRequest"); | ||
| } | ||
| // Path Params | ||
| const localVarPath = '/api/rest/2.0/system/security-settings/configure'; | ||
| // Make Request Context | ||
| const requestContext = _config.baseServer.makeRequestContext(localVarPath, HttpMethod.POST); | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
| // Body Params | ||
| const contentType = ObjectSerializer.getPreferredMediaType([ | ||
| "application/json" | ||
| ]); | ||
| requestContext.setHeaderParam("Content-Type", contentType); | ||
| const serializedBody = ObjectSerializer.stringify( | ||
| ObjectSerializer.serialize(configureSecuritySettingsRequest, "ConfigureSecuritySettingsRequest", ""), | ||
| contentType | ||
| ); | ||
| requestContext.setBody(serializedBody); | ||
| let authMethod: SecurityAuthentication | undefined; | ||
| // Apply auth methods | ||
| authMethod = _config.authMethods["bearerAuth"] | ||
| if (authMethod?.applySecurityAuthentication) { | ||
| await authMethod?.applySecurityAuthentication(requestContext); | ||
| } | ||
| const defaultAuth: SecurityAuthentication | undefined = _options?.authMethods?.default || this.configuration?.authMethods?.default | ||
| if (defaultAuth?.applySecurityAuthentication) { | ||
| await defaultAuth?.applySecurityAuthentication(requestContext); | ||
| } | ||
| return requestContext; | ||
| } | ||
| /** | ||
| * Version: 9.0.0.cl or later Retrieves the current configuration details of the cluster. If the request is successful, the API returns a list configuration settings applied on the cluster. Requires `ADMINISTRATION`(**Can administer ThoughtSpot**) privilege to view these complete configuration settings of the cluster. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `SYSTEM_INFO_ADMINISTRATION` (**Can view system activities**) privilege is required. This API does not require any parameters to be passed in the request. | ||
@@ -90,3 +145,4 @@ */ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -123,3 +179,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -156,3 +213,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -196,3 +254,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -229,2 +288,53 @@ | ||
| /** | ||
| * Version: 26.2.0.cl or later Fetch security settings for your ThoughtSpot application instance. - Use `scope: CLUSTER` to retrieve cluster-level security settings, including CORS and CSP allowlists, SAML redirect URLs, and settings that control access to non-embedded pages. - Use `scope: ORG` to retrieve Org-level security settings. If your instance has [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview), this returns CORS and non-embed access settings specific to the Org. - If `scope` is not specified, returns both cluster and Org-specific settings based on user privileges. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. See [Security Settings](https://developers.thoughtspot.com/docs/security-settings) for more details. | ||
| * @param searchSecuritySettingsRequest | ||
| */ | ||
| public async searchSecuritySettings(searchSecuritySettingsRequest: SearchSecuritySettingsRequest, _options?: Configuration): Promise<RequestContext> { | ||
| let _config = _options || this.configuration; | ||
| // verify required parameter 'searchSecuritySettingsRequest' is not null or undefined | ||
| if (searchSecuritySettingsRequest === null || searchSecuritySettingsRequest === undefined) { | ||
| throw new RequiredError("SystemApi", "searchSecuritySettings", "searchSecuritySettingsRequest"); | ||
| } | ||
| // Path Params | ||
| const localVarPath = '/api/rest/2.0/system/security-settings/search'; | ||
| // Make Request Context | ||
| const requestContext = _config.baseServer.makeRequestContext(localVarPath, HttpMethod.POST); | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
| // Body Params | ||
| const contentType = ObjectSerializer.getPreferredMediaType([ | ||
| "application/json" | ||
| ]); | ||
| requestContext.setHeaderParam("Content-Type", contentType); | ||
| const serializedBody = ObjectSerializer.stringify( | ||
| ObjectSerializer.serialize(searchSecuritySettingsRequest, "SearchSecuritySettingsRequest", ""), | ||
| contentType | ||
| ); | ||
| requestContext.setBody(serializedBody); | ||
| let authMethod: SecurityAuthentication | undefined; | ||
| // Apply auth methods | ||
| authMethod = _config.authMethods["bearerAuth"] | ||
| if (authMethod?.applySecurityAuthentication) { | ||
| await authMethod?.applySecurityAuthentication(requestContext); | ||
| } | ||
| const defaultAuth: SecurityAuthentication | undefined = _options?.authMethods?.default || this.configuration?.authMethods?.default | ||
| if (defaultAuth?.applySecurityAuthentication) { | ||
| await defaultAuth?.applySecurityAuthentication(requestContext); | ||
| } | ||
| return requestContext; | ||
| } | ||
| /** | ||
| * Version: 9.2.0.cl or later Updates the current configuration of the cluster. You must send the configuration data in JSON format. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privileges. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `APPLICATION_ADMINISTRATION` (**Can manage application settings**) privilege is required. | ||
@@ -248,3 +358,4 @@ * @param updateSystemConfigRequest | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -341,2 +452,55 @@ | ||
| * | ||
| * @params response Response returned by the server for a request to configureSecuritySettings | ||
| * @throws ApiException if the response code was not in [200, 299] | ||
| */ | ||
| public async configureSecuritySettings(response: ResponseContext): Promise<void > { | ||
| const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]); | ||
| if (isCodeInRange("204", response.httpStatusCode)) { | ||
| return; | ||
| } | ||
| if (isCodeInRange("400", response.httpStatusCode)) { | ||
| const body: ErrorResponse = ObjectSerializer.deserialize( | ||
| ObjectSerializer.parse(await response.body.text(), contentType), | ||
| "ErrorResponse", "" | ||
| ) as ErrorResponse; | ||
| throw new ApiException<ErrorResponse>(response.httpStatusCode, "Invalid request.", body, response.headers); | ||
| } | ||
| if (isCodeInRange("401", response.httpStatusCode)) { | ||
| const body: ErrorResponse = ObjectSerializer.deserialize( | ||
| ObjectSerializer.parse(await response.body.text(), contentType), | ||
| "ErrorResponse", "" | ||
| ) as ErrorResponse; | ||
| throw new ApiException<ErrorResponse>(response.httpStatusCode, "Unauthorized access.", body, response.headers); | ||
| } | ||
| if (isCodeInRange("403", response.httpStatusCode)) { | ||
| const body: ErrorResponse = ObjectSerializer.deserialize( | ||
| ObjectSerializer.parse(await response.body.text(), contentType), | ||
| "ErrorResponse", "" | ||
| ) as ErrorResponse; | ||
| throw new ApiException<ErrorResponse>(response.httpStatusCode, "Forbidden access.", body, response.headers); | ||
| } | ||
| if (isCodeInRange("500", response.httpStatusCode)) { | ||
| const body: ErrorResponse = ObjectSerializer.deserialize( | ||
| ObjectSerializer.parse(await response.body.text(), contentType), | ||
| "ErrorResponse", "" | ||
| ) as ErrorResponse; | ||
| throw new ApiException<ErrorResponse>(response.httpStatusCode, "Unexpected error", body, response.headers); | ||
| } | ||
| // Work around for missing responses in specification, e.g. for petstore.yaml | ||
| if (response.httpStatusCode >= 200 && response.httpStatusCode <= 299) { | ||
| const body: void = ObjectSerializer.deserialize( | ||
| ObjectSerializer.parse(await response.body.text(), contentType), | ||
| "void", "" | ||
| ) as void; | ||
| return body; | ||
| } | ||
| throw new ApiException<string | Blob | undefined>(response.httpStatusCode, "Unknown API Status Code!", await response.getBodyAsAny(), response.headers); | ||
| } | ||
| /** | ||
| * Unwraps the actual response sent by the server from the response context and deserializes the response content | ||
| * to the expected objects | ||
| * | ||
| * @params response Response returned by the server for a request to getSystemConfig | ||
@@ -570,2 +734,59 @@ * @throws ApiException if the response code was not in [200, 299] | ||
| * | ||
| * @params response Response returned by the server for a request to searchSecuritySettings | ||
| * @throws ApiException if the response code was not in [200, 299] | ||
| */ | ||
| public async searchSecuritySettings(response: ResponseContext): Promise<SecuritySettingsResponse > { | ||
| const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]); | ||
| if (isCodeInRange("200", response.httpStatusCode)) { | ||
| const body: SecuritySettingsResponse = ObjectSerializer.deserialize( | ||
| ObjectSerializer.parse(await response.body.text(), contentType), | ||
| "SecuritySettingsResponse", "" | ||
| ) as SecuritySettingsResponse; | ||
| return body; | ||
| } | ||
| if (isCodeInRange("400", response.httpStatusCode)) { | ||
| const body: ErrorResponse = ObjectSerializer.deserialize( | ||
| ObjectSerializer.parse(await response.body.text(), contentType), | ||
| "ErrorResponse", "" | ||
| ) as ErrorResponse; | ||
| throw new ApiException<ErrorResponse>(response.httpStatusCode, "Invalid request.", body, response.headers); | ||
| } | ||
| if (isCodeInRange("401", response.httpStatusCode)) { | ||
| const body: ErrorResponse = ObjectSerializer.deserialize( | ||
| ObjectSerializer.parse(await response.body.text(), contentType), | ||
| "ErrorResponse", "" | ||
| ) as ErrorResponse; | ||
| throw new ApiException<ErrorResponse>(response.httpStatusCode, "Unauthorized access.", body, response.headers); | ||
| } | ||
| if (isCodeInRange("403", response.httpStatusCode)) { | ||
| const body: ErrorResponse = ObjectSerializer.deserialize( | ||
| ObjectSerializer.parse(await response.body.text(), contentType), | ||
| "ErrorResponse", "" | ||
| ) as ErrorResponse; | ||
| throw new ApiException<ErrorResponse>(response.httpStatusCode, "Forbidden access.", body, response.headers); | ||
| } | ||
| if (isCodeInRange("500", response.httpStatusCode)) { | ||
| const body: ErrorResponse = ObjectSerializer.deserialize( | ||
| ObjectSerializer.parse(await response.body.text(), contentType), | ||
| "ErrorResponse", "" | ||
| ) as ErrorResponse; | ||
| throw new ApiException<ErrorResponse>(response.httpStatusCode, "Unexpected error", body, response.headers); | ||
| } | ||
| // Work around for missing responses in specification, e.g. for petstore.yaml | ||
| if (response.httpStatusCode >= 200 && response.httpStatusCode <= 299) { | ||
| const body: SecuritySettingsResponse = ObjectSerializer.deserialize( | ||
| ObjectSerializer.parse(await response.body.text(), contentType), | ||
| "SecuritySettingsResponse", "" | ||
| ) as SecuritySettingsResponse; | ||
| return body; | ||
| } | ||
| throw new ApiException<string | Blob | undefined>(response.httpStatusCode, "Unknown API Status Code!", await response.getBodyAsAny(), response.headers); | ||
| } | ||
| /** | ||
| * Unwraps the actual response sent by the server from the response context and deserializes the response content | ||
| * to the expected objects | ||
| * | ||
| * @params response Response returned by the server for a request to updateSystemConfig | ||
@@ -572,0 +793,0 @@ * @throws ApiException if the response code was not in [200, 299] |
+12
-6
@@ -42,3 +42,4 @@ // TODO: better import syntax? | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -93,3 +94,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -145,3 +147,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -185,3 +188,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -236,3 +240,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -295,3 +300,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -298,0 +304,0 @@ |
+20
-10
@@ -49,3 +49,4 @@ // TODO: better import syntax? | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -100,3 +101,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -151,3 +153,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -202,3 +205,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -254,3 +258,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -294,3 +299,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -345,3 +351,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -396,3 +403,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -447,3 +455,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -506,3 +515,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -509,0 +519,0 @@ |
+12
-7
@@ -42,3 +42,4 @@ // TODO: better import syntax? | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -94,3 +95,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -134,3 +136,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -167,3 +170,3 @@ | ||
| /** | ||
| * Update a variable\'s name Version: 10.14.0.cl or later Allows updating a variable\'s properties in ThoughtSpot. Requires ADMINISTRATION role and TENANT scope. The CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope. The API endpoint allows updating: * The variable name | ||
| * Update a variable\'s name Version: 10.14.0.cl or later Allows updating a variable\'s name in ThoughtSpot. Requires ADMINISTRATION role and TENANT scope. The CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope. The API endpoint allows updating: * The variable name | ||
| * @param identifier Unique id or name of the variable to update. | ||
@@ -194,3 +197,4 @@ * @param updateVariableRequest | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -227,3 +231,3 @@ | ||
| /** | ||
| * Update values for multiple variables Version: 10.14.0.cl or later Allows updating values for multiple variables in ThoughtSpot. Requires ADMINISTRATION role. The CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope. The API endpoint allows: * Adding new values to variables * Replacing existing values * Deleting values from variables When updating variable values, you need to specify: * The variable identifiers * The values to add/replace/remove for each variable * The operation to perform (ADD, REPLACE, REMOVE, CLEAR) Behaviour based on operation type: * ADD - Adds values to the variable if this is a list type variable, else same as replace. * REPLACE - Replaces all values of a given set of constraints with the current set of values. * REMOVE - Removes any values which match the set of conditions of the variables if this is a list type variable, else clears value. * CLEAR - Removes all constrains for a given variable, scope is ignored | ||
| * Update values for multiple variables Version: 10.14.0.cl or later Allows updating values for multiple variables in ThoughtSpot. Requires ADMINISTRATION role. The CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope. The API endpoint allows: * Adding new values to variables * Replacing existing values * Deleting values from variables When updating variable values, you need to specify: * The variable identifiers * The values to add/replace/remove for each variable * The operation to perform (ADD, REPLACE, REMOVE, RESET) Behaviour based on operation type: * ADD - Adds values to the variable if this is a list type variable, else same as replace. * REPLACE - Replaces all values of a given set of constraints with the current set of values. * REMOVE - Removes any values which match the set of conditions of the variables if this is a list type variable, else clears value. * RESET - Removes all constrains for a given variable, scope is ignored | ||
| * @param updateVariableValuesRequest | ||
@@ -246,3 +250,4 @@ */ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -249,0 +254,0 @@ |
@@ -51,3 +51,4 @@ // TODO: better import syntax? | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -102,3 +103,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -153,3 +155,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -204,3 +207,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -263,3 +267,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -314,3 +319,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -365,3 +371,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -416,3 +423,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -467,3 +475,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -470,0 +479,0 @@ |
@@ -44,3 +44,4 @@ // TODO: better import syntax? | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -95,3 +96,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -146,3 +148,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -205,3 +208,4 @@ | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.20.0") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.21.0") | ||
| requestContext.setHeaderParam("X-ThoughtSpot-Client", "ThoughtSpot-ts-client/2.21.0") | ||
@@ -208,0 +212,0 @@ |
@@ -80,3 +80,3 @@ # ThoughtSpotRestApiSdk.ConnectionConfigurationsApi | ||
| Version: 10.12.0.cl or later Creates an additional configuration to an existing connection to a data warehouse. Requires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required. #### Usage guidelines * A JSON map of configuration attributes in `configuration`. The following example shows the configuration attributes: ``` { \"user\":\"DEV_USER\", \"password\":\"TestConn123\", \"role\":\"DEV\", \"warehouse\":\"DEV_WH\" } ``` * If the `policy_type` is `PRINCIPALS`, then `policy_principals` is a required field. * If the `policy_type` is `PROCESSES`, then `policy_processes` is a required field. * If the `policy_type` is `NO_POLICY`, then `policy_principals` and `policy_processes` are not required fields. | ||
| Version: 10.12.0.cl or later Creates an additional configuration to an existing connection to a data warehouse. Requires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required. #### Usage guidelines * A JSON map of configuration attributes in `configuration`. The following example shows the configuration attributes: ``` { \"user\":\"DEV_USER\", \"password\":\"TestConn123\", \"role\":\"DEV\", \"warehouse\":\"DEV_WH\" } ``` * If the `policy_type` is `PRINCIPALS`, then `policy_principals` is a required field. * If the `policy_type` is `PROCESSES`, then `policy_processes` is a required field. * If the `policy_type` is `NO_POLICY`, then `policy_principals` and `policy_processes` are not required fields. #### Parameterized Connection Support For parameterized connections that use OAuth authentication, only the same_as_parent and policy_process_options attributes are allowed in the API request. These attributes are not applicable to connections that are not parameterized. | ||
@@ -101,2 +101,4 @@ ### Example | ||
| connection_identifier: "connection_identifier_example", | ||
| same_as_parent: false, | ||
| policy_process_options: null, | ||
| authentication_type: "SERVICE_ACCOUNT", | ||
@@ -218,3 +220,3 @@ configuration: {}, | ||
| Version: 10.12.0.cl or later Updates a connection configuration object. Requires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required. #### Supported operations This API endpoint lets you perform the following operations in a single API request: * Edit the name or description of the configuration * Edit the configuration properties * Edit the `policy_type` * Edit the type of authentication * Enable or disable a configuration **NOTE**: When updating a configuration where `disabled` is `true`, you must reset `disabled` to `true` in your update request payload. If not explicitly set again, the API will default `disabled` to `false`. | ||
| Version: 10.12.0.cl or later Updates a connection configuration object. Requires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required. #### Supported operations This API endpoint lets you perform the following operations in a single API request: * Edit the name or description of the configuration * Edit the configuration properties * Edit the `policy_type` * Edit the type of authentication * Enable or disable a configuration #### Parameterized Connection Support For parameterized oauth based connections, only the `same_as_parent` and `policy_process_options` attributes are allowed. These attributes are not applicable to connections that are not parameterized. **NOTE**: When updating a configuration where `disabled` is `true`, you must reset `disabled` to `true` in your update request payload. If not explicitly set again, the API will default `disabled` to `false`. | ||
@@ -241,2 +243,4 @@ ### Example | ||
| description: "description_example", | ||
| same_as_parent: false, | ||
| policy_process_options: null, | ||
| authentication_type: "SERVICE_ACCOUNT", | ||
@@ -243,0 +247,0 @@ configuration: {}, |
+76
-0
@@ -12,2 +12,3 @@ # ThoughtSpotRestApiSdk.ConnectionsApi | ||
| [**fetchConnectionDiffStatus**](ConnectionsApi.md#fetchConnectionDiffStatus) | **POST** /api/rest/2.0/connections/fetch-connection-diff-status/{connection_identifier} | | ||
| [**revokeRefreshTokens**](ConnectionsApi.md#revokeRefreshTokens) | **POST** /api/rest/2.0/connections/{connection_identifier}/revoke-refresh-tokens | | ||
| [**searchConnection**](ConnectionsApi.md#searchConnection) | **POST** /api/rest/2.0/connection/search | | ||
@@ -326,2 +327,77 @@ [**updateConnection**](ConnectionsApi.md#updateConnection) | **POST** /api/rest/2.0/connection/update | | ||
| # **revokeRefreshTokens** | ||
| > RevokeRefreshTokensResponse revokeRefreshTokens(revokeRefreshTokensRequest) | ||
| Version: 26.2.0.cl or later Revokes OAuth refresh tokens for users who no longer require access to a data warehouse connection. When a token is revoked, the affected user\'s session for that connection is terminated, and they must re-authenticate to regain access. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DATAMANAGEMENT` (**Can manage data**) privileges. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on the ThoughtSpot instance, users with `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege can also make API requests to revoke tokens for connection users. #### Usage guidelines You can specify different combinations of identifiers to control which refresh tokens are revoked. - **connection_identifier**: Revokes refresh tokens for all users of the connection, except the connection author. - **connection_identifier** and **user_identifiers**: Revokes refresh tokens only for the users specified in the request. If the name or ID of the connection author is included in the request, their token will also be revoked. - **connection_identifier** and **configuration_identifiers**: Revokes refresh tokens for all users on the specified configurations, except the configuration author. - **connection_identifier**, **configuration_identifiers**, and **user_identifiers**: Revokes refresh tokens for the specified users on the specified configurations. - **connection_identifier** and **org_identifiers**: Revokes refresh tokens for the specified Orgs. Applicable only for published connections. - **connection_identifier**, **org_identifiers**, and **user_identifiers**: Revokes refresh tokens for the specified users in the specified Orgs. Applicable only for published connections. **NOTE**: The `org_identifiers` parameter is only applicable for published connections. Using this parameter for unpublished connections will result in an error. Ensure that the connections are published before making the API request. | ||
| ### Example | ||
| ```typescript | ||
| import { createBearerAuthenticationConfig, ConnectionsApi, RevokeRefreshTokensRequest } from '@thoughtspot/rest-api-sdk'; | ||
| const configuration = createBearerAuthenticationConfig("CLUSTER_SERVER_URL", { | ||
| username: "YOUR_USERNAME", | ||
| password: "YOUR_PASSWORD", | ||
| }); | ||
| const apiInstance = new ConnectionsApi(configuration); | ||
| apiInstance.revokeRefreshTokens( | ||
| // string | Unique ID or name of the connection whose refresh tokens need to be revoked. All the users associated with the connection will have their refresh tokens revoked except the author. | ||
| "connection_identifier_example" , | ||
| // RevokeRefreshTokensRequest | ||
| { | ||
| configuration_identifiers: [ | ||
| "configuration_identifiers_example", | ||
| ], | ||
| user_identifiers: [ | ||
| "user_identifiers_example", | ||
| ], | ||
| org_identifiers: [ | ||
| "org_identifiers_example", | ||
| ], | ||
| } | ||
| ).then((data:any) => { | ||
| console.log('API called successfully. Returned data: ' + data); | ||
| }).catch((error:any) => console.error(error)); | ||
| ``` | ||
| ### Parameters | ||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **revokeRefreshTokensRequest** | **RevokeRefreshTokensRequest**| | | ||
| **connectionIdentifier** | [**string**] | Unique ID or name of the connection whose refresh tokens need to be revoked. All the users associated with the connection will have their refresh tokens revoked except the author. | defaults to undefined | ||
| ### Return type | ||
| **RevokeRefreshTokensResponse** | ||
| ### Authorization | ||
| [bearerAuth](README.md#bearerAuth) | ||
| ### HTTP request headers | ||
| - **Content-Type**: application/json | ||
| - **Accept**: application/json | ||
| ### HTTP response details | ||
| | Status code | Description | Response headers | | ||
| |-------------|-------------|------------------| | ||
| **200** | Token(s) successfully revoked. | - | | ||
| **400** | Invalid request. | - | | ||
| **401** | Unauthorized access. | - | | ||
| **403** | Forbidden access. | - | | ||
| **404** | Object not found | - | | ||
| **409** | Conflict | - | | ||
| **500** | Unexpected error | - | | ||
| [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) | ||
| # **searchConnection** | ||
@@ -328,0 +404,0 @@ > Array<SearchConnectionResponse> searchConnection(searchConnectionRequest) |
+2
-2
@@ -710,3 +710,3 @@ # ThoughtSpotRestApiSdk.MetadataApi | ||
| Parameterize fields in metadata objects. Version: 10.9.0.cl or later Allows parameterizing fields in metadata objects in ThoughtSpot. Requires appropriate permissions to modify the metadata object. The API endpoint allows parameterizing the following types of metadata objects: * Logical Tables * Connections For a Logical Table the field type must be `ATTRIBUTE` and field name can be one of: * databaseName * schemaName * tableName For a Connection the field type is always `CONNECTION_PROPERTY`. We use the field_name in this case to specify the exact property of a connection which needs to be parameterized. | ||
| Parameterize fields in metadata objects. Version: 10.9.0.cl or later Allows parameterizing fields in metadata objects in ThoughtSpot. Requires appropriate permissions to modify the metadata object. The API endpoint allows parameterizing the following types of metadata objects: * Logical Tables * Connections * Connection Configs For a Logical Table the field type must be `ATTRIBUTE` and field name can be one of: * databaseName * schemaName * tableName For a Connection or Connection Config, the field type is always `CONNECTION_PROPERTY`. In this case, field_name specifies the exact property of the Connection or Connection Config that needs to be parameterized. For Connection Config, the only supported field name is: * impersonate_user | ||
@@ -892,3 +892,3 @@ ### Example | ||
| Remove parameterization from fields in metadata objects. Version: 10.9.0.cl or later Allows removing parameterization from fields in metadata objects in ThoughtSpot. Requires appropriate permissions to modify the metadata object. The API endpoint allows unparameterizing the following types of metadata objects: * Logical Tables * Connections For a Logical Table the field type must be `ATTRIBUTE` and field name can be one of: * databaseName * schemaName * tableName For a Connection the field type is always `CONNECTION_PROPERTY`. We use the field_name in this case to specify the exact property of a connection which needs to be unparameterized. | ||
| Remove parameterization from fields in metadata objects. Version: 10.9.0.cl or later Allows removing parameterization from fields in metadata objects in ThoughtSpot. Requires appropriate permissions to modify the metadata object. The API endpoint allows unparameterizing the following types of metadata objects: * Logical Tables * Connections * Connection Configs For a Logical Table the field type must be `ATTRIBUTE` and field name can be one of: * databaseName * schemaName * tableName For a Connection or Connection Config, the field type is always `CONNECTION_PROPERTY`. In this case, field_name specifies the exact property of the Connection or Connection Config that needs to be unparameterized. For Connection Config, the only supported field name is: * impersonate_user | ||
@@ -895,0 +895,0 @@ ### Example |
+23
-0
@@ -32,2 +32,4 @@ export * from '../models/AIContext' | ||
| export * from '../models/ChangeUserPasswordRequest' | ||
| export * from '../models/ClusterNonEmbedAccess' | ||
| export * from '../models/ClusterNonEmbedAccessInput' | ||
| export * from '../models/Column' | ||
@@ -49,2 +51,4 @@ export * from '../models/ColumnSecurityRule' | ||
| export * from '../models/ConfigureCommunicationChannelPreferencesRequest' | ||
| export * from '../models/ConfigureSecuritySettingsRequest' | ||
| export * from '../models/ConfigureSecuritySettingsRequestClusterPreferences' | ||
| export * from '../models/ConnectionConfigurationResponse' | ||
@@ -65,2 +69,3 @@ export * from '../models/ConnectionConfigurationSearchRequest' | ||
| export * from '../models/CreateConnectionConfigurationRequest' | ||
| export * from '../models/CreateConnectionConfigurationRequestPolicyProcessOptions' | ||
| export * from '../models/CreateConnectionRequest' | ||
@@ -91,2 +96,4 @@ export * from '../models/CreateConnectionResponse' | ||
| export * from '../models/CronExpressionInput' | ||
| export * from '../models/CspSettings' | ||
| export * from '../models/CspSettingsInput' | ||
| export * from '../models/CustomActionMetadataTypeInput' | ||
@@ -167,2 +174,3 @@ export * from '../models/DataSource' | ||
| export * from '../models/GetTokenResponse' | ||
| export * from '../models/GroupInfo' | ||
| export * from '../models/GroupObject' | ||
@@ -210,2 +218,4 @@ export * from '../models/GroupsImportListInput' | ||
| export * from '../models/OrgInfo' | ||
| export * from '../models/OrgNonEmbedAccess' | ||
| export * from '../models/OrgNonEmbedAccessInput' | ||
| export * from '../models/OrgPreferenceSearchCriteriaInput' | ||
@@ -225,2 +235,4 @@ export * from '../models/OrgResponse' | ||
| export * from '../models/PngOptionsInput' | ||
| export * from '../models/PolicyProcessOptions' | ||
| export * from '../models/PolicyProcessOptionsInput' | ||
| export * from '../models/PrincipalsInput' | ||
@@ -256,2 +268,4 @@ export * from '../models/PrincipalsListItem' | ||
| export * from '../models/RevertedMetadata' | ||
| export * from '../models/RevokeRefreshTokensRequest' | ||
| export * from '../models/RevokeRefreshTokensResponse' | ||
| export * from '../models/RevokeTokenRequest' | ||
@@ -272,2 +286,4 @@ export * from '../models/RiseGQLArgWrapper' | ||
| export * from '../models/Scope' | ||
| export * from '../models/ScriptSrcUrls' | ||
| export * from '../models/ScriptSrcUrlsInput' | ||
| export * from '../models/SearchCalendarsRequest' | ||
@@ -295,2 +311,3 @@ export * from '../models/SearchCalendarsRequestSortOptions' | ||
| export * from '../models/SearchSchedulesRequestSortOptions' | ||
| export * from '../models/SearchSecuritySettingsRequest' | ||
| export * from '../models/SearchTagsRequest' | ||
@@ -304,2 +321,8 @@ export * from '../models/SearchUserGroupsRequest' | ||
| export * from '../models/SearchWebhookConfigurationsRequestSortOptions' | ||
| export * from '../models/SecuritySettingsClusterPreferences' | ||
| export * from '../models/SecuritySettingsClusterPreferencesInput' | ||
| export * from '../models/SecuritySettingsOrgDetails' | ||
| export * from '../models/SecuritySettingsOrgPreferences' | ||
| export * from '../models/SecuritySettingsOrgPreferencesInput' | ||
| export * from '../models/SecuritySettingsResponse' | ||
| export * from '../models/SendAgentMessageRequest' | ||
@@ -306,0 +329,0 @@ export * from '../models/SendAgentMessageResponse' |
@@ -13,2 +13,3 @@ /** | ||
| import { PolicyProcessOptions } from '../models/PolicyProcessOptions'; | ||
| import { UserPrincipal } from '../models/UserPrincipal'; | ||
@@ -27,2 +28,4 @@ import { HttpFile } from '../http/http'; | ||
| 'policy_type'?: ConnectionConfigurationResponsePolicyTypeEnum | null; | ||
| 'same_as_parent'?: boolean | null; | ||
| 'policy_process_options'?: PolicyProcessOptions; | ||
@@ -85,2 +88,14 @@ static readonly discriminator: string | undefined = undefined; | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "same_as_parent", | ||
| "baseName": "same_as_parent", | ||
| "type": "boolean", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "policy_process_options", | ||
| "baseName": "policy_process_options", | ||
| "type": "PolicyProcessOptions", | ||
| "format": "" | ||
| } ]; | ||
@@ -87,0 +102,0 @@ |
@@ -13,2 +13,3 @@ /** | ||
| import { CreateConnectionConfigurationRequestPolicyProcessOptions } from '../models/CreateConnectionConfigurationRequestPolicyProcessOptions'; | ||
| import { HttpFile } from '../http/http'; | ||
@@ -30,2 +31,7 @@ | ||
| /** | ||
| * Specifies whether the connection configuration should inherit all properties and authentication type from its parent connection. This attribute is only applicable to parameterized connections. When set to true, the configuration uses only the connection properties and authentication type inherited from the parent. Version: 26.2.0.cl or later | ||
| */ | ||
| 'same_as_parent'?: boolean | null; | ||
| 'policy_process_options'?: CreateConnectionConfigurationRequestPolicyProcessOptions; | ||
| /** | ||
| * Type of authentication used for the connection. | ||
@@ -73,2 +79,14 @@ */ | ||
| { | ||
| "name": "same_as_parent", | ||
| "baseName": "same_as_parent", | ||
| "type": "boolean", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "policy_process_options", | ||
| "baseName": "policy_process_options", | ||
| "type": "CreateConnectionConfigurationRequestPolicyProcessOptions", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "authentication_type", | ||
@@ -75,0 +93,0 @@ "baseName": "authentication_type", |
@@ -119,2 +119,10 @@ /** | ||
| 'company_website_url'?: string | null; | ||
| /** | ||
| * Contact support url (HTTP/HTTPS only). | ||
| */ | ||
| 'contact_support_url'?: string | null; | ||
| /** | ||
| * Whether to hide contact support url. | ||
| */ | ||
| 'hide_contact_support_url'?: boolean | null; | ||
@@ -273,2 +281,14 @@ static readonly discriminator: string | undefined = undefined; | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "contact_support_url", | ||
| "baseName": "contact_support_url", | ||
| "type": "string", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "hide_contact_support_url", | ||
| "baseName": "hide_contact_support_url", | ||
| "type": "boolean", | ||
| "format": "" | ||
| } ]; | ||
@@ -275,0 +295,0 @@ |
@@ -29,3 +29,3 @@ /** | ||
| /** | ||
| * Variable Data Type | ||
| * Variable Data Type, only for formula_variable type, leave empty for others Version: 10.15.0.cl or later | ||
| */ | ||
@@ -32,0 +32,0 @@ 'data_type'?: CreateVariableRequestDataTypeEnum; |
@@ -154,3 +154,3 @@ /** | ||
| export type ExportLiveboardReportRequestFileFormatEnum = "PDF" | "PNG" ; | ||
| export type ExportLiveboardReportRequestFileFormatEnum = "PDF" | "PNG" | "CSV" | "XLSX" ; | ||
+11
-0
@@ -73,2 +73,6 @@ /** | ||
| 'favorite_metadata'?: Array<FavoriteMetadataInput> | null; | ||
| /** | ||
| * Locale for the user. When setting this value, do not set use_browser_language to true, otherwise the browser\'s language setting will take precedence and the preferred_locale value will be ignored. | ||
| */ | ||
| 'preferred_locale'?: ImportUserPreferredLocaleEnum | null; | ||
@@ -161,2 +165,8 @@ static readonly discriminator: string | undefined = undefined; | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "preferred_locale", | ||
| "baseName": "preferred_locale", | ||
| "type": "ImportUserPreferredLocaleEnum", | ||
| "format": "" | ||
| } ]; | ||
@@ -176,2 +186,3 @@ | ||
| export type ImportUserVisibilityEnum = "SHARABLE" | "NON_SHARABLE" ; | ||
| export type ImportUserPreferredLocaleEnum = "en-CA" | "en-GB" | "en-US" | "de-DE" | "ja-JP" | "zh-CN" | "pt-BR" | "fr-FR" | "fr-CA" | "es-US" | "da-DK" | "es-ES" | "fi-FI" | "sv-SE" | "nb-NO" | "pt-PT" | "nl-NL" | "it-IT" | "ru-RU" | "en-IN" | "de-CH" | "en-NZ" | "es-MX" | "en-AU" | "zh-Hant" | "ko-KR" | "en-DE" ; | ||
@@ -80,4 +80,4 @@ /** | ||
| export type ParameterizeMetadataRequestMetadataTypeEnum = "LOGICAL_TABLE" | "CONNECTION" ; | ||
| export type ParameterizeMetadataRequestMetadataTypeEnum = "LOGICAL_TABLE" | "CONNECTION" | "CONNECTION_CONFIG" ; | ||
| export type ParameterizeMetadataRequestFieldTypeEnum = "ATTRIBUTE" | "CONNECTION_PROPERTY" ; | ||
@@ -95,2 +95,6 @@ /** | ||
| 'include_favorite_metadata'?: boolean | null; | ||
| /** | ||
| * Indicates if the user\'s formula variable values should be included in the response. | ||
| */ | ||
| 'include_variable_values'?: boolean | null; | ||
@@ -219,2 +223,8 @@ static readonly discriminator: string | undefined = undefined; | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "include_variable_values", | ||
| "baseName": "include_variable_values", | ||
| "type": "boolean", | ||
| "format": "" | ||
| } ]; | ||
@@ -221,0 +231,0 @@ |
@@ -17,2 +17,4 @@ /** | ||
| 'onboarding_content_url'?: string | null; | ||
| 'saml_enabled'?: boolean | null; | ||
| 'okta_enabled'?: boolean | null; | ||
@@ -27,2 +29,14 @@ static readonly discriminator: string | undefined = undefined; | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "saml_enabled", | ||
| "baseName": "saml_enabled", | ||
| "type": "boolean", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "okta_enabled", | ||
| "baseName": "okta_enabled", | ||
| "type": "boolean", | ||
| "format": "" | ||
| } ]; | ||
@@ -29,0 +43,0 @@ |
@@ -119,2 +119,10 @@ /** | ||
| 'company_website_url'?: string | null; | ||
| /** | ||
| * Contact support url (HTTP/HTTPS only). | ||
| */ | ||
| 'contact_support_url'?: string | null; | ||
| /** | ||
| * Whether to hide contact support url. | ||
| */ | ||
| 'hide_contact_support_url'?: boolean | null; | ||
@@ -273,2 +281,14 @@ static readonly discriminator: string | undefined = undefined; | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "contact_support_url", | ||
| "baseName": "contact_support_url", | ||
| "type": "string", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "hide_contact_support_url", | ||
| "baseName": "hide_contact_support_url", | ||
| "type": "boolean", | ||
| "format": "" | ||
| } ]; | ||
@@ -275,0 +295,0 @@ |
@@ -80,4 +80,4 @@ /** | ||
| export type UnparameterizeMetadataRequestMetadataTypeEnum = "LOGICAL_TABLE" | "CONNECTION" ; | ||
| export type UnparameterizeMetadataRequestMetadataTypeEnum = "LOGICAL_TABLE" | "CONNECTION" | "CONNECTION_CONFIG" ; | ||
| export type UnparameterizeMetadataRequestFieldTypeEnum = "ATTRIBUTE" | "CONNECTION_PROPERTY" ; | ||
@@ -13,2 +13,3 @@ /** | ||
| import { CreateConnectionConfigurationRequestPolicyProcessOptions } from '../models/CreateConnectionConfigurationRequestPolicyProcessOptions'; | ||
| import { HttpFile } from '../http/http'; | ||
@@ -30,2 +31,7 @@ | ||
| /** | ||
| * Specifies whether the connection configuration should inherit all properties and authentication type from its parent connection. This attribute is only applicable to parameterized connections. When set to true, the configuration uses only the connection properties and authentication type inherited from the parent. Version: 26.2.0.cl or later | ||
| */ | ||
| 'same_as_parent'?: boolean | null; | ||
| 'policy_process_options'?: CreateConnectionConfigurationRequestPolicyProcessOptions; | ||
| /** | ||
| * Type of authentication. | ||
@@ -77,2 +83,14 @@ */ | ||
| { | ||
| "name": "same_as_parent", | ||
| "baseName": "same_as_parent", | ||
| "type": "boolean", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "policy_process_options", | ||
| "baseName": "policy_process_options", | ||
| "type": "CreateConnectionConfigurationRequestPolicyProcessOptions", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "authentication_type", | ||
@@ -79,0 +97,0 @@ "baseName": "authentication_type", |
+5
-1
| { | ||
| "name": "@thoughtspot/rest-api-sdk", | ||
| "version": "2.20.0", | ||
| "version": "2.21.0", | ||
| "description": "Api sdk for thoughtspot's public v2 rest api", | ||
@@ -51,2 +51,6 @@ "keywords": [ | ||
| }, | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "git+https://github.com/thoughtspot/rest-api-sdk.git" | ||
| }, | ||
| "publishConfig":{ | ||
@@ -53,0 +57,0 @@ "registry":"https://registry.npmjs.org" |
+1
-1
@@ -1,2 +0,2 @@ | ||
| ## @thoughtspot/rest-api-sdk@2.20.0 | ||
| ## @thoughtspot/rest-api-sdk@2.21.0 | ||
@@ -3,0 +3,0 @@ TypeScript/JavaScript client for ThoughtSpot's v2 [Rest APIs](https://developers.thoughtspot.com/docs/rest-api-v2). |
+1
-1
@@ -83,3 +83,3 @@ # ThoughtSpotRestApiSdk.ReportsApi | ||
| Version: 9.0.0.cl or later Exports a Liveboard and its visualizations in PDF or PNG file format. Requires at least view access to the Liveboard. #### Usage guidelines In the request body, specify the GUID or name of the Liveboard. To generate a Liveboard report with specific visualizations, add GUIDs or names of the visualizations. The default `file_format` is PDF. For PDF downloads, you can specify additional parameters to customize the page orientation and include or exclude the cover page, logo, footer text, and page numbers. Similar customization options are also available for PNG output. **NOTE**: The downloadable file returned in API response file is extensionless. Please rename the downloaded file by typing in the relevant extension. Optionally, you can define [runtime overrides](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_overrides) to apply to the Answer data. To include unsaved changes in the report, pass the `transient_pinboard_content` script generated from the `getExportRequestForCurrentPinboard` method in the Visual Embed SDK. Upon successful execution, the API returns the report with unsaved changes, including ad hoc changes to visualizations. For more information, see [Liveboard Report API](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_liveboard_report_api). **NOTE**: Starting with ThoughtSpot Cloud 10.9.0.cl release, the Liveboard can be exported in the PNG format in the resolution of your choice. To enable this on your instance, contact ThoughtSpot support. When this feature is enabled, the options `include_cover_page`,`include_filter_page` within the `png_options` will not be available for PNG exports. | ||
| Version: 9.0.0.cl or later Exports a Liveboard and its visualizations in PDF, PNG, CSV, or XLSX file format. Requires at least view access to the Liveboard. #### Usage guidelines In the request body, specify the GUID or name of the Liveboard. To generate a Liveboard report with specific visualizations, add GUIDs or names of the visualizations. The default `file_format` is CSV. For PDF exports, you can specify additional parameters to customize the page orientation and include or exclude the cover page, logo, footer text, and page numbers. Similar customization options are available for PNG exports. CSV and XLSX exports do not support customization options. **NOTE**: The downloadable file returned in API response file is extensionless. Please rename the downloaded file by typing in the relevant extension. Optionally, you can define [runtime overrides](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_overrides) to apply to the Answer data. To include unsaved changes in the report, pass the `transient_pinboard_content` script generated from the `getExportRequestForCurrentPinboard` method in the Visual Embed SDK. Upon successful execution, the API returns the report with unsaved changes, including ad hoc changes to visualizations. For more information, see [Liveboard Report API](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_liveboard_report_api). **NOTE**: Starting with ThoughtSpot Cloud 10.9.0.cl release, the Liveboard can be exported in the PNG format in the resolution of your choice. To enable this on your instance, contact ThoughtSpot support. When this feature is enabled, the options `include_cover_page`,`include_filter_page` within the `png_options` will not be available for PNG exports. **NOTE**: Starting with the ThoughtSpot Cloud 26.2.0.cl release, Liveboards can be exported in CSV format. All visualizations in the Liveboard can be exported as individual CSV files. If multiple visualizations are selected or if the entire Liveboard is exported, the output is returned as a .zip file containing the CSV files for each visualization. **NOTE**: Starting with the ThoughtSpot Cloud 26.2.0.cl release, Liveboards can be exported in XLSX format. All selected visualizations are consolidated into a single Excel workbook (.xlsx), with each visualization placed in its own worksheet (tab). XLSX exports are limited to 255 worksheets (tabs) per workbook. | ||
@@ -86,0 +86,0 @@ ### Example |
+140
-0
@@ -8,2 +8,3 @@ # ThoughtSpotRestApiSdk.SystemApi | ||
| [**configureCommunicationChannelPreferences**](SystemApi.md#configureCommunicationChannelPreferences) | **POST** /api/rest/2.0/system/preferences/communication-channels/configure | | ||
| [**configureSecuritySettings**](SystemApi.md#configureSecuritySettings) | **POST** /api/rest/2.0/system/security-settings/configure | | ||
| [**getSystemConfig**](SystemApi.md#getSystemConfig) | **GET** /api/rest/2.0/system/config | | ||
@@ -13,2 +14,3 @@ [**getSystemInformation**](SystemApi.md#getSystemInformation) | **GET** /api/rest/2.0/system | | ||
| [**searchCommunicationChannelPreferences**](SystemApi.md#searchCommunicationChannelPreferences) | **POST** /api/rest/2.0/system/preferences/communication-channels/search | | ||
| [**searchSecuritySettings**](SystemApi.md#searchSecuritySettings) | **POST** /api/rest/2.0/system/security-settings/search | | ||
| [**updateSystemConfig**](SystemApi.md#updateSystemConfig) | **POST** /api/rest/2.0/system/config-update | | ||
@@ -103,2 +105,78 @@ | ||
| # **configureSecuritySettings** | ||
| > void configureSecuritySettings(configureSecuritySettingsRequest) | ||
| Version: 26.2.0.cl or later Configure security settings for your ThoughtSpot application instance. - Use `cluster_preferences` to update cluster-level security settings including CORS whitelisted URLs, CSP settings, SAML redirect URLs, partitioned cookies, and non-embed access configuration. - Use `org_preferences` to configure Org-specific security settings. If your instance has [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview), this allows configuring CORS and non-embed access settings specific to the Org. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. Cluster-level SAML and script-src settings require `ADMINISTRATION` privilege. See [Security Settings](https://developers.thoughtspot.com/docs/security-settings) for more details. | ||
| ### Example | ||
| ```typescript | ||
| import { createBearerAuthenticationConfig, SystemApi, ConfigureSecuritySettingsRequest } from '@thoughtspot/rest-api-sdk'; | ||
| const configuration = createBearerAuthenticationConfig("CLUSTER_SERVER_URL", { | ||
| username: "YOUR_USERNAME", | ||
| password: "YOUR_PASSWORD", | ||
| }); | ||
| const apiInstance = new SystemApi(configuration); | ||
| apiInstance.configureSecuritySettings( | ||
| // ConfigureSecuritySettingsRequest | ||
| { | ||
| cluster_preferences: null, | ||
| org_preferences: [ | ||
| { | ||
| org_identifier: "org_identifier_example", | ||
| cors_whitelisted_urls: [ | ||
| "cors_whitelisted_urls_example", | ||
| ], | ||
| non_embed_access: { | ||
| block_full_app_access: true, | ||
| groups_identifiers_with_access: [ | ||
| "groups_identifiers_with_access_example", | ||
| ], | ||
| }, | ||
| }, | ||
| ], | ||
| } | ||
| ).then((data:any) => { | ||
| console.log('API called successfully. Returned data: ' + data); | ||
| }).catch((error:any) => console.error(error)); | ||
| ``` | ||
| ### Parameters | ||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **configureSecuritySettingsRequest** | **ConfigureSecuritySettingsRequest**| | | ||
| ### Return type | ||
| **void** | ||
| ### Authorization | ||
| [bearerAuth](README.md#bearerAuth) | ||
| ### HTTP request headers | ||
| - **Content-Type**: application/json | ||
| - **Accept**: application/json | ||
| ### HTTP response details | ||
| | Status code | Description | Response headers | | ||
| |-------------|-------------|------------------| | ||
| **204** | Successfully configured the security settings. | - | | ||
| **400** | Invalid request. | - | | ||
| **401** | Unauthorized access. | - | | ||
| **403** | Forbidden access. | - | | ||
| **500** | Unexpected error | - | | ||
| [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) | ||
| # **getSystemConfig** | ||
@@ -338,2 +416,64 @@ > SystemConfig getSystemConfig() | ||
| # **searchSecuritySettings** | ||
| > SecuritySettingsResponse searchSecuritySettings(searchSecuritySettingsRequest) | ||
| Version: 26.2.0.cl or later Fetch security settings for your ThoughtSpot application instance. - Use `scope: CLUSTER` to retrieve cluster-level security settings, including CORS and CSP allowlists, SAML redirect URLs, and settings that control access to non-embedded pages. - Use `scope: ORG` to retrieve Org-level security settings. If your instance has [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview), this returns CORS and non-embed access settings specific to the Org. - If `scope` is not specified, returns both cluster and Org-specific settings based on user privileges. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. See [Security Settings](https://developers.thoughtspot.com/docs/security-settings) for more details. | ||
| ### Example | ||
| ```typescript | ||
| import { createBearerAuthenticationConfig, SystemApi, SearchSecuritySettingsRequest } from '@thoughtspot/rest-api-sdk'; | ||
| const configuration = createBearerAuthenticationConfig("CLUSTER_SERVER_URL", { | ||
| username: "YOUR_USERNAME", | ||
| password: "YOUR_PASSWORD", | ||
| }); | ||
| const apiInstance = new SystemApi(configuration); | ||
| apiInstance.searchSecuritySettings( | ||
| // SearchSecuritySettingsRequest | ||
| { | ||
| scope: "CLUSTER", | ||
| } | ||
| ).then((data:any) => { | ||
| console.log('API called successfully. Returned data: ' + data); | ||
| }).catch((error:any) => console.error(error)); | ||
| ``` | ||
| ### Parameters | ||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **searchSecuritySettingsRequest** | **SearchSecuritySettingsRequest**| | | ||
| ### Return type | ||
| **SecuritySettingsResponse** | ||
| ### Authorization | ||
| [bearerAuth](README.md#bearerAuth) | ||
| ### HTTP request headers | ||
| - **Content-Type**: application/json | ||
| - **Accept**: application/json | ||
| ### HTTP response details | ||
| | Status code | Description | Response headers | | ||
| |-------------|-------------|------------------| | ||
| **200** | Successfully retrieved the list of security settings. | - | | ||
| **400** | Invalid request. | - | | ||
| **401** | Unauthorized access. | - | | ||
| **403** | Forbidden access. | - | | ||
| **500** | Unexpected error | - | | ||
| [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) | ||
| # **updateSystemConfig** | ||
@@ -340,0 +480,0 @@ > void updateSystemConfig(updateSystemConfigRequest) |
+228
-0
@@ -25,2 +25,34 @@ import chai from "chai"; | ||
| describe('createAgentConversation', function() { | ||
| const testReqBodies = requestBodies.filter( | ||
| (body: any) => body.Metadata.operationId === "createAgentConversation" | ||
| ); | ||
| testReqBodies.forEach(async (test: any) => { | ||
| it(`${test.Metadata.operationId} - ${test.Metadata.scenario} : Testid - ${test.Metadata.testId}`, async function () { | ||
| if (test.Metadata.scenario === "positive") { | ||
| var data; | ||
| try { | ||
| data = await instance.createAgentConversation( | ||
| // createAgentConversationRequest CreateAgentConversationRequest | ||
| test.Body | ||
| ) | ||
| } catch (er) { | ||
| console.error(er, "Response", data) | ||
| expect(er).to.be.undefined | ||
| } | ||
| } else { | ||
| await expect( | ||
| instance.createAgentConversation( | ||
| // createAgentConversationRequest CreateAgentConversationRequest | ||
| test.Body | ||
| ) | ||
| ).to.be.rejectedWith(Error); | ||
| } | ||
| }); | ||
| }); | ||
| }); | ||
| describe('createConversation', function() { | ||
@@ -58,2 +90,98 @@ | ||
| describe('getDataSourceSuggestions', function() { | ||
| const testReqBodies = requestBodies.filter( | ||
| (body: any) => body.Metadata.operationId === "getDataSourceSuggestions" | ||
| ); | ||
| testReqBodies.forEach(async (test: any) => { | ||
| it(`${test.Metadata.operationId} - ${test.Metadata.scenario} : Testid - ${test.Metadata.testId}`, async function () { | ||
| if (test.Metadata.scenario === "positive") { | ||
| var data; | ||
| try { | ||
| data = await instance.getDataSourceSuggestions( | ||
| // getDataSourceSuggestionsRequest GetDataSourceSuggestionsRequest | ||
| test.Body | ||
| ) | ||
| } catch (er) { | ||
| console.error(er, "Response", data) | ||
| expect(er).to.be.undefined | ||
| } | ||
| } else { | ||
| await expect( | ||
| instance.getDataSourceSuggestions( | ||
| // getDataSourceSuggestionsRequest GetDataSourceSuggestionsRequest | ||
| test.Body | ||
| ) | ||
| ).to.be.rejectedWith(Error); | ||
| } | ||
| }); | ||
| }); | ||
| }); | ||
| describe('getNLInstructions', function() { | ||
| const testReqBodies = requestBodies.filter( | ||
| (body: any) => body.Metadata.operationId === "getNLInstructions" | ||
| ); | ||
| testReqBodies.forEach(async (test: any) => { | ||
| it(`${test.Metadata.operationId} - ${test.Metadata.scenario} : Testid - ${test.Metadata.testId}`, async function () { | ||
| if (test.Metadata.scenario === "positive") { | ||
| var data; | ||
| try { | ||
| data = await instance.getNLInstructions( | ||
| // getNLInstructionsRequest GetNLInstructionsRequest | ||
| test.Body | ||
| ) | ||
| } catch (er) { | ||
| console.error(er, "Response", data) | ||
| expect(er).to.be.undefined | ||
| } | ||
| } else { | ||
| await expect( | ||
| instance.getNLInstructions( | ||
| // getNLInstructionsRequest GetNLInstructionsRequest | ||
| test.Body | ||
| ) | ||
| ).to.be.rejectedWith(Error); | ||
| } | ||
| }); | ||
| }); | ||
| }); | ||
| describe('getRelevantQuestions', function() { | ||
| const testReqBodies = requestBodies.filter( | ||
| (body: any) => body.Metadata.operationId === "getRelevantQuestions" | ||
| ); | ||
| testReqBodies.forEach(async (test: any) => { | ||
| it(`${test.Metadata.operationId} - ${test.Metadata.scenario} : Testid - ${test.Metadata.testId}`, async function () { | ||
| if (test.Metadata.scenario === "positive") { | ||
| var data; | ||
| try { | ||
| data = await instance.getRelevantQuestions( | ||
| // getRelevantQuestionsRequest GetRelevantQuestionsRequest | ||
| test.Body | ||
| ) | ||
| } catch (er) { | ||
| console.error(er, "Response", data) | ||
| expect(er).to.be.undefined | ||
| } | ||
| } else { | ||
| await expect( | ||
| instance.getRelevantQuestions( | ||
| // getRelevantQuestionsRequest GetRelevantQuestionsRequest | ||
| test.Body | ||
| ) | ||
| ).to.be.rejectedWith(Error); | ||
| } | ||
| }); | ||
| }); | ||
| }); | ||
| describe('queryGetDecomposedQuery', function() { | ||
@@ -91,2 +219,70 @@ | ||
| describe('sendAgentMessage', function() { | ||
| const testReqBodies = requestBodies.filter( | ||
| (body: any) => body.Metadata.operationId === "sendAgentMessage" | ||
| ); | ||
| testReqBodies.forEach(async (test: any) => { | ||
| it(`${test.Metadata.operationId} - ${test.Metadata.scenario} : Testid - ${test.Metadata.testId}`, async function () { | ||
| if (test.Metadata.scenario === "positive") { | ||
| var data; | ||
| try { | ||
| data = await instance.sendAgentMessage( | ||
| // conversationIdentifier conversation_identifier | ||
| test.Path_Variables.conversation_identifier , | ||
| // sendAgentMessageRequest SendAgentMessageRequest | ||
| test.Body | ||
| ) | ||
| } catch (er) { | ||
| console.error(er, "Response", data) | ||
| expect(er).to.be.undefined | ||
| } | ||
| } else { | ||
| await expect( | ||
| instance.sendAgentMessage( | ||
| // conversationIdentifier conversation_identifier | ||
| test.Path_Variables.conversation_identifier , | ||
| // sendAgentMessageRequest SendAgentMessageRequest | ||
| test.Body | ||
| ) | ||
| ).to.be.rejectedWith(Error); | ||
| } | ||
| }); | ||
| }); | ||
| }); | ||
| describe('sendAgentMessageStreaming', function() { | ||
| const testReqBodies = requestBodies.filter( | ||
| (body: any) => body.Metadata.operationId === "sendAgentMessageStreaming" | ||
| ); | ||
| testReqBodies.forEach(async (test: any) => { | ||
| it(`${test.Metadata.operationId} - ${test.Metadata.scenario} : Testid - ${test.Metadata.testId}`, async function () { | ||
| if (test.Metadata.scenario === "positive") { | ||
| var data; | ||
| try { | ||
| data = await instance.sendAgentMessageStreaming( | ||
| // sendAgentMessageStreamingRequest SendAgentMessageStreamingRequest | ||
| test.Body | ||
| ) | ||
| } catch (er) { | ||
| console.error(er, "Response", data) | ||
| expect(er).to.be.undefined | ||
| } | ||
| } else { | ||
| await expect( | ||
| instance.sendAgentMessageStreaming( | ||
| // sendAgentMessageStreamingRequest SendAgentMessageStreamingRequest | ||
| test.Body | ||
| ) | ||
| ).to.be.rejectedWith(Error); | ||
| } | ||
| }); | ||
| }); | ||
| }); | ||
| describe('sendMessage', function() { | ||
@@ -128,2 +324,34 @@ | ||
| describe('setNLInstructions', function() { | ||
| const testReqBodies = requestBodies.filter( | ||
| (body: any) => body.Metadata.operationId === "setNLInstructions" | ||
| ); | ||
| testReqBodies.forEach(async (test: any) => { | ||
| it(`${test.Metadata.operationId} - ${test.Metadata.scenario} : Testid - ${test.Metadata.testId}`, async function () { | ||
| if (test.Metadata.scenario === "positive") { | ||
| var data; | ||
| try { | ||
| data = await instance.setNLInstructions( | ||
| // setNLInstructionsRequest SetNLInstructionsRequest | ||
| test.Body | ||
| ) | ||
| } catch (er) { | ||
| console.error(er, "Response", data) | ||
| expect(er).to.be.undefined | ||
| } | ||
| } else { | ||
| await expect( | ||
| instance.setNLInstructions( | ||
| // setNLInstructionsRequest SetNLInstructionsRequest | ||
| test.Body | ||
| ) | ||
| ).to.be.rejectedWith(Error); | ||
| } | ||
| }); | ||
| }); | ||
| }); | ||
| describe('singleAnswer', function() { | ||
@@ -130,0 +358,0 @@ |
@@ -185,2 +185,38 @@ import chai from "chai"; | ||
| describe('revokeRefreshTokens', function() { | ||
| const testReqBodies = requestBodies.filter( | ||
| (body: any) => body.Metadata.operationId === "revokeRefreshTokens" | ||
| ); | ||
| testReqBodies.forEach(async (test: any) => { | ||
| it(`${test.Metadata.operationId} - ${test.Metadata.scenario} : Testid - ${test.Metadata.testId}`, async function () { | ||
| if (test.Metadata.scenario === "positive") { | ||
| var data; | ||
| try { | ||
| data = await instance.revokeRefreshTokens( | ||
| // connectionIdentifier connection_identifier | ||
| test.Path_Variables.connection_identifier , | ||
| // revokeRefreshTokensRequest RevokeRefreshTokensRequest | ||
| test.Body | ||
| ) | ||
| } catch (er) { | ||
| console.error(er, "Response", data) | ||
| expect(er).to.be.undefined | ||
| } | ||
| } else { | ||
| await expect( | ||
| instance.revokeRefreshTokens( | ||
| // connectionIdentifier connection_identifier | ||
| test.Path_Variables.connection_identifier , | ||
| // revokeRefreshTokensRequest RevokeRefreshTokensRequest | ||
| test.Body | ||
| ) | ||
| ).to.be.rejectedWith(Error); | ||
| } | ||
| }); | ||
| }); | ||
| }); | ||
| describe('searchConnection', function() { | ||
@@ -187,0 +223,0 @@ |
@@ -143,6 +143,6 @@ import chai from "chai"; | ||
| , | ||
| // modelTables model_tables | ||
| , | ||
| // importWorksheets import_worksheets | ||
| , | ||
| // modelTables model_tables | ||
| , | ||
| // worksheets worksheets | ||
@@ -162,6 +162,6 @@ , | ||
| , | ||
| // modelTables model_tables | ||
| , | ||
| // importWorksheets import_worksheets | ||
| , | ||
| // modelTables model_tables | ||
| , | ||
| // worksheets worksheets | ||
@@ -168,0 +168,0 @@ , |
+128
-0
@@ -25,2 +25,66 @@ import chai from "chai"; | ||
| describe('configureCommunicationChannelPreferences', function() { | ||
| const testReqBodies = requestBodies.filter( | ||
| (body: any) => body.Metadata.operationId === "configureCommunicationChannelPreferences" | ||
| ); | ||
| testReqBodies.forEach(async (test: any) => { | ||
| it(`${test.Metadata.operationId} - ${test.Metadata.scenario} : Testid - ${test.Metadata.testId}`, async function () { | ||
| if (test.Metadata.scenario === "positive") { | ||
| var data; | ||
| try { | ||
| data = await instance.configureCommunicationChannelPreferences( | ||
| // configureCommunicationChannelPreferencesRequest ConfigureCommunicationChannelPreferencesRequest | ||
| test.Body | ||
| ) | ||
| } catch (er) { | ||
| console.error(er, "Response", data) | ||
| expect(er).to.be.undefined | ||
| } | ||
| } else { | ||
| await expect( | ||
| instance.configureCommunicationChannelPreferences( | ||
| // configureCommunicationChannelPreferencesRequest ConfigureCommunicationChannelPreferencesRequest | ||
| test.Body | ||
| ) | ||
| ).to.be.rejectedWith(Error); | ||
| } | ||
| }); | ||
| }); | ||
| }); | ||
| describe('configureSecuritySettings', function() { | ||
| const testReqBodies = requestBodies.filter( | ||
| (body: any) => body.Metadata.operationId === "configureSecuritySettings" | ||
| ); | ||
| testReqBodies.forEach(async (test: any) => { | ||
| it(`${test.Metadata.operationId} - ${test.Metadata.scenario} : Testid - ${test.Metadata.testId}`, async function () { | ||
| if (test.Metadata.scenario === "positive") { | ||
| var data; | ||
| try { | ||
| data = await instance.configureSecuritySettings( | ||
| // configureSecuritySettingsRequest ConfigureSecuritySettingsRequest | ||
| test.Body | ||
| ) | ||
| } catch (er) { | ||
| console.error(er, "Response", data) | ||
| expect(er).to.be.undefined | ||
| } | ||
| } else { | ||
| await expect( | ||
| instance.configureSecuritySettings( | ||
| // configureSecuritySettingsRequest ConfigureSecuritySettingsRequest | ||
| test.Body | ||
| ) | ||
| ).to.be.rejectedWith(Error); | ||
| } | ||
| }); | ||
| }); | ||
| }); | ||
| describe('getSystemConfig', function() { | ||
@@ -110,2 +174,66 @@ | ||
| describe('searchCommunicationChannelPreferences', function() { | ||
| const testReqBodies = requestBodies.filter( | ||
| (body: any) => body.Metadata.operationId === "searchCommunicationChannelPreferences" | ||
| ); | ||
| testReqBodies.forEach(async (test: any) => { | ||
| it(`${test.Metadata.operationId} - ${test.Metadata.scenario} : Testid - ${test.Metadata.testId}`, async function () { | ||
| if (test.Metadata.scenario === "positive") { | ||
| var data; | ||
| try { | ||
| data = await instance.searchCommunicationChannelPreferences( | ||
| // searchCommunicationChannelPreferencesRequest SearchCommunicationChannelPreferencesRequest | ||
| test.Body | ||
| ) | ||
| } catch (er) { | ||
| console.error(er, "Response", data) | ||
| expect(er).to.be.undefined | ||
| } | ||
| } else { | ||
| await expect( | ||
| instance.searchCommunicationChannelPreferences( | ||
| // searchCommunicationChannelPreferencesRequest SearchCommunicationChannelPreferencesRequest | ||
| test.Body | ||
| ) | ||
| ).to.be.rejectedWith(Error); | ||
| } | ||
| }); | ||
| }); | ||
| }); | ||
| describe('searchSecuritySettings', function() { | ||
| const testReqBodies = requestBodies.filter( | ||
| (body: any) => body.Metadata.operationId === "searchSecuritySettings" | ||
| ); | ||
| testReqBodies.forEach(async (test: any) => { | ||
| it(`${test.Metadata.operationId} - ${test.Metadata.scenario} : Testid - ${test.Metadata.testId}`, async function () { | ||
| if (test.Metadata.scenario === "positive") { | ||
| var data; | ||
| try { | ||
| data = await instance.searchSecuritySettings( | ||
| // searchSecuritySettingsRequest SearchSecuritySettingsRequest | ||
| test.Body | ||
| ) | ||
| } catch (er) { | ||
| console.error(er, "Response", data) | ||
| expect(er).to.be.undefined | ||
| } | ||
| } else { | ||
| await expect( | ||
| instance.searchSecuritySettings( | ||
| // searchSecuritySettingsRequest SearchSecuritySettingsRequest | ||
| test.Body | ||
| ) | ||
| ).to.be.rejectedWith(Error); | ||
| } | ||
| }); | ||
| }); | ||
| }); | ||
| describe('updateSystemConfig', function() { | ||
@@ -112,0 +240,0 @@ |
+2
-0
@@ -469,2 +469,3 @@ # ThoughtSpotRestApiSdk.UsersApi | ||
| ], | ||
| preferred_locale: "en-CA", | ||
| }, | ||
@@ -632,2 +633,3 @@ ], | ||
| include_favorite_metadata: false, | ||
| include_variable_values: false, | ||
| } | ||
@@ -634,0 +636,0 @@ ).then((data:any) => { |
+2
-2
@@ -221,3 +221,3 @@ # ThoughtSpotRestApiSdk.VariableApi | ||
| Update a variable\'s name Version: 10.14.0.cl or later Allows updating a variable\'s properties in ThoughtSpot. Requires ADMINISTRATION role and TENANT scope. The CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope. The API endpoint allows updating: * The variable name | ||
| Update a variable\'s name Version: 10.14.0.cl or later Allows updating a variable\'s name in ThoughtSpot. Requires ADMINISTRATION role and TENANT scope. The CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope. The API endpoint allows updating: * The variable name | ||
@@ -287,3 +287,3 @@ ### Example | ||
| Update values for multiple variables Version: 10.14.0.cl or later Allows updating values for multiple variables in ThoughtSpot. Requires ADMINISTRATION role. The CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope. The API endpoint allows: * Adding new values to variables * Replacing existing values * Deleting values from variables When updating variable values, you need to specify: * The variable identifiers * The values to add/replace/remove for each variable * The operation to perform (ADD, REPLACE, REMOVE, CLEAR) Behaviour based on operation type: * ADD - Adds values to the variable if this is a list type variable, else same as replace. * REPLACE - Replaces all values of a given set of constraints with the current set of values. * REMOVE - Removes any values which match the set of conditions of the variables if this is a list type variable, else clears value. * CLEAR - Removes all constrains for a given variable, scope is ignored | ||
| Update values for multiple variables Version: 10.14.0.cl or later Allows updating values for multiple variables in ThoughtSpot. Requires ADMINISTRATION role. The CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope. The API endpoint allows: * Adding new values to variables * Replacing existing values * Deleting values from variables When updating variable values, you need to specify: * The variable identifiers * The values to add/replace/remove for each variable * The operation to perform (ADD, REPLACE, REMOVE, RESET) Behaviour based on operation type: * ADD - Adds values to the variable if this is a list type variable, else same as replace. * REPLACE - Replaces all values of a given set of constraints with the current set of values. * REMOVE - Removes any values which match the set of conditions of the variables if this is a list type variable, else clears value. * RESET - Removes all constrains for a given variable, scope is ignored | ||
@@ -290,0 +290,0 @@ ### Example |
| // TODO: better import syntax? | ||
| import {BaseAPIRequestFactory, RequiredError, COLLECTION_FORMATS} from './baseapi'; | ||
| import {Configuration} from '../configuration'; | ||
| import {RequestContext, HttpMethod, ResponseContext, HttpFile} from '../http/http'; | ||
| import {ObjectSerializer} from '../models/ObjectSerializer'; | ||
| import {ApiException} from './exception'; | ||
| import {canConsumeForm, isCodeInRange} from '../util'; | ||
| import {SecurityAuthentication} from '../auth/auth'; | ||
| import { CreateEmailCustomisationRequest } from '../models/CreateEmailCustomisationRequest'; | ||
| import { CreateEmailCustomisationResponse } from '../models/CreateEmailCustomisationResponse'; | ||
| import { ErrorResponse } from '../models/ErrorResponse'; | ||
| /** | ||
| * no description | ||
| */ | ||
| export class EmailCustomisationApiRequestFactory extends BaseAPIRequestFactory { | ||
| /** | ||
| * Version: 10.10.0.cl or later Creates a custom configuration for the email customisation #### Pre-requisites Requires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `_Has developer privilege` privilege is required. Coms should be enabled on the cluster. #### Usage guidelines To create a custom confuguration: 1. Pass these parameters in your API request. - A JSON map of configuration attributes `template_properties`. The following example shows the configuration attribures for a csutom configuration: ``` { { \"logoUrl\": \"<logo_url>\", \"homeUrl\": \"<home_url>\", \"productName\": \"<Company Name in the Mail>\", \"footerAddress\": \"<address to be visible in the footer>\", \"ctaButtonBgColor\": \"#444DEA\", \"ctaTextFontColor\": \"#FFFFFF\", \"primaryBgColor\": \"#D3DEF0\", \"hideMobileAppNudge\": <true/false>, \"hideTsVocabularyDefinitions\": <true/false>e, \"hideProductName\": <true/false>, \"hideFooterPhone\": <true/false>, \"hideFooterAddress\": <true/false>, \"hidePrivacyPolicy\": <true/false>, \"hideManageNotification\": <true/false>, \"fontfamily\": \"<to maintain a single font in the entire email>\" } } ``` | ||
| * @param createEmailCustomisationRequest | ||
| */ | ||
| public async createEmailCustomisation(createEmailCustomisationRequest: CreateEmailCustomisationRequest, _options?: Configuration): Promise<RequestContext> { | ||
| let _config = _options || this.configuration; | ||
| // verify required parameter 'createEmailCustomisationRequest' is not null or undefined | ||
| if (createEmailCustomisationRequest === null || createEmailCustomisationRequest === undefined) { | ||
| throw new RequiredError("EmailCustomisationApi", "createEmailCustomisation", "createEmailCustomisationRequest"); | ||
| } | ||
| // Path Params | ||
| const localVarPath = '/api/rest/2.0/customization/email'; | ||
| // Make Request Context | ||
| const requestContext = _config.baseServer.makeRequestContext(localVarPath, HttpMethod.POST); | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.15.1") | ||
| // Body Params | ||
| const contentType = ObjectSerializer.getPreferredMediaType([ | ||
| "application/json" | ||
| ]); | ||
| requestContext.setHeaderParam("Content-Type", contentType); | ||
| const serializedBody = ObjectSerializer.stringify( | ||
| ObjectSerializer.serialize(createEmailCustomisationRequest, "CreateEmailCustomisationRequest", ""), | ||
| contentType | ||
| ); | ||
| requestContext.setBody(serializedBody); | ||
| let authMethod: SecurityAuthentication | undefined; | ||
| // Apply auth methods | ||
| authMethod = _config.authMethods["bearerAuth"] | ||
| if (authMethod?.applySecurityAuthentication) { | ||
| await authMethod?.applySecurityAuthentication(requestContext); | ||
| } | ||
| const defaultAuth: SecurityAuthentication | undefined = _options?.authMethods?.default || this.configuration?.authMethods?.default | ||
| if (defaultAuth?.applySecurityAuthentication) { | ||
| await defaultAuth?.applySecurityAuthentication(requestContext); | ||
| } | ||
| return requestContext; | ||
| } | ||
| /** | ||
| * Version: 10.10.0.cl or later Deletes the configuration for the email customisation. #### Pre-requisites Requires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `_Has developer privilege` privilege is required. Coms should be enabled on the cluster. #### Usage guidelines Deletes the configuration available for the cluster/org. Pass the `template_identifier` in the API request. Note: `template_identifier` can be fetched from search API request. | ||
| * @param templateIdentifier Unique ID or name of the email customization. | ||
| */ | ||
| public async deleteEmailCustomisation(templateIdentifier: string, _options?: Configuration): Promise<RequestContext> { | ||
| let _config = _options || this.configuration; | ||
| // verify required parameter 'templateIdentifier' is not null or undefined | ||
| if (templateIdentifier === null || templateIdentifier === undefined) { | ||
| throw new RequiredError("EmailCustomisationApi", "deleteEmailCustomisation", "templateIdentifier"); | ||
| } | ||
| // Path Params | ||
| const localVarPath = '/api/rest/2.0/customization/email/{template_identifier}/delete' | ||
| .replace('{' + 'template_identifier' + '}', encodeURIComponent(String(templateIdentifier))); | ||
| // Make Request Context | ||
| const requestContext = _config.baseServer.makeRequestContext(localVarPath, HttpMethod.POST); | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.15.1") | ||
| let authMethod: SecurityAuthentication | undefined; | ||
| // Apply auth methods | ||
| authMethod = _config.authMethods["bearerAuth"] | ||
| if (authMethod?.applySecurityAuthentication) { | ||
| await authMethod?.applySecurityAuthentication(requestContext); | ||
| } | ||
| const defaultAuth: SecurityAuthentication | undefined = _options?.authMethods?.default || this.configuration?.authMethods?.default | ||
| if (defaultAuth?.applySecurityAuthentication) { | ||
| await defaultAuth?.applySecurityAuthentication(requestContext); | ||
| } | ||
| return requestContext; | ||
| } | ||
| /** | ||
| * Version: 10.10.0.cl or later Search the email customisation configuration if any set for the ThoughtSpot system. #### Pre-requisites Requires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `_Has developer privilege` privilege is required. Coms should be enabled on the cluster. #### Usage guidelines To get the list of configurations set in the cluster/org. | ||
| */ | ||
| public async searchEmailCustomisation(_options?: Configuration): Promise<RequestContext> { | ||
| let _config = _options || this.configuration; | ||
| // Path Params | ||
| const localVarPath = '/api/rest/2.0/customization/email/search'; | ||
| // Make Request Context | ||
| const requestContext = _config.baseServer.makeRequestContext(localVarPath, HttpMethod.POST); | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.15.1") | ||
| let authMethod: SecurityAuthentication | undefined; | ||
| // Apply auth methods | ||
| authMethod = _config.authMethods["bearerAuth"] | ||
| if (authMethod?.applySecurityAuthentication) { | ||
| await authMethod?.applySecurityAuthentication(requestContext); | ||
| } | ||
| const defaultAuth: SecurityAuthentication | undefined = _options?.authMethods?.default || this.configuration?.authMethods?.default | ||
| if (defaultAuth?.applySecurityAuthentication) { | ||
| await defaultAuth?.applySecurityAuthentication(requestContext); | ||
| } | ||
| return requestContext; | ||
| } | ||
| /** | ||
| * Version: 10.10.0.cl or later Validates the email customisation configuration if any set for the ThoughtSpot system. #### Pre-requisites Requires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `_Has developer privilege` privilege is required. Coms should be enabled on the cluster. | ||
| */ | ||
| public async validateEmailCustomisation(_options?: Configuration): Promise<RequestContext> { | ||
| let _config = _options || this.configuration; | ||
| // Path Params | ||
| const localVarPath = '/api/rest/2.0/customization/email/validate'; | ||
| // Make Request Context | ||
| const requestContext = _config.baseServer.makeRequestContext(localVarPath, HttpMethod.POST); | ||
| requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
| requestContext.setHeaderParam("User-Agent", "ThoughtSpot-Client/typescript/2.15.1") | ||
| let authMethod: SecurityAuthentication | undefined; | ||
| // Apply auth methods | ||
| authMethod = _config.authMethods["bearerAuth"] | ||
| if (authMethod?.applySecurityAuthentication) { | ||
| await authMethod?.applySecurityAuthentication(requestContext); | ||
| } | ||
| const defaultAuth: SecurityAuthentication | undefined = _options?.authMethods?.default || this.configuration?.authMethods?.default | ||
| if (defaultAuth?.applySecurityAuthentication) { | ||
| await defaultAuth?.applySecurityAuthentication(requestContext); | ||
| } | ||
| return requestContext; | ||
| } | ||
| } | ||
| export class EmailCustomisationApiResponseProcessor { | ||
| /** | ||
| * Unwraps the actual response sent by the server from the response context and deserializes the response content | ||
| * to the expected objects | ||
| * | ||
| * @params response Response returned by the server for a request to createEmailCustomisation | ||
| * @throws ApiException if the response code was not in [200, 299] | ||
| */ | ||
| public async createEmailCustomisation(response: ResponseContext): Promise<CreateEmailCustomisationResponse > { | ||
| const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]); | ||
| if (isCodeInRange("200", response.httpStatusCode)) { | ||
| const body: CreateEmailCustomisationResponse = ObjectSerializer.deserialize( | ||
| ObjectSerializer.parse(await response.body.text(), contentType), | ||
| "CreateEmailCustomisationResponse", "" | ||
| ) as CreateEmailCustomisationResponse; | ||
| return body; | ||
| } | ||
| if (isCodeInRange("400", response.httpStatusCode)) { | ||
| const body: ErrorResponse = ObjectSerializer.deserialize( | ||
| ObjectSerializer.parse(await response.body.text(), contentType), | ||
| "ErrorResponse", "" | ||
| ) as ErrorResponse; | ||
| throw new ApiException<ErrorResponse>(response.httpStatusCode, "Invalid request.", body, response.headers); | ||
| } | ||
| if (isCodeInRange("403", response.httpStatusCode)) { | ||
| const body: ErrorResponse = ObjectSerializer.deserialize( | ||
| ObjectSerializer.parse(await response.body.text(), contentType), | ||
| "ErrorResponse", "" | ||
| ) as ErrorResponse; | ||
| throw new ApiException<ErrorResponse>(response.httpStatusCode, "Unauthorized access.", body, response.headers); | ||
| } | ||
| if (isCodeInRange("500", response.httpStatusCode)) { | ||
| const body: ErrorResponse = ObjectSerializer.deserialize( | ||
| ObjectSerializer.parse(await response.body.text(), contentType), | ||
| "ErrorResponse", "" | ||
| ) as ErrorResponse; | ||
| throw new ApiException<ErrorResponse>(response.httpStatusCode, "Unexpected error", body, response.headers); | ||
| } | ||
| // Work around for missing responses in specification, e.g. for petstore.yaml | ||
| if (response.httpStatusCode >= 200 && response.httpStatusCode <= 299) { | ||
| const body: CreateEmailCustomisationResponse = ObjectSerializer.deserialize( | ||
| ObjectSerializer.parse(await response.body.text(), contentType), | ||
| "CreateEmailCustomisationResponse", "" | ||
| ) as CreateEmailCustomisationResponse; | ||
| return body; | ||
| } | ||
| throw new ApiException<string | Blob | undefined>(response.httpStatusCode, "Unknown API Status Code!", await response.getBodyAsAny(), response.headers); | ||
| } | ||
| /** | ||
| * Unwraps the actual response sent by the server from the response context and deserializes the response content | ||
| * to the expected objects | ||
| * | ||
| * @params response Response returned by the server for a request to deleteEmailCustomisation | ||
| * @throws ApiException if the response code was not in [200, 299] | ||
| */ | ||
| public async deleteEmailCustomisation(response: ResponseContext): Promise<void > { | ||
| const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]); | ||
| if (isCodeInRange("204", response.httpStatusCode)) { | ||
| return; | ||
| } | ||
| if (isCodeInRange("400", response.httpStatusCode)) { | ||
| const body: ErrorResponse = ObjectSerializer.deserialize( | ||
| ObjectSerializer.parse(await response.body.text(), contentType), | ||
| "ErrorResponse", "" | ||
| ) as ErrorResponse; | ||
| throw new ApiException<ErrorResponse>(response.httpStatusCode, "Invalid request.", body, response.headers); | ||
| } | ||
| if (isCodeInRange("403", response.httpStatusCode)) { | ||
| const body: ErrorResponse = ObjectSerializer.deserialize( | ||
| ObjectSerializer.parse(await response.body.text(), contentType), | ||
| "ErrorResponse", "" | ||
| ) as ErrorResponse; | ||
| throw new ApiException<ErrorResponse>(response.httpStatusCode, "Unauthorized access.", body, response.headers); | ||
| } | ||
| if (isCodeInRange("500", response.httpStatusCode)) { | ||
| const body: ErrorResponse = ObjectSerializer.deserialize( | ||
| ObjectSerializer.parse(await response.body.text(), contentType), | ||
| "ErrorResponse", "" | ||
| ) as ErrorResponse; | ||
| throw new ApiException<ErrorResponse>(response.httpStatusCode, "Unexpected error", body, response.headers); | ||
| } | ||
| // Work around for missing responses in specification, e.g. for petstore.yaml | ||
| if (response.httpStatusCode >= 200 && response.httpStatusCode <= 299) { | ||
| const body: void = ObjectSerializer.deserialize( | ||
| ObjectSerializer.parse(await response.body.text(), contentType), | ||
| "void", "" | ||
| ) as void; | ||
| return body; | ||
| } | ||
| throw new ApiException<string | Blob | undefined>(response.httpStatusCode, "Unknown API Status Code!", await response.getBodyAsAny(), response.headers); | ||
| } | ||
| /** | ||
| * Unwraps the actual response sent by the server from the response context and deserializes the response content | ||
| * to the expected objects | ||
| * | ||
| * @params response Response returned by the server for a request to searchEmailCustomisation | ||
| * @throws ApiException if the response code was not in [200, 299] | ||
| */ | ||
| public async searchEmailCustomisation(response: ResponseContext): Promise<Array<CreateEmailCustomisationResponse> > { | ||
| const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]); | ||
| if (isCodeInRange("200", response.httpStatusCode)) { | ||
| const body: Array<CreateEmailCustomisationResponse> = ObjectSerializer.deserialize( | ||
| ObjectSerializer.parse(await response.body.text(), contentType), | ||
| "Array<CreateEmailCustomisationResponse>", "" | ||
| ) as Array<CreateEmailCustomisationResponse>; | ||
| return body; | ||
| } | ||
| if (isCodeInRange("400", response.httpStatusCode)) { | ||
| const body: ErrorResponse = ObjectSerializer.deserialize( | ||
| ObjectSerializer.parse(await response.body.text(), contentType), | ||
| "ErrorResponse", "" | ||
| ) as ErrorResponse; | ||
| throw new ApiException<ErrorResponse>(response.httpStatusCode, "Invalid request.", body, response.headers); | ||
| } | ||
| if (isCodeInRange("403", response.httpStatusCode)) { | ||
| const body: ErrorResponse = ObjectSerializer.deserialize( | ||
| ObjectSerializer.parse(await response.body.text(), contentType), | ||
| "ErrorResponse", "" | ||
| ) as ErrorResponse; | ||
| throw new ApiException<ErrorResponse>(response.httpStatusCode, "Unauthorized access.", body, response.headers); | ||
| } | ||
| if (isCodeInRange("500", response.httpStatusCode)) { | ||
| const body: ErrorResponse = ObjectSerializer.deserialize( | ||
| ObjectSerializer.parse(await response.body.text(), contentType), | ||
| "ErrorResponse", "" | ||
| ) as ErrorResponse; | ||
| throw new ApiException<ErrorResponse>(response.httpStatusCode, "Unexpected error", body, response.headers); | ||
| } | ||
| // Work around for missing responses in specification, e.g. for petstore.yaml | ||
| if (response.httpStatusCode >= 200 && response.httpStatusCode <= 299) { | ||
| const body: Array<CreateEmailCustomisationResponse> = ObjectSerializer.deserialize( | ||
| ObjectSerializer.parse(await response.body.text(), contentType), | ||
| "Array<CreateEmailCustomisationResponse>", "" | ||
| ) as Array<CreateEmailCustomisationResponse>; | ||
| return body; | ||
| } | ||
| throw new ApiException<string | Blob | undefined>(response.httpStatusCode, "Unknown API Status Code!", await response.getBodyAsAny(), response.headers); | ||
| } | ||
| /** | ||
| * Unwraps the actual response sent by the server from the response context and deserializes the response content | ||
| * to the expected objects | ||
| * | ||
| * @params response Response returned by the server for a request to validateEmailCustomisation | ||
| * @throws ApiException if the response code was not in [200, 299] | ||
| */ | ||
| public async validateEmailCustomisation(response: ResponseContext): Promise<void > { | ||
| const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]); | ||
| if (isCodeInRange("204", response.httpStatusCode)) { | ||
| return; | ||
| } | ||
| if (isCodeInRange("400", response.httpStatusCode)) { | ||
| const body: ErrorResponse = ObjectSerializer.deserialize( | ||
| ObjectSerializer.parse(await response.body.text(), contentType), | ||
| "ErrorResponse", "" | ||
| ) as ErrorResponse; | ||
| throw new ApiException<ErrorResponse>(response.httpStatusCode, "Invalid request.", body, response.headers); | ||
| } | ||
| if (isCodeInRange("403", response.httpStatusCode)) { | ||
| const body: ErrorResponse = ObjectSerializer.deserialize( | ||
| ObjectSerializer.parse(await response.body.text(), contentType), | ||
| "ErrorResponse", "" | ||
| ) as ErrorResponse; | ||
| throw new ApiException<ErrorResponse>(response.httpStatusCode, "Unauthorized access.", body, response.headers); | ||
| } | ||
| if (isCodeInRange("500", response.httpStatusCode)) { | ||
| const body: ErrorResponse = ObjectSerializer.deserialize( | ||
| ObjectSerializer.parse(await response.body.text(), contentType), | ||
| "ErrorResponse", "" | ||
| ) as ErrorResponse; | ||
| throw new ApiException<ErrorResponse>(response.httpStatusCode, "Unexpected error", body, response.headers); | ||
| } | ||
| // Work around for missing responses in specification, e.g. for petstore.yaml | ||
| if (response.httpStatusCode >= 200 && response.httpStatusCode <= 299) { | ||
| const body: void = ObjectSerializer.deserialize( | ||
| ObjectSerializer.parse(await response.body.text(), contentType), | ||
| "void", "" | ||
| ) as void; | ||
| return body; | ||
| } | ||
| throw new ApiException<string | Blob | undefined>(response.httpStatusCode, "Unknown API Status Code!", await response.getBodyAsAny(), response.headers); | ||
| } | ||
| } |
| # ThoughtSpotRestApiSdk.EmailCustomisationApi | ||
| All URIs are relative to *CLUSTER_URL* | ||
| Method | HTTP request | Description | ||
| ------------- | ------------- | ------------- | ||
| [**createEmailCustomisation**](EmailCustomisationApi.md#createEmailCustomisation) | **POST** /api/rest/2.0/customization/email | | ||
| [**deleteEmailCustomisation**](EmailCustomisationApi.md#deleteEmailCustomisation) | **POST** /api/rest/2.0/customization/email/{template_identifier}/delete | | ||
| [**searchEmailCustomisation**](EmailCustomisationApi.md#searchEmailCustomisation) | **POST** /api/rest/2.0/customization/email/search | | ||
| [**validateEmailCustomisation**](EmailCustomisationApi.md#validateEmailCustomisation) | **POST** /api/rest/2.0/customization/email/validate | | ||
| # **createEmailCustomisation** | ||
| > CreateEmailCustomisationResponse createEmailCustomisation(createEmailCustomisationRequest) | ||
| Version: 10.10.0.cl or later Creates a custom configuration for the email customisation #### Pre-requisites Requires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `_Has developer privilege` privilege is required. Coms should be enabled on the cluster. #### Usage guidelines To create a custom confuguration: 1. Pass these parameters in your API request. - A JSON map of configuration attributes `template_properties`. The following example shows the configuration attribures for a csutom configuration: ``` { { \"logoUrl\": \"<logo_url>\", \"homeUrl\": \"<home_url>\", \"productName\": \"<Company Name in the Mail>\", \"footerAddress\": \"<address to be visible in the footer>\", \"ctaButtonBgColor\": \"#444DEA\", \"ctaTextFontColor\": \"#FFFFFF\", \"primaryBgColor\": \"#D3DEF0\", \"hideMobileAppNudge\": <true/false>, \"hideTsVocabularyDefinitions\": <true/false>e, \"hideProductName\": <true/false>, \"hideFooterPhone\": <true/false>, \"hideFooterAddress\": <true/false>, \"hidePrivacyPolicy\": <true/false>, \"hideManageNotification\": <true/false>, \"fontfamily\": \"<to maintain a single font in the entire email>\" } } ``` | ||
| ### Example | ||
| ```typescript | ||
| import { createBearerAuthenticationConfig, EmailCustomisationApi, CreateEmailCustomisationRequest } from '@thoughtspot/rest-api-sdk'; | ||
| const configuration = createBearerAuthenticationConfig("CLUSTER_SERVER_URL", { | ||
| username: "YOUR_USERNAME", | ||
| password: "YOUR_PASSWORD", | ||
| }); | ||
| const apiInstance = new EmailCustomisationApi(configuration); | ||
| apiInstance.createEmailCustomisation( | ||
| // CreateEmailCustomisationRequest | ||
| { | ||
| template_properties: {}, | ||
| } | ||
| ).then((data:any) => { | ||
| console.log('API called successfully. Returned data: ' + data); | ||
| }).catch((error:any) => console.error(error)); | ||
| ``` | ||
| ### Parameters | ||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **createEmailCustomisationRequest** | **CreateEmailCustomisationRequest**| | | ||
| ### Return type | ||
| **CreateEmailCustomisationResponse** | ||
| ### Authorization | ||
| [bearerAuth](README.md#bearerAuth) | ||
| ### HTTP request headers | ||
| - **Content-Type**: application/json | ||
| - **Accept**: application/json | ||
| ### HTTP response details | ||
| | Status code | Description | Response headers | | ||
| |-------------|-------------|------------------| | ||
| **200** | OK | - | | ||
| **400** | Invalid request. | - | | ||
| **403** | Unauthorized access. | - | | ||
| **500** | Unexpected error | - | | ||
| [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) | ||
| # **deleteEmailCustomisation** | ||
| > void deleteEmailCustomisation() | ||
| Version: 10.10.0.cl or later Deletes the configuration for the email customisation. #### Pre-requisites Requires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `_Has developer privilege` privilege is required. Coms should be enabled on the cluster. #### Usage guidelines Deletes the configuration available for the cluster/org. Pass the `template_identifier` in the API request. Note: `template_identifier` can be fetched from search API request. | ||
| ### Example | ||
| ```typescript | ||
| import { createBearerAuthenticationConfig, EmailCustomisationApi, DeleteEmailCustomisationRequest } from '@thoughtspot/rest-api-sdk'; | ||
| const configuration = createBearerAuthenticationConfig("CLUSTER_SERVER_URL", { | ||
| username: "YOUR_USERNAME", | ||
| password: "YOUR_PASSWORD", | ||
| }); | ||
| const apiInstance = new EmailCustomisationApi(configuration); | ||
| apiInstance.deleteEmailCustomisation( | ||
| // string | Unique ID or name of the email customization. | ||
| "template_identifier_example" | ||
| ).then((data:any) => { | ||
| console.log('API called successfully. Returned data: ' + data); | ||
| }).catch((error:any) => console.error(error)); | ||
| ``` | ||
| ### Parameters | ||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **templateIdentifier** | [**string**] | Unique ID or name of the email customization. | defaults to undefined | ||
| ### Return type | ||
| **void** | ||
| ### Authorization | ||
| [bearerAuth](README.md#bearerAuth) | ||
| ### HTTP request headers | ||
| - **Content-Type**: Not defined | ||
| - **Accept**: application/json | ||
| ### HTTP response details | ||
| | Status code | Description | Response headers | | ||
| |-------------|-------------|------------------| | ||
| **204** | Email Customization configuration successfully deleted. | - | | ||
| **400** | Invalid request. | - | | ||
| **403** | Unauthorized access. | - | | ||
| **500** | Unexpected error | - | | ||
| [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) | ||
| # **searchEmailCustomisation** | ||
| > Array<CreateEmailCustomisationResponse> searchEmailCustomisation() | ||
| Version: 10.10.0.cl or later Search the email customisation configuration if any set for the ThoughtSpot system. #### Pre-requisites Requires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `_Has developer privilege` privilege is required. Coms should be enabled on the cluster. #### Usage guidelines To get the list of configurations set in the cluster/org. | ||
| ### Example | ||
| ```typescript | ||
| import { createBearerAuthenticationConfig, EmailCustomisationApi, SearchEmailCustomisationRequest } from '@thoughtspot/rest-api-sdk'; | ||
| const configuration = createBearerAuthenticationConfig("CLUSTER_SERVER_URL", { | ||
| username: "YOUR_USERNAME", | ||
| password: "YOUR_PASSWORD", | ||
| }); | ||
| const apiInstance = new EmailCustomisationApi(configuration); | ||
| apiInstance.searchEmailCustomisation().then((data:any) => { | ||
| console.log('API called successfully. Returned data: ' + JSON.stringify(data)); | ||
| }).catch((error:any) => console.error(error)); | ||
| ``` | ||
| ### Parameters | ||
| This endpoint does not need any parameter. | ||
| ### Return type | ||
| **Array<CreateEmailCustomisationResponse>** | ||
| ### Authorization | ||
| [bearerAuth](README.md#bearerAuth) | ||
| ### HTTP request headers | ||
| - **Content-Type**: Not defined | ||
| - **Accept**: application/json | ||
| ### HTTP response details | ||
| | Status code | Description | Response headers | | ||
| |-------------|-------------|------------------| | ||
| **200** | OK | - | | ||
| **400** | Invalid request. | - | | ||
| **403** | Unauthorized access. | - | | ||
| **500** | Unexpected error | - | | ||
| [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) | ||
| # **validateEmailCustomisation** | ||
| > void validateEmailCustomisation() | ||
| Version: 10.10.0.cl or later Validates the email customisation configuration if any set for the ThoughtSpot system. #### Pre-requisites Requires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `_Has developer privilege` privilege is required. Coms should be enabled on the cluster. | ||
| ### Example | ||
| ```typescript | ||
| import { createBearerAuthenticationConfig, EmailCustomisationApi, ValidateEmailCustomisationRequest } from '@thoughtspot/rest-api-sdk'; | ||
| const configuration = createBearerAuthenticationConfig("CLUSTER_SERVER_URL", { | ||
| username: "YOUR_USERNAME", | ||
| password: "YOUR_PASSWORD", | ||
| }); | ||
| const apiInstance = new EmailCustomisationApi(configuration); | ||
| apiInstance.validateEmailCustomisation().then((data:any) => { | ||
| console.log('API called successfully. Returned data: ' + JSON.stringify(data)); | ||
| }).catch((error:any) => console.error(error)); | ||
| ``` | ||
| ### Parameters | ||
| This endpoint does not need any parameter. | ||
| ### Return type | ||
| **void** | ||
| ### Authorization | ||
| [bearerAuth](README.md#bearerAuth) | ||
| ### HTTP request headers | ||
| - **Content-Type**: Not defined | ||
| - **Accept**: application/json | ||
| ### HTTP response details | ||
| | Status code | Description | Response headers | | ||
| |-------------|-------------|------------------| | ||
| **204** | Triggered test email for customization configuration | - | | ||
| **400** | Invalid request. | - | | ||
| **403** | Unauthorized access. | - | | ||
| **500** | Unexpected error | - | | ||
| [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) | ||
| /** | ||
| * ThoughtSpot Public REST API | ||
| * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) | ||
| * | ||
| * OpenAPI spec version: 2.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| */ | ||
| import { HttpFile } from '../http/http'; | ||
| export class CreateEmailCustomisationRequest { | ||
| /** | ||
| * Email customization configuration as key value pair | ||
| */ | ||
| 'template_properties': any; | ||
| static readonly discriminator: string | undefined = undefined; | ||
| static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ | ||
| { | ||
| "name": "template_properties", | ||
| "baseName": "template_properties", | ||
| "type": "any", | ||
| "format": "" | ||
| } ]; | ||
| static getAttributeTypeMap() { | ||
| return CreateEmailCustomisationRequest.attributeTypeMap; | ||
| } | ||
| public constructor() { | ||
| } | ||
| } | ||
| /** | ||
| * ThoughtSpot Public REST API | ||
| * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) | ||
| * | ||
| * OpenAPI spec version: 2.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| */ | ||
| import { OrgType } from '../models/OrgType'; | ||
| import { HttpFile } from '../http/http'; | ||
| export class CreateEmailCustomisationResponse { | ||
| /** | ||
| * Tenant ID | ||
| */ | ||
| 'tenant_id': string; | ||
| 'org': OrgType; | ||
| /** | ||
| * Email customization name. | ||
| */ | ||
| 'name': string; | ||
| /** | ||
| * Customization configuration for the email | ||
| */ | ||
| 'template_properties': any; | ||
| static readonly discriminator: string | undefined = undefined; | ||
| static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ | ||
| { | ||
| "name": "tenant_id", | ||
| "baseName": "tenant_id", | ||
| "type": "string", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "org", | ||
| "baseName": "org", | ||
| "type": "OrgType", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "name", | ||
| "baseName": "name", | ||
| "type": "string", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "template_properties", | ||
| "baseName": "template_properties", | ||
| "type": "any", | ||
| "format": "" | ||
| } ]; | ||
| static getAttributeTypeMap() { | ||
| return CreateEmailCustomisationResponse.attributeTypeMap; | ||
| } | ||
| public constructor() { | ||
| } | ||
| } | ||
| /** | ||
| * ThoughtSpot Public REST API | ||
| * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) | ||
| * | ||
| * OpenAPI spec version: 2.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| */ | ||
| import { HttpFile } from '../http/http'; | ||
| export class DbtConnectionRequest { | ||
| /** | ||
| * Name of the connection. | ||
| */ | ||
| 'connection_name': string; | ||
| /** | ||
| * Name of the Database. | ||
| */ | ||
| 'database_name': string; | ||
| /** | ||
| * Mention type of Import | ||
| */ | ||
| 'import_type'?: DbtConnectionRequestImportTypeEnum; | ||
| /** | ||
| * Access token is mandatory when Import_Type is DBT_CLOUD. | ||
| */ | ||
| 'access_token'?: string; | ||
| /** | ||
| * DBT URL is mandatory when Import_Type is DBT_CLOUD. | ||
| */ | ||
| 'dbt_url'?: string; | ||
| /** | ||
| * Account ID is mandatory when Import_Type is DBT_CLOUD | ||
| */ | ||
| 'account_id'?: string; | ||
| /** | ||
| * Project ID is mandatory when Import_Type is DBT_CLOUD | ||
| */ | ||
| 'project_id'?: string; | ||
| /** | ||
| * DBT Environment ID\" | ||
| */ | ||
| 'dbt_env_id'?: string; | ||
| /** | ||
| * Name of the project | ||
| */ | ||
| 'project_name'?: string; | ||
| /** | ||
| * Upload DBT Manifest and Catalog artifact files as a ZIP file. This field is Mandatory when Import Type is \'ZIP_FILE\' | ||
| */ | ||
| 'file_content'?: HttpFile; | ||
| static readonly discriminator: string | undefined = undefined; | ||
| static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ | ||
| { | ||
| "name": "connection_name", | ||
| "baseName": "connection_name", | ||
| "type": "string", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "database_name", | ||
| "baseName": "database_name", | ||
| "type": "string", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "import_type", | ||
| "baseName": "import_type", | ||
| "type": "DbtConnectionRequestImportTypeEnum", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "access_token", | ||
| "baseName": "access_token", | ||
| "type": "string", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "dbt_url", | ||
| "baseName": "dbt_url", | ||
| "type": "string", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "account_id", | ||
| "baseName": "account_id", | ||
| "type": "string", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "project_id", | ||
| "baseName": "project_id", | ||
| "type": "string", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "dbt_env_id", | ||
| "baseName": "dbt_env_id", | ||
| "type": "string", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "project_name", | ||
| "baseName": "project_name", | ||
| "type": "string", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "file_content", | ||
| "baseName": "file_content", | ||
| "type": "HttpFile", | ||
| "format": "binary" | ||
| } ]; | ||
| static getAttributeTypeMap() { | ||
| return DbtConnectionRequest.attributeTypeMap; | ||
| } | ||
| public constructor() { | ||
| } | ||
| } | ||
| export type DbtConnectionRequestImportTypeEnum = "DBT_CLOUD" | "ZIP_FILE" ; | ||
| /** | ||
| * ThoughtSpot Public REST API | ||
| * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) | ||
| * | ||
| * OpenAPI spec version: 2.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| */ | ||
| import { HttpFile } from '../http/http'; | ||
| export class DbtGenerateSyncTmlRequest { | ||
| /** | ||
| * Unique ID of the DBT connection. | ||
| */ | ||
| 'dbt_connection_identifier': string; | ||
| /** | ||
| * Upload DBT Manifest and Catalog artifact files as a ZIP file. This field is mandatory if the connection was created with import_type ‘ZIP_FILE’ | ||
| */ | ||
| 'file_content'?: HttpFile; | ||
| static readonly discriminator: string | undefined = undefined; | ||
| static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ | ||
| { | ||
| "name": "dbt_connection_identifier", | ||
| "baseName": "dbt_connection_identifier", | ||
| "type": "string", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "file_content", | ||
| "baseName": "file_content", | ||
| "type": "HttpFile", | ||
| "format": "binary" | ||
| } ]; | ||
| static getAttributeTypeMap() { | ||
| return DbtGenerateSyncTmlRequest.attributeTypeMap; | ||
| } | ||
| public constructor() { | ||
| } | ||
| } | ||
| /** | ||
| * ThoughtSpot Public REST API | ||
| * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) | ||
| * | ||
| * OpenAPI spec version: 2.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| */ | ||
| import { ModelTableList } from '../models/ModelTableList'; | ||
| import { HttpFile } from '../http/http'; | ||
| export class DbtGenerateTmlRequest { | ||
| /** | ||
| * Unique ID of the DBT connection. | ||
| */ | ||
| 'dbt_connection_identifier': string; | ||
| /** | ||
| * List of Models and their respective Tables | ||
| */ | ||
| 'model_tables'?: Array<ModelTableList>; | ||
| /** | ||
| * Mention the worksheet tmls to import | ||
| */ | ||
| 'import_worksheets': DbtGenerateTmlRequestImportWorksheetsEnum; | ||
| /** | ||
| * List of worksheets is mandatory when import_Worksheets is type SELECTED | ||
| */ | ||
| 'worksheets'?: Array<string>; | ||
| /** | ||
| * Upload DBT Manifest and Catalog artifact files as a ZIP file. This field is mandatory if the connection was created with import_type ‘ZIP_FILE’ | ||
| */ | ||
| 'file_content'?: HttpFile; | ||
| static readonly discriminator: string | undefined = undefined; | ||
| static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ | ||
| { | ||
| "name": "dbt_connection_identifier", | ||
| "baseName": "dbt_connection_identifier", | ||
| "type": "string", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "model_tables", | ||
| "baseName": "model_tables", | ||
| "type": "Array<ModelTableList>", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "import_worksheets", | ||
| "baseName": "import_worksheets", | ||
| "type": "DbtGenerateTmlRequestImportWorksheetsEnum", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "worksheets", | ||
| "baseName": "worksheets", | ||
| "type": "Array<string>", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "file_content", | ||
| "baseName": "file_content", | ||
| "type": "HttpFile", | ||
| "format": "binary" | ||
| } ]; | ||
| static getAttributeTypeMap() { | ||
| return DbtGenerateTmlRequest.attributeTypeMap; | ||
| } | ||
| public constructor() { | ||
| } | ||
| } | ||
| export type DbtGenerateTmlRequestImportWorksheetsEnum = "ALL" | "NONE" | "SELECTED" ; | ||
| /** | ||
| * ThoughtSpot Public REST API | ||
| * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) | ||
| * | ||
| * OpenAPI spec version: 2.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| */ | ||
| import { HttpFile } from '../http/http'; | ||
| export class InputVariableValue { | ||
| /** | ||
| * The connection property value | ||
| */ | ||
| 'value': string; | ||
| /** | ||
| * The unique name of the org | ||
| */ | ||
| 'org_identifier': string; | ||
| /** | ||
| * Principal type | ||
| */ | ||
| 'principal_type'?: InputVariableValuePrincipalTypeEnum | null; | ||
| /** | ||
| * Unique ID or name of the principal | ||
| */ | ||
| 'principal_identifier'?: string | null; | ||
| /** | ||
| * The priority assigned to this value. If there are 2 matching values, the one with the higher priority will be picked. | ||
| */ | ||
| 'priority'?: number | null; | ||
| static readonly discriminator: string | undefined = undefined; | ||
| static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ | ||
| { | ||
| "name": "value", | ||
| "baseName": "value", | ||
| "type": "string", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "org_identifier", | ||
| "baseName": "org_identifier", | ||
| "type": "string", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "principal_type", | ||
| "baseName": "principal_type", | ||
| "type": "InputVariableValuePrincipalTypeEnum", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "principal_identifier", | ||
| "baseName": "principal_identifier", | ||
| "type": "string", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "priority", | ||
| "baseName": "priority", | ||
| "type": "number", | ||
| "format": "int32" | ||
| } ]; | ||
| static getAttributeTypeMap() { | ||
| return InputVariableValue.attributeTypeMap; | ||
| } | ||
| public constructor() { | ||
| } | ||
| } | ||
| export type InputVariableValuePrincipalTypeEnum = "USER" | "USER_GROUP" ; | ||
| /** | ||
| * ThoughtSpot Public REST API | ||
| * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) | ||
| * | ||
| * OpenAPI spec version: 2.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| */ | ||
| import { HttpFile } from '../http/http'; | ||
| export class UpdateDbtConnectionRequest { | ||
| /** | ||
| * Unique ID of the DBT Connection. | ||
| */ | ||
| 'dbt_connection_identifier': string; | ||
| /** | ||
| * Name of the connection. | ||
| */ | ||
| 'connection_name'?: string; | ||
| /** | ||
| * Name of the Database. | ||
| */ | ||
| 'database_name'?: string; | ||
| /** | ||
| * Mention type of Import | ||
| */ | ||
| 'import_type'?: UpdateDbtConnectionRequestImportTypeEnum; | ||
| /** | ||
| * Access token is mandatory when Import_Type is DBT_CLOUD. | ||
| */ | ||
| 'access_token'?: string; | ||
| /** | ||
| * DBT URL is mandatory when Import_Type is DBT_CLOUD. | ||
| */ | ||
| 'dbt_url'?: string; | ||
| /** | ||
| * Account ID is mandatory when Import_Type is DBT_CLOUD | ||
| */ | ||
| 'account_id'?: string; | ||
| /** | ||
| * Project ID is mandatory when Import_Type is DBT_CLOUD | ||
| */ | ||
| 'project_id'?: string; | ||
| /** | ||
| * DBT Environment ID\" | ||
| */ | ||
| 'dbt_env_id'?: string; | ||
| /** | ||
| * Name of the project | ||
| */ | ||
| 'project_name'?: string; | ||
| /** | ||
| * Upload DBT Manifest and Catalog artifact files as a ZIP file. This field is Mandatory when Import Type is \'ZIP_FILE\' | ||
| */ | ||
| 'file_content'?: HttpFile; | ||
| static readonly discriminator: string | undefined = undefined; | ||
| static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ | ||
| { | ||
| "name": "dbt_connection_identifier", | ||
| "baseName": "dbt_connection_identifier", | ||
| "type": "string", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "connection_name", | ||
| "baseName": "connection_name", | ||
| "type": "string", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "database_name", | ||
| "baseName": "database_name", | ||
| "type": "string", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "import_type", | ||
| "baseName": "import_type", | ||
| "type": "UpdateDbtConnectionRequestImportTypeEnum", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "access_token", | ||
| "baseName": "access_token", | ||
| "type": "string", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "dbt_url", | ||
| "baseName": "dbt_url", | ||
| "type": "string", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "account_id", | ||
| "baseName": "account_id", | ||
| "type": "string", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "project_id", | ||
| "baseName": "project_id", | ||
| "type": "string", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "dbt_env_id", | ||
| "baseName": "dbt_env_id", | ||
| "type": "string", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "project_name", | ||
| "baseName": "project_name", | ||
| "type": "string", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "file_content", | ||
| "baseName": "file_content", | ||
| "type": "HttpFile", | ||
| "format": "binary" | ||
| } ]; | ||
| static getAttributeTypeMap() { | ||
| return UpdateDbtConnectionRequest.attributeTypeMap; | ||
| } | ||
| public constructor() { | ||
| } | ||
| } | ||
| export type UpdateDbtConnectionRequestImportTypeEnum = "DBT_CLOUD" | "ZIP_FILE" ; | ||
| /** | ||
| * ThoughtSpot Public REST API | ||
| * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) | ||
| * | ||
| * OpenAPI spec version: 2.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| */ | ||
| import { InputVariableValue } from '../models/InputVariableValue'; | ||
| import { HttpFile } from '../http/http'; | ||
| /** | ||
| * Input for variable value update | ||
| */ | ||
| export class VariableValueInput { | ||
| /** | ||
| * ID or Name of the variable | ||
| */ | ||
| 'variable_identifier': string; | ||
| /** | ||
| * Values of the variable | ||
| */ | ||
| 'variable_values': Array<InputVariableValue>; | ||
| static readonly discriminator: string | undefined = undefined; | ||
| static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [ | ||
| { | ||
| "name": "variable_identifier", | ||
| "baseName": "variable_identifier", | ||
| "type": "string", | ||
| "format": "" | ||
| }, | ||
| { | ||
| "name": "variable_values", | ||
| "baseName": "variable_values", | ||
| "type": "Array<InputVariableValue>", | ||
| "format": "" | ||
| } ]; | ||
| static getAttributeTypeMap() { | ||
| return VariableValueInput.attributeTypeMap; | ||
| } | ||
| public constructor() { | ||
| } | ||
| } | ||
| import chai from "chai"; | ||
| import chaiAsPromised from "chai-as-promised"; | ||
| import { createBearerAuthenticationConfig } from "../utils/config"; | ||
| import { PromiseEmailCustomisationApi } from "../types/PromiseAPI"; | ||
| import requestBodies from "./testDataUpdated.json"; | ||
| chai.use(chaiAsPromised); | ||
| const expect = chai.expect; | ||
| const baseUrlFromCli = process.argv.filter(s => s.startsWith("--baseUrl="))?.[0]?.split("=")?.[1] | ||
| const BASE_URL = baseUrlFromCli || "http://127.0.0.1:4123" | ||
| const config = createBearerAuthenticationConfig(BASE_URL, { | ||
| username: "tsadmin", | ||
| password: "admin", | ||
| }); | ||
| const instance = new PromiseEmailCustomisationApi(config); | ||
| describe('EmailCustomisationApi', function() { | ||
| describe('createEmailCustomisation', function() { | ||
| const testReqBodies = requestBodies.filter( | ||
| (body: any) => body.Metadata.operationId === "createEmailCustomisation" | ||
| ); | ||
| testReqBodies.forEach(async (test: any) => { | ||
| it(`${test.Metadata.operationId} - ${test.Metadata.scenario} : Testid - ${test.Metadata.testId}`, async function () { | ||
| if (test.Metadata.scenario === "positive") { | ||
| var data; | ||
| try { | ||
| data = await instance.createEmailCustomisation( | ||
| // createEmailCustomisationRequest CreateEmailCustomisationRequest | ||
| test.Body | ||
| ) | ||
| } catch (er) { | ||
| console.error(er, "Response", data) | ||
| expect(er).to.be.undefined | ||
| } | ||
| } else { | ||
| await expect( | ||
| instance.createEmailCustomisation( | ||
| // createEmailCustomisationRequest CreateEmailCustomisationRequest | ||
| test.Body | ||
| ) | ||
| ).to.be.rejectedWith(Error); | ||
| } | ||
| }); | ||
| }); | ||
| }); | ||
| describe('deleteEmailCustomisation', function() { | ||
| const testReqBodies = requestBodies.filter( | ||
| (body: any) => body.Metadata.operationId === "deleteEmailCustomisation" | ||
| ); | ||
| testReqBodies.forEach(async (test: any) => { | ||
| it(`${test.Metadata.operationId} - ${test.Metadata.scenario} : Testid - ${test.Metadata.testId}`, async function () { | ||
| if (test.Metadata.scenario === "positive") { | ||
| var data; | ||
| try { | ||
| data = await instance.deleteEmailCustomisation( | ||
| // templateIdentifier template_identifier | ||
| test.Path_Variables.template_identifier | ||
| ) | ||
| } catch (er) { | ||
| console.error(er, "Response", data) | ||
| expect(er).to.be.undefined | ||
| } | ||
| } else { | ||
| await expect( | ||
| instance.deleteEmailCustomisation( | ||
| // templateIdentifier template_identifier | ||
| test.Path_Variables.template_identifier | ||
| ) | ||
| ).to.be.rejectedWith(Error); | ||
| } | ||
| }); | ||
| }); | ||
| }); | ||
| describe('searchEmailCustomisation', function() { | ||
| const testReqBodies = requestBodies.filter( | ||
| (body: any) => body.Metadata.operationId === "searchEmailCustomisation" | ||
| ); | ||
| testReqBodies.forEach(async (test: any) => { | ||
| it(`${test.Metadata.operationId} - ${test.Metadata.scenario} : Testid - ${test.Metadata.testId}`, async function () { | ||
| if (test.Metadata.scenario === "positive") { | ||
| var data; | ||
| try { | ||
| data = await instance.searchEmailCustomisation( | ||
| ) | ||
| } catch (er) { | ||
| console.error(er, "Response", data) | ||
| expect(er).to.be.undefined | ||
| } | ||
| } else { | ||
| await expect( | ||
| instance.searchEmailCustomisation( | ||
| ) | ||
| ).to.be.rejectedWith(Error); | ||
| } | ||
| }); | ||
| }); | ||
| }); | ||
| describe('validateEmailCustomisation', function() { | ||
| const testReqBodies = requestBodies.filter( | ||
| (body: any) => body.Metadata.operationId === "validateEmailCustomisation" | ||
| ); | ||
| testReqBodies.forEach(async (test: any) => { | ||
| it(`${test.Metadata.operationId} - ${test.Metadata.scenario} : Testid - ${test.Metadata.testId}`, async function () { | ||
| if (test.Metadata.scenario === "positive") { | ||
| var data; | ||
| try { | ||
| data = await instance.validateEmailCustomisation( | ||
| ) | ||
| } catch (er) { | ||
| console.error(er, "Response", data) | ||
| expect(er).to.be.undefined | ||
| } | ||
| } else { | ||
| await expect( | ||
| instance.validateEmailCustomisation( | ||
| ) | ||
| ).to.be.rejectedWith(Error); | ||
| } | ||
| }); | ||
| }); | ||
| }); | ||
| }); |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Network access
Supply chain riskThis module accesses the network.
Found 1 instance in 1 package
AI-detected potential code anomaly
Supply chain riskAI has identified unusual behaviors that may pose a security risk.
Found 1 instance in 1 package
Long strings
Supply chain riskContains long string literals, which may be a sign of obfuscated or packed code.
Found 1 instance in 1 package
URL strings
Supply chain riskPackage contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.
Found 1 instance in 1 package
Network access
Supply chain riskThis module accesses the network.
Found 1 instance in 1 package
AI-detected potential code anomaly
Supply chain riskAI has identified unusual behaviors that may pose a security risk.
Found 1 instance in 1 package
Long strings
Supply chain riskContains long string literals, which may be a sign of obfuscated or packed code.
Found 1 instance in 1 package
No repository
Supply chain riskPackage does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.
Found 1 instance in 1 package
URL strings
Supply chain riskPackage contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.
Found 1 instance in 1 package
15963739
3.43%509
2.62%283117
2.74%492
0.82%