Inttegro TypeScript SDK - v12.0.0
    Preparing search index...

    Class InttegroClient

    Main Inttegro SDK client

    import { InttegroClient } from '@inttegro/inttegro-sdk';

    const inttegro = new InttegroClient({
      apiKey: 'your-api-key',
      baseUrl: 'https://api.inttegro.com', // optional
      timeout: 30000, // optional
      debug: false, // optional
    });

    // Use the orders resource
    const order = await inttegro.orders.create({ ... });
    Index
    constructor
    apps balances balanceTransactions broadcasts chimes customers fileLinks fileReferences files financialAccounts keys messageTemplates orders otp paymentMethods payouts prices products purchaseIntents refunds schedules spec uploadRequests
    addRequestInterceptor addResponseInterceptor postWithResponse requestWithResponse updateConfig
    apps: Apps

    Apps resource for managing the authenticated application

    balances: Balances

    Balances resource

    balanceTransactions: BalanceTransactions

    Balance transactions resource

    broadcasts: Broadcasts

    Broadcasts resource

    chimes: Chimes

    Chimes resource

    customers: Customers

    Customers resource

    fileLinks: FileLinks

    File links resource

    fileReferences: FileReferences

    File references resource

    files: Files

    Files resource

    financialAccounts: FinancialAccounts

    Financial accounts resource

    keys: Keys

    Secret keys resource

    messageTemplates: MessageTemplates

    Message templates resource

    orders: Orders

    Orders resource for managing orders

    otp: Otp

    OTP resource

    paymentMethods: PaymentMethods

    Payment methods resource

    payouts: Payouts

    Payouts resource

    prices: Prices

    Prices resource

    products: Products

    Products resource

    purchaseIntents: PurchaseIntents

    Purchase intents resource

    refunds: Refunds

    Refunds resource

    schedules: Schedules

    Schedules resource

    spec: Spec

    Specifications resource

    uploadRequests: UploadRequests

    Upload requests resource

    • Add a request interceptor

      Request interceptors allow you to modify requests before they are sent.

      Parameters

      Returns void

      inttegro.addRequestInterceptor(async (url, options) => {
        // Add custom header
        options.headers = {
          ...options.headers,
          'X-Custom-Header': 'value',
        };
        return { url, options };
      });

    • Add a response interceptor

      Response interceptors allow you to process responses before they are returned.

      Parameters

      Returns void

      inttegro.addResponseInterceptor(async (response) => {
        // Log response status
        console.log('Response status:', response.status);
        return response;
      });

    • Make a POST request and keep native HTTP response facts with the decoded body.

      Type Parameters

      • T

      Parameters

      • path: string
      • Optionalbody: unknown
      • options: RequestInit = {}

      Returns Promise<InttegroResponse<T>>

    • Make a JSON request and keep native HTTP response facts with the decoded body.

      Prefer typed resource methods such as orders.createWithResponse when they exist. This lower-level helper is useful while response-envelope coverage is rolled out across every resource.

      Type Parameters

      • T

      Parameters

      • path: string
      • options: RequestInit = {}

      Returns Promise<InttegroResponse<T>>

    • Update SDK configuration

      Parameters

      Returns void

      inttegro.updateConfig({
        timeout: 60000,
        debug: true,
      });

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods