@relentless-identity/sdk 1.0.0

package/dist/apis/ProbeApi.js

@@ -0,0 +1,130 @@
+"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.ProbeApi = void 0;
+const runtime = require("../runtime");
+/**
+ *
+ */
+class ProbeApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for probeBatch without sending the request
+     */
+    probeBatchRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['probeBatchRequest'] == null) {
+                throw new runtime.RequiredError('probeBatchRequest', 'Required parameter "probeBatchRequest" was null or undefined when calling probeBatch().');
+            }
+            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/probe/batch`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: requestParameters['probeBatchRequest'],
+            };
+        });
+    }
+    /**
+     * Send many known email addresses and receive compact per-item identity results plus a batch summary.
+     * Verify many email addresses
+     */
+    probeBatchRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.probeBatchRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response);
+        });
+    }
+    /**
+     * Send many known email addresses and receive compact per-item identity results plus a batch summary.
+     * Verify many email addresses
+     */
+    probeBatch(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.probeBatchRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for probeEmail without sending the request
+     */
+    probeEmailRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['probeRequest'] == null) {
+                throw new runtime.RequiredError('probeRequest', 'Required parameter "probeRequest" was null or undefined when calling probeEmail().');
+            }
+            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/probe`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: requestParameters['probeRequest'],
+            };
+        });
+    }
+    /**
+     * Send a single email address to verify it directly.
+     * Verify an email address
+     */
+    probeEmailRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.probeEmailRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response);
+        });
+    }
+    /**
+     * Send a single email address to verify it directly.
+     * Verify an email address
+     */
+    probeEmail(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.probeEmailRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.ProbeApi = ProbeApi;

package/dist/apis/index.d.ts

@@ -0,0 +1,4 @@
+export * from './AccountApi';
+export * from './FinderApi';
+export * from './JobsApi';
+export * from './ProbeApi';

package/dist/apis/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* tslint:disable */
+/* eslint-disable */
+__exportStar(require("./AccountApi"), exports);
+__exportStar(require("./FinderApi"), exports);
+__exportStar(require("./JobsApi"), exports);
+__exportStar(require("./ProbeApi"), exports);

package/dist/esm/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/esm/apis/AccountApi.js

@@ -0,0 +1,186 @@
+/* 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());
+    });
+};
+import * as runtime from '../runtime';
+/**
+ *
+ */
+export 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();
+        });
+    }
+}
+/**
+ * @export
+ */
+export const GetRequestHistoryRequestTypeEnum = {
+    Finder: 'finder',
+    Probe: 'probe'
+};
+/**
+ * @export
+ */
+export const GetRequestHistoryStateEnum = {
+    Deliverable: 'deliverable',
+    Undeliverable: 'undeliverable'
+};

package/dist/esm/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/esm/apis/FinderApi.js

@@ -0,0 +1,77 @@
+/* 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());
+    });
+};
+import * as runtime from '../runtime';
+/**
+ *
+ */
+export 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();
+        });
+    }
+}