@lomi./sdk
Version:
Official TypeScript SDK for the lomi. API
308 lines • 9.51 kB
TypeScript
import type { customers } from '../models/customers.js';
import type { customers_create } from '../models/customers_create.js';
import type { customers_update } from '../models/customers_update.js';
import type { payment_requests } from '../models/payment_requests.js';
import type { payment_requests_create } from '../models/payment_requests_create.js';
import type { payment_requests_update } from '../models/payment_requests_update.js';
import type { refunds } from '../models/refunds.js';
import type { refunds_create } from '../models/refunds_create.js';
import type { refunds_update } from '../models/refunds_update.js';
import type { transactions } from '../models/transactions.js';
import type { CancelablePromise } from '../core/CancelablePromise.js';
export declare class CoreService {
/**
* List customers
* Customer management - create and manage customer profiles
* @returns any Successful response with paginated data
* @throws ApiError
*/
static listCustomers({ limit, offset, sort, }: {
/**
* Maximum number of items to return (1-100)
*/
limit?: number;
/**
* Number of items to skip for pagination
*/
offset?: number;
/**
* Sort order. Format: `field:direction` (e.g., `created_at:desc`)
*/
sort?: string;
}): CancelablePromise<{
data?: Array<customers>;
pagination?: {
/**
* Number of items per page
*/
limit?: number;
/**
* Number of items skipped
*/
offset?: number;
/**
* Total number of items available
*/
total?: number;
};
}>;
/**
* Create customer
* Customer management - create and manage customer profiles
* @returns customers Customer successfully created
* @throws ApiError
*/
static createCustomer({ requestBody, }: {
requestBody: customers_create;
}): CancelablePromise<customers>;
/**
* Retrieve customer
* Retrieve a specific customer by its unique identifier.
* @returns customers Customer retrieved successfully
* @throws ApiError
*/
static retrieveCustomer({ customerId, }: {
/**
* Unique identifier for the customer
*/
customerId: string;
}): CancelablePromise<customers>;
/**
* Update customer
* Update a specific customer. Only provided fields will be updated.
* @returns customers Customer successfully updated
* @throws ApiError
*/
static updateCustomer({ customerId, requestBody, }: {
/**
* Unique identifier for the customer
*/
customerId: string;
requestBody: customers_update;
}): CancelablePromise<customers>;
/**
* Delete customer
* Delete a specific customer. This action cannot be undone.
* @returns void
* @throws ApiError
*/
static deleteCustomer({ customerId, }: {
/**
* Unique identifier for the customer
*/
customerId: string;
}): CancelablePromise<void>;
/**
* List payment requests
* Payment requests - create payment intents and track status
* @returns any Successful response with paginated data
* @throws ApiError
*/
static listPaymentRequests({ limit, offset, sort, }: {
/**
* Maximum number of items to return (1-100)
*/
limit?: number;
/**
* Number of items to skip for pagination
*/
offset?: number;
/**
* Sort order. Format: `field:direction` (e.g., `created_at:desc`)
*/
sort?: string;
}): CancelablePromise<{
data?: Array<payment_requests>;
pagination?: {
/**
* Number of items per page
*/
limit?: number;
/**
* Number of items skipped
*/
offset?: number;
/**
* Total number of items available
*/
total?: number;
};
}>;
/**
* Create payment request
* Payment requests - create payment intents and track status
* @returns payment_requests Payment_request successfully created
* @throws ApiError
*/
static createPaymentRequest({ requestBody, }: {
requestBody: payment_requests_create;
}): CancelablePromise<payment_requests>;
/**
* Retrieve payment request
* Retrieve a specific payment request by its unique identifier.
* @returns payment_requests Payment_request retrieved successfully
* @throws ApiError
*/
static retrievePaymentRequest({ requestId, }: {
/**
* Unique identifier for the payment request
*/
requestId: string;
}): CancelablePromise<payment_requests>;
/**
* Update payment request
* Update a specific payment request. Only provided fields will be updated.
* @returns payment_requests Payment_request successfully updated
* @throws ApiError
*/
static updatePaymentRequest({ requestId, requestBody, }: {
/**
* Unique identifier for the payment request
*/
requestId: string;
requestBody: payment_requests_update;
}): CancelablePromise<payment_requests>;
/**
* Delete payment request
* Delete a specific payment request. This action cannot be undone.
* @returns void
* @throws ApiError
*/
static deletePaymentRequest({ requestId, }: {
/**
* Unique identifier for the payment request
*/
requestId: string;
}): CancelablePromise<void>;
/**
* List transactions
* Transaction history - view completed and pending transactions
* @returns any Successful response with paginated data
* @throws ApiError
*/
static listTransactions({ limit, offset, sort, }: {
/**
* Maximum number of items to return (1-100)
*/
limit?: number;
/**
* Number of items to skip for pagination
*/
offset?: number;
/**
* Sort order. Format: `field:direction` (e.g., `created_at:desc`)
*/
sort?: string;
}): CancelablePromise<{
data?: Array<transactions>;
pagination?: {
/**
* Number of items per page
*/
limit?: number;
/**
* Number of items skipped
*/
offset?: number;
/**
* Total number of items available
*/
total?: number;
};
}>;
/**
* Retrieve transaction
* Retrieve a specific transaction by its unique identifier.
* @returns transactions Transaction retrieved successfully
* @throws ApiError
*/
static retrieveTransaction({ transactionId, }: {
/**
* Unique identifier for the transaction
*/
transactionId: string;
}): CancelablePromise<transactions>;
/**
* List refunds
* Refund management - process and track refunds
* @returns any Successful response with paginated data
* @throws ApiError
*/
static listRefunds({ limit, offset, sort, }: {
/**
* Maximum number of items to return (1-100)
*/
limit?: number;
/**
* Number of items to skip for pagination
*/
offset?: number;
/**
* Sort order. Format: `field:direction` (e.g., `created_at:desc`)
*/
sort?: string;
}): CancelablePromise<{
data?: Array<refunds>;
pagination?: {
/**
* Number of items per page
*/
limit?: number;
/**
* Number of items skipped
*/
offset?: number;
/**
* Total number of items available
*/
total?: number;
};
}>;
/**
* Create refund
* Refund management - process and track refunds
* @returns refunds Refund successfully created
* @throws ApiError
*/
static createRefund({ requestBody, }: {
requestBody: refunds_create;
}): CancelablePromise<refunds>;
/**
* Retrieve refund
* Retrieve a specific refund by its unique identifier.
* @returns refunds Refund retrieved successfully
* @throws ApiError
*/
static retrieveRefund({ refundId, }: {
/**
* Unique identifier for the refund
*/
refundId: string;
}): CancelablePromise<refunds>;
/**
* Update refund
* Update a specific refund. Only provided fields will be updated.
* @returns refunds Refund successfully updated
* @throws ApiError
*/
static updateRefund({ refundId, requestBody, }: {
/**
* Unique identifier for the refund
*/
refundId: string;
requestBody: refunds_update;
}): CancelablePromise<refunds>;
/**
* Delete refund
* Delete a specific refund. This action cannot be undone.
* @returns void
* @throws ApiError
*/
static deleteRefund({ refundId, }: {
/**
* Unique identifier for the refund
*/
refundId: string;
}): CancelablePromise<void>;
}
//# sourceMappingURL=CoreService.d.ts.map