@xfloor/memory-sdk-js 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +1 -0
- package/README.md +220 -0
- package/dist/ApiClient.js +701 -0
- package/dist/api/DefaultApi.js +734 -0
- package/dist/api/EditFloorApi.js +103 -0
- package/dist/api/EventApi.js +86 -0
- package/dist/api/GetFloorInformationApi.js +89 -0
- package/dist/api/GetRecentEventsApi.js +88 -0
- package/dist/api/QueryApi.js +81 -0
- package/dist/index.js +412 -0
- package/dist/model/BlockDetails.js +144 -0
- package/dist/model/ChangePassword200Response.js +113 -0
- package/dist/model/ConversationThreads200Response.js +144 -0
- package/dist/model/ConversationThreads200ResponseThreadsInner.js +140 -0
- package/dist/model/EditFloor400Response.js +114 -0
- package/dist/model/EditFloor400ResponseError.js +158 -0
- package/dist/model/Event400Response.js +114 -0
- package/dist/model/Event400ResponseError.js +155 -0
- package/dist/model/EventResponse.js +112 -0
- package/dist/model/FloorInfo.js +202 -0
- package/dist/model/GetConversations200Response.js +158 -0
- package/dist/model/GetConversations200ResponseConversationInner.js +105 -0
- package/dist/model/GetConversations200ResponseConversationInnerAssistant.js +226 -0
- package/dist/model/GetConversations200ResponseConversationInnerAssistantChoicesInner.js +139 -0
- package/dist/model/GetConversations200ResponseConversationInnerAssistantChoicesInnerAiModelDetails.js +210 -0
- package/dist/model/GetConversations200ResponseConversationInnerAssistantChoicesInnerMessage.js +126 -0
- package/dist/model/GetConversations200ResponseConversationInnerAssistantChoicesInnerPromptDetails.js +126 -0
- package/dist/model/GetConversations200ResponseConversationInnerAssistantFetchMultiplePosts.js +186 -0
- package/dist/model/GetConversations200ResponseConversationInnerAssistantFetchMultiplePostsResultsInner.js +216 -0
- package/dist/model/GetConversations200ResponseConversationInnerUser.js +170 -0
- package/dist/model/GetConversations200ResponseConversationInnerUserContext.js +168 -0
- package/dist/model/GetFloorInformation200Response.js +201 -0
- package/dist/model/GetRecentEvents200Response.js +146 -0
- package/dist/model/GetRecentEvents200ResponseItemsInner.js +217 -0
- package/dist/model/GetRecentEvents200ResponseItemsInnerAuthor.js +131 -0
- package/dist/model/GetRecentEvents400Response.js +114 -0
- package/dist/model/GetRecentEvents400ResponseError.js +154 -0
- package/dist/model/Media.js +128 -0
- package/dist/model/Model400ErrorCode.js +158 -0
- package/dist/model/PostAdd.js +173 -0
- package/dist/model/Query422Response.js +114 -0
- package/dist/model/Query422ResponseError.js +113 -0
- package/dist/model/QueryRequest.js +196 -0
- package/dist/model/QueryRequestFilters.js +159 -0
- package/dist/model/QueryResponse.js +124 -0
- package/dist/model/QueryResponseItemsInner.js +213 -0
- package/dist/model/SendSignInValidationCode200Response.js +141 -0
- package/dist/model/SendSignInValidationCode400Response.js +158 -0
- package/dist/model/SendValidationCode200Response.js +113 -0
- package/dist/model/SendValidationCodeRequest.js +128 -0
- package/dist/model/SignInWithEmail200Response.js +145 -0
- package/dist/model/SignInWithEmail200ResponseProfile.js +230 -0
- package/dist/model/SignInWithEmail200ResponseProfileAvatar.js +129 -0
- package/dist/model/SignUp200Response.js +128 -0
- package/dist/model/SignUpResponse.js +128 -0
- package/dist/model/Threads.js +140 -0
- package/dist/model/UserDetails.js +145 -0
- package/dist/model/ValidateCode400Response.js +114 -0
- package/dist/model/ValidateCode400ResponseError.js +156 -0
- package/dist/model/ValidateCode412Response.js +113 -0
- package/dist/model/ValidateCodeRequest.js +158 -0
- package/package.json +64 -0
package/LICENSE
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
MIT License
|
package/README.md
ADDED
|
@@ -0,0 +1,220 @@
|
|
|
1
|
+
# @xfloor/memory-sdk-js
|
|
2
|
+
|
|
3
|
+
XfloorMemorySdkJs - JavaScript client for @xfloor/memory-sdk-js
|
|
4
|
+
The set APIs are used to develop Floor pds which can be used as their personal assistants.
|
|
5
|
+
|
|
6
|
+
This set of APIs are divided into two parts.
|
|
7
|
+
- Memory and
|
|
8
|
+
- Registration.
|
|
9
|
+
|
|
10
|
+
The developer has two ways of using the APIs for the app development. Developer can choose to the Registration APIs for using the existing xfloor infracture or can implement custom Registration process. In the case of custom registration process, the developer is bound to provide proper authentication mechanisms and then send the user information to xlfoor.
|
|
11
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
12
|
+
|
|
13
|
+
- API version: 1.0.0
|
|
14
|
+
- Package version: 1.0.1
|
|
15
|
+
- Generator version: 7.18.0
|
|
16
|
+
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
|
|
17
|
+
For more information, please visit [https://xfloor.ai/ipomo/blog1551084548304/](https://xfloor.ai/ipomo/blog1551084548304/)
|
|
18
|
+
|
|
19
|
+
## Installation
|
|
20
|
+
|
|
21
|
+
### For [Node.js](https://nodejs.org/)
|
|
22
|
+
|
|
23
|
+
#### npm
|
|
24
|
+
|
|
25
|
+
To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
|
|
26
|
+
|
|
27
|
+
Then install it via:
|
|
28
|
+
|
|
29
|
+
```shell
|
|
30
|
+
npm install @xfloor/memory-sdk-js --save
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Finally, you need to build the module:
|
|
34
|
+
|
|
35
|
+
```shell
|
|
36
|
+
npm run build
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
##### Local development
|
|
40
|
+
|
|
41
|
+
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:
|
|
42
|
+
|
|
43
|
+
```shell
|
|
44
|
+
npm install
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:
|
|
48
|
+
|
|
49
|
+
```shell
|
|
50
|
+
npm link
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
To use the link you just defined in your project, switch to the directory you want to use your @xfloor/memory-sdk-js from, and run:
|
|
54
|
+
|
|
55
|
+
```shell
|
|
56
|
+
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Finally, you need to build the module:
|
|
60
|
+
|
|
61
|
+
```shell
|
|
62
|
+
npm run build
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
#### git
|
|
66
|
+
|
|
67
|
+
If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID
|
|
68
|
+
then install it via:
|
|
69
|
+
|
|
70
|
+
```shell
|
|
71
|
+
npm install GIT_USER_ID/GIT_REPO_ID --save
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### For browser
|
|
75
|
+
|
|
76
|
+
The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
|
|
77
|
+
the above steps with Node.js and installing browserify with `npm install -g browserify`,
|
|
78
|
+
perform the following (assuming *main.js* is your entry file):
|
|
79
|
+
|
|
80
|
+
```shell
|
|
81
|
+
browserify main.js > bundle.js
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
Then include *bundle.js* in the HTML pages.
|
|
85
|
+
|
|
86
|
+
### Webpack Configuration
|
|
87
|
+
|
|
88
|
+
Using Webpack you may encounter the following error: "Module not found: Error:
|
|
89
|
+
Cannot resolve module", most certainly you should disable AMD loader. Add/merge
|
|
90
|
+
the following section to your webpack config:
|
|
91
|
+
|
|
92
|
+
```javascript
|
|
93
|
+
module: {
|
|
94
|
+
rules: [
|
|
95
|
+
{
|
|
96
|
+
parser: {
|
|
97
|
+
amd: false
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
]
|
|
101
|
+
}
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
## Getting Started
|
|
105
|
+
|
|
106
|
+
Please follow the [installation](#installation) instruction and execute the following JS code:
|
|
107
|
+
|
|
108
|
+
```javascript
|
|
109
|
+
var XfloorMemorySdkJs = require('@xfloor/memory-sdk-js');
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
var api = new XfloorMemorySdkJs.DefaultApi()
|
|
113
|
+
var inputInfo = "inputInfo_example"; // {String}
|
|
114
|
+
var opts = {
|
|
115
|
+
'icon': "/path/to/file" // {File}
|
|
116
|
+
};
|
|
117
|
+
var callback = function(error, data, response) {
|
|
118
|
+
if (error) {
|
|
119
|
+
console.error(error);
|
|
120
|
+
} else {
|
|
121
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
122
|
+
}
|
|
123
|
+
};
|
|
124
|
+
api.apiDeveloperCreateAppPost(inputInfo, opts, callback);
|
|
125
|
+
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
## Documentation for API Endpoints
|
|
129
|
+
|
|
130
|
+
All URIs are relative to *https://appfloor.in*
|
|
131
|
+
|
|
132
|
+
Class | Method | HTTP request | Description
|
|
133
|
+
------------ | ------------- | ------------- | -------------
|
|
134
|
+
*XfloorMemorySdkJs.DefaultApi* | [**apiDeveloperCreateAppPost**](docs/DefaultApi.md#apiDeveloperCreateAppPost) | **POST** /api/developer/create/app | Create App
|
|
135
|
+
*XfloorMemorySdkJs.DefaultApi* | [**apiDeveloperModifyAppPost**](docs/DefaultApi.md#apiDeveloperModifyAppPost) | **POST** /api/developer/modify/app | Modify Floorpod App
|
|
136
|
+
*XfloorMemorySdkJs.DefaultApi* | [**changeEmail**](docs/DefaultApi.md#changeEmail) | **POST** /auth-service/change/email | Change email ID
|
|
137
|
+
*XfloorMemorySdkJs.DefaultApi* | [**changeMobileNumber**](docs/DefaultApi.md#changeMobileNumber) | **POST** /auth-service/change/mobile | Change Mobile number
|
|
138
|
+
*XfloorMemorySdkJs.DefaultApi* | [**changePassword**](docs/DefaultApi.md#changePassword) | **POST** /auth-service/change/password | Change Password
|
|
139
|
+
*XfloorMemorySdkJs.DefaultApi* | [**conversationThreads**](docs/DefaultApi.md#conversationThreads) | **GET** /agent/memory/threads | Get the conversational threads
|
|
140
|
+
*XfloorMemorySdkJs.DefaultApi* | [**getConversations**](docs/DefaultApi.md#getConversations) | **GET** /agent/memory/conversations | Conversations
|
|
141
|
+
*XfloorMemorySdkJs.DefaultApi* | [**makeFloorPrivate**](docs/DefaultApi.md#makeFloorPrivate) | **POST** /api/memory/make/floor/private | Make floor Private
|
|
142
|
+
*XfloorMemorySdkJs.DefaultApi* | [**makeFloorPublic**](docs/DefaultApi.md#makeFloorPublic) | **POST** /api/memory/make/floor/public | Make floor public
|
|
143
|
+
*XfloorMemorySdkJs.DefaultApi* | [**registerExternalUserIdentity**](docs/DefaultApi.md#registerExternalUserIdentity) | **POST** /memory/identity/external-user | External User Registration
|
|
144
|
+
*XfloorMemorySdkJs.DefaultApi* | [**renameFloor**](docs/DefaultApi.md#renameFloor) | **POST** /api/memory/change/floor/id | Rename floor
|
|
145
|
+
*XfloorMemorySdkJs.DefaultApi* | [**sendSignInValidationCode**](docs/DefaultApi.md#sendSignInValidationCode) | **POST** /auth-service/send/sign/in/validation/code | Send Sign-In Validation Code (OTP)
|
|
146
|
+
*XfloorMemorySdkJs.DefaultApi* | [**sendValidationCode**](docs/DefaultApi.md#sendValidationCode) | **POST** /auth-service/send/validation/code | Send Validation code
|
|
147
|
+
*XfloorMemorySdkJs.DefaultApi* | [**signInWithEmail**](docs/DefaultApi.md#signInWithEmail) | **POST** /auth-service/sign/in/with/email | Sign In with email ID
|
|
148
|
+
*XfloorMemorySdkJs.DefaultApi* | [**signInWithMobileNumber**](docs/DefaultApi.md#signInWithMobileNumber) | **POST** /auth-service/sign/in/with/mobile/number | Sign In with Mobile number
|
|
149
|
+
*XfloorMemorySdkJs.DefaultApi* | [**signUp**](docs/DefaultApi.md#signUp) | **POST** /auth-service/sign/up | Sign Up
|
|
150
|
+
*XfloorMemorySdkJs.DefaultApi* | [**validateCode**](docs/DefaultApi.md#validateCode) | **POST** /auth-service/validate/activation/code | Validation
|
|
151
|
+
*XfloorMemorySdkJs.EditFloorApi* | [**editFloor**](docs/EditFloorApi.md#editFloor) | **POST** /api/memory/edit/floor/{floor_id} | Edit floor
|
|
152
|
+
*XfloorMemorySdkJs.EventApi* | [**event**](docs/EventApi.md#event) | **POST** /api/memory/events | Create Event (Post Content)
|
|
153
|
+
*XfloorMemorySdkJs.GetFloorInformationApi* | [**getFloorInformation**](docs/GetFloorInformationApi.md#getFloorInformation) | **GET** /api/memory/floor/info/{floor_id} | Basic information of a floor
|
|
154
|
+
*XfloorMemorySdkJs.GetRecentEventsApi* | [**getRecentEvents**](docs/GetRecentEventsApi.md#getRecentEvents) | **GET** /api/memory/recent/events | Recent Events
|
|
155
|
+
*XfloorMemorySdkJs.QueryApi* | [**query**](docs/QueryApi.md#query) | **POST** /agent/memory/query | Query (Primary API)
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
## Documentation for Models
|
|
159
|
+
|
|
160
|
+
- [XfloorMemorySdkJs.BlockDetails](docs/BlockDetails.md)
|
|
161
|
+
- [XfloorMemorySdkJs.ChangePassword200Response](docs/ChangePassword200Response.md)
|
|
162
|
+
- [XfloorMemorySdkJs.ConversationThreads200Response](docs/ConversationThreads200Response.md)
|
|
163
|
+
- [XfloorMemorySdkJs.ConversationThreads200ResponseThreadsInner](docs/ConversationThreads200ResponseThreadsInner.md)
|
|
164
|
+
- [XfloorMemorySdkJs.EditFloor400Response](docs/EditFloor400Response.md)
|
|
165
|
+
- [XfloorMemorySdkJs.EditFloor400ResponseError](docs/EditFloor400ResponseError.md)
|
|
166
|
+
- [XfloorMemorySdkJs.Event400Response](docs/Event400Response.md)
|
|
167
|
+
- [XfloorMemorySdkJs.Event400ResponseError](docs/Event400ResponseError.md)
|
|
168
|
+
- [XfloorMemorySdkJs.EventResponse](docs/EventResponse.md)
|
|
169
|
+
- [XfloorMemorySdkJs.FloorInfo](docs/FloorInfo.md)
|
|
170
|
+
- [XfloorMemorySdkJs.GetConversations200Response](docs/GetConversations200Response.md)
|
|
171
|
+
- [XfloorMemorySdkJs.GetConversations200ResponseConversationInner](docs/GetConversations200ResponseConversationInner.md)
|
|
172
|
+
- [XfloorMemorySdkJs.GetConversations200ResponseConversationInnerAssistant](docs/GetConversations200ResponseConversationInnerAssistant.md)
|
|
173
|
+
- [XfloorMemorySdkJs.GetConversations200ResponseConversationInnerAssistantChoicesInner](docs/GetConversations200ResponseConversationInnerAssistantChoicesInner.md)
|
|
174
|
+
- [XfloorMemorySdkJs.GetConversations200ResponseConversationInnerAssistantChoicesInnerAiModelDetails](docs/GetConversations200ResponseConversationInnerAssistantChoicesInnerAiModelDetails.md)
|
|
175
|
+
- [XfloorMemorySdkJs.GetConversations200ResponseConversationInnerAssistantChoicesInnerMessage](docs/GetConversations200ResponseConversationInnerAssistantChoicesInnerMessage.md)
|
|
176
|
+
- [XfloorMemorySdkJs.GetConversations200ResponseConversationInnerAssistantChoicesInnerPromptDetails](docs/GetConversations200ResponseConversationInnerAssistantChoicesInnerPromptDetails.md)
|
|
177
|
+
- [XfloorMemorySdkJs.GetConversations200ResponseConversationInnerAssistantFetchMultiplePosts](docs/GetConversations200ResponseConversationInnerAssistantFetchMultiplePosts.md)
|
|
178
|
+
- [XfloorMemorySdkJs.GetConversations200ResponseConversationInnerAssistantFetchMultiplePostsResultsInner](docs/GetConversations200ResponseConversationInnerAssistantFetchMultiplePostsResultsInner.md)
|
|
179
|
+
- [XfloorMemorySdkJs.GetConversations200ResponseConversationInnerUser](docs/GetConversations200ResponseConversationInnerUser.md)
|
|
180
|
+
- [XfloorMemorySdkJs.GetConversations200ResponseConversationInnerUserContext](docs/GetConversations200ResponseConversationInnerUserContext.md)
|
|
181
|
+
- [XfloorMemorySdkJs.GetFloorInformation200Response](docs/GetFloorInformation200Response.md)
|
|
182
|
+
- [XfloorMemorySdkJs.GetRecentEvents200Response](docs/GetRecentEvents200Response.md)
|
|
183
|
+
- [XfloorMemorySdkJs.GetRecentEvents200ResponseItemsInner](docs/GetRecentEvents200ResponseItemsInner.md)
|
|
184
|
+
- [XfloorMemorySdkJs.GetRecentEvents200ResponseItemsInnerAuthor](docs/GetRecentEvents200ResponseItemsInnerAuthor.md)
|
|
185
|
+
- [XfloorMemorySdkJs.GetRecentEvents400Response](docs/GetRecentEvents400Response.md)
|
|
186
|
+
- [XfloorMemorySdkJs.GetRecentEvents400ResponseError](docs/GetRecentEvents400ResponseError.md)
|
|
187
|
+
- [XfloorMemorySdkJs.Media](docs/Media.md)
|
|
188
|
+
- [XfloorMemorySdkJs.Model400ErrorCode](docs/Model400ErrorCode.md)
|
|
189
|
+
- [XfloorMemorySdkJs.PostAdd](docs/PostAdd.md)
|
|
190
|
+
- [XfloorMemorySdkJs.Query422Response](docs/Query422Response.md)
|
|
191
|
+
- [XfloorMemorySdkJs.Query422ResponseError](docs/Query422ResponseError.md)
|
|
192
|
+
- [XfloorMemorySdkJs.QueryRequest](docs/QueryRequest.md)
|
|
193
|
+
- [XfloorMemorySdkJs.QueryRequestFilters](docs/QueryRequestFilters.md)
|
|
194
|
+
- [XfloorMemorySdkJs.QueryResponse](docs/QueryResponse.md)
|
|
195
|
+
- [XfloorMemorySdkJs.QueryResponseItemsInner](docs/QueryResponseItemsInner.md)
|
|
196
|
+
- [XfloorMemorySdkJs.SendSignInValidationCode200Response](docs/SendSignInValidationCode200Response.md)
|
|
197
|
+
- [XfloorMemorySdkJs.SendSignInValidationCode400Response](docs/SendSignInValidationCode400Response.md)
|
|
198
|
+
- [XfloorMemorySdkJs.SendValidationCode200Response](docs/SendValidationCode200Response.md)
|
|
199
|
+
- [XfloorMemorySdkJs.SendValidationCodeRequest](docs/SendValidationCodeRequest.md)
|
|
200
|
+
- [XfloorMemorySdkJs.SignInWithEmail200Response](docs/SignInWithEmail200Response.md)
|
|
201
|
+
- [XfloorMemorySdkJs.SignInWithEmail200ResponseProfile](docs/SignInWithEmail200ResponseProfile.md)
|
|
202
|
+
- [XfloorMemorySdkJs.SignInWithEmail200ResponseProfileAvatar](docs/SignInWithEmail200ResponseProfileAvatar.md)
|
|
203
|
+
- [XfloorMemorySdkJs.SignUp200Response](docs/SignUp200Response.md)
|
|
204
|
+
- [XfloorMemorySdkJs.SignUpResponse](docs/SignUpResponse.md)
|
|
205
|
+
- [XfloorMemorySdkJs.Threads](docs/Threads.md)
|
|
206
|
+
- [XfloorMemorySdkJs.UserDetails](docs/UserDetails.md)
|
|
207
|
+
- [XfloorMemorySdkJs.ValidateCode400Response](docs/ValidateCode400Response.md)
|
|
208
|
+
- [XfloorMemorySdkJs.ValidateCode400ResponseError](docs/ValidateCode400ResponseError.md)
|
|
209
|
+
- [XfloorMemorySdkJs.ValidateCode412Response](docs/ValidateCode412Response.md)
|
|
210
|
+
- [XfloorMemorySdkJs.ValidateCodeRequest](docs/ValidateCodeRequest.md)
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
## Documentation for Authorization
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
Authentication schemes defined for the API:
|
|
217
|
+
### bearer
|
|
218
|
+
|
|
219
|
+
- **Type**: Bearer authentication
|
|
220
|
+
|