@paymos/sdk 1.0.0

package/dist/index.d.cts

@@ -0,0 +1,267 @@
+interface RetryOptions {
+    maxRetries?: number;
+    baseDelayMs?: number;
+}
+interface ClientOptions {
+    apiKey: string;
+    apiSecret: string;
+    baseUrl?: string;
+    timeoutMs?: number;
+    retry?: RetryOptions | false;
+    fetch?: typeof globalThis.fetch;
+    clock?: () => number;
+}
+declare class HttpClient {
+    private readonly options;
+    constructor(options: ClientOptions);
+    request<T>(method: string, path: string, payload?: unknown, query?: string): Promise<T>;
+}
+
+type InvoiceStatus = "awaiting_client" | "awaiting_payment" | "confirming" | "underpaid_waiting" | "paid" | "paid_over" | "underpaid" | "expired" | "cancelled";
+type WithdrawalStatus = "created" | "pending_review" | "signed" | "cancelling" | "completed" | "failed" | "cancelled";
+interface CreateInvoiceParams {
+    project_id: string;
+    amount: string;
+    currency: string;
+    external_order_id: string;
+    network?: string | null;
+    allow_multiple_payments?: boolean;
+    customer_fee_percent?: number | null;
+    client_id?: string | null;
+}
+interface ConfirmPaymentParams {
+    currency: string;
+    network: string;
+}
+interface Order {
+    external_id: string;
+    client_id: string | null;
+    amount: string;
+    currency: string;
+    network: string | null;
+}
+interface Transfer {
+    tx_hash: string;
+    amount: string;
+    status: string;
+    created_at: string;
+    confirmed_at: string | null;
+    required_confirmations: number | null;
+    estimated_confirmation_at: string | null;
+    explorer_url: string | null;
+}
+interface Payment {
+    currency: string;
+    network: string;
+    chain_id: number;
+    contract_address: string | null;
+    expected: string;
+    address: string | null;
+    exchange_rate: string | null;
+    paid: string | null;
+    remaining: string | null;
+    fee: string | null;
+    net: string | null;
+    transfers: Transfer[] | null;
+}
+interface Invoice {
+    invoice_id: string;
+    project_id: string;
+    status: InvoiceStatus;
+    is_final: boolean;
+    is_test: boolean;
+    payment_url: string;
+    order: Order;
+    payment: Payment | null;
+    created_at: string;
+    updated_at: string;
+    expires_at: string | null;
+    completed_at: string | null;
+}
+interface InvoiceListItem {
+    invoice_id: string;
+    project_id: string;
+    external_order_id: string;
+    client_id: string | null;
+    status: InvoiceStatus;
+    is_final: boolean;
+    is_test: boolean;
+    amount: string;
+    currency: string;
+    network: string | null;
+    created_at: string;
+    expires_at: string | null;
+    completed_at: string | null;
+}
+interface ListInvoicesParams {
+    limit?: number;
+    cursor?: string;
+    status?: InvoiceStatus[];
+    external_order_id?: string;
+    project_id?: string;
+    created_from?: number;
+    created_to?: number;
+}
+interface CreateWithdrawalParams {
+    destination_address: string;
+    network: string;
+    currency: string;
+    amount: string;
+    external_order_id: string;
+}
+interface Withdrawal {
+    withdrawal_id: string;
+    external_order_id: string;
+    status: WithdrawalStatus;
+    is_final: boolean;
+    is_test: boolean;
+    amount: string;
+    fee: string | null;
+    currency: string;
+    network: string;
+    destination_address: string;
+    tx_hash: string | null;
+    explorer_url: string | null;
+    created_at: string;
+    completed_at: string | null;
+    failed_at: string | null;
+    cancelled_at: string | null;
+}
+type WithdrawalListItem = Omit<Withdrawal, "tx_hash" | "explorer_url">;
+interface ListWithdrawalsParams {
+    limit?: number;
+    cursor?: string;
+    status?: WithdrawalStatus[];
+    external_order_id?: string;
+    created_from?: number;
+    created_to?: number;
+}
+interface CursorPage<T> {
+    items: T[];
+    next_cursor: string | null;
+}
+interface Balance {
+    currency: string;
+    available: string;
+}
+interface ProblemError {
+    code: string;
+    field: string | null;
+    message: string;
+}
+interface ProblemDetails {
+    type?: string;
+    title?: string;
+    status?: number;
+    detail?: string;
+    code?: string;
+    field?: string | null;
+    errors?: ProblemError[];
+    trace_id?: string;
+}
+interface WebhookEvent<T = unknown> {
+    event_id: string;
+    event_type: string;
+    created_at: string;
+    data: T;
+}
+
+declare class InvoicesResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    create(params: CreateInvoiceParams): Promise<Invoice>;
+    get(invoiceId: string): Promise<Invoice>;
+    list(params?: ListInvoicesParams): Promise<CursorPage<InvoiceListItem>>;
+    iterate(params?: ListInvoicesParams, maxPages?: number): AsyncGenerator<InvoiceListItem>;
+    cancel(invoiceId: string, reason: string): Promise<Invoice>;
+    confirmPayment(invoiceId: string, params: ConfirmPaymentParams): Promise<Invoice>;
+    simulatePayment(invoiceId: string, stage: "paid" | "overpaid" | "underpay" | "cancel"): Promise<Invoice>;
+}
+declare class WithdrawalsResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    create(params: CreateWithdrawalParams): Promise<Withdrawal>;
+    get(withdrawalId: string): Promise<Withdrawal>;
+    list(params?: ListWithdrawalsParams): Promise<CursorPage<WithdrawalListItem>>;
+    iterate(params?: ListWithdrawalsParams, maxPages?: number): AsyncGenerator<WithdrawalListItem>;
+    cancel(withdrawalId: string, reason: string): Promise<Withdrawal>;
+    simulateCompletion(withdrawalId: string): Promise<Withdrawal>;
+}
+declare class BalancesResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    get(): Promise<Balance[]>;
+}
+declare class SystemResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    time(): Promise<{
+        server_time: number;
+    }>;
+}
+
+declare class PaymosError extends Error {
+    constructor(message: string, options?: ErrorOptions);
+}
+declare class ConfigurationError extends PaymosError {
+}
+declare class SignatureMismatchError extends PaymosError {
+}
+declare class TimestampSkewError extends PaymosError {
+}
+declare class ApiError extends PaymosError {
+    readonly status: number;
+    readonly body: string;
+    readonly headers: Headers;
+    readonly problem: ProblemDetails | null;
+    constructor(status: number, body: string, headers: Headers);
+    get code(): string;
+    get field(): string | null;
+    get errors(): readonly ProblemError[];
+    get retryAfterSeconds(): number | null;
+}
+declare class ValidationError extends ApiError {
+}
+declare class AuthenticationError extends ApiError {
+}
+declare class NotFoundError extends ApiError {
+}
+declare class ConflictError extends ApiError {
+}
+declare class GoneError extends ApiError {
+}
+declare class RateLimitError extends ApiError {
+}
+declare class ServerError extends ApiError {
+}
+declare class UnavailableError extends ServerError {
+}
+declare function apiErrorFromResponse(status: number, body: string, headers: Headers): ApiError;
+
+declare function stringToSign(timestamp: string | number, method: string, path: string, query?: string, body?: string): string;
+declare function sign(secret: string, value: string): string;
+declare function authorizationHeader(apiKey: string, apiSecret: string, timestamp: string | number, method: string, path: string, query?: string, body?: string): string;
+declare function encodePathSegment(value: string): string;
+declare function buildQuery<T extends object>(filters: T): string;
+
+declare class WebhookVerifier {
+    private readonly secret;
+    private readonly toleranceSeconds;
+    constructor(secret: string, toleranceSeconds?: number);
+    verify(signatureHeader: string, rawBody: string | Buffer, now?: number): boolean;
+    assertValid(signatureHeader: string, rawBody: string | Buffer, now?: number): void;
+    constructEvent<T = unknown>(signatureHeader: string, rawBody: string | Buffer, now?: number): WebhookEvent<T>;
+}
+
+declare const SDK_VERSION = "1.0.0";
+
+declare class Paymos {
+    readonly invoices: InvoicesResource;
+    readonly withdrawals: WithdrawalsResource;
+    readonly balances: BalancesResource;
+    readonly system: SystemResource;
+    constructor(options: ClientOptions);
+}
+declare function externalOrderId(prefix?: string): string;
+
+export { ApiError, AuthenticationError, type Balance, type ClientOptions, ConfigurationError, type ConfirmPaymentParams, ConflictError, type CreateInvoiceParams, type CreateWithdrawalParams, type CursorPage, GoneError, type Invoice, type InvoiceListItem, type InvoiceStatus, type ListInvoicesParams, type ListWithdrawalsParams, NotFoundError, type Order, type Payment, Paymos, PaymosError, type ProblemDetails, type ProblemError, RateLimitError, type RetryOptions, SDK_VERSION, ServerError, SignatureMismatchError, TimestampSkewError, type Transfer, UnavailableError, ValidationError, type WebhookEvent, WebhookVerifier, type Withdrawal, type WithdrawalListItem, type WithdrawalStatus, apiErrorFromResponse, authorizationHeader, buildQuery, encodePathSegment, externalOrderId, sign, stringToSign };

package/dist/index.d.ts

@@ -0,0 +1,267 @@
+interface RetryOptions {
+    maxRetries?: number;
+    baseDelayMs?: number;
+}
+interface ClientOptions {
+    apiKey: string;
+    apiSecret: string;
+    baseUrl?: string;
+    timeoutMs?: number;
+    retry?: RetryOptions | false;
+    fetch?: typeof globalThis.fetch;
+    clock?: () => number;
+}
+declare class HttpClient {
+    private readonly options;
+    constructor(options: ClientOptions);
+    request<T>(method: string, path: string, payload?: unknown, query?: string): Promise<T>;
+}
+
+type InvoiceStatus = "awaiting_client" | "awaiting_payment" | "confirming" | "underpaid_waiting" | "paid" | "paid_over" | "underpaid" | "expired" | "cancelled";
+type WithdrawalStatus = "created" | "pending_review" | "signed" | "cancelling" | "completed" | "failed" | "cancelled";
+interface CreateInvoiceParams {
+    project_id: string;
+    amount: string;
+    currency: string;
+    external_order_id: string;
+    network?: string | null;
+    allow_multiple_payments?: boolean;
+    customer_fee_percent?: number | null;
+    client_id?: string | null;
+}
+interface ConfirmPaymentParams {
+    currency: string;
+    network: string;
+}
+interface Order {
+    external_id: string;
+    client_id: string | null;
+    amount: string;
+    currency: string;
+    network: string | null;
+}
+interface Transfer {
+    tx_hash: string;
+    amount: string;
+    status: string;
+    created_at: string;
+    confirmed_at: string | null;
+    required_confirmations: number | null;
+    estimated_confirmation_at: string | null;
+    explorer_url: string | null;
+}
+interface Payment {
+    currency: string;
+    network: string;
+    chain_id: number;
+    contract_address: string | null;
+    expected: string;
+    address: string | null;
+    exchange_rate: string | null;
+    paid: string | null;
+    remaining: string | null;
+    fee: string | null;
+    net: string | null;
+    transfers: Transfer[] | null;
+}
+interface Invoice {
+    invoice_id: string;
+    project_id: string;
+    status: InvoiceStatus;
+    is_final: boolean;
+    is_test: boolean;
+    payment_url: string;
+    order: Order;
+    payment: Payment | null;
+    created_at: string;
+    updated_at: string;
+    expires_at: string | null;
+    completed_at: string | null;
+}
+interface InvoiceListItem {
+    invoice_id: string;
+    project_id: string;
+    external_order_id: string;
+    client_id: string | null;
+    status: InvoiceStatus;
+    is_final: boolean;
+    is_test: boolean;
+    amount: string;
+    currency: string;
+    network: string | null;
+    created_at: string;
+    expires_at: string | null;
+    completed_at: string | null;
+}
+interface ListInvoicesParams {
+    limit?: number;
+    cursor?: string;
+    status?: InvoiceStatus[];
+    external_order_id?: string;
+    project_id?: string;
+    created_from?: number;
+    created_to?: number;
+}
+interface CreateWithdrawalParams {
+    destination_address: string;
+    network: string;
+    currency: string;
+    amount: string;
+    external_order_id: string;
+}
+interface Withdrawal {
+    withdrawal_id: string;
+    external_order_id: string;
+    status: WithdrawalStatus;
+    is_final: boolean;
+    is_test: boolean;
+    amount: string;
+    fee: string | null;
+    currency: string;
+    network: string;
+    destination_address: string;
+    tx_hash: string | null;
+    explorer_url: string | null;
+    created_at: string;
+    completed_at: string | null;
+    failed_at: string | null;
+    cancelled_at: string | null;
+}
+type WithdrawalListItem = Omit<Withdrawal, "tx_hash" | "explorer_url">;
+interface ListWithdrawalsParams {
+    limit?: number;
+    cursor?: string;
+    status?: WithdrawalStatus[];
+    external_order_id?: string;
+    created_from?: number;
+    created_to?: number;
+}
+interface CursorPage<T> {
+    items: T[];
+    next_cursor: string | null;
+}
+interface Balance {
+    currency: string;
+    available: string;
+}
+interface ProblemError {
+    code: string;
+    field: string | null;
+    message: string;
+}
+interface ProblemDetails {
+    type?: string;
+    title?: string;
+    status?: number;
+    detail?: string;
+    code?: string;
+    field?: string | null;
+    errors?: ProblemError[];
+    trace_id?: string;
+}
+interface WebhookEvent<T = unknown> {
+    event_id: string;
+    event_type: string;
+    created_at: string;
+    data: T;
+}
+
+declare class InvoicesResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    create(params: CreateInvoiceParams): Promise<Invoice>;
+    get(invoiceId: string): Promise<Invoice>;
+    list(params?: ListInvoicesParams): Promise<CursorPage<InvoiceListItem>>;
+    iterate(params?: ListInvoicesParams, maxPages?: number): AsyncGenerator<InvoiceListItem>;
+    cancel(invoiceId: string, reason: string): Promise<Invoice>;
+    confirmPayment(invoiceId: string, params: ConfirmPaymentParams): Promise<Invoice>;
+    simulatePayment(invoiceId: string, stage: "paid" | "overpaid" | "underpay" | "cancel"): Promise<Invoice>;
+}
+declare class WithdrawalsResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    create(params: CreateWithdrawalParams): Promise<Withdrawal>;
+    get(withdrawalId: string): Promise<Withdrawal>;
+    list(params?: ListWithdrawalsParams): Promise<CursorPage<WithdrawalListItem>>;
+    iterate(params?: ListWithdrawalsParams, maxPages?: number): AsyncGenerator<WithdrawalListItem>;
+    cancel(withdrawalId: string, reason: string): Promise<Withdrawal>;
+    simulateCompletion(withdrawalId: string): Promise<Withdrawal>;
+}
+declare class BalancesResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    get(): Promise<Balance[]>;
+}
+declare class SystemResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    time(): Promise<{
+        server_time: number;
+    }>;
+}
+
+declare class PaymosError extends Error {
+    constructor(message: string, options?: ErrorOptions);
+}
+declare class ConfigurationError extends PaymosError {
+}
+declare class SignatureMismatchError extends PaymosError {
+}
+declare class TimestampSkewError extends PaymosError {
+}
+declare class ApiError extends PaymosError {
+    readonly status: number;
+    readonly body: string;
+    readonly headers: Headers;
+    readonly problem: ProblemDetails | null;
+    constructor(status: number, body: string, headers: Headers);
+    get code(): string;
+    get field(): string | null;
+    get errors(): readonly ProblemError[];
+    get retryAfterSeconds(): number | null;
+}
+declare class ValidationError extends ApiError {
+}
+declare class AuthenticationError extends ApiError {
+}
+declare class NotFoundError extends ApiError {
+}
+declare class ConflictError extends ApiError {
+}
+declare class GoneError extends ApiError {
+}
+declare class RateLimitError extends ApiError {
+}
+declare class ServerError extends ApiError {
+}
+declare class UnavailableError extends ServerError {
+}
+declare function apiErrorFromResponse(status: number, body: string, headers: Headers): ApiError;
+
+declare function stringToSign(timestamp: string | number, method: string, path: string, query?: string, body?: string): string;
+declare function sign(secret: string, value: string): string;
+declare function authorizationHeader(apiKey: string, apiSecret: string, timestamp: string | number, method: string, path: string, query?: string, body?: string): string;
+declare function encodePathSegment(value: string): string;
+declare function buildQuery<T extends object>(filters: T): string;
+
+declare class WebhookVerifier {
+    private readonly secret;
+    private readonly toleranceSeconds;
+    constructor(secret: string, toleranceSeconds?: number);
+    verify(signatureHeader: string, rawBody: string | Buffer, now?: number): boolean;
+    assertValid(signatureHeader: string, rawBody: string | Buffer, now?: number): void;
+    constructEvent<T = unknown>(signatureHeader: string, rawBody: string | Buffer, now?: number): WebhookEvent<T>;
+}
+
+declare const SDK_VERSION = "1.0.0";
+
+declare class Paymos {
+    readonly invoices: InvoicesResource;
+    readonly withdrawals: WithdrawalsResource;
+    readonly balances: BalancesResource;
+    readonly system: SystemResource;
+    constructor(options: ClientOptions);
+}
+declare function externalOrderId(prefix?: string): string;
+
+export { ApiError, AuthenticationError, type Balance, type ClientOptions, ConfigurationError, type ConfirmPaymentParams, ConflictError, type CreateInvoiceParams, type CreateWithdrawalParams, type CursorPage, GoneError, type Invoice, type InvoiceListItem, type InvoiceStatus, type ListInvoicesParams, type ListWithdrawalsParams, NotFoundError, type Order, type Payment, Paymos, PaymosError, type ProblemDetails, type ProblemError, RateLimitError, type RetryOptions, SDK_VERSION, ServerError, SignatureMismatchError, TimestampSkewError, type Transfer, UnavailableError, ValidationError, type WebhookEvent, WebhookVerifier, type Withdrawal, type WithdrawalListItem, type WithdrawalStatus, apiErrorFromResponse, authorizationHeader, buildQuery, encodePathSegment, externalOrderId, sign, stringToSign };