Skip to content

Commit

Permalink
Automated update to repo's documentation and third party notices from…
Browse files Browse the repository at this point in the history
… github action
  • Loading branch information
github-actions[bot] committed Sep 10, 2024
1 parent ecd46e3 commit 32913a5
Show file tree
Hide file tree
Showing 12 changed files with 49 additions and 51 deletions.
14 changes: 7 additions & 7 deletions packages/chat-core-aws-connect/THIRD-PARTY-NOTICES
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ The following NPM packages may be included in this product:
- @types/istanbul-lib-report@3.0.3
- @types/istanbul-reports@3.0.4
- @types/jsdom@20.0.1
- @types/node@22.5.0
- @types/node@22.5.4
- @types/stack-utils@2.0.3
- @types/tough-cookie@4.0.5
- @types/yargs-parser@21.0.3
Expand Down Expand Up @@ -321,7 +321,7 @@ THE SOFTWARE.

The following NPM package may be included in this product:

- acorn-walk@8.3.3
- acorn-walk@8.3.4

This package contains the following license and notice below:

Expand Down Expand Up @@ -1024,7 +1024,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI

The following NPM package may be included in this product:

- debug@4.3.6
- debug@4.3.7

This package contains the following license and notice below:

Expand Down Expand Up @@ -1803,13 +1803,13 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

The following NPM package may be included in this product:

- ms@2.1.2
- ms@2.1.3

This package contains the following license and notice below:

The MIT License (MIT)

Copyright (c) 2016 Zeit, Inc.
Copyright (c) 2020 Vercel, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down Expand Up @@ -1922,13 +1922,13 @@ THE SOFTWARE.

The following NPM package may be included in this product:

- picocolors@1.0.1
- picocolors@1.1.0

This package contains the following license and notice below:

ISC License

Copyright (c) 2021 Alexey Raspopov, Kostiantyn Denysov, Anton Verinov
Copyright (c) 2021-2024 Oleksii Raspopov, Kostiantyn Denysov, Anton Verinov

Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
Expand Down
4 changes: 2 additions & 2 deletions packages/chat-core/docs/chat-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
| Enumeration | Description |
| --- | --- |
| [Environment](./chat-core.environment.md) | Defines the environment of the API domains. |
| [MessageSource\_2](./chat-core.messagesource_2.md) | Types of sender of a message. |
| [MessageSource](./chat-core.messagesource.md) | Types of sender of a message. |
| [Region](./chat-core.region.md) | The region to send the requests to. |
| [StreamEventName](./chat-core.streameventname.md) | Names of stream events returned from Chat Stream API. |

Expand All @@ -37,7 +37,7 @@
| [EndEvent](./chat-core.endevent.md) | An event that indicates end of Chat stream. |
| [Endpoints](./chat-core.endpoints.md) | The URLs which are used when making requests to the Chat API. |
| [IntegrationDetails](./chat-core.integrationdetails.md) | Integration details for the current conversation. |
| [Message\_2](./chat-core.message_2.md) | Represents a message within a conversation. |
| [Message](./chat-core.message.md) | Represents a message within a conversation. |
| [MessageNotes](./chat-core.messagenotes.md) | Information relevant to the current state of the conversation, serving as the bot’s "memory" regarding what work it previously did to help determine future actions. |
| [MessageRequest](./chat-core.messagerequest.md) | A request to Chat API. |
| [MessageResponse](./chat-core.messageresponse.md) | A response from Chat API. |
Expand Down
23 changes: 23 additions & 0 deletions packages/chat-core/docs/chat-core.message.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/chat-core](./chat-core.md) &gt; [Message](./chat-core.message.md)

## Message interface

Represents a message within a conversation.

**Signature:**

```typescript
export interface Message
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [responseId?](./chat-core.message.responseid.md) | | string | _(Optional)_ The response's id in the form of a 26 character ULID. This is present for message coming from server. |
| [source](./chat-core.message.source.md) | | [EnumOrLiteral](./chat-core.enumorliteral.md)<!-- -->&lt;[MessageSource](./chat-core.messagesource.md)<!-- -->&gt; | The sender of the message. |
| [text](./chat-core.message.text.md) | | string | The message's content. |
| [timestamp?](./chat-core.message.timestamp.md) | | string | _(Optional)_ Time when the message is sent. |

Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/chat-core](./chat-core.md) &gt; [Message\_2](./chat-core.message_2.md) &gt; [responseId](./chat-core.message_2.responseid.md)
[Home](./index.md) &gt; [@yext/chat-core](./chat-core.md) &gt; [Message](./chat-core.message.md) &gt; [responseId](./chat-core.message.responseid.md)

## Message\_2.responseId property
## Message.responseId property

The response's id in the form of a 26 character ULID. This is present for message coming from server.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/chat-core](./chat-core.md) &gt; [Message\_2](./chat-core.message_2.md) &gt; [source](./chat-core.message_2.source.md)
[Home](./index.md) &gt; [@yext/chat-core](./chat-core.md) &gt; [Message](./chat-core.message.md) &gt; [source](./chat-core.message.source.md)

## Message\_2.source property
## Message.source property

The sender of the message.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/chat-core](./chat-core.md) &gt; [Message\_2](./chat-core.message_2.md) &gt; [text](./chat-core.message_2.text.md)
[Home](./index.md) &gt; [@yext/chat-core](./chat-core.md) &gt; [Message](./chat-core.message.md) &gt; [text](./chat-core.message.text.md)

## Message\_2.text property
## Message.text property

The message's content.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/chat-core](./chat-core.md) &gt; [Message\_2](./chat-core.message_2.md) &gt; [timestamp](./chat-core.message_2.timestamp.md)
[Home](./index.md) &gt; [@yext/chat-core](./chat-core.md) &gt; [Message](./chat-core.message.md) &gt; [timestamp](./chat-core.message.timestamp.md)

## Message\_2.timestamp property
## Message.timestamp property

Time when the message is sent.

Expand Down
23 changes: 0 additions & 23 deletions packages/chat-core/docs/chat-core.message_2.md

This file was deleted.

2 changes: 1 addition & 1 deletion packages/chat-core/docs/chat-core.messagerequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@ export interface MessageRequest
| --- | --- | --- | --- |
| [context?](./chat-core.messagerequest.context.md) | | any | _(Optional)_ Additional information to pass into the instruction flow. This data could then be used in the URL or body of a REST API step, influence Chat API's assessment in a conditional step, or help construct a reply with additional details. |
| [conversationId?](./chat-core.messagerequest.conversationid.md) | | string | _(Optional)_ The id corresponds to the current conversation. This is generated by the server on the first message of the conversation and returned in [MessageResponse](./chat-core.messageresponse.md)<!-- -->. |
| [messages](./chat-core.messagerequest.messages.md) | | [Message](./chat-core.message_2.md)<!-- -->\[\] | The messages of the current conversation. |
| [messages](./chat-core.messagerequest.messages.md) | | [Message](./chat-core.message.md)<!-- -->\[\] | The messages of the current conversation. |
| [notes?](./chat-core.messagerequest.notes.md) | | [MessageNotes](./chat-core.messagenotes.md) | _(Optional)_ Information relevant to the current state of the conversation, serving as the bots "memory" regarding what work it previously did to help determine future actions. |

2 changes: 1 addition & 1 deletion packages/chat-core/docs/chat-core.messageresponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@ export interface MessageResponse
| --- | --- | --- | --- |
| [conversationId?](./chat-core.messageresponse.conversationid.md) | | string | _(Optional)_ The id corresponds to the current conversation. |
| [integrationDetails?](./chat-core.messageresponse.integrationdetails.md) | | [IntegrationDetails](./chat-core.integrationdetails.md) | _(Optional)_ Integration details for the current conversation. |
| [message](./chat-core.messageresponse.message.md) | | [Message](./chat-core.message_2.md) | The generated reply to the latest message in the request. |
| [message](./chat-core.messageresponse.message.md) | | [Message](./chat-core.message.md) | The generated reply to the latest message in the request. |
| [notes](./chat-core.messageresponse.notes.md) | | [MessageNotes](./chat-core.messagenotes.md) | Information relevant to the current state of the conversation, serving as the bots "memory" regarding what work it previously did to help determine future actions. |

Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/chat-core](./chat-core.md) &gt; [MessageSource\_2](./chat-core.messagesource_2.md)
[Home](./index.md) &gt; [@yext/chat-core](./chat-core.md) &gt; [MessageSource](./chat-core.messagesource.md)

## MessageSource\_2 enum
## MessageSource enum

Types of sender of a message.

Expand Down
12 changes: 5 additions & 7 deletions packages/chat-core/etc/chat-core.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,13 +88,12 @@ export interface InternalConfig {
}

// @public
interface Message_2 {
export interface Message {
responseId?: string;
source: EnumOrLiteral<MessageSource_2>;
source: EnumOrLiteral<MessageSource>;
text: string;
timestamp?: string;
}
export { Message_2 as Message }

// @public
export interface MessageNotes {
Expand All @@ -112,25 +111,24 @@ export interface MessageNotes {
export interface MessageRequest {
context?: any;
conversationId?: string;
messages: Message_2[];
messages: Message[];
notes?: MessageNotes;
}

// @public
export interface MessageResponse {
conversationId?: string;
integrationDetails?: IntegrationDetails;
message: Message_2;
message: Message;
notes: MessageNotes;
}

// @public
enum MessageSource_2 {
export enum MessageSource {
AGENT = "AGENT",
BOT = "BOT",
USER = "USER"
}
export { MessageSource_2 as MessageSource }

// @public
export function provideChatCore(config: ChatConfig): ChatCore;
Expand Down

0 comments on commit 32913a5

Please sign in to comment.