shred-api-client 2.12.2 → 2.13.0

package/dist/index.d.ts

@@ -1713,11 +1713,17 @@ type Preferences = z.infer<typeof PreferencesSchema>;
 interface IAPI$c {
     getByInviteCode: (code: string, context?: Context) => Promise<Tenant | null>;
     create: (tenant: Tenant, context: Context) => Promise<boolean>;
-    list: (context: Context) => Promise<Tenant[]>;
+    /** Deleted tenants are left out unless `includeInactive` is true. */
+    list: (context: Context, options?: ListOptions) => Promise<Tenant[]>;
     getTenant: (context: Context, tenantId?: string) => Promise<Tenant | null>;
     getMembers: (context: Context, tenantId: string) => Promise<Member[]>;
     update: (tenantId: string, data: TenantUpdate, context: Context) => Promise<boolean>;
     updateMembers: (tenantId: string, memberUpdate: MemberUpdate, context: Context) => Promise<boolean>;
+    /** Logical delete: the tenant becomes inactive and every member leaves it. */
+    delete: (tenantId: string, context: Context) => Promise<boolean>;
+}
+interface ListOptions {
+    includeInactive?: boolean;
 }
 declare const Endpoints$b: {
     GetByInviteCode: {
@@ -1752,8 +1758,13 @@ declare const Endpoints$b: {
         uri: string;
         method: string;
     };
+    DeleteTenant: {
+        uri: string;
+        method: string;
+    };
 };
 
+type index$d_ListOptions = ListOptions;
 type index$d_Member = Member;
 declare const index$d_MemberSchema: typeof MemberSchema;
 type index$d_MemberUpdate = MemberUpdate;
@@ -1764,7 +1775,7 @@ declare const index$d_TenantSchema: typeof TenantSchema;
 type index$d_TenantUpdate = TenantUpdate;
 declare const index$d_TenantUpdateSchema: typeof TenantUpdateSchema;
 declare namespace index$d {
-  export { Action$1 as Action, Endpoints$b as Endpoints, type Tenant as Entity, type IAPI$c as IAPI, type index$d_Member as Member, index$d_MemberSchema as MemberSchema, type index$d_MemberUpdate as MemberUpdate, index$d_MemberUpdateSchema as MemberUpdateSchema, type index$d_Preferences as Preferences, index$d_PreferencesSchema as PreferencesSchema, index$d_TenantSchema as TenantSchema, type index$d_TenantUpdate as TenantUpdate, index$d_TenantUpdateSchema as TenantUpdateSchema };
+  export { Action$1 as Action, Endpoints$b as Endpoints, type Tenant as Entity, type IAPI$c as IAPI, type index$d_ListOptions as ListOptions, type index$d_Member as Member, index$d_MemberSchema as MemberSchema, type index$d_MemberUpdate as MemberUpdate, index$d_MemberUpdateSchema as MemberUpdateSchema, type index$d_Preferences as Preferences, index$d_PreferencesSchema as PreferencesSchema, index$d_TenantSchema as TenantSchema, type index$d_TenantUpdate as TenantUpdate, index$d_TenantUpdateSchema as TenantUpdateSchema };
 }
 
 declare const TrackParamSchema: z.ZodObject<{
@@ -5318,6 +5329,7 @@ declare const Actions: {
     readonly TENANT_LIST: "tenant.list";
     readonly TENANT_VIEW: "tenant.view";
     readonly TENANT_UPDATE: "tenant.update";
+    readonly TENANT_DELETE: "tenant.delete";
     readonly TENANT_VIEW_MEMBERS: "tenant.view_members";
     readonly TENANT_UPDATE_MEMBERS: "tenant.update_members";
     readonly TENANT_VIEW_REPORT: "tenant.view_report";

package/dist/index.js

@@ -4747,11 +4747,12 @@ var TenantAPI = class {
     );
     return data;
   }
-  async list(context) {
+  async list(context, options) {
     const endpointInfo = tenant_exports.Endpoints.ListAll;
+    const endpoint = (options == null ? void 0 : options.includeInactive) ? `${endpointInfo.uri}?includeInactive=true` : endpointInfo.uri;
     const data = await this.clientHTTP.makeRequest(
       this.env,
-      `${endpointInfo.uri}`,
+      endpoint,
       endpointInfo.method,
       null,
       context
@@ -4793,6 +4794,18 @@ var TenantAPI = class {
     );
     return data;
   }
+  async delete(tenantId, context) {
+    const endpointInfo = tenant_exports.Endpoints.DeleteTenant;
+    const endpoint = endpointInfo.uri.replace(":tenantId", tenantId);
+    const data = await this.clientHTTP.makeRequest(
+      this.env,
+      endpoint,
+      endpointInfo.method,
+      null,
+      context
+    );
+    return data;
+  }
 };
 var Tenant_api_default = TenantAPI;
 
@@ -6476,6 +6489,7 @@ var Actions = {
   TENANT_LIST: "tenant.list",
   TENANT_VIEW: "tenant.view",
   TENANT_UPDATE: "tenant.update",
+  TENANT_DELETE: "tenant.delete",
   TENANT_VIEW_MEMBERS: "tenant.view_members",
   TENANT_UPDATE_MEMBERS: "tenant.update_members",
   TENANT_VIEW_REPORT: "tenant.view_report",
@@ -6572,6 +6586,7 @@ var ActionCatalog = {
   [Actions.TENANT_LIST]: { label: "List all tenants", group: "Tenants" },
   [Actions.TENANT_VIEW]: { label: "View any tenant", group: "Tenants" },
   [Actions.TENANT_UPDATE]: { label: "Update any tenant", group: "Tenants" },
+  [Actions.TENANT_DELETE]: { label: "Delete a tenant", group: "Tenants" },
   [Actions.TENANT_VIEW_MEMBERS]: { label: "View a tenant's members", group: "Tenants" },
   [Actions.TENANT_UPDATE_MEMBERS]: { label: "Manage a tenant's members", group: "Tenants" },
   [Actions.TENANT_VIEW_REPORT]: { label: "View a tenant's report", group: "Tenants", scopeable: true },
@@ -6999,6 +7014,10 @@ var Endpoints13 = {
   UpdateMembers: {
     uri: "/tenants/:tenantId/members",
     method: "PUT"
+  },
+  DeleteTenant: {
+    uri: "/tenants/:tenantId",
+    method: "DELETE"
   }
 };