Skip to content
Draft

v7.0 #13

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 @@ -18,5 +18,5 @@ Class | Method | HTTP request | Description

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

- API version: `6.2`
- API version: `7.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 @@ -64,5 +64,5 @@ Class | Method | HTTP request | Description

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

- API version: `6.2`
- API version: `7.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: `6.2`
- API version: `7.0`
- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`
2 changes: 1 addition & 1 deletion README_PythonScheduler.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@ Class | Method | HTTP request | Description

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

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

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

- API version: `6.2`
- API version: `7.0`
- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`
5 changes: 4 additions & 1 deletion README_TeamAdmin.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Class | Method | HTTP request | Description
*BasesApi* | [**listApiTokensOfAllBases**](docs/TeamAdmin/Api/BasesApi.md#listapitokensofallbases) | **GET** /api/v2.1/org/{org_id}/admin/api-tokens/ | List API-Tokens of All Bases
*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* | [**listBasesSharedToUser**](docs/TeamAdmin/Api/BasesApi.md#listbasessharedtouser) | **GET** /api/v2.1/org/{org_id}/admin/users/{user_id}/shared-dtables/ | List Bases Shared to User
*BasesApi* | [**listTrashBases**](docs/TeamAdmin/Api/BasesApi.md#listtrashbases) | **GET** /api/v2.1/org/{org_id}/admin/trash-dtables/ | List Trash Bases
*BasesApi* | [**listUsersBases**](docs/TeamAdmin/Api/BasesApi.md#listusersbases) | **GET** /api/v2.1/org/{org_id}/admin/users/{user_id}/dtables/ | List User's Bases
*BasesApi* | [**restoreBaseFromTrash**](docs/TeamAdmin/Api/BasesApi.md#restorebasefromtrash) | **PUT** /api/v2.1/org/{org_id}/admin/trash-dtables/{base_uuid}/ | Restore Base from Trash
Expand Down Expand Up @@ -66,7 +67,9 @@ Class | Method | HTTP request | Description
*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* | [**listManagedApps**](docs/TeamAdmin/Api/UsersApi.md#listmanagedapps) | **GET** /api/v2.1/org/{org_id}/admin/users/{user_id}/managed-external-apps/ | List Managed Apps
*UsersApi* | [**listTeamUsers**](docs/TeamAdmin/Api/UsersApi.md#listteamusers) | **GET** /api/v2.1/org/{org_id}/admin/users/ | List Users (Team)
*UsersApi* | [**listUsableApps**](docs/TeamAdmin/Api/UsersApi.md#listusableapps) | **GET** /api/v2.1/org/{org_id}/admin/users/{user_id}/can-use-external-apps/ | List Usable Apps
*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 @@ -75,5 +78,5 @@ Class | Method | HTTP request | Description

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

- API version: `6.2`
- API version: `7.0`
- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`
3 changes: 2 additions & 1 deletion README_User.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Class | Method | HTTP request | Description
*AttachmentApi* | [**checkIfAssetExists**](docs/User/Api/AttachmentApi.md#checkifassetexists) | **GET** /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/asset-exists/ | Check If Asset Exists
*AttachmentApi* | [**deleteBaseAsset**](docs/User/Api/AttachmentApi.md#deletebaseasset) | **DELETE** /api/v2.1/dtable-asset/{base_uuid}/ | Delete Base Asset
*AttachmentApi* | [**deleteBaseAssets**](docs/User/Api/AttachmentApi.md#deletebaseassets) | **DELETE** /api/v2.1/dtable-asset/{base_uuid}/batch-delete-assets/ | Delete Base Assets
*AttachmentApi* | [**getBaseAssetSize**](docs/User/Api/AttachmentApi.md#getbaseassetsize) | **GET** /api/v2.1/dtable-asset/{base_uuid}/asset-size/ | Get Base Asset Size
*AttachmentApi* | [**getBaseAttachmentUploadLink**](docs/User/Api/AttachmentApi.md#getbaseattachmentuploadlink) | **GET** /api/v2.1/workspace/{workspace_id}/dtable-asset-upload-link/ | Get Base Attachment Upload Link
*AttachmentApi* | [**listBaseAssets**](docs/User/Api/AttachmentApi.md#listbaseassets) | **GET** /api/v2.1/dtable-asset/{base_uuid}/ | List Base Asset Directories And Files
*AttachmentApi* | [**listRecentlyUploadedFiles**](docs/User/Api/AttachmentApi.md#listrecentlyuploadedfiles) | **GET** /api/v2.1/dtable-recent-asset/{base_uuid}/ | List Recently Uploaded Files
Expand Down Expand Up @@ -151,5 +152,5 @@ Class | Method | HTTP request | Description

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

- API version: `6.2`
- API version: `7.0`
- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`
56 changes: 56 additions & 0 deletions docs/TeamAdmin/Api/BasesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ All URIs are relative to https://cloud.seatable.io, except if the operation defi
| [**listApiTokensOfAllBases()**](BasesApi.md#listApiTokensOfAllBases) | **GET** /api/v2.1/org/{org_id}/admin/api-tokens/ | List API-Tokens of All Bases |
| [**listBaseSharings()**](BasesApi.md#listBaseSharings) | **GET** /api/v2.1/org/{org_id}/admin/dtables/{base_uuid}/shares/ | List Base Sharings |
| [**listBases()**](BasesApi.md#listBases) | **GET** /api/v2.1/org/{org_id}/admin/dtables/ | List Bases (Team) |
| [**listBasesSharedToUser()**](BasesApi.md#listBasesSharedToUser) | **GET** /api/v2.1/org/{org_id}/admin/users/{user_id}/shared-dtables/ | List Bases Shared to User |
| [**listTrashBases()**](BasesApi.md#listTrashBases) | **GET** /api/v2.1/org/{org_id}/admin/trash-dtables/ | List Trash Bases |
| [**listUsersBases()**](BasesApi.md#listUsersBases) | **GET** /api/v2.1/org/{org_id}/admin/users/{user_id}/dtables/ | List User's Bases |
| [**restoreBaseFromTrash()**](BasesApi.md#restoreBaseFromTrash) | **PUT** /api/v2.1/org/{org_id}/admin/trash-dtables/{base_uuid}/ | Restore Base from Trash |
Expand Down Expand Up @@ -430,6 +431,61 @@ AccountTokenAuth



## `listBasesSharedToUser()`

```php
listBasesSharedToUser($org_id, $user_id, $page, $per_page): object
```

List Bases Shared to User

List all the bases shared to a certain user by the user's ID.

### 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\TeamAdmin\BasesApi(
new GuzzleHttp\Client(),
$config
);
$org_id = 1; // int | The ID of your team/organization. Numeric. Get it from [Get Team](/reference/getteaminfo). Contact your team admin, if you are not the admin.
$user_id = 123456789f1e4c8d8e1c31415867317c@auth.local; // string | The unique `user_id` in the form ...@auth.local. This is not the email address of the user.
$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->listBasesSharedToUser($org_id, $user_id, $page, $per_page);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BasesApi->listBasesSharedToUser: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **org_id** | **int**| The ID of your team/organization. Numeric. Get it from [Get Team](/reference/getteaminfo). Contact your team admin, if you are not the admin. | |
| **user_id** | **string**| The unique &#x60;user_id&#x60; in the form ...@auth.local. This is not the email address of the user. | |
| **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




## `listTrashBases()`

```php
Expand Down
112 changes: 112 additions & 0 deletions docs/TeamAdmin/Api/UsersApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ All URIs are relative to https://cloud.seatable.io, except if the operation defi
| [**disableTwoFactor()**](UsersApi.md#disableTwoFactor) | **DELETE** /api/v2.1/org/{org_id}/admin/users/{user_id}/two-factor-auth/ | Disable 2FA |
| [**enforceTwofactor()**](UsersApi.md#enforceTwofactor) | **PUT** /api/v2.1/org/{org_id}/admin/users/{user_id}/two-factor-auth/ | Enforce 2FA |
| [**getUser()**](UsersApi.md#getUser) | **GET** /api/v2.1/org/{org_id}/admin/users/{user_id}/ | Get User |
| [**listManagedApps()**](UsersApi.md#listManagedApps) | **GET** /api/v2.1/org/{org_id}/admin/users/{user_id}/managed-external-apps/ | List Managed Apps |
| [**listTeamUsers()**](UsersApi.md#listTeamUsers) | **GET** /api/v2.1/org/{org_id}/admin/users/ | List Users (Team) |
| [**listUsableApps()**](UsersApi.md#listUsableApps) | **GET** /api/v2.1/org/{org_id}/admin/users/{user_id}/can-use-external-apps/ | List Usable Apps |
| [**resetUserPassword()**](UsersApi.md#resetUserPassword) | **PUT** /api/v2.1/org/{org_id}/admin/users/{user_id}/set-password/ | Reset User Password |
| [**updateUser()**](UsersApi.md#updateUser) | **PUT** /api/v2.1/org/{org_id}/admin/users/{user_id}/ | Update User |

Expand Down Expand Up @@ -277,6 +279,61 @@ AccountTokenAuth



## `listManagedApps()`

```php
listManagedApps($org_id, $user_id, $page, $per_page): object
```

List Managed Apps

List all the universal apps a certain user manages, i.e. the apps in which the user has the `admin` role. Inactive apps and apps of deleted bases are not included.

### 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\TeamAdmin\UsersApi(
new GuzzleHttp\Client(),
$config
);
$org_id = 1; // int | The ID of your team/organization. Numeric. Get it from [Get Team](/reference/getteaminfo). Contact your team admin, if you are not the admin.
$user_id = 123456789f1e4c8d8e1c31415867317c@auth.local; // string | The unique `user_id` in the form ...@auth.local. This is not the email address of the user.
$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->listManagedApps($org_id, $user_id, $page, $per_page);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UsersApi->listManagedApps: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **org_id** | **int**| The ID of your team/organization. Numeric. Get it from [Get Team](/reference/getteaminfo). Contact your team admin, if you are not the admin. | |
| **user_id** | **string**| The unique &#x60;user_id&#x60; in the form ...@auth.local. This is not the email address of the user. | |
| **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




## `listTeamUsers()`

```php
Expand Down Expand Up @@ -330,6 +387,61 @@ AccountTokenAuth



## `listUsableApps()`

```php
listUsableApps($org_id, $user_id, $page, $per_page): object
```

List Usable Apps

List all the universal apps a certain user can use, i.e. the apps in which the user has a role other than `admin`. Inactive apps and apps of deleted bases are not included.

### 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\TeamAdmin\UsersApi(
new GuzzleHttp\Client(),
$config
);
$org_id = 1; // int | The ID of your team/organization. Numeric. Get it from [Get Team](/reference/getteaminfo). Contact your team admin, if you are not the admin.
$user_id = 123456789f1e4c8d8e1c31415867317c@auth.local; // string | The unique `user_id` in the form ...@auth.local. This is not the email address of the user.
$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->listUsableApps($org_id, $user_id, $page, $per_page);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UsersApi->listUsableApps: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **org_id** | **int**| The ID of your team/organization. Numeric. Get it from [Get Team](/reference/getteaminfo). Contact your team admin, if you are not the admin. | |
| **user_id** | **string**| The unique &#x60;user_id&#x60; in the form ...@auth.local. This is not the email address of the user. | |
| **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




## `resetUserPassword()`

```php
Expand Down
50 changes: 50 additions & 0 deletions docs/User/Api/AttachmentApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ All URIs are relative to https://cloud.seatable.io, except if the operation defi
| [**checkIfAssetExists()**](AttachmentApi.md#checkIfAssetExists) | **GET** /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/asset-exists/ | Check If Asset Exists |
| [**deleteBaseAsset()**](AttachmentApi.md#deleteBaseAsset) | **DELETE** /api/v2.1/dtable-asset/{base_uuid}/ | Delete Base Asset |
| [**deleteBaseAssets()**](AttachmentApi.md#deleteBaseAssets) | **DELETE** /api/v2.1/dtable-asset/{base_uuid}/batch-delete-assets/ | Delete Base Assets |
| [**getBaseAssetSize()**](AttachmentApi.md#getBaseAssetSize) | **GET** /api/v2.1/dtable-asset/{base_uuid}/asset-size/ | Get Base Asset Size |
| [**getBaseAttachmentUploadLink()**](AttachmentApi.md#getBaseAttachmentUploadLink) | **GET** /api/v2.1/workspace/{workspace_id}/dtable-asset-upload-link/ | Get Base Attachment Upload Link |
| [**listBaseAssets()**](AttachmentApi.md#listBaseAssets) | **GET** /api/v2.1/dtable-asset/{base_uuid}/ | List Base Asset Directories And Files |
| [**listRecentlyUploadedFiles()**](AttachmentApi.md#listRecentlyUploadedFiles) | **GET** /api/v2.1/dtable-recent-asset/{base_uuid}/ | List Recently Uploaded Files |
Expand Down Expand Up @@ -166,6 +167,55 @@ AccountTokenAuth



## `getBaseAssetSize()`

```php
getBaseAssetSize($base_uuid): \SeaTable\Client\User\GetBaseAssetSize200Response
```

Get Base Asset Size

Get the total size of all assets (attachments, images and files) stored in a base and check whether the base can be exported together with its assets. All sizes are given in megabytes, rounded down. `max_size_of_export` is the server-wide limit configured by the system administrator (default: 100). If `can_export_asset` is `false`, the assets of this base exceed that limit and the base can only be exported without its assets.

### 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\User\AttachmentApi(
new GuzzleHttp\Client(),
$config
);
$base_uuid = 5c264e76-0e5a-448a-9f34-580b551364ca; // string | The unique identifier of a base. Sometimes also called dtable_uuid.

try {
$result = $apiInstance->getBaseAssetSize($base_uuid);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AttachmentApi->getBaseAssetSize: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **base_uuid** | **string**| The unique identifier of a base. Sometimes also called dtable_uuid. | |

### Return type

[**\SeaTable\Client\User\GetBaseAssetSize200Response**](../Model/GetBaseAssetSize200Response.md)

### Authorization

AccountTokenAuth




## `getBaseAttachmentUploadLink()`

```php
Expand Down
11 changes: 11 additions & 0 deletions docs/User/Model/GetBaseAssetSize200Response.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# # GetBaseAssetSize200Response

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**asset_size** | **int** | Total size of all assets of the base. | [optional]
**max_size_of_export** | **int** | Maximum asset size that can be included in an export. | [optional]
**unit** | **string** | Unit of the returned sizes. | [optional]
**can_export_asset** | **bool** | Whether the assets of this base can be included in an export. | [optional]

2 changes: 1 addition & 1 deletion lib/ApiException.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
*
* The official SeaTable API Reference (OpenAPI 3.0).
*
* The version of the OpenAPI document: 6.2
* The version of the OpenAPI document: 7.0
* Generated by: https://openapi-generator.tech
*/

Expand Down
2 changes: 1 addition & 1 deletion lib/Auth/APITokenApi.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
*
* The official SeaTable API Reference (OpenAPI 3.0).
*
* The version of the OpenAPI document: 6.2
* The version of the OpenAPI document: 7.0
* Generated by: https://openapi-generator.tech
*/

Expand Down
2 changes: 1 addition & 1 deletion lib/Auth/AccessToken.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
*
* The official SeaTable API Reference (OpenAPI 3.0).
*
* The version of the OpenAPI document: 6.2
* The version of the OpenAPI document: 7.0
* Generated by: https://openapi-generator.tech
*/

Expand Down
2 changes: 1 addition & 1 deletion lib/Auth/AccountToken.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
*
* The official SeaTable API Reference (OpenAPI 3.0).
*
* The version of the OpenAPI document: 6.2
* The version of the OpenAPI document: 7.0
* Generated by: https://openapi-generator.tech
*/

Expand Down
Loading