Skip to content
Open

v6.2 #11

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.1`
- API version: `6.2`
- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`
3 changes: 2 additions & 1 deletion README_Base.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Class | Method | HTTP request | Description
*NotificationsApi* | [**markBaseNotificationAsSeen**](docs/Base/Api/NotificationsApi.md#markbasenotificationasseen) | **PUT** /api-gateway/api/v2/dtables/{base_uuid}/notifications/{notification_id}/ | Mark Notification Read/Unread
*NotificationsApi* | [**markBaseNotificationsAsSeen**](docs/Base/Api/NotificationsApi.md#markbasenotificationsasseen) | **PUT** /api-gateway/api/v2/dtables/{base_uuid}/notifications/ | Mark Base Notifications as seen
*NotificationsApi* | [**sendToastNotification**](docs/Base/Api/NotificationsApi.md#sendtoastnotification) | **POST** /api-gateway/api/v2/dtables/{base_uuid}/ui-toasts/ | Send Toast Notification
*RowCommentsApi* | [**createRowComment**](docs/Base/Api/RowCommentsApi.md#createrowcomment) | **POST** /api-gateway/api/v2/dtables/{base_uuid}/comments/ | Create Row Comment
*RowCommentsApi* | [**deleteComment**](docs/Base/Api/RowCommentsApi.md#deletecomment) | **DELETE** /api-gateway/api/v2/dtables/{base_uuid}/comments/{comment_id}/ | Delete Comment
*RowCommentsApi* | [**getComment**](docs/Base/Api/RowCommentsApi.md#getcomment) | **GET** /api-gateway/api/v2/dtables/{base_uuid}/comments/{comment_id}/ | Get Comment
*RowCommentsApi* | [**getNumberOfComments**](docs/Base/Api/RowCommentsApi.md#getnumberofcomments) | **GET** /api/v2.1/dtables/{base_uuid}/rows-comments-num/ | Get Number of Comments
Expand Down Expand Up @@ -63,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.1`
- API version: `6.2`
- 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.1`
- API version: `6.2`
- 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.1`
- API version: `6.2`
- 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.1`
- API version: `6.2`
- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`
2 changes: 1 addition & 1 deletion README_TeamAdmin.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,5 +75,5 @@ Class | Method | HTTP request | Description

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

- API version: `6.1`
- API version: `6.2`
- 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: `6.1`
- API version: `6.2`
- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`
64 changes: 60 additions & 4 deletions docs/Base/Api/RowCommentsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ All URIs are relative to https://cloud.seatable.io, except if the operation defi

| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**createRowComment()**](RowCommentsApi.md#createRowComment) | **POST** /api-gateway/api/v2/dtables/{base_uuid}/comments/ | Create Row Comment |
| [**deleteComment()**](RowCommentsApi.md#deleteComment) | **DELETE** /api-gateway/api/v2/dtables/{base_uuid}/comments/{comment_id}/ | Delete Comment |
| [**getComment()**](RowCommentsApi.md#getComment) | **GET** /api-gateway/api/v2/dtables/{base_uuid}/comments/{comment_id}/ | Get Comment |
| [**getNumberOfComments()**](RowCommentsApi.md#getNumberOfComments) | **GET** /api/v2.1/dtables/{base_uuid}/rows-comments-num/ | Get Number of Comments |
Expand All @@ -12,6 +13,61 @@ All URIs are relative to https://cloud.seatable.io, except if the operation defi
| [**listRowComments()**](RowCommentsApi.md#listRowComments) | **GET** /api-gateway/api/v2/dtables/{base_uuid}/comments/ | List Row Comments |


## `createRowComment()`

```php
createRowComment($base_uuid, $table_id, $row_id, $create_row_comment): object
```

Create Row Comment

Create a comment for a certain row.

### Example

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

// Configure Bearer authorization: BaseTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');
$apiInstance = new SeaTable\Client\Base\RowCommentsApi(
new GuzzleHttp\Client(),
$config
);
$base_uuid = 5c264e76-0e5a-448a-9f34-580b551364ca; // string | The unique identifier of a base. Sometimes also called dtable_uuid.
$table_id = 0000; // string | The id of the table. The id of a table is unique inside a base and is often used to identify a table.
$row_id = YMIviMeERQCUiQhPPqo6Gw; // string | Unique id of a row.
$create_row_comment = new \SeaTable\Client\Base\CreateRowComment(); // \SeaTable\Client\Base\CreateRowComment

try {
$result = $apiInstance->createRowComment($base_uuid, $table_id, $row_id, $create_row_comment);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling RowCommentsApi->createRowComment: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **base_uuid** | **string**| The unique identifier of a base. Sometimes also called dtable_uuid. | |
| **table_id** | **string**| The id of the table. The id of a table is unique inside a base and is often used to identify a table. | |
| **row_id** | **string**| Unique id of a row. | |
| **create_row_comment** | [**\SeaTable\Client\Base\CreateRowComment**](../Model/CreateRowComment.md)| | [optional] |

### Return type

**object**

### Authorization

BaseTokenAuth




## `deleteComment()`

```php
Expand All @@ -20,7 +76,7 @@ deleteComment($base_uuid, $comment_id): object

Delete Comment

Delete a certain comment by its ID. > 🚧 Creating comments via the API Gateway is not yet supported. This will be fixed in SeaTable 6.2. Until then, comments can only be created via `POST /api/v2.1/dtables/{dtable_uuid}/comments/` (dtable-web).
Delete a certain comment by its ID.

### Example

Expand Down Expand Up @@ -71,7 +127,7 @@ getComment($base_uuid, $comment_id): \SeaTable\Client\Base\GetComment200Response

Get Comment

Get the details of a certain comment with its ID. > 🚧 Creating comments via the API Gateway is not yet supported. This will be fixed in SeaTable 6.2. Until then, comments can only be created via `POST /api/v2.1/dtables/{dtable_uuid}/comments/` (dtable-web).
Get the details of a certain comment with its ID.

### Example

Expand Down Expand Up @@ -268,7 +324,7 @@ BaseTokenAuth
## `listRowComments()`

```php
listRowComments($base_uuid, $row_id): object
listRowComments($base_uuid, $row_id): object[]
```

List Row Comments
Expand Down Expand Up @@ -307,7 +363,7 @@ try {

### Return type

**object**
**object[]**

### Authorization

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # GetFileDownloadLink400Response
# # GetFileDownloadLink404Response

## Properties

Expand Down
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.1
* The version of the OpenAPI document: 6.2
* 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.1
* The version of the OpenAPI document: 6.2
* 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.1
* The version of the OpenAPI document: 6.2
* 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.1
* The version of the OpenAPI document: 6.2
* Generated by: https://openapi-generator.tech
*/

Expand Down
2 changes: 1 addition & 1 deletion lib/Auth/AccountTokenApi.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.1
* The version of the OpenAPI document: 6.2
* Generated by: https://openapi-generator.tech
*/

Expand Down
2 changes: 1 addition & 1 deletion lib/Auth/ApiToken.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.1
* The version of the OpenAPI document: 6.2
* Generated by: https://openapi-generator.tech
*/

Expand Down
2 changes: 1 addition & 1 deletion lib/Auth/ApiTokenList.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.1
* The version of the OpenAPI document: 6.2
* Generated by: https://openapi-generator.tech
*/

Expand Down
2 changes: 1 addition & 1 deletion lib/Auth/ApiTokenTemporary.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.1
* The version of the OpenAPI document: 6.2
* Generated by: https://openapi-generator.tech
*/

Expand Down
2 changes: 1 addition & 1 deletion lib/Auth/AuthenticationPermission.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.1
* The version of the OpenAPI document: 6.2
* Generated by: https://openapi-generator.tech
*/

Expand Down
2 changes: 1 addition & 1 deletion lib/Auth/BaseTokenApi.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.1
* The version of the OpenAPI document: 6.2
* Generated by: https://openapi-generator.tech
*/

Expand Down
2 changes: 1 addition & 1 deletion lib/Auth/GetBaseTokenWithApiToken200Response.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.1
* The version of the OpenAPI document: 6.2
* Generated by: https://openapi-generator.tech
*/

Expand Down
2 changes: 1 addition & 1 deletion lib/Auth/ModelInterface.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.1
* The version of the OpenAPI document: 6.2
* Generated by: https://openapi-generator.tech
*/

Expand Down
2 changes: 1 addition & 1 deletion lib/Base/ActivitiesLogsApi.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.1
* The version of the OpenAPI document: 6.2
* Generated by: https://openapi-generator.tech
*/

Expand Down
2 changes: 1 addition & 1 deletion lib/Base/AddSingleMultipleSelectOptions.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.1
* The version of the OpenAPI document: 6.2
* Generated by: https://openapi-generator.tech
*/

Expand Down
2 changes: 1 addition & 1 deletion lib/Base/AddSingleMultipleSelectOptionsOptionsInner.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.1
* The version of the OpenAPI document: 6.2
* Generated by: https://openapi-generator.tech
*/

Expand Down
2 changes: 1 addition & 1 deletion lib/Base/AppendColumnsRequest.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.1
* The version of the OpenAPI document: 6.2
* Generated by: https://openapi-generator.tech
*/

Expand Down
2 changes: 1 addition & 1 deletion lib/Base/AppendColumnsRequestColumnsInner.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.1
* The version of the OpenAPI document: 6.2
* Generated by: https://openapi-generator.tech
*/

Expand Down
2 changes: 1 addition & 1 deletion lib/Base/AppendRow.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.1
* The version of the OpenAPI document: 6.2
* Generated by: https://openapi-generator.tech
*/

Expand Down
2 changes: 1 addition & 1 deletion lib/Base/AppendRows.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.1
* The version of the OpenAPI document: 6.2
* Generated by: https://openapi-generator.tech
*/

Expand Down
2 changes: 1 addition & 1 deletion lib/Base/AppendRows200Response.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.1
* The version of the OpenAPI document: 6.2
* Generated by: https://openapi-generator.tech
*/

Expand Down
2 changes: 1 addition & 1 deletion lib/Base/ArchiveView.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.1
* The version of the OpenAPI document: 6.2
* Generated by: https://openapi-generator.tech
*/

Expand Down
2 changes: 1 addition & 1 deletion lib/Base/AutomaticFilterPredicate.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.1
* The version of the OpenAPI document: 6.2
* Generated by: https://openapi-generator.tech
*/

Expand Down
2 changes: 1 addition & 1 deletion lib/Base/AutonumberColumn.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.1
* The version of the OpenAPI document: 6.2
* Generated by: https://openapi-generator.tech
*/

Expand Down
2 changes: 1 addition & 1 deletion lib/Base/AutonumberColumnFormat.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.1
* The version of the OpenAPI document: 6.2
* Generated by: https://openapi-generator.tech
*/

Expand Down
Loading