@fern-api/fdr-sdk 1.0.4-92b8658c63 → 1.0.4-cab13ddd2d

package/dist/client/FdrClient.d.ts

@@ -0,0 +1,808 @@
+import { type CreateFdrORPCClientOptions, createFdrORPCClient, type FdrORPCClient } from "../orpc-client/client.js";
+export type { CreateFdrORPCClientOptions, FdrORPCClient };
+export { createFdrORPCClient };
+export interface FdrClientOptions {
+    environment?: string;
+    token?: string;
+}
+/**
+ * Backward-compatible FdrClient class that wraps the oRPC composite client.
+ * Supports `new FdrClient({ environment, token })` syntax used by downstream packages.
+ */
+export declare class FdrClient {
+    private readonly client;
+    constructor(options?: FdrClientOptions);
+    get api(): import("../orpc-client/index.js").ApiClient;
+    get dashboard(): {
+        getDocsSitesForOrg: import("@orpc/client").Client<Record<never, never>, {
+            orgId: string;
+        }, {
+            docsSites: {
+                urls: {
+                    domain: string;
+                    path?: string | null | undefined;
+                }[];
+                mainUrl: {
+                    domain: string;
+                    path?: string | null | undefined;
+                };
+            }[];
+        }, Error>;
+    };
+    get docs(): import("../orpc-client/index.js").DocsClient;
+    get docsCache(): {
+        invalidate: import("@orpc/client").Client<Record<never, never>, {
+            url: string;
+        }, unknown, Error>;
+    };
+    get generators(): import("../orpc-client/client.js").GeneratorsClient;
+    get git(): {
+        getRepository: import("@orpc/client").Client<Record<never, never>, {
+            repositoryOwner: string;
+            repositoryName: string;
+        }, {
+            type: "sdk";
+            url: string;
+            id: {
+                type: "github";
+                id: string;
+            };
+            name: string;
+            owner: string;
+            fullName: string;
+            repositoryOwnerOrganizationId: string;
+            defaultBranchChecks: {
+                status: string;
+                name: string;
+                createdAt: string;
+                checkId: string;
+                repositoryOwner: string;
+                repositoryName: string;
+                ref: string;
+                conclusion: string;
+                checkRunUrl: string;
+                completedAt?: string | null | undefined;
+                rawCheckRun?: unknown;
+            }[];
+            sdkLanguage: string;
+        } | {
+            type: "config";
+            url: string;
+            id: {
+                type: "github";
+                id: string;
+            };
+            name: string;
+            owner: string;
+            fullName: string;
+            repositoryOwnerOrganizationId: string;
+            defaultBranchChecks: {
+                status: string;
+                name: string;
+                createdAt: string;
+                checkId: string;
+                repositoryOwner: string;
+                repositoryName: string;
+                ref: string;
+                conclusion: string;
+                checkRunUrl: string;
+                completedAt?: string | null | undefined;
+                rawCheckRun?: unknown;
+            }[];
+        }, Error>;
+        listRepositories: import("@orpc/client").Client<Record<never, never>, {
+            page?: number | null | undefined;
+            organizationId?: string | null | undefined;
+            pageSize?: number | null | undefined;
+            repositoryOwner?: string | null | undefined;
+            repositoryName?: string | null | undefined;
+        }, {
+            repositories: ({
+                type: "sdk";
+                url: string;
+                id: {
+                    type: "github";
+                    id: string;
+                };
+                name: string;
+                owner: string;
+                fullName: string;
+                repositoryOwnerOrganizationId: string;
+                defaultBranchChecks: {
+                    status: string;
+                    name: string;
+                    createdAt: string;
+                    checkId: string;
+                    repositoryOwner: string;
+                    repositoryName: string;
+                    ref: string;
+                    conclusion: string;
+                    checkRunUrl: string;
+                    completedAt?: string | null | undefined;
+                    rawCheckRun?: unknown;
+                }[];
+                sdkLanguage: string;
+            } | {
+                type: "config";
+                url: string;
+                id: {
+                    type: "github";
+                    id: string;
+                };
+                name: string;
+                owner: string;
+                fullName: string;
+                repositoryOwnerOrganizationId: string;
+                defaultBranchChecks: {
+                    status: string;
+                    name: string;
+                    createdAt: string;
+                    checkId: string;
+                    repositoryOwner: string;
+                    repositoryName: string;
+                    ref: string;
+                    conclusion: string;
+                    checkRunUrl: string;
+                    completedAt?: string | null | undefined;
+                    rawCheckRun?: unknown;
+                }[];
+            })[];
+        }, Error>;
+        upsertRepository: import("@orpc/client").Client<Record<never, never>, {
+            type: "sdk";
+            url: string;
+            id: {
+                type: "github";
+                id: string;
+            };
+            name: string;
+            owner: string;
+            fullName: string;
+            repositoryOwnerOrganizationId: string;
+            defaultBranchChecks: {
+                status: string;
+                name: string;
+                createdAt: string;
+                checkId: string;
+                repositoryOwner: string;
+                repositoryName: string;
+                ref: string;
+                conclusion: string;
+                checkRunUrl: string;
+                completedAt?: string | null | undefined;
+                rawCheckRun?: unknown;
+            }[];
+            sdkLanguage: string;
+        } | {
+            type: "config";
+            url: string;
+            id: {
+                type: "github";
+                id: string;
+            };
+            name: string;
+            owner: string;
+            fullName: string;
+            repositoryOwnerOrganizationId: string;
+            defaultBranchChecks: {
+                status: string;
+                name: string;
+                createdAt: string;
+                checkId: string;
+                repositoryOwner: string;
+                repositoryName: string;
+                ref: string;
+                conclusion: string;
+                checkRunUrl: string;
+                completedAt?: string | null | undefined;
+                rawCheckRun?: unknown;
+            }[];
+        }, unknown, Error>;
+        deleteRepository: import("@orpc/client").Client<Record<never, never>, {
+            repositoryOwner: string;
+            repositoryName: string;
+        }, unknown, Error>;
+        getPullRequest: import("@orpc/client").Client<Record<never, never>, {
+            repositoryOwner: string;
+            repositoryName: string;
+            pullRequestNumber: number;
+        }, {
+            url: string;
+            title: string;
+            createdAt: string;
+            repositoryOwner: string;
+            repositoryName: string;
+            pullRequestNumber: number;
+            reviewers: ({
+                type: "user";
+                username: string;
+                name?: string | null | undefined;
+                email?: string | null | undefined;
+            } | {
+                type: "team";
+                name: string;
+                teamId: string;
+            })[];
+            checks: {
+                status: string;
+                name: string;
+                createdAt: string;
+                checkId: string;
+                repositoryOwner: string;
+                repositoryName: string;
+                ref: string;
+                conclusion: string;
+                checkRunUrl: string;
+                completedAt?: string | null | undefined;
+                rawCheckRun?: unknown;
+            }[];
+            state: "open" | "closed" | "merged";
+            updatedAt?: string | null | undefined;
+            author?: {
+                username: string;
+                name?: string | null | undefined;
+                email?: string | null | undefined;
+            } | null | undefined;
+            mergedAt?: string | null | undefined;
+            closedAt?: string | null | undefined;
+        }, Error>;
+        listPullRequests: import("@orpc/client").Client<Record<never, never>, {
+            page?: number | null | undefined;
+            organizationId?: string | null | undefined;
+            pageSize?: number | null | undefined;
+            repositoryOwner?: string | null | undefined;
+            repositoryName?: string | null | undefined;
+            author?: string[] | null | undefined;
+            state?: ("open" | "closed" | "merged")[] | null | undefined;
+        }, {
+            pullRequests: {
+                url: string;
+                title: string;
+                createdAt: string;
+                repositoryOwner: string;
+                repositoryName: string;
+                pullRequestNumber: number;
+                reviewers: ({
+                    type: "user";
+                    username: string;
+                    name?: string | null | undefined;
+                    email?: string | null | undefined;
+                } | {
+                    type: "team";
+                    name: string;
+                    teamId: string;
+                })[];
+                checks: {
+                    status: string;
+                    name: string;
+                    createdAt: string;
+                    checkId: string;
+                    repositoryOwner: string;
+                    repositoryName: string;
+                    ref: string;
+                    conclusion: string;
+                    checkRunUrl: string;
+                    completedAt?: string | null | undefined;
+                    rawCheckRun?: unknown;
+                }[];
+                state: "open" | "closed" | "merged";
+                updatedAt?: string | null | undefined;
+                author?: {
+                    username: string;
+                    name?: string | null | undefined;
+                    email?: string | null | undefined;
+                } | null | undefined;
+                mergedAt?: string | null | undefined;
+                closedAt?: string | null | undefined;
+            }[];
+        }, Error>;
+        upsertPullRequest: import("@orpc/client").Client<Record<never, never>, {
+            url: string;
+            title: string;
+            createdAt: string;
+            repositoryOwner: string;
+            repositoryName: string;
+            pullRequestNumber: number;
+            reviewers: ({
+                type: "user";
+                username: string;
+                name?: string | null | undefined;
+                email?: string | null | undefined;
+            } | {
+                type: "team";
+                name: string;
+                teamId: string;
+            })[];
+            checks: {
+                status: string;
+                name: string;
+                createdAt: string;
+                checkId: string;
+                repositoryOwner: string;
+                repositoryName: string;
+                ref: string;
+                conclusion: string;
+                checkRunUrl: string;
+                completedAt?: string | null | undefined;
+                rawCheckRun?: unknown;
+            }[];
+            state: "open" | "closed" | "merged";
+            updatedAt?: string | null | undefined;
+            author?: {
+                username: string;
+                name?: string | null | undefined;
+                email?: string | null | undefined;
+            } | null | undefined;
+            mergedAt?: string | null | undefined;
+            closedAt?: string | null | undefined;
+        }, unknown, Error>;
+        deletePullRequest: import("@orpc/client").Client<Record<never, never>, {
+            repositoryOwner: string;
+            repositoryName: string;
+            pullRequestNumber: number;
+        }, unknown, Error>;
+    };
+    get pdfExport(): {
+        createTask: import("@orpc/client").Client<Record<never, never>, {
+            orgId: string;
+            docsUrl: string;
+            options?: {
+                version: "v1";
+                coverTitle?: string | null | undefined;
+                coverSubtitle?: string | null | undefined;
+                hideCoverFooter?: boolean | null | undefined;
+                headerLeftTemplate?: string | null | undefined;
+                headerRightTemplate?: string | null | undefined;
+                footerLeftTemplate?: string | null | undefined;
+                footerRightTemplate?: string | null | undefined;
+            } | null | undefined;
+            productId?: string | null | undefined;
+            versionId?: string | null | undefined;
+            requesterName?: string | null | undefined;
+            notifyEmails?: string[] | null | undefined;
+        }, {
+            status: "PENDING" | "RUNNING" | "COMPLETED" | "FAILED";
+            orgId: string;
+            id: string;
+            createdAt: string;
+            docsUrl: string;
+            options?: {
+                version: "v1";
+                coverTitle?: string | null | undefined;
+                coverSubtitle?: string | null | undefined;
+                hideCoverFooter?: boolean | null | undefined;
+                headerLeftTemplate?: string | null | undefined;
+                headerRightTemplate?: string | null | undefined;
+                footerLeftTemplate?: string | null | undefined;
+                footerRightTemplate?: string | null | undefined;
+            } | null | undefined;
+            completedAt?: string | null | undefined;
+            productId?: string | null | undefined;
+            versionId?: string | null | undefined;
+            requesterName?: string | null | undefined;
+            notifyEmails?: string[] | null | undefined;
+            startedAt?: string | null | undefined;
+            fileName?: string | null | undefined;
+            sizeBytes?: number | null | undefined;
+            errorMessage?: string | null | undefined;
+        }, Error>;
+        listTasks: import("@orpc/client").Client<Record<never, never>, {
+            orgId: string;
+            docsUrl: string;
+            limit?: number | null | undefined;
+        }, {
+            tasks: {
+                status: "PENDING" | "RUNNING" | "COMPLETED" | "FAILED";
+                orgId: string;
+                id: string;
+                createdAt: string;
+                docsUrl: string;
+                options?: {
+                    version: "v1";
+                    coverTitle?: string | null | undefined;
+                    coverSubtitle?: string | null | undefined;
+                    hideCoverFooter?: boolean | null | undefined;
+                    headerLeftTemplate?: string | null | undefined;
+                    headerRightTemplate?: string | null | undefined;
+                    footerLeftTemplate?: string | null | undefined;
+                    footerRightTemplate?: string | null | undefined;
+                } | null | undefined;
+                completedAt?: string | null | undefined;
+                productId?: string | null | undefined;
+                versionId?: string | null | undefined;
+                requesterName?: string | null | undefined;
+                notifyEmails?: string[] | null | undefined;
+                startedAt?: string | null | undefined;
+                fileName?: string | null | undefined;
+                sizeBytes?: number | null | undefined;
+                errorMessage?: string | null | undefined;
+            }[];
+        }, Error>;
+        getTask: import("@orpc/client").Client<Record<never, never>, {
+            taskId: string;
+        }, {
+            status: "PENDING" | "RUNNING" | "COMPLETED" | "FAILED";
+            orgId: string;
+            id: string;
+            createdAt: string;
+            docsUrl: string;
+            options?: {
+                version: "v1";
+                coverTitle?: string | null | undefined;
+                coverSubtitle?: string | null | undefined;
+                hideCoverFooter?: boolean | null | undefined;
+                headerLeftTemplate?: string | null | undefined;
+                headerRightTemplate?: string | null | undefined;
+                footerLeftTemplate?: string | null | undefined;
+                footerRightTemplate?: string | null | undefined;
+            } | null | undefined;
+            completedAt?: string | null | undefined;
+            productId?: string | null | undefined;
+            versionId?: string | null | undefined;
+            requesterName?: string | null | undefined;
+            notifyEmails?: string[] | null | undefined;
+            startedAt?: string | null | undefined;
+            fileName?: string | null | undefined;
+            sizeBytes?: number | null | undefined;
+            errorMessage?: string | null | undefined;
+        }, Error>;
+        updateTask: import("@orpc/client").Client<Record<never, never>, {
+            status: "PENDING" | "RUNNING" | "COMPLETED" | "FAILED";
+            taskId: string;
+            completedAt?: string | null | undefined;
+            startedAt?: string | null | undefined;
+            fileName?: string | null | undefined;
+            sizeBytes?: number | null | undefined;
+            errorMessage?: string | null | undefined;
+            s3Key?: string | null | undefined;
+        }, {
+            status: "PENDING" | "RUNNING" | "COMPLETED" | "FAILED";
+            orgId: string;
+            id: string;
+            createdAt: string;
+            docsUrl: string;
+            options?: {
+                version: "v1";
+                coverTitle?: string | null | undefined;
+                coverSubtitle?: string | null | undefined;
+                hideCoverFooter?: boolean | null | undefined;
+                headerLeftTemplate?: string | null | undefined;
+                headerRightTemplate?: string | null | undefined;
+                footerLeftTemplate?: string | null | undefined;
+                footerRightTemplate?: string | null | undefined;
+            } | null | undefined;
+            completedAt?: string | null | undefined;
+            productId?: string | null | undefined;
+            versionId?: string | null | undefined;
+            requesterName?: string | null | undefined;
+            notifyEmails?: string[] | null | undefined;
+            startedAt?: string | null | undefined;
+            fileName?: string | null | undefined;
+            sizeBytes?: number | null | undefined;
+            errorMessage?: string | null | undefined;
+        }, Error>;
+        getDownloadUrl: import("@orpc/client").Client<Record<never, never>, {
+            taskId: string;
+        }, {
+            downloadUrl: string;
+            fileName: string;
+            sizeBytes: number;
+        }, Error>;
+    };
+    get sdks(): {
+        computeSemanticVersion: import("@orpc/client").Client<Record<never, never>, {
+            language: "Python" | "Go" | "Ruby" | "Csharp" | "Php" | "Swift" | "Rust" | "Java" | "TypeScript";
+            package: string;
+            githubRepository?: string | null | undefined;
+        }, {
+            version: string;
+            bump: "PATCH" | "MAJOR" | "MINOR";
+        }, Error>;
+    };
+    get snippets(): {
+        get: import("@orpc/client").Client<Record<never, never>, {
+            endpoint: {
+                path: string;
+                method: "POST" | "HEAD" | "GET" | "PUT" | "DELETE" | "PATCH";
+                identifierOverride?: string | null | undefined;
+            };
+            orgId?: string | null | undefined;
+            sdks?: import("./FdrAPI.js").SdkRequest[] | null | undefined;
+            payload?: {
+                pathParameters?: {
+                    name: string;
+                    value?: unknown;
+                }[] | null | undefined;
+                queryParameters?: {
+                    name: string;
+                    value?: unknown;
+                }[] | null | undefined;
+                headers?: {
+                    name: string;
+                    value?: unknown;
+                }[] | null | undefined;
+                requestBody?: unknown;
+                auth?: {
+                    type: "bearer";
+                    token: string;
+                } | {
+                    type: "basic";
+                    username: string;
+                    password: string;
+                } | null | undefined;
+            } | null | undefined;
+            apiId?: string | null | undefined;
+            exampleIdentifier?: string | null | undefined;
+        }, unknown[], Error>;
+        load: import("@orpc/client").Client<Record<never, never>, {
+            orgId?: string | null | undefined;
+            sdks?: import("./FdrAPI.js").SdkRequest[] | null | undefined;
+            apiId?: string | null | undefined;
+        }, {
+            snippets: {
+                [x: string]: {
+                    POST?: unknown[] | undefined;
+                    HEAD?: unknown[] | undefined;
+                    GET?: unknown[] | undefined;
+                    PUT?: unknown[] | undefined;
+                    DELETE?: unknown[] | undefined;
+                    PATCH?: unknown[] | undefined;
+                };
+            };
+            next?: number | null | undefined;
+        }, Error>;
+    };
+    get snippetsFactory(): {
+        createSnippetsForSdk: import("@orpc/client").Client<Record<never, never>, {
+            orgId: string;
+            snippets: {
+                type: "typescript";
+                snippets: {
+                    endpoint: {
+                        path: string;
+                        method: "POST" | "HEAD" | "GET" | "PUT" | "DELETE" | "PATCH";
+                        identifierOverride?: string | null | undefined;
+                    };
+                    snippet: {
+                        client: string;
+                    };
+                    exampleIdentifier?: string | null | undefined;
+                }[];
+                sdk: {
+                    version: string;
+                    package: string;
+                };
+            } | {
+                type: "python";
+                snippets: {
+                    endpoint: {
+                        path: string;
+                        method: "POST" | "HEAD" | "GET" | "PUT" | "DELETE" | "PATCH";
+                        identifierOverride?: string | null | undefined;
+                    };
+                    snippet: {
+                        async_client: string;
+                        sync_client: string;
+                    };
+                    exampleIdentifier?: string | null | undefined;
+                }[];
+                sdk: {
+                    version: string;
+                    package: string;
+                };
+            } | {
+                type: "go";
+                snippets: {
+                    endpoint: {
+                        path: string;
+                        method: "POST" | "HEAD" | "GET" | "PUT" | "DELETE" | "PATCH";
+                        identifierOverride?: string | null | undefined;
+                    };
+                    snippet: {
+                        client: string;
+                    };
+                    exampleIdentifier?: string | null | undefined;
+                }[];
+                sdk: {
+                    githubRepo: string;
+                    version: string;
+                };
+            } | {
+                type: "java";
+                snippets: {
+                    endpoint: {
+                        path: string;
+                        method: "POST" | "HEAD" | "GET" | "PUT" | "DELETE" | "PATCH";
+                        identifierOverride?: string | null | undefined;
+                    };
+                    snippet: {
+                        async_client: string;
+                        sync_client: string;
+                    };
+                    exampleIdentifier?: string | null | undefined;
+                }[];
+                sdk: {
+                    version: string;
+                    group: string;
+                    artifact: string;
+                };
+            } | {
+                type: "ruby";
+                snippets: {
+                    endpoint: {
+                        path: string;
+                        method: "POST" | "HEAD" | "GET" | "PUT" | "DELETE" | "PATCH";
+                        identifierOverride?: string | null | undefined;
+                    };
+                    snippet: {
+                        client: string;
+                    };
+                    exampleIdentifier?: string | null | undefined;
+                }[];
+                sdk: {
+                    version: string;
+                    gem: string;
+                };
+            } | {
+                type: "csharp";
+                snippets: {
+                    endpoint: {
+                        path: string;
+                        method: "POST" | "HEAD" | "GET" | "PUT" | "DELETE" | "PATCH";
+                        identifierOverride?: string | null | undefined;
+                    };
+                    snippet: {
+                        client: string;
+                    };
+                    exampleIdentifier?: string | null | undefined;
+                }[];
+                sdk: {
+                    version: string;
+                    package: string;
+                };
+            };
+            apiId: string;
+        }, unknown, Error>;
+    };
+    get templates(): {
+        register: import("@orpc/client").Client<Record<never, never>, {
+            orgId: string;
+            apiDefinitionId: string;
+            apiId: string;
+            snippet: {
+                endpointId: {
+                    path: string;
+                    method: "POST" | "HEAD" | "GET" | "PUT" | "DELETE" | "PATCH";
+                    identifierOverride?: string | null | undefined;
+                };
+                sdk: {
+                    type: "typescript";
+                    version: string;
+                    package: string;
+                } | {
+                    type: "python";
+                    version: string;
+                    package: string;
+                } | {
+                    type: "go";
+                    githubRepo: string;
+                    version: string;
+                } | {
+                    type: "ruby";
+                    version: string;
+                    gem: string;
+                } | {
+                    type: "java";
+                    version: string;
+                    group: string;
+                    artifact: string;
+                } | {
+                    type: "csharp";
+                    version: string;
+                    package: string;
+                };
+                snippetTemplate: {
+                    type: "v1";
+                    clientInstantiation: string;
+                    functionInvocation?: unknown;
+                };
+                additionalTemplates?: Record<string, unknown> | null | undefined;
+            };
+        }, unknown, Error>;
+        registerBatch: import("@orpc/client").Client<Record<never, never>, {
+            orgId: string;
+            snippets: {
+                endpointId: {
+                    path: string;
+                    method: "POST" | "HEAD" | "GET" | "PUT" | "DELETE" | "PATCH";
+                    identifierOverride?: string | null | undefined;
+                };
+                sdk: {
+                    type: "typescript";
+                    version: string;
+                    package: string;
+                } | {
+                    type: "python";
+                    version: string;
+                    package: string;
+                } | {
+                    type: "go";
+                    githubRepo: string;
+                    version: string;
+                } | {
+                    type: "ruby";
+                    version: string;
+                    gem: string;
+                } | {
+                    type: "java";
+                    version: string;
+                    group: string;
+                    artifact: string;
+                } | {
+                    type: "csharp";
+                    version: string;
+                    package: string;
+                };
+                snippetTemplate: {
+                    type: "v1";
+                    clientInstantiation: string;
+                    functionInvocation?: unknown;
+                };
+                additionalTemplates?: Record<string, unknown> | null | undefined;
+            }[];
+            apiDefinitionId: string;
+            apiId: string;
+        }, unknown, Error>;
+        get: import("@orpc/client").Client<Record<never, never>, {
+            orgId: string;
+            endpointId: {
+                path: string;
+                method: "POST" | "HEAD" | "GET" | "PUT" | "DELETE" | "PATCH";
+                identifierOverride?: string | null | undefined;
+            };
+            apiId: string;
+            sdk: {
+                type: "typescript";
+                version: string;
+                package: string;
+            } | {
+                type: "python";
+                version: string;
+                package: string;
+            } | {
+                type: "go";
+                githubRepo: string;
+                version: string;
+            } | {
+                type: "ruby";
+                version: string;
+                gem: string;
+            } | {
+                type: "java";
+                version: string;
+                group: string;
+                artifact: string;
+            } | {
+                type: "csharp";
+                version: string;
+                package: string;
+            };
+        }, {
+            [x: string]: unknown;
+        }, Error>;
+    };
+    get tokens(): {
+        generate: import("@orpc/client").Client<Record<never, never>, {
+            orgId: string;
+            scope: string;
+        }, {
+            id: string;
+            token: string;
+        }, Error>;
+        revoke: import("@orpc/client").Client<Record<never, never>, {
+            orgId: string;
+            tokenId: string;
+        }, unknown, Error>;
+    };
+}
+//# sourceMappingURL=FdrClient.d.ts.map