@phala/cloud 0.0.10 → 0.0.11

package/dist/actions/workspaces/list_workspaces.d.ts

@@ -0,0 +1,219 @@
+import { z } from "zod";
+import { type Client, type SafeResult } from "../../client";
+import { ActionParameters, ActionReturnType } from "../../types/common";
+/**
+ * List workspaces accessible by the current user
+ *
+ * Returns a paginated list of workspaces with their basic information.
+ *
+ * @example
+ * ```typescript
+ * import { createClient, listWorkspaces } from '@phala/cloud'
+ *
+ * const client = createClient({ apiKey: 'your-api-key' })
+ * const workspaces = await listWorkspaces(client)
+ * // Output: { data: [{ id: '...', name: '...', ... }], pagination: { ... } }
+ * ```
+ *
+ * ## Returns
+ *
+ * `ListWorkspaces | unknown`
+ *
+ * Information about accessible workspaces. Return type depends on schema parameter.
+ *
+ * ## Parameters
+ *
+ * ### parameters (optional)
+ * - **Type:** `ListWorkspacesParameters`
+ *
+ * Optional behavior parameters for schema validation and pagination.
+ *
+ * ```typescript
+ * // Use default schema
+ * const workspaces = await listWorkspaces(client)
+ *
+ * // Return raw data without validation
+ * const raw = await listWorkspaces(client, { schema: false })
+ *
+ * // Use custom schema
+ * const customSchema = z.object({ data: z.array(z.object({ id: z.string() })) })
+ * const custom = await listWorkspaces(client, { schema: customSchema })
+ *
+ * // With pagination
+ * const page = await listWorkspaces(client, { limit: 20, cursor: 'next-page-cursor' })
+ * ```
+ *
+ * ## Safe Version
+ *
+ * Use `safeListWorkspaces` for error handling without exceptions:
+ *
+ * ```typescript
+ * import { safeListWorkspaces } from '@phala/cloud'
+ *
+ * const result = await safeListWorkspaces(client)
+ * if (result.success) {
+ *   console.log(result.data.data[0].name)
+ * } else {
+ *   if ("isRequestError" in result.error) {
+ *     console.error(`HTTP ${result.error.status}: ${result.error.message}`)
+ *   } else {
+ *     console.error(`Validation error: ${result.error.issues}`)
+ *   }
+ * }
+ * ```
+ */
+export declare const WorkspaceResponseSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    slug: z.ZodNullable<z.ZodString>;
+    tier: z.ZodString;
+    role: z.ZodString;
+    created_at: z.ZodString;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    id: z.ZodString;
+    name: z.ZodString;
+    slug: z.ZodNullable<z.ZodString>;
+    tier: z.ZodString;
+    role: z.ZodString;
+    created_at: z.ZodString;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    id: z.ZodString;
+    name: z.ZodString;
+    slug: z.ZodNullable<z.ZodString>;
+    tier: z.ZodString;
+    role: z.ZodString;
+    created_at: z.ZodString;
+}, z.ZodTypeAny, "passthrough">>;
+export declare const PaginationMetadataSchema: z.ZodObject<{
+    has_more: z.ZodBoolean;
+    next_cursor: z.ZodNullable<z.ZodString>;
+    total: z.ZodNullable<z.ZodNumber>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    has_more: z.ZodBoolean;
+    next_cursor: z.ZodNullable<z.ZodString>;
+    total: z.ZodNullable<z.ZodNumber>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    has_more: z.ZodBoolean;
+    next_cursor: z.ZodNullable<z.ZodString>;
+    total: z.ZodNullable<z.ZodNumber>;
+}, z.ZodTypeAny, "passthrough">>;
+export declare const ListWorkspacesSchema: z.ZodObject<{
+    data: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        slug: z.ZodNullable<z.ZodString>;
+        tier: z.ZodString;
+        role: z.ZodString;
+        created_at: z.ZodString;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        id: z.ZodString;
+        name: z.ZodString;
+        slug: z.ZodNullable<z.ZodString>;
+        tier: z.ZodString;
+        role: z.ZodString;
+        created_at: z.ZodString;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        id: z.ZodString;
+        name: z.ZodString;
+        slug: z.ZodNullable<z.ZodString>;
+        tier: z.ZodString;
+        role: z.ZodString;
+        created_at: z.ZodString;
+    }, z.ZodTypeAny, "passthrough">>, "many">;
+    pagination: z.ZodObject<{
+        has_more: z.ZodBoolean;
+        next_cursor: z.ZodNullable<z.ZodString>;
+        total: z.ZodNullable<z.ZodNumber>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        has_more: z.ZodBoolean;
+        next_cursor: z.ZodNullable<z.ZodString>;
+        total: z.ZodNullable<z.ZodNumber>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        has_more: z.ZodBoolean;
+        next_cursor: z.ZodNullable<z.ZodString>;
+        total: z.ZodNullable<z.ZodNumber>;
+    }, z.ZodTypeAny, "passthrough">>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    data: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        slug: z.ZodNullable<z.ZodString>;
+        tier: z.ZodString;
+        role: z.ZodString;
+        created_at: z.ZodString;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        id: z.ZodString;
+        name: z.ZodString;
+        slug: z.ZodNullable<z.ZodString>;
+        tier: z.ZodString;
+        role: z.ZodString;
+        created_at: z.ZodString;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        id: z.ZodString;
+        name: z.ZodString;
+        slug: z.ZodNullable<z.ZodString>;
+        tier: z.ZodString;
+        role: z.ZodString;
+        created_at: z.ZodString;
+    }, z.ZodTypeAny, "passthrough">>, "many">;
+    pagination: z.ZodObject<{
+        has_more: z.ZodBoolean;
+        next_cursor: z.ZodNullable<z.ZodString>;
+        total: z.ZodNullable<z.ZodNumber>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        has_more: z.ZodBoolean;
+        next_cursor: z.ZodNullable<z.ZodString>;
+        total: z.ZodNullable<z.ZodNumber>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        has_more: z.ZodBoolean;
+        next_cursor: z.ZodNullable<z.ZodString>;
+        total: z.ZodNullable<z.ZodNumber>;
+    }, z.ZodTypeAny, "passthrough">>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    data: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        slug: z.ZodNullable<z.ZodString>;
+        tier: z.ZodString;
+        role: z.ZodString;
+        created_at: z.ZodString;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        id: z.ZodString;
+        name: z.ZodString;
+        slug: z.ZodNullable<z.ZodString>;
+        tier: z.ZodString;
+        role: z.ZodString;
+        created_at: z.ZodString;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        id: z.ZodString;
+        name: z.ZodString;
+        slug: z.ZodNullable<z.ZodString>;
+        tier: z.ZodString;
+        role: z.ZodString;
+        created_at: z.ZodString;
+    }, z.ZodTypeAny, "passthrough">>, "many">;
+    pagination: z.ZodObject<{
+        has_more: z.ZodBoolean;
+        next_cursor: z.ZodNullable<z.ZodString>;
+        total: z.ZodNullable<z.ZodNumber>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        has_more: z.ZodBoolean;
+        next_cursor: z.ZodNullable<z.ZodString>;
+        total: z.ZodNullable<z.ZodNumber>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        has_more: z.ZodBoolean;
+        next_cursor: z.ZodNullable<z.ZodString>;
+        total: z.ZodNullable<z.ZodNumber>;
+    }, z.ZodTypeAny, "passthrough">>;
+}, z.ZodTypeAny, "passthrough">>;
+export type WorkspaceResponse = z.infer<typeof WorkspaceResponseSchema>;
+export type PaginationMetadata = z.infer<typeof PaginationMetadataSchema>;
+export type ListWorkspaces = z.infer<typeof ListWorkspacesSchema>;
+export type ListWorkspacesParameters<T = undefined> = ActionParameters<T> & {
+    cursor?: string;
+    limit?: number;
+};
+export type ListWorkspacesReturnType<T = undefined> = ActionReturnType<ListWorkspaces, T>;
+export declare function listWorkspaces<T extends z.ZodSchema | false | undefined = undefined>(client: Client, parameters?: ListWorkspacesParameters<T>): Promise<ListWorkspacesReturnType<T>>;
+export declare function safeListWorkspaces<T extends z.ZodSchema | false | undefined = undefined>(client: Client, parameters?: ListWorkspacesParameters<T>): Promise<SafeResult<ListWorkspacesReturnType<T>>>;
+//# sourceMappingURL=list_workspaces.d.ts.map

package/dist/actions/workspaces/list_workspaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"list_workspaces.d.ts","sourceRoot":"","sources":["../../../src/actions/workspaces/list_workspaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,UAAU,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAGxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4DG;AAEH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;gCASpB,CAAC;AAEjB,eAAO,MAAM,wBAAwB;;;;;;;;;;;;gCAMrB,CAAC;AAEjB,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gCAKjB,CAAC;AAEjB,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AACxE,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAC1E,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAElE,MAAM,MAAM,wBAAwB,CAAC,CAAC,GAAG,SAAS,IAAI,gBAAgB,CAAC,CAAC,CAAC,GAAG;IAC1E,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,wBAAwB,CAAC,CAAC,GAAG,SAAS,IAAI,gBAAgB,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;AAE1F,wBAAsB,cAAc,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS,GAAG,KAAK,GAAG,SAAS,GAAG,SAAS,EACxF,MAAM,EAAE,MAAM,EACd,UAAU,CAAC,EAAE,wBAAwB,CAAC,CAAC,CAAC,GACvC,OAAO,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC,CAiBtC;AAED,wBAAsB,kBAAkB,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS,GAAG,KAAK,GAAG,SAAS,GAAG,SAAS,EAC5F,MAAM,EAAE,MAAM,EACd,UAAU,CAAC,EAAE,wBAAwB,CAAC,CAAC,CAAC,GACvC,OAAO,CAAC,UAAU,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC,CAAC,CAuBlD"}