signet-core 1.0.0

package/apis/PartnerApi.ts

@@ -0,0 +1,442 @@
+/* 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 {
+  ManagementControllerAllClients200Response,
+  ManagementControllerAllClients400Response,
+  ManagementControllerAllClients404Response,
+  ManagementControllerAllClients500Response,
+  ManagementControllerGetClient200Response,
+  ManagementControllerGetClient400Response,
+  ManagementControllerGetClient404Response,
+  ManagementControllerGetClient500Response,
+  ManagementControllerRegisterClient201Response,
+  ManagementControllerRegisterClient400Response,
+  ManagementControllerRegisterClient409Response,
+  ManagementControllerRegisterClient500Response,
+  ManagementControllerRegisterClientRequest,
+  ManagementControllerRemoveClient200Response,
+  ManagementControllerRemoveClient400Response,
+  ManagementControllerRemoveClient500Response,
+  ManagementControllerRemoveClientRequest,
+  ManagementControllerUpdateClient200Response,
+  ManagementControllerUpdateClient400Response,
+  ManagementControllerUpdateClient500Response,
+  ManagementControllerUpdateClientRequest,
+} from '../models/index';
+import {
+    ManagementControllerAllClients200ResponseFromJSON,
+    ManagementControllerAllClients200ResponseToJSON,
+    ManagementControllerAllClients400ResponseFromJSON,
+    ManagementControllerAllClients400ResponseToJSON,
+    ManagementControllerAllClients404ResponseFromJSON,
+    ManagementControllerAllClients404ResponseToJSON,
+    ManagementControllerAllClients500ResponseFromJSON,
+    ManagementControllerAllClients500ResponseToJSON,
+    ManagementControllerGetClient200ResponseFromJSON,
+    ManagementControllerGetClient200ResponseToJSON,
+    ManagementControllerGetClient400ResponseFromJSON,
+    ManagementControllerGetClient400ResponseToJSON,
+    ManagementControllerGetClient404ResponseFromJSON,
+    ManagementControllerGetClient404ResponseToJSON,
+    ManagementControllerGetClient500ResponseFromJSON,
+    ManagementControllerGetClient500ResponseToJSON,
+    ManagementControllerRegisterClient201ResponseFromJSON,
+    ManagementControllerRegisterClient201ResponseToJSON,
+    ManagementControllerRegisterClient400ResponseFromJSON,
+    ManagementControllerRegisterClient400ResponseToJSON,
+    ManagementControllerRegisterClient409ResponseFromJSON,
+    ManagementControllerRegisterClient409ResponseToJSON,
+    ManagementControllerRegisterClient500ResponseFromJSON,
+    ManagementControllerRegisterClient500ResponseToJSON,
+    ManagementControllerRegisterClientRequestFromJSON,
+    ManagementControllerRegisterClientRequestToJSON,
+    ManagementControllerRemoveClient200ResponseFromJSON,
+    ManagementControllerRemoveClient200ResponseToJSON,
+    ManagementControllerRemoveClient400ResponseFromJSON,
+    ManagementControllerRemoveClient400ResponseToJSON,
+    ManagementControllerRemoveClient500ResponseFromJSON,
+    ManagementControllerRemoveClient500ResponseToJSON,
+    ManagementControllerRemoveClientRequestFromJSON,
+    ManagementControllerRemoveClientRequestToJSON,
+    ManagementControllerUpdateClient200ResponseFromJSON,
+    ManagementControllerUpdateClient200ResponseToJSON,
+    ManagementControllerUpdateClient400ResponseFromJSON,
+    ManagementControllerUpdateClient400ResponseToJSON,
+    ManagementControllerUpdateClient500ResponseFromJSON,
+    ManagementControllerUpdateClient500ResponseToJSON,
+    ManagementControllerUpdateClientRequestFromJSON,
+    ManagementControllerUpdateClientRequestToJSON,
+} from '../models/index';
+
+export interface ManagementControllerAllClientsRequest {
+    limit?: number;
+    offset?: number;
+}
+
+export interface ManagementControllerGetClientRequest {
+    clientId: string;
+}
+
+export interface ManagementControllerRegisterClientOperationRequest {
+    managementControllerRegisterClientRequest: ManagementControllerRegisterClientRequest;
+}
+
+export interface ManagementControllerRemoveClientOperationRequest {
+    managementControllerRemoveClientRequest: ManagementControllerRemoveClientRequest;
+}
+
+export interface ManagementControllerUpdateClientOperationRequest {
+    managementControllerUpdateClientRequest: ManagementControllerUpdateClientRequest;
+}
+
+/**
+ * PartnerApi - interface
+ * 
+ * @export
+ * @interface PartnerApiInterface
+ */
+export interface PartnerApiInterface {
+    /**
+     * The all-clients endpoint retrieves a paginated list of all clients under the authenticated organization. It supports offset and limit parameters for pagination and returns client details including ID, name, email, status, and timestamps.
+     * @summary Get All Clients
+     * @param {number} [limit] Maximum number of results - The maximum number of clients to return per page, between 1 and 100 (number, default: 20)
+     * @param {number} [offset] Pagination offset - The number of records to skip before starting to return results (number, default: 0)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerApiInterface
+     */
+    managementControllerAllClientsRaw(requestParameters: ManagementControllerAllClientsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ManagementControllerAllClients200Response>>;
+
+    /**
+     * The all-clients endpoint retrieves a paginated list of all clients under the authenticated organization. It supports offset and limit parameters for pagination and returns client details including ID, name, email, status, and timestamps.
+     * Get All Clients
+     */
+    managementControllerAllClients(requestParameters: ManagementControllerAllClientsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ManagementControllerAllClients200Response>;
+
+    /**
+     * The get-client endpoint retrieves detailed information for a specific client by their UUID. It verifies the client belongs to the authenticated organization and returns the client\'s ID, name, email, status, registration date, and last update timestamp.
+     * @summary Get Client by ID
+     * @param {string} clientId Client UUID - The unique identifier of the client to retrieve (string, UUID format)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerApiInterface
+     */
+    managementControllerGetClientRaw(requestParameters: ManagementControllerGetClientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ManagementControllerGetClient200Response>>;
+
+    /**
+     * The get-client endpoint retrieves detailed information for a specific client by their UUID. It verifies the client belongs to the authenticated organization and returns the client\'s ID, name, email, status, registration date, and last update timestamp.
+     * Get Client by ID
+     */
+    managementControllerGetClient(requestParameters: ManagementControllerGetClientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ManagementControllerGetClient200Response>;
+
+    /**
+     * The register-client endpoint lets partners add new clients by name and email. It prevents duplicates, creates an active client record, and returns the client\'s ID, name, email, status, and registration details.
+     * @summary Register Client
+     * @param {ManagementControllerRegisterClientRequest} managementControllerRegisterClientRequest Client registration data
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerApiInterface
+     */
+    managementControllerRegisterClientRaw(requestParameters: ManagementControllerRegisterClientOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ManagementControllerRegisterClient201Response>>;
+
+    /**
+     * The register-client endpoint lets partners add new clients by name and email. It prevents duplicates, creates an active client record, and returns the client\'s ID, name, email, status, and registration details.
+     * Register Client
+     */
+    managementControllerRegisterClient(requestParameters: ManagementControllerRegisterClientOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ManagementControllerRegisterClient201Response>;
+
+    /**
+     * The remove-client endpoint soft deletes a client from the system by marking it as deleted. It verifies the client belongs to the organization, updates the client status to deleted, sends a removal webhook, and returns a success confirmation. The client record is not permanently removed from the database.
+     * @summary Remove Client
+     * @param {ManagementControllerRemoveClientRequest} managementControllerRemoveClientRequest Client removal request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerApiInterface
+     */
+    managementControllerRemoveClientRaw(requestParameters: ManagementControllerRemoveClientOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ManagementControllerRemoveClient200Response>>;
+
+    /**
+     * The remove-client endpoint soft deletes a client from the system by marking it as deleted. It verifies the client belongs to the organization, updates the client status to deleted, sends a removal webhook, and returns a success confirmation. The client record is not permanently removed from the database.
+     * Remove Client
+     */
+    managementControllerRemoveClient(requestParameters: ManagementControllerRemoveClientOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ManagementControllerRemoveClient200Response>;
+
+    /**
+     * The update-client endpoint allows partners to modify an existing client\'s information including name, email, or status. It validates the client belongs to the organization, checks for email uniqueness, updates the specified fields, and returns the updated client data.
+     * @summary Update Client
+     * @param {ManagementControllerUpdateClientRequest} managementControllerUpdateClientRequest Client update data
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerApiInterface
+     */
+    managementControllerUpdateClientRaw(requestParameters: ManagementControllerUpdateClientOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ManagementControllerUpdateClient200Response>>;
+
+    /**
+     * The update-client endpoint allows partners to modify an existing client\'s information including name, email, or status. It validates the client belongs to the organization, checks for email uniqueness, updates the specified fields, and returns the updated client data.
+     * Update Client
+     */
+    managementControllerUpdateClient(requestParameters: ManagementControllerUpdateClientOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ManagementControllerUpdateClient200Response>;
+
+}
+
+/**
+ * 
+ */
+export class PartnerApi extends runtime.BaseAPI implements PartnerApiInterface {
+
+    /**
+     * The all-clients endpoint retrieves a paginated list of all clients under the authenticated organization. It supports offset and limit parameters for pagination and returns client details including ID, name, email, status, and timestamps.
+     * Get All Clients
+     */
+    async managementControllerAllClientsRaw(requestParameters: ManagementControllerAllClientsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ManagementControllerAllClients200Response>> {
+        const queryParameters: any = {};
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        if (requestParameters['offset'] != null) {
+            queryParameters['offset'] = requestParameters['offset'];
+        }
+
+        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 = `/partner/v1/all-clients`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ManagementControllerAllClients200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * The all-clients endpoint retrieves a paginated list of all clients under the authenticated organization. It supports offset and limit parameters for pagination and returns client details including ID, name, email, status, and timestamps.
+     * Get All Clients
+     */
+    async managementControllerAllClients(requestParameters: ManagementControllerAllClientsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ManagementControllerAllClients200Response> {
+        const response = await this.managementControllerAllClientsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * The get-client endpoint retrieves detailed information for a specific client by their UUID. It verifies the client belongs to the authenticated organization and returns the client\'s ID, name, email, status, registration date, and last update timestamp.
+     * Get Client by ID
+     */
+    async managementControllerGetClientRaw(requestParameters: ManagementControllerGetClientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ManagementControllerGetClient200Response>> {
+        if (requestParameters['clientId'] == null) {
+            throw new runtime.RequiredError(
+                'clientId',
+                'Required parameter "clientId" was null or undefined when calling managementControllerGetClient().'
+            );
+        }
+
+        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 = `/partner/v1/get-client/{clientId}`;
+        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.JSONApiResponse(response, (jsonValue) => ManagementControllerGetClient200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * The get-client endpoint retrieves detailed information for a specific client by their UUID. It verifies the client belongs to the authenticated organization and returns the client\'s ID, name, email, status, registration date, and last update timestamp.
+     * Get Client by ID
+     */
+    async managementControllerGetClient(requestParameters: ManagementControllerGetClientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ManagementControllerGetClient200Response> {
+        const response = await this.managementControllerGetClientRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * The register-client endpoint lets partners add new clients by name and email. It prevents duplicates, creates an active client record, and returns the client\'s ID, name, email, status, and registration details.
+     * Register Client
+     */
+    async managementControllerRegisterClientRaw(requestParameters: ManagementControllerRegisterClientOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ManagementControllerRegisterClient201Response>> {
+        if (requestParameters['managementControllerRegisterClientRequest'] == null) {
+            throw new runtime.RequiredError(
+                'managementControllerRegisterClientRequest',
+                'Required parameter "managementControllerRegisterClientRequest" was null or undefined when calling managementControllerRegisterClient().'
+            );
+        }
+
+        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 = `/partner/v1/register-client`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ManagementControllerRegisterClientRequestToJSON(requestParameters['managementControllerRegisterClientRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ManagementControllerRegisterClient201ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * The register-client endpoint lets partners add new clients by name and email. It prevents duplicates, creates an active client record, and returns the client\'s ID, name, email, status, and registration details.
+     * Register Client
+     */
+    async managementControllerRegisterClient(requestParameters: ManagementControllerRegisterClientOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ManagementControllerRegisterClient201Response> {
+        const response = await this.managementControllerRegisterClientRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * The remove-client endpoint soft deletes a client from the system by marking it as deleted. It verifies the client belongs to the organization, updates the client status to deleted, sends a removal webhook, and returns a success confirmation. The client record is not permanently removed from the database.
+     * Remove Client
+     */
+    async managementControllerRemoveClientRaw(requestParameters: ManagementControllerRemoveClientOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ManagementControllerRemoveClient200Response>> {
+        if (requestParameters['managementControllerRemoveClientRequest'] == null) {
+            throw new runtime.RequiredError(
+                'managementControllerRemoveClientRequest',
+                'Required parameter "managementControllerRemoveClientRequest" was null or undefined when calling managementControllerRemoveClient().'
+            );
+        }
+
+        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 = `/partner/v1/remove-client`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ManagementControllerRemoveClientRequestToJSON(requestParameters['managementControllerRemoveClientRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ManagementControllerRemoveClient200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * The remove-client endpoint soft deletes a client from the system by marking it as deleted. It verifies the client belongs to the organization, updates the client status to deleted, sends a removal webhook, and returns a success confirmation. The client record is not permanently removed from the database.
+     * Remove Client
+     */
+    async managementControllerRemoveClient(requestParameters: ManagementControllerRemoveClientOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ManagementControllerRemoveClient200Response> {
+        const response = await this.managementControllerRemoveClientRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * The update-client endpoint allows partners to modify an existing client\'s information including name, email, or status. It validates the client belongs to the organization, checks for email uniqueness, updates the specified fields, and returns the updated client data.
+     * Update Client
+     */
+    async managementControllerUpdateClientRaw(requestParameters: ManagementControllerUpdateClientOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ManagementControllerUpdateClient200Response>> {
+        if (requestParameters['managementControllerUpdateClientRequest'] == null) {
+            throw new runtime.RequiredError(
+                'managementControllerUpdateClientRequest',
+                'Required parameter "managementControllerUpdateClientRequest" was null or undefined when calling managementControllerUpdateClient().'
+            );
+        }
+
+        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 = `/partner/v1/update-client`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ManagementControllerUpdateClientRequestToJSON(requestParameters['managementControllerUpdateClientRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ManagementControllerUpdateClient200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * The update-client endpoint allows partners to modify an existing client\'s information including name, email, or status. It validates the client belongs to the organization, checks for email uniqueness, updates the specified fields, and returns the updated client data.
+     * Update Client
+     */
+    async managementControllerUpdateClient(requestParameters: ManagementControllerUpdateClientOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ManagementControllerUpdateClient200Response> {
+        const response = await this.managementControllerUpdateClientRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}