@openmeter/client 1.0.0-beta.232 → 1.0.0-beta.234

package/dist/models/operations/customers.d.ts

@@ -1,5 +1,5 @@
 import type { AcceptDateStrings } from '../../lib/wire.js';
-import type { AppCustomerData, AppStripeCreateCheckoutSessionResult, AppStripeCreateCustomerPortalSessionResult, Charge, ChargePagePaginatedResponse, CreateChargeRequest, CreateCreditAdjustmentRequest as CreateCreditAdjustmentRequestBody, CreateCreditGrantRequestInput, CreateCustomerRequest as CreateCustomerRequestBody, CreditAdjustment, CreditBalances, CreditGrant, CreditGrantPagePaginatedResponse, CreditTransactionPaginatedResponse, CursorPaginationQueryPage, Customer, CustomerData, CustomerPagePaginatedResponse, CustomerStripeCreateCheckoutSessionRequestInput, CustomerStripeCreateCustomerPortalSessionRequest, GetCreditBalanceParamsFilter, ListChargesParamsFilter, ListCreditGrantsParamsFilter, ListCreditTransactionsParamsFilter, ListCustomersParamsFilter, SortQueryInput, UpdateCreditGrantExternalSettlementRequest as UpdateCreditGrantExternalSettlementRequestBody, UpsertAppCustomerDataRequest, UpsertCustomerBillingDataRequest, UpsertCustomerRequest as UpsertCustomerRequestBody, VoidCreditGrantRequestInput } from '../types.js';
+import type { AppCustomerData, AppStripeCreateCheckoutSessionResult, AppStripeCreateCustomerPortalSessionResult, Charge, ChargePagePaginatedResponse, CreateChargeRequestInput, CreateCreditAdjustmentRequest as CreateCreditAdjustmentRequestBody, CreateCreditGrantRequestInput, CreateCustomerRequest as CreateCustomerRequestBody, CreateEntitlementRequestInput, CreditAdjustment, CreditBalances, CreditGrant, CreditGrantPagePaginatedResponse, CreditTransactionPaginatedResponse, CursorPaginationQueryPage, Customer, CustomerData, CustomerPagePaginatedResponse, CustomerStripeCreateCheckoutSessionRequestInput, CustomerStripeCreateCustomerPortalSessionRequest, Entitlement, EntitlementGrant, EntitlementGrantCreateRequest, EntitlementGrantPagePaginatedResponse, EntitlementHistory, EntitlementHistoryWindowSize, EntitlementPagePaginatedResponse, GetCreditBalanceParamsFilter, ListCreditGrantsParamsFilter, ListCreditTransactionsParamsFilter, ListCustomerChargesParamsFilter, ListCustomerEntitlementsParamsFilter, ListCustomersParamsFilter, ResetCustomerEntitlementUsageRequestInput, SortQueryInput, UpdateCreditGrantExternalSettlementRequest as UpdateCreditGrantExternalSettlementRequestBody, UpsertAppCustomerDataRequest, UpsertCustomerBillingDataRequest, UpsertCustomerRequest as UpsertCustomerRequestBody, VoidCreditGrantRequestInput } from '../types.js';
 export type CreateCustomerRequest = AcceptDateStrings<CreateCustomerRequestBody>;
 export type CreateCustomerResponse = Customer;
 export type GetCustomerRequest = {
@@ -65,6 +65,114 @@ export type CreateCustomerStripePortalSessionRequest = AcceptDateStrings<{
     body: CustomerStripeCreateCustomerPortalSessionRequest;
 }>;
 export type CreateCustomerStripePortalSessionResponse = AppStripeCreateCustomerPortalSessionResult;
+export type CreateCustomerEntitlementRequest = AcceptDateStrings<{
+    customerId: string;
+    body: CreateEntitlementRequestInput;
+}>;
+export type CreateCustomerEntitlementResponse = Entitlement;
+export type OverrideCustomerEntitlementRequest = AcceptDateStrings<{
+    customerId: string;
+    entitlementId: string;
+    body: CreateEntitlementRequestInput;
+}>;
+export type OverrideCustomerEntitlementResponse = Entitlement;
+export interface GetCustomerEntitlementHistoryQuery {
+    /**
+     * The start of the queried range. Defaults to the last reset. Truncated to the
+     * minute. The range may span at most 1000 windows.
+     */
+    from?: Date;
+    /**
+     * The end of the queried range. Defaults to the current time. Truncated to the
+     * minute unless it is the current time.
+     */
+    to?: Date;
+    /** The size of the windows the usage is grouped into. */
+    windowSize: EntitlementHistoryWindowSize;
+    /** The IANA time zone the windows are aligned to. */
+    timeZone?: string;
+}
+export type GetCustomerEntitlementHistoryRequest = AcceptDateStrings<GetCustomerEntitlementHistoryQuery & {
+    customerId: string;
+    entitlementId: string;
+}>;
+export type GetCustomerEntitlementHistoryResponse = EntitlementHistory;
+export type GetCustomerEntitlementRequest = {
+    customerId: string;
+    entitlementId: string;
+};
+export type GetCustomerEntitlementResponse = Entitlement;
+export interface ListCustomerEntitlementsQuery {
+    /** Determines which page of the collection to retrieve. */
+    page?: {
+        size?: number;
+        number?: number;
+    };
+    /**
+     * Sort entitlements returned in the response. Supported sort attributes are:
+     *
+     * - `created_at` (default)
+     * - `updated_at`
+     *
+     * The `asc` suffix is optional as the default sort order is ascending. The `desc`
+     * suffix is used to specify a descending order.
+     */
+    sort?: SortQueryInput;
+    /**
+     * Filter entitlements returned in the response.
+     *
+     * To filter entitlements by feature key add the following query param:
+     * `filter[feature_key]=my-feature`
+     */
+    filter?: ListCustomerEntitlementsParamsFilter;
+}
+export type ListCustomerEntitlementsRequest = AcceptDateStrings<ListCustomerEntitlementsQuery & {
+    customerId: string;
+}>;
+export type ListCustomerEntitlementsResponse = EntitlementPagePaginatedResponse;
+export type ResetCustomerEntitlementUsageRequest = AcceptDateStrings<{
+    customerId: string;
+    entitlementId: string;
+    body: ResetCustomerEntitlementUsageRequestInput;
+}>;
+export type ResetCustomerEntitlementUsageResponse = void;
+export type DeleteCustomerEntitlementRequest = {
+    customerId: string;
+    entitlementId: string;
+};
+export type DeleteCustomerEntitlementResponse = void;
+export type CreateCustomerEntitlementGrantRequest = AcceptDateStrings<{
+    customerId: string;
+    entitlementId: string;
+    body: EntitlementGrantCreateRequest;
+}>;
+export type CreateCustomerEntitlementGrantResponse = EntitlementGrant;
+export interface ListCustomerEntitlementGrantsQuery {
+    /** Determines which page of the collection to retrieve. */
+    page?: {
+        size?: number;
+        number?: number;
+    };
+    /**
+     * Sort grants returned in the response. Supported sort attributes are:
+     *
+     * - `created_at` (default)
+     * - `updated_at`
+     * - `effective_at`
+     * - `expires_at`
+     *
+     * The `asc` suffix is optional as the default sort order is ascending. The `desc`
+     * suffix is used to specify a descending order.
+     */
+    sort?: SortQueryInput;
+    /** Include deleted grants in the response. */
+    includeDeleted?: boolean;
+}
+export type ListCustomerEntitlementGrantsRequest = AcceptDateStrings<ListCustomerEntitlementGrantsQuery & {
+    customerId: string;
+    entitlementId: string;
+}>;
+export type ListCustomerEntitlementGrantsResponse = EntitlementGrantPagePaginatedResponse;
 export type CreateCreditGrantRequest = AcceptDateStrings<{
     customerId: string;
     body: CreateCreditGrantRequestInput;
@@ -150,16 +258,30 @@ export interface ListCustomerChargesQuery {
      *
      * To filter charges by status add the following query param:
      * `filter[status][oeq]=created,active`
+     *
+     * To filter charges by feature, use `filter[feature_id][oeq]=<id>,<id>` or
+     * `filter[feature_key][oeq]=<key>,<key>`.
+     *
+     * See the `service_period_from` filter field for expressing a service-period
+     * window query.
      */
-    filter?: ListChargesParamsFilter;
+    filter?: ListCustomerChargesParamsFilter;
     /**
      * Expand full objects for referenced entities.
      *
      * Supported values are:
      *
-     * - `real_time_usage`: Expand the charge's real-time usage.
+     * - `real_time_usage`: Expand the charge's real-time usage; it sets the `usage`
+     * and the `totals.realtime` fields.
+     * - `customer`: Expand the charge's customer to the complete entity.
+     * - `feature`: Expand the charge's feature to the complete entity.
+     * - `subscription`: Expand the charge's subscription to the complete entity.
+     * - `realization.invoice`: Expand each realization's invoice to the complete
+     * entity.
+     * - `realization.totals`: Expand each realization run's `totals`.
+     * - `realization.detailed_lines`: Expand each realization run's `detailed_lines`.
      */
-    expand?: 'real_time_usage'[];
+    expand?: ('real_time_usage' | 'customer' | 'feature' | 'subscription' | 'realization.invoice' | 'realization.totals' | 'realization.detailed_lines')[];
 }
 export type ListCustomerChargesRequest = AcceptDateStrings<ListCustomerChargesQuery & {
     customerId: string;
@@ -167,6 +289,6 @@ export type ListCustomerChargesRequest = AcceptDateStrings<ListCustomerChargesQu
 export type ListCustomerChargesResponse = ChargePagePaginatedResponse;
 export type CreateCustomerChargesRequest = AcceptDateStrings<{
     customerId: string;
-    body: CreateChargeRequest;
+    body: CreateChargeRequestInput;
 }>;
 export type CreateCustomerChargesResponse = Charge;

package/dist/models/operations/entitlementAccess.d.ts

@@ -0,0 +1,9 @@
+import type { AcceptDateStrings } from '../../lib/wire.js';
+import type { CursorPaginationQueryPage, EntitlementAccessQueryRequestInput, EntitlementAccessQueryResponse } from '../types.js';
+export interface QueryEntitlementAccessQuery {
+    page?: CursorPaginationQueryPage;
+}
+export type QueryEntitlementAccessRequest = AcceptDateStrings<{
+    body: EntitlementAccessQueryRequestInput;
+} & QueryEntitlementAccessQuery>;
+export type QueryEntitlementAccessResponse = EntitlementAccessQueryResponse;

package/dist/models/operations/entitlementAccess.js

@@ -0,0 +1,2 @@
+// Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
+export {};

package/dist/models/operations/entitlements.d.ts

@@ -1,5 +1,77 @@
-import type { ListCustomerEntitlementAccessResponseData } from '../types.js';
+import type { AcceptDateStrings } from '../../lib/wire.js';
+import type { Entitlement, EntitlementAccessCheckResult, EntitlementFeatureValueResult, EntitlementPagePaginatedResponse, EntitlementValueResult, ListCustomerEntitlementAccessResponseData, ListEntitlementsParamsFilter, SortQueryInput } from '../types.js';
 export type ListCustomerEntitlementAccessRequest = {
     customerId: string;
 };
 export type ListCustomerEntitlementAccessResponse = ListCustomerEntitlementAccessResponseData;
+export type GetCustomerEntitlementAccessRequest = {
+    customerId: string;
+    featureKey: string;
+};
+export type GetCustomerEntitlementAccessResponse = EntitlementAccessCheckResult;
+export interface GetCustomerEntitlementValueByFeatureKeyQuery {
+    /**
+     * Expand computed fields.
+     *
+     * Supported values are:
+     *
+     * - `value`: Expand the balance details of a metered entitlement; it sets the
+     * `value` field.
+     */
+    expand?: 'value'[];
+    /** The point in time to evaluate the entitlement at. Defaults to the current time. */
+    at?: Date;
+}
+export type GetCustomerEntitlementValueByFeatureKeyRequest = AcceptDateStrings<GetCustomerEntitlementValueByFeatureKeyQuery & {
+    customerId: string;
+    featureKey: string;
+}>;
+export type GetCustomerEntitlementValueByFeatureKeyResponse = EntitlementFeatureValueResult;
+export interface ListEntitlementsQuery {
+    /** Determines which page of the collection to retrieve. */
+    page?: {
+        size?: number;
+        number?: number;
+    };
+    /**
+     * Sort entitlements returned in the response. Supported sort attributes are:
+     *
+     * - `created_at` (default)
+     * - `updated_at`
+     *
+     * The `asc` suffix is optional as the default sort order is ascending. The `desc`
+     * suffix is used to specify a descending order.
+     */
+    sort?: SortQueryInput;
+    /**
+     * Filter entitlements returned in the response.
+     *
+     * To filter entitlements by customer, add the following query param:
+     * `filter[customer_id]=01K4WAQ0J99ZZ0MD75HXR112H8`
+     */
+    filter?: ListEntitlementsParamsFilter;
+}
+export type ListEntitlementsRequest = AcceptDateStrings<ListEntitlementsQuery>;
+export type ListEntitlementsResponse = EntitlementPagePaginatedResponse;
+export type GetEntitlementRequest = {
+    entitlementId: string;
+};
+export type GetEntitlementResponse = Entitlement;
+export interface GetCustomerEntitlementValueQuery {
+    /**
+     * Expand computed fields.
+     *
+     * Supported values are:
+     *
+     * - `value`: Expand the balance details of a metered entitlement; it sets the
+     * `value` field.
+     */
+    expand?: 'value'[];
+    /** The point in time to evaluate the entitlement at. Defaults to the current time. */
+    at?: Date;
+}
+export type GetCustomerEntitlementValueRequest = AcceptDateStrings<GetCustomerEntitlementValueQuery & {
+    customerId: string;
+    entitlementId: string;
+}>;
+export type GetCustomerEntitlementValueResponse = EntitlementValueResult;

package/dist/models/operations/grants.d.ts

@@ -0,0 +1,43 @@
+import type { AcceptDateStrings } from '../../lib/wire.js';
+import type { EntitlementGrantPagePaginatedResponse, ListGrantsParamsFilter, SortQueryInput } from '../types.js';
+export interface ListGrantsQuery {
+    /** Determines which page of the collection to retrieve. */
+    page?: {
+        size?: number;
+        number?: number;
+    };
+    /**
+     * Sort grants returned in the response. Supported sort attributes are:
+     *
+     * - `created_at` (default)
+     * - `updated_at`
+     * - `effective_at`
+     * - `expires_at`
+     *
+     * The `asc` suffix is optional as the default sort order is ascending. The `desc`
+     * suffix is used to specify a descending order.
+     */
+    sort?: SortQueryInput;
+    /**
+     * Filter grants returned in the response.
+     *
+     * To filter grants by customer, add the following query param:
+     * `filter[customer_id]=01K4WAQ0J99ZZ0MD75HXR112H8`
+     */
+    filter?: ListGrantsParamsFilter;
+    /** Include deleted grants in the response. */
+    includeDeleted?: boolean;
+}
+export type ListGrantsRequest = AcceptDateStrings<ListGrantsQuery>;
+export type ListGrantsResponse = EntitlementGrantPagePaginatedResponse;
+export interface VoidGrantQuery {
+    /**
+     * The time the grant is voided from. Defaults to now; it cannot be in the future
+     * or before the start of the current usage period.
+     */
+    voidedAt?: Date;
+}
+export type VoidGrantRequest = AcceptDateStrings<VoidGrantQuery & {
+    grantId: string;
+}>;
+export type VoidGrantResponse = void;

package/dist/models/operations/grants.js

@@ -0,0 +1,2 @@
+// Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
+export {};

package/dist/models/operations/notifications.d.ts

@@ -0,0 +1,46 @@
+import type { AcceptDateStrings } from '../../lib/wire.js';
+import type { CreateNotificationChannelRequestInput, ListNotificationChannelsParamsFilter, NotificationChannel, NotificationChannelPagePaginatedResponse, SortQueryInput, UpdateNotificationChannelRequestInput } from '../types.js';
+export interface ListNotificationChannelsQuery {
+    /** Determines which page of the collection to retrieve. */
+    page?: {
+        size?: number;
+        number?: number;
+    };
+    /**
+     * Sort notification channels returned in the response. Supported sort attributes
+     * are:
+     *
+     * - `id` (default)
+     * - `type`
+     * - `created_at`
+     * - `updated_at`
+     *
+     * The `asc` suffix is optional as the default sort order is ascending. The `desc`
+     * suffix is used to specify a descending order.
+     */
+    sort?: SortQueryInput;
+    /**
+     * Filter notification channels returned in the response.
+     *
+     * To filter notification channels by type add the following query param:
+     * filter[type]=webhook
+     */
+    filter?: ListNotificationChannelsParamsFilter;
+}
+export type ListNotificationChannelsRequest = AcceptDateStrings<ListNotificationChannelsQuery>;
+export type ListNotificationChannelsResponse = NotificationChannelPagePaginatedResponse;
+export type CreateNotificationChannelRequest = AcceptDateStrings<CreateNotificationChannelRequestInput>;
+export type CreateNotificationChannelResponse = NotificationChannel;
+export type GetNotificationChannelRequest = {
+    notificationChannelId: string;
+};
+export type GetNotificationChannelResponse = NotificationChannel;
+export type UpdateNotificationChannelRequest = AcceptDateStrings<{
+    notificationChannelId: string;
+    body: UpdateNotificationChannelRequestInput;
+}>;
+export type UpdateNotificationChannelResponse = NotificationChannel;
+export type DeleteNotificationChannelRequest = {
+    notificationChannelId: string;
+};
+export type DeleteNotificationChannelResponse = void;

package/dist/models/operations/notifications.js

@@ -0,0 +1,2 @@
+// Code generated by @openmeter/typespec-typescript. DO NOT EDIT.
+export {};

package/dist/models/operations/planAddons.d.ts

@@ -1,11 +1,24 @@
 import type { AcceptDateStrings } from '../../lib/wire.js';
-import type { CreatePlanAddonRequest as CreatePlanAddonRequestBody, PlanAddon, PlanAddonPagePaginatedResponse, UpsertPlanAddonRequest } from '../types.js';
+import type { CreatePlanAddonRequest as CreatePlanAddonRequestBody, ListPlanAddonsParamsFilter, PlanAddon, PlanAddonPagePaginatedResponse, SortQueryInput, UpsertPlanAddonRequest } from '../types.js';
 export interface ListPlanAddonsQuery {
     /** Determines which page of the collection to retrieve. */
     page?: {
         size?: number;
         number?: number;
     };
+    /**
+     * Sort plan add-ons returned in the response. Supported sort attributes are:
+     *
+     * - `id` (default)
+     * - `created_at`
+     * - `updated_at`
+     *
+     * The `asc` suffix is optional as the default sort order is ascending. The `desc`
+     * suffix is used to specify a descending order.
+     */
+    sort?: SortQueryInput;
+    /** Filter plan add-ons returned in the response. */
+    filter?: ListPlanAddonsParamsFilter;
 }
 export type ListPlanAddonsRequest = AcceptDateStrings<ListPlanAddonsQuery & {
     planId: string;

package/dist/models/operations/subscriptions.d.ts

@@ -1,6 +1,6 @@
 import type { AcceptDateStrings } from '../../lib/wire.js';
-import type { CreateSubscriptionAddonRequest as CreateSubscriptionAddonRequestBody, ListSubscriptionsParamsFilter, SortQueryInput, Subscription, SubscriptionAddon, SubscriptionAddonPagePaginatedResponse, SubscriptionCancelInput, SubscriptionChange, SubscriptionChangeResponse, SubscriptionCreate, SubscriptionPagePaginatedResponse } from '../types.js';
-export type CreateSubscriptionRequest = AcceptDateStrings<SubscriptionCreate>;
+import type { CreateSubscriptionAddonRequest as CreateSubscriptionAddonRequestBody, ListSubscriptionsParamsFilter, SortQueryInput, Subscription, SubscriptionAddon, SubscriptionAddonPagePaginatedResponse, SubscriptionAddonUpdate, SubscriptionCancelInput, SubscriptionChangeInput, SubscriptionChangeResponse, SubscriptionCreateInput, SubscriptionEditInput, SubscriptionMigrateInput, SubscriptionMigrateResponse, SubscriptionPagePaginatedResponse } from '../types.js';
+export type CreateSubscriptionRequest = AcceptDateStrings<SubscriptionCreateInput>;
 export type CreateSubscriptionResponse = Subscription;
 export interface ListSubscriptionsQuery {
     /** Determines which page of the collection to retrieve. */
@@ -37,11 +37,29 @@ export type UnscheduleCancelationRequest = {
     subscriptionId: string;
 };
 export type UnscheduleCancelationResponse = Subscription;
+export type UnscheduleSubscriptionRequest = {
+    subscriptionId: string;
+};
+export type UnscheduleSubscriptionResponse = void;
+export type RestoreSubscriptionRequest = {
+    subscriptionId: string;
+};
+export type RestoreSubscriptionResponse = Subscription;
 export type ChangeSubscriptionRequest = AcceptDateStrings<{
     subscriptionId: string;
-    body: SubscriptionChange;
+    body: SubscriptionChangeInput;
 }>;
 export type ChangeSubscriptionResponse = SubscriptionChangeResponse;
+export type MigrateSubscriptionRequest = AcceptDateStrings<{
+    subscriptionId: string;
+    body: SubscriptionMigrateInput;
+}>;
+export type MigrateSubscriptionResponse = SubscriptionMigrateResponse;
+export type EditSubscriptionRequest = AcceptDateStrings<{
+    subscriptionId: string;
+    body: SubscriptionEditInput;
+}>;
+export type EditSubscriptionResponse = Subscription;
 export type CreateSubscriptionAddonRequest = AcceptDateStrings<{
     subscriptionId: string;
     body: CreateSubscriptionAddonRequestBody;
@@ -75,3 +93,9 @@ export type GetSubscriptionAddonRequest = {
     subscriptionAddonId: string;
 };
 export type GetSubscriptionAddonResponse = SubscriptionAddon;
+export type UpdateSubscriptionAddonRequest = AcceptDateStrings<{
+    subscriptionId: string;
+    subscriptionAddonId: string;
+    body: SubscriptionAddonUpdate;
+}>;
+export type UpdateSubscriptionAddonResponse = SubscriptionAddon;