@empathyco/x-components 6.0.0-alpha.6 → 6.0.0-alpha.8

package/docs/API-reference/api/x-adapter-platform.md

@@ -39,6 +39,9 @@
 |  [PlatformRecommendationsRequest](./x-adapter-platform.platformrecommendationsrequest.md) | Request for <code>recommendations</code> endpoint with <code>extra params</code>. |
 |  [PlatformRecommendationsResponse](./x-adapter-platform.platformrecommendationsresponse.md) | Response for the <code>recommendations</code> endpoint. |
 |  [PlatformRedirection](./x-adapter-platform.platformredirection.md) | Redirection model for the <code>platform</code> API. |
+|  [PlatformRelatedPrompt](./x-adapter-platform.platformrelatedprompt.md) | Related prompt model for the <code>platform</code> API. |
+|  [PlatformRelatedPromptsRequest](./x-adapter-platform.platformrelatedpromptsrequest.md) | Request for the <code>related prompts</code> endpoint with <code>extra params</code>. |
+|  [PlatformRelatedPromptsResponse](./x-adapter-platform.platformrelatedpromptsresponse.md) | Response for the <code>related prompts</code> endpoint. |
 |  [PlatformRelatedTag](./x-adapter-platform.platformrelatedtag.md) | Related tag model for the <code>platform</code> API. |
 |  [PlatformRelatedTagsRequest](./x-adapter-platform.platformrelatedtagsrequest.md) | Request for the <code>related tags</code> endpoint with <code>extra params</code>. |
 |  [PlatformRelatedTagsResponse](./x-adapter-platform.platformrelatedtagsresponse.md) | Response for the <code>related tags</code> endpoint. |
@@ -94,6 +97,12 @@
 |  [recommendationsResponseMapper](./x-adapter-platform.recommendationsresponsemapper.md) | Default implementation for the RecommendationsResponseMapper. |
 |  [recommendationsResponseSchema](./x-adapter-platform.recommendationsresponseschema.md) | Default implementation for the RecommendationsResponseSchema. |
 |  [redirectionSchema](./x-adapter-platform.redirectionschema.md) | Default implementation for the RedirectionSchema. |
+|  [relatedPromptSchema](./x-adapter-platform.relatedpromptschema.md) | Default implementation for the RelatedPromptSchema. |
+|  [relatedPromptsEndpointAdapter](./x-adapter-platform.relatedpromptsendpointadapter.md) | Default adapter for the related prompt endpoint. This endpoint does not support pagination in the request. |
+|  [relatedPromptsRequestMapper](./x-adapter-platform.relatedpromptsrequestmapper.md) | Default implementation for the RelatedPromptsRequestMapper. |
+|  [relatedPromptsRequestSchema](./x-adapter-platform.relatedpromptsrequestschema.md) | Default implementation for the RelatedPromptsRequestSchema. |
+|  [relatedPromptsResponseMapper](./x-adapter-platform.relatedpromptsresponsemapper.md) | Default implementation for the RelatedPromptsResponseMapper. |
+|  [relatedPromptsResponseSchema](./x-adapter-platform.relatedpromptsresponseschema.md) | Default implementation for the RelatedPromptsResponseSchema. |
 |  [relatedTagSchema](./x-adapter-platform.relatedtagschema.md) | Default implementation for the RelatedTagSchema. |
 |  [relatedTagsEndpointAdapter](./x-adapter-platform.relatedtagsendpointadapter.md) | This endpoint does not support pagination in the request. |
 |  [relatedTagsRequestMapper](./x-adapter-platform.relatedtagsrequestmapper.md) | Default implementation for the RelatedTagsRequestMapper. |

package/docs/API-reference/api/x-adapter-platform.platformadapter.relatedprompts.md

@@ -7,5 +7,5 @@
 **Signature:**
 
 ```typescript
-relatedPrompts: any;
+relatedPrompts: ExtendableEndpointAdapter<RelatedPromptsRequest, RelatedPromptsResponse>;
 ```

package/docs/API-reference/api/x-adapter-platform.platformrelatedprompt.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformRelatedPrompt](./x-adapter-platform.platformrelatedprompt.md)
+
+## PlatformRelatedPrompt interface
+
+Related prompt model for the `platform` API.
+
+**Signature:**
+
+```typescript
+export interface PlatformRelatedPrompt 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [nextQueries](./x-adapter-platform.platformrelatedprompt.nextqueries.md) |  | string\[\] |  |
+|  [suggestionText](./x-adapter-platform.platformrelatedprompt.suggestiontext.md) |  | string |  |
+|  [type](./x-adapter-platform.platformrelatedprompt.type.md) |  | 'SYNTHETIC' \| 'CURATED' |  |
+

package/docs/API-reference/api/x-adapter-platform.platformrelatedprompt.nextqueries.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformRelatedPrompt](./x-adapter-platform.platformrelatedprompt.md) &gt; [nextQueries](./x-adapter-platform.platformrelatedprompt.nextqueries.md)
+
+## PlatformRelatedPrompt.nextQueries property
+
+**Signature:**
+
+```typescript
+nextQueries: string[];
+```

package/docs/API-reference/api/x-adapter-platform.platformrelatedprompt.suggestiontext.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformRelatedPrompt](./x-adapter-platform.platformrelatedprompt.md) &gt; [suggestionText](./x-adapter-platform.platformrelatedprompt.suggestiontext.md)
+
+## PlatformRelatedPrompt.suggestionText property
+
+**Signature:**
+
+```typescript
+suggestionText: string;
+```

package/docs/API-reference/api/x-adapter-platform.platformrelatedprompt.type.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformRelatedPrompt](./x-adapter-platform.platformrelatedprompt.md) &gt; [type](./x-adapter-platform.platformrelatedprompt.type.md)
+
+## PlatformRelatedPrompt.type property
+
+**Signature:**
+
+```typescript
+type: 'SYNTHETIC' | 'CURATED';
+```

package/docs/API-reference/api/x-adapter-platform.platformrelatedpromptsrequest.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformRelatedPromptsRequest](./x-adapter-platform.platformrelatedpromptsrequest.md)
+
+## PlatformRelatedPromptsRequest interface
+
+Request for the `related prompts` endpoint with `extra params`<!-- -->.
+
+**Signature:**
+
+```typescript
+export interface PlatformRelatedPromptsRequest extends PlatformQueryableRequest, PlatformExtraParamsRequest 
+```
+**Extends:** PlatformQueryableRequest, PlatformExtraParamsRequest
+

package/docs/API-reference/api/x-adapter-platform.platformrelatedpromptsresponse.data.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformRelatedPromptsResponse](./x-adapter-platform.platformrelatedpromptsresponse.md) &gt; [data](./x-adapter-platform.platformrelatedpromptsresponse.data.md)
+
+## PlatformRelatedPromptsResponse.data property
+
+**Signature:**
+
+```typescript
+data: {
+        relatedprompts: PlatformRelatedPrompt[];
+    };
+```

package/docs/API-reference/api/x-adapter-platform.platformrelatedpromptsresponse.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformRelatedPromptsResponse](./x-adapter-platform.platformrelatedpromptsresponse.md)
+
+## PlatformRelatedPromptsResponse interface
+
+Response for the `related prompts` endpoint.
+
+**Signature:**
+
+```typescript
+export interface PlatformRelatedPromptsResponse 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [data](./x-adapter-platform.platformrelatedpromptsresponse.data.md) |  | { relatedprompts: [PlatformRelatedPrompt](./x-adapter-platform.platformrelatedprompt.md)<!-- -->\[\]; } |  |
+|  [status](./x-adapter-platform.platformrelatedpromptsresponse.status.md) |  | number |  |
+

package/docs/API-reference/api/x-adapter-platform.platformrelatedpromptsresponse.status.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformRelatedPromptsResponse](./x-adapter-platform.platformrelatedpromptsresponse.md) &gt; [status](./x-adapter-platform.platformrelatedpromptsresponse.status.md)
+
+## PlatformRelatedPromptsResponse.status property
+
+**Signature:**
+
+```typescript
+status: number;
+```

package/docs/API-reference/api/x-adapter-platform.relatedpromptschema.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [relatedPromptSchema](./x-adapter-platform.relatedpromptschema.md)
+
+## relatedPromptSchema variable
+
+Default implementation for the RelatedPromptSchema.
+
+**Signature:**
+
+```typescript
+relatedPromptSchema: import("@empathyco/x-adapter").MutableSchema<PlatformRelatedPrompt, RelatedPrompt>
+```

package/docs/API-reference/api/x-adapter-platform.relatedpromptsendpointadapter.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [relatedPromptsEndpointAdapter](./x-adapter-platform.relatedpromptsendpointadapter.md)
+
+## relatedPromptsEndpointAdapter variable
+
+Default adapter for the related prompt endpoint. This endpoint does not support pagination in the request.
+
+**Signature:**
+
+```typescript
+relatedPromptsEndpointAdapter: import("@empathyco/x-adapter").ExtendableEndpointAdapter<RelatedPromptsRequest, RelatedPromptsResponse>
+```

package/docs/API-reference/api/x-adapter-platform.relatedpromptsrequestmapper.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [relatedPromptsRequestMapper](./x-adapter-platform.relatedpromptsrequestmapper.md)
+
+## relatedPromptsRequestMapper variable
+
+Default implementation for the RelatedPromptsRequestMapper.
+
+**Signature:**
+
+```typescript
+relatedPromptsRequestMapper: import("@empathyco/x-adapter").Mapper<RelatedPromptsRequest, PlatformRelatedPromptsRequest>
+```

package/docs/API-reference/api/x-adapter-platform.relatedpromptsrequestschema.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [relatedPromptsRequestSchema](./x-adapter-platform.relatedpromptsrequestschema.md)
+
+## relatedPromptsRequestSchema variable
+
+Default implementation for the RelatedPromptsRequestSchema.
+
+**Signature:**
+
+```typescript
+relatedPromptsRequestSchema: import("@empathyco/x-adapter").MutableSchema<RelatedPromptsRequest, PlatformRelatedPromptsRequest>
+```

package/docs/API-reference/api/x-adapter-platform.relatedpromptsresponsemapper.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [relatedPromptsResponseMapper](./x-adapter-platform.relatedpromptsresponsemapper.md)
+
+## relatedPromptsResponseMapper variable
+
+Default implementation for the RelatedPromptsResponseMapper.
+
+**Signature:**
+
+```typescript
+relatedPromptsResponseMapper: import("@empathyco/x-adapter").Mapper<PlatformRelatedPromptsResponse, RelatedPromptsResponse>
+```

package/docs/API-reference/api/x-adapter-platform.relatedpromptsresponseschema.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [relatedPromptsResponseSchema](./x-adapter-platform.relatedpromptsresponseschema.md)
+
+## relatedPromptsResponseSchema variable
+
+Default implementation for the RelatedPromptsResponseSchema.
+
+**Signature:**
+
+```typescript
+relatedPromptsResponseSchema: import("@empathyco/x-adapter").MutableSchema<PlatformRelatedPromptsResponse, RelatedPromptsResponse>
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empathyco/x-components",
-  "version": "6.0.0-alpha.6",
+  "version": "6.0.0-alpha.8",
   "description": "Empathy X Components",
   "author": "Empathy Systems Corporation S.L.",
   "license": "Apache-2.0",
@@ -70,7 +70,7 @@
   },
   "dependencies": {
     "@empathyco/x-adapter": "^8.1.0-alpha.0",
-    "@empathyco/x-adapter-platform": "^1.1.0-alpha.4",
+    "@empathyco/x-adapter-platform": "^1.1.0-alpha.6",
     "@empathyco/x-bus": "^1.0.3-alpha.1",
     "@empathyco/x-deep-merge": "^2.0.3-alpha.1",
     "@empathyco/x-logger": "^1.2.0-alpha.11",
@@ -137,5 +137,5 @@
     "access": "public",
     "directory": "dist"
   },
-  "gitHead": "abc0d00d934bc6cd4052c2212d816321ab097742"
+  "gitHead": "4e0518127d797743f37cedb6bdea0e68a85402ed"
 }