@domu-ai/kiban-sdk 1.72.0

package/public/schemas.js

@@ -0,0 +1,455 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProcessSwervePayPaymentResponse = exports.ProcessSwervePayPaymentBody = exports.ProcessSpeedPayPaymentResponse = exports.ProcessSpeedPayPaymentBody = exports.ProcessRepayPaymentResponse = exports.ProcessRepayPaymentBody = exports.ProcessPayrazrPaymentResponse = exports.ProcessPayrazrPaymentBody = exports.ProcessPNMPaymentResponse = exports.ProcessPNMPaymentBody = exports.ProcessPayliancePaymentResponse = exports.ProcessPayliancePaymentBody = exports.ProcessMonerisPaymentResponse = exports.ProcessMonerisPaymentBody = exports.UpdateContactResponse = exports.UpdateContactBody = exports.UpdateContactQueryParams = exports.UpdateContactParams = exports.GetContactResponse = exports.GetContactQueryParams = exports.GetContactParams = exports.CreateAloricaNoteResponse = exports.CreateAloricaNoteBody = exports.CreateAloricaNoteQueryParams = exports.GetDebtsResponse = exports.GetDebtsQueryParams = exports.getDebtsQueryIncludeOffersDefault = exports.GetDebtsParams = exports.EndResponse = exports.EndBody = exports.StartBody = exports.startBodyTypeDefault = exports.startBodyPhoneNumberRegExp = exports.MeResponse = exports.CheckResponse = void 0;
+/**
+ * Generated by orval v8.2.0 🍺
+ * Do not edit manually.
+ * Kiban API
+ * REST API for application integration. Production-ready endpoints with enterprise-grade reliability.
+ * OpenAPI spec version: 1.0.0
+ */
+const zod = __importStar(require("zod"));
+/**
+ * Lightweight endpoint that returns 200 OK when the service is operational. Designed for load balancers, uptime monitors, and client-side connectivity checks. Does not perform dependency validation.
+ * @summary Basic service availability check
+ */
+exports.CheckResponse = zod.object({
+    "status": zod.enum(['ok']).describe('Service operational status - always returns \'ok\' when available'),
+    "timestamp": zod.string().describe('ISO 8601 UTC timestamp of health check execution')
+});
+/**
+ * Returns the authenticated user information including userId, sessionId, and organization details. Requires valid Bearer token in Authorization header.
+ * @summary Get authenticated user information
+ */
+exports.MeResponse = zod.object({
+    "userId": zod.string().describe('Authenticated user identifier'),
+    "sessionId": zod.string().describe('Current session identifier'),
+    "orgId": zod.string().nullable().describe('Organization identifier if present'),
+    "orgRole": zod.string().nullable().describe('User\'s role in the organization')
+});
+/**
+ * Initiates an interaction session with Nubank for a customer. Returns a sourceId that must be used to end the interaction.
+ * @summary Start a Nubank customer interaction
+ */
+exports.startBodyPhoneNumberRegExp = new RegExp('^\\d+$');
+exports.startBodyTypeDefault = `ai-voice-dialer`;
+exports.StartBody = zod.object({
+    "customerId": zod.string().min(1),
+    "phoneNumber": zod.string().min(1).regex(exports.startBodyPhoneNumberRegExp),
+    "type": zod.string().default(exports.startBodyTypeDefault)
+});
+/**
+ * Closes an interaction session with Nubank. The sourceId from the start interaction must be provided.
+ * @summary End a Nubank customer interaction
+ */
+exports.EndBody = zod.object({
+    "sourceId": zod.string().min(1),
+    "customerId": zod.string().min(1)
+});
+exports.EndResponse = zod.object({
+    "success": zod.boolean()
+});
+/**
+ * Retrieves debts for a Nubank customer. Optionally includes available payment offers when include_offers=true.
+ * @summary Get customer debts
+ */
+exports.GetDebtsParams = zod.object({
+    "customerId": zod.string().min(1)
+});
+exports.getDebtsQueryIncludeOffersDefault = false;
+exports.GetDebtsQueryParams = zod.object({
+    "include_offers": zod.boolean().default(exports.getDebtsQueryIncludeOffersDefault)
+});
+exports.GetDebtsResponse = zod.union([zod.object({
+        "customerId": zod.string(),
+        "debts": zod.union([zod.array(zod.object({
+                "late": zod.string().optional(),
+                "start": zod.string().optional(),
+                "total": zod.string().optional(),
+                "current": zod.string().optional(),
+                "principal": zod.string().optional(),
+                "days_late": zod.number().optional(),
+                "product": zod.object({
+                    "type": zod.string(),
+                    "reference_id": zod.string()
+                }).optional()
+            })), zod.object({
+                "error": zod.string(),
+                "statusCode": zod.string().optional()
+            })])
+    }), zod.object({
+        "customerId": zod.string(),
+        "debts": zod.union([zod.array(zod.object({
+                "late": zod.string().optional(),
+                "start": zod.string().optional(),
+                "total": zod.string().optional(),
+                "current": zod.string().optional(),
+                "principal": zod.string().optional(),
+                "days_late": zod.number().optional(),
+                "product": zod.object({
+                    "type": zod.string(),
+                    "reference_id": zod.string()
+                }).optional()
+            })), zod.object({
+                "error": zod.string(),
+                "statusCode": zod.string().optional()
+            })]),
+        "offers": zod.union([zod.array(zod.object({
+                "type": zod.string(),
+                "offers": zod.object({
+                    "single_payment": zod.object({
+                        "debt": zod.string(),
+                        "discount": zod.string(),
+                        "discount_percentage": zod.string(),
+                        "downpayment": zod.string(),
+                        "downpayment_due_date": zod.string(),
+                        "simulation_id": zod.string(),
+                        "created_at": zod.string()
+                    }).optional(),
+                    "installments": zod.object({
+                        "downpayment": zod.string(),
+                        "downpayment_due_date": zod.string(),
+                        "has_installments_boleto": zod.boolean(),
+                        "first_installment_due_date": zod.string(),
+                        "due_day": zod.number(),
+                        "created_at": zod.string(),
+                        "installment_options": zod.array(zod.object({
+                            "simulation_id": zod.string(),
+                            "number_of_installments": zod.number(),
+                            "installment_amount": zod.string(),
+                            "debt": zod.string(),
+                            "discount_percentage": zod.string(),
+                            "total_to_pay": zod.string(),
+                            "iof": zod.string(),
+                            "interest_rate": zod.string(),
+                            "interest": zod.string(),
+                            "discount": zod.string(),
+                            "monthly_cet": zod.string(),
+                            "yearly_cet": zod.string()
+                        }))
+                    }).optional()
+                }),
+                "product": zod.object({
+                    "type": zod.string(),
+                    "reference_id": zod.string()
+                })
+            })), zod.object({
+                "error": zod.string(),
+                "statusCode": zod.string().optional()
+            })])
+    })]);
+/**
+ * Creates a call result note in SST Loan Services for Domu.AI integration.
+ * @summary Create note in SST
+ */
+exports.CreateAloricaNoteQueryParams = zod.object({
+    "campaignId": zod.string().min(1)
+});
+exports.CreateAloricaNoteBody = zod.object({
+    "phoneNumber": zod.string().min(1),
+    "result": zod.enum(['PAYMENT', 'PROMISE', 'PAYOFF_QUOTE_REQUEST', 'ACCOUNT_INQUIRY', 'ACCOUNT_UNLOCK', 'GENERAL']),
+    "note": zod.string().min(1)
+});
+exports.CreateAloricaNoteResponse = zod.object({
+    "returnMessage": zod.enum(['OK', 'INVALID_ACCOUNT_NUMBER', 'INVALID_RESULT_TYPE', 'INTERNAL'])
+});
+/**
+ * @summary Get a contact by ID
+ */
+exports.GetContactParams = zod.object({
+    "id": zod.string()
+});
+exports.GetContactQueryParams = zod.object({
+    "campaignId": zod.string()
+});
+exports.GetContactResponse = zod.object({
+    "contactId": zod.string(),
+    "contact": zod.record(zod.string(), zod.unknown())
+});
+/**
+ * @summary Update contact disposition data by ID
+ */
+exports.UpdateContactParams = zod.object({
+    "id": zod.string()
+});
+exports.UpdateContactQueryParams = zod.object({
+    "campaignId": zod.string()
+});
+exports.UpdateContactBody = zod.object({
+    "resultCode": zod.string().optional(),
+    "attributes": zod.record(zod.string(), zod.string().nullable()).optional()
+});
+exports.UpdateContactResponse = zod.object({
+    "contactId": zod.string()
+});
+/**
+ * Moneris Generic Payment Connector
+ * @summary Process an end-to-end Moneris payment
+ */
+exports.ProcessMonerisPaymentBody = zod.object({
+    "transaction_id": zod.string(),
+    "amount": zod.string(),
+    "currency_code": zod.string().optional(),
+    "method": zod.string().optional(),
+    "description": zod.string().nullish(),
+    "cardnumber": zod.string().optional(),
+    "cvv": zod.string().optional(),
+    "expiry_month": zod.string().optional(),
+    "expiry_year": zod.string().optional(),
+    "postal_code": zod.string().nullish(),
+    "bankaccountnumber": zod.string().optional(),
+    "routing_number": zod.string().optional(),
+    "account_type": zod.string().optional(),
+    "parameters": zod.object({
+        "campaignid": zod.string(),
+        "callerphone": zod.string(),
+        "sessionid": zod.string().optional(),
+        "payment_method_id": zod.string().optional(),
+        "paymentdate": zod.string().optional(),
+        "planfrequency": zod.string().optional(),
+        "plantype": zod.string().optional(),
+        "numberofpayments": zod.string().optional()
+    })
+});
+exports.ProcessMonerisPaymentResponse = zod.object({
+    "charge_id": zod.string(),
+    "error_code": zod.string().nullable(),
+    "error_message": zod.string().nullable()
+});
+/**
+ * Payliance Generic Payment Connector
+ * @summary Process a Payliance card verify, tokenize, and optional payment delegate
+ */
+exports.ProcessPayliancePaymentBody = zod.object({
+    "transaction_id": zod.string(),
+    "amount": zod.string(),
+    "currency_code": zod.string().optional(),
+    "method": zod.string().optional(),
+    "description": zod.string().nullish(),
+    "cardnumber": zod.string().optional(),
+    "cvv": zod.string().optional(),
+    "expiry_month": zod.string().optional(),
+    "expiry_year": zod.string().optional(),
+    "postal_code": zod.string().nullish(),
+    "bankaccountnumber": zod.string().optional(),
+    "routing_number": zod.string().optional(),
+    "account_type": zod.string().optional(),
+    "parameters": zod.object({
+        "campaignid": zod.string(),
+        "callerphone": zod.string(),
+        "sessionid": zod.string().optional(),
+        "payment_method_id": zod.string().optional(),
+        "paymentdate": zod.string().optional(),
+        "planfrequency": zod.string().optional(),
+        "plantype": zod.string().optional(),
+        "numberofpayments": zod.string().optional()
+    })
+});
+exports.ProcessPayliancePaymentResponse = zod.object({
+    "charge_id": zod.string(),
+    "error_code": zod.string().nullable(),
+    "error_message": zod.string().nullable()
+});
+/**
+ * Accepts Twilio Generic Pay Connector JSON callback. Orchestrates the full PayNearMe payment flow: resolves target by phone, finds or creates an order, reconciles amounts, tokenizes payment method, and processes payment.
+ * @summary Process an end-to-end PayNearMe payment
+ */
+exports.ProcessPNMPaymentBody = zod.object({
+    "transaction_id": zod.string(),
+    "amount": zod.string(),
+    "currency_code": zod.string().optional(),
+    "method": zod.string().optional(),
+    "description": zod.string().nullish(),
+    "cardnumber": zod.string().optional(),
+    "cvv": zod.string().optional(),
+    "expiry_month": zod.string().optional(),
+    "expiry_year": zod.string().optional(),
+    "postal_code": zod.string().nullish(),
+    "bankaccountnumber": zod.string().optional(),
+    "routing_number": zod.string().optional(),
+    "account_type": zod.string().optional(),
+    "parameters": zod.object({
+        "campaignid": zod.string(),
+        "callerphone": zod.string(),
+        "sessionid": zod.string().optional(),
+        "payment_method_id": zod.string().optional(),
+        "paymentdate": zod.string().optional(),
+        "planfrequency": zod.string().optional(),
+        "plantype": zod.string().optional(),
+        "numberofpayments": zod.string().optional()
+    })
+});
+exports.ProcessPNMPaymentResponse = zod.object({
+    "charge_id": zod.string(),
+    "error_code": zod.string().nullable(),
+    "error_message": zod.string().nullable()
+});
+/**
+ * Payrazr Generic Payment Connector
+ * @summary Process a Payrazr card or ACH payment with customer resolution and fee calculation
+ */
+exports.ProcessPayrazrPaymentBody = zod.object({
+    "transaction_id": zod.string(),
+    "amount": zod.string(),
+    "currency_code": zod.string().optional(),
+    "method": zod.string().optional(),
+    "description": zod.string().nullish(),
+    "cardnumber": zod.string().optional(),
+    "cvv": zod.string().optional(),
+    "expiry_month": zod.string().optional(),
+    "expiry_year": zod.string().optional(),
+    "postal_code": zod.string().nullish(),
+    "bankaccountnumber": zod.string().optional(),
+    "routing_number": zod.string().optional(),
+    "account_type": zod.string().optional(),
+    "parameters": zod.object({
+        "campaignid": zod.string(),
+        "callerphone": zod.string(),
+        "sessionid": zod.string().optional(),
+        "payment_method_id": zod.string().optional(),
+        "paymentdate": zod.string().optional(),
+        "planfrequency": zod.string().optional(),
+        "plantype": zod.string().optional(),
+        "numberofpayments": zod.string().optional()
+    })
+});
+exports.ProcessPayrazrPaymentResponse = zod.object({
+    "charge_id": zod.string(),
+    "error_code": zod.string().nullable(),
+    "error_message": zod.string().nullable()
+});
+/**
+ * Repay Generic Payment Connector
+ * @summary Process an end-to-end Repay payment
+ */
+exports.ProcessRepayPaymentBody = zod.object({
+    "transaction_id": zod.string(),
+    "amount": zod.string(),
+    "currency_code": zod.string().optional(),
+    "method": zod.string().optional(),
+    "description": zod.string().nullish(),
+    "cardnumber": zod.string().optional(),
+    "cvv": zod.string().optional(),
+    "expiry_month": zod.string().optional(),
+    "expiry_year": zod.string().optional(),
+    "postal_code": zod.string().nullish(),
+    "bankaccountnumber": zod.string().optional(),
+    "routing_number": zod.string().optional(),
+    "account_type": zod.string().optional(),
+    "parameters": zod.object({
+        "campaignid": zod.string(),
+        "callerphone": zod.string(),
+        "sessionid": zod.string().optional(),
+        "payment_method_id": zod.string().optional(),
+        "paymentdate": zod.string().optional(),
+        "planfrequency": zod.string().optional(),
+        "plantype": zod.string().optional(),
+        "numberofpayments": zod.string().optional()
+    })
+});
+exports.ProcessRepayPaymentResponse = zod.object({
+    "charge_id": zod.string(),
+    "error_code": zod.string().nullable(),
+    "error_message": zod.string().nullable()
+});
+/**
+ * Accepts Twilio Generic Pay Connector JSON callback. Resolves target by phone, determines funding account (existing via payment_method_id or new card/ACH), and processes payment through SpeedPay.
+ * @summary Process an end-to-end SpeedPay payment
+ */
+exports.ProcessSpeedPayPaymentBody = zod.object({
+    "transaction_id": zod.string(),
+    "amount": zod.string(),
+    "currency_code": zod.string().optional(),
+    "method": zod.string().optional(),
+    "description": zod.string().nullish(),
+    "cardnumber": zod.string().optional(),
+    "cvv": zod.string().optional(),
+    "expiry_month": zod.string().optional(),
+    "expiry_year": zod.string().optional(),
+    "postal_code": zod.string().nullish(),
+    "bankaccountnumber": zod.string().optional(),
+    "routing_number": zod.string().optional(),
+    "account_type": zod.string().optional(),
+    "parameters": zod.object({
+        "campaignid": zod.string(),
+        "callerphone": zod.string(),
+        "sessionid": zod.string().optional(),
+        "payment_method_id": zod.string().optional(),
+        "paymentdate": zod.string().optional(),
+        "planfrequency": zod.string().optional(),
+        "plantype": zod.string().optional(),
+        "numberofpayments": zod.string().optional()
+    })
+});
+exports.ProcessSpeedPayPaymentResponse = zod.object({
+    "charge_id": zod.string(),
+    "error_code": zod.string().nullable(),
+    "error_message": zod.string().nullable()
+});
+/**
+ * Accepts Twilio Generic Pay Connector JSON callback. Resolves target by phone, processes payment through SwervePay, and returns charge_id or error.
+ * @summary Process an end-to-end SwervePay payment
+ */
+exports.ProcessSwervePayPaymentBody = zod.object({
+    "transaction_id": zod.string(),
+    "amount": zod.string(),
+    "currency_code": zod.string().optional(),
+    "method": zod.string().optional(),
+    "description": zod.string().nullish(),
+    "cardnumber": zod.string().optional(),
+    "cvv": zod.string().optional(),
+    "expiry_month": zod.string().optional(),
+    "expiry_year": zod.string().optional(),
+    "postal_code": zod.string().nullish(),
+    "bankaccountnumber": zod.string().optional(),
+    "routing_number": zod.string().optional(),
+    "account_type": zod.string().optional(),
+    "parameters": zod.object({
+        "campaignid": zod.string(),
+        "callerphone": zod.string(),
+        "sessionid": zod.string().optional(),
+        "payment_method_id": zod.string().optional(),
+        "paymentdate": zod.string().optional(),
+        "planfrequency": zod.string().optional(),
+        "plantype": zod.string().optional(),
+        "numberofpayments": zod.string().optional()
+    })
+});
+exports.ProcessSwervePayPaymentResponse = zod.object({
+    "charge_id": zod.string(),
+    "error_code": zod.string().nullable(),
+    "error_message": zod.string().nullable()
+});

package/shared/fetcher.d.ts

@@ -0,0 +1,94 @@
+/**
+ * Custom HTTP fetcher for the Kiban API client.
+ *
+ * Supports Orval's mutator signature (`customFetcher(url, options)`) while
+ * preserving auth-token injection and robust JSON/non-JSON response parsing.
+ */
+type HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+type QueryValue = string | number | boolean | null | undefined;
+type SuccessStatus = 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 226;
+export interface FetcherOptions<TBody = unknown> {
+    url: string;
+    method: HttpMethod;
+    headers?: HeadersInit;
+    params?: Record<string, QueryValue>;
+    data?: TBody;
+    signal?: AbortSignal;
+}
+export interface FetcherResponse<TData> {
+    data: TData;
+    status: number;
+    headers: Headers;
+}
+export type MutatorResponseEnvelope = {
+    data: unknown;
+    status: number;
+    headers: Headers;
+};
+export type SuccessResponse<TResponse extends {
+    status: number;
+}> = Extract<TResponse, {
+    status: SuccessStatus;
+}>;
+/**
+ * Set the authentication token getter
+ *
+ * @example
+ * // After user login:
+ * setAuthToken(() => localStorage.getItem('authToken'));
+ *
+ * // With Clerk:
+ * setAuthToken(() => clerk.session?.getToken() ?? null);
+ */
+export declare function setAuthToken(getter: () => string | null): void;
+/**
+ * Clear the authentication token (call on logout)
+ */
+export declare function clearAuthToken(): void;
+/**
+ * Set API base URL at runtime.
+ *
+ * @example
+ * setApiBaseUrl("https://api.example.com");
+ */
+export declare function setApiBaseUrl(url: string): void;
+/**
+ * Clear runtime API base URL override and fall back to env/default.
+ */
+export declare function clearApiBaseUrl(): void;
+/**
+ * Get the effective API base URL used by the fetcher.
+ */
+export declare function getApiBaseUrl(): string;
+/**
+ * Type guard for SDK response unions that discriminates 2xx responses.
+ */
+export declare function isSuccessResponse<TResponse extends {
+    status: number;
+}>(response: TResponse): response is SuccessResponse<TResponse>;
+/**
+ * Assert an SDK response is successful (2xx), otherwise throw with payload context.
+ */
+export declare function ensureSuccess<TResponse extends {
+    status: number;
+    data: unknown;
+}>(response: TResponse, operationName?: string): asserts response is SuccessResponse<TResponse>;
+/**
+ * Return the success payload from an SDK response or throw for non-2xx responses.
+ */
+export declare function getSuccessData<TResponse extends {
+    status: number;
+    data: unknown;
+}>(response: TResponse, operationName?: string): SuccessResponse<TResponse>["data"];
+/**
+ * Orval mutator signature (used by generated SDK clients).
+ *
+ * `TResponse` is expected to be the full response envelope shape
+ * ({ data, status, headers }), not just the parsed body payload.
+ */
+export declare function customFetcher<TResponse extends MutatorResponseEnvelope>(url: string, options?: RequestInit): Promise<TResponse>;
+/**
+ * Alternate object-style fetcher signature.
+ */
+export declare function customFetcher<TData, TBody = unknown>(options: FetcherOptions<TBody>): Promise<FetcherResponse<TData>>;
+export default customFetcher;