@sailpoint/api-client 2.2.38 → 2.2.40

package/dist/sources/api.d.ts

@@ -3212,6 +3212,31 @@ export declare const SourceSchemasInnerTypeEnum: {
     readonly ConnectorSchema: "CONNECTOR_SCHEMA";
 };
 export type SourceSchemasInnerTypeEnum = typeof SourceSchemasInnerTypeEnum[keyof typeof SourceSchemasInnerTypeEnum];
+/**
+ * A Service Desk Integration that carries out provisioning for a source.
+ * @export
+ * @interface SourceServiceDeskIntegrationDto
+ */
+export interface SourceServiceDeskIntegrationDto {
+    /**
+     * ID of the Service Desk Integration.
+     * @type {string}
+     * @memberof SourceServiceDeskIntegrationDto
+     */
+    'id': string;
+    /**
+     * Name of the Service Desk Integration, as given by the administrator who created it. Use this to find the integration in the Service Desk Integrations list.
+     * @type {string}
+     * @memberof SourceServiceDeskIntegrationDto
+     */
+    'name': string;
+    /**
+     * Type of the Service Desk Integration, matching the connector it was created from. This is the same value the Service Desk Integration APIs report as `type`, for example: - ServiceNowSDIM - ServiceNow  The supported types are not fixed, so use [List service desk integration types](https://developer.sailpoint.com/docs/api/get-service-desk-integration-types-v-1) for the current set rather than hard coding them.
+     * @type {string}
+     * @memberof SourceServiceDeskIntegrationDto
+     */
+    'type': string;
+}
 /**
  *
  * @export
@@ -3964,6 +3989,16 @@ export declare const SourcesApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     getSourceSchemasV1: (sourceId: string, includeTypes?: GetSourceSchemasV1IncludeTypesEnum, includeNames?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Use this API to list the Service Desk Integrations that carry out provisioning for a source in Identity Security Cloud (ISC).  A source is provisioned either entirely through its own connector or entirely through a Service Desk Integration; provisioning is never split between the two. An empty list therefore means the source\'s own connector handles provisioning, and a non-empty list means every provisioning request for the source is routed to the integrations named in the response.  Use this API to determine why provisioning settings on the source itself have no effect, and to identify the integration an administrator must change instead.
+     * @summary List source service desk integrations
+     * @param {string} sourceId Source ID.
+     * @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 {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 {*} [axiosOptions] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSourceServiceDeskIntegrationsV1: (sourceId: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Use this API to get a source by a specified ID in Identity Security Cloud (ISC).
      * @summary Get source by id
@@ -4700,6 +4735,16 @@ export declare const SourcesApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getSourceSchemasV1(sourceId: string, includeTypes?: GetSourceSchemasV1IncludeTypesEnum, includeNames?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Schema>>>;
+    /**
+     * Use this API to list the Service Desk Integrations that carry out provisioning for a source in Identity Security Cloud (ISC).  A source is provisioned either entirely through its own connector or entirely through a Service Desk Integration; provisioning is never split between the two. An empty list therefore means the source\'s own connector handles provisioning, and a non-empty list means every provisioning request for the source is routed to the integrations named in the response.  Use this API to determine why provisioning settings on the source itself have no effect, and to identify the integration an administrator must change instead.
+     * @summary List source service desk integrations
+     * @param {string} sourceId Source ID.
+     * @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 {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 {*} [axiosOptions] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSourceServiceDeskIntegrationsV1(sourceId: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SourceServiceDeskIntegrationDto>>>;
     /**
      * Use this API to get a source by a specified ID in Identity Security Cloud (ISC).
      * @summary Get source by id
@@ -5391,6 +5436,14 @@ export declare const SourcesApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     getSourceSchemasV1(requestParameters: SourcesApiGetSourceSchemasV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<Schema>>;
+    /**
+     * Use this API to list the Service Desk Integrations that carry out provisioning for a source in Identity Security Cloud (ISC).  A source is provisioned either entirely through its own connector or entirely through a Service Desk Integration; provisioning is never split between the two. An empty list therefore means the source\'s own connector handles provisioning, and a non-empty list means every provisioning request for the source is routed to the integrations named in the response.  Use this API to determine why provisioning settings on the source itself have no effect, and to identify the integration an administrator must change instead.
+     * @summary List source service desk integrations
+     * @param {SourcesApiGetSourceServiceDeskIntegrationsV1Request} requestParameters Request parameters.
+     * @param {*} [axiosOptions] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSourceServiceDeskIntegrationsV1(requestParameters: SourcesApiGetSourceServiceDeskIntegrationsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<SourceServiceDeskIntegrationDto>>;
     /**
      * Use this API to get a source by a specified ID in Identity Security Cloud (ISC).
      * @summary Get source by id
@@ -6473,6 +6526,31 @@ export interface SourcesApiGetSourceSchemasV1Request {
      */
     readonly includeNames?: string;
 }
+/**
+ * Request parameters for getSourceServiceDeskIntegrationsV1 operation in SourcesApi.
+ * @export
+ * @interface SourcesApiGetSourceServiceDeskIntegrationsV1Request
+ */
+export interface SourcesApiGetSourceServiceDeskIntegrationsV1Request {
+    /**
+     * Source ID.
+     * @type {string}
+     * @memberof SourcesApiGetSourceServiceDeskIntegrationsV1
+     */
+    readonly sourceId: string;
+    /**
+     * 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 SourcesApiGetSourceServiceDeskIntegrationsV1
+     */
+    readonly limit?: number;
+    /**
+     * 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 SourcesApiGetSourceServiceDeskIntegrationsV1
+     */
+    readonly offset?: number;
+}
 /**
  * Request parameters for getSourceV1 operation in SourcesApi.
  * @export
@@ -7729,6 +7807,15 @@ export declare class SourcesApi extends BaseAPI {
      * @memberof SourcesApi
      */
     getSourceSchemasV1(requestParameters: SourcesApiGetSourceSchemasV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Schema[], any>>;
+    /**
+     * Use this API to list the Service Desk Integrations that carry out provisioning for a source in Identity Security Cloud (ISC).  A source is provisioned either entirely through its own connector or entirely through a Service Desk Integration; provisioning is never split between the two. An empty list therefore means the source\'s own connector handles provisioning, and a non-empty list means every provisioning request for the source is routed to the integrations named in the response.  Use this API to determine why provisioning settings on the source itself have no effect, and to identify the integration an administrator must change instead.
+     * @summary List source service desk integrations
+     * @param {SourcesApiGetSourceServiceDeskIntegrationsV1Request} requestParameters Request parameters.
+     * @param {*} [axiosOptions] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SourcesApi
+     */
+    getSourceServiceDeskIntegrationsV1(requestParameters: SourcesApiGetSourceServiceDeskIntegrationsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SourceServiceDeskIntegrationDto[], any>>;
     /**
      * Use this API to get a source by a specified ID in Identity Security Cloud (ISC).
      * @summary Get source by id

package/dist/sources/api.js

@@ -2198,6 +2198,47 @@ var SourcesApiAxiosParamCreator = function (configuration) {
                 });
             });
         },
+        /**
+         * Use this API to list the Service Desk Integrations that carry out provisioning for a source in Identity Security Cloud (ISC).  A source is provisioned either entirely through its own connector or entirely through a Service Desk Integration; provisioning is never split between the two. An empty list therefore means the source\'s own connector handles provisioning, and a non-empty list means every provisioning request for the source is routed to the integrations named in the response.  Use this API to determine why provisioning settings on the source itself have no effect, and to identify the integration an administrator must change instead.
+         * @summary List source service desk integrations
+         * @param {string} sourceId Source ID.
+         * @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 {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 {*} [axiosOptions] Override http request option.
+         * @throws {RequiredError}
+         */
+        getSourceServiceDeskIntegrationsV1: function (sourceId, limit, offset, axiosOptions) {
+            if (axiosOptions === void 0) { axiosOptions = {}; }
+            return __awaiter(_this, void 0, void 0, function () {
+                var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
+                return __generator(this, function (_a) {
+                    // verify required parameter 'sourceId' is not null or undefined
+                    (0, common_1.assertParamExists)('getSourceServiceDeskIntegrationsV1', 'sourceId', sourceId);
+                    localVarPath = "/sources/v1/{sourceId}/service-desk-integrations"
+                        .replace("{".concat("sourceId", "}"), encodeURIComponent(String(sourceId)));
+                    localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+                    if (configuration) {
+                        baseOptions = configuration.baseOptions;
+                    }
+                    localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), axiosOptions);
+                    localVarHeaderParameter = {};
+                    localVarQueryParameter = {};
+                    if (limit !== undefined) {
+                        localVarQueryParameter['limit'] = limit;
+                    }
+                    if (offset !== undefined) {
+                        localVarQueryParameter['offset'] = offset;
+                    }
+                    (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+                    headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+                    localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), axiosOptions.headers);
+                    return [2 /*return*/, {
+                            url: (0, common_1.toPathString)(localVarUrlObj),
+                            axiosOptions: localVarRequestOptions,
+                        }];
+                });
+            });
+        },
         /**
          * Use this API to get a source by a specified ID in Identity Security Cloud (ISC).
          * @summary Get source by id
@@ -4741,6 +4782,31 @@ var SourcesApiFp = function (configuration) {
                 });
             });
         },
+        /**
+         * Use this API to list the Service Desk Integrations that carry out provisioning for a source in Identity Security Cloud (ISC).  A source is provisioned either entirely through its own connector or entirely through a Service Desk Integration; provisioning is never split between the two. An empty list therefore means the source\'s own connector handles provisioning, and a non-empty list means every provisioning request for the source is routed to the integrations named in the response.  Use this API to determine why provisioning settings on the source itself have no effect, and to identify the integration an administrator must change instead.
+         * @summary List source service desk integrations
+         * @param {string} sourceId Source ID.
+         * @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 {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 {*} [axiosOptions] Override http request option.
+         * @throws {RequiredError}
+         */
+        getSourceServiceDeskIntegrationsV1: function (sourceId, limit, offset, axiosOptions) {
+            var _a, _b, _c;
+            return __awaiter(this, void 0, void 0, function () {
+                var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
+                return __generator(this, function (_d) {
+                    switch (_d.label) {
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSourceServiceDeskIntegrationsV1(sourceId, limit, offset, axiosOptions)];
+                        case 1:
+                            localVarAxiosArgs = _d.sent();
+                            localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                            localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['SourcesApi.getSourceServiceDeskIntegrationsV1']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                            return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
+                    }
+                });
+            });
+        },
         /**
          * Use this API to get a source by a specified ID in Identity Security Cloud (ISC).
          * @summary Get source by id
@@ -6082,6 +6148,16 @@ var SourcesApiFactory = function (configuration, basePath, axios) {
         getSourceSchemasV1: function (requestParameters, axiosOptions) {
             return localVarFp.getSourceSchemasV1(requestParameters.sourceId, requestParameters.includeTypes, requestParameters.includeNames, axiosOptions).then(function (request) { return request(axios, basePath); });
         },
+        /**
+         * Use this API to list the Service Desk Integrations that carry out provisioning for a source in Identity Security Cloud (ISC).  A source is provisioned either entirely through its own connector or entirely through a Service Desk Integration; provisioning is never split between the two. An empty list therefore means the source\'s own connector handles provisioning, and a non-empty list means every provisioning request for the source is routed to the integrations named in the response.  Use this API to determine why provisioning settings on the source itself have no effect, and to identify the integration an administrator must change instead.
+         * @summary List source service desk integrations
+         * @param {SourcesApiGetSourceServiceDeskIntegrationsV1Request} requestParameters Request parameters.
+         * @param {*} [axiosOptions] Override http request option.
+         * @throws {RequiredError}
+         */
+        getSourceServiceDeskIntegrationsV1: function (requestParameters, axiosOptions) {
+            return localVarFp.getSourceServiceDeskIntegrationsV1(requestParameters.sourceId, requestParameters.limit, requestParameters.offset, axiosOptions).then(function (request) { return request(axios, basePath); });
+        },
         /**
          * Use this API to get a source by a specified ID in Identity Security Cloud (ISC).
          * @summary Get source by id
@@ -6945,6 +7021,18 @@ var SourcesApi = /** @class */ (function (_super) {
         var _this = this;
         return (0, exports.SourcesApiFp)(this.configuration).getSourceSchemasV1(requestParameters.sourceId, requestParameters.includeTypes, requestParameters.includeNames, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
     };
+    /**
+     * Use this API to list the Service Desk Integrations that carry out provisioning for a source in Identity Security Cloud (ISC).  A source is provisioned either entirely through its own connector or entirely through a Service Desk Integration; provisioning is never split between the two. An empty list therefore means the source\'s own connector handles provisioning, and a non-empty list means every provisioning request for the source is routed to the integrations named in the response.  Use this API to determine why provisioning settings on the source itself have no effect, and to identify the integration an administrator must change instead.
+     * @summary List source service desk integrations
+     * @param {SourcesApiGetSourceServiceDeskIntegrationsV1Request} requestParameters Request parameters.
+     * @param {*} [axiosOptions] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SourcesApi
+     */
+    SourcesApi.prototype.getSourceServiceDeskIntegrationsV1 = function (requestParameters, axiosOptions) {
+        var _this = this;
+        return (0, exports.SourcesApiFp)(this.configuration).getSourceServiceDeskIntegrationsV1(requestParameters.sourceId, requestParameters.limit, requestParameters.offset, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
     /**
      * Use this API to get a source by a specified ID in Identity Security Cloud (ISC).
      * @summary Get source by id