@hasna/contacts 0.6.34 → 0.6.35

package/dist/server/openapi.d.ts

@@ -0,0 +1,1134 @@
+export declare function buildV1OpenApiDocument(version?: string): {
+    openapi: string;
+    info: {
+        title: string;
+        version: string;
+        description: string;
+    };
+    servers: {
+        url: string;
+    }[];
+    components: {
+        securitySchemes: {
+            apiKey: {
+                type: string;
+                in: string;
+                name: string;
+            };
+        };
+        schemas: {
+            Contact: {
+                readonly type: "object";
+                readonly required: readonly ["tags"];
+                readonly properties: {
+                    readonly id: {
+                        readonly type: "string";
+                    };
+                    readonly first_name: {
+                        readonly type: "string";
+                    };
+                    readonly last_name: {
+                        readonly type: "string";
+                    };
+                    readonly display_name: {
+                        readonly type: "string";
+                    };
+                    readonly nickname: {
+                        readonly type: "string";
+                        readonly nullable: true;
+                    };
+                    readonly company_id: {
+                        readonly type: "string";
+                        readonly nullable: true;
+                    };
+                    readonly job_title: {
+                        readonly type: "string";
+                        readonly nullable: true;
+                    };
+                    readonly notes: {
+                        readonly type: "string";
+                        readonly nullable: true;
+                    };
+                    readonly source: {
+                        readonly type: "string";
+                    };
+                    readonly status: {
+                        readonly type: "string";
+                    };
+                    readonly sensitivity: {
+                        readonly type: "string";
+                    };
+                    readonly archived: {
+                        readonly type: "boolean";
+                    };
+                    readonly priority: {
+                        readonly type: "number";
+                    };
+                    readonly tags: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly $ref: "#/components/schemas/Tag";
+                        };
+                    };
+                    readonly created_at: {
+                        readonly type: "string";
+                    };
+                    readonly updated_at: {
+                        readonly type: "string";
+                    };
+                };
+            };
+            Company: {
+                readonly type: "object";
+                readonly properties: {
+                    readonly id: {
+                        readonly type: "string";
+                    };
+                    readonly name: {
+                        readonly type: "string";
+                    };
+                    readonly domain: {
+                        readonly type: "string";
+                        readonly nullable: true;
+                    };
+                    readonly industry: {
+                        readonly type: "string";
+                        readonly nullable: true;
+                    };
+                    readonly size: {
+                        readonly type: "string";
+                        readonly nullable: true;
+                    };
+                    readonly founded_year: {
+                        readonly type: "number";
+                        readonly nullable: true;
+                    };
+                    readonly notes: {
+                        readonly type: "string";
+                        readonly nullable: true;
+                    };
+                    readonly is_owned_entity: {
+                        readonly type: "boolean";
+                    };
+                    readonly created_at: {
+                        readonly type: "string";
+                    };
+                    readonly updated_at: {
+                        readonly type: "string";
+                    };
+                };
+            };
+            Tag: {
+                readonly type: "object";
+                readonly properties: {
+                    readonly id: {
+                        readonly type: "string";
+                    };
+                    readonly name: {
+                        readonly type: "string";
+                    };
+                    readonly color: {
+                        readonly type: "string";
+                    };
+                    readonly description: {
+                        readonly type: "string";
+                        readonly nullable: true;
+                    };
+                    readonly created_at: {
+                        readonly type: "string";
+                    };
+                };
+            };
+            CreateContactInput: {
+                type: string;
+                properties: {
+                    first_name: {
+                        type: string;
+                    };
+                    last_name: {
+                        type: string;
+                    };
+                    display_name: {
+                        type: string;
+                    };
+                    nickname: {
+                        type: string;
+                    };
+                    company_id: {
+                        type: string;
+                    };
+                    job_title: {
+                        type: string;
+                    };
+                    notes: {
+                        type: string;
+                    };
+                    source: {
+                        type: string;
+                    };
+                    status: {
+                        type: string;
+                    };
+                    sensitivity: {
+                        type: string;
+                    };
+                };
+            };
+            UpdateContactInput: {
+                type: string;
+                properties: {
+                    first_name: {
+                        type: string;
+                    };
+                    last_name: {
+                        type: string;
+                    };
+                    display_name: {
+                        type: string;
+                    };
+                    nickname: {
+                        type: string;
+                    };
+                    company_id: {
+                        type: string;
+                    };
+                    job_title: {
+                        type: string;
+                    };
+                    notes: {
+                        type: string;
+                    };
+                    status: {
+                        type: string;
+                    };
+                };
+            };
+            CreateCompanyInput: {
+                type: string;
+                required: string[];
+                properties: {
+                    name: {
+                        type: string;
+                    };
+                    domain: {
+                        type: string;
+                    };
+                    industry: {
+                        type: string;
+                    };
+                    size: {
+                        type: string;
+                    };
+                    founded_year: {
+                        type: string;
+                    };
+                    notes: {
+                        type: string;
+                    };
+                    is_owned_entity: {
+                        type: string;
+                    };
+                };
+            };
+            UpdateCompanyInput: {
+                type: string;
+                properties: {
+                    name: {
+                        type: string;
+                    };
+                    domain: {
+                        type: string;
+                    };
+                    industry: {
+                        type: string;
+                    };
+                    notes: {
+                        type: string;
+                    };
+                };
+            };
+            CreateTagInput: {
+                type: string;
+                required: string[];
+                properties: {
+                    name: {
+                        type: string;
+                    };
+                    color: {
+                        type: string;
+                    };
+                    description: {
+                        type: string;
+                    };
+                };
+            };
+            UpdateTagInput: {
+                type: string;
+                properties: {
+                    name: {
+                        type: string;
+                    };
+                    color: {
+                        type: string;
+                    };
+                    description: {
+                        type: string;
+                    };
+                };
+            };
+            ProjectIdsInput: {
+                type: string;
+                required: string[];
+                properties: {
+                    project_ids: {
+                        type: string;
+                        items: {
+                            type: string;
+                            minLength: number;
+                        };
+                        uniqueItems: boolean;
+                    };
+                };
+            };
+            ContactProjectMembershipSnapshot: {
+                type: string;
+                required: string[];
+                properties: {
+                    contact_id: {
+                        type: string;
+                    };
+                    project_id: {
+                        type: string;
+                    };
+                    linked: {
+                        type: string;
+                    };
+                    version: {
+                        type: string;
+                    };
+                };
+            };
+            ContactProjectMembershipMutationInput: {
+                type: string;
+                required: string[];
+                properties: {
+                    operation_id: {
+                        type: string;
+                        minLength: number;
+                    };
+                    step_id: {
+                        type: string;
+                        minLength: number;
+                    };
+                    expected_version: {
+                        type: string;
+                        minLength: number;
+                    };
+                };
+            };
+            ContactProjectMembershipMutationResult: {
+                type: string;
+                required: string[];
+                properties: {
+                    outcome: {
+                        type: string;
+                        enum: string[];
+                    };
+                    operation_id: {
+                        type: string;
+                    };
+                    step_id: {
+                        type: string;
+                    };
+                    before: {
+                        $ref: string;
+                    };
+                    after: {
+                        $ref: string;
+                    };
+                    receipt_id: {
+                        type: string;
+                    };
+                };
+            };
+            ContactProjectMembershipListResult: {
+                type: string;
+                required: string[];
+                properties: {
+                    project_id: {
+                        type: string;
+                    };
+                    contact_ids: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                    };
+                    complete: {
+                        type: string;
+                        const: boolean;
+                    };
+                    membership_revision: {
+                        type: string;
+                    };
+                };
+            };
+        };
+    };
+    security: {
+        apiKey: never[];
+    }[];
+    paths: {
+        "/v1/contacts": {
+            get: {
+                operationId: string;
+                summary: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                responses: {
+                    "200": {
+                        content: {
+                            "application/json": {
+                                schema: {
+                                    type: string;
+                                    properties: Record<string, unknown>;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+            post: {
+                operationId: string;
+                summary: string;
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        "application/json": {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    "201": {
+                        content: {
+                            "application/json": {
+                                schema: {
+                                    type: string;
+                                    properties: {
+                                        contact: {
+                                            $ref: string;
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        "/v1/contacts/{id}": {
+            get: {
+                operationId: string;
+                summary: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                responses: {
+                    "200": {
+                        content: {
+                            "application/json": {
+                                schema: {
+                                    type: string;
+                                    properties: Record<string, unknown>;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+            patch: {
+                operationId: string;
+                summary: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        "application/json": {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    "200": {
+                        content: {
+                            "application/json": {
+                                schema: {
+                                    type: string;
+                                    properties: Record<string, unknown>;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+            delete: {
+                operationId: string;
+                summary: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                responses: {
+                    "200": {
+                        content: {
+                            "application/json": {
+                                schema: {
+                                    type: string;
+                                    properties: Record<string, unknown>;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        "/v1/companies": {
+            get: {
+                operationId: string;
+                summary: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                responses: {
+                    "200": {
+                        content: {
+                            "application/json": {
+                                schema: {
+                                    type: string;
+                                    properties: Record<string, unknown>;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+            post: {
+                operationId: string;
+                summary: string;
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        "application/json": {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    "201": {
+                        content: {
+                            "application/json": {
+                                schema: {
+                                    type: string;
+                                    properties: {
+                                        company: {
+                                            $ref: string;
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        "/v1/companies/{id}": {
+            get: {
+                operationId: string;
+                summary: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                responses: {
+                    "200": {
+                        content: {
+                            "application/json": {
+                                schema: {
+                                    type: string;
+                                    properties: Record<string, unknown>;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+            patch: {
+                operationId: string;
+                summary: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        "application/json": {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    "200": {
+                        content: {
+                            "application/json": {
+                                schema: {
+                                    type: string;
+                                    properties: Record<string, unknown>;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+            delete: {
+                operationId: string;
+                summary: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                responses: {
+                    "200": {
+                        content: {
+                            "application/json": {
+                                schema: {
+                                    type: string;
+                                    properties: Record<string, unknown>;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        "/v1/tags": {
+            get: {
+                operationId: string;
+                summary: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                responses: {
+                    "200": {
+                        content: {
+                            "application/json": {
+                                schema: {
+                                    type: string;
+                                    properties: Record<string, unknown>;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+            post: {
+                operationId: string;
+                summary: string;
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        "application/json": {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    "201": {
+                        content: {
+                            "application/json": {
+                                schema: {
+                                    type: string;
+                                    properties: {
+                                        tag: {
+                                            $ref: string;
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        "/v1/tags/{id}": {
+            get: {
+                operationId: string;
+                summary: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                responses: {
+                    "200": {
+                        content: {
+                            "application/json": {
+                                schema: {
+                                    type: string;
+                                    properties: Record<string, unknown>;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+            patch: {
+                operationId: string;
+                summary: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        "application/json": {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    "200": {
+                        content: {
+                            "application/json": {
+                                schema: {
+                                    type: string;
+                                    properties: Record<string, unknown>;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+            delete: {
+                operationId: string;
+                summary: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                responses: {
+                    "200": {
+                        content: {
+                            "application/json": {
+                                schema: {
+                                    type: string;
+                                    properties: Record<string, unknown>;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        "/v1/contacts/{contact_id}/tags/{tag_id}": {
+            put: {
+                operationId: string;
+                summary: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                responses: {
+                    "200": {
+                        content: {
+                            "application/json": {
+                                schema: {
+                                    type: string;
+                                    properties: Record<string, unknown>;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+            delete: {
+                operationId: string;
+                summary: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                responses: {
+                    "200": {
+                        content: {
+                            "application/json": {
+                                schema: {
+                                    type: string;
+                                    properties: Record<string, unknown>;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        "/v1/contacts/{contact_id}/projects": {
+            get: {
+                operationId: string;
+                summary: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                responses: {
+                    "200": {
+                        content: {
+                            "application/json": {
+                                schema: {
+                                    type: string;
+                                    properties: Record<string, unknown>;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+            put: {
+                operationId: string;
+                summary: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        "application/json": {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    "200": {
+                        content: {
+                            "application/json": {
+                                schema: {
+                                    type: string;
+                                    properties: Record<string, unknown>;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        "/v1/contacts/{contact_id}/projects/{project_id}": {
+            put: {
+                operationId: string;
+                summary: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                responses: {
+                    "200": {
+                        content: {
+                            "application/json": {
+                                schema: {
+                                    type: string;
+                                    properties: Record<string, unknown>;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+            delete: {
+                operationId: string;
+                summary: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                responses: {
+                    "200": {
+                        content: {
+                            "application/json": {
+                                schema: {
+                                    type: string;
+                                    properties: Record<string, unknown>;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        "/v1/projects/{project_id}/contacts": {
+            get: {
+                operationId: string;
+                summary: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                responses: {
+                    "200": {
+                        content: {
+                            "application/json": {
+                                schema: {
+                                    type: string;
+                                    properties: Record<string, unknown>;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        "/v1/projects/{project_id}/contact-memberships": {
+            get: {
+                operationId: string;
+                summary: string;
+                parameters: ({
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                        minimum?: undefined;
+                    };
+                } | {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                        minimum: number;
+                    };
+                })[];
+                responses: {
+                    "200": {
+                        content: {
+                            "application/json": {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        "/v1/projects/{project_id}/contact-memberships/{contact_id}": {
+            get: {
+                operationId: string;
+                summary: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                responses: {
+                    "200": {
+                        content: {
+                            "application/json": {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        "/v1/projects/{project_id}/contact-memberships/{contact_id}/attach": {
+            post: {
+                operationId: string;
+                summary: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        "application/json": {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    "200": {
+                        content: {
+                            "application/json": {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        "/v1/projects/{project_id}/contact-memberships/{contact_id}/detach": {
+            post: {
+                operationId: string;
+                summary: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        "application/json": {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    "200": {
+                        content: {
+                            "application/json": {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        "/v1/stats": {
+            get: {
+                operationId: string;
+                summary: string;
+                responses: {
+                    "200": {
+                        content: {
+                            "application/json": {
+                                schema: {
+                                    type: string;
+                                    properties: Record<string, unknown>;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+    };
+};
+//# sourceMappingURL=openapi.d.ts.map