@openmeter/sdk 1.0.0-beta.210 → 1.0.0-beta.211

package/dist/src/client/customers.d.ts

@@ -30,6 +30,7 @@ export declare class Customers {
         currency?: import("./schemas.js").components["schemas"]["CurrencyCode"];
         billingAddress?: import("./schemas.js").components["schemas"]["Address"];
         readonly currentSubscriptionId?: string;
+        readonly subscriptions?: import("./schemas.js").components["schemas"]["Subscription"][];
     }>;
     /**
      * Get a customer by ID
@@ -51,6 +52,7 @@ export declare class Customers {
         currency?: import("./schemas.js").components["schemas"]["CurrencyCode"];
         billingAddress?: import("./schemas.js").components["schemas"]["Address"];
         readonly currentSubscriptionId?: string;
+        readonly subscriptions?: import("./schemas.js").components["schemas"]["Subscription"][];
     }>;
     /**
      * Update a customer
@@ -73,6 +75,7 @@ export declare class Customers {
         currency?: import("./schemas.js").components["schemas"]["CurrencyCode"];
         billingAddress?: import("./schemas.js").components["schemas"]["Address"];
         readonly currentSubscriptionId?: string;
+        readonly subscriptions?: import("./schemas.js").components["schemas"]["Subscription"][];
     }>;
     /**
      * Delete a customer

package/dist/src/client/schemas.d.ts

@@ -956,6 +956,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    '/api/v1/marketplace/listings/{type}/install': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Install app
+         * @description Install an app from the marketplace.
+         */
+        post: operations['marketplaceAppInstall'];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     '/api/v1/marketplace/listings/{type}/install/apikey': {
         parameters: {
             query?: never;
@@ -967,7 +987,7 @@ export interface paths {
         put?: never;
         /**
          * Install app via API key
-         * @description Install an marketplace via API Key.
+         * @description Install an marketplace app via API Key.
          */
         post: operations['marketplaceAppAPIKeyInstall'];
         delete?: never;
@@ -3246,6 +3266,12 @@ export interface components {
              * @example 01G65Z755AFWAKHE12NY0CQ9FH
              */
             readonly currentSubscriptionId?: string;
+            /**
+             * Subscriptions
+             * @description The subscriptions of the customer.
+             *     Only with the `subscriptions` expand option.
+             */
+            readonly subscriptions?: components['schemas']['Subscription'][];
         };
         /** @description CustomerAccess describes what features the customer has access to. */
         CustomerAccess: {
@@ -3326,6 +3352,11 @@ export interface components {
              */
             billingAddress?: components['schemas']['Address'];
         };
+        /**
+         * @description CustomerExpand specifies the parts of the customer to expand in the list output.
+         * @enum {string}
+         */
+        CustomerExpand: 'subscriptions';
         /** @description Create Stripe checkout session with customer ID. */
         CustomerId: {
             /**
@@ -4742,6 +4773,11 @@ export interface components {
             /** @description The cursor of the last item in the list. */
             nextCursor?: string;
         };
+        /**
+         * @description Install method of the application.
+         * @enum {string}
+         */
+        InstallMethod: 'with_oauth2' | 'with_api_key' | 'no_credentials_required';
         /** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
         InternalServerErrorProblemResponse: components['schemas']['UnexpectedProblemResponse'];
         /** @description Invoice represents an invoice in the system. */
@@ -6024,6 +6060,10 @@ export interface components {
          *           "name": "Collect Payments",
          *           "description": "Stripe payments collects outstanding revenue with Stripe customer's default payment method."
          *         }
+         *       ],
+         *       "installMethods": [
+         *         "with_oauth2",
+         *         "with_api_key"
          *       ]
          *     }
          */
@@ -6036,6 +6076,10 @@ export interface components {
             description: string;
             /** @description The app's capabilities. */
             capabilities: components['schemas']['AppCapability'][];
+            /** @description Install methods.
+             *
+             *     List of methods to install the app. */
+            installMethods: components['schemas']['InstallMethod'][];
         };
         /** @description Paginated response */
         MarketplaceListingPaginatedResponse: {
@@ -7079,6 +7123,16 @@ export interface components {
              * @example 2024-01-01T01:01:01.001Z
              */
             readonly deletedAt?: Date;
+            /**
+             * Annotations
+             * @description Set of key-value pairs managed by the system. Cannot be modified by user.
+             */
+            readonly annotations?: components['schemas']['Annotations'];
+            /**
+             * Metadata
+             * @description Additional metadata for the resource.
+             */
+            metadata?: components['schemas']['Metadata'];
             /**
              * Addon
              * @description Partially populated add-on properties.
@@ -7119,36 +7173,13 @@ export interface components {
              */
             maxQuantity?: number;
         };
-        /** @description Resource create operation model. */
+        /** @description A plan add-on assignment create request. */
         PlanAddonCreate: {
             /**
-             * Addon
-             * @description Partially populated add-on properties.
+             * Metadata
+             * @description Additional metadata for the resource.
              */
-            addon: {
-                /**
-                 * ID
-                 * @description The ID of the add-on.
-                 * @example 01G65Z755AFWAKHE12NY0CQ9FH
-                 */
-                id: string;
-                /**
-                 * Key
-                 * @description A semi-unique identifier for the resource.
-                 */
-                readonly key: string;
-                /**
-                 * Version
-                 * @description The version of the Add-on which templates this instance.
-                 * @default 1
-                 */
-                readonly version: number;
-                /**
-                 * InstanceType
-                 * @description The instance type of the add-on.
-                 */
-                readonly instanceType: components['schemas']['AddonInstanceType'];
-            };
+            metadata?: components['schemas']['Metadata'];
             /**
              * The plan phase from the add-on becomes purchasable
              * @description The key of the plan phase from the add-on becomes available for purchase.
@@ -7160,37 +7191,50 @@ export interface components {
              *     It is not applicable for add-ons with single instance type.
              */
             maxQuantity?: number;
-        };
-        /** @description Resource update operation model. */
-        PlanAddonReplaceUpdate: {
             /**
              * Addon
-             * @description Partially populated add-on properties.
+             * @description The add-on to create.
              */
             addon: {
                 /**
-                 * ID
                  * @description The ID of the add-on.
                  * @example 01G65Z755AFWAKHE12NY0CQ9FH
                  */
                 id: string;
-                /**
-                 * Key
-                 * @description A semi-unique identifier for the resource.
-                 */
-                readonly key: string;
-                /**
-                 * Version
-                 * @description The version of the Add-on which templates this instance.
-                 * @default 1
-                 */
-                readonly version: number;
-                /**
-                 * InstanceType
-                 * @description The instance type of the add-on.
-                 */
-                readonly instanceType: components['schemas']['AddonInstanceType'];
             };
+        };
+        /**
+         * @description Order by options for plan add-on assignments.
+         * @enum {string}
+         */
+        PlanAddonOrderBy: 'id' | 'key' | 'version' | 'created_at' | 'updated_at';
+        /** @description Paginated response */
+        PlanAddonPaginatedResponse: {
+            /**
+             * @description The total number of items.
+             * @example 500
+             */
+            totalCount: number;
+            /**
+             * @description The page index.
+             * @example 1
+             */
+            page: number;
+            /**
+             * @description The maximum number of items per page.
+             * @example 100
+             */
+            pageSize: number;
+            /** @description The items in the current page. */
+            items: components['schemas']['PlanAddon'][];
+        };
+        /** @description Resource update operation model. */
+        PlanAddonReplaceUpdate: {
+            /**
+             * Metadata
+             * @description Additional metadata for the resource.
+             */
+            metadata?: components['schemas']['Metadata'];
             /**
              * The plan phase from the add-on becomes purchasable
              * @description The key of the plan phase from the add-on becomes available for purchase.
@@ -7882,6 +7926,10 @@ export interface components {
          *             "name": "Collect Payments",
          *             "description": "Stripe payments collects outstanding revenue with Stripe customer's default payment method."
          *           }
+         *         ],
+         *         "installMethods": [
+         *           "with_oauth2",
+         *           "with_api_key"
          *         ]
          *       },
          *       "createdAt": "2024-01-01T01:01:01.001Z",
@@ -8335,7 +8383,7 @@ export interface components {
              */
             readonly rateCards: components['schemas']['SubscriptionAddonRateCard'][];
         };
-        /** @description Resource create operation model. */
+        /** @description A subscription add-on create body. */
         SubscriptionAddonCreate: {
             /**
              * Display name
@@ -8364,34 +8412,6 @@ export interface components {
              * @example 2023-01-01T01:01:01.001Z
              */
             activeTo?: Date;
-            /**
-             * Addon
-             * @description Partially populated add-on properties.
-             */
-            addon: {
-                /**
-                 * ID
-                 * @description The ID of the add-on.
-                 * @example 01G65Z755AFWAKHE12NY0CQ9FH
-                 */
-                id: string;
-                /**
-                 * Key
-                 * @description A semi-unique identifier for the resource.
-                 */
-                readonly key: string;
-                /**
-                 * Version
-                 * @description The version of the Add-on which templates this instance.
-                 * @default 1
-                 */
-                readonly version: number;
-                /**
-                 * InstanceType
-                 * @description The instance type of the add-on.
-                 */
-                readonly instanceType: components['schemas']['AddonInstanceType'];
-            };
             /**
              * Quantity
              * @description The quantity of the add-on. Always 1 for single instance add-ons.
@@ -8403,6 +8423,17 @@ export interface components {
              * @description The timing of the operation. After the create or update, a new entry will be created in the timeline.
              */
             timing: components['schemas']['SubscriptionTiming'];
+            /**
+             * Addon
+             * @description The add-on to create.
+             */
+            addon: {
+                /**
+                 * @description The ID of the add-on.
+                 * @example 01G65Z755AFWAKHE12NY0CQ9FH
+                 */
+                id: string;
+            };
         };
         /** @description A rate card for a subscription add-on. */
         SubscriptionAddonRateCard: {
@@ -8467,11 +8498,6 @@ export interface components {
              * @example 2023-01-01T01:01:01.001Z
              */
             activeTo?: Date;
-            /**
-             * Addon
-             * @description Partially populated add-on properties.
-             */
-            addon?: Record<string, never>;
             /**
              * Quantity
              * @description The quantity of the add-on. Always 1 for single instance add-ons.
@@ -9209,6 +9235,8 @@ export interface components {
         /** @description The type of the app to install. */
         'MarketplaceApiKeyInstallRequest.type': components['schemas']['AppType'];
         /** @description The type of the app to install. */
+        'MarketplaceInstallRequest.type': components['schemas']['AppType'];
+        /** @description The type of the app to install. */
         'MarketplaceOAuth2InstallAuthorizeRequest.type': components['schemas']['AppType'];
         /** @description The order direction. */
         'MeterOrderByOrdering.order': components['schemas']['SortOrder'];
@@ -9293,9 +9321,17 @@ export interface components {
          *     Default is 100. */
         'Pagination.pageSize': number;
         /** @description The order direction. */
+        'PlanAddonOrderByOrdering.order': components['schemas']['SortOrder'];
+        /** @description The order by field. */
+        'PlanAddonOrderByOrdering.orderBy': components['schemas']['PlanAddonOrderBy'];
+        /** @description The order direction. */
         'PlanOrderByOrdering.order': components['schemas']['SortOrder'];
         /** @description The order by field. */
         'PlanOrderByOrdering.orderBy': components['schemas']['PlanOrderBy'];
+        /** @description What parts of the customer output to expand */
+        queryCustomerGet: components['schemas']['CustomerExpand'][];
+        /** @description What parts of the list output to expand in listings */
+        'queryCustomerList.expand': components['schemas']['CustomerExpand'][];
         /** @description Include deleted customers. */
         'queryCustomerList.includeDeleted': boolean;
         /** @description Filter customers by key.
@@ -9404,6 +9440,7 @@ export type CustomerAccess = components['schemas']['CustomerAccess'];
 export type CustomerAppData = components['schemas']['CustomerAppData'];
 export type CustomerAppDataPaginatedResponse = components['schemas']['CustomerAppDataPaginatedResponse'];
 export type CustomerCreate = components['schemas']['CustomerCreate'];
+export type CustomerExpand = components['schemas']['CustomerExpand'];
 export type CustomerId = components['schemas']['CustomerId'];
 export type CustomerKey = components['schemas']['CustomerKey'];
 export type CustomerOrderBy = components['schemas']['CustomerOrderBy'];
@@ -9460,6 +9497,7 @@ export type IdResource = components['schemas']['IDResource'];
 export type IngestEventsBody = components['schemas']['IngestEventsBody'];
 export type IngestedEvent = components['schemas']['IngestedEvent'];
 export type IngestedEventCursorPaginatedResponse = components['schemas']['IngestedEventCursorPaginatedResponse'];
+export type InstallMethod = components['schemas']['InstallMethod'];
 export type InternalServerErrorProblemResponse = components['schemas']['InternalServerErrorProblemResponse'];
 export type Invoice = components['schemas']['Invoice'];
 export type InvoiceAppExternalIds = components['schemas']['InvoiceAppExternalIds'];
@@ -9566,6 +9604,8 @@ export type Period = components['schemas']['Period'];
 export type Plan = components['schemas']['Plan'];
 export type PlanAddon = components['schemas']['PlanAddon'];
 export type PlanAddonCreate = components['schemas']['PlanAddonCreate'];
+export type PlanAddonOrderBy = components['schemas']['PlanAddonOrderBy'];
+export type PlanAddonPaginatedResponse = components['schemas']['PlanAddonPaginatedResponse'];
 export type PlanAddonReplaceUpdate = components['schemas']['PlanAddonReplaceUpdate'];
 export type PlanCreate = components['schemas']['PlanCreate'];
 export type PlanOrderBy = components['schemas']['PlanOrderBy'];
@@ -9687,6 +9727,7 @@ export type ParameterInvoiceOrderByOrderingOrderBy = components['parameters']['I
 export type ParameterLimitOffsetLimit = components['parameters']['LimitOffset.limit'];
 export type ParameterLimitOffsetOffset = components['parameters']['LimitOffset.offset'];
 export type ParameterMarketplaceApiKeyInstallRequestType = components['parameters']['MarketplaceApiKeyInstallRequest.type'];
+export type ParameterMarketplaceInstallRequestType = components['parameters']['MarketplaceInstallRequest.type'];
 export type ParameterMarketplaceOAuth2InstallAuthorizeRequestType = components['parameters']['MarketplaceOAuth2InstallAuthorizeRequest.type'];
 export type ParameterMeterOrderByOrderingOrder = components['parameters']['MeterOrderByOrdering.order'];
 export type ParameterMeterOrderByOrderingOrderBy = components['parameters']['MeterOrderByOrdering.orderBy'];
@@ -9711,8 +9752,12 @@ export type ParameterOAuth2AuthorizationCodeGrantSuccessParamsCode = components[
 export type ParameterOAuth2AuthorizationCodeGrantSuccessParamsState = components['parameters']['OAuth2AuthorizationCodeGrantSuccessParams.state'];
 export type ParameterPaginationPage = components['parameters']['Pagination.page'];
 export type ParameterPaginationPageSize = components['parameters']['Pagination.pageSize'];
+export type ParameterPlanAddonOrderByOrderingOrder = components['parameters']['PlanAddonOrderByOrdering.order'];
+export type ParameterPlanAddonOrderByOrderingOrderBy = components['parameters']['PlanAddonOrderByOrdering.orderBy'];
 export type ParameterPlanOrderByOrderingOrder = components['parameters']['PlanOrderByOrdering.order'];
 export type ParameterPlanOrderByOrderingOrderBy = components['parameters']['PlanOrderByOrdering.orderBy'];
+export type ParameterQueryCustomerGet = components['parameters']['queryCustomerGet'];
+export type ParameterQueryCustomerListExpand = components['parameters']['queryCustomerList.expand'];
 export type ParameterQueryCustomerListIncludeDeleted = components['parameters']['queryCustomerList.includeDeleted'];
 export type ParameterQueryCustomerListKey = components['parameters']['queryCustomerList.key'];
 export type ParameterQueryCustomerListName = components['parameters']['queryCustomerList.name'];
@@ -13001,6 +13046,8 @@ export interface operations {
                 subject?: components['parameters']['queryCustomerList.subject'];
                 /** @description Filter customers by the plan key of their susbcription. */
                 planKey?: components['parameters']['queryCustomerList.planKey'];
+                /** @description What parts of the list output to expand in listings */
+                expand?: components['parameters']['queryCustomerList.expand'];
             };
             header?: never;
             path?: never;
@@ -13171,7 +13218,10 @@ export interface operations {
     };
     getCustomer: {
         parameters: {
-            query?: never;
+            query?: {
+                /** @description What parts of the customer output to expand */
+                expand?: components['parameters']['queryCustomerGet'];
+            };
             header?: never;
             path: {
                 customerIdOrKey: string;
@@ -15488,6 +15538,101 @@ export interface operations {
             };
         };
     };
+    marketplaceAppInstall: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The type of the app to install. */
+                type: components['parameters']['MarketplaceInstallRequest.type'];
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                'application/json': {
+                    /** @description Name of the application to install.
+                     *
+                     *     If not set defaults to the marketplace item's description. */
+                    name?: string;
+                };
+            };
+        };
+        responses: {
+            /** @description The request has succeeded. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['MarketplaceInstallResponse'];
+                };
+            };
+            /** @description The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['BadRequestProblemResponse'];
+                };
+            };
+            /** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
+                };
+            };
+            /** @description The server understood the request but refuses to authorize it. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
+                };
+            };
+            /** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
+            412: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['PreconditionFailedProblemResponse'];
+                };
+            };
+            /** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['InternalServerErrorProblemResponse'];
+                };
+            };
+            /** @description The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay. */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['ServiceUnavailableProblemResponse'];
+                };
+            };
+            /** @description An unexpected error response. */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['UnexpectedProblemResponse'];
+                };
+            };
+        };
+    };
     marketplaceAppAPIKeyInstall: {
         parameters: {
             query?: never;
@@ -18382,7 +18527,32 @@ export interface operations {
     };
     listPlanAddons: {
         parameters: {
-            query?: never;
+            query?: {
+                /** @description Include deleted plan add-on assignments.
+                 *
+                 *     Usage: `?includeDeleted=true` */
+                includeDeleted?: boolean;
+                /** @description Filter by addon.id attribute. */
+                id?: string[];
+                /** @description Filter by addon.key attribute. */
+                key?: string[];
+                /** @description Filter by addon.key and addon.version attributes. */
+                keyVersion?: {
+                    [key: string]: number[];
+                };
+                /** @description Page index.
+                 *
+                 *     Default is 1. */
+                page?: components['parameters']['Pagination.page'];
+                /** @description The maximum number of items per page.
+                 *
+                 *     Default is 100. */
+                pageSize?: components['parameters']['Pagination.pageSize'];
+                /** @description The order direction. */
+                order?: components['parameters']['PlanAddonOrderByOrdering.order'];
+                /** @description The order by field. */
+                orderBy?: components['parameters']['PlanAddonOrderByOrdering.orderBy'];
+            };
             header?: never;
             path: {
                 planId: string;
@@ -18397,7 +18567,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    'application/json': components['schemas']['PlanAddon'][];
+                    'application/json': components['schemas']['PlanAddonPaginatedResponse'];
                 };
             };
             /** @description The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). */