@cloudfleet/sdk 0.0.1-017af9f → 0.0.1-028b8fa

package/dist/schemas.gen.js

@@ -2,6 +2,15 @@
 export const BillingContactSchema = {
     type: 'object',
     properties: {
+        type: {
+            type: 'string',
+            description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
+            example: 'business',
+            enum: [
+                'business',
+                'personal'
+            ]
+        },
         company: {
             type: 'string',
             maxLength: 120,
@@ -207,6 +216,7 @@ export const BillingContactSchema = {
         }
     },
     required: [
+        'type',
         'email',
         'individual_name'
     ],
@@ -748,10 +758,10 @@ export const FleetCreateInputSchema = {
             type: 'object',
             properties: {
                 cpu: {
-                    type: 'number',
-                    format: 'float',
+                    type: 'integer',
                     minimum: 0,
-                    description: 'CPU limit in cores.'
+                    maximum: 100000,
+                    description: 'CPU limit in cores. Maximum 100,000.'
                 }
             },
             additionalProperties: false,
@@ -761,16 +771,17 @@ export const FleetCreateInputSchema = {
             type: 'object',
             properties: {
                 enabled: {
-                    type: 'boolean',
-                    default: true
+                    type: 'boolean'
                 },
                 project: {
                     type: 'string',
-                    description: 'Project GCP Project id to deploy instances into'
+                    pattern: '^[a-z][a-z0-9-]{4,28}[a-z0-9]$',
+                    description: 'GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.',
+                    example: 'my-cloudfleet-project'
                 }
             },
             required: [
-                'project'
+                'enabled'
             ],
             additionalProperties: false
         },
@@ -778,30 +789,36 @@ export const FleetCreateInputSchema = {
             type: 'object',
             properties: {
                 enabled: {
-                    type: 'boolean',
-                    default: true
+                    type: 'boolean'
                 },
                 apiKey: {
                     type: 'string',
-                    description: 'Hetzner Cloud API key with read / write access. On update, omit this field to keep the existing value.'
+                    maxLength: 64,
+                    minLength: 64,
+                    pattern: '^[A-Za-z0-9]+$',
+                    description: 'Hetzner Cloud API token with read / write access (64 alphanumeric characters). Omit this field to keep the existing value.'
                 }
             },
+            required: [
+                'enabled'
+            ],
             additionalProperties: false
         },
         aws: {
             type: 'object',
             properties: {
                 enabled: {
-                    type: 'boolean',
-                    default: true
+                    type: 'boolean'
                 },
                 controllerRoleArn: {
                     type: 'string',
-                    description: 'ControllerRoleArn is the AWS IAM role that Karpenter uses to manage resources.'
+                    pattern: '^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$',
+                    description: 'AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.',
+                    example: 'arn:aws:iam::123456789012:role/Cloudfleet'
                 }
             },
             required: [
-                'controllerRoleArn'
+                'enabled'
             ],
             additionalProperties: false
         },
@@ -817,7 +834,12 @@ export const FleetCreateInputSchema = {
                             'spot'
                         ]
                     },
-                    description: 'Allowed values for `karpenter.sh/capacity-type`.'
+                    minItems: 1,
+                    description: 'Allowed values for `karpenter.sh/capacity-type`.',
+                    default: [
+                        'on-demand',
+                        'spot'
+                    ]
                 },
                 'kubernetes.io/arch': {
                     type: 'array',
@@ -828,7 +850,11 @@ export const FleetCreateInputSchema = {
                             'arm64'
                         ]
                     },
-                    description: 'Allowed values for `kubernetes.io/arch`.'
+                    minItems: 1,
+                    description: 'Allowed values for `kubernetes.io/arch`.',
+                    default: [
+                        'amd64'
+                    ]
                 },
                 'cfke.io/instance-family': {
                     type: 'array',
@@ -1077,6 +1103,7 @@ export const FleetCreateInputSchema = {
         scalingProfile: {
             type: 'string',
             description: 'Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.',
+            default: 'conservative',
             example: 'conservative',
             enum: [
                 'aggressive',
@@ -1104,10 +1131,10 @@ export const FleetSchema = {
             type: 'object',
             properties: {
                 cpu: {
-                    type: 'number',
-                    format: 'float',
+                    type: 'integer',
                     minimum: 0,
-                    description: 'CPU limit in cores.'
+                    maximum: 100000,
+                    description: 'CPU limit in cores. Maximum 100,000.'
                 }
             },
             additionalProperties: false,
@@ -1117,16 +1144,17 @@ export const FleetSchema = {
             type: 'object',
             properties: {
                 enabled: {
-                    type: 'boolean',
-                    default: true
+                    type: 'boolean'
                 },
                 project: {
                     type: 'string',
-                    description: 'Project GCP Project id to deploy instances into'
+                    pattern: '^[a-z][a-z0-9-]{4,28}[a-z0-9]$',
+                    description: 'GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.',
+                    example: 'my-cloudfleet-project'
                 }
             },
             required: [
-                'project'
+                'enabled'
             ],
             additionalProperties: false
         },
@@ -1134,30 +1162,34 @@ export const FleetSchema = {
             type: 'object',
             properties: {
                 enabled: {
-                    type: 'boolean',
-                    default: true
+                    type: 'boolean'
                 },
                 apiKey: {
                     type: 'string',
-                    description: 'Hetzner Cloud API key with read / write access. On update, omit this field to keep the existing value.'
+                    pattern: '^\\*{64}$',
+                    description: 'Redacted Hetzner API token. Returned as 64 asterisks when a token is configured; omitted otherwise. The real value is never echoed by the API.'
                 }
             },
+            required: [
+                'enabled'
+            ],
             additionalProperties: false
         },
         aws: {
             type: 'object',
             properties: {
                 enabled: {
-                    type: 'boolean',
-                    default: true
+                    type: 'boolean'
                 },
                 controllerRoleArn: {
                     type: 'string',
-                    description: 'ControllerRoleArn is the AWS IAM role that Karpenter uses to manage resources.'
+                    pattern: '^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$',
+                    description: 'AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.',
+                    example: 'arn:aws:iam::123456789012:role/Cloudfleet'
                 }
             },
             required: [
-                'controllerRoleArn'
+                'enabled'
             ],
             additionalProperties: false
         },
@@ -1173,7 +1205,12 @@ export const FleetSchema = {
                             'spot'
                         ]
                     },
-                    description: 'Allowed values for `karpenter.sh/capacity-type`.'
+                    minItems: 1,
+                    description: 'Allowed values for `karpenter.sh/capacity-type`.',
+                    default: [
+                        'on-demand',
+                        'spot'
+                    ]
                 },
                 'kubernetes.io/arch': {
                     type: 'array',
@@ -1184,7 +1221,11 @@ export const FleetSchema = {
                             'arm64'
                         ]
                     },
-                    description: 'Allowed values for `kubernetes.io/arch`.'
+                    minItems: 1,
+                    description: 'Allowed values for `kubernetes.io/arch`.',
+                    default: [
+                        'amd64'
+                    ]
                 },
                 'cfke.io/instance-family': {
                     type: 'array',
@@ -1433,6 +1474,7 @@ export const FleetSchema = {
         scalingProfile: {
             type: 'string',
             description: 'Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.',
+            default: 'conservative',
             example: 'conservative',
             enum: [
                 'aggressive',
@@ -1449,6 +1491,7 @@ export const FleetSchema = {
         }
     },
     required: [
+        'scalingProfile',
         'id'
     ],
     additionalProperties: false
@@ -1460,10 +1503,10 @@ export const FleetUpdateInputSchema = {
             type: 'object',
             properties: {
                 cpu: {
-                    type: 'number',
-                    format: 'float',
+                    type: 'integer',
                     minimum: 0,
-                    description: 'CPU limit in cores.'
+                    maximum: 100000,
+                    description: 'CPU limit in cores. Maximum 100,000.'
                 }
             },
             additionalProperties: false,
@@ -1473,16 +1516,17 @@ export const FleetUpdateInputSchema = {
             type: 'object',
             properties: {
                 enabled: {
-                    type: 'boolean',
-                    default: true
+                    type: 'boolean'
                 },
                 project: {
                     type: 'string',
-                    description: 'Project GCP Project id to deploy instances into'
+                    pattern: '^[a-z][a-z0-9-]{4,28}[a-z0-9]$',
+                    description: 'GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.',
+                    example: 'my-cloudfleet-project'
                 }
             },
             required: [
-                'project'
+                'enabled'
             ],
             additionalProperties: false
         },
@@ -1490,30 +1534,36 @@ export const FleetUpdateInputSchema = {
             type: 'object',
             properties: {
                 enabled: {
-                    type: 'boolean',
-                    default: true
+                    type: 'boolean'
                 },
                 apiKey: {
                     type: 'string',
-                    description: 'Hetzner Cloud API key with read / write access. On update, omit this field to keep the existing value.'
+                    maxLength: 64,
+                    minLength: 64,
+                    pattern: '^[A-Za-z0-9]+$',
+                    description: 'Hetzner Cloud API token with read / write access (64 alphanumeric characters). Omit this field to keep the existing value.'
                 }
             },
+            required: [
+                'enabled'
+            ],
             additionalProperties: false
         },
         aws: {
             type: 'object',
             properties: {
                 enabled: {
-                    type: 'boolean',
-                    default: true
+                    type: 'boolean'
                 },
                 controllerRoleArn: {
                     type: 'string',
-                    description: 'ControllerRoleArn is the AWS IAM role that Karpenter uses to manage resources.'
+                    pattern: '^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$',
+                    description: 'AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.',
+                    example: 'arn:aws:iam::123456789012:role/Cloudfleet'
                 }
             },
             required: [
-                'controllerRoleArn'
+                'enabled'
             ],
             additionalProperties: false
         },
@@ -1529,6 +1579,7 @@ export const FleetUpdateInputSchema = {
                             'spot'
                         ]
                     },
+                    minItems: 1,
                     description: 'Allowed values for `karpenter.sh/capacity-type`.'
                 },
                 'kubernetes.io/arch': {
@@ -1540,6 +1591,7 @@ export const FleetUpdateInputSchema = {
                             'arm64'
                         ]
                     },
+                    minItems: 1,
                     description: 'Allowed values for `kubernetes.io/arch`.'
                 },
                 'cfke.io/instance-family': {
@@ -1796,6 +1848,9 @@ export const FleetUpdateInputSchema = {
             ]
         }
     },
+    required: [
+        'scalingProfile'
+    ],
     additionalProperties: false
 };
 export const InviteSchema = {
@@ -2048,6 +2103,15 @@ export const MarketplaceListingSchema = {
 export const OrganizationCreateInputSchema = {
     type: 'object',
     properties: {
+        type: {
+            type: 'string',
+            description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
+            example: 'business',
+            enum: [
+                'business',
+                'personal'
+            ]
+        },
         email: {
             type: 'string',
             format: 'email',
@@ -2056,11 +2120,13 @@ export const OrganizationCreateInputSchema = {
         },
         first_name: {
             type: 'string',
+            minLength: 1,
             description: 'First name of the billing contact person.',
             example: 'John'
         },
         last_name: {
             type: 'string',
+            minLength: 1,
             description: 'Last name of the billing contact person.',
             example: 'Doe'
         },
@@ -2079,6 +2145,7 @@ export const OrganizationCreateInputSchema = {
         }
     },
     required: [
+        'type',
         'email',
         'first_name',
         'last_name',
@@ -2087,6 +2154,20 @@ export const OrganizationCreateInputSchema = {
     ],
     additionalProperties: false
 };
+export const OrganizationCreateOutputSchema = {
+    type: 'object',
+    properties: {
+        id: {
+            type: 'string',
+            description: 'Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.',
+            example: 'organization-id'
+        }
+    },
+    required: [
+        'id'
+    ],
+    additionalProperties: false
+};
 export const OrganizationSchema = {
     type: 'object',
     properties: {
@@ -2103,6 +2184,15 @@ export const OrganizationSchema = {
             description: 'Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.',
             example: 'ACME Corp.'
         },
+        type: {
+            type: 'string',
+            description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
+            example: 'business',
+            enum: [
+                'business',
+                'personal'
+            ]
+        },
         date_created: {
             type: 'string',
             format: 'date-time',
@@ -2212,13 +2302,25 @@ export const OrganizationSchema = {
                 'closed',
                 'suspended'
             ]
+        },
+        verification: {
+            type: 'string',
+            description: 'Verification status of the organization, which determines the assigned quota. `none` when billing information is incomplete, `submitted` when billing information is complete but the organization is not yet verified, `verified` when the organization is verified.',
+            example: 'verified',
+            enum: [
+                'none',
+                'submitted',
+                'verified'
+            ]
         }
     },
     required: [
         'id',
+        'type',
         'date_created',
         'quota',
-        'status'
+        'status',
+        'verification'
     ],
     additionalProperties: false
 };
@@ -2227,28 +2329,23 @@ export const PaymentMethodSchema = {
     properties: {
         id: {
             type: 'string',
-            format: 'uuid',
-            description: 'Unique identifier of the organization. UUID v4 string in canonical form.',
-            example: 'e94d30ec-a2dd-4dcb-832c-ac2be144ba91'
-        },
-        setup: {
-            type: 'boolean',
-            description: 'Whether organization payment method was set up and ready to use for payments.',
-            example: true
+            description: 'Payment method identifier. Stripe payment method id for cards/SEPA; the constant `bank_transfer` for the invoice/bank-transfer method. Used to set as default or delete the payment method.',
+            example: 'pm_1MtwBwLkdIwHu7ix28a3tqPa'
         },
         type: {
             type: 'string',
-            nullable: true,
-            description: 'Payment method type type. Only `card` payments supported at the moment.',
+            description: 'Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.',
             example: 'card',
             enum: [
-                'card'
+                'card',
+                'sepa_debit',
+                'bank_transfer'
             ]
         },
         last4: {
             type: 'string',
             nullable: true,
-            description: 'Last 4 digits of the payment card number.',
+            description: 'Last 4 digits of the payment card number, of the bank account (IBAN) for SEPA Direct Debit, or of the destination IBAN for bank transfer.',
             example: '4242'
         },
         exp_month: {
@@ -2256,42 +2353,56 @@ export const PaymentMethodSchema = {
             minimum: 1,
             maximum: 12,
             nullable: true,
-            description: 'Two-digit number representing the card\'s expiration month.',
-            example: '12'
+            description: 'Two-digit number representing the card\'s expiration month. Null for SEPA Direct Debit and bank transfer.',
+            example: 12
         },
         exp_year: {
             type: 'integer',
-            minimum: 2024,
             nullable: true,
-            description: 'Four-digit number representing the card\'s expiration year.',
-            example: '2028'
+            description: 'Four-digit number representing the card\'s expiration year. May be in the past for an expired card still on file. Null for SEPA Direct Debit and bank transfer.',
+            example: 2028
         },
         brand: {
             type: 'string',
             nullable: true,
-            description: 'Payment card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.',
-            example: 'visa',
-            enum: [
-                'amex',
-                'diners',
-                'discover',
-                'eftpos_au',
-                'jcb',
-                'mastercard',
-                'unionpay',
-                'visa',
-                'unknown'
-            ]
+            description: 'Payment card brand as reported by Stripe, e.g. `visa`, `mastercard`, `amex`, `cartes_bancaires`, or `unknown`. Null for SEPA Direct Debit and bank transfer.',
+            example: 'visa'
+        },
+        iban: {
+            type: 'string',
+            nullable: true,
+            description: 'Full destination IBAN to send bank transfers to. Set only for `bank_transfer`; null otherwise. This is Cloudfleet\'s virtual receiving account, shown in full so the customer can pay into it.',
+            example: 'DE11243015658023127510'
+        },
+        bic: {
+            type: 'string',
+            nullable: true,
+            description: 'BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.',
+            example: 'SOGEDEFFXXX'
+        },
+        account_holder_name: {
+            type: 'string',
+            nullable: true,
+            description: 'Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.',
+            example: 'Cloudfleet GmbH'
+        },
+        is_default: {
+            type: 'boolean',
+            description: 'Whether this payment method is the default used for invoices and active subscriptions. Always false for `bank_transfer` (it cannot be a Stripe default payment method).',
+            example: true
         }
     },
     required: [
         'id',
-        'setup',
         'type',
         'last4',
         'exp_month',
         'exp_year',
-        'brand'
+        'brand',
+        'iban',
+        'bic',
+        'account_holder_name',
+        'is_default'
     ],
     additionalProperties: false
 };