sailpoint-api-client 2.0.3 → 2.0.5

package/intelligence/base.ts

@@ -0,0 +1,86 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Identity Security Cloud API - Intelligence
+ * 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';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
+
+export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, "");
+
+/**
+ *
+ * @export
+ */
+export const COLLECTION_FORMATS = {
+    csv: ",",
+    ssv: " ",
+    tsv: "\t",
+    pipes: "|",
+};
+
+/**
+ *
+ * @export
+ * @interface RequestArgs
+ */
+export interface RequestArgs {
+    url: string;
+    axiosOptions: RawAxiosRequestConfig;
+}
+
+/**
+ *
+ * @export
+ * @class BaseAPI
+ */
+export class BaseAPI {
+    protected configuration: Configuration | undefined;
+
+    constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) {
+        if (configuration) {
+            this.configuration = configuration;
+            this.basePath = configuration.basePath || this.basePath;
+        }
+    }
+};
+
+/**
+ *
+ * @export
+ * @class RequiredError
+ * @extends {Error}
+ */
+export class RequiredError extends Error {
+    constructor(public field: string, msg?: string) {
+        super(msg);
+        this.name = "RequiredError"
+    }
+}
+
+interface ServerMap {
+    [key: string]: {
+        url: string,
+        description: string,
+    }[];
+}
+
+/**
+ *
+ * @export
+ */
+export const operationServerMap: ServerMap = {
+}

package/intelligence/common.ts

@@ -0,0 +1,183 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Identity Security Cloud API - Intelligence
+ * 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 { RequestArgs } from "./base";
+import type { AxiosInstance, AxiosResponse } from 'axios';
+import { RequiredError } from "./base";
+
+/**
+ *
+ * @export
+ */
+export const DUMMY_BASE_URL = 'https://example.com'
+
+/**
+ *
+ * @throws {RequiredError}
+ * @export
+ */
+export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) {
+    if (paramValue === null || paramValue === undefined) {
+        throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) {
+    if (configuration && configuration.apiKey) {
+        const localVarApiKeyValue = typeof configuration.apiKey === 'function'
+            ? await configuration.apiKey(keyParamName)
+            : await configuration.apiKey;
+        object[keyParamName] = localVarApiKeyValue;
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setBasicAuthToObject = function (object: any, configuration?: Configuration) {
+    if (configuration && (configuration.username || configuration.password)) {
+        object["auth"] = { username: configuration.username, password: configuration.password };
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) {
+    if (configuration && configuration.accessToken) {
+        const accessToken = typeof configuration.accessToken === 'function'
+            ? await configuration.accessToken()
+            : await configuration.accessToken;
+        object["Authorization"] = "Bearer " + accessToken;
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) {
+    if (configuration && configuration.accessToken) {
+        const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+            ? await configuration.accessToken(name, scopes)
+            : await configuration.accessToken;
+        object["Authorization"] = "Bearer " + localVarAccessTokenValue;
+    }
+}
+
+function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void {
+    if (parameter == null) return;
+    if (typeof parameter === "object") {
+        if (Array.isArray(parameter)) {
+            (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
+        } 
+        else {
+            Object.keys(parameter).forEach(currentKey => 
+                setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`)
+            );
+        }
+    } 
+    else {
+        if (urlSearchParams.has(key)) {
+            urlSearchParams.append(key, parameter);
+        } 
+        else {
+            urlSearchParams.set(key, parameter);
+        }
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setSearchParams = function (url: URL, ...objects: any[]) {
+    const searchParams = new URLSearchParams(url.search);
+    setFlattenedQueryParams(searchParams, objects);
+    url.search = searchParams.toString();
+}
+
+/**
+ *
+ * @export
+ */
+export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) {
+    const nonString = typeof value !== 'string';
+    const needsSerialization = nonString && configuration && configuration.isJsonMime
+        ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
+        : nonString;
+    return needsSerialization
+        ? JSON.stringify(value !== undefined ? value : {})
+        : (value || "");
+}
+
+/**
+ *
+ * @export
+ */
+export const toPathString = function (url: URL) {
+    return url.pathname + url.search + url.hash
+}
+
+/**
+ *
+ * @export
+ */
+export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) {
+    return async <T = unknown, R = AxiosResponse<T>>(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
+        let userAgent = `SailPoint-SDK-TypeScript/1.0.0`;
+        if (configuration?.consumerIdentifier && configuration?.consumerVersion) {
+            userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`;
+        }
+        userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`;
+        const headers = {
+            ...axiosArgs.axiosOptions.headers,
+            ...{'X-SailPoint-SDK':'typescript-1.0.0'},
+            ...{'User-Agent': userAgent},
+        }
+
+        if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) {
+            throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.")
+        } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) {
+            console.log("Warning: You are using Experimental APIs")
+        }
+
+        await setBearerAuthToObject(headers, configuration);
+
+        const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers};
+        return axios.request<T, R>(axiosRequestArgs).catch((error: any) => {
+            if (error?.isAxiosError === true) {
+                const clean: any = new Error(error.message ?? 'API request failed');
+                clean.name = 'ApiError';
+                clean.stack = error.stack;
+                clean.code = error.code;
+                if (error.response) {
+                    clean.status = error.response.status;
+                    clean.statusText = error.response.statusText;
+                    clean.data = error.response.data;
+                }
+                throw clean;
+            }
+            throw error;
+        });
+    };
+}

package/intelligence/configuration.ts

@@ -0,0 +1,110 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Identity Security Cloud API - Intelligence
+ * 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.
+ */
+
+
+export interface ConfigurationParameters {
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    username?: string;
+    password?: string;
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    basePath?: string;
+    serverIndex?: number;
+    baseOptions?: any;
+    formDataCtor?: new () => any;
+}
+
+export class Configuration {
+    /**
+     * parameter for apiKey security
+     * @param name security name
+     * @memberof Configuration
+     */
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    username?: string;
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    password?: string;
+    /**
+     * parameter for oauth2 security
+     * @param name security name
+     * @param scopes oauth2 scope
+     * @memberof Configuration
+     */
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    /**
+     * override base path
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    basePath?: string;
+    /**
+     * override server index
+     *
+     * @type {number}
+     * @memberof Configuration
+     */
+    serverIndex?: number;
+    /**
+     * base options for axios calls
+     *
+     * @type {any}
+     * @memberof Configuration
+     */
+    baseOptions?: any;
+    /**
+     * The FormData constructor that will be used to create multipart form data
+     * requests. You can inject this here so that execution environments that
+     * do not support the FormData class can still run the generated client.
+     *
+     * @type {new () => FormData}
+     */
+    formDataCtor?: new () => any;
+
+    constructor(param: ConfigurationParameters = {}) {
+        this.apiKey = param.apiKey;
+        this.username = param.username;
+        this.password = param.password;
+        this.accessToken = param.accessToken;
+        this.basePath = param.basePath;
+        this.serverIndex = param.serverIndex;
+        this.baseOptions = param.baseOptions;
+        this.formDataCtor = param.formDataCtor;
+    }
+
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    public isJsonMime(mime: string): boolean {
+        const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
+        return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
+    }
+}

package/intelligence/docs/Examples/typescript_code_examples_overlay.yaml

@@ -0,0 +1,78 @@
+- path: /intelligence/v1/identities
+  method: GET
+  xCodeSample:
+    - lang: TypeScript
+      label: SDK_tools/sdk/typescript/intelligence/methods/intelligence#get-identity-intelligence-v1
+      source: |
+        import { IntelligenceApi } from 'sailpoint-api-client';
+        import { Configuration } from 'sailpoint-api-client';
+
+        const configuration = new Configuration();
+        const apiInstance = new IntelligenceApi(configuration);
+        const filters: string = 'id eq "ef38f94347e94562b5bb8424a56397d8"'; // 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*  **email**: *eq* (default to undefined)
+        const result = await apiInstance.getIdentityIntelligenceV1({ filters: filters });
+        console.log(result);
+- path: /intelligence/v1/identities/{id}/access-history/access-items
+  method: GET
+  xCodeSample:
+    - lang: TypeScript
+      label: SDK_tools/sdk/typescript/intelligence/methods/intelligence#get-intel-identity-access-item-history-v1
+      source: |
+        import { IntelligenceApi } from 'sailpoint-api-client';
+        import { Configuration } from 'sailpoint-api-client';
+
+        const configuration = new Configuration();
+        const apiInstance = new IntelligenceApi(configuration);
+        const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Non-empty identity id path segment for Intelligence sub-resources. (default to undefined)
+        const limit: number = 250; // number | Page size. Defaults to 250; values above 250 are rejected with 400. (optional) (default to 250)
+        const offset: number = 0; // number | Zero-based page offset. Defaults to 0. (optional) (default to 0)
+        const result = await apiInstance.getIntelIdentityAccessItemHistoryV1({ id: id });
+        console.log(result);
+- path: /intelligence/v1/identities/{id}/accounts
+  method: GET
+  xCodeSample:
+    - lang: TypeScript
+      label: SDK_tools/sdk/typescript/intelligence/methods/intelligence#get-intel-identity-accounts-v1
+      source: |
+        import { IntelligenceApi } from 'sailpoint-api-client';
+        import { Configuration } from 'sailpoint-api-client';
+
+        const configuration = new Configuration();
+        const apiInstance = new IntelligenceApi(configuration);
+        const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Non-empty identity id path segment for Intelligence sub-resources. (default to undefined)
+        const limit: number = 250; // number | Page size. Defaults to 250; values above 250 are rejected with 400. (optional) (default to 250)
+        const offset: number = 0; // number | Zero-based page offset. Defaults to 0. (optional) (default to 0)
+        const result = await apiInstance.getIntelIdentityAccountsV1({ id: id });
+        console.log(result);
+- path: /intelligence/v1/identities/{id}/access-history/certifications
+  method: GET
+  xCodeSample:
+    - lang: TypeScript
+      label: SDK_tools/sdk/typescript/intelligence/methods/intelligence#get-intel-identity-certification-history-v1
+      source: |
+        import { IntelligenceApi } from 'sailpoint-api-client';
+        import { Configuration } from 'sailpoint-api-client';
+
+        const configuration = new Configuration();
+        const apiInstance = new IntelligenceApi(configuration);
+        const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Non-empty identity id path segment for Intelligence sub-resources. (default to undefined)
+        const limit: number = 250; // number | Page size. Defaults to 250; values above 250 are rejected with 400. (optional) (default to 250)
+        const offset: number = 0; // number | Zero-based page offset. Defaults to 0. (optional) (default to 0)
+        const result = await apiInstance.getIntelIdentityCertificationHistoryV1({ id: id });
+        console.log(result);
+- path: /intelligence/v1/identities/{id}/outliers/rare-access
+  method: GET
+  xCodeSample:
+    - lang: TypeScript
+      label: SDK_tools/sdk/typescript/intelligence/methods/intelligence#get-intel-identity-rare-access-v1
+      source: |
+        import { IntelligenceApi } from 'sailpoint-api-client';
+        import { Configuration } from 'sailpoint-api-client';
+
+        const configuration = new Configuration();
+        const apiInstance = new IntelligenceApi(configuration);
+        const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Non-empty identity id path segment for Intelligence sub-resources. (default to undefined)
+        const limit: number = 250; // number | Page size. Defaults to 250; values above 250 are rejected with 400. (optional) (default to 250)
+        const offset: number = 0; // number | Zero-based page offset. Defaults to 0. (optional) (default to 0)
+        const result = await apiInstance.getIntelIdentityRareAccessV1({ id: id });
+        console.log(result);

package/intelligence/docs/Methods/Index.md

@@ -0,0 +1,30 @@
+---
+id: intelligence-methods
+title: Methods
+pagination_label: Methods
+sidebar_label: Methods
+sidebar_position: 3
+sidebar_key: intelligence-typescript-methods
+sidebar_class_name: methods
+keywords: ['typescript', 'TypeScript', 'sdk', 'intelligence', 'methods']
+slug: /tools/sdk/typescript/intelligence/methods
+tags: ['SDK', 'Software Development Kit', 'intelligence', 'methods']
+---
+
+Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it.
+## Key Features
+- Purpose & Overview: Explains the purpose of the method and its role in the API.
+- Parameters: Describe the required input parameters, including their data types.
+- Response Format: Details the expected return format or structure.
+- Error Scenarios: Outline potential errors or issues that may arise during method execution.
+- Example: Provides a sample of how the API uses the method.
+
+## Available Methods
+This is a list of the core methods available in the TypeScript SDK for **V1** endpoints:
+
+```mdx-code-block
+import DocCardList from '@theme/DocCardList';
+import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
+
+<DocCardList items={useCurrentSidebarCategory().items}/>
+```