@empathyco/x-components 6.0.0-alpha.3 → 6.0.0-alpha.31

package/report/x-adapter-platform.api.json

@@ -1840,6 +1840,56 @@
                 "endIndex": 7
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-adapter-platform!PlatformAdapter#relatedPrompts:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "relatedPrompts: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ExtendableEndpointAdapter",
+                  "canonicalReference": "@empathyco/x-adapter!ExtendableEndpointAdapter:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "RelatedPromptsRequest",
+                  "canonicalReference": "@empathyco/x-adapter-platform!RelatedPromptsRequest:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "RelatedPromptsResponse",
+                  "canonicalReference": "@empathyco/x-adapter-platform!RelatedPromptsResponse:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ">"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "relatedPrompts",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 7
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@empathyco/x-adapter-platform!PlatformAdapter#relatedTags:member",
@@ -3650,6 +3700,230 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@empathyco/x-adapter-platform!PlatformRelatedPrompt:interface",
+          "docComment": "/**\n * Related prompt model for the `platform` API.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface PlatformRelatedPrompt "
+            }
+          ],
+          "fileUrlPath": "dist/types/types/models/related-prompt.model.d.ts",
+          "releaseTag": "Public",
+          "name": "PlatformRelatedPrompt",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-adapter-platform!PlatformRelatedPrompt#nextQueries:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "nextQueries: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "nextQueries",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-adapter-platform!PlatformRelatedPrompt#suggestionText:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "suggestionText: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "suggestionText",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-adapter-platform!PlatformRelatedPrompt#type:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "type: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "'SYNTHETIC' | 'CURATED'"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "type",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@empathyco/x-adapter-platform!PlatformRelatedPromptsRequest:interface",
+          "docComment": "/**\n * Request for the `related prompts` endpoint with `extra params`.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface PlatformRelatedPromptsRequest extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "PlatformQueryableRequest",
+              "canonicalReference": "@empathyco/x-adapter-platform!~PlatformQueryableRequest:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", "
+            },
+            {
+              "kind": "Reference",
+              "text": "PlatformExtraParamsRequest",
+              "canonicalReference": "@empathyco/x-adapter-platform!~PlatformExtraParamsRequest:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "fileUrlPath": "dist/types/types/requests/related-prompts-request.model.d.ts",
+          "releaseTag": "Public",
+          "name": "PlatformRelatedPromptsRequest",
+          "preserveMemberOrder": false,
+          "members": [],
+          "extendsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 2
+            },
+            {
+              "startIndex": 3,
+              "endIndex": 4
+            }
+          ]
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@empathyco/x-adapter-platform!PlatformRelatedPromptsResponse:interface",
+          "docComment": "/**\n * Response for the `related prompts` endpoint.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface PlatformRelatedPromptsResponse "
+            }
+          ],
+          "fileUrlPath": "dist/types/types/responses/related-prompts-response.model.d.ts",
+          "releaseTag": "Public",
+          "name": "PlatformRelatedPromptsResponse",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-adapter-platform!PlatformRelatedPromptsResponse#data:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "data: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n        relatedprompts: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "PlatformRelatedPrompt",
+                  "canonicalReference": "@empathyco/x-adapter-platform!PlatformRelatedPrompt:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[];\n    }"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "data",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 4
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-adapter-platform!PlatformRelatedPromptsResponse#status:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "status: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "status",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
         {
           "kind": "Interface",
           "canonicalReference": "@empathyco/x-adapter-platform!PlatformRelatedTag:interface",
@@ -4294,7 +4568,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "[];\n        tagging: {\n            query: string;\n            display: string;\n        };\n    }"
+                  "text": "[];\n        tagging: {\n            query: string;\n            display: string;\n        };\n        stats: {\n            price: {\n                min: number;\n                max: number;\n            };\n        };\n    }"
                 },
                 {
                   "kind": "Content",
@@ -5618,6 +5892,306 @@
             "endIndex": 8
           }
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@empathyco/x-adapter-platform!relatedPromptSchema:var",
+          "docComment": "/**\n * Default implementation for the RelatedPromptSchema.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "relatedPromptSchema: "
+            },
+            {
+              "kind": "Content",
+              "text": "import(\"@empathyco/x-adapter\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "MutableSchema",
+              "canonicalReference": "@empathyco/x-adapter!MutableSchema:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "PlatformRelatedPrompt",
+              "canonicalReference": "@empathyco/x-adapter-platform!PlatformRelatedPrompt:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", "
+            },
+            {
+              "kind": "Reference",
+              "text": "RelatedPrompt",
+              "canonicalReference": "@empathyco/x-adapter-platform!RelatedPrompt:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            }
+          ],
+          "fileUrlPath": "dist/types/schemas/models/related-prompt.schema.d.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "relatedPromptSchema",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 8
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@empathyco/x-adapter-platform!relatedPromptsEndpointAdapter:var",
+          "docComment": "/**\n * Default adapter for the related prompt endpoint. This endpoint does not support pagination in the request.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "relatedPromptsEndpointAdapter: "
+            },
+            {
+              "kind": "Content",
+              "text": "import(\"@empathyco/x-adapter\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "ExtendableEndpointAdapter",
+              "canonicalReference": "@empathyco/x-adapter!ExtendableEndpointAdapter:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "RelatedPromptsRequest",
+              "canonicalReference": "@empathyco/x-adapter-platform!RelatedPromptsRequest:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", "
+            },
+            {
+              "kind": "Reference",
+              "text": "RelatedPromptsResponse",
+              "canonicalReference": "@empathyco/x-adapter-platform!RelatedPromptsResponse:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            }
+          ],
+          "fileUrlPath": "dist/types/endpoint-adapters/related-prompts.endpoint-adapter.d.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "relatedPromptsEndpointAdapter",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 8
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@empathyco/x-adapter-platform!relatedPromptsRequestMapper:var",
+          "docComment": "/**\n * Default implementation for the RelatedPromptsRequestMapper.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "relatedPromptsRequestMapper: "
+            },
+            {
+              "kind": "Content",
+              "text": "import(\"@empathyco/x-adapter\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "Mapper",
+              "canonicalReference": "@empathyco/x-adapter!Mapper:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "RelatedPromptsRequest",
+              "canonicalReference": "@empathyco/x-adapter-platform!RelatedPromptsRequest:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", "
+            },
+            {
+              "kind": "Reference",
+              "text": "PlatformRelatedPromptsRequest",
+              "canonicalReference": "@empathyco/x-adapter-platform!PlatformRelatedPromptsRequest:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            }
+          ],
+          "fileUrlPath": "dist/types/mappers/requests/related-prompts-request.mapper.d.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "relatedPromptsRequestMapper",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 8
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@empathyco/x-adapter-platform!relatedPromptsRequestSchema:var",
+          "docComment": "/**\n * Default implementation for the RelatedPromptsRequestSchema.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "relatedPromptsRequestSchema: "
+            },
+            {
+              "kind": "Content",
+              "text": "import(\"@empathyco/x-adapter\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "MutableSchema",
+              "canonicalReference": "@empathyco/x-adapter!MutableSchema:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "RelatedPromptsRequest",
+              "canonicalReference": "@empathyco/x-adapter-platform!RelatedPromptsRequest:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", "
+            },
+            {
+              "kind": "Reference",
+              "text": "PlatformRelatedPromptsRequest",
+              "canonicalReference": "@empathyco/x-adapter-platform!PlatformRelatedPromptsRequest:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            }
+          ],
+          "fileUrlPath": "dist/types/schemas/requests/related-prompts-request.schema.d.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "relatedPromptsRequestSchema",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 8
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@empathyco/x-adapter-platform!relatedPromptsResponseMapper:var",
+          "docComment": "/**\n * Default implementation for the RelatedPromptsResponseMapper.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "relatedPromptsResponseMapper: "
+            },
+            {
+              "kind": "Content",
+              "text": "import(\"@empathyco/x-adapter\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "Mapper",
+              "canonicalReference": "@empathyco/x-adapter!Mapper:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "PlatformRelatedPromptsResponse",
+              "canonicalReference": "@empathyco/x-adapter-platform!PlatformRelatedPromptsResponse:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", "
+            },
+            {
+              "kind": "Reference",
+              "text": "RelatedPromptsResponse",
+              "canonicalReference": "@empathyco/x-adapter-platform!RelatedPromptsResponse:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            }
+          ],
+          "fileUrlPath": "dist/types/mappers/responses/related-prompts-response.mapper.d.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "relatedPromptsResponseMapper",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 8
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@empathyco/x-adapter-platform!relatedPromptsResponseSchema:var",
+          "docComment": "/**\n * Default implementation for the RelatedPromptsResponseSchema.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "relatedPromptsResponseSchema: "
+            },
+            {
+              "kind": "Content",
+              "text": "import(\"@empathyco/x-adapter\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "MutableSchema",
+              "canonicalReference": "@empathyco/x-adapter!MutableSchema:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "PlatformRelatedPromptsResponse",
+              "canonicalReference": "@empathyco/x-adapter-platform!PlatformRelatedPromptsResponse:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", "
+            },
+            {
+              "kind": "Reference",
+              "text": "RelatedPromptsResponse",
+              "canonicalReference": "@empathyco/x-adapter-platform!RelatedPromptsResponse:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            }
+          ],
+          "fileUrlPath": "dist/types/schemas/responses/related-prompts-response.schema.d.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "relatedPromptsResponseSchema",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 8
+          }
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@empathyco/x-adapter-platform!relatedTagSchema:var",