@ptkl/sdk - v1.18.0
    Preparing search index...

    Class default

    Base client for the platform API Classes that extend PlatformBaseClient have intentins of only working in platform context

    PlatformBaseClient

    The axios instance to use for the client

    // if sdk is used in the forge app that is running in the platform context
    const utils = new ComponentUtils()
    // this won't work outside of platform context because client needs authtorization to communicate with the API.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    client env host token

    Methods

    apiUser app billing component componentUtils config forge function getPlatformBaseURL getPlatformClient integrations kortex project ratchet sandbox satellites setClient system thunder transactions user workflow

    Constructors

    • Parameters

      • Optionaloptions: { env?: string; host?: string; token?: string }

      Returns default

    Properties

    client: AxiosInstance
    env: null | string = null
    host: null | string = null
    token: null | string = null

    Methods

    • Parameters

      • appType: string

      Returns default

    • Alias for transactions() — reads more naturally at call sites that only care about billing (platform.billing().getBalance()).

      Returns default

    • Type Parameters

      • C extends string

      Parameters

      • ref: C

      Returns default<C>

    • Returns default

    • Returns string

    • Returns AxiosInstance

    • Convenience factory for the Integrations gateway façade.

      Integrations live behind a different gateway (INTEGRATION_API / host/luma/integrations) than the rest of the platform API, so this returns an independently-configured Integrations client (it does not reuse this.client, whose base URL points at the platform host). The Platform's resolved token/env/host are propagated so the child client carries the same credentials.

      Returns default

    • Convenience factory for the Satellites (custom JSON-RPC integrations) client.

      Same gateway note as integrations() — Satellites talks to the integrations gateway, not the platform host, so a fresh, independently configured client is returned, with the Platform's credentials propagated.

      Returns default

    • Parameters

      • client: AxiosInstance

      Returns default

    • Transactions (billing) client — subscriptions, invoices, credits/balance, usage pricing and billing-mode overrides. Reached through the platform gateway (transactions/…), so it reuses this.client like the other native/proxied-service factories.

      This is the billing service — not distributed/database transactions.

      Returns default

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods