@archildata/api-types 0.0.47 → 0.0.49

package/index.d.ts

@@ -41,6 +41,29 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/billing/payment-methods/{paymentMethodID}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                paymentMethodID: string;
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /**
+         * Delete a saved payment method
+         * @description Deletes the saved payment method from the Archil account. To use the same card again, add it as a new payment method.
+         */
+        delete: operations["deleteBillingPaymentMethod"];
+        options?: never;
+        head?: never;
+        /** Edit a saved card's billing name or address */
+        patch: operations["updateBillingPaymentMethod"];
+        trace?: never;
+    };
     "/api/billing/setup-intents": {
         parameters: {
             query?: never;
@@ -50,7 +73,10 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** Start card setup with Stripe Elements */
+        /**
+         * Start card setup with Stripe Elements
+         * @description Confirm the returned SetupIntent with Stripe Elements in the client.
+         */
         post: operations["createBillingSetupIntent"];
         delete?: never;
         options?: never;
@@ -78,6 +104,24 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/billing/profile": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get invoice billing details from Stripe */
+        get: operations["getBillingProfile"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        /** Update invoice billing details in Stripe */
+        patch: operations["updateBillingProfile"];
+        trace?: never;
+    };
     "/api/activity": {
         parameters: {
             query?: never;
@@ -915,10 +959,41 @@ export interface components {
                 /** Format: int64 */
                 expYear: number;
             };
+            billingDetails?: {
+                name: string;
+                address?: components["schemas"]["BillingAddress"];
+            };
             isCustomerDefault: boolean;
             isSubscriptionDefault: boolean;
             isDefault: boolean;
         };
+        BillingAddress: {
+            line1: string;
+            line2: string;
+            city: string;
+            state: string;
+            postalCode: string;
+            country: string;
+        };
+        BillingAddressPatch: {
+            line1?: string;
+            line2?: string;
+            city?: string;
+            state?: string;
+            postalCode?: string;
+            country?: string;
+        };
+        ApiResponse_BillingPaymentMethod: {
+            success: boolean;
+            data: components["schemas"]["BillingPaymentMethod"];
+        };
+        ApiResponse_BillingMethodRemoved: {
+            success: boolean;
+            data: {
+                id: string;
+                removed: boolean;
+            };
+        };
         ApiResponse_BillingPaymentMethods: {
             success: boolean;
             data: components["schemas"]["BillingPaymentMethod"][];
@@ -941,6 +1016,28 @@ export interface components {
                 scope: "customer" | "customer_and_subscription";
             };
         };
+        BillingProfile: {
+            /** @enum {string} */
+            billingMode: "not_setup" | "self_serve";
+            name: string;
+            email: string;
+            phone: string;
+            address?: components["schemas"]["BillingAddress"];
+        };
+        BillingProfileValidationError: components["schemas"]["ErrorResponse"] & {
+            /** @enum {string} */
+            code: "invalid_billing_profile";
+            data: {
+                /** @description Validation messages keyed by profile field name. */
+                fieldErrors: {
+                    [key: string]: string;
+                };
+            };
+        };
+        ApiResponse_BillingProfile: {
+            success: boolean;
+            data: components["schemas"]["BillingProfile"];
+        };
         ActivityEvent: {
             accountId: string;
             /**
@@ -2248,6 +2345,83 @@ export interface operations {
             };
         };
     };
+    deleteBillingPaymentMethod: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                paymentMethodID: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Saved payment method deleted from the Archil account */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ApiResponse_BillingMethodRemoved"];
+                };
+            };
+            400: components["responses"]["ValidationError"];
+            /** @description Missing, invalid, or disallowed credential */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            404: components["responses"]["NotFound"];
+            409: components["responses"]["ValidationError"];
+            502: components["responses"]["InternalError"];
+        };
+    };
+    updateBillingPaymentMethod: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                paymentMethodID: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    name?: string;
+                    address?: components["schemas"]["BillingAddressPatch"];
+                };
+            };
+        };
+        responses: {
+            /** @description Updated safe method details */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ApiResponse_BillingPaymentMethod"];
+                };
+            };
+            400: components["responses"]["ValidationError"];
+            /** @description Missing, invalid, or disallowed credential */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            404: components["responses"]["NotFound"];
+            409: components["responses"]["ValidationError"];
+            502: components["responses"]["InternalError"];
+        };
+    };
     createBillingSetupIntent: {
         parameters: {
             query?: never;
@@ -2335,6 +2509,69 @@ export interface operations {
             502: components["responses"]["InternalError"];
         };
     };
+    getBillingProfile: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Billing profile, or empty fields when billing is not set up */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ApiResponse_BillingProfile"];
+                };
+            };
+            403: components["responses"]["Unauthorized"];
+            502: components["responses"]["InternalError"];
+        };
+    };
+    updateBillingProfile: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    name?: string;
+                    /** Format: email */
+                    email?: string;
+                    phone?: string;
+                    address?: components["schemas"]["BillingAddressPatch"];
+                };
+            };
+        };
+        responses: {
+            /** @description Saved invoice billing profile */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ApiResponse_BillingProfile"];
+                };
+            };
+            /** @description Invalid profile, with fieldErrors in data */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["BillingProfileValidationError"];
+                };
+            };
+            403: components["responses"]["Unauthorized"];
+            502: components["responses"]["InternalError"];
+        };
+    };
     listActivity: {
         parameters: {
             query?: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@archildata/api-types",
-  "version": "0.0.47",
+  "version": "0.0.49",
   "description": "API types for the Archil control plane",
   "type": "module",
   "types": "index.d.ts",