@sendbird/cli 0.0.0-stage → 0.3.0-alpha.1

package/dist/catalog.d.ts

@@ -0,0 +1,67 @@
+import { z } from "zod";
+export declare const verifySchema: z.ZodObject<{
+    user: z.ZodOptional<z.ZodObject<{}, z.core.$loose>>;
+    organization: z.ZodOptional<z.ZodObject<{}, z.core.$loose>>;
+    organizations: z.ZodOptional<z.ZodArray<z.ZodObject<{}, z.core.$loose>>>;
+    role: z.ZodOptional<z.ZodObject<{}, z.core.$loose>>;
+}, z.core.$loose>;
+export type Definition = {
+    name: string;
+    description: string;
+    method: string;
+    path: string;
+    scope?: "app" | "org";
+    requiresOrg?: boolean;
+    params?: z.ZodObject;
+    query?: z.ZodObject;
+    body?: z.ZodObject;
+    /** Validates the upstream API response before normalization/redaction. */
+    response: z.ZodType;
+    /** Optional final CLI result contract for composed/transformed responses. */
+    resultSchema?: z.ZodType;
+    multipart?: boolean;
+    danger?: boolean;
+    secret?: boolean;
+    privateFields?: string[];
+    source: [string, string];
+    example?: Record<string, unknown>;
+    exampleParams?: Record<string, unknown>;
+    exampleQuery?: Record<string, unknown>;
+    defaults?: Record<string, unknown>;
+};
+export declare const definitions: Definition[];
+export declare function jsonSchema(s?: z.ZodType): Record<string, unknown>;
+export declare function describe(d: Definition): {
+    private_input_fields?: string[] | undefined;
+    params: Record<string, unknown>;
+    query: Record<string, unknown>;
+    body: Record<string, unknown>;
+    response: Record<string, unknown>;
+    example: Record<string, unknown>;
+    dangerous: boolean;
+    source: [string, string];
+    requires_org_context?: boolean | undefined;
+    command: string;
+    description: string;
+    method: string;
+    path: string;
+    scope: "app" | "org" | undefined;
+};
+export declare function exampleFor(d: Definition): {
+    command: string;
+    params: {
+        [x: string]: unknown;
+    };
+    query: {
+        [x: string]: unknown;
+    };
+    body: Record<string, unknown>;
+    context: {
+        "org-id"?: string | undefined;
+        "app-id": string;
+    } | {
+        "org-id": string;
+    } | {
+        "org-id"?: undefined;
+    };
+};