signet-core 1.0.0

package/apis/IpApi.ts

@@ -0,0 +1,322 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Credentials Service API
+ * API documentation for the Credentials service - Mandate and Enrollment endpoints  API documentation for the Fraud service - Blacklist, Device, Geo, IP, Reporting, and Risk endpoints  API documentation for the Partner service - Management endpoints
+ *
+ * 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 {
+  IpControllerFlagIpRequest,
+  IpControllerUnflagIpRequest,
+} from '../models/index';
+import {
+    IpControllerFlagIpRequestFromJSON,
+    IpControllerFlagIpRequestToJSON,
+    IpControllerUnflagIpRequestFromJSON,
+    IpControllerUnflagIpRequestToJSON,
+} from '../models/index';
+
+export interface IpControllerFlagIpOperationRequest {
+    ipControllerFlagIpRequest: IpControllerFlagIpRequest;
+}
+
+export interface IpControllerGetFlaggedIpsRequest {
+    offset?: number;
+    limit?: number;
+}
+
+export interface IpControllerIpCheckForClientRequest {
+    ip: string;
+    clientId: string;
+}
+
+export interface IpControllerUnflagIpOperationRequest {
+    ipControllerUnflagIpRequest: IpControllerUnflagIpRequest;
+}
+
+/**
+ * IpApi - interface
+ * 
+ * @export
+ * @interface IpApiInterface
+ */
+export interface IpApiInterface {
+    /**
+     * Flags an IP address for suspicious activity with specified reasons.
+     * @summary Flag IP address
+     * @param {IpControllerFlagIpRequest} ipControllerFlagIpRequest IP flag request with structured risk reasons
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof IpApiInterface
+     */
+    ipControllerFlagIpRaw(requestParameters: IpControllerFlagIpOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Flags an IP address for suspicious activity with specified reasons.
+     * Flag IP address
+     */
+    ipControllerFlagIp(requestParameters: IpControllerFlagIpOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Retrieves a paginated list of all flagged IP addresses for the organization.
+     * @summary Get all flagged IPs
+     * @param {number} [offset] Pagination offset (default: 0)
+     * @param {number} [limit] Maximum number of results (1-100, default: 20)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof IpApiInterface
+     */
+    ipControllerGetFlaggedIpsRaw(requestParameters: IpControllerGetFlaggedIpsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Retrieves a paginated list of all flagged IP addresses for the organization.
+     * Get all flagged IPs
+     */
+    ipControllerGetFlaggedIps(requestParameters: IpControllerGetFlaggedIpsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Checks if an IP address has been flagged for a specific client.
+     * @summary Check if IP is flagged for client
+     * @param {string} ip 
+     * @param {string} clientId 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof IpApiInterface
+     */
+    ipControllerIpCheckForClientRaw(requestParameters: IpControllerIpCheckForClientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Checks if an IP address has been flagged for a specific client.
+     * Check if IP is flagged for client
+     */
+    ipControllerIpCheckForClient(requestParameters: IpControllerIpCheckForClientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Removes a flag from an IP address, clearing it from the flagged IPs list.
+     * @summary Unflag IP address
+     * @param {IpControllerUnflagIpRequest} ipControllerUnflagIpRequest IP unflag request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof IpApiInterface
+     */
+    ipControllerUnflagIpRaw(requestParameters: IpControllerUnflagIpOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Removes a flag from an IP address, clearing it from the flagged IPs list.
+     * Unflag IP address
+     */
+    ipControllerUnflagIp(requestParameters: IpControllerUnflagIpOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+}
+
+/**
+ * 
+ */
+export class IpApi extends runtime.BaseAPI implements IpApiInterface {
+
+    /**
+     * Flags an IP address for suspicious activity with specified reasons.
+     * Flag IP address
+     */
+    async ipControllerFlagIpRaw(requestParameters: IpControllerFlagIpOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['ipControllerFlagIpRequest'] == null) {
+            throw new runtime.RequiredError(
+                'ipControllerFlagIpRequest',
+                'Required parameter "ipControllerFlagIpRequest" was null or undefined when calling ipControllerFlagIp().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("DPoP", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/fraud/v1/ip`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: IpControllerFlagIpRequestToJSON(requestParameters['ipControllerFlagIpRequest']),
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Flags an IP address for suspicious activity with specified reasons.
+     * Flag IP address
+     */
+    async ipControllerFlagIp(requestParameters: IpControllerFlagIpOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.ipControllerFlagIpRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Retrieves a paginated list of all flagged IP addresses for the organization.
+     * Get all flagged IPs
+     */
+    async ipControllerGetFlaggedIpsRaw(requestParameters: IpControllerGetFlaggedIpsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const queryParameters: any = {};
+
+        if (requestParameters['offset'] != null) {
+            queryParameters['offset'] = requestParameters['offset'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("DPoP", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/fraud/v1/ip/all`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Retrieves a paginated list of all flagged IP addresses for the organization.
+     * Get all flagged IPs
+     */
+    async ipControllerGetFlaggedIps(requestParameters: IpControllerGetFlaggedIpsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.ipControllerGetFlaggedIpsRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Checks if an IP address has been flagged for a specific client.
+     * Check if IP is flagged for client
+     */
+    async ipControllerIpCheckForClientRaw(requestParameters: IpControllerIpCheckForClientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['ip'] == null) {
+            throw new runtime.RequiredError(
+                'ip',
+                'Required parameter "ip" was null or undefined when calling ipControllerIpCheckForClient().'
+            );
+        }
+
+        if (requestParameters['clientId'] == null) {
+            throw new runtime.RequiredError(
+                'clientId',
+                'Required parameter "clientId" was null or undefined when calling ipControllerIpCheckForClient().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("DPoP", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/fraud/v1/ip/{ip}/{clientId}`;
+        urlPath = urlPath.replace(`{${"ip"}}`, encodeURIComponent(String(requestParameters['ip'])));
+        urlPath = urlPath.replace(`{${"clientId"}}`, encodeURIComponent(String(requestParameters['clientId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Checks if an IP address has been flagged for a specific client.
+     * Check if IP is flagged for client
+     */
+    async ipControllerIpCheckForClient(requestParameters: IpControllerIpCheckForClientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.ipControllerIpCheckForClientRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Removes a flag from an IP address, clearing it from the flagged IPs list.
+     * Unflag IP address
+     */
+    async ipControllerUnflagIpRaw(requestParameters: IpControllerUnflagIpOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['ipControllerUnflagIpRequest'] == null) {
+            throw new runtime.RequiredError(
+                'ipControllerUnflagIpRequest',
+                'Required parameter "ipControllerUnflagIpRequest" was null or undefined when calling ipControllerUnflagIp().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("DPoP", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/fraud/v1/ip`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+            body: IpControllerUnflagIpRequestToJSON(requestParameters['ipControllerUnflagIpRequest']),
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Removes a flag from an IP address, clearing it from the flagged IPs list.
+     * Unflag IP address
+     */
+    async ipControllerUnflagIp(requestParameters: IpControllerUnflagIpOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.ipControllerUnflagIpRaw(requestParameters, initOverrides);
+    }
+
+}