@relentless-identity/sdk 1.0.0

package/README.md

@@ -0,0 +1,163 @@
+# @relentlessidentity/sdk@1.0.0
+
+A TypeScript SDK client for the api.relentlessidentity.com API.
+
+## Usage
+
+First, install the SDK from npm.
+
+```bash
+npm install @relentlessidentity/sdk --save
+```
+
+Next, try it out.
+
+
+```ts
+import {
+  Configuration,
+  AccountApi,
+} from '@relentlessidentity/sdk';
+import type { GetRequestHistoryRequest } from '@relentlessidentity/sdk';
+
+async function example() {
+  console.log("🚀 Testing @relentlessidentity/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new AccountApi(config);
+
+  const body = {
+    // number | Page number starting at 1. (optional)
+    page: 56,
+    // number | Number of history rows per page. Maximum 25. (optional)
+    pageSize: 56,
+    // 'finder' | 'probe' | Optional request-type filter. (optional)
+    requestType: requestType_example,
+    // 'deliverable' | 'undeliverable' | Optional deliverability-state filter. (optional)
+    state: state_example,
+  } satisfies GetRequestHistoryRequest;
+
+  try {
+    const data = await api.getRequestHistory(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+
+## Documentation
+
+### API Endpoints
+
+All URIs are relative to *https://api.relentlessidentity.com*
+
+| Class | Method | HTTP request | Description
+| ----- | ------ | ------------ | -------------
+*AccountApi* | [**getRequestHistory**](docs/AccountApi.md#getrequesthistory) | **GET** /client/history | Get paginated request history
+*AccountApi* | [**getTokenStatus**](docs/AccountApi.md#gettokenstatus) | **GET** /client/token | Inspect the current bearer token
+*AccountApi* | [**getUsage**](docs/AccountApi.md#getusage) | **GET** /client/usage | Get current usage and limits
+*FinderApi* | [**finderAttempt**](docs/FinderApi.md#finderattempt) | **POST** /client/attempt | Find a work email
+*JobsApi* | [**getJob**](docs/JobsApi.md#getjob) | **GET** /client/jobs/{job_id} | Get background job
+*JobsApi* | [**getJobInputsText**](docs/JobsApi.md#getjobinputstext) | **GET** /client/jobs/{job_id}/inputs.txt | Download job inputs
+*JobsApi* | [**getJobResultsJson**](docs/JobsApi.md#getjobresultsjson) | **GET** /client/jobs/{job_id}/results.json | Download job results as JSON
+*JobsApi* | [**getJobResultsText**](docs/JobsApi.md#getjobresultstext) | **GET** /client/jobs/{job_id}/results.txt | Download job results as text
+*JobsApi* | [**listJobs**](docs/JobsApi.md#listjobs) | **GET** /client/jobs | List background jobs
+*JobsApi* | [**scheduleFinderBatch**](docs/JobsApi.md#schedulefinderbatch) | **POST** /client/jobs/finder | Schedule a finder batch
+*JobsApi* | [**scheduleProbeBatch**](docs/JobsApi.md#scheduleprobebatch) | **POST** /client/jobs/probe-batch | Schedule a probe batch
+*ProbeApi* | [**probeBatch**](docs/ProbeApi.md#probebatchoperation) | **POST** /client/probe/batch | Verify many email addresses
+*ProbeApi* | [**probeEmail**](docs/ProbeApi.md#probeemail) | **POST** /client/probe | Verify an email address
+
+
+### Models
+
+- [AliasInfo](docs/AliasInfo.md)
+- [BatchSummary](docs/BatchSummary.md)
+- [ClientBackgroundJobDetailResponse](docs/ClientBackgroundJobDetailResponse.md)
+- [ClientBackgroundJobItemResponse](docs/ClientBackgroundJobItemResponse.md)
+- [ClientBackgroundJobPageResponse](docs/ClientBackgroundJobPageResponse.md)
+- [ClientBackgroundJobResponse](docs/ClientBackgroundJobResponse.md)
+- [ClientBatchIdentityResponse](docs/ClientBatchIdentityResponse.md)
+- [ClientFinderResponse](docs/ClientFinderResponse.md)
+- [ClientFinderResponseAlias](docs/ClientFinderResponseAlias.md)
+- [ClientIdentityResponse](docs/ClientIdentityResponse.md)
+- [ClientRequestHistoryItem](docs/ClientRequestHistoryItem.md)
+- [ClientRequestHistoryPageResponse](docs/ClientRequestHistoryPageResponse.md)
+- [ClientTokenStatusResponse](docs/ClientTokenStatusResponse.md)
+- [ClientUsageResponse](docs/ClientUsageResponse.md)
+- [ErrorResponse](docs/ErrorResponse.md)
+- [FinderBatchJobRequest](docs/FinderBatchJobRequest.md)
+- [FinderBatchJobRequestInputsInner](docs/FinderBatchJobRequestInputsInner.md)
+- [FinderRequest](docs/FinderRequest.md)
+- [HTTPValidationError](docs/HTTPValidationError.md)
+- [IdentityProvider](docs/IdentityProvider.md)
+- [LocationInner](docs/LocationInner.md)
+- [ProbeBatchJobBackgroundRequest](docs/ProbeBatchJobBackgroundRequest.md)
+- [ProbeBatchRequest](docs/ProbeBatchRequest.md)
+- [ProbeRequest](docs/ProbeRequest.md)
+- [ValidationError](docs/ValidationError.md)
+
+### Authorization
+
+
+Authentication schemes defined for the API:
+<a id="bearerAuth"></a>
+#### bearerAuth
+
+
+- **Type**: HTTP Bearer Token authentication (PAT)
+
+## About
+
+This TypeScript SDK client supports the [Fetch API](https://fetch.spec.whatwg.org/)
+and is automatically generated by the
+[OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: `1.0.0`
+- Package version: `1.0.0`
+- Generator version: `7.21.0`
+- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
+
+The generated npm module supports the following:
+
+- Environments
+  * Node.js
+  * Webpack
+  * Browserify
+- Language levels
+  * ES5 - you must have a Promises/A+ library installed
+  * ES6
+- Module systems
+  * CommonJS
+  * ES6 module system
+
+
+## Development
+
+### Building
+
+To build the TypeScript source code, you need to have Node.js and npm installed.
+After cloning the repository, navigate to the project directory and run:
+
+```bash
+npm install
+npm run build
+```
+
+### Publishing
+
+Once you've built the package, you can publish it to npm:
+
+```bash
+npm publish
+```
+
+## License
+
+[]()

package/dist/apis/AccountApi.d.ts

@@ -0,0 +1,82 @@
+/**
+ * Relentless Identity API
+ * Public client API for Finder and Probe workflows. This spec is generated from the FastAPI app, then narrowed to the supported bearer-authenticated routes used by SDKs and the API reference.
+ *
+ * The version of the OpenAPI document: 1.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.
+ */
+import * as runtime from '../runtime';
+import type { ClientRequestHistoryPageResponse, ClientTokenStatusResponse, ClientUsageResponse } from '../models/index';
+export interface GetRequestHistoryRequest {
+    page?: number;
+    pageSize?: number;
+    requestType?: GetRequestHistoryRequestTypeEnum;
+    state?: GetRequestHistoryStateEnum;
+}
+/**
+ *
+ */
+export declare class AccountApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for getRequestHistory without sending the request
+     */
+    getRequestHistoryRequestOpts(requestParameters: GetRequestHistoryRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Return the authenticated user\'s latest request history with pagination and optional filters.
+     * Get paginated request history
+     */
+    getRequestHistoryRaw(requestParameters: GetRequestHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClientRequestHistoryPageResponse>>;
+    /**
+     * Return the authenticated user\'s latest request history with pagination and optional filters.
+     * Get paginated request history
+     */
+    getRequestHistory(requestParameters?: GetRequestHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClientRequestHistoryPageResponse>;
+    /**
+     * Creates request options for getTokenStatus without sending the request
+     */
+    getTokenStatusRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * Validate the current bearer token and return its active claims.
+     * Inspect the current bearer token
+     */
+    getTokenStatusRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClientTokenStatusResponse>>;
+    /**
+     * Validate the current bearer token and return its active claims.
+     * Inspect the current bearer token
+     */
+    getTokenStatus(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClientTokenStatusResponse>;
+    /**
+     * Creates request options for getUsage without sending the request
+     */
+    getUsageRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * Return the current account usage, free-tier limits, and paid capacity details for the authenticated user.
+     * Get current usage and limits
+     */
+    getUsageRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClientUsageResponse>>;
+    /**
+     * Return the current account usage, free-tier limits, and paid capacity details for the authenticated user.
+     * Get current usage and limits
+     */
+    getUsage(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClientUsageResponse>;
+}
+/**
+ * @export
+ */
+export declare const GetRequestHistoryRequestTypeEnum: {
+    readonly Finder: "finder";
+    readonly Probe: "probe";
+};
+export type GetRequestHistoryRequestTypeEnum = typeof GetRequestHistoryRequestTypeEnum[keyof typeof GetRequestHistoryRequestTypeEnum];
+/**
+ * @export
+ */
+export declare const GetRequestHistoryStateEnum: {
+    readonly Deliverable: "deliverable";
+    readonly Undeliverable: "undeliverable";
+};
+export type GetRequestHistoryStateEnum = typeof GetRequestHistoryStateEnum[keyof typeof GetRequestHistoryStateEnum];

package/dist/apis/AccountApi.js

@@ -0,0 +1,190 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Relentless Identity API
+ * Public client API for Finder and Probe workflows. This spec is generated from the FastAPI app, then narrowed to the supported bearer-authenticated routes used by SDKs and the API reference.
+ *
+ * The version of the OpenAPI document: 1.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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetRequestHistoryStateEnum = exports.GetRequestHistoryRequestTypeEnum = exports.AccountApi = void 0;
+const runtime = require("../runtime");
+/**
+ *
+ */
+class AccountApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for getRequestHistory without sending the request
+     */
+    getRequestHistoryRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['page'] != null) {
+                queryParameters['page'] = requestParameters['page'];
+            }
+            if (requestParameters['pageSize'] != null) {
+                queryParameters['page_size'] = requestParameters['pageSize'];
+            }
+            if (requestParameters['requestType'] != null) {
+                queryParameters['request_type'] = requestParameters['requestType'];
+            }
+            if (requestParameters['state'] != null) {
+                queryParameters['state'] = requestParameters['state'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/client/history`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Return the authenticated user\'s latest request history with pagination and optional filters.
+     * Get paginated request history
+     */
+    getRequestHistoryRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getRequestHistoryRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response);
+        });
+    }
+    /**
+     * Return the authenticated user\'s latest request history with pagination and optional filters.
+     * Get paginated request history
+     */
+    getRequestHistory() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.getRequestHistoryRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getTokenStatus without sending the request
+     */
+    getTokenStatusRequestOpts() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/client/token`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Validate the current bearer token and return its active claims.
+     * Inspect the current bearer token
+     */
+    getTokenStatusRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getTokenStatusRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response);
+        });
+    }
+    /**
+     * Validate the current bearer token and return its active claims.
+     * Inspect the current bearer token
+     */
+    getTokenStatus(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getTokenStatusRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getUsage without sending the request
+     */
+    getUsageRequestOpts() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/client/usage`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Return the current account usage, free-tier limits, and paid capacity details for the authenticated user.
+     * Get current usage and limits
+     */
+    getUsageRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getUsageRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response);
+        });
+    }
+    /**
+     * Return the current account usage, free-tier limits, and paid capacity details for the authenticated user.
+     * Get current usage and limits
+     */
+    getUsage(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getUsageRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.AccountApi = AccountApi;
+/**
+ * @export
+ */
+exports.GetRequestHistoryRequestTypeEnum = {
+    Finder: 'finder',
+    Probe: 'probe'
+};
+/**
+ * @export
+ */
+exports.GetRequestHistoryStateEnum = {
+    Deliverable: 'deliverable',
+    Undeliverable: 'undeliverable'
+};

package/dist/apis/FinderApi.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Relentless Identity API
+ * Public client API for Finder and Probe workflows. This spec is generated from the FastAPI app, then narrowed to the supported bearer-authenticated routes used by SDKs and the API reference.
+ *
+ * The version of the OpenAPI document: 1.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.
+ */
+import * as runtime from '../runtime';
+import type { ClientFinderResponse, FinderRequest } from '../models/index';
+export interface FinderAttemptRequest {
+    finderRequest: FinderRequest;
+}
+/**
+ *
+ */
+export declare class FinderApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for finderAttempt without sending the request
+     */
+    finderAttemptRequestOpts(requestParameters: FinderAttemptRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Send a full name and company domain to resolve the most likely verified work email.
+     * Find a work email
+     */
+    finderAttemptRaw(requestParameters: FinderAttemptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClientFinderResponse>>;
+    /**
+     * Send a full name and company domain to resolve the most likely verified work email.
+     * Find a work email
+     */
+    finderAttempt(requestParameters: FinderAttemptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClientFinderResponse>;
+}

package/dist/apis/FinderApi.js

@@ -0,0 +1,81 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Relentless Identity API
+ * Public client API for Finder and Probe workflows. This spec is generated from the FastAPI app, then narrowed to the supported bearer-authenticated routes used by SDKs and the API reference.
+ *
+ * The version of the OpenAPI document: 1.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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FinderApi = void 0;
+const runtime = require("../runtime");
+/**
+ *
+ */
+class FinderApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for finderAttempt without sending the request
+     */
+    finderAttemptRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['finderRequest'] == null) {
+                throw new runtime.RequiredError('finderRequest', 'Required parameter "finderRequest" was null or undefined when calling finderAttempt().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/client/attempt`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: requestParameters['finderRequest'],
+            };
+        });
+    }
+    /**
+     * Send a full name and company domain to resolve the most likely verified work email.
+     * Find a work email
+     */
+    finderAttemptRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.finderAttemptRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response);
+        });
+    }
+    /**
+     * Send a full name and company domain to resolve the most likely verified work email.
+     * Find a work email
+     */
+    finderAttempt(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.finderAttemptRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.FinderApi = FinderApi;