@sipgate/integration-bridge 1.0.36 → 1.0.40

package/dist/swagger/openapi-spec.d.ts

@@ -0,0 +1,972 @@
+export declare const openApiSpec: {
+    openapi: string;
+    info: {
+        title: string;
+        description: string;
+        version: string;
+    };
+    tags: {
+        name: string;
+        description: string;
+    }[];
+    security: {
+        providerKey: never[];
+    }[];
+    paths: {
+        '/contacts': {
+            get: {
+                tags: string[];
+                summary: string;
+                description: string;
+                responses: {
+                    '200': {
+                        description: string;
+                        headers: {
+                            'X-Fetching-State': {
+                                schema: {
+                                    type: string;
+                                    enum: string[];
+                                };
+                                description: string;
+                            };
+                            'X-Provider-Key': {
+                                schema: {
+                                    type: string;
+                                };
+                                description: string;
+                            };
+                        };
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                    items: {
+                                        $ref: string;
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+            post: {
+                tags: string[];
+                summary: string;
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    '200': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/contacts/{id}': {
+            get: {
+                tags: string[];
+                summary: string;
+                parameters: ({
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                        $ref?: undefined;
+                    };
+                    description?: undefined;
+                } | {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        $ref: string;
+                        type?: undefined;
+                    };
+                    description: string;
+                })[];
+                responses: {
+                    '200': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+            put: {
+                tags: string[];
+                summary: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    '200': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+            delete: {
+                tags: string[];
+                summary: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                responses: {
+                    '200': {
+                        description: string;
+                    };
+                };
+            };
+        };
+        '/contacts/stream': {
+            post: {
+                tags: string[];
+                summary: string;
+                description: string;
+                responses: {
+                    '200': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                    properties: {
+                                        timestamp: {
+                                            type: string;
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/contacts/{id}/entities': {
+            get: {
+                tags: string[];
+                summary: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                    };
+                    description: string;
+                }[];
+                responses: {
+                    '200': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                    items: {
+                                        $ref: string;
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/entity/{type}/{id}': {
+            get: {
+                tags: string[];
+                summary: string;
+                parameters: ({
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        $ref: string;
+                        type?: undefined;
+                    };
+                } | {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                        $ref?: undefined;
+                    };
+                })[];
+                responses: {
+                    '200': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/events/calls': {
+            post: {
+                tags: string[];
+                summary: string;
+                deprecated: boolean;
+                description: string;
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    '200': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/events/calls/{id}': {
+            put: {
+                tags: string[];
+                summary: string;
+                deprecated: boolean;
+                description: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    '200': {
+                        description: string;
+                    };
+                };
+            };
+        };
+        '/events/connected': {
+            post: {
+                tags: string[];
+                summary: string;
+                description: string;
+                responses: {
+                    '200': {
+                        description: string;
+                    };
+                };
+            };
+        };
+        '/events/disconnected': {
+            post: {
+                tags: string[];
+                summary: string;
+                description: string;
+                responses: {
+                    '200': {
+                        description: string;
+                    };
+                };
+            };
+        };
+        '/call-log': {
+            put: {
+                tags: string[];
+                summary: string;
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    '200': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                    items: {
+                                        $ref: string;
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/call-log/phoneNumber': {
+            put: {
+                tags: string[];
+                summary: string;
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    '200': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    nullable: boolean;
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/call-log-metadata': {
+            get: {
+                tags: string[];
+                summary: string;
+                responses: {
+                    '200': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/health': {
+            get: {
+                tags: string[];
+                summary: string;
+                description: string;
+                security: never[];
+                responses: {
+                    '200': {
+                        description: string;
+                    };
+                };
+            };
+        };
+        '/validate-token': {
+            get: {
+                tags: string[];
+                summary: string;
+                responses: {
+                    '200': {
+                        description: string;
+                        content: {
+                            'text/plain': {
+                                schema: {
+                                    type: string;
+                                    example: string;
+                                };
+                            };
+                        };
+                    };
+                    '401': {
+                        description: string;
+                    };
+                };
+            };
+        };
+        '/oauth2/redirect': {
+            get: {
+                tags: string[];
+                summary: string;
+                description: string;
+                security: never[];
+                responses: {
+                    '200': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                    properties: {
+                                        redirectUrl: {
+                                            type: string;
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/oauth2/callback': {
+            get: {
+                tags: string[];
+                summary: string;
+                description: string;
+                security: never[];
+                parameters: {
+                    name: string;
+                    in: string;
+                    schema: {
+                        type: string;
+                    };
+                    description: string;
+                }[];
+                responses: {
+                    '302': {
+                        description: string;
+                    };
+                };
+            };
+        };
+        '/oauth2/token': {
+            get: {
+                tags: string[];
+                summary: string;
+                description: string;
+                security: never[];
+                parameters: {
+                    name: string;
+                    in: string;
+                    schema: {
+                        type: string;
+                    };
+                    description: string;
+                }[];
+                responses: {
+                    '200': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                    properties: {
+                                        apiKey: {
+                                            type: string;
+                                        };
+                                        apiUrl: {
+                                            type: string;
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/account/id': {
+            get: {
+                tags: string[];
+                summary: string;
+                responses: {
+                    '200': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/webhook': {
+            post: {
+                tags: string[];
+                summary: string;
+                description: string;
+                security: never[];
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    '200': {
+                        description: string;
+                    };
+                    '403': {
+                        description: string;
+                    };
+                };
+            };
+        };
+        '/tasks/{id}': {
+            get: {
+                tags: string[];
+                summary: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                responses: {
+                    '200': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/tasks': {
+            post: {
+                tags: string[];
+                summary: string;
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    '200': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                    properties: {
+                                        followUpId: {
+                                            type: string;
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/task-metadata': {
+            get: {
+                tags: string[];
+                summary: string;
+                responses: {
+                    '200': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+    };
+    components: {
+        securitySchemes: {
+            providerKey: {
+                type: string;
+                in: string;
+                name: string;
+                description: string;
+            };
+        };
+        schemas: {
+            PhoneNumberLabel: {
+                type: string;
+                enum: string[];
+            };
+            PhoneNumber: {
+                type: string;
+                required: string[];
+                properties: {
+                    label: {
+                        type: string;
+                        description: string;
+                    };
+                    phoneNumber: {
+                        type: string;
+                        example: string;
+                    };
+                };
+            };
+            ContactScope: {
+                type: string;
+                enum: string[];
+            };
+            IntegrationEntityType: {
+                type: string;
+                enum: string[];
+            };
+            ContactTemplate: {
+                type: string;
+                required: string[];
+                properties: {
+                    name: {
+                        type: string;
+                        nullable: boolean;
+                    };
+                    firstName: {
+                        type: string;
+                        nullable: boolean;
+                    };
+                    lastName: {
+                        type: string;
+                        nullable: boolean;
+                    };
+                    email: {
+                        type: string;
+                        nullable: boolean;
+                    };
+                    organization: {
+                        type: string;
+                        nullable: boolean;
+                    };
+                    phoneNumbers: {
+                        type: string;
+                        items: {
+                            $ref: string;
+                        };
+                    };
+                    type: {
+                        $ref: string;
+                    };
+                    scope: {
+                        $ref: string;
+                    };
+                };
+            };
+            Contact: {
+                allOf: ({
+                    $ref: string;
+                    type?: undefined;
+                    required?: undefined;
+                    properties?: undefined;
+                } | {
+                    type: string;
+                    required: string[];
+                    properties: {
+                        id: {
+                            type: string;
+                        };
+                        contactUrl: {
+                            type: string;
+                            nullable: boolean;
+                        };
+                        avatarUrl: {
+                            type: string;
+                            nullable: boolean;
+                        };
+                        readonly: {
+                            type: string;
+                        };
+                        relatesTo: {
+                            type: string;
+                            items: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                    $ref?: undefined;
+                })[];
+            };
+            IntegrationEntity: {
+                type: string;
+                required: string[];
+                properties: {
+                    id: {
+                        type: string;
+                    };
+                    type: {
+                        $ref: string;
+                    };
+                    source: {
+                        type: string;
+                    };
+                };
+            };
+            LabeledIntegrationEntity: {
+                allOf: ({
+                    $ref: string;
+                    type?: undefined;
+                    required?: undefined;
+                    properties?: undefined;
+                } | {
+                    type: string;
+                    required: string[];
+                    properties: {
+                        label: {
+                            type: string;
+                        };
+                    };
+                    $ref?: undefined;
+                })[];
+            };
+            LoggedIntegrationEntity: {
+                allOf: ({
+                    $ref: string;
+                    type?: undefined;
+                    required?: undefined;
+                    properties?: undefined;
+                } | {
+                    type: string;
+                    required: string[];
+                    properties: {
+                        logId: {
+                            type: string;
+                        };
+                    };
+                    $ref?: undefined;
+                })[];
+            };
+            CallDirection: {
+                type: string;
+                enum: string[];
+            };
+            CallParticipantType: {
+                type: string;
+                enum: string[];
+            };
+            CallState: {
+                type: string;
+                enum: string[];
+            };
+            CallParticipant: {
+                type: string;
+                required: string[];
+                properties: {
+                    type: {
+                        $ref: string;
+                    };
+                    phoneNumber: {
+                        type: string;
+                    };
+                };
+            };
+            CallEvent: {
+                type: string;
+                required: string[];
+                properties: {
+                    id: {
+                        type: string;
+                    };
+                    startTime: {
+                        type: string;
+                    };
+                    endTime: {
+                        type: string;
+                    };
+                    direction: {
+                        $ref: string;
+                    };
+                    participants: {
+                        type: string;
+                        items: {
+                            $ref: string;
+                        };
+                    };
+                    note: {
+                        type: string;
+                    };
+                    state: {
+                        $ref: string;
+                    };
+                    outcome: {
+                        type: string;
+                    };
+                };
+            };
+            CallEventWithIntegrationEntities: {
+                allOf: ({
+                    $ref: string;
+                    type?: undefined;
+                    required?: undefined;
+                    properties?: undefined;
+                } | {
+                    type: string;
+                    required: string[];
+                    properties: {
+                        integrationEntities: {
+                            type: string;
+                            items: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                    $ref?: undefined;
+                })[];
+            };
+            Task: {
+                type: string;
+                required: string[];
+                properties: {
+                    id: {
+                        type: string;
+                    };
+                    content: {
+                        type: string;
+                    };
+                    createdAt: {
+                        type: string;
+                    };
+                    dueAt: {
+                        type: string;
+                    };
+                    title: {
+                        type: string;
+                    };
+                    type: {
+                        type: string;
+                    };
+                    link: {
+                        type: string;
+                    };
+                };
+            };
+            FollowUpWithIntegrationEntities: {
+                type: string;
+                required: string[];
+                properties: {
+                    content: {
+                        type: string;
+                    };
+                    dueAt: {
+                        type: string;
+                    };
+                    title: {
+                        type: string;
+                    };
+                    type: {
+                        type: string;
+                    };
+                    integrationEntities: {
+                        type: string;
+                        items: {
+                            $ref: string;
+                        };
+                    };
+                };
+            };
+            IntegrationDefinedOptions: {
+                type: string;
+                required: string[];
+                properties: {
+                    label: {
+                        type: string;
+                    };
+                    type: {
+                        type: string;
+                    };
+                    options: {
+                        type: string;
+                        items: {
+                            type: string;
+                            required: string[];
+                            properties: {
+                                label: {
+                                    type: string;
+                                };
+                                key: {
+                                    type: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+    };
+};