Visa Acceptance

Instructions

Implementation Reference

• typescript/src/shared/invoices/getInvoice.ts:29-52 (handler)

  The handler function that executes the get_invoice tool logic. It uses the Cybersource InvoicesApi to fetch the invoice by ID, masks customer information, and returns the result or an error message.

  export const getInvoice = async (
    visaClient: any,
    context: VisaContext,
    params: z.infer<ReturnType<typeof getInvoiceParameters>>
  ) => {
    try {
      const invoiceApiInstance = new cybersourceRestApi.InvoicesApi(visaClient.configuration, visaClient.visaApiClient);
      
      const result = await new Promise((resolve, reject) => {
        invoiceApiInstance.getInvoice(params.id, (error: any, data: any) => {
          if (error) {
            reject(error);
          } else {
            resolve(data);
          }
        });
      });
      
      const maskedResult = maskInvoiceCustomerInfo(result);
      return maskedResult;
    } catch (error) {
      return 'Failed to get invoice';
    }
  };

• typescript/src/shared/invoices/getInvoice.ts:16-22 (schema)

  Zod schema defining the input parameters for the get_invoice tool: a required string 'id' for the invoice ID.

  export const getInvoiceParameters = (
    context: VisaContext = {} as VisaContext
  ) => {
    return z.object({
      id: z.string().describe('Invoice ID (required)')
    });
  };

• typescript/src/shared/invoices/getInvoice.ts:54-67 (registration)

  Tool object definition and default export for the get_invoice tool, specifying method name, description, parameters, actions, and handler reference.

  const tool = (context: VisaContext): Tool => ({
    method: 'get_invoice',
    name: 'Get Invoice',
    description: getInvoicePrompt(context),
    parameters: getInvoiceParameters(context),
    actions: {
      invoices: {
        read: true,
      },
    },
    execute: getInvoice,
  });
  
  export default tool;

• typescript/src/shared/tools.ts:40-53 (registration)

  Registration of the get_invoice tool (as getInvoiceToolModule(context)) into the central tools array via the createTools function.

  export function createTools(context: VisaContext): Tool[] {
    return [
      createInvoiceToolModule(context),
      updateInvoiceToolModule(context),
      getInvoiceToolModule(context),
      listInvoicesToolModule(context),
      sendInvoiceToolModule(context),
      cancelInvoiceToolModule(context),
      createPaymentLinkToolModule(context),
      updatePaymentLinkToolModule(context),
      getPaymentLinkToolModule(context),
      listPaymentLinkToolModule(context)
    ];
  }

• typescript/src/shared/invoices/getInvoice.ts:24-27 (schema)

  Prompt providing the description text for the get_invoice tool.

  export const getInvoicePrompt = (context: VisaContext = {} as VisaContext) => `
  This tool will get a specific invoice from Visa Acceptance.
  `;