@paybyrd/ai-agent-toolkit/dist/src/prompts.d.ts

Toolkit for building AI agents with various models

export declare const createPaymentLinkPrompt = "\nThis tool will create a payment link through the Paybyrd API that can be sent to customers.\n\nRequired arguments:\n- isoAmount (number): The payment amount in the smallest currency unit (e.g. cents for EUR).\n- currency (string): The currency code of the payment (e.g. EUR).\n\nOptional arguments:\n- orderRef (string): Your reference for this order, which has a default value dynamically generated (uuid).\n- shopper (object): The shopper information with firstName and lastName.\n- orderOptions (object): Configuration options including notification preferences, redirect URL, culture code, and expiration time.\n- paymentOptions (object): Payment method configuration including allowedPaymentMethods.\n\nThe 'orderId' and the 'checkoutUrl' fields in the response are the most important values for the user.\n";
export declare const createRefundPrompt = "\nThis tool will create a refund for a specific transaction through the Paybyrd API.\n\nRequired arguments:\n- transactionId (string): The ID of the transaction to refund.\n- isoAmount (number): The amount to refund in the smallest currency unit (e.g. cents).\n";
export declare const retrieveOrderPrompt = "\nThis tool will retrieve the details of a specific order through the Paybyrd API.\n\nRequired arguments:\n- orderId (string): The ID of the order to retrieve.\n\nAdditional knowlodge:\nThe field status represents the state of the order.\nCreated - Order has no payments associated to it or all payment attempts have failed.\nPending - Order has a payment associated to it which is in progress but not concluded.\nPaid - Order has a payment associated to it with final status 'Success'.\nCanceled - This status can occur by system routines, shopper action by clicking on 'cancel payment' button in the hosted page or by calling the order cancel endpoint.\nExpired - This status occurs by system routines that checks for payment abandonment or in case an expiration date is sent in the create order request.\nRefunded - In case a successful payment is refunded, its order will have the 'Refunded' status.\n";