@openmeter/sdk 1.0.0-beta-b40fd1a9944f → 1.0.0-beta-bc6bd31aa419

package/dist/cjs/src/client/customers.d.cts

@@ -132,9 +132,9 @@ export declare class CustomerApps {
     } | {
         id?: string;
         type: "stripe";
-        readonly app?: import("./schemas.cjs").components["schemas"]["StripeApp"];
         stripeCustomerId: string;
         stripeDefaultPaymentMethodId?: string;
+        readonly app?: import("./schemas.cjs").components["schemas"]["StripeApp"];
     } | {
         readonly app?: import("./schemas.cjs").components["schemas"]["SandboxApp"];
         id?: string;

package/dist/cjs/src/client/schemas.d.cts

@@ -948,6 +948,56 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    '/api/v1/customers/{customerIdOrKey}/stripe': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get customer stripe app data
+         * @description Get stripe app data for a customer.
+         *     Only returns data if the customer billing profile is linked to a stripe app.
+         */
+        get: operations['getCustomerStripeAppData'];
+        /**
+         * Upsert customer stripe app data
+         * @description Upsert stripe app data for a customer.
+         *     Only updates data if the customer billing profile is linked to a stripe app.
+         */
+        put: operations['upsertCustomerStripeAppData'];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    '/api/v1/customers/{customerIdOrKey}/stripe/portal': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Create Stripe customer portal session
+         * @description Create Stripe customer portal session.
+         *     Only returns URL if the customer billing profile is linked to a stripe app and customer.
+         *
+         *     Useful to redirect the customer to the Stripe customer portal to manage their payment methods,
+         *     change their billing address and access their invoice history.
+         */
+        post: operations['createCustomerStripePortalSession'];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     '/api/v1/customers/{customerIdOrKey}/subscriptions': {
         parameters: {
             query?: never;
@@ -3380,6 +3430,34 @@ export interface components {
             /** @description Return URL. */
             returnURL?: string;
         };
+        /** @description Stripe customer portal request params. */
+        CreateStripeCustomerPortalSessionParams: {
+            /**
+             * Configuration
+             * @description The ID of an existing configuration to use for this session,
+             *     describing its functionality and features.
+             *     If not specified, the session uses the default configuration.
+             *
+             *     See https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-configuration
+             */
+            configurationId?: string;
+            /**
+             * Locale
+             * @description The IETF language tag of the locale customer portal is displayed in.
+             *     If blank or auto, the customer’s preferred_locales or browser’s locale is used.
+             *
+             *     See: https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-locale
+             */
+            locale?: string;
+            /**
+             * ReturnUrl
+             * @description The URL to redirect the customer to after they have completed
+             *     their requested actions.
+             *
+             *     See: https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url
+             */
+            returnUrl?: string;
+        };
         /** @description CreditNoteOriginalInvoiceRef is used to reference the original invoice that a credit note is based on. */
         CreditNoteOriginalInvoiceRef: {
             /**
@@ -8906,8 +8984,15 @@ export interface components {
              * @enum {string}
              */
             type: 'stripe';
+            /** @description The Stripe customer ID. */
+            stripeCustomerId: string;
+            /** @description The Stripe default payment method ID. */
+            stripeDefaultPaymentMethodId?: string;
             /** @description The installed stripe app this data belongs to. */
             readonly app?: components['schemas']['StripeApp'];
+        };
+        /** @description Stripe Customer App Data Base. */
+        StripeCustomerAppDataBase: {
             /** @description The Stripe customer ID. */
             stripeCustomerId: string;
             /** @description The Stripe default payment method ID. */
@@ -8938,6 +9023,47 @@ export interface components {
             /** @description The Stripe default payment method ID. */
             stripeDefaultPaymentMethodId?: string;
         };
+        /** @description Stripe customer portal session.
+         *
+         *     See: https://docs.stripe.com/api/customer_portal/sessions/object */
+        StripeCustomerPortalSession: {
+            /** @description The ID of the customer portal session.
+             *
+             *     See: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-id */
+            id: string;
+            /** @description The ID of the stripe customer. */
+            stripeCustomerId: string;
+            /** @description Configuration used to customize the customer portal.
+             *
+             *     See: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-configuration */
+            configurationId: string;
+            /** @description Livemode.
+             *
+             *     See: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-livemode */
+            livemode: boolean;
+            /**
+             * Format: date-time
+             * @description Created at.
+             *
+             *     See: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-created
+             * @example 2023-01-01T01:01:01.001Z
+             */
+            createdAt: Date;
+            /** @description Return URL.
+             *
+             *     See: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-return_url */
+            returnUrl: string;
+            /** @description Status.
+             *       /**
+             *     The IETF language tag of the locale customer portal is displayed in.
+             *
+             *     See: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-locale */
+            locale: string;
+            /** @description /**
+             *     The ID of the customer.The URL to redirect the customer to after they have completed
+             *     their requested actions. */
+            url: string;
+        };
         /** @description The tax config for Stripe. */
         StripeTaxConfig: {
             /**
@@ -10348,6 +10474,8 @@ export interface components {
         'PlanOrderByOrdering.order': components['schemas']['SortOrder'];
         /** @description The order by field. */
         'PlanOrderByOrdering.orderBy': components['schemas']['PlanOrderBy'];
+        /** @description Filter customer data by app type. */
+        'listCustomerAppDataParams.type': components['schemas']['AppType'];
         /** @description What parts of the customer output to expand */
         queryCustomerGet: components['schemas']['CustomerExpand'][];
         /** @description What parts of the list output to expand in listings */
@@ -10368,8 +10496,6 @@ export interface components {
         /** @description Filter customers by usage attribution subject.
          *     Case-insensitive partial match. */
         'queryCustomerList.subject': string;
-        /** @description Filter customer data by app type. */
-        'queryCustomerList.type': components['schemas']['AppType'];
         /** @description Include deleted meters. */
         'queryMeterList.includeDeleted': boolean;
     };
@@ -10451,6 +10577,7 @@ export type CreateStripeCheckoutSessionRedirectOnCompletion = components['schema
 export type CreateStripeCheckoutSessionRequest = components['schemas']['CreateStripeCheckoutSessionRequest'];
 export type CreateStripeCheckoutSessionRequestOptions = components['schemas']['CreateStripeCheckoutSessionRequestOptions'];
 export type CreateStripeCheckoutSessionResult = components['schemas']['CreateStripeCheckoutSessionResult'];
+export type CreateStripeCustomerPortalSessionParams = components['schemas']['CreateStripeCustomerPortalSessionParams'];
 export type CreditNoteOriginalInvoiceRef = components['schemas']['CreditNoteOriginalInvoiceRef'];
 export type Currency = components['schemas']['Currency'];
 export type CurrencyCode = components['schemas']['CurrencyCode'];
@@ -10691,7 +10818,9 @@ export type StripeApp = components['schemas']['StripeApp'];
 export type StripeAppReplaceUpdate = components['schemas']['StripeAppReplaceUpdate'];
 export type StripeCheckoutSessionMode = components['schemas']['StripeCheckoutSessionMode'];
 export type StripeCustomerAppData = components['schemas']['StripeCustomerAppData'];
+export type StripeCustomerAppDataBase = components['schemas']['StripeCustomerAppDataBase'];
 export type StripeCustomerAppDataCreateOrUpdateItem = components['schemas']['StripeCustomerAppDataCreateOrUpdateItem'];
+export type StripeCustomerPortalSession = components['schemas']['StripeCustomerPortalSession'];
 export type StripeTaxConfig = components['schemas']['StripeTaxConfig'];
 export type StripeWebhookEvent = components['schemas']['StripeWebhookEvent'];
 export type StripeWebhookResponse = components['schemas']['StripeWebhookResponse'];
@@ -10812,6 +10941,7 @@ export type ParameterPlanAddonOrderByOrderingOrder = components['parameters']['P
 export type ParameterPlanAddonOrderByOrderingOrderBy = components['parameters']['PlanAddonOrderByOrdering.orderBy'];
 export type ParameterPlanOrderByOrderingOrder = components['parameters']['PlanOrderByOrdering.order'];
 export type ParameterPlanOrderByOrderingOrderBy = components['parameters']['PlanOrderByOrdering.orderBy'];
+export type ParameterListCustomerAppDataParamsType = components['parameters']['listCustomerAppDataParams.type'];
 export type ParameterQueryCustomerGet = components['parameters']['queryCustomerGet'];
 export type ParameterQueryCustomerListExpand = components['parameters']['queryCustomerList.expand'];
 export type ParameterQueryCustomerListIncludeDeleted = components['parameters']['queryCustomerList.includeDeleted'];
@@ -10820,7 +10950,6 @@ export type ParameterQueryCustomerListName = components['parameters']['queryCust
 export type ParameterQueryCustomerListPlanKey = components['parameters']['queryCustomerList.planKey'];
 export type ParameterQueryCustomerListPrimaryEmail = components['parameters']['queryCustomerList.primaryEmail'];
 export type ParameterQueryCustomerListSubject = components['parameters']['queryCustomerList.subject'];
-export type ParameterQueryCustomerListType = components['parameters']['queryCustomerList.type'];
 export type ParameterQueryMeterListIncludeDeleted = components['parameters']['queryMeterList.includeDeleted'];
 export type $defs = Record<string, never>;
 export interface operations {
@@ -15038,7 +15167,7 @@ export interface operations {
                  *     Default is 100. */
                 pageSize?: components['parameters']['Pagination.pageSize'];
                 /** @description Filter customer data by app type. */
-                type?: components['parameters']['queryCustomerList.type'];
+                type?: components['parameters']['listCustomerAppDataParams.type'];
             };
             header?: never;
             path: {
@@ -16290,6 +16419,296 @@ export interface operations {
             };
         };
     };
+    getCustomerStripeAppData: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                customerIdOrKey: components['schemas']['ULIDOrExternalKey'];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The request has succeeded. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['StripeCustomerAppData'];
+                };
+            };
+            /** @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 The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['NotFoundProblemResponse'];
+                };
+            };
+            /** @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'];
+                };
+            };
+        };
+    };
+    upsertCustomerStripeAppData: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                customerIdOrKey: components['schemas']['ULIDOrExternalKey'];
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                'application/json': components['schemas']['StripeCustomerAppDataBase'];
+            };
+        };
+        responses: {
+            /** @description The request has succeeded. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['StripeCustomerAppData'];
+                };
+            };
+            /** @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 The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['NotFoundProblemResponse'];
+                };
+            };
+            /** @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'];
+                };
+            };
+        };
+    };
+    createCustomerStripePortalSession: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                customerIdOrKey: components['schemas']['ULIDOrExternalKey'];
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                'application/json': components['schemas']['CreateStripeCustomerPortalSessionParams'];
+            };
+        };
+        responses: {
+            /** @description The request has succeeded. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['StripeCustomerPortalSession'];
+                };
+            };
+            /** @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 The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['NotFoundProblemResponse'];
+                };
+            };
+            /** @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'];
+                };
+            };
+        };
+    };
     listCustomerSubscriptions: {
         parameters: {
             query?: {