sailpoint-api-client 1.0.1

package/index.ts

@@ -0,0 +1,33 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * IdentityNow V3 API
+ * Use these APIs to interact with the IdentityNow 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: 3.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+export * from "./beta/api";
+export {Configuration as ConfigurationBeta, ConfigurationParameters as ConfigurationParametersBeta} from "./beta/configuration";
+
+export * from "./v3/api";
+export {Configuration as ConfigurationV3, ConfigurationParameters as ConfigurationParametersV3} from "./v3/configuration";
+
+export * from "./v2/api";
+export {Configuration as ConfigurationV2, ConfigurationParameters as ConfigurationParametersV2} from "./v2/configuration";
+
+export * from "./cc/api";
+export {Configuration as ConfigurationCC, ConfigurationParameters as ConfigurationParametersCC} from "./cc/configuration";
+
+export {Configuration, ConfigurationParameters} from "./configuration";
+
+export * from "./paginator";
+
+export * as axiosRetry from "axios-retry"

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "sailpoint-api-client",
+  "version": "1.0.1",
+  "description": "Official library for using the SailPoint API",
+  "author": "SailPoint DevOps",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sailpoint-oss/typescript-sdk.git"
+  },
+  "keywords": [
+    "axios",
+    "typescript",
+    "sdk",
+    "sailpoint"
+  ],
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "bugs": {
+    "url": "https://github.com/sailpoint-oss/typescript-sdk/issues"
+  },
+  "main": "./dist/index.js",
+  "typings": "./dist/index.d.ts",
+  "scripts": {
+    "build": "tsc --outDir dist/",
+    "prepare": "npm run build"
+  },
+  "dependencies": {
+    "axios": "^0.26.1",
+    "axios-retry": "^3.4.0",
+    "js-yaml": "^4.1.0"
+  },
+  "devDependencies": {
+    "@types/js-yaml": "^4.0.5",
+    "@types/node": "^12.11.5",
+    "typescript": "^4.0"
+  }
+}

package/paginator.ts

@@ -0,0 +1,99 @@
+import { Search, SearchApi, SearchApiSearchPostRequest, SearchDocument } from "./v3";
+
+export interface PaginationParams {
+    /**
+     * 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 AccountsApiListAccounts
+     */
+    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 AccountsApiListAccounts
+     */
+    offset?: number;
+    /**
+     * 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 AccountsApiListAccounts
+     */
+    count?: boolean;
+    /**
+     * 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*  **identityId**: *eq*  **name**: *eq, in*  **nativeIdentity**: *eq, in*  **sourceId**: *eq, in*  **uncorrelated**: *eq*
+     * @type {string}
+     * @memberof AccountsApiListAccounts
+     */
+    filters?: string;
+}
+
+export interface AxiosResponse<T = any, D = any>  {
+    data: T;
+    status: number;
+    statusText: string;
+    request?: any;
+    headers: AxiosResponseHeaders;
+  }
+  export type AxiosResponseHeaders = Record<string, string> & {
+    "set-cookie"?: string[]
+  };
+
+export class Paginator {
+
+    public static async paginate<T, TResult, A extends PaginationParams>(thisArg: T, callbackFn: (this: T, args: A) => Promise<AxiosResponse<TResult[], any>>, args?: A, increment?: number): Promise<AxiosResponse<TResult[], any>> {
+        let params: PaginationParams = args ? args : {limit: 0, offset: 0}
+        const maxLimit = params && params.limit ? params.limit : 0
+        if (!params.offset) {
+            params.offset = 0
+        }
+        if (!increment) {
+            increment = 250
+        }
+        params.limit = increment
+    
+        let modified: TResult[] = []
+        while (true) {
+            console.log(`Paginating call, offset = ${params.offset}`)
+            let results = await callbackFn.call(thisArg, params)
+            modified.push.apply(modified, results.data)
+            if (results.data.length < increment || (params.offset >= maxLimit && maxLimit > 0)) {
+                results.data = modified
+                return results
+            }
+            params.offset += increment
+        }
+    }
+
+    public static async paginateSearchApi(searchAPI: SearchApi, search: Search, increment?: number, limit?: number): Promise<AxiosResponse<SearchDocument[], any>> {
+        increment = increment ? increment : 250
+        const searchParams: SearchApiSearchPostRequest = {
+            search: search,
+            limit: increment
+        }
+        let offset = 0 
+        const maxLimit = limit ? limit : 0
+        let modified: SearchDocument[] = []
+    
+        if (!search.sort || search.sort.length != 1) {
+            throw("search must include exactly one sort parameter to paginate properly")
+        }
+    
+        while (true) {
+            console.log(`Paginating call, offset = ${offset}`)
+            let results = await searchAPI.searchPost(searchParams)
+            modified.push.apply(modified, results.data)
+            if (results.data.length < increment || (offset >= maxLimit && maxLimit > 0)) {
+                results.data = modified
+                return results
+            } else {
+                const result = <any>results.data[results.data.length - 1]
+                if (searchParams.search.sort) {
+                    searchParams.search.searchAfter = [result[searchParams.search.sort[0].replace("-", "")]]
+                } else {
+                    throw("search unexpectedly did not return a result we can search after!")
+                }
+            }
+            offset += increment
+        }
+    }
+}

package/readme.md

@@ -0,0 +1,53 @@
+# SailPoint API Client
+
+## Description
+
+A typescript sdk for accessing the SailPoint IdentityNow REST API's.
+
+## Installation
+
+```bash
+npm install sailpoint-api-client
+```
+
+## Create a configuration file or save your configuration as environment variables
+
+You can create a local configuration file using the [CLI tool](https://github.com/sailpoint-oss/sailpoint-cli#configuration) or you can store your configuration in environment variables
+
+* SAIL_BASE_URL
+* SAIL_CLIENT_ID
+* SAIL_CLIENT_SECRET
+
+## Examples
+
+Simply import the API you want to work with, create a new configuration and get started.
+
+```typescript
+
+import { Configuration, TransformsApi, TransformsApiCreateTransformRequest} from "sailpoint-api-client"
+
+const createTransform = async () => {
+
+    let apiConfig = new Configuration()
+    let api = new TransformsApi(apiConfig)
+    let transform: TransformsApiCreateTransformRequest = 
+    {
+        transform:
+        {
+            name: "Test Transform",
+            type: "dateFormat",
+            attributes: {
+                inputFormat: "MMM dd yyyy, HH:mm:ss.SSS",
+                outputFormat: "yyyy/dd/MM"
+            }
+        }
+    }
+    const val = await api.createTransform(transform)
+    console.log(val)
+}
+
+createTransform()
+
+```
+
+### See more uses of the SDK [here](../examples/src/index.ts)

package/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "target": "ES5",
+    "module": "CommonJS",
+    "noImplicitAny": true,
+    "outDir": "dist",
+    "rootDir": ".",
+    "lib": [
+      "es6",
+      "dom"
+    ],
+    "typeRoots": [
+      "node_modules/@types"
+    ],
+    "sourceMap": true
+  },
+  "exclude": [
+    "dist",
+    "node_modules"
+  ]
+}

package/v2/.openapi-generator/FILES

@@ -0,0 +1,11 @@
+.gitignore
+.npmignore
+README.md
+api.ts
+base.ts
+common.ts
+configuration.ts
+git_push.sh
+index.ts
+package.json
+tsconfig.json

package/v2/.openapi-generator/VERSION

@@ -0,0 +1 @@
+6.0.1

package/v2/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

package/v2/README.md

@@ -0,0 +1,45 @@
+## sailpoint-sdk@1.0.1
+
+This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
+
+Environment
+* Node.js
+* Webpack
+* Browserify
+
+Language level
+* ES5 - you must have a Promises/A+ library installed
+* ES6
+
+Module system
+* CommonJS
+* ES6 module system
+
+It can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via `package.json`. ([Reference](http://www.typescriptlang.org/docs/handbook/typings-for-npm-packages.html))
+
+### Building
+
+To build and compile the typescript sources to javascript use:
+```
+npm install
+npm run build
+```
+
+### Publishing
+
+First build the package then run ```npm publish```
+
+### Consuming
+
+navigate to the folder of your consuming project and run one of the following commands.
+
+_published:_
+
+```
+npm install sailpoint-sdk@1.0.1 --save
+```
+
+_unPublished (not recommended):_
+
+```
+npm install PATH_TO_GENERATED_PACKAGE --save