neuland-hub-sdk 1.0.3

package/docs/Sharepoint.md

@@ -0,0 +1,402 @@
+# Sharepoint
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**integrationsGetItemInfo**](#integrationsgetiteminfo) | **GET** /integrations/sharepoint/drives/{drive_id}/items/{drive_item_id} | Get a drive item|
+|[**integrationsGetUserInfo**](#integrationsgetuserinfo) | **GET** /integrations/sharepoint/me | Get current SharePoint user|
+|[**integrationsIsConnected**](#integrationsisconnected) | **GET** /integrations/sharepoint/connected | Check SharePoint connection|
+|[**integrationsListAllSites**](#integrationslistallsites) | **GET** /integrations/sharepoint/sites | List SharePoint sites|
+|[**integrationsListChildren**](#integrationslistchildren) | **GET** /integrations/sharepoint/drives/{drive_id}/items/{drive_item_id}/children | List children of a drive item|
+|[**integrationsListDrives**](#integrationslistdrives) | **GET** /integrations/sharepoint/sites/{site_id}/drives | List drives in a site|
+
+# **integrationsGetItemInfo**
+> SharepointItemModel integrationsGetItemInfo()
+
+Get a single SharePoint drive item, annotated with imported counts.
+
+### Example
+
+```typescript
+import {
+    Sharepoint,
+    Configuration
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new Sharepoint(configuration);
+
+let driveId: string; //Id of the drive. (default to undefined)
+let driveItemId: string; //Id of the drive item. (default to undefined)
+let chatId: string; //Scope imported counts to this chat. (optional) (default to undefined)
+let libraryId: string; //Scope imported counts to this library. (optional) (default to undefined)
+let assistantId: string; //Scope imported counts to this assistant. (optional) (default to undefined)
+let projectId: string; //Scope imported counts to this project. (optional) (default to undefined)
+let cookieName: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.integrationsGetItemInfo(
+    driveId,
+    driveItemId,
+    chatId,
+    libraryId,
+    assistantId,
+    projectId,
+    cookieName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **driveId** | [**string**] | Id of the drive. | defaults to undefined|
+| **driveItemId** | [**string**] | Id of the drive item. | defaults to undefined|
+| **chatId** | [**string**] | Scope imported counts to this chat. | (optional) defaults to undefined|
+| **libraryId** | [**string**] | Scope imported counts to this library. | (optional) defaults to undefined|
+| **assistantId** | [**string**] | Scope imported counts to this assistant. | (optional) defaults to undefined|
+| **projectId** | [**string**] | Scope imported counts to this project. | (optional) defaults to undefined|
+| **cookieName** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**SharepointItemModel**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**401** | Missing or invalid authentication, or no valid connector token. |  -  |
+|**403** | User has not consented to the required SharePoint scope. |  -  |
+|**422** | Validation Error |  -  |
+
+[[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)
+
+# **integrationsGetUserInfo**
+> SharepointUserModel integrationsGetUserInfo()
+
+Return the signed-in user\'s SharePoint / Microsoft Graph profile.
+
+### Example
+
+```typescript
+import {
+    Sharepoint,
+    Configuration
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new Sharepoint(configuration);
+
+let cookieName: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.integrationsGetUserInfo(
+    cookieName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **cookieName** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**SharepointUserModel**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**401** | Missing or invalid authentication, or no valid connector token. |  -  |
+|**403** | User has not consented to the required SharePoint scope. |  -  |
+|**422** | Validation Error |  -  |
+
+[[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)
+
+# **integrationsIsConnected**
+> boolean integrationsIsConnected()
+
+Report whether the user has consented to the SharePoint file-read scope.
+
+### Example
+
+```typescript
+import {
+    Sharepoint,
+    Configuration
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new Sharepoint(configuration);
+
+let cookieName: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.integrationsIsConnected(
+    cookieName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **cookieName** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**boolean**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**401** | Missing or invalid authentication. |  -  |
+|**422** | Validation Error |  -  |
+
+[[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)
+
+# **integrationsListAllSites**
+> Array<SharepointSiteModel> integrationsListAllSites()
+
+List the SharePoint sites the user can access, with imported document counts.
+
+### Example
+
+```typescript
+import {
+    Sharepoint,
+    Configuration
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new Sharepoint(configuration);
+
+let chatId: string; //Scope imported counts to this chat. (optional) (default to undefined)
+let libraryId: string; //Scope imported counts to this library. (optional) (default to undefined)
+let assistantId: string; //Scope imported counts to this assistant. (optional) (default to undefined)
+let projectId: string; //Scope imported counts to this project. (optional) (default to undefined)
+let cookieName: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.integrationsListAllSites(
+    chatId,
+    libraryId,
+    assistantId,
+    projectId,
+    cookieName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **chatId** | [**string**] | Scope imported counts to this chat. | (optional) defaults to undefined|
+| **libraryId** | [**string**] | Scope imported counts to this library. | (optional) defaults to undefined|
+| **assistantId** | [**string**] | Scope imported counts to this assistant. | (optional) defaults to undefined|
+| **projectId** | [**string**] | Scope imported counts to this project. | (optional) defaults to undefined|
+| **cookieName** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<SharepointSiteModel>**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**401** | Missing or invalid authentication, or no valid connector token. |  -  |
+|**403** | User has not consented to the required SharePoint scope. |  -  |
+|**422** | Validation Error |  -  |
+
+[[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)
+
+# **integrationsListChildren**
+> Array<SharepointItemModel> integrationsListChildren()
+
+List files and folders under a drive item, annotated with imported counts.
+
+### Example
+
+```typescript
+import {
+    Sharepoint,
+    Configuration
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new Sharepoint(configuration);
+
+let driveId: string; //Id of the drive. (default to undefined)
+let driveItemId: string; //Id of the parent item; empty or \'root\' for the drive root. (default to undefined)
+let chatId: string; //Scope imported counts to this chat. (optional) (default to undefined)
+let libraryId: string; //Scope imported counts to this library. (optional) (default to undefined)
+let assistantId: string; //Scope imported counts to this assistant. (optional) (default to undefined)
+let projectId: string; //Scope imported counts to this project. (optional) (default to undefined)
+let recursive: boolean; //Recurse into subfolders, returning only files. (optional) (default to false)
+let cookieName: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.integrationsListChildren(
+    driveId,
+    driveItemId,
+    chatId,
+    libraryId,
+    assistantId,
+    projectId,
+    recursive,
+    cookieName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **driveId** | [**string**] | Id of the drive. | defaults to undefined|
+| **driveItemId** | [**string**] | Id of the parent item; empty or \&#39;root\&#39; for the drive root. | defaults to undefined|
+| **chatId** | [**string**] | Scope imported counts to this chat. | (optional) defaults to undefined|
+| **libraryId** | [**string**] | Scope imported counts to this library. | (optional) defaults to undefined|
+| **assistantId** | [**string**] | Scope imported counts to this assistant. | (optional) defaults to undefined|
+| **projectId** | [**string**] | Scope imported counts to this project. | (optional) defaults to undefined|
+| **recursive** | [**boolean**] | Recurse into subfolders, returning only files. | (optional) defaults to false|
+| **cookieName** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<SharepointItemModel>**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**401** | Missing or invalid authentication, or no valid connector token. |  -  |
+|**403** | User has not consented to the required SharePoint scope. |  -  |
+|**422** | Validation Error |  -  |
+
+[[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)
+
+# **integrationsListDrives**
+> Array<SharepointDriveModel> integrationsListDrives()
+
+List the document libraries (drives) within a SharePoint site.
+
+### Example
+
+```typescript
+import {
+    Sharepoint,
+    Configuration
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new Sharepoint(configuration);
+
+let siteId: string; //SharePoint site id. (default to undefined)
+let chatId: string; //Scope imported counts to this chat. (optional) (default to undefined)
+let libraryId: string; //Scope imported counts to this library. (optional) (default to undefined)
+let assistantId: string; //Scope imported counts to this assistant. (optional) (default to undefined)
+let projectId: string; //Scope imported counts to this project. (optional) (default to undefined)
+let cookieName: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.integrationsListDrives(
+    siteId,
+    chatId,
+    libraryId,
+    assistantId,
+    projectId,
+    cookieName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **siteId** | [**string**] | SharePoint site id. | defaults to undefined|
+| **chatId** | [**string**] | Scope imported counts to this chat. | (optional) defaults to undefined|
+| **libraryId** | [**string**] | Scope imported counts to this library. | (optional) defaults to undefined|
+| **assistantId** | [**string**] | Scope imported counts to this assistant. | (optional) defaults to undefined|
+| **projectId** | [**string**] | Scope imported counts to this project. | (optional) defaults to undefined|
+| **cookieName** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<SharepointDriveModel>**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**401** | Missing or invalid authentication, or no valid connector token. |  -  |
+|**403** | User has not consented to the required SharePoint scope. |  -  |
+|**422** | Validation Error |  -  |
+
+[[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)
+

package/docs/SharepointDriveModel.md

@@ -0,0 +1,31 @@
+# SharepointDriveModel
+
+A document library (drive) within a SharePoint site.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Drive id. | [default to undefined]
+**web_url** | **string** | URL to open the drive in SharePoint. | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**root** | [**SharepointItemModel**](SharepointItemModel.md) | The drive\'s root folder item. | [default to undefined]
+**imported_count** | **number** | Number of imported documents from this drive in the current scope. | [optional] [default to 0]
+
+## Example
+
+```typescript
+import { SharepointDriveModel } from 'neuland-hub-sdk';
+
+const instance: SharepointDriveModel = {
+    id,
+    web_url,
+    name,
+    description,
+    root,
+    imported_count,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SharepointFolderModel.md

@@ -0,0 +1,21 @@
+# SharepointFolderModel
+
+Metadata specific to folder items.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**child_count** | **number** | Number of immediate children inside the folder. | [default to undefined]
+
+## Example
+
+```typescript
+import { SharepointFolderModel } from 'neuland-hub-sdk';
+
+const instance: SharepointFolderModel = {
+    child_count,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SharepointItemModel.md

@@ -0,0 +1,47 @@
+# SharepointItemModel
+
+A file or folder item in a SharePoint drive.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Drive item id. | [default to undefined]
+**web_url** | **string** | URL to open the item in SharePoint. | [default to undefined]
+**drive_id** | **string** | Id of the drive containing the item. | [default to undefined]
+**site_id** | **string** |  | [default to undefined]
+**parent_folder_id** | **string** | Id of the parent folder, or \'root\'. | [default to undefined]
+**parent_path** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**size** | **number** |  | [default to undefined]
+**last_modified_date_time** | **string** |  | [default to undefined]
+**mimetype** | **string** |  | [default to undefined]
+**folder** | [**SharepointFolderModel**](SharepointFolderModel.md) |  | [default to undefined]
+**imported** | **boolean** |  | [optional] [default to undefined]
+**imported_count** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SharepointItemModel } from 'neuland-hub-sdk';
+
+const instance: SharepointItemModel = {
+    id,
+    web_url,
+    drive_id,
+    site_id,
+    parent_folder_id,
+    parent_path,
+    name,
+    description,
+    size,
+    last_modified_date_time,
+    mimetype,
+    folder,
+    imported,
+    imported_count,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SharepointSiteModel.md

@@ -0,0 +1,31 @@
+# SharepointSiteModel
+
+A SharePoint site.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Site id. | [default to undefined]
+**web_url** | **string** | URL to open the site in SharePoint. | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**display_name** | **string** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**imported_count** | **number** | Number of imported documents from this site in the current scope. | [optional] [default to 0]
+
+## Example
+
+```typescript
+import { SharepointSiteModel } from 'neuland-hub-sdk';
+
+const instance: SharepointSiteModel = {
+    id,
+    web_url,
+    name,
+    display_name,
+    description,
+    imported_count,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SharepointUserModel.md

@@ -0,0 +1,29 @@
+# SharepointUserModel
+
+The signed-in user\'s SharePoint / Microsoft Graph profile.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**display_name** | **string** |  | [default to undefined]
+**job_title** | **string** |  | [default to undefined]
+**mail** | **string** |  | [default to undefined]
+**surname** | **string** |  | [default to undefined]
+**user_principal_name** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SharepointUserModel } from 'neuland-hub-sdk';
+
+const instance: SharepointUserModel = {
+    display_name,
+    job_title,
+    mail,
+    surname,
+    user_principal_name,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)