@relentless-identity/sdk 1.0.0

package/dist/apis/JobsApi.d.ts

@@ -0,0 +1,167 @@
+/**
+ * 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 { ClientBackgroundJobDetailResponse, ClientBackgroundJobPageResponse, ClientBackgroundJobResponse, FinderBatchJobRequest, ProbeBatchJobBackgroundRequest } from '../models/index';
+export interface GetJobRequest {
+    jobId: string;
+    page?: number;
+    pageSize?: number;
+}
+export interface GetJobInputsTextRequest {
+    jobId: string;
+    ifNoneMatch?: string | null;
+    ifModifiedSince?: string | null;
+}
+export interface GetJobResultsJsonRequest {
+    jobId: string;
+    ifNoneMatch?: string | null;
+    ifModifiedSince?: string | null;
+}
+export interface GetJobResultsTextRequest {
+    jobId: string;
+    ifNoneMatch?: string | null;
+    ifModifiedSince?: string | null;
+}
+export interface ListJobsRequest {
+    page?: number;
+    pageSize?: number;
+    jobType?: ListJobsJobTypeEnum;
+    status?: ListJobsStatusEnum;
+}
+export interface ScheduleFinderBatchRequest {
+    finderBatchJobRequest: FinderBatchJobRequest;
+}
+export interface ScheduleProbeBatchRequest {
+    probeBatchJobBackgroundRequest: ProbeBatchJobBackgroundRequest;
+}
+/**
+ *
+ */
+export declare class JobsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for getJob without sending the request
+     */
+    getJobRequestOpts(requestParameters: GetJobRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Return the current status and paginated results for one background job.
+     * Get background job
+     */
+    getJobRaw(requestParameters: GetJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClientBackgroundJobDetailResponse>>;
+    /**
+     * Return the current status and paginated results for one background job.
+     * Get background job
+     */
+    getJob(requestParameters: GetJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClientBackgroundJobDetailResponse>;
+    /**
+     * Creates request options for getJobInputsText without sending the request
+     */
+    getJobInputsTextRequestOpts(requestParameters: GetJobInputsTextRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Return the original background job inputs as plain text when the payload is still retained.
+     * Download job inputs
+     */
+    getJobInputsTextRaw(requestParameters: GetJobInputsTextRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Return the original background job inputs as plain text when the payload is still retained.
+     * Download job inputs
+     */
+    getJobInputsText(requestParameters: GetJobInputsTextRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Creates request options for getJobResultsJson without sending the request
+     */
+    getJobResultsJsonRequestOpts(requestParameters: GetJobResultsJsonRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Return the canonical immutable background job results artifact as JSON.
+     * Download job results as JSON
+     */
+    getJobResultsJsonRaw(requestParameters: GetJobResultsJsonRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<any>>;
+    /**
+     * Return the canonical immutable background job results artifact as JSON.
+     * Download job results as JSON
+     */
+    getJobResultsJson(requestParameters: GetJobResultsJsonRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<any>;
+    /**
+     * Creates request options for getJobResultsText without sending the request
+     */
+    getJobResultsTextRequestOpts(requestParameters: GetJobResultsTextRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Return the canonical background job results in a readable plain-text format.
+     * Download job results as text
+     */
+    getJobResultsTextRaw(requestParameters: GetJobResultsTextRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Return the canonical background job results in a readable plain-text format.
+     * Download job results as text
+     */
+    getJobResultsText(requestParameters: GetJobResultsTextRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Creates request options for listJobs without sending the request
+     */
+    listJobsRequestOpts(requestParameters: ListJobsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Return the authenticated user\'s paginated background job history.
+     * List background jobs
+     */
+    listJobsRaw(requestParameters: ListJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClientBackgroundJobPageResponse>>;
+    /**
+     * Return the authenticated user\'s paginated background job history.
+     * List background jobs
+     */
+    listJobs(requestParameters?: ListJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClientBackgroundJobPageResponse>;
+    /**
+     * Creates request options for scheduleFinderBatch without sending the request
+     */
+    scheduleFinderBatchRequestOpts(requestParameters: ScheduleFinderBatchRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Queue a background finder batch job with an optional deadline and callback URL.
+     * Schedule a finder batch
+     */
+    scheduleFinderBatchRaw(requestParameters: ScheduleFinderBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClientBackgroundJobResponse>>;
+    /**
+     * Queue a background finder batch job with an optional deadline and callback URL.
+     * Schedule a finder batch
+     */
+    scheduleFinderBatch(requestParameters: ScheduleFinderBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClientBackgroundJobResponse>;
+    /**
+     * Creates request options for scheduleProbeBatch without sending the request
+     */
+    scheduleProbeBatchRequestOpts(requestParameters: ScheduleProbeBatchRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Queue a background probe batch job with an optional deadline and callback URL.
+     * Schedule a probe batch
+     */
+    scheduleProbeBatchRaw(requestParameters: ScheduleProbeBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClientBackgroundJobResponse>>;
+    /**
+     * Queue a background probe batch job with an optional deadline and callback URL.
+     * Schedule a probe batch
+     */
+    scheduleProbeBatch(requestParameters: ScheduleProbeBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClientBackgroundJobResponse>;
+}
+/**
+ * @export
+ */
+export declare const ListJobsJobTypeEnum: {
+    readonly FinderBatch: "finder_batch";
+    readonly ProbeBatch: "probe_batch";
+};
+export type ListJobsJobTypeEnum = typeof ListJobsJobTypeEnum[keyof typeof ListJobsJobTypeEnum];
+/**
+ * @export
+ */
+export declare const ListJobsStatusEnum: {
+    readonly Queued: "queued";
+    readonly Processing: "processing";
+    readonly Completed: "completed";
+    readonly Failed: "failed";
+    readonly Canceled: "canceled";
+};
+export type ListJobsStatusEnum = typeof ListJobsStatusEnum[keyof typeof ListJobsStatusEnum];

package/dist/apis/JobsApi.js

@@ -0,0 +1,434 @@
+"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.ListJobsStatusEnum = exports.ListJobsJobTypeEnum = exports.JobsApi = void 0;
+const runtime = require("../runtime");
+/**
+ *
+ */
+class JobsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for getJob without sending the request
+     */
+    getJobRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['jobId'] == null) {
+                throw new runtime.RequiredError('jobId', 'Required parameter "jobId" was null or undefined when calling getJob().');
+            }
+            const queryParameters = {};
+            if (requestParameters['page'] != null) {
+                queryParameters['page'] = requestParameters['page'];
+            }
+            if (requestParameters['pageSize'] != null) {
+                queryParameters['page_size'] = requestParameters['pageSize'];
+            }
+            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/jobs/{job_id}`;
+            urlPath = urlPath.replace(`{${"job_id"}}`, encodeURIComponent(String(requestParameters['jobId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Return the current status and paginated results for one background job.
+     * Get background job
+     */
+    getJobRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getJobRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response);
+        });
+    }
+    /**
+     * Return the current status and paginated results for one background job.
+     * Get background job
+     */
+    getJob(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getJobRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getJobInputsText without sending the request
+     */
+    getJobInputsTextRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['jobId'] == null) {
+                throw new runtime.RequiredError('jobId', 'Required parameter "jobId" was null or undefined when calling getJobInputsText().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['ifNoneMatch'] != null) {
+                headerParameters['if-none-match'] = String(requestParameters['ifNoneMatch']);
+            }
+            if (requestParameters['ifModifiedSince'] != null) {
+                headerParameters['if-modified-since'] = String(requestParameters['ifModifiedSince']);
+            }
+            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/jobs/{job_id}/inputs.txt`;
+            urlPath = urlPath.replace(`{${"job_id"}}`, encodeURIComponent(String(requestParameters['jobId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Return the original background job inputs as plain text when the payload is still retained.
+     * Download job inputs
+     */
+    getJobInputsTextRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getJobInputsTextRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            if (this.isJsonMime(response.headers.get('content-type'))) {
+                return new runtime.JSONApiResponse(response);
+            }
+            else {
+                return new runtime.TextApiResponse(response);
+            }
+        });
+    }
+    /**
+     * Return the original background job inputs as plain text when the payload is still retained.
+     * Download job inputs
+     */
+    getJobInputsText(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getJobInputsTextRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getJobResultsJson without sending the request
+     */
+    getJobResultsJsonRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['jobId'] == null) {
+                throw new runtime.RequiredError('jobId', 'Required parameter "jobId" was null or undefined when calling getJobResultsJson().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['ifNoneMatch'] != null) {
+                headerParameters['if-none-match'] = String(requestParameters['ifNoneMatch']);
+            }
+            if (requestParameters['ifModifiedSince'] != null) {
+                headerParameters['if-modified-since'] = String(requestParameters['ifModifiedSince']);
+            }
+            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/jobs/{job_id}/results.json`;
+            urlPath = urlPath.replace(`{${"job_id"}}`, encodeURIComponent(String(requestParameters['jobId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Return the canonical immutable background job results artifact as JSON.
+     * Download job results as JSON
+     */
+    getJobResultsJsonRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getJobResultsJsonRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            if (this.isJsonMime(response.headers.get('content-type'))) {
+                return new runtime.JSONApiResponse(response);
+            }
+            else {
+                return new runtime.TextApiResponse(response);
+            }
+        });
+    }
+    /**
+     * Return the canonical immutable background job results artifact as JSON.
+     * Download job results as JSON
+     */
+    getJobResultsJson(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getJobResultsJsonRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getJobResultsText without sending the request
+     */
+    getJobResultsTextRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['jobId'] == null) {
+                throw new runtime.RequiredError('jobId', 'Required parameter "jobId" was null or undefined when calling getJobResultsText().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['ifNoneMatch'] != null) {
+                headerParameters['if-none-match'] = String(requestParameters['ifNoneMatch']);
+            }
+            if (requestParameters['ifModifiedSince'] != null) {
+                headerParameters['if-modified-since'] = String(requestParameters['ifModifiedSince']);
+            }
+            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/jobs/{job_id}/results.txt`;
+            urlPath = urlPath.replace(`{${"job_id"}}`, encodeURIComponent(String(requestParameters['jobId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Return the canonical background job results in a readable plain-text format.
+     * Download job results as text
+     */
+    getJobResultsTextRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getJobResultsTextRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            if (this.isJsonMime(response.headers.get('content-type'))) {
+                return new runtime.JSONApiResponse(response);
+            }
+            else {
+                return new runtime.TextApiResponse(response);
+            }
+        });
+    }
+    /**
+     * Return the canonical background job results in a readable plain-text format.
+     * Download job results as text
+     */
+    getJobResultsText(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getJobResultsTextRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for listJobs without sending the request
+     */
+    listJobsRequestOpts(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['jobType'] != null) {
+                queryParameters['job_type'] = requestParameters['jobType'];
+            }
+            if (requestParameters['status'] != null) {
+                queryParameters['status'] = requestParameters['status'];
+            }
+            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/jobs`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Return the authenticated user\'s paginated background job history.
+     * List background jobs
+     */
+    listJobsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.listJobsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response);
+        });
+    }
+    /**
+     * Return the authenticated user\'s paginated background job history.
+     * List background jobs
+     */
+    listJobs() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.listJobsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for scheduleFinderBatch without sending the request
+     */
+    scheduleFinderBatchRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['finderBatchJobRequest'] == null) {
+                throw new runtime.RequiredError('finderBatchJobRequest', 'Required parameter "finderBatchJobRequest" was null or undefined when calling scheduleFinderBatch().');
+            }
+            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/jobs/finder`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: requestParameters['finderBatchJobRequest'],
+            };
+        });
+    }
+    /**
+     * Queue a background finder batch job with an optional deadline and callback URL.
+     * Schedule a finder batch
+     */
+    scheduleFinderBatchRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.scheduleFinderBatchRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response);
+        });
+    }
+    /**
+     * Queue a background finder batch job with an optional deadline and callback URL.
+     * Schedule a finder batch
+     */
+    scheduleFinderBatch(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.scheduleFinderBatchRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for scheduleProbeBatch without sending the request
+     */
+    scheduleProbeBatchRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['probeBatchJobBackgroundRequest'] == null) {
+                throw new runtime.RequiredError('probeBatchJobBackgroundRequest', 'Required parameter "probeBatchJobBackgroundRequest" was null or undefined when calling scheduleProbeBatch().');
+            }
+            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/jobs/probe-batch`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: requestParameters['probeBatchJobBackgroundRequest'],
+            };
+        });
+    }
+    /**
+     * Queue a background probe batch job with an optional deadline and callback URL.
+     * Schedule a probe batch
+     */
+    scheduleProbeBatchRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.scheduleProbeBatchRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response);
+        });
+    }
+    /**
+     * Queue a background probe batch job with an optional deadline and callback URL.
+     * Schedule a probe batch
+     */
+    scheduleProbeBatch(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.scheduleProbeBatchRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.JobsApi = JobsApi;
+/**
+ * @export
+ */
+exports.ListJobsJobTypeEnum = {
+    FinderBatch: 'finder_batch',
+    ProbeBatch: 'probe_batch'
+};
+/**
+ * @export
+ */
+exports.ListJobsStatusEnum = {
+    Queued: 'queued',
+    Processing: 'processing',
+    Completed: 'completed',
+    Failed: 'failed',
+    Canceled: 'canceled'
+};

package/dist/apis/ProbeApi.d.ts

@@ -0,0 +1,52 @@
+/**
+ * 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 { ClientBatchIdentityResponse, ClientIdentityResponse, ProbeBatchRequest, ProbeRequest } from '../models/index';
+export interface ProbeBatchOperationRequest {
+    probeBatchRequest: ProbeBatchRequest;
+}
+export interface ProbeEmailRequest {
+    probeRequest: ProbeRequest;
+}
+/**
+ *
+ */
+export declare class ProbeApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for probeBatch without sending the request
+     */
+    probeBatchRequestOpts(requestParameters: ProbeBatchOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Send many known email addresses and receive compact per-item identity results plus a batch summary.
+     * Verify many email addresses
+     */
+    probeBatchRaw(requestParameters: ProbeBatchOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClientBatchIdentityResponse>>;
+    /**
+     * Send many known email addresses and receive compact per-item identity results plus a batch summary.
+     * Verify many email addresses
+     */
+    probeBatch(requestParameters: ProbeBatchOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClientBatchIdentityResponse>;
+    /**
+     * Creates request options for probeEmail without sending the request
+     */
+    probeEmailRequestOpts(requestParameters: ProbeEmailRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Send a single email address to verify it directly.
+     * Verify an email address
+     */
+    probeEmailRaw(requestParameters: ProbeEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClientIdentityResponse>>;
+    /**
+     * Send a single email address to verify it directly.
+     * Verify an email address
+     */
+    probeEmail(requestParameters: ProbeEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClientIdentityResponse>;
+}