signet-core 1.0.0

package/apis/MandateApi.ts

@@ -0,0 +1,529 @@
+/* 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 {
+  MandateControllerCreateCartMandate201Response,
+  MandateControllerCreateCartMandateRequest,
+  MandateControllerCreateIntentMandateRequest,
+  MandateControllerCreatePaymentMandateRequest,
+  MandateControllerCreateSignedPaymentMandateRequest,
+} from '../models/index';
+import {
+    MandateControllerCreateCartMandate201ResponseFromJSON,
+    MandateControllerCreateCartMandate201ResponseToJSON,
+    MandateControllerCreateCartMandateRequestFromJSON,
+    MandateControllerCreateCartMandateRequestToJSON,
+    MandateControllerCreateIntentMandateRequestFromJSON,
+    MandateControllerCreateIntentMandateRequestToJSON,
+    MandateControllerCreatePaymentMandateRequestFromJSON,
+    MandateControllerCreatePaymentMandateRequestToJSON,
+    MandateControllerCreateSignedPaymentMandateRequestFromJSON,
+    MandateControllerCreateSignedPaymentMandateRequestToJSON,
+} from '../models/index';
+
+export interface MandateControllerCreateCartMandateOperationRequest {
+    mandateControllerCreateCartMandateRequest: MandateControllerCreateCartMandateRequest;
+}
+
+export interface MandateControllerCreateIntentMandateOperationRequest {
+    mandateControllerCreateIntentMandateRequest: MandateControllerCreateIntentMandateRequest;
+}
+
+export interface MandateControllerCreatePaymentMandateOperationRequest {
+    mandateControllerCreatePaymentMandateRequest: MandateControllerCreatePaymentMandateRequest;
+}
+
+export interface MandateControllerCreateSignedPaymentMandateOperationRequest {
+    mandateControllerCreateSignedPaymentMandateRequest: MandateControllerCreateSignedPaymentMandateRequest;
+}
+
+export interface MandateControllerGetMandateRequest {
+    offset?: number;
+    limit?: number;
+    transactionId?: string;
+    payerEmail?: string;
+    merchantName?: string;
+    partnershipId?: string;
+    clientId?: string;
+    status?: string;
+    endDate?: string;
+    startDate?: string;
+    kind?: MandateControllerGetMandateKindEnum;
+    id?: string;
+}
+
+export interface MandateControllerGetMandateByClientIdRequest {
+    clientId: string;
+}
+
+/**
+ * MandateApi - interface
+ * 
+ * @export
+ * @interface MandateApiInterface
+ */
+export interface MandateApiInterface {
+    /**
+     * Creates a cart mandate in Redis for fast UX and stores it in Postgres for persistence.
+     * @summary Create a cart mandate
+     * @param {MandateControllerCreateCartMandateRequest} mandateControllerCreateCartMandateRequest Cart mandate creation request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MandateApiInterface
+     */
+    mandateControllerCreateCartMandateRaw(requestParameters: MandateControllerCreateCartMandateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MandateControllerCreateCartMandate201Response>>;
+
+    /**
+     * Creates a cart mandate in Redis for fast UX and stores it in Postgres for persistence.
+     * Create a cart mandate
+     */
+    mandateControllerCreateCartMandate(requestParameters: MandateControllerCreateCartMandateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MandateControllerCreateCartMandate201Response>;
+
+    /**
+     * Creates an intent mandate in Postgres with status=\'active\'.
+     * @summary Create an intent mandate
+     * @param {MandateControllerCreateIntentMandateRequest} mandateControllerCreateIntentMandateRequest Intent mandate creation request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MandateApiInterface
+     */
+    mandateControllerCreateIntentMandateRaw(requestParameters: MandateControllerCreateIntentMandateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Creates an intent mandate in Postgres with status=\'active\'.
+     * Create an intent mandate
+     */
+    mandateControllerCreateIntentMandate(requestParameters: MandateControllerCreateIntentMandateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Creates a payment mandate in Postgres with status=\'pending\', awaiting user signature.
+     * @summary Create a payment mandate
+     * @param {MandateControllerCreatePaymentMandateRequest} mandateControllerCreatePaymentMandateRequest Payment mandate creation request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MandateApiInterface
+     */
+    mandateControllerCreatePaymentMandateRaw(requestParameters: MandateControllerCreatePaymentMandateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Creates a payment mandate in Postgres with status=\'pending\', awaiting user signature.
+     * Create a payment mandate
+     */
+    mandateControllerCreatePaymentMandate(requestParameters: MandateControllerCreatePaymentMandateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Creates a signed payment mandate by authorizing an existing payment mandate with user signature.
+     * @summary Create a signed payment mandate
+     * @param {MandateControllerCreateSignedPaymentMandateRequest} mandateControllerCreateSignedPaymentMandateRequest Signed payment mandate creation request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MandateApiInterface
+     */
+    mandateControllerCreateSignedPaymentMandateRaw(requestParameters: MandateControllerCreateSignedPaymentMandateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Creates a signed payment mandate by authorizing an existing payment mandate with user signature.
+     * Create a signed payment mandate
+     */
+    mandateControllerCreateSignedPaymentMandate(requestParameters: MandateControllerCreateSignedPaymentMandateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Retrieves mandates based on various search criteria. At least one search parameter must be provided.
+     * @summary Get mandates
+     * @param {number} [offset] Pagination offset (default: 0)
+     * @param {number} [limit] Maximum number of results (1-1000, default: 100)
+     * @param {string} [transactionId] Transaction ID (INTENT mandate ID) to get all mandates in a transaction flow
+     * @param {string} [payerEmail] Payer email
+     * @param {string} [merchantName] Merchant name
+     * @param {string} [partnershipId] Partnership UUID
+     * @param {string} [clientId] Client UUID
+     * @param {string} [status] Mandate status
+     * @param {string} [endDate] End date (ISO 8601)
+     * @param {string} [startDate] Start date (ISO 8601)
+     * @param {'INTENT' | 'CART' | 'PAYMENT' | 'SIGNED_PAYMENT'} [kind] Mandate kind
+     * @param {string} [id] Mandate ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MandateApiInterface
+     */
+    mandateControllerGetMandateRaw(requestParameters: MandateControllerGetMandateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Retrieves mandates based on various search criteria. At least one search parameter must be provided.
+     * Get mandates
+     */
+    mandateControllerGetMandate(requestParameters: MandateControllerGetMandateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Retrieves all mandates for a specific client ID.
+     * @summary Get mandates by client ID
+     * @param {string} clientId Client UUID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MandateApiInterface
+     */
+    mandateControllerGetMandateByClientIdRaw(requestParameters: MandateControllerGetMandateByClientIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Retrieves all mandates for a specific client ID.
+     * Get mandates by client ID
+     */
+    mandateControllerGetMandateByClientId(requestParameters: MandateControllerGetMandateByClientIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+}
+
+/**
+ * 
+ */
+export class MandateApi extends runtime.BaseAPI implements MandateApiInterface {
+
+    /**
+     * Creates a cart mandate in Redis for fast UX and stores it in Postgres for persistence.
+     * Create a cart mandate
+     */
+    async mandateControllerCreateCartMandateRaw(requestParameters: MandateControllerCreateCartMandateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MandateControllerCreateCartMandate201Response>> {
+        if (requestParameters['mandateControllerCreateCartMandateRequest'] == null) {
+            throw new runtime.RequiredError(
+                'mandateControllerCreateCartMandateRequest',
+                'Required parameter "mandateControllerCreateCartMandateRequest" was null or undefined when calling mandateControllerCreateCartMandate().'
+            );
+        }
+
+        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 = `/credentials/v1/mandate/cart`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: MandateControllerCreateCartMandateRequestToJSON(requestParameters['mandateControllerCreateCartMandateRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => MandateControllerCreateCartMandate201ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Creates a cart mandate in Redis for fast UX and stores it in Postgres for persistence.
+     * Create a cart mandate
+     */
+    async mandateControllerCreateCartMandate(requestParameters: MandateControllerCreateCartMandateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MandateControllerCreateCartMandate201Response> {
+        const response = await this.mandateControllerCreateCartMandateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates an intent mandate in Postgres with status=\'active\'.
+     * Create an intent mandate
+     */
+    async mandateControllerCreateIntentMandateRaw(requestParameters: MandateControllerCreateIntentMandateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['mandateControllerCreateIntentMandateRequest'] == null) {
+            throw new runtime.RequiredError(
+                'mandateControllerCreateIntentMandateRequest',
+                'Required parameter "mandateControllerCreateIntentMandateRequest" was null or undefined when calling mandateControllerCreateIntentMandate().'
+            );
+        }
+
+        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 = `/credentials/v1/mandate/intent`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: MandateControllerCreateIntentMandateRequestToJSON(requestParameters['mandateControllerCreateIntentMandateRequest']),
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Creates an intent mandate in Postgres with status=\'active\'.
+     * Create an intent mandate
+     */
+    async mandateControllerCreateIntentMandate(requestParameters: MandateControllerCreateIntentMandateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.mandateControllerCreateIntentMandateRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates a payment mandate in Postgres with status=\'pending\', awaiting user signature.
+     * Create a payment mandate
+     */
+    async mandateControllerCreatePaymentMandateRaw(requestParameters: MandateControllerCreatePaymentMandateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['mandateControllerCreatePaymentMandateRequest'] == null) {
+            throw new runtime.RequiredError(
+                'mandateControllerCreatePaymentMandateRequest',
+                'Required parameter "mandateControllerCreatePaymentMandateRequest" was null or undefined when calling mandateControllerCreatePaymentMandate().'
+            );
+        }
+
+        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 = `/credentials/v1/mandate/payment`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: MandateControllerCreatePaymentMandateRequestToJSON(requestParameters['mandateControllerCreatePaymentMandateRequest']),
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Creates a payment mandate in Postgres with status=\'pending\', awaiting user signature.
+     * Create a payment mandate
+     */
+    async mandateControllerCreatePaymentMandate(requestParameters: MandateControllerCreatePaymentMandateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.mandateControllerCreatePaymentMandateRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates a signed payment mandate by authorizing an existing payment mandate with user signature.
+     * Create a signed payment mandate
+     */
+    async mandateControllerCreateSignedPaymentMandateRaw(requestParameters: MandateControllerCreateSignedPaymentMandateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['mandateControllerCreateSignedPaymentMandateRequest'] == null) {
+            throw new runtime.RequiredError(
+                'mandateControllerCreateSignedPaymentMandateRequest',
+                'Required parameter "mandateControllerCreateSignedPaymentMandateRequest" was null or undefined when calling mandateControllerCreateSignedPaymentMandate().'
+            );
+        }
+
+        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 = `/credentials/v1/mandate/payment/signed`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: MandateControllerCreateSignedPaymentMandateRequestToJSON(requestParameters['mandateControllerCreateSignedPaymentMandateRequest']),
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Creates a signed payment mandate by authorizing an existing payment mandate with user signature.
+     * Create a signed payment mandate
+     */
+    async mandateControllerCreateSignedPaymentMandate(requestParameters: MandateControllerCreateSignedPaymentMandateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.mandateControllerCreateSignedPaymentMandateRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Retrieves mandates based on various search criteria. At least one search parameter must be provided.
+     * Get mandates
+     */
+    async mandateControllerGetMandateRaw(requestParameters: MandateControllerGetMandateRequest, 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'];
+        }
+
+        if (requestParameters['transactionId'] != null) {
+            queryParameters['transactionId'] = requestParameters['transactionId'];
+        }
+
+        if (requestParameters['payerEmail'] != null) {
+            queryParameters['payerEmail'] = requestParameters['payerEmail'];
+        }
+
+        if (requestParameters['merchantName'] != null) {
+            queryParameters['merchantName'] = requestParameters['merchantName'];
+        }
+
+        if (requestParameters['partnershipId'] != null) {
+            queryParameters['partnershipId'] = requestParameters['partnershipId'];
+        }
+
+        if (requestParameters['clientId'] != null) {
+            queryParameters['clientId'] = requestParameters['clientId'];
+        }
+
+        if (requestParameters['status'] != null) {
+            queryParameters['status'] = requestParameters['status'];
+        }
+
+        if (requestParameters['endDate'] != null) {
+            queryParameters['endDate'] = requestParameters['endDate'];
+        }
+
+        if (requestParameters['startDate'] != null) {
+            queryParameters['startDate'] = requestParameters['startDate'];
+        }
+
+        if (requestParameters['kind'] != null) {
+            queryParameters['kind'] = requestParameters['kind'];
+        }
+
+        if (requestParameters['id'] != null) {
+            queryParameters['id'] = requestParameters['id'];
+        }
+
+        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 = `/credentials/v1/mandate`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Retrieves mandates based on various search criteria. At least one search parameter must be provided.
+     * Get mandates
+     */
+    async mandateControllerGetMandate(requestParameters: MandateControllerGetMandateRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.mandateControllerGetMandateRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Retrieves all mandates for a specific client ID.
+     * Get mandates by client ID
+     */
+    async mandateControllerGetMandateByClientIdRaw(requestParameters: MandateControllerGetMandateByClientIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['clientId'] == null) {
+            throw new runtime.RequiredError(
+                'clientId',
+                'Required parameter "clientId" was null or undefined when calling mandateControllerGetMandateByClientId().'
+            );
+        }
+
+        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 = `/credentials/v1/mandate/{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.VoidApiResponse(response);
+    }
+
+    /**
+     * Retrieves all mandates for a specific client ID.
+     * Get mandates by client ID
+     */
+    async mandateControllerGetMandateByClientId(requestParameters: MandateControllerGetMandateByClientIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.mandateControllerGetMandateByClientIdRaw(requestParameters, initOverrides);
+    }
+
+}
+
+/**
+ * @export
+ */
+export const MandateControllerGetMandateKindEnum = {
+    Intent: 'INTENT',
+    Cart: 'CART',
+    Payment: 'PAYMENT',
+    SignedPayment: 'SIGNED_PAYMENT'
+} as const;
+export type MandateControllerGetMandateKindEnum = typeof MandateControllerGetMandateKindEnum[keyof typeof MandateControllerGetMandateKindEnum];