@arbidocs/react 0.5.105 → 0.5.106

package/dist/index.d.cts

@@ -1991,6 +1991,7 @@ type UserSettingsPatch = components['schemas']['UserSettingsUpdate'];
 /** The user's settings record (flags, pins, notification preferences). */
 declare function useUserSettings(options?: {
     enabled?: boolean;
+    refetchOnMount?: boolean | 'always';
 }): _tanstack_react_query.UseQueryResult<NoInfer<{
     [x: string]: unknown;
     subscription?: {
@@ -5285,6 +5286,9 @@ declare function useProjects(options?: {
     name: string;
     created_by: string;
     subscription: string;
+    is_personal: boolean;
+    subscription_ended_at?: string | null | undefined;
+    retention_delete_at?: string | null | undefined;
     created_at: string;
     quotas: {
         storage_gb: {
@@ -5333,11 +5337,22 @@ declare function useProjects(options?: {
         packs_next?: number | null | undefined;
         plan_name: string;
         plan_ai_gbp: number;
+        plan_monthly_ex_vat_pence: number;
+        total_monthly_ex_vat_pence: number;
         plan_storage_gb: number;
         block_ai_gbp: number;
+        block_collaborators: number;
+        spend_cap_step_pence: number;
+        maximum_spend_cap_pence: number;
+        default_spend_cap_pence: number;
+        included_collaborators: number;
+        collaborator_blocks_min: number;
+        collaborator_block_price_ex_vat_pence: number;
+        collaborator_block_period_ex_vat_pence: number;
         block_storage_gb: number;
         ai_blocks: number;
         storage_blocks: number;
+        collaborator_blocks: number;
         legacy_ai_blocks: number;
         legacy_storage_blocks: number;
         legacy_block_ai_gbp: number;
@@ -5346,6 +5361,7 @@ declare function useProjects(options?: {
         blocks_storage_gb: number;
         ai_blocks_next?: number | null | undefined;
         storage_blocks_next?: number | null | undefined;
+        collaborator_blocks_next?: number | null | undefined;
         storage_blocks_min: number;
         auto_topup_threshold_gbp: number;
         min_auto_topup_threshold_gbp: number;
@@ -5377,11 +5393,12 @@ declare function useProjects(options?: {
         period_end?: number | null | undefined;
         ai_usage_reset_at?: number | null | undefined;
         pending_interval?: ("month" | "year") | null | undefined;
+        renewal_error?: string | null | undefined;
         billing_error?: string | null | undefined;
         confirm_url?: string | null | undefined;
         payment?: {
             status: "pending" | "paid";
-            kind?: ("ai_usage" | "storage") | null | undefined;
+            kind?: ("ai_usage" | "storage" | "collaborators") | null | undefined;
             amount_pence?: number | null | undefined;
             amount_ex_vat_pence?: number | null | undefined;
             tax_pence?: number | null | undefined;
@@ -6694,8 +6711,9 @@ interface ExportDownloadRequest {
  * Download a scope of the open workspace as files: its documents (every version, and each
  * version's markup PDF), one JSON file per entity type and a manifest (`buildWorkspaceArchive`).
  */
-declare function useWorkspaceExportDownload({ workspaceName }?: {
+declare function useWorkspaceExportDownload({ workspaceName, workspaceId, }?: {
     workspaceName?: string;
+    workspaceId?: string;
 }): {
     download: ({ scope, documents, csvColumns }: ExportDownloadRequest) => Promise<boolean>;
     isDownloading: boolean;
@@ -9220,6 +9238,9 @@ declare function useUpdateProjectFields(): _tanstack_react_query.UseMutationResu
     name: string;
     created_by: string;
     subscription: string;
+    is_personal: boolean;
+    subscription_ended_at?: string | null;
+    retention_delete_at?: string | null;
     created_at: string;
     quotas: _arbidocs_client.components["schemas"]["ProjectQuotas"];
     daily_cap_per_user?: number | null;
@@ -9304,6 +9325,13 @@ declare function useInvalidateProjects(): () => Promise<void>;
 declare function useProducts(options?: {
     enabled?: boolean;
 }): _tanstack_react_query.UseQueryResult<NoInfer<{
+    included_ai_gbp: number;
+    included_storage_gb: number;
+    included_collaborators: number;
+    default_spend_cap_pence: number;
+    spend_cap_step_pence: number;
+    maximum_spend_cap_pence: number;
+    quota_warning_percent: number;
     product_id: string;
     name: string;
     description?: string | null | undefined;
@@ -9321,9 +9349,10 @@ declare function useProducts(options?: {
             amount_ex_vat: number;
         }[];
         addon_prices: {
-            kind: "ai_usage" | "storage";
+            kind: "ai_usage" | "storage" | "collaborators";
             ai_gbp: number;
             storage_gb: number;
+            collaborators: number;
             amount_ex_vat: number;
             amount: number;
             monthly_ex_vat: number;
@@ -9359,6 +9388,9 @@ declare function useRefreshProject(): _tanstack_react_query.UseMutationResult<{
     name: string;
     created_by: string;
     subscription: string;
+    is_personal: boolean;
+    subscription_ended_at?: string | null | undefined;
+    retention_delete_at?: string | null | undefined;
     created_at: string;
     quotas: {
         storage_gb: {
@@ -9407,11 +9439,22 @@ declare function useRefreshProject(): _tanstack_react_query.UseMutationResult<{
         packs_next?: number | null | undefined;
         plan_name: string;
         plan_ai_gbp: number;
+        plan_monthly_ex_vat_pence: number;
+        total_monthly_ex_vat_pence: number;
         plan_storage_gb: number;
         block_ai_gbp: number;
+        block_collaborators: number;
+        spend_cap_step_pence: number;
+        maximum_spend_cap_pence: number;
+        default_spend_cap_pence: number;
+        included_collaborators: number;
+        collaborator_blocks_min: number;
+        collaborator_block_price_ex_vat_pence: number;
+        collaborator_block_period_ex_vat_pence: number;
         block_storage_gb: number;
         ai_blocks: number;
         storage_blocks: number;
+        collaborator_blocks: number;
         legacy_ai_blocks: number;
         legacy_storage_blocks: number;
         legacy_block_ai_gbp: number;
@@ -9420,6 +9463,7 @@ declare function useRefreshProject(): _tanstack_react_query.UseMutationResult<{
         blocks_storage_gb: number;
         ai_blocks_next?: number | null | undefined;
         storage_blocks_next?: number | null | undefined;
+        collaborator_blocks_next?: number | null | undefined;
         storage_blocks_min: number;
         auto_topup_threshold_gbp: number;
         min_auto_topup_threshold_gbp: number;
@@ -9451,11 +9495,12 @@ declare function useRefreshProject(): _tanstack_react_query.UseMutationResult<{
         period_end?: number | null | undefined;
         ai_usage_reset_at?: number | null | undefined;
         pending_interval?: ("month" | "year") | null | undefined;
+        renewal_error?: string | null | undefined;
         billing_error?: string | null | undefined;
         confirm_url?: string | null | undefined;
         payment?: {
             status: "pending" | "paid";
-            kind?: ("ai_usage" | "storage") | null | undefined;
+            kind?: ("ai_usage" | "storage" | "collaborators") | null | undefined;
             amount_pence?: number | null | undefined;
             amount_ex_vat_pence?: number | null | undefined;
             tax_pence?: number | null | undefined;
@@ -9488,6 +9533,9 @@ declare function useChangeProjectPlan(): _tanstack_react_query.UseMutationResult
     name: string;
     created_by: string;
     subscription: string;
+    is_personal: boolean;
+    subscription_ended_at?: string | null | undefined;
+    retention_delete_at?: string | null | undefined;
     created_at: string;
     quotas: {
         storage_gb: {
@@ -9536,11 +9584,22 @@ declare function useChangeProjectPlan(): _tanstack_react_query.UseMutationResult
         packs_next?: number | null | undefined;
         plan_name: string;
         plan_ai_gbp: number;
+        plan_monthly_ex_vat_pence: number;
+        total_monthly_ex_vat_pence: number;
         plan_storage_gb: number;
         block_ai_gbp: number;
+        block_collaborators: number;
+        spend_cap_step_pence: number;
+        maximum_spend_cap_pence: number;
+        default_spend_cap_pence: number;
+        included_collaborators: number;
+        collaborator_blocks_min: number;
+        collaborator_block_price_ex_vat_pence: number;
+        collaborator_block_period_ex_vat_pence: number;
         block_storage_gb: number;
         ai_blocks: number;
         storage_blocks: number;
+        collaborator_blocks: number;
         legacy_ai_blocks: number;
         legacy_storage_blocks: number;
         legacy_block_ai_gbp: number;
@@ -9549,6 +9608,7 @@ declare function useChangeProjectPlan(): _tanstack_react_query.UseMutationResult
         blocks_storage_gb: number;
         ai_blocks_next?: number | null | undefined;
         storage_blocks_next?: number | null | undefined;
+        collaborator_blocks_next?: number | null | undefined;
         storage_blocks_min: number;
         auto_topup_threshold_gbp: number;
         min_auto_topup_threshold_gbp: number;
@@ -9580,11 +9640,12 @@ declare function useChangeProjectPlan(): _tanstack_react_query.UseMutationResult
         period_end?: number | null | undefined;
         ai_usage_reset_at?: number | null | undefined;
         pending_interval?: ("month" | "year") | null | undefined;
+        renewal_error?: string | null | undefined;
         billing_error?: string | null | undefined;
         confirm_url?: string | null | undefined;
         payment?: {
             status: "pending" | "paid";
-            kind?: ("ai_usage" | "storage") | null | undefined;
+            kind?: ("ai_usage" | "storage" | "collaborators") | null | undefined;
             amount_pence?: number | null | undefined;
             amount_ex_vat_pence?: number | null | undefined;
             tax_pence?: number | null | undefined;
@@ -9610,6 +9671,9 @@ declare function useCancelProjectSubscription(): _tanstack_react_query.UseMutati
     name: string;
     created_by: string;
     subscription: string;
+    is_personal: boolean;
+    subscription_ended_at?: string | null | undefined;
+    retention_delete_at?: string | null | undefined;
     created_at: string;
     quotas: {
         storage_gb: {
@@ -9658,11 +9722,22 @@ declare function useCancelProjectSubscription(): _tanstack_react_query.UseMutati
         packs_next?: number | null | undefined;
         plan_name: string;
         plan_ai_gbp: number;
+        plan_monthly_ex_vat_pence: number;
+        total_monthly_ex_vat_pence: number;
         plan_storage_gb: number;
         block_ai_gbp: number;
+        block_collaborators: number;
+        spend_cap_step_pence: number;
+        maximum_spend_cap_pence: number;
+        default_spend_cap_pence: number;
+        included_collaborators: number;
+        collaborator_blocks_min: number;
+        collaborator_block_price_ex_vat_pence: number;
+        collaborator_block_period_ex_vat_pence: number;
         block_storage_gb: number;
         ai_blocks: number;
         storage_blocks: number;
+        collaborator_blocks: number;
         legacy_ai_blocks: number;
         legacy_storage_blocks: number;
         legacy_block_ai_gbp: number;
@@ -9671,6 +9746,7 @@ declare function useCancelProjectSubscription(): _tanstack_react_query.UseMutati
         blocks_storage_gb: number;
         ai_blocks_next?: number | null | undefined;
         storage_blocks_next?: number | null | undefined;
+        collaborator_blocks_next?: number | null | undefined;
         storage_blocks_min: number;
         auto_topup_threshold_gbp: number;
         min_auto_topup_threshold_gbp: number;
@@ -9702,11 +9778,12 @@ declare function useCancelProjectSubscription(): _tanstack_react_query.UseMutati
         period_end?: number | null | undefined;
         ai_usage_reset_at?: number | null | undefined;
         pending_interval?: ("month" | "year") | null | undefined;
+        renewal_error?: string | null | undefined;
         billing_error?: string | null | undefined;
         confirm_url?: string | null | undefined;
         payment?: {
             status: "pending" | "paid";
-            kind?: ("ai_usage" | "storage") | null | undefined;
+            kind?: ("ai_usage" | "storage" | "collaborators") | null | undefined;
             amount_pence?: number | null | undefined;
             amount_ex_vat_pence?: number | null | undefined;
             tax_pence?: number | null | undefined;
@@ -9764,7 +9841,7 @@ declare function usePlanQuote(projectExtId: string | null | undefined, body: Pro
 }>, unknown>;
 /** What one more add-on block costs now and at renewal, taxed for the saved address. */
 declare function useAddonQuote(projectExtId: string, kind: ProjectAddonKind, enabled?: boolean): _tanstack_react_query.UseQueryResult<NoInfer<{
-    kind: "ai_usage" | "storage";
+    kind: "ai_usage" | "storage" | "collaborators";
     now: {
         subtotal_pence: number;
         tax_pence: number;
@@ -9810,6 +9887,9 @@ declare function useAddProjectAddonBlock(): _tanstack_react_query.UseMutationRes
         name: string;
         created_by: string;
         subscription: string;
+        is_personal: boolean;
+        subscription_ended_at?: string | null | undefined;
+        retention_delete_at?: string | null | undefined;
         created_at: string;
         quotas: {
             storage_gb: {
@@ -9858,11 +9938,22 @@ declare function useAddProjectAddonBlock(): _tanstack_react_query.UseMutationRes
             packs_next?: number | null | undefined;
             plan_name: string;
             plan_ai_gbp: number;
+            plan_monthly_ex_vat_pence: number;
+            total_monthly_ex_vat_pence: number;
             plan_storage_gb: number;
             block_ai_gbp: number;
+            block_collaborators: number;
+            spend_cap_step_pence: number;
+            maximum_spend_cap_pence: number;
+            default_spend_cap_pence: number;
+            included_collaborators: number;
+            collaborator_blocks_min: number;
+            collaborator_block_price_ex_vat_pence: number;
+            collaborator_block_period_ex_vat_pence: number;
             block_storage_gb: number;
             ai_blocks: number;
             storage_blocks: number;
+            collaborator_blocks: number;
             legacy_ai_blocks: number;
             legacy_storage_blocks: number;
             legacy_block_ai_gbp: number;
@@ -9871,6 +9962,7 @@ declare function useAddProjectAddonBlock(): _tanstack_react_query.UseMutationRes
             blocks_storage_gb: number;
             ai_blocks_next?: number | null | undefined;
             storage_blocks_next?: number | null | undefined;
+            collaborator_blocks_next?: number | null | undefined;
             storage_blocks_min: number;
             auto_topup_threshold_gbp: number;
             min_auto_topup_threshold_gbp: number;
@@ -9902,11 +9994,12 @@ declare function useAddProjectAddonBlock(): _tanstack_react_query.UseMutationRes
             period_end?: number | null | undefined;
             ai_usage_reset_at?: number | null | undefined;
             pending_interval?: ("month" | "year") | null | undefined;
+            renewal_error?: string | null | undefined;
             billing_error?: string | null | undefined;
             confirm_url?: string | null | undefined;
             payment?: {
                 status: "pending" | "paid";
-                kind?: ("ai_usage" | "storage") | null | undefined;
+                kind?: ("ai_usage" | "storage" | "collaborators") | null | undefined;
                 amount_pence?: number | null | undefined;
                 amount_ex_vat_pence?: number | null | undefined;
                 tax_pence?: number | null | undefined;
@@ -9933,6 +10026,9 @@ declare function useUpdateProjectNextPeriodAddons(): _tanstack_react_query.UseMu
     name: string;
     created_by: string;
     subscription: string;
+    is_personal: boolean;
+    subscription_ended_at?: string | null | undefined;
+    retention_delete_at?: string | null | undefined;
     created_at: string;
     quotas: {
         storage_gb: {
@@ -9981,11 +10077,22 @@ declare function useUpdateProjectNextPeriodAddons(): _tanstack_react_query.UseMu
         packs_next?: number | null | undefined;
         plan_name: string;
         plan_ai_gbp: number;
+        plan_monthly_ex_vat_pence: number;
+        total_monthly_ex_vat_pence: number;
         plan_storage_gb: number;
         block_ai_gbp: number;
+        block_collaborators: number;
+        spend_cap_step_pence: number;
+        maximum_spend_cap_pence: number;
+        default_spend_cap_pence: number;
+        included_collaborators: number;
+        collaborator_blocks_min: number;
+        collaborator_block_price_ex_vat_pence: number;
+        collaborator_block_period_ex_vat_pence: number;
         block_storage_gb: number;
         ai_blocks: number;
         storage_blocks: number;
+        collaborator_blocks: number;
         legacy_ai_blocks: number;
         legacy_storage_blocks: number;
         legacy_block_ai_gbp: number;
@@ -9994,6 +10101,7 @@ declare function useUpdateProjectNextPeriodAddons(): _tanstack_react_query.UseMu
         blocks_storage_gb: number;
         ai_blocks_next?: number | null | undefined;
         storage_blocks_next?: number | null | undefined;
+        collaborator_blocks_next?: number | null | undefined;
         storage_blocks_min: number;
         auto_topup_threshold_gbp: number;
         min_auto_topup_threshold_gbp: number;
@@ -10025,11 +10133,12 @@ declare function useUpdateProjectNextPeriodAddons(): _tanstack_react_query.UseMu
         period_end?: number | null | undefined;
         ai_usage_reset_at?: number | null | undefined;
         pending_interval?: ("month" | "year") | null | undefined;
+        renewal_error?: string | null | undefined;
         billing_error?: string | null | undefined;
         confirm_url?: string | null | undefined;
         payment?: {
             status: "pending" | "paid";
-            kind?: ("ai_usage" | "storage") | null | undefined;
+            kind?: ("ai_usage" | "storage" | "collaborators") | null | undefined;
             amount_pence?: number | null | undefined;
             amount_ex_vat_pence?: number | null | undefined;
             tax_pence?: number | null | undefined;
@@ -10055,6 +10164,9 @@ declare function useUpdateProjectAddonSettings(): _tanstack_react_query.UseMutat
     name: string;
     created_by: string;
     subscription: string;
+    is_personal: boolean;
+    subscription_ended_at?: string | null | undefined;
+    retention_delete_at?: string | null | undefined;
     created_at: string;
     quotas: {
         storage_gb: {
@@ -10103,11 +10215,22 @@ declare function useUpdateProjectAddonSettings(): _tanstack_react_query.UseMutat
         packs_next?: number | null | undefined;
         plan_name: string;
         plan_ai_gbp: number;
+        plan_monthly_ex_vat_pence: number;
+        total_monthly_ex_vat_pence: number;
         plan_storage_gb: number;
         block_ai_gbp: number;
+        block_collaborators: number;
+        spend_cap_step_pence: number;
+        maximum_spend_cap_pence: number;
+        default_spend_cap_pence: number;
+        included_collaborators: number;
+        collaborator_blocks_min: number;
+        collaborator_block_price_ex_vat_pence: number;
+        collaborator_block_period_ex_vat_pence: number;
         block_storage_gb: number;
         ai_blocks: number;
         storage_blocks: number;
+        collaborator_blocks: number;
         legacy_ai_blocks: number;
         legacy_storage_blocks: number;
         legacy_block_ai_gbp: number;
@@ -10116,6 +10239,7 @@ declare function useUpdateProjectAddonSettings(): _tanstack_react_query.UseMutat
         blocks_storage_gb: number;
         ai_blocks_next?: number | null | undefined;
         storage_blocks_next?: number | null | undefined;
+        collaborator_blocks_next?: number | null | undefined;
         storage_blocks_min: number;
         auto_topup_threshold_gbp: number;
         min_auto_topup_threshold_gbp: number;
@@ -10147,11 +10271,12 @@ declare function useUpdateProjectAddonSettings(): _tanstack_react_query.UseMutat
         period_end?: number | null | undefined;
         ai_usage_reset_at?: number | null | undefined;
         pending_interval?: ("month" | "year") | null | undefined;
+        renewal_error?: string | null | undefined;
         billing_error?: string | null | undefined;
         confirm_url?: string | null | undefined;
         payment?: {
             status: "pending" | "paid";
-            kind?: ("ai_usage" | "storage") | null | undefined;
+            kind?: ("ai_usage" | "storage" | "collaborators") | null | undefined;
             amount_pence?: number | null | undefined;
             amount_ex_vat_pence?: number | null | undefined;
             tax_pence?: number | null | undefined;