@crestal/nation-sdk 0.1.20 → 0.1.22

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.
@@ -0,0 +1,63 @@
1
+ # UserApi
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**getUserAgents**](#getuseragents) | **GET** /user/agents | Get User Agents|
8
+
9
+ # **getUserAgents**
10
+ > AgentListResponse getUserAgents()
11
+
12
+ Get all agents owned by the authenticated user. **Query Parameters:** * `cursor` - Cursor for pagination * `limit` - Maximum number of agents to return (1-100) **Returns:** * `AgentListResponse` - Paginated list of user\'s agents with their quota information and additional processed data
13
+
14
+ ### Example
15
+
16
+ ```typescript
17
+ import {
18
+ UserApi,
19
+ Configuration
20
+ } from '@crestal/nation-sdk';
21
+
22
+ const configuration = new Configuration();
23
+ const apiInstance = new UserApi(configuration);
24
+
25
+ let cursor: string; //Cursor for pagination (optional) (default to undefined)
26
+ let limit: number; //Maximum number of agents to return (optional) (default to 20)
27
+
28
+ const { status, data } = await apiInstance.getUserAgents(
29
+ cursor,
30
+ limit
31
+ );
32
+ ```
33
+
34
+ ### Parameters
35
+
36
+ |Name | Type | Description | Notes|
37
+ |------------- | ------------- | ------------- | -------------|
38
+ | **cursor** | [**string**] | Cursor for pagination | (optional) defaults to undefined|
39
+ | **limit** | [**number**] | Maximum number of agents to return | (optional) defaults to 20|
40
+
41
+
42
+ ### Return type
43
+
44
+ **AgentListResponse**
45
+
46
+ ### Authorization
47
+
48
+ [HTTPBearer](../README.md#HTTPBearer)
49
+
50
+ ### HTTP request headers
51
+
52
+ - **Content-Type**: Not defined
53
+ - **Accept**: application/json
54
+
55
+
56
+ ### HTTP response details
57
+ | Status code | Description | Response headers |
58
+ |-------------|-------------|------------------|
59
+ |**200** | Successful Response | - |
60
+ |**422** | Validation Error | - |
61
+
62
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
63
+
package/index.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Nation IntentKit API
5
5
  * API for Nation IntentKit services
6
6
  *
7
- * The version of the OpenAPI document: 0.1.20
7
+ * The version of the OpenAPI document: 0.1.22
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@crestal/nation-sdk",
3
- "version": "0.1.20",
3
+ "version": "0.1.22",
4
4
  "description": "OpenAPI client for @crestal/nation-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {