/* tslint:disable */ /* eslint-disable */ /** * Identity Security Cloud API - Service Desk Integration * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. * * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import globalAxios from 'axios'; // Some imports not used depending on template conditions // @ts-ignore import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common'; import type { RequestArgs } from './base'; // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base'; /** * * @export * @interface ArrayInner */ export interface ArrayInner { } /** * * @export * @interface BaseCommonDto */ export interface BaseCommonDto { /** * System-generated unique ID of the Object * @type {string} * @memberof BaseCommonDto */ 'id'?: string; /** * Name of the Object * @type {string} * @memberof BaseCommonDto */ 'name': string | null; /** * Creation date of the Object * @type {string} * @memberof BaseCommonDto */ 'created'?: string; /** * Last modification date of the Object * @type {string} * @memberof BaseCommonDto */ 'modified'?: string; } /** * Before Provisioning Rule. * @export * @interface BeforeProvisioningRuleDto */ export interface BeforeProvisioningRuleDto { /** * Before Provisioning Rule DTO type. * @type {string} * @memberof BeforeProvisioningRuleDto */ 'type'?: BeforeProvisioningRuleDtoTypeEnum; /** * Before Provisioning Rule ID. * @type {string} * @memberof BeforeProvisioningRuleDto */ 'id'?: string; /** * Rule display name. * @type {string} * @memberof BeforeProvisioningRuleDto */ 'name'?: string; } export const BeforeProvisioningRuleDtoTypeEnum = { Rule: 'RULE' } as const; export type BeforeProvisioningRuleDtoTypeEnum = typeof BeforeProvisioningRuleDtoTypeEnum[keyof typeof BeforeProvisioningRuleDtoTypeEnum]; /** * * @export * @interface ErrorMessageDto */ export interface ErrorMessageDto { /** * The locale for the message text, a BCP 47 language tag. * @type {string} * @memberof ErrorMessageDto */ 'locale'?: string | null; /** * * @type {LocaleOrigin} * @memberof ErrorMessageDto */ 'localeOrigin'?: LocaleOrigin | null; /** * Actual text of the error message in the indicated locale. * @type {string} * @memberof ErrorMessageDto */ 'text'?: string; } /** * * @export * @interface ErrorResponseDto */ export interface ErrorResponseDto { /** * Fine-grained error code providing more detail of the error. * @type {string} * @memberof ErrorResponseDto */ 'detailCode'?: string; /** * Unique tracking id for the error. * @type {string} * @memberof ErrorResponseDto */ 'trackingId'?: string; /** * Generic localized reason for error * @type {Array} * @memberof ErrorResponseDto */ 'messages'?: Array; /** * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field * @type {Array} * @memberof ErrorResponseDto */ 'causes'?: Array; } /** * * @export * @interface GetServiceDeskIntegrationsV1401Response */ export interface GetServiceDeskIntegrationsV1401Response { /** * A message describing the error * @type {any} * @memberof GetServiceDeskIntegrationsV1401Response */ 'error'?: any; } /** * * @export * @interface GetServiceDeskIntegrationsV1429Response */ export interface GetServiceDeskIntegrationsV1429Response { /** * A message describing the error * @type {any} * @memberof GetServiceDeskIntegrationsV1429Response */ 'message'?: any; } /** * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) * @export * @interface JsonPatchOperation */ export interface JsonPatchOperation { /** * The operation to be performed * @type {string} * @memberof JsonPatchOperation */ 'op': JsonPatchOperationOpEnum; /** * A string JSON Pointer representing the target path to an element to be affected by the operation * @type {string} * @memberof JsonPatchOperation */ 'path': string; /** * * @type {JsonPatchOperationValue} * @memberof JsonPatchOperation */ 'value'?: JsonPatchOperationValue; } export const JsonPatchOperationOpEnum = { Add: 'add', Remove: 'remove', Replace: 'replace', Move: 'move', Copy: 'copy', Test: 'test' } as const; export type JsonPatchOperationOpEnum = typeof JsonPatchOperationOpEnum[keyof typeof JsonPatchOperationOpEnum]; /** * @type JsonPatchOperationValue * The value to be used for the operation, required for \"add\" and \"replace\" operations * @export */ export type JsonPatchOperationValue = Array | boolean | number | object | string; /** * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. * @export * @enum {string} */ export const LocaleOrigin = { Default: 'DEFAULT', Request: 'REQUEST' } as const; export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin]; /** * Owner\'s identity. * @export * @interface OwnerDto */ export interface OwnerDto { /** * Owner\'s DTO type. * @type {string} * @memberof OwnerDto */ 'type'?: OwnerDtoTypeEnum; /** * Owner\'s identity ID. * @type {string} * @memberof OwnerDto */ 'id'?: string; /** * Owner\'s name. * @type {string} * @memberof OwnerDto */ 'name'?: string; } export const OwnerDtoTypeEnum = { Identity: 'IDENTITY' } as const; export type OwnerDtoTypeEnum = typeof OwnerDtoTypeEnum[keyof typeof OwnerDtoTypeEnum]; /** * Specification of a Service Desk integration provisioning configuration. * @export * @interface ProvisioningConfig */ export interface ProvisioningConfig { /** * Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed. * @type {boolean} * @memberof ProvisioningConfig */ 'universalManager'?: boolean; /** * References to sources for the Service Desk integration template. May only be specified if universalManager is false. * @type {Array} * @memberof ProvisioningConfig */ 'managedResourceRefs'?: Array; /** * * @type {ProvisioningConfigPlanInitializerScript} * @memberof ProvisioningConfig */ 'planInitializerScript'?: ProvisioningConfigPlanInitializerScript | null; /** * Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. * @type {boolean} * @memberof ProvisioningConfig */ 'noProvisioningRequests'?: boolean; /** * When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation. * @type {number} * @memberof ProvisioningConfig */ 'provisioningRequestExpiration'?: number; } /** * This is a reference to a plan initializer script. * @export * @interface ProvisioningConfigPlanInitializerScript */ export interface ProvisioningConfigPlanInitializerScript { /** * This is a Rule that allows provisioning instruction changes. * @type {string} * @memberof ProvisioningConfigPlanInitializerScript */ 'source'?: string; } /** * Configuration of maximum number of days and interval for checking Service Desk integration queue status. * @export * @interface QueuedCheckConfigDetails */ export interface QueuedCheckConfigDetails { /** * Interval in minutes between status checks * @type {string} * @memberof QueuedCheckConfigDetails */ 'provisioningStatusCheckIntervalMinutes': string; /** * Maximum number of days to check * @type {string} * @memberof QueuedCheckConfigDetails */ 'provisioningMaxStatusCheckDays': string; } /** * * @export * @interface ServiceDeskIntegrationDto */ export interface ServiceDeskIntegrationDto { /** * Unique identifier for the Service Desk integration * @type {string} * @memberof ServiceDeskIntegrationDto */ 'id'?: string; /** * Service Desk integration\'s name. The name must be unique. * @type {string} * @memberof ServiceDeskIntegrationDto */ 'name': string; /** * The date and time the Service Desk integration was created * @type {string} * @memberof ServiceDeskIntegrationDto */ 'created'?: string; /** * The date and time the Service Desk integration was last modified * @type {string} * @memberof ServiceDeskIntegrationDto */ 'modified'?: string; /** * Service Desk integration\'s description. * @type {string} * @memberof ServiceDeskIntegrationDto */ 'description': string; /** * Service Desk integration types: - ServiceNowSDIM - ServiceNow * @type {string} * @memberof ServiceDeskIntegrationDto */ 'type': string; /** * * @type {OwnerDto} * @memberof ServiceDeskIntegrationDto */ 'ownerRef'?: OwnerDto; /** * * @type {SourceClusterDto} * @memberof ServiceDeskIntegrationDto */ 'clusterRef'?: SourceClusterDto; /** * Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility). * @type {string} * @memberof ServiceDeskIntegrationDto * @deprecated */ 'cluster'?: string | null; /** * Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility). * @type {Array} * @memberof ServiceDeskIntegrationDto * @deprecated */ 'managedSources'?: Array; /** * * @type {ProvisioningConfig} * @memberof ServiceDeskIntegrationDto */ 'provisioningConfig'?: ProvisioningConfig; /** * Service Desk integration\'s attributes. Validation constraints enforced by the implementation. * @type {{ [key: string]: any; }} * @memberof ServiceDeskIntegrationDto */ 'attributes': { [key: string]: any; }; /** * * @type {BeforeProvisioningRuleDto} * @memberof ServiceDeskIntegrationDto */ 'beforeProvisioningRule'?: BeforeProvisioningRuleDto; } /** * * @export * @interface ServiceDeskIntegrationTemplateDto */ export interface ServiceDeskIntegrationTemplateDto { /** * System-generated unique ID of the Object * @type {string} * @memberof ServiceDeskIntegrationTemplateDto */ 'id'?: string; /** * Name of the Object * @type {string} * @memberof ServiceDeskIntegrationTemplateDto */ 'name': string | null; /** * Creation date of the Object * @type {string} * @memberof ServiceDeskIntegrationTemplateDto */ 'created'?: string; /** * Last modification date of the Object * @type {string} * @memberof ServiceDeskIntegrationTemplateDto */ 'modified'?: string; /** * The \'type\' property specifies the type of the Service Desk integration template. * @type {string} * @memberof ServiceDeskIntegrationTemplateDto */ 'type': string; /** * The \'attributes\' property value is a map of attributes available for integrations using this Service Desk integration template. * @type {{ [key: string]: any; }} * @memberof ServiceDeskIntegrationTemplateDto */ 'attributes': { [key: string]: any; }; /** * * @type {ProvisioningConfig} * @memberof ServiceDeskIntegrationTemplateDto */ 'provisioningConfig': ProvisioningConfig; } /** * This represents a Service Desk Integration template type. * @export * @interface ServiceDeskIntegrationTemplateType */ export interface ServiceDeskIntegrationTemplateType { /** * This is the name of the type. * @type {string} * @memberof ServiceDeskIntegrationTemplateType */ 'name'?: string; /** * This is the type value for the type. * @type {string} * @memberof ServiceDeskIntegrationTemplateType */ 'type': string; /** * This is the scriptName attribute value for the type. * @type {string} * @memberof ServiceDeskIntegrationTemplateType */ 'scriptName': string; } /** * Source for Service Desk integration template. * @export * @interface ServiceDeskSource */ export interface ServiceDeskSource { /** * DTO type of source for service desk integration template. * @type {string} * @memberof ServiceDeskSource */ 'type'?: ServiceDeskSourceTypeEnum; /** * ID of source for service desk integration template. * @type {string} * @memberof ServiceDeskSource */ 'id'?: string; /** * Human-readable name of source for service desk integration template. * @type {string} * @memberof ServiceDeskSource */ 'name'?: string; } export const ServiceDeskSourceTypeEnum = { Source: 'SOURCE' } as const; export type ServiceDeskSourceTypeEnum = typeof ServiceDeskSourceTypeEnum[keyof typeof ServiceDeskSourceTypeEnum]; /** * Source cluster. * @export * @interface SourceClusterDto */ export interface SourceClusterDto { /** * Source cluster DTO type. * @type {string} * @memberof SourceClusterDto */ 'type'?: SourceClusterDtoTypeEnum; /** * Source cluster ID. * @type {string} * @memberof SourceClusterDto */ 'id'?: string; /** * Source cluster display name. * @type {string} * @memberof SourceClusterDto */ 'name'?: string; } export const SourceClusterDtoTypeEnum = { Cluster: 'CLUSTER' } as const; export type SourceClusterDtoTypeEnum = typeof SourceClusterDtoTypeEnum[keyof typeof SourceClusterDtoTypeEnum]; /** * ServiceDeskIntegrationApi - axios parameter creator * @export */ export const ServiceDeskIntegrationApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * Create a new Service Desk integration. * @summary Create new service desk integration * @param {ServiceDeskIntegrationDto} serviceDeskIntegrationDto The specifics of a new integration to create * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createServiceDeskIntegrationV1: async (serviceDeskIntegrationDto: ServiceDeskIntegrationDto, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'serviceDeskIntegrationDto' is not null or undefined assertParamExists('createServiceDeskIntegrationV1', 'serviceDeskIntegrationDto', serviceDeskIntegrationDto) const localVarPath = `/service-desk-integrations/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(serviceDeskIntegrationDto, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Delete an existing Service Desk integration by ID. * @summary Delete a service desk integration * @param {string} id ID of Service Desk integration to delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteServiceDeskIntegrationV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('deleteServiceDeskIntegrationV1', 'id', id) const localVarPath = `/service-desk-integrations/v1/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API endpoint returns an existing Service Desk integration template by scriptName. * @summary Service desk integration template by scriptname * @param {string} scriptName The scriptName value of the Service Desk integration template to get * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getServiceDeskIntegrationTemplateV1: async (scriptName: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'scriptName' is not null or undefined assertParamExists('getServiceDeskIntegrationTemplateV1', 'scriptName', scriptName) const localVarPath = `/service-desk-integrations/v1/templates/{scriptName}` .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API endpoint returns the current list of supported Service Desk integration types. * @summary List service desk integration types * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getServiceDeskIntegrationTypesV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/service-desk-integrations/v1/types`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Get an existing Service Desk integration by ID. * @summary Get a service desk integration * @param {string} id ID of the Service Desk integration to get * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getServiceDeskIntegrationV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getServiceDeskIntegrationV1', 'id', id) const localVarPath = `/service-desk-integrations/v1/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Get a list of Service Desk integration objects. * @summary List existing service desk integrations * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getServiceDeskIntegrationsV1: async (offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/service-desk-integrations/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (sorters !== undefined) { localVarQueryParameter['sorters'] = sorters; } if (filters !== undefined) { localVarQueryParameter['filters'] = filters; } if (count !== undefined) { localVarQueryParameter['count'] = count; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Get the time check configuration of queued SDIM tickets. * @summary Get the time check configuration * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getStatusCheckDetailsV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/service-desk-integrations/v1/status-check-configuration`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Update an existing Service Desk integration by ID with a PATCH request. * @summary Patch a service desk integration * @param {string} id ID of the Service Desk integration to update * @param {Array} jsonPatchOperation A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchServiceDeskIntegrationV1: async (id: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('patchServiceDeskIntegrationV1', 'id', id) // verify required parameter 'jsonPatchOperation' is not null or undefined assertParamExists('patchServiceDeskIntegrationV1', 'jsonPatchOperation', jsonPatchOperation) const localVarPath = `/service-desk-integrations/v1/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperation, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Update an existing Service Desk integration by ID. * @summary Update a service desk integration * @param {string} id ID of the Service Desk integration to update * @param {ServiceDeskIntegrationDto} serviceDeskIntegrationDto The specifics of the integration to update * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putServiceDeskIntegrationV1: async (id: string, serviceDeskIntegrationDto: ServiceDeskIntegrationDto, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('putServiceDeskIntegrationV1', 'id', id) // verify required parameter 'serviceDeskIntegrationDto' is not null or undefined assertParamExists('putServiceDeskIntegrationV1', 'serviceDeskIntegrationDto', serviceDeskIntegrationDto) const localVarPath = `/service-desk-integrations/v1/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(serviceDeskIntegrationDto, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Update the time check configuration of queued SDIM tickets. * @summary Update the time check configuration * @param {QueuedCheckConfigDetails} queuedCheckConfigDetails The modified time check configuration * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateStatusCheckDetailsV1: async (queuedCheckConfigDetails: QueuedCheckConfigDetails, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'queuedCheckConfigDetails' is not null or undefined assertParamExists('updateStatusCheckDetailsV1', 'queuedCheckConfigDetails', queuedCheckConfigDetails) const localVarPath = `/service-desk-integrations/v1/status-check-configuration`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(queuedCheckConfigDetails, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, } }; /** * ServiceDeskIntegrationApi - functional programming interface * @export */ export const ServiceDeskIntegrationApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = ServiceDeskIntegrationApiAxiosParamCreator(configuration) return { /** * Create a new Service Desk integration. * @summary Create new service desk integration * @param {ServiceDeskIntegrationDto} serviceDeskIntegrationDto The specifics of a new integration to create * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async createServiceDeskIntegrationV1(serviceDeskIntegrationDto: ServiceDeskIntegrationDto, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createServiceDeskIntegrationV1(serviceDeskIntegrationDto, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationApi.createServiceDeskIntegrationV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Delete an existing Service Desk integration by ID. * @summary Delete a service desk integration * @param {string} id ID of Service Desk integration to delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async deleteServiceDeskIntegrationV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteServiceDeskIntegrationV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationApi.deleteServiceDeskIntegrationV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API endpoint returns an existing Service Desk integration template by scriptName. * @summary Service desk integration template by scriptname * @param {string} scriptName The scriptName value of the Service Desk integration template to get * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getServiceDeskIntegrationTemplateV1(scriptName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getServiceDeskIntegrationTemplateV1(scriptName, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationApi.getServiceDeskIntegrationTemplateV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API endpoint returns the current list of supported Service Desk integration types. * @summary List service desk integration types * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getServiceDeskIntegrationTypesV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getServiceDeskIntegrationTypesV1(axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationApi.getServiceDeskIntegrationTypesV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Get an existing Service Desk integration by ID. * @summary Get a service desk integration * @param {string} id ID of the Service Desk integration to get * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getServiceDeskIntegrationV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getServiceDeskIntegrationV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationApi.getServiceDeskIntegrationV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Get a list of Service Desk integration objects. * @summary List existing service desk integrations * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getServiceDeskIntegrationsV1(offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getServiceDeskIntegrationsV1(offset, limit, sorters, filters, count, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationApi.getServiceDeskIntegrationsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Get the time check configuration of queued SDIM tickets. * @summary Get the time check configuration * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getStatusCheckDetailsV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getStatusCheckDetailsV1(axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationApi.getStatusCheckDetailsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Update an existing Service Desk integration by ID with a PATCH request. * @summary Patch a service desk integration * @param {string} id ID of the Service Desk integration to update * @param {Array} jsonPatchOperation A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async patchServiceDeskIntegrationV1(id: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.patchServiceDeskIntegrationV1(id, jsonPatchOperation, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationApi.patchServiceDeskIntegrationV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Update an existing Service Desk integration by ID. * @summary Update a service desk integration * @param {string} id ID of the Service Desk integration to update * @param {ServiceDeskIntegrationDto} serviceDeskIntegrationDto The specifics of the integration to update * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async putServiceDeskIntegrationV1(id: string, serviceDeskIntegrationDto: ServiceDeskIntegrationDto, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.putServiceDeskIntegrationV1(id, serviceDeskIntegrationDto, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationApi.putServiceDeskIntegrationV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Update the time check configuration of queued SDIM tickets. * @summary Update the time check configuration * @param {QueuedCheckConfigDetails} queuedCheckConfigDetails The modified time check configuration * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async updateStatusCheckDetailsV1(queuedCheckConfigDetails: QueuedCheckConfigDetails, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.updateStatusCheckDetailsV1(queuedCheckConfigDetails, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationApi.updateStatusCheckDetailsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, } }; /** * ServiceDeskIntegrationApi - factory interface * @export */ export const ServiceDeskIntegrationApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = ServiceDeskIntegrationApiFp(configuration) return { /** * Create a new Service Desk integration. * @summary Create new service desk integration * @param {ServiceDeskIntegrationApiCreateServiceDeskIntegrationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createServiceDeskIntegrationV1(requestParameters: ServiceDeskIntegrationApiCreateServiceDeskIntegrationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.createServiceDeskIntegrationV1(requestParameters.serviceDeskIntegrationDto, axiosOptions).then((request) => request(axios, basePath)); }, /** * Delete an existing Service Desk integration by ID. * @summary Delete a service desk integration * @param {ServiceDeskIntegrationApiDeleteServiceDeskIntegrationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteServiceDeskIntegrationV1(requestParameters: ServiceDeskIntegrationApiDeleteServiceDeskIntegrationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.deleteServiceDeskIntegrationV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API endpoint returns an existing Service Desk integration template by scriptName. * @summary Service desk integration template by scriptname * @param {ServiceDeskIntegrationApiGetServiceDeskIntegrationTemplateV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getServiceDeskIntegrationTemplateV1(requestParameters: ServiceDeskIntegrationApiGetServiceDeskIntegrationTemplateV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getServiceDeskIntegrationTemplateV1(requestParameters.scriptName, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API endpoint returns the current list of supported Service Desk integration types. * @summary List service desk integration types * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getServiceDeskIntegrationTypesV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.getServiceDeskIntegrationTypesV1(axiosOptions).then((request) => request(axios, basePath)); }, /** * Get an existing Service Desk integration by ID. * @summary Get a service desk integration * @param {ServiceDeskIntegrationApiGetServiceDeskIntegrationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getServiceDeskIntegrationV1(requestParameters: ServiceDeskIntegrationApiGetServiceDeskIntegrationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getServiceDeskIntegrationV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * Get a list of Service Desk integration objects. * @summary List existing service desk integrations * @param {ServiceDeskIntegrationApiGetServiceDeskIntegrationsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getServiceDeskIntegrationsV1(requestParameters: ServiceDeskIntegrationApiGetServiceDeskIntegrationsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.getServiceDeskIntegrationsV1(requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); }, /** * Get the time check configuration of queued SDIM tickets. * @summary Get the time check configuration * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getStatusCheckDetailsV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getStatusCheckDetailsV1(axiosOptions).then((request) => request(axios, basePath)); }, /** * Update an existing Service Desk integration by ID with a PATCH request. * @summary Patch a service desk integration * @param {ServiceDeskIntegrationApiPatchServiceDeskIntegrationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchServiceDeskIntegrationV1(requestParameters: ServiceDeskIntegrationApiPatchServiceDeskIntegrationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.patchServiceDeskIntegrationV1(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); }, /** * Update an existing Service Desk integration by ID. * @summary Update a service desk integration * @param {ServiceDeskIntegrationApiPutServiceDeskIntegrationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putServiceDeskIntegrationV1(requestParameters: ServiceDeskIntegrationApiPutServiceDeskIntegrationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.putServiceDeskIntegrationV1(requestParameters.id, requestParameters.serviceDeskIntegrationDto, axiosOptions).then((request) => request(axios, basePath)); }, /** * Update the time check configuration of queued SDIM tickets. * @summary Update the time check configuration * @param {ServiceDeskIntegrationApiUpdateStatusCheckDetailsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateStatusCheckDetailsV1(requestParameters: ServiceDeskIntegrationApiUpdateStatusCheckDetailsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.updateStatusCheckDetailsV1(requestParameters.queuedCheckConfigDetails, axiosOptions).then((request) => request(axios, basePath)); }, }; }; /** * Request parameters for createServiceDeskIntegrationV1 operation in ServiceDeskIntegrationApi. * @export * @interface ServiceDeskIntegrationApiCreateServiceDeskIntegrationV1Request */ export interface ServiceDeskIntegrationApiCreateServiceDeskIntegrationV1Request { /** * The specifics of a new integration to create * @type {ServiceDeskIntegrationDto} * @memberof ServiceDeskIntegrationApiCreateServiceDeskIntegrationV1 */ readonly serviceDeskIntegrationDto: ServiceDeskIntegrationDto } /** * Request parameters for deleteServiceDeskIntegrationV1 operation in ServiceDeskIntegrationApi. * @export * @interface ServiceDeskIntegrationApiDeleteServiceDeskIntegrationV1Request */ export interface ServiceDeskIntegrationApiDeleteServiceDeskIntegrationV1Request { /** * ID of Service Desk integration to delete * @type {string} * @memberof ServiceDeskIntegrationApiDeleteServiceDeskIntegrationV1 */ readonly id: string } /** * Request parameters for getServiceDeskIntegrationTemplateV1 operation in ServiceDeskIntegrationApi. * @export * @interface ServiceDeskIntegrationApiGetServiceDeskIntegrationTemplateV1Request */ export interface ServiceDeskIntegrationApiGetServiceDeskIntegrationTemplateV1Request { /** * The scriptName value of the Service Desk integration template to get * @type {string} * @memberof ServiceDeskIntegrationApiGetServiceDeskIntegrationTemplateV1 */ readonly scriptName: string } /** * Request parameters for getServiceDeskIntegrationV1 operation in ServiceDeskIntegrationApi. * @export * @interface ServiceDeskIntegrationApiGetServiceDeskIntegrationV1Request */ export interface ServiceDeskIntegrationApiGetServiceDeskIntegrationV1Request { /** * ID of the Service Desk integration to get * @type {string} * @memberof ServiceDeskIntegrationApiGetServiceDeskIntegrationV1 */ readonly id: string } /** * Request parameters for getServiceDeskIntegrationsV1 operation in ServiceDeskIntegrationApi. * @export * @interface ServiceDeskIntegrationApiGetServiceDeskIntegrationsV1Request */ export interface ServiceDeskIntegrationApiGetServiceDeskIntegrationsV1Request { /** * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof ServiceDeskIntegrationApiGetServiceDeskIntegrationsV1 */ readonly offset?: number /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof ServiceDeskIntegrationApiGetServiceDeskIntegrationsV1 */ readonly limit?: number /** * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** * @type {string} * @memberof ServiceDeskIntegrationApiGetServiceDeskIntegrationsV1 */ readonly sorters?: string /** * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* * @type {string} * @memberof ServiceDeskIntegrationApiGetServiceDeskIntegrationsV1 */ readonly filters?: string /** * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {boolean} * @memberof ServiceDeskIntegrationApiGetServiceDeskIntegrationsV1 */ readonly count?: boolean } /** * Request parameters for patchServiceDeskIntegrationV1 operation in ServiceDeskIntegrationApi. * @export * @interface ServiceDeskIntegrationApiPatchServiceDeskIntegrationV1Request */ export interface ServiceDeskIntegrationApiPatchServiceDeskIntegrationV1Request { /** * ID of the Service Desk integration to update * @type {string} * @memberof ServiceDeskIntegrationApiPatchServiceDeskIntegrationV1 */ readonly id: string /** * A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. * @type {Array} * @memberof ServiceDeskIntegrationApiPatchServiceDeskIntegrationV1 */ readonly jsonPatchOperation: Array } /** * Request parameters for putServiceDeskIntegrationV1 operation in ServiceDeskIntegrationApi. * @export * @interface ServiceDeskIntegrationApiPutServiceDeskIntegrationV1Request */ export interface ServiceDeskIntegrationApiPutServiceDeskIntegrationV1Request { /** * ID of the Service Desk integration to update * @type {string} * @memberof ServiceDeskIntegrationApiPutServiceDeskIntegrationV1 */ readonly id: string /** * The specifics of the integration to update * @type {ServiceDeskIntegrationDto} * @memberof ServiceDeskIntegrationApiPutServiceDeskIntegrationV1 */ readonly serviceDeskIntegrationDto: ServiceDeskIntegrationDto } /** * Request parameters for updateStatusCheckDetailsV1 operation in ServiceDeskIntegrationApi. * @export * @interface ServiceDeskIntegrationApiUpdateStatusCheckDetailsV1Request */ export interface ServiceDeskIntegrationApiUpdateStatusCheckDetailsV1Request { /** * The modified time check configuration * @type {QueuedCheckConfigDetails} * @memberof ServiceDeskIntegrationApiUpdateStatusCheckDetailsV1 */ readonly queuedCheckConfigDetails: QueuedCheckConfigDetails } /** * ServiceDeskIntegrationApi - object-oriented interface * @export * @class ServiceDeskIntegrationApi * @extends {BaseAPI} */ export class ServiceDeskIntegrationApi extends BaseAPI { /** * Create a new Service Desk integration. * @summary Create new service desk integration * @param {ServiceDeskIntegrationApiCreateServiceDeskIntegrationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ServiceDeskIntegrationApi */ public createServiceDeskIntegrationV1(requestParameters: ServiceDeskIntegrationApiCreateServiceDeskIntegrationV1Request, axiosOptions?: RawAxiosRequestConfig) { return ServiceDeskIntegrationApiFp(this.configuration).createServiceDeskIntegrationV1(requestParameters.serviceDeskIntegrationDto, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Delete an existing Service Desk integration by ID. * @summary Delete a service desk integration * @param {ServiceDeskIntegrationApiDeleteServiceDeskIntegrationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ServiceDeskIntegrationApi */ public deleteServiceDeskIntegrationV1(requestParameters: ServiceDeskIntegrationApiDeleteServiceDeskIntegrationV1Request, axiosOptions?: RawAxiosRequestConfig) { return ServiceDeskIntegrationApiFp(this.configuration).deleteServiceDeskIntegrationV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API endpoint returns an existing Service Desk integration template by scriptName. * @summary Service desk integration template by scriptname * @param {ServiceDeskIntegrationApiGetServiceDeskIntegrationTemplateV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ServiceDeskIntegrationApi */ public getServiceDeskIntegrationTemplateV1(requestParameters: ServiceDeskIntegrationApiGetServiceDeskIntegrationTemplateV1Request, axiosOptions?: RawAxiosRequestConfig) { return ServiceDeskIntegrationApiFp(this.configuration).getServiceDeskIntegrationTemplateV1(requestParameters.scriptName, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API endpoint returns the current list of supported Service Desk integration types. * @summary List service desk integration types * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ServiceDeskIntegrationApi */ public getServiceDeskIntegrationTypesV1(axiosOptions?: RawAxiosRequestConfig) { return ServiceDeskIntegrationApiFp(this.configuration).getServiceDeskIntegrationTypesV1(axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Get an existing Service Desk integration by ID. * @summary Get a service desk integration * @param {ServiceDeskIntegrationApiGetServiceDeskIntegrationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ServiceDeskIntegrationApi */ public getServiceDeskIntegrationV1(requestParameters: ServiceDeskIntegrationApiGetServiceDeskIntegrationV1Request, axiosOptions?: RawAxiosRequestConfig) { return ServiceDeskIntegrationApiFp(this.configuration).getServiceDeskIntegrationV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Get a list of Service Desk integration objects. * @summary List existing service desk integrations * @param {ServiceDeskIntegrationApiGetServiceDeskIntegrationsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ServiceDeskIntegrationApi */ public getServiceDeskIntegrationsV1(requestParameters: ServiceDeskIntegrationApiGetServiceDeskIntegrationsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return ServiceDeskIntegrationApiFp(this.configuration).getServiceDeskIntegrationsV1(requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Get the time check configuration of queued SDIM tickets. * @summary Get the time check configuration * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ServiceDeskIntegrationApi */ public getStatusCheckDetailsV1(axiosOptions?: RawAxiosRequestConfig) { return ServiceDeskIntegrationApiFp(this.configuration).getStatusCheckDetailsV1(axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Update an existing Service Desk integration by ID with a PATCH request. * @summary Patch a service desk integration * @param {ServiceDeskIntegrationApiPatchServiceDeskIntegrationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ServiceDeskIntegrationApi */ public patchServiceDeskIntegrationV1(requestParameters: ServiceDeskIntegrationApiPatchServiceDeskIntegrationV1Request, axiosOptions?: RawAxiosRequestConfig) { return ServiceDeskIntegrationApiFp(this.configuration).patchServiceDeskIntegrationV1(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Update an existing Service Desk integration by ID. * @summary Update a service desk integration * @param {ServiceDeskIntegrationApiPutServiceDeskIntegrationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ServiceDeskIntegrationApi */ public putServiceDeskIntegrationV1(requestParameters: ServiceDeskIntegrationApiPutServiceDeskIntegrationV1Request, axiosOptions?: RawAxiosRequestConfig) { return ServiceDeskIntegrationApiFp(this.configuration).putServiceDeskIntegrationV1(requestParameters.id, requestParameters.serviceDeskIntegrationDto, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Update the time check configuration of queued SDIM tickets. * @summary Update the time check configuration * @param {ServiceDeskIntegrationApiUpdateStatusCheckDetailsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ServiceDeskIntegrationApi */ public updateStatusCheckDetailsV1(requestParameters: ServiceDeskIntegrationApiUpdateStatusCheckDetailsV1Request, axiosOptions?: RawAxiosRequestConfig) { return ServiceDeskIntegrationApiFp(this.configuration).updateStatusCheckDetailsV1(requestParameters.queuedCheckConfigDetails, axiosOptions).then((request) => request(this.axios, this.basePath)); } }