@openmeter/client 1.0.0-beta-62b7ce950326 → 1.0.0-beta-106e6d4e7951

package/dist/models/types.d.ts

@@ -43,11 +43,11 @@ export interface CursorMetaPage {
     /** URI to the last page. */
     last?: string;
     /** URI to the next page. */
-    next?: string;
+    next: string | null;
     /** URI to the previous page. */
-    previous?: string;
+    previous: string | null;
     /** Requested page size. */
-    size?: number;
+    size: number;
 }
 /** Standard error response. */
 export interface BaseError {
@@ -188,6 +188,44 @@ export interface RateCardBooleanEntitlement {
     /** The type of the entitlement template. */
     type: 'boolean';
 }
+/** Model for installing an app from the catalog with an API key. */
+export interface InstallAppStripeWithApiKey {
+    /** Type of the app. */
+    type: 'stripe';
+    /** Name of the app. */
+    name: string;
+    /**
+     * If true, a billing profile will be created for the app. The Stripe app will be
+     * also set as the default billing profile if the current default is a Sandbox app.
+     */
+    createBillingProfile: boolean;
+    /** API key for the app. */
+    apiKey: string;
+}
+/** Base model for installing an app from the catalog. */
+export interface InstallAppSandbox {
+    /** Type of the app. */
+    type: 'sandbox';
+    /** Name of the app. */
+    name: string;
+    /**
+     * If true, a billing profile will be created for the app. The Stripe app will be
+     * also set as the default billing profile if the current default is a Sandbox app.
+     */
+    createBillingProfile: boolean;
+}
+/** Base model for installing an app from the catalog. */
+export interface InstallAppExternalInvoicing {
+    /** Type of the app. */
+    type: 'external_invoicing';
+    /** Name of the app. */
+    name: string;
+    /**
+     * If true, a billing profile will be created for the app. The Stripe app will be
+     * also set as the default billing profile if the current default is a Sandbox app.
+     */
+    createBillingProfile: boolean;
+}
 /**
  * BillingWorkflowCollectionAlignmentSubscription specifies the alignment for
  * collecting the pending line items into an invoice.
@@ -1781,20 +1819,6 @@ export interface UnitConfig {
      */
     displayUnit?: string;
 }
-/**
- * Available apps for billing integrations to connect with third-party services.
- * Apps can have various capabilities like syncing data from or to external
- * systems, integrating with third-party services for tax calculation, delivery of
- * invoices, collection of payments, etc.
- */
-export interface AppCatalogItem {
-    /** Type of the app. */
-    type: 'sandbox' | 'stripe' | 'external_invoicing';
-    /** Name of the app. */
-    name: string;
-    /** Description of the app. */
-    description: string;
-}
 /** Mapping of app types to tax codes. */
 export interface TaxCodeAppMapping {
     /** The app type that the tax code is associated with. */
@@ -1802,6 +1826,17 @@ export interface TaxCodeAppMapping {
     /** Tax code. */
     taxCode: string;
 }
+/** App capability describes a function that an App can perform. */
+export interface AppCapability {
+    /** Type of the capability. */
+    type: 'report_usage' | 'report_events' | 'calculate_tax' | 'invoice_customers' | 'collect_payments';
+    /** Key of the capability. */
+    key: string;
+    /** Name of the capability. */
+    name: string;
+    /** Description of the capability. */
+    description: string;
+}
 /**
  * Identity stores the details required to identify an entity for tax purposes in a
  * specific country.
@@ -2866,141 +2901,6 @@ export interface InvoiceUsageQuantityDetail {
      */
     appliedUnitConfig: UnitConfig;
 }
-/** Stripe app. */
-export interface AppStripe {
-    id: string;
-    /**
-     * Display name of the resource.
-     *
-     * Between 1 and 256 characters.
-     */
-    name: string;
-    /**
-     * Optional description of the resource.
-     *
-     * Maximum 1024 characters.
-     */
-    description?: string;
-    labels?: Labels;
-    /** An ISO-8601 timestamp representation of entity creation date. */
-    createdAt: Date;
-    /** An ISO-8601 timestamp representation of entity last update date. */
-    updatedAt: Date;
-    /** An ISO-8601 timestamp representation of entity deletion date. */
-    deletedAt?: Date;
-    /** The app type. */
-    type: 'stripe';
-    /** The app catalog definition that this installed app is based on. */
-    definition: AppCatalogItem;
-    /** Status of the app connection. */
-    status: 'ready' | 'unauthorized';
-    /** The Stripe account ID associated with the connected Stripe account. */
-    accountId: string;
-    /** Indicates whether the app is connected to a live Stripe account. */
-    livemode: boolean;
-    /** The masked Stripe API key that only exposes the first and last few characters. */
-    maskedApiKey: string;
-}
-/** Sandbox app can be used for testing billing features. */
-export interface AppSandbox {
-    id: string;
-    /**
-     * Display name of the resource.
-     *
-     * Between 1 and 256 characters.
-     */
-    name: string;
-    /**
-     * Optional description of the resource.
-     *
-     * Maximum 1024 characters.
-     */
-    description?: string;
-    labels?: Labels;
-    /** An ISO-8601 timestamp representation of entity creation date. */
-    createdAt: Date;
-    /** An ISO-8601 timestamp representation of entity last update date. */
-    updatedAt: Date;
-    /** An ISO-8601 timestamp representation of entity deletion date. */
-    deletedAt?: Date;
-    /** The app type. */
-    type: 'sandbox';
-    /** The app catalog definition that this installed app is based on. */
-    definition: AppCatalogItem;
-    /** Status of the app connection. */
-    status: 'ready' | 'unauthorized';
-}
-/**
- * External Invoicing app enables integration with third-party invoicing or payment
- * system.
- *
- * The app supports a bi-directional synchronization pattern where OpenMeter
- * Billing manages the invoice lifecycle while the external system handles invoice
- * presentation and payment collection.
- *
- * Integration workflow:
- *
- * 1. The billing system creates invoices and transitions them through lifecycle
- * states (draft → issuing → issued)
- * 2. The integration receives webhook notifications about invoice state changes
- * 3. The integration calls back to provide external system IDs and metadata
- * 4. The integration reports payment events back via the payment status API
- *
- * State synchronization is controlled by hooks that pause invoice progression
- * until the external system confirms synchronization via API callbacks.
- */
-export interface AppExternalInvoicing {
-    id: string;
-    /**
-     * Display name of the resource.
-     *
-     * Between 1 and 256 characters.
-     */
-    name: string;
-    /**
-     * Optional description of the resource.
-     *
-     * Maximum 1024 characters.
-     */
-    description?: string;
-    labels?: Labels;
-    /** An ISO-8601 timestamp representation of entity creation date. */
-    createdAt: Date;
-    /** An ISO-8601 timestamp representation of entity last update date. */
-    updatedAt: Date;
-    /** An ISO-8601 timestamp representation of entity deletion date. */
-    deletedAt?: Date;
-    /** The app type. */
-    type: 'external_invoicing';
-    /** The app catalog definition that this installed app is based on. */
-    definition: AppCatalogItem;
-    /** Status of the app connection. */
-    status: 'ready' | 'unauthorized';
-    /**
-     * Enable draft synchronization hook.
-     *
-     * When enabled, invoices will pause at the draft state and wait for the
-     * integration to call the draft synchronized endpoint before progressing to the
-     * issuing state. This allows the external system to validate and prepare the
-     * invoice data.
-     *
-     * When disabled, invoices automatically progress through the draft state based on
-     * the configured workflow timing.
-     */
-    enableDraftSyncHook: boolean;
-    /**
-     * Enable issuing synchronization hook.
-     *
-     * When enabled, invoices will pause at the issuing state and wait for the
-     * integration to call the issuing synchronized endpoint before progressing to the
-     * issued state. This ensures the external invoicing system has successfully
-     * created and finalized the invoice before it is marked as issued.
-     *
-     * When disabled, invoices automatically progress through the issuing state and are
-     * immediately marked as issued.
-     */
-    enableIssuingSyncHook: boolean;
-}
 /** TaxCode create request. */
 export interface CreateTaxCodeRequest {
     /**
@@ -3064,6 +2964,24 @@ export interface UpsertTaxCodeRequest {
     /** Mapping of app types to tax codes. */
     appMappings: TaxCodeAppMapping[];
 }
+/**
+ * Available apps for billing integrations to connect with third-party services.
+ * Apps can have various capabilities like syncing data from or to external
+ * systems, integrating with third-party services for tax calculation, delivery of
+ * invoices, collection of payments, etc.
+ */
+export interface AppCatalogItem {
+    /** Type of the app. */
+    type: 'sandbox' | 'stripe' | 'external_invoicing';
+    /** Name of the app. */
+    name: string;
+    /** Description of the app. */
+    description: string;
+    /** Capabilities of the app. */
+    capabilities: AppCapability[];
+    /** Available install methods of the app. */
+    installMethods: ('with_oauth2' | 'with_api_key' | 'no_credentials_required')[];
+}
 /**
  * Invoice-level snapshot of the workflow configuration.
  *
@@ -3616,6 +3534,146 @@ export interface TaxCodePagePaginatedResponse {
     data: TaxCode[];
     meta: PaginatedMeta;
 }
+/** Stripe app. */
+export interface AppStripe {
+    id: string;
+    /**
+     * Display name of the resource.
+     *
+     * Between 1 and 256 characters.
+     */
+    name: string;
+    /**
+     * Optional description of the resource.
+     *
+     * Maximum 1024 characters.
+     */
+    description?: string;
+    labels?: Labels;
+    /** An ISO-8601 timestamp representation of entity creation date. */
+    createdAt: Date;
+    /** An ISO-8601 timestamp representation of entity last update date. */
+    updatedAt: Date;
+    /** An ISO-8601 timestamp representation of entity deletion date. */
+    deletedAt?: Date;
+    /** The app type. */
+    type: 'stripe';
+    /** The app catalog definition that this installed app is based on. */
+    definition: AppCatalogItem;
+    /** Status of the app connection. */
+    status: 'ready' | 'unauthorized';
+    /** The Stripe account ID associated with the connected Stripe account. */
+    accountId: string;
+    /** Indicates whether the app is connected to a live Stripe account. */
+    livemode: boolean;
+    /** The masked Stripe API key that only exposes the first and last few characters. */
+    maskedApiKey: string;
+}
+/** Sandbox app can be used for testing billing features. */
+export interface AppSandbox {
+    id: string;
+    /**
+     * Display name of the resource.
+     *
+     * Between 1 and 256 characters.
+     */
+    name: string;
+    /**
+     * Optional description of the resource.
+     *
+     * Maximum 1024 characters.
+     */
+    description?: string;
+    labels?: Labels;
+    /** An ISO-8601 timestamp representation of entity creation date. */
+    createdAt: Date;
+    /** An ISO-8601 timestamp representation of entity last update date. */
+    updatedAt: Date;
+    /** An ISO-8601 timestamp representation of entity deletion date. */
+    deletedAt?: Date;
+    /** The app type. */
+    type: 'sandbox';
+    /** The app catalog definition that this installed app is based on. */
+    definition: AppCatalogItem;
+    /** Status of the app connection. */
+    status: 'ready' | 'unauthorized';
+}
+/**
+ * External Invoicing app enables integration with third-party invoicing or payment
+ * system.
+ *
+ * The app supports a bi-directional synchronization pattern where OpenMeter
+ * Billing manages the invoice lifecycle while the external system handles invoice
+ * presentation and payment collection.
+ *
+ * Integration workflow:
+ *
+ * 1. The billing system creates invoices and transitions them through lifecycle
+ * states (draft → issuing → issued)
+ * 2. The integration receives webhook notifications about invoice state changes
+ * 3. The integration calls back to provide external system IDs and metadata
+ * 4. The integration reports payment events back via the payment status API
+ *
+ * State synchronization is controlled by hooks that pause invoice progression
+ * until the external system confirms synchronization via API callbacks.
+ */
+export interface AppExternalInvoicing {
+    id: string;
+    /**
+     * Display name of the resource.
+     *
+     * Between 1 and 256 characters.
+     */
+    name: string;
+    /**
+     * Optional description of the resource.
+     *
+     * Maximum 1024 characters.
+     */
+    description?: string;
+    labels?: Labels;
+    /** An ISO-8601 timestamp representation of entity creation date. */
+    createdAt: Date;
+    /** An ISO-8601 timestamp representation of entity last update date. */
+    updatedAt: Date;
+    /** An ISO-8601 timestamp representation of entity deletion date. */
+    deletedAt?: Date;
+    /** The app type. */
+    type: 'external_invoicing';
+    /** The app catalog definition that this installed app is based on. */
+    definition: AppCatalogItem;
+    /** Status of the app connection. */
+    status: 'ready' | 'unauthorized';
+    /**
+     * Enable draft synchronization hook.
+     *
+     * When enabled, invoices will pause at the draft state and wait for the
+     * integration to call the draft synchronized endpoint before progressing to the
+     * issuing state. This allows the external system to validate and prepare the
+     * invoice data.
+     *
+     * When disabled, invoices automatically progress through the draft state based on
+     * the configured workflow timing.
+     */
+    enableDraftSyncHook: boolean;
+    /**
+     * Enable issuing synchronization hook.
+     *
+     * When enabled, invoices will pause at the issuing state and wait for the
+     * integration to call the issuing synchronized endpoint before progressing to the
+     * issued state. This ensures the external invoicing system has successfully
+     * created and finalized the invoice before it is marked as issued.
+     *
+     * When disabled, invoices automatically progress through the issuing state and are
+     * immediately marked as issued.
+     */
+    enableIssuingSyncHook: boolean;
+}
+/** Page paginated response. */
+export interface AppCatalogItemPagePaginatedResponse {
+    data: AppCatalogItem[];
+    meta: PaginatedMeta;
+}
 /** Snapshot of the billing workflow configuration captured at invoice creation. */
 export interface InvoiceWorkflowSettings {
     /** The apps that will be used to orchestrate the invoice's workflow. */
@@ -3888,20 +3946,6 @@ export interface WorkflowCollectionSettings {
      */
     interval: string;
 }
-/** Page paginated response. */
-export interface AppPagePaginatedResponse {
-    data: App[];
-    meta: PaginatedMeta;
-}
-/** Applications used by a billing profile. */
-export interface ProfileApps {
-    /** The tax app used for this workflow. */
-    tax: App;
-    /** The invoicing app used for this workflow. */
-    invoicing: App;
-    /** The payment app used for this workflow. */
-    payment: App;
-}
 /** Response of the governance query. */
 export interface GovernanceQueryResponse {
     /** Access evaluation results, one entry per resolved customer. */
@@ -4162,6 +4206,25 @@ export interface Workflow {
     /** The tax settings for this workflow */
     tax?: WorkflowTaxSettings;
 }
+/** Page paginated response. */
+export interface AppPagePaginatedResponse {
+    data: App[];
+    meta: PaginatedMeta;
+}
+/** Response of the app install. */
+export interface BillingInstallAppResponse {
+    app: App;
+    defaultForCapabilityTypes: ('report_usage' | 'report_events' | 'calculate_tax' | 'invoice_customers' | 'collect_payments')[];
+}
+/** Applications used by a billing profile. */
+export interface ProfileApps {
+    /** The tax app used for this workflow. */
+    tax: App;
+    /** The invoicing app used for this workflow. */
+    invoicing: App;
+    /** The payment app used for this workflow. */
+    payment: App;
+}
 /** A usage-based charge for a customer. */
 export interface ChargeUsageBased {
     id: string;
@@ -4963,6 +5026,8 @@ export type DateTimeFieldFilter = Date | {
  * returned.
  */
 export type SubscriptionEditTiming = 'immediate' | 'next_billing_cycle' | Date;
+/** Request to install an app from the catalog. */
+export type InstallAppRequest = InstallAppStripeWithApiKey | InstallAppSandbox | InstallAppExternalInvoicing;
 /** Payment settings for a billing workflow. */
 export type WorkflowPaymentSettings = WorkflowPaymentChargeAutomaticallySettings | WorkflowPaymentSendInvoiceSettings;
 /** Payment settings for a billing workflow. */
@@ -4989,12 +5054,12 @@ export type FeatureUnitCost = FeatureManualUnitCost | FeatureLlmUnitCost;
  * arrears items).
  */
 export type WorkflowCollectionAlignment = WorkflowCollectionAlignmentSubscription | WorkflowCollectionAlignmentAnchored;
-/** Installed application. */
-export type App = AppStripe | AppSandbox | AppExternalInvoicing;
 /** Price. */
 export type Price = PriceFree | PriceFlat | PriceUnit | PriceGraduated | PriceVolume;
 /** Price. */
 export type UpdatePrice = UpdatePriceFree | UpdatePriceFlat | UpdatePriceUnit | UpdatePriceGraduated | UpdatePriceVolume;
+/** Installed application. */
+export type App = AppStripe | AppSandbox | AppExternalInvoicing;
 /** Customer charge. */
 export type CreateChargeRequest = CreateChargeFlatFeeRequest | CreateChargeUsageBasedRequest;
 /** Customer charge. */

package/dist/sdk/apps.d.ts

@@ -1,7 +1,7 @@
 import { type Client } from '../core.js';
 import { type RequestOptions } from '../lib/types.js';
-import type { ListAppsRequest, ListAppsResponse, GetAppRequest, GetAppResponse } from '../models/operations/apps.js';
-import type { App } from '../models/types.js';
+import type { ListAppsRequest, ListAppsResponse, GetAppRequest, GetAppResponse, ListAppCatalogRequest, ListAppCatalogResponse, GetAppCatalogItemRequest, GetAppCatalogItemResponse, InstallAppRequest, InstallAppResponse } from '../models/operations/apps.js';
+import type { App, AppCatalogItem } from '../models/types.js';
 export declare class Apps {
     private readonly _client;
     constructor(_client: Client);
@@ -31,4 +31,38 @@ export declare class Apps {
      * GET /openmeter/apps/{appId}
      */
     get(request: GetAppRequest, options?: RequestOptions): Promise<GetAppResponse>;
+    /**
+     * List app catalog
+     *
+     * List available apps.
+     *
+     * GET /openmeter/app-catalog
+     */
+    listCatalog(request?: ListAppCatalogRequest, options?: RequestOptions): Promise<ListAppCatalogResponse>;
+    /**
+     * List app catalog
+     *
+     * List available apps.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/app-catalog
+     */
+    listCatalogAll(request?: ListAppCatalogRequest, options?: RequestOptions): AsyncIterable<AppCatalogItem>;
+    /**
+     * Get app catalog item by type
+     *
+     * Get an app catalog item by type.
+     *
+     * GET /openmeter/app-catalog/{appType}
+     */
+    getCatalogItem(request: GetAppCatalogItemRequest, options?: RequestOptions): Promise<GetAppCatalogItemResponse>;
+    /**
+     * Install app from the catalog
+     *
+     * Install an app from the catalog.
+     *
+     * POST /openmeter/app-catalog/install
+     */
+    install(request: InstallAppRequest, options?: RequestOptions): Promise<InstallAppResponse>;
 }

package/dist/sdk/apps.js

@@ -1,7 +1,7 @@
 // Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
 import { unwrap } from '../lib/types.js';
 import { paginatePages } from '../lib/paginate.js';
-import { listApps, getApp } from '../funcs/apps.js';
+import { listApps, getApp, listAppCatalog, getAppCatalogItem, installApp, } from '../funcs/apps.js';
 export class Apps {
     _client;
     constructor(_client) {
@@ -39,4 +39,46 @@ export class Apps {
     async get(request, options) {
         return unwrap(await getApp(this._client, request, options));
     }
+    /**
+     * List app catalog
+     *
+     * List available apps.
+     *
+     * GET /openmeter/app-catalog
+     */
+    async listCatalog(request, options) {
+        return unwrap(await listAppCatalog(this._client, request, options));
+    }
+    /**
+     * List app catalog
+     *
+     * List available apps.
+     *
+     * Iterates every item across all pages, fetching more as the returned iterable is consumed.
+     *
+     * GET /openmeter/app-catalog
+     */
+    listCatalogAll(request, options) {
+        return paginatePages((req, opts) => listAppCatalog(this._client, req, opts), request ?? {}, options);
+    }
+    /**
+     * Get app catalog item by type
+     *
+     * Get an app catalog item by type.
+     *
+     * GET /openmeter/app-catalog/{appType}
+     */
+    async getCatalogItem(request, options) {
+        return unwrap(await getAppCatalogItem(this._client, request, options));
+    }
+    /**
+     * Install app from the catalog
+     *
+     * Install an app from the catalog.
+     *
+     * POST /openmeter/app-catalog/install
+     */
+    async install(request, options) {
+        return unwrap(await installApp(this._client, request, options));
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmeter/client",
-  "version": "1.0.0-beta-62b7ce950326",
+  "version": "1.0.0-beta-106e6d4e7951",
   "description": "Official TypeScript SDK for the OpenMeter API — usage metering and billing",
   "keywords": [
     "openmeter",