shoal-web-sdk 1.0.125 → 1.0.127

package/dist/sdk/billing/@tanstack/react-query.gen.d.ts

@@ -1,6 +1,6 @@
 import { type UseMutationOptions } from '@tanstack/react-query';
 import { type Options } from '../sdk.gen';
-import type { CancelSubscriptionData, CancelSubscriptionError, CreateSetupIntentData, CreateSetupIntentError, CreateSetupIntentResponse, CreateSubscriptionData, CreateSubscriptionError, CreateSubscriptionResponse, DeletePaymentMethodData, DeletePaymentMethodError, DeletePaymentMethodResponse, GetCustomerData, GetInvoicesData, GetPlansData, GetUsageData, M2mCreateCustomerData, M2mCreateCustomerError, M2mGetCustomerData, M2mUpdatePlanData, M2mUpdatePlanError, UpdateDefaultPaymentMethodData, UpdateDefaultPaymentMethodError, UpdateDefaultPaymentMethodResponse, UpdatePlanData, UpdatePlanError } from '../types.gen';
+import type { CancelSubscriptionData, CancelSubscriptionError, CreateSetupIntentData, CreateSetupIntentError, CreateSetupIntentResponse, CreateSubscriptionData, CreateSubscriptionError, CreateSubscriptionResponse, DeletePaymentMethodData, DeletePaymentMethodError, DeletePaymentMethodResponse, GetCustomerData, GetInvoicesData, GetPlansData, GetUsageData, M2mCreateCustomerData, M2mCreateCustomerError, M2mGetCustomerData, M2mUpdatePlanData, M2mUpdatePlanError, UpdateBillingAddressData, UpdateBillingAddressError, UpdateBillingAddressResponse, UpdateDefaultPaymentMethodData, UpdateDefaultPaymentMethodError, UpdateDefaultPaymentMethodResponse, UpdatePlanData, UpdatePlanError } from '../types.gen';
 export type QueryKey<TOptions extends Options> = [
     Pick<TOptions, 'baseUrl' | 'body' | 'headers' | 'path' | 'query'> & {
         _id: string;
@@ -110,6 +110,13 @@ export declare const cancelSubscriptionMutation: (options?: Partial<Options<Canc
  *
  */
 export declare const createSubscriptionMutation: (options?: Partial<Options<CreateSubscriptionData>>) => UseMutationOptions<CreateSubscriptionResponse, CreateSubscriptionError, Options<CreateSubscriptionData>>;
+/**
+ * Sets the billing address on the Stripe customer.
+ *
+ * Stripe Tax uses the customer's address to work out their tax location. The address is validated immediately, so an address Stripe cannot use for tax is rejected instead of leaving the customer with an unknown tax location.
+ *
+ */
+export declare const updateBillingAddressMutation: (options?: Partial<Options<UpdateBillingAddressData>>) => UseMutationOptions<UpdateBillingAddressResponse, UpdateBillingAddressError, Options<UpdateBillingAddressData>>;
 /**
  * Creates a Stripe SetupIntent.
  *

package/dist/sdk/billing/@tanstack/react-query.gen.js

@@ -1,7 +1,7 @@
 // This file is auto-generated by @hey-api/openapi-ts
 import { queryOptions } from '@tanstack/react-query';
 import { client } from '../client.gen';
-import { cancelSubscription, createSetupIntent, createSubscription, deletePaymentMethod, getCustomer, getInvoices, getPlans, getUsage, m2mCreateCustomer, m2mGetCustomer, m2mUpdatePlan, updateDefaultPaymentMethod, updatePlan } from '../sdk.gen';
+import { cancelSubscription, createSetupIntent, createSubscription, deletePaymentMethod, getCustomer, getInvoices, getPlans, getUsage, m2mCreateCustomer, m2mGetCustomer, m2mUpdatePlan, updateBillingAddress, updateDefaultPaymentMethod, updatePlan } from '../sdk.gen';
 const createQueryKey = (id, options, infinite, tags) => {
     const params = { _id: id, baseUrl: options?.baseUrl || (options?.client ?? client).getConfig().baseUrl };
     if (infinite) {
@@ -134,6 +134,25 @@ export const createSubscriptionMutation = (options) => {
     };
     return mutationOptions;
 };
+/**
+ * Sets the billing address on the Stripe customer.
+ *
+ * Stripe Tax uses the customer's address to work out their tax location. The address is validated immediately, so an address Stripe cannot use for tax is rejected instead of leaving the customer with an unknown tax location.
+ *
+ */
+export const updateBillingAddressMutation = (options) => {
+    const mutationOptions = {
+        mutationFn: async (fnOptions) => {
+            const { data } = await updateBillingAddress({
+                ...options,
+                ...fnOptions,
+                throwOnError: true
+            });
+            return data;
+        }
+    };
+    return mutationOptions;
+};
 /**
  * Creates a Stripe SetupIntent.
  *

package/dist/sdk/billing/sdk.gen.d.ts

@@ -1,5 +1,5 @@
 import type { Client, Options as Options2, TDataShape } from './client';
-import type { CancelSubscriptionData, CancelSubscriptionErrors, CancelSubscriptionResponses, CreateSetupIntentData, CreateSetupIntentErrors, CreateSetupIntentResponses, CreateSubscriptionData, CreateSubscriptionErrors, CreateSubscriptionResponses, DeletePaymentMethodData, DeletePaymentMethodErrors, DeletePaymentMethodResponses, GetCustomerData, GetCustomerErrors, GetCustomerResponses, GetInvoicesData, GetInvoicesErrors, GetInvoicesResponses, GetPlansData, GetPlansErrors, GetPlansResponses, GetUsageData, GetUsageErrors, GetUsageResponses, M2mCreateCustomerData, M2mCreateCustomerErrors, M2mCreateCustomerResponses, M2mGetCustomerData, M2mGetCustomerErrors, M2mGetCustomerResponses, M2mUpdatePlanData, M2mUpdatePlanErrors, M2mUpdatePlanResponses, UpdateDefaultPaymentMethodData, UpdateDefaultPaymentMethodErrors, UpdateDefaultPaymentMethodResponses, UpdatePlanData, UpdatePlanErrors, UpdatePlanResponses } from './types.gen';
+import type { CancelSubscriptionData, CancelSubscriptionErrors, CancelSubscriptionResponses, CreateSetupIntentData, CreateSetupIntentErrors, CreateSetupIntentResponses, CreateSubscriptionData, CreateSubscriptionErrors, CreateSubscriptionResponses, DeletePaymentMethodData, DeletePaymentMethodErrors, DeletePaymentMethodResponses, GetCustomerData, GetCustomerErrors, GetCustomerResponses, GetInvoicesData, GetInvoicesErrors, GetInvoicesResponses, GetPlansData, GetPlansErrors, GetPlansResponses, GetUsageData, GetUsageErrors, GetUsageResponses, M2mCreateCustomerData, M2mCreateCustomerErrors, M2mCreateCustomerResponses, M2mGetCustomerData, M2mGetCustomerErrors, M2mGetCustomerResponses, M2mUpdatePlanData, M2mUpdatePlanErrors, M2mUpdatePlanResponses, UpdateBillingAddressData, UpdateBillingAddressErrors, UpdateBillingAddressResponses, UpdateDefaultPaymentMethodData, UpdateDefaultPaymentMethodErrors, UpdateDefaultPaymentMethodResponses, UpdatePlanData, UpdatePlanErrors, UpdatePlanResponses } from './types.gen';
 export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
     /**
      * You can provide a client instance returned by `createClient()` instead of
@@ -43,6 +43,13 @@ export declare const cancelSubscription: <ThrowOnError extends boolean = false>(
  *
  */
 export declare const createSubscription: <ThrowOnError extends boolean = false>(options: Options<CreateSubscriptionData, ThrowOnError>) => import("./client").RequestResult<CreateSubscriptionResponses, CreateSubscriptionErrors, ThrowOnError, "fields">;
+/**
+ * Sets the billing address on the Stripe customer.
+ *
+ * Stripe Tax uses the customer's address to work out their tax location. The address is validated immediately, so an address Stripe cannot use for tax is rejected instead of leaving the customer with an unknown tax location.
+ *
+ */
+export declare const updateBillingAddress: <ThrowOnError extends boolean = false>(options: Options<UpdateBillingAddressData, ThrowOnError>) => import("./client").RequestResult<UpdateBillingAddressResponses, UpdateBillingAddressErrors, ThrowOnError, "fields">;
 /**
  * Creates a Stripe SetupIntent.
  *

package/dist/sdk/billing/sdk.gen.js

@@ -104,6 +104,28 @@ export const createSubscription = (options) => {
         }
     });
 };
+/**
+ * Sets the billing address on the Stripe customer.
+ *
+ * Stripe Tax uses the customer's address to work out their tax location. The address is validated immediately, so an address Stripe cannot use for tax is rejected instead of leaving the customer with an unknown tax location.
+ *
+ */
+export const updateBillingAddress = (options) => {
+    return (options.client ?? client).put({
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/api/v1/billing-address/{org}',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options.headers
+        }
+    });
+};
 /**
  * Creates a Stripe SetupIntent.
  *

package/dist/sdk/billing/types.gen.d.ts

@@ -96,6 +96,18 @@ export type CreateSubscriptionRequest = {
     plan: string;
     billingInterval: BillingInterval;
 };
+export type BillingAddress = {
+    name: string;
+    line1: string;
+    line2?: string;
+    city: string;
+    state: string;
+    postalCode: string;
+    /**
+     * Two-letter ISO 3166-1 country code.
+     */
+    country: string;
+};
 export type SetupIntentResponse = {
     readonly clientSecret: string;
 };
@@ -156,6 +168,10 @@ export type CustomerResponse = {
     readonly paymentMethods: Array<PaymentMethodSummary>;
     readonly estimatedCreditBalanceUSD: unknown;
     readonly upcomingInvoiceTotalCents?: number;
+    /**
+     * The address Stripe Tax uses for the customer's tax location. Null when none is set.
+     */
+    billingAddress?: BillingAddress;
 };
 export type UsageInfoResponse = {
     meters: {
@@ -478,6 +494,43 @@ export type CreateSubscriptionResponses = {
     201: SubscriptionResponse;
 };
 export type CreateSubscriptionResponse = CreateSubscriptionResponses[keyof CreateSubscriptionResponses];
+export type UpdateBillingAddressData = {
+    body: BillingAddress;
+    path: {
+        /**
+         * Kinde organisation id.
+         */
+        org: string;
+    };
+    query?: never;
+    url: '/api/v1/billing-address/{org}';
+};
+export type UpdateBillingAddressErrors = {
+    /**
+     * Invalid request body, or Stripe could not use the address as a tax location
+     */
+    400: _Error;
+    /**
+     * Unauthorised user
+     */
+    401: _Error;
+    /**
+     * Account not found
+     */
+    404: _Error;
+    /**
+     * Internal error
+     */
+    500: _Error;
+};
+export type UpdateBillingAddressError = UpdateBillingAddressErrors[keyof UpdateBillingAddressErrors];
+export type UpdateBillingAddressResponses = {
+    /**
+     * The billing address was updated
+     */
+    204: void;
+};
+export type UpdateBillingAddressResponse = UpdateBillingAddressResponses[keyof UpdateBillingAddressResponses];
 export type CreateSetupIntentData = {
     body?: never;
     path: {

package/dist/sdk/billing/zod.gen.d.ts

@@ -1959,6 +1959,15 @@ export declare const zCreateSubscriptionRequest: z.ZodObject<{
         annual: "annual";
     }>;
 }, z.core.$strip>;
+export declare const zBillingAddress: z.ZodObject<{
+    name: z.ZodString;
+    line1: z.ZodString;
+    line2: z.ZodOptional<z.ZodString>;
+    city: z.ZodString;
+    state: z.ZodString;
+    postalCode: z.ZodString;
+    country: z.ZodString;
+}, z.core.$strip>;
 export declare const zSetupIntentResponse: z.ZodObject<{
     clientSecret: z.ZodReadonly<z.ZodString>;
 }, z.core.$strip>;
@@ -2919,6 +2928,15 @@ export declare const zCustomerResponse: z.ZodObject<{
     }, z.core.$strip>>>;
     estimatedCreditBalanceUSD: z.ZodReadonly<z.ZodUnknown>;
     upcomingInvoiceTotalCents: z.ZodOptional<z.ZodReadonly<z.ZodInt>>;
+    billingAddress: z.ZodOptional<z.ZodObject<{
+        name: z.ZodString;
+        line1: z.ZodString;
+        line2: z.ZodOptional<z.ZodString>;
+        city: z.ZodString;
+        state: z.ZodString;
+        postalCode: z.ZodString;
+        country: z.ZodString;
+    }, z.core.$strip>>;
 }, z.core.$strip>;
 export declare const zUsagePoint: z.ZodObject<{
     date: z.ZodISODateTime;
@@ -5249,6 +5267,15 @@ export declare const zGetCustomerResponse: z.ZodObject<{
     }, z.core.$strip>>>;
     estimatedCreditBalanceUSD: z.ZodReadonly<z.ZodUnknown>;
     upcomingInvoiceTotalCents: z.ZodOptional<z.ZodReadonly<z.ZodInt>>;
+    billingAddress: z.ZodOptional<z.ZodObject<{
+        name: z.ZodString;
+        line1: z.ZodString;
+        line2: z.ZodOptional<z.ZodString>;
+        city: z.ZodString;
+        state: z.ZodString;
+        postalCode: z.ZodString;
+        country: z.ZodString;
+    }, z.core.$strip>>;
 }, z.core.$strip>;
 export declare const zGetUsageData: z.ZodObject<{
     body: z.ZodOptional<z.ZodNever>;
@@ -6555,6 +6582,25 @@ export declare const zCreateSubscriptionResponse: z.ZodObject<{
     status: z.ZodReadonly<z.ZodString>;
     clientSecret: z.ZodOptional<z.ZodReadonly<z.ZodString>>;
 }, z.core.$strip>;
+export declare const zUpdateBillingAddressData: z.ZodObject<{
+    body: z.ZodObject<{
+        name: z.ZodString;
+        line1: z.ZodString;
+        line2: z.ZodOptional<z.ZodString>;
+        city: z.ZodString;
+        state: z.ZodString;
+        postalCode: z.ZodString;
+        country: z.ZodString;
+    }, z.core.$strip>;
+    path: z.ZodObject<{
+        org: z.ZodString;
+    }, z.core.$strip>;
+    query: z.ZodOptional<z.ZodNever>;
+}, z.core.$strip>;
+/**
+ * The billing address was updated
+ */
+export declare const zUpdateBillingAddressResponse: z.ZodVoid;
 export declare const zCreateSetupIntentData: z.ZodObject<{
     body: z.ZodOptional<z.ZodNever>;
     path: z.ZodObject<{
@@ -7242,6 +7288,15 @@ export declare const zM2mGetCustomerResponse: z.ZodObject<{
     }, z.core.$strip>>>;
     estimatedCreditBalanceUSD: z.ZodReadonly<z.ZodUnknown>;
     upcomingInvoiceTotalCents: z.ZodOptional<z.ZodReadonly<z.ZodInt>>;
+    billingAddress: z.ZodOptional<z.ZodObject<{
+        name: z.ZodString;
+        line1: z.ZodString;
+        line2: z.ZodOptional<z.ZodString>;
+        city: z.ZodString;
+        state: z.ZodString;
+        postalCode: z.ZodString;
+        country: z.ZodString;
+    }, z.core.$strip>>;
 }, z.core.$strip>;
 export declare const zM2mCreateCustomerData: z.ZodObject<{
     body: z.ZodObject<{

package/dist/sdk/billing/zod.gen.js

@@ -121,6 +121,15 @@ export const zCreateSubscriptionRequest = z.object({
     plan: z.string(),
     billingInterval: zBillingInterval
 });
+export const zBillingAddress = z.object({
+    name: z.string(),
+    line1: z.string(),
+    line2: z.optional(z.string()),
+    city: z.string(),
+    state: z.string(),
+    postalCode: z.string(),
+    country: z.string()
+});
 export const zSetupIntentResponse = z.object({
     clientSecret: z.string().readonly()
 });
@@ -186,7 +195,8 @@ export const zCustomerResponse = z.object({
     seats: z.int().readonly(),
     paymentMethods: z.array(zPaymentMethodSummary).readonly(),
     estimatedCreditBalanceUSD: z.unknown().readonly(),
-    upcomingInvoiceTotalCents: z.optional(z.int().readonly())
+    upcomingInvoiceTotalCents: z.optional(z.int().readonly()),
+    billingAddress: z.optional(zBillingAddress)
 });
 export const zUsagePoint = z.object({
     date: z.iso.datetime(),
@@ -349,6 +359,17 @@ export const zCreateSubscriptionData = z.object({
  * The subscription was created
  */
 export const zCreateSubscriptionResponse = zSubscriptionResponse;
+export const zUpdateBillingAddressData = z.object({
+    body: zBillingAddress,
+    path: z.object({
+        org: z.string()
+    }),
+    query: z.optional(z.never())
+});
+/**
+ * The billing address was updated
+ */
+export const zUpdateBillingAddressResponse = z.void();
 export const zCreateSetupIntentData = z.object({
     body: z.optional(z.never()),
     path: z.object({

package/dist/sdk/types.gen.d.ts

@@ -659,6 +659,8 @@ export type Node = {
     } & CloudSqlNodeProps) | ({
         typ: 'queue';
     } & QueueNodeProps) | ({
+        typ: 'bucket';
+    } & BucketNodeProps) | ({
         typ: 'proxy';
     } & ProxyNodeProps) | ({
         typ: 'vm';
@@ -667,7 +669,7 @@ export type Node = {
     } & SchedulerNodeProps);
 };
 export type EdgeType = 'network' | 'route' | 'output';
-export type NodeType = 'cache' | 'comment' | 'container' | 'cronjob' | 'database' | 'function' | 'neondb' | 'mongodb' | 'cloudsql' | 'queue' | 'proxy' | 'vm' | 'scheduler';
+export type NodeType = 'cache' | 'comment' | 'container' | 'cronjob' | 'database' | 'function' | 'neondb' | 'mongodb' | 'cloudsql' | 'queue' | 'bucket' | 'proxy' | 'vm' | 'scheduler';
 export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS';
 export type CommentNodeProps = {
     comment?: string;
@@ -880,6 +882,61 @@ export type QueueNodeProps = {
     saEmail?: string;
     subscriptions: Array<QueueSubscriptionProps>;
 };
+/**
+ * Cloud Storage bucket location as listed at https://cloud.google.com/storage/docs/locations: a region, a predefined dual-region, or a multi-region.
+ */
+export type BucketLocation = 'NORTHAMERICA-NORTHEAST1' | 'NORTHAMERICA-NORTHEAST2' | 'NORTHAMERICA-SOUTH1' | 'US-CENTRAL1' | 'US-EAST1' | 'US-EAST4' | 'US-EAST5' | 'US-SOUTH1' | 'US-WEST1' | 'US-WEST2' | 'US-WEST3' | 'US-WEST4' | 'SOUTHAMERICA-EAST1' | 'SOUTHAMERICA-WEST1' | 'EUROPE-CENTRAL2' | 'EUROPE-NORTH1' | 'EUROPE-NORTH2' | 'EUROPE-SOUTHWEST1' | 'EUROPE-WEST1' | 'EUROPE-WEST2' | 'EUROPE-WEST3' | 'EUROPE-WEST4' | 'EUROPE-WEST6' | 'EUROPE-WEST8' | 'EUROPE-WEST9' | 'EUROPE-WEST10' | 'EUROPE-WEST12' | 'ASIA-EAST1' | 'ASIA-EAST2' | 'ASIA-NORTHEAST1' | 'ASIA-NORTHEAST2' | 'ASIA-NORTHEAST3' | 'ASIA-SOUTH1' | 'ASIA-SOUTH2' | 'ASIA-SOUTHEAST1' | 'ASIA-SOUTHEAST2' | 'ASIA-SOUTHEAST3' | 'ME-CENTRAL1' | 'ME-CENTRAL2' | 'ME-WEST1' | 'AUSTRALIA-SOUTHEAST1' | 'AUSTRALIA-SOUTHEAST2' | 'AFRICA-SOUTH1' | 'ASIA1' | 'EUR4' | 'EUR5' | 'EUR7' | 'EUR8' | 'NAM4' | 'ASIA' | 'EU' | 'US';
+export type BucketStorageClass = 'STANDARD' | 'NEARLINE' | 'COLDLINE' | 'ARCHIVE';
+export type BucketCorsRule = {
+    /**
+     * Origins allowed to make cross-origin requests, e.g. "https://example.com". Use "*" for any origin.
+     */
+    origins: Array<string>;
+    /**
+     * HTTP methods allowed for cross-origin requests, e.g. GET, HEAD, PUT, POST, DELETE. Use "*" for any method.
+     */
+    methods: Array<string>;
+    /**
+     * Response headers the browser may expose to the requesting origin.
+     */
+    responseHeaders?: Array<string>;
+    /**
+     * How long the browser may cache the preflight response, in seconds.
+     */
+    maxAgeSeconds?: number;
+};
+export type BucketNodeProps = {
+    location: BucketLocation;
+    storageClass: BucketStorageClass;
+    /**
+     * When true, anyone on the internet can read objects in the bucket. When false, public access prevention is enforced and only connected workloads and holders of the node credential can reach it.
+     */
+    public?: boolean;
+    /**
+     * Keep noncurrent versions of objects when they are overwritten or deleted.
+     */
+    versioningEnabled?: boolean;
+    /**
+     * Delete every object in the bucket when the node is removed. Without it, a non-empty bucket cannot be deleted.
+     */
+    forceDestroy?: boolean;
+    /**
+     * How many days deleted or overwritten objects stay recoverable, and billed. 0 turns soft delete off; otherwise between 7 and 90. Trial accounts are always 0.
+     */
+    softDeleteRetentionDays?: number;
+    /**
+     * Cross-origin resource sharing rules, needed when a browser app reads or uploads objects directly.
+     */
+    cors?: Array<BucketCorsRule>;
+    /**
+     * The provisioned GCS bucket name. Written back by the deployment job; null until the bucket has been provisioned. Sending null leaves the stored value unchanged.
+     */
+    bucketName?: string;
+    /**
+     * Email of the service account scoped to this bucket, used to issue node credentials. Written back by the deployment job; null until provisioned. Sending null leaves the stored value unchanged.
+     */
+    saEmail?: string;
+};
 export type QueueSubscriptionProps = {
     name: string;
     /**