Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion README_Auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,5 @@ Class | Method | HTTP request | Description

This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: `5.3`
- API version: `6.0`
- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`
2 changes: 1 addition & 1 deletion README_Base.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,5 +63,5 @@ Class | Method | HTTP request | Description

This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: `5.3`
- API version: `6.0`
- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`
2 changes: 1 addition & 1 deletion README_File.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,5 @@ Class | Method | HTTP request | Description

This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: `5.3`
- API version: `6.0`
- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`
3 changes: 2 additions & 1 deletion README_SysAdmin.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ Class | Method | HTTP request | Description
*LogsApi* | [**listAuditLogs**](docs/SysAdmin/Api/LogsApi.md#listauditlogs) | **GET** /api/v2.1/admin/audit-logs/ | List Audit Logs
*LogsApi* | [**listEmailLogs**](docs/SysAdmin/Api/LogsApi.md#listemaillogs) | **GET** /api/v2.1/admin/email-sending-logs/ | List Email Logs
*LogsApi* | [**listFileAccessLogs**](docs/SysAdmin/Api/LogsApi.md#listfileaccesslogs) | **GET** /api/v2.1/admin/file-access-logs/ | List File Access Logs
*LogsApi* | [**listGroupMemberAuditLogs**](docs/SysAdmin/Api/LogsApi.md#listgroupmemberauditlogs) | **GET** /api/v2.1/admin/group-member-audit/ | List Group Member Audit Logs
*LogsApi* | [**listLoginLogs**](docs/SysAdmin/Api/LogsApi.md#listloginlogs) | **GET** /api/v2.1/admin/logs/login-logs/ | List Login Logs
*LogsApi* | [**listRegistrationLogs**](docs/SysAdmin/Api/LogsApi.md#listregistrationlogs) | **GET** /api/v2.1/admin/registration-logs/ | List Registration Logs
*LogsApi* | [**listVirusFiles**](docs/SysAdmin/Api/LogsApi.md#listvirusfiles) | **GET** /api/v2.1/admin/virus-files/ | List Virus Files
Expand Down Expand Up @@ -106,5 +107,5 @@ Class | Method | HTTP request | Description

This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: `5.3`
- API version: `6.0`
- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`
10 changes: 7 additions & 3 deletions README_TeamAmin.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,17 @@
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ActivitiesLogsApi* | [**listFileAccessLogs**](docs/TeamAdmin/Api/ActivitiesLogsApi.md#listfileaccesslogs) | **GET** /api/v2.1/org/{org_id}/admin/file-access-logs/ | List File Access Logs
*ActivitiesLogsApi* | [**listGroupMemberAuditLogs**](docs/TeamAdmin/Api/ActivitiesLogsApi.md#listgroupmemberauditlogs) | **GET** /api/v2.1/org/{org_id}/admin/group-member-audit/ | List Group Member Audit Logs
*ActivitiesLogsApi* | [**listTeamLogins**](docs/TeamAdmin/Api/ActivitiesLogsApi.md#listteamlogins) | **GET** /api/v2.1/org/{org_id}/admin/login-logs/ | List Team Logins
*ActivitiesLogsApi* | [**listTeamOperationLog**](docs/TeamAdmin/Api/ActivitiesLogsApi.md#listteamoperationlog) | **GET** /api/v2.1/org/{org_id}/admin/admin-logs/ | List Team Operations
*ActivitiesLogsApi* | [**listUserLogins**](docs/TeamAdmin/Api/ActivitiesLogsApi.md#listuserlogins) | **GET** /api/v2.1/org/{org_id}/admin/login-logs/{user_id}/ | List User Logins
*BasesApi* | [**clearTeamTrashBin**](docs/TeamAdmin/Api/BasesApi.md#clearteamtrashbin) | **DELETE** /api/v2.1/org/{org_id}/admin/trash-dtables/ | Clear Team Trash Bin
*BasesApi* | [**deleteBase**](docs/TeamAdmin/Api/BasesApi.md#deletebase) | **DELETE** /api/v2.1/org/{org_id}/admin/dtables/{base_id}/ | Delete Base
*BasesApi* | [**deleteBase**](docs/TeamAdmin/Api/BasesApi.md#deletebase) | **DELETE** /api/v2.1/org/{org_id}/admin/dtables/{base_uuid}/ | Delete Base
*BasesApi* | [**getBase**](docs/TeamAdmin/Api/BasesApi.md#getbase) | **GET** /api/v2.1/org/{org_id}/admin/dtables/{base_uuid}/ | Get Base
*BasesApi* | [**listBaseSharings**](docs/TeamAdmin/Api/BasesApi.md#listbasesharings) | **GET** /api/v2.1/org/{org_id}/admin/dtables/{base_uuid}/shares/ | List Base Sharings
*BasesApi* | [**listBases**](docs/TeamAdmin/Api/BasesApi.md#listbases) | **GET** /api/v2.1/org/{org_id}/admin/dtables/ | List Bases (Team)
*BasesApi* | [**listTrashBases**](docs/TeamAdmin/Api/BasesApi.md#listtrashbases) | **GET** /api/v2.1/org/{org_id}/admin/trash-dtables/ | List Trash Bases
*BasesApi* | [**restoreBaseFromTrash**](docs/TeamAdmin/Api/BasesApi.md#restorebasefromtrash) | **PUT** /api/v2.1/org/{org_id}/admin/trash-dtables/{base_id}/ | Restore Base from Trash
*BasesApi* | [**restoreBaseFromTrash**](docs/TeamAdmin/Api/BasesApi.md#restorebasefromtrash) | **PUT** /api/v2.1/org/{org_id}/admin/trash-dtables/{base_uuid}/ | Restore Base from Trash
*BasesApi* | [**searchBase**](docs/TeamAdmin/Api/BasesApi.md#searchbase) | **GET** /api/v2.1/org/{org_id}/admin/search-dtables/ | Search Base
*CustomizingApi* | [**deleteTeamLogo**](docs/TeamAdmin/Api/CustomizingApi.md#deleteteamlogo) | **DELETE** /api/v2.1/org/{org_id}/admin/org-logo/ | Delete Team Logo
*CustomizingApi* | [**getTeamLogo**](docs/TeamAdmin/Api/CustomizingApi.md#getteamlogo) | **GET** /api/v2.1/org/{org_id}/admin/org-logo/ | Get Team Logo
Expand All @@ -33,6 +35,7 @@ Class | Method | HTTP request | Description
*InfoSettingsApi* | [**getTeamSettings**](docs/TeamAdmin/Api/InfoSettingsApi.md#getteamsettings) | **GET** /api/v2.1/org/admin/settings/ | Get Team Settings
*InfoSettingsApi* | [**updateTeam**](docs/TeamAdmin/Api/InfoSettingsApi.md#updateteam) | **PUT** /api/v2.1/org/admin/info/ | Update Team
*InfoSettingsApi* | [**updateTeamSettings**](docs/TeamAdmin/Api/InfoSettingsApi.md#updateteamsettings) | **PUT** /api/v2.1/org/admin/settings/ | Update Team Settings
*SAMLApi* | [**deleteSamlConfig**](docs/TeamAdmin/Api/SAMLApi.md#deletesamlconfig) | **DELETE** /api/v2.1/org/{org_id}/admin/saml-config/ | Delete SAML Config
*SAMLApi* | [**getSamlConfig**](docs/TeamAdmin/Api/SAMLApi.md#getsamlconfig) | **GET** /api/v2.1/org/{org_id}/admin/saml-config/ | Get SAML Config
*SAMLApi* | [**updateSamlConfig**](docs/TeamAdmin/Api/SAMLApi.md#updatesamlconfig) | **PUT** /api/v2.1/org/{org_id}/admin/saml-config/ | Update SAML Config
*SAMLApi* | [**verifySamlDomain**](docs/TeamAdmin/Api/SAMLApi.md#verifysamldomain) | **PUT** /api/v2.1/org/{org_id}/admin/verify-domain/ | Verify SAML domain
Expand All @@ -47,6 +50,7 @@ Class | Method | HTTP request | Description
*UsersApi* | [**deleteUser**](docs/TeamAdmin/Api/UsersApi.md#deleteuser) | **DELETE** /api/v2.1/org/{org_id}/admin/users/{user_id}/ | Delete User
*UsersApi* | [**disableTwoFactor**](docs/TeamAdmin/Api/UsersApi.md#disabletwofactor) | **DELETE** /api/v2.1/org/{org_id}/admin/users/{user_id}/two-factor-auth/ | Disable 2FA
*UsersApi* | [**enforceTwofactor**](docs/TeamAdmin/Api/UsersApi.md#enforcetwofactor) | **PUT** /api/v2.1/org/{org_id}/admin/users/{user_id}/two-factor-auth/ | Enforce 2FA
*UsersApi* | [**getUser**](docs/TeamAdmin/Api/UsersApi.md#getuser) | **GET** /api/v2.1/org/{org_id}/admin/users/{user_id}/ | Get User
*UsersApi* | [**listTeamUsers**](docs/TeamAdmin/Api/UsersApi.md#listteamusers) | **GET** /api/v2.1/org/{org_id}/admin/users/ | List Users (Team)
*UsersApi* | [**resetUserPassword**](docs/TeamAdmin/Api/UsersApi.md#resetuserpassword) | **PUT** /api/v2.1/org/{org_id}/admin/users/{user_id}/set-password/ | Reset User Password
*UsersApi* | [**updateUser**](docs/TeamAdmin/Api/UsersApi.md#updateuser) | **PUT** /api/v2.1/org/{org_id}/admin/users/{user_id}/ | Update User
Expand All @@ -56,5 +60,5 @@ Class | Method | HTTP request | Description

This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: `5.3`
- API version: `6.0`
- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`
2 changes: 1 addition & 1 deletion README_User.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,5 +151,5 @@ Class | Method | HTTP request | Description

This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: `5.3`
- API version: `6.0`
- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`
2 changes: 1 addition & 1 deletion docs/Base/Api/BigDataApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ moveRowsToBigData($base_uuid, $archive_view): object

Move Rows to Big Data Backend

Use an sql-like where clause to select the rows that should be moved into the big data backend. Big data backend has to be activated in this base.
Select a view to move its rows to the big data backend. Note that the big data backend must be enabled in this base.

### Example

Expand Down
2 changes: 1 addition & 1 deletion docs/Base/Model/ArchiveView.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**table_name** | **string** | The name of the table to perform the operation on. Alternatively, you can use the `table_id` instead of `table_name`. If using `table_id`, ensure that the key in the request body is replaced accordingly. |
**where** | **string** | Use an sql-like clause to select the rows you want to archive. If not set, all rows in the table will be archived. More examples are: <br/> \\`Name\\` = 'Michael' <br/> \\`Gender\\` != 'Michael' <br/> \\`Name of the column\\` ilike '%error%' | [optional]
**view_name** | **string** | The name of the view to perform the operation on. Alternatively, you can use the `view_id` instead of `view_name`. If using `view_id`, ensure that the key in the request body is replaced accordingly. **Example:** Instead of `view_name: Default View` you an use `view_id: 0000`. |

2 changes: 1 addition & 1 deletion docs/Base/Model/UpdateView.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | The new name of the view, if you want to give the view a new name. | [optional]
**name** | **string** | The name of the view to perform the operation on. Alternatively, you can use the `view_id` instead of `view_name`. If using `view_id`, ensure that the key in the request body is replaced accordingly. **Example:** Instead of `view_name: Default View` you an use `view_id: 0000`. | [optional]
**is_locked** | **bool** | | [optional]
**filters** | [**\SeaTable\Client\Base\UpdateViewFiltersInner[]**](UpdateViewFiltersInner.md) | filter of your view | [optional]
**filter_conjunction** | [**\SeaTable\Client\Base\FilterConjunction**](FilterConjunction.md) | | [optional]
Expand Down
4 changes: 2 additions & 2 deletions docs/File/Api/FilesImagesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ getUploadLink(): object

Get Upload Link

With the **API token** (not the Base Token), you can generate an upload link, the parent- and the relative path. These information are needed to upload a file / an image to a bases. Then this file/image can be attached to a file/image column. > 📘 The upload link is only valid for a short time > > The upload link is only valid for some minutes. After that the upload link must be created again.
Generate an upload link, including the parent- and the relative path. These values are needed in order to [upload a file / an image](https://api.seatable.com/reference/uploadfile) to a base. Afterwards, this file/image can be attached to a file/image column. Please note that this endpoint requires an **API token** instead of a **Base token**. > 📘 The upload link is only valid for a short time > > The upload link is only valid for some minutes. After that the upload link must be created again.

### Example

Expand Down Expand Up @@ -162,7 +162,7 @@ uploadFile($upload_link, $file, $parent_dir, $relative_path, $replace): object[]

Upload File (or Image)

Upload a file or an image as an attachment to a base. To execute this request you need to generate an upload link first. > 📘 Three steps to add a file/an image to a base > > To add an image or a file to a base, three steps are necessary: > 1. [Generate an upload link](/reference/getuploadlink). > 2. Upload the file to the base as an attachment. (this article) > 3. [Update a row](/reference/updaterow) and attach the file/the image to a file or image column. > 📘 Different variable names > > Pay attention that the return values of upload link have slightly different names, so `parent_path` is `parent_dir` in this call. ## Attach the file/image to a file or image column After uploading the file/image to a base, SeaTable saves the uploaded file at non-public URL in the form: `/workspace/{workspace_id}`+`parent_dir`+`relative_path`+`name`. Here is an example how this might look like: `https://cloud.seatable.io/workspace/24/asset/55f2f056-5da1-4095-b5f8-791bb51b991e/images/2023-07/party.png` If you are logged in with your browser, you can access this file. Otherwise you will see the login screen. Knowing this URL, you can add a new row or update an existing row and use the URL to add this attachment to your file/image column. ``` # Example how to add an already uploaded image to a row: \"row\": { \"My Image Column\": [\"/workspace/24/asset/55f2f056-5da1-4095-b5f8-791bb51b991e/images/2023-07/party.png`\"] } # Example how to add an already uploaded file to a row: \"row\": { \"File Column\": [{ \"name\": \"invoice.pdf\", \"size\": 101454, \"type\": \"file\", \"url\": \"/workspace/24/asset/55f2f056-5da1-4095-b5f8-791bb51b991e/images/2023-07/invoice.pdf\" }] } ``` > 🚧 File requires the input variables size, type and url > > As you can see, in the case of an image the URL is sufficient to attach the image to an image column. In case of a file, you have to provide all four input values.
Upload a file or an image as an attachment to a base. To execute this request you need to generate an upload link first. > 📘 Three steps to add a file/an image to a base > > To add an image or a file to a base, three steps are necessary: > 1. [Generate an upload link](/reference/getuploadlink). > 2. Upload the file to the base as an attachment. (this article) > 3. [Update a row](/reference/updaterow) and attach the file/the image to a file or image column. > > The [SeaTable Developer Manual](https://developer.seatable.com/clients/javascript/examples/file-upload/) includes a Node.js script that showcases the necessary API calls. > 📘 Different variable names > > Pay attention that the return values of upload link have slightly different names, so `parent_path` is `parent_dir` in this call. ## Attach the file/image to a file or image column After uploading the file/image to a base, SeaTable saves the uploaded file at non-public URL in the form: `/workspace/{workspace_id}`+`parent_dir`+`relative_path`+`name`. You are expected to construct this relative URL yourself. The URL consists of the following components: - `workspace_id`: Each base is attached to a workspace. You can use the [Get Base-Token with API-Token](https://api.seatable.com/reference/getbasetokenwithapitoken) endpoint to retrieve the workspace ID for a base. - `parent_dir`: Use the value of the `parent_path` field from the response of the [Get Upload Link](https://api.seatable.com/reference/getuploadlink) API call. - `relative_path`: Use the value of the `img_relative_path` or `file_relative_path` field (depending on the type of asset you want to upload) from the response of the [Get Upload Link](https://api.seatable.com/reference/getuploadlink) API call. - `name`: Use the value of the `name` field from the response of the [Upload File (or Image)](https://api.seatable.com/reference/uploadfile) API call. Here is an example how this might look like: `https://cloud.seatable.io/workspace/24/asset/55f2f056-5da1-4095-b5f8-791bb51b991e/images/2023-07/party.png` If you are logged in with your browser, you can access this file. Otherwise you will see the login screen. Knowing this URL, you can add a new row or update an existing row and use the URL to add this attachment to your file/image column. ``` # Example how to add an already uploaded image to a row: \"row\": { \"My Image Column\": [\"/workspace/24/asset/55f2f056-5da1-4095-b5f8-791bb51b991e/images/2023-07/party.png`\"] } # Example how to add an already uploaded file to a row: \"row\": { \"File Column\": [{ \"name\": \"invoice.pdf\", \"size\": 101454, \"type\": \"file\", \"url\": \"/workspace/24/asset/55f2f056-5da1-4095-b5f8-791bb51b991e/images/2023-07/invoice.pdf\" }] } ``` > 🚧 File requires the input variables size, type and url > > As you can see, in the case of an image the URL is sufficient to attach the image to an image column. In case of a file, you have to provide all four input values.

### Example

Expand Down
52 changes: 52 additions & 0 deletions docs/SysAdmin/Api/LogsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ All URIs are relative to https://cloud.seatable.io, except if the operation defi
| [**listAuditLogs()**](LogsApi.md#listAuditLogs) | **GET** /api/v2.1/admin/audit-logs/ | List Audit Logs |
| [**listEmailLogs()**](LogsApi.md#listEmailLogs) | **GET** /api/v2.1/admin/email-sending-logs/ | List Email Logs |
| [**listFileAccessLogs()**](LogsApi.md#listFileAccessLogs) | **GET** /api/v2.1/admin/file-access-logs/ | List File Access Logs |
| [**listGroupMemberAuditLogs()**](LogsApi.md#listGroupMemberAuditLogs) | **GET** /api/v2.1/admin/group-member-audit/ | List Group Member Audit Logs |
| [**listLoginLogs()**](LogsApi.md#listLoginLogs) | **GET** /api/v2.1/admin/logs/login-logs/ | List Login Logs |
| [**listRegistrationLogs()**](LogsApi.md#listRegistrationLogs) | **GET** /api/v2.1/admin/registration-logs/ | List Registration Logs |
| [**listVirusFiles()**](LogsApi.md#listVirusFiles) | **GET** /api/v2.1/admin/virus-files/ | List Virus Files |
Expand Down Expand Up @@ -263,6 +264,57 @@ AccountTokenAuth



## `listGroupMemberAuditLogs()`

```php
listGroupMemberAuditLogs($page, $per_page): object
```

List Group Member Audit Logs

Retrieves audit logs for changes to group members (either `group_member_add` or `group_member_delete`).

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');
$apiInstance = new SeaTable\Client\SysAdmin\LogsApi(
new GuzzleHttp\Client(),
$config
);
$page = 1; // int | The page number you want to start showing the entries. If no value is provided, 1 will be used.
$per_page = 25; // int | The number of results that should be returned. If no value is provided, 25 results will be returned.

try {
$result = $apiInstance->listGroupMemberAuditLogs($page, $per_page);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling LogsApi->listGroupMemberAuditLogs: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **page** | **int**| The page number you want to start showing the entries. If no value is provided, 1 will be used. | [optional] |
| **per_page** | **int**| The number of results that should be returned. If no value is provided, 25 results will be returned. | [optional] |

### Return type

**object**

### Authorization

AccountTokenAuth




## `listLoginLogs()`

```php
Expand Down
7 changes: 4 additions & 3 deletions docs/SysAdmin/Api/UsersApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ AccountTokenAuth
## `getUser()`

```php
getUser($user_id)
getUser($user_id): object
```

Get User
Expand All @@ -242,7 +242,8 @@ $apiInstance = new SeaTable\Client\SysAdmin\UsersApi(
$user_id = [email protected]; // string | The unique user id in the form [email protected]. This is not the email address of the user.

try {
$apiInstance->getUser($user_id);
$result = $apiInstance->getUser($user_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UsersApi->getUser: ', $e->getMessage(), PHP_EOL;
}
Expand All @@ -256,7 +257,7 @@ try {

### Return type

void (empty response body)
**object**

### Authorization

Expand Down
Loading