1c/OpenIntegrations
1
0
Fork 0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-08-13 20:05:19 +02:00
Code Issues Releases Activity

Создание MD файлов документации

Browse Source
This commit is contained in:
Vitaly the Alpaca
2024-06-05 10:19:46 +00:00
committed by Vitaly the Alpaca (bot)
parent 9c2d012d41
commit 09822c04ec
597 changed files with 41032 additions and 41032 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
docs/en/md/Airtable/Airtable.md
View File

@@ -1,24 +1,24 @@
--- ---
id: Airtable id: Airtable
sidebar_class_name: Airtable sidebar_class_name: Airtable
--- ---
<img src={require('../../static/img/APIs/Airtable.png').default} width='64px' /> <img src={require('../../static/img/APIs/Airtable.png').default} width='64px' />
# Airtable # Airtable
Этот раздел поwithinящен библиотеtoе for work with Airtable API. Nа данной withтранице опиwithаны inwithе дейwithтinия, необходимые for полноценного of start work Этот раздел поwithinящен библиотеtoе for work with Airtable API. Nа данной withтранице опиwithаны inwithе дейwithтinия, необходимые for полноценного of start work
## Getting started ## Getting started
1. Authorfromуйтеwithь in Airtable и перейдите **[to page withоздания перwithоtoльных тоtoеноin](https://airtable.com/create/tokens)**, toжмите **Create new token** 1. Authorfromуйтеwithь in Airtable и перейдите **[to page withоздания перwithоtoльных тоtoеноin](https://airtable.com/create/tokens)**, toжмите **Create new token**
![BF](../../static/img/Docs/Airtable/1.png) ![BF](../../static/img/Docs/Airtable/1.png)
2. Ininедите name for ноinого тоtoеto, inыберите from перечня необходимые **Scopes** (разрешения) и **Acess** (базы и рабочие проwithтранwithтinа, to toоторым у тоtoеto will доwithтуп) 2. Ininедите name for ноinого тоtoеto, inыберите from перечня необходимые **Scopes** (разрешения) и **Acess** (базы и рабочие проwithтранwithтinа, to toоторым у тоtoеto will доwithтуп)
![BF](../../static/img/Docs/Airtable/2.png) ![BF](../../static/img/Docs/Airtable/2.png)
3. Сtoопируйте ноinый **тоtoен** 3. Сtoопируйте ноinый **тоtoен**
![BF](../../static/img/Docs/Airtable/3.png) ![BF](../../static/img/Docs/Airtable/3.png)

118
docs/en/md/Airtable/Comment-management/Create-comment.md
View File

@@ -1,59 +1,59 @@
--- ---
sidebar_position: 2 sidebar_position: 2
--- ---
# Create comment # Create comment
Creates a comment for a record in the table Creates a comment for a record in the table
*Function CreateComment(Val Token, Val Base, Val Table, Val Record, Val Text) Export* *Function CreateComment(Val Token, Val Base, Val Table, Val Record, Val Text) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Base | --base | String | Database identifier | | Base | --base | String | Database identifier |
| Table | --table | String | Table identifier | | Table | --table | String | Table identifier |
| Record | --record | String | Record identifier in the table | | Record | --record | String | Record identifier in the table |
| Text | --text | String | Comment text | | Text | --text | String | Comment text |
Returns: Key-Value Pair - serialized JSON response from Airtable Returns: Key-Value Pair - serialized JSON response from Airtable
```bsl title="Code example" ```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ"; Base = "apptm8Xqo7TwMaipQ";
Table = "tbl9G4jVoTJpxYwSY"; Table = "tbl9G4jVoTJpxYwSY";
Record = "recV6DxeLQMBNJrUk"; Record = "recV6DxeLQMBNJrUk";
Text = "TestComment"; Text = "TestComment";
Response = OPI_Airtable.CreateComment(Token, Base, Table, Record, Text); //Map Response = OPI_Airtable.CreateComment(Token, Base, Table, Record, Text); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint airtable CreateComment --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk" --text "TestComment" oint airtable CreateComment --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk" --text "TestComment"
``` ```
```json title="Result" ```json title="Result"
{ {
"id": "comL1oGEDJvIQlMs1", "id": "comL1oGEDJvIQlMs1",
"author": { "author": {
"id": "usrFlaAHlTfYWAbVW", "id": "usrFlaAHlTfYWAbVW",
"email": "bayselonarrend@gmail.com", "email": "bayselonarrend@gmail.com",
"name": "Anton Titovets" "name": "Anton Titovets"
}, },
"text": "TestComment", "text": "TestComment",
"createdTime": "2024-05-10T19:39:51.561Z", "createdTime": "2024-05-10T19:39:51.561Z",
"lastUpdatedTime": null "lastUpdatedTime": null
} }
``` ```

104
docs/en/md/Airtable/Comment-management/Delete-comment.md
View File

@@ -1,52 +1,52 @@
--- ---
sidebar_position: 4 sidebar_position: 4
--- ---
# Delete comment # Delete comment
Deletes a comment for a table record Deletes a comment for a table record
*Function DeleteComment(Val Token, Val Base, Val Table, Val Record, Val Comment) Export* *Function DeleteComment(Val Token, Val Base, Val Table, Val Record, Val Comment) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Base | --base | String | Database identifier | | Base | --base | String | Database identifier |
| Table | --table | String | Table identifier | | Table | --table | String | Table identifier |
| Record | --record | String | Record identifier in the table | | Record | --record | String | Record identifier in the table |
| Comment | --comment | String | Comment identifier | | Comment | --comment | String | Comment identifier |
Returns: Key-Value Pair - serialized JSON response from Airtable Returns: Key-Value Pair - serialized JSON response from Airtable
```bsl title="Code example" ```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ"; Base = "apptm8Xqo7TwMaipQ";
Table = "tbl9G4jVoTJpxYwSY"; Table = "tbl9G4jVoTJpxYwSY";
Record = "recV6DxeLQMBNJrUk"; Record = "recV6DxeLQMBNJrUk";
Comment = "comL1oGEDJvIQlMs1"; Comment = "comL1oGEDJvIQlMs1";
Response = OPI_Airtable.DeleteComment(Token, Base, Table, Record, Comment); //Map Response = OPI_Airtable.DeleteComment(Token, Base, Table, Record, Comment); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint airtable DeleteComment --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk" --comment %comment% oint airtable DeleteComment --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk" --comment %comment%
``` ```
```json title="Result" ```json title="Result"
{ {
"id": "comL1oGEDJvIQlMs1", "id": "comL1oGEDJvIQlMs1",
"deleted": true "deleted": true
} }
``` ```

122
docs/en/md/Airtable/Comment-management/Edit-comment.md
View File

@@ -1,61 +1,61 @@
--- ---
sidebar_position: 3 sidebar_position: 3
--- ---
# Modify comment # Modify comment
Changes the text of an existing comment Changes the text of an existing comment
*Function EditComment(Val Token, Val Base, Val Table, Val Record, Val Comment, Val Text) Export* *Function EditComment(Val Token, Val Base, Val Table, Val Record, Val Comment, Val Text) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Base | --base | String | Database identifier | | Base | --base | String | Database identifier |
| Table | --table | String | Table identifier | | Table | --table | String | Table identifier |
| Record | --record | String | Record identifier in the table | | Record | --record | String | Record identifier in the table |
| Comment | --comment | String | Comment identifier | | Comment | --comment | String | Comment identifier |
| Text | --text | String | New comment text | | Text | --text | String | New comment text |
Returns: Key-Value Pair - serialized JSON response from Airtable Returns: Key-Value Pair - serialized JSON response from Airtable
```bsl title="Code example" ```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ"; Base = "apptm8Xqo7TwMaipQ";
Table = "tbl9G4jVoTJpxYwSY"; Table = "tbl9G4jVoTJpxYwSY";
Record = "recV6DxeLQMBNJrUk"; Record = "recV6DxeLQMBNJrUk";
Comment = "comL1oGEDJvIQlMs1"; Comment = "comL1oGEDJvIQlMs1";
Text = "Test comment (change.)"; Text = "Test comment (change.)";
Response = OPI_Airtable.EditComment(Token, Base, Table, Record, Comment, Text); //Map Response = OPI_Airtable.EditComment(Token, Base, Table, Record, Comment, Text); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint airtable EditComment --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk" --comment %comment% --text "Test comment (change.)" oint airtable EditComment --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk" --comment %comment% --text "Test comment (change.)"
``` ```
```json title="Result" ```json title="Result"
{ {
"id": "comL1oGEDJvIQlMs1", "id": "comL1oGEDJvIQlMs1",
"author": { "author": {
"id": "usrFlaAHlTfYWAbVW", "id": "usrFlaAHlTfYWAbVW",
"email": "bayselonarrend@gmail.com", "email": "bayselonarrend@gmail.com",
"name": "Anton Titovets" "name": "Anton Titovets"
}, },
"text": "Test comment (change.)", "text": "Test comment (change.)",
"createdTime": "2024-05-10T19:39:52Z", "createdTime": "2024-05-10T19:39:52Z",
"lastUpdatedTime": "2024-05-10T19:39:51.967Z" "lastUpdatedTime": "2024-05-10T19:39:51.967Z"
} }
``` ```

126
docs/en/md/Airtable/Comment-management/Get-comments.md
View File

@@ -1,63 +1,63 @@
--- ---
sidebar_position: 1 sidebar_position: 1
--- ---
# Get comments # Get comments
Gets the list of comments for a record in the table Gets the list of comments for a record in the table
*Function GetComments(Val Token, Val Base, Val Table, Val Record, Val Indent = "") Export* *Function GetComments(Val Token, Val Base, Val Table, Val Record, Val Indent = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Base | --base | String | Database identifier | | Base | --base | String | Database identifier |
| Table | --table | String | Table identifier | | Table | --table | String | Table identifier |
| Record | --record | String | Record identifier in the table | | Record | --record | String | Record identifier in the table |
| Indent | --offset | String | Next page identifier of data from the previous request | | Indent | --offset | String | Next page identifier of data from the previous request |
Returns: Key-Value Pair - serialized JSON response from Airtable Returns: Key-Value Pair - serialized JSON response from Airtable
```bsl title="Code example" ```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ"; Base = "apptm8Xqo7TwMaipQ";
Table = "tbl9G4jVoTJpxYwSY"; Table = "tbl9G4jVoTJpxYwSY";
Record = "recV6DxeLQMBNJrUk"; Record = "recV6DxeLQMBNJrUk";
Response = OPI_Airtable.GetComments(Token, Base, Table, Record); //Map Response = OPI_Airtable.GetComments(Token, Base, Table, Record); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint airtable GetComments --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk" --offset %offset% oint airtable GetComments --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk" --offset %offset%
``` ```
```json title="Result" ```json title="Result"
{ {
"comments": [ "comments": [
{ {
"id": "comL1oGEDJvIQlMs1", "id": "comL1oGEDJvIQlMs1",
"author": { "author": {
"id": "usrFlaAHlTfYWAbVW", "id": "usrFlaAHlTfYWAbVW",
"email": "bayselonarrend@gmail.com", "email": "bayselonarrend@gmail.com",
"name": "Anton Titovets" "name": "Anton Titovets"
}, },
"text": "Test comment (change.)", "text": "Test comment (change.)",
"createdTime": "2024-05-10T19:39:52Z", "createdTime": "2024-05-10T19:39:52Z",
"lastUpdatedTime": "2024-05-10T19:39:52Z" "lastUpdatedTime": "2024-05-10T19:39:52Z"
} }
], ],
"offset": null "offset": null
} }
``` ```

8
docs/en/md/Airtable/Comment-management/_category_.json
View File

@@ -1,4 +1,4 @@
{ {
"label": "Comment management", "label": "Comment management",
"position": "6" "position": "6"
} }

172
docs/en/md/Airtable/Database-work/Create-database.md
View File

@@ -1,86 +1,86 @@
--- ---
sidebar_position: 3 sidebar_position: 3
--- ---
# Create base # Create base
Creates a new database Creates a new database
*Function CreateDatabase(Val Token, Val Workspace, Val Name, Val TableCollection) Export* *Function CreateDatabase(Val Token, Val Workspace, Val Name, Val TableCollection) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Workspace | --ws | String | Workspace identifier | | Workspace | --ws | String | Workspace identifier |
| Name | --title | String | New base name | | Name | --title | String | New base name |
| TableCollection | --tablesdata | Key-Value Pair | Table description: Key > name, Value > array of fields | | TableCollection | --tablesdata | Key-Value Pair | Table description: Key > name, Value > array of fields |
Returns: Key-Value Pair - serialized JSON response from Airtable Returns: Key-Value Pair - serialized JSON response from Airtable
```bsl title="Code example" ```bsl title="Code example"
Workspace = "wspdf8yl1yZz3PmWZ"; Workspace = "wspdf8yl1yZz3PmWZ";
Name = "TestDatabase"; Name = "TestDatabase";
FieldArray = New Array; FieldArray = New Array;
FieldArray.Add(OPI_Airtable.GetNumberField("Number")); FieldArray.Add(OPI_Airtable.GetNumberField("Number"));
FieldArray.Add(OPI_Airtable.GetStringField("String")); FieldArray.Add(OPI_Airtable.GetStringField("String"));
TableName = "TestTable"; TableName = "TestTable";
TableCollection = New Map; TableCollection = New Map;
TableCollection.Insert(TableName, FieldArray); TableCollection.Insert(TableName, FieldArray);
Response = OPI_Airtable.CreateDatabase(Token, Workspace, Name, TableCollection); //Map Response = OPI_Airtable.CreateDatabase(Token, Workspace, Name, TableCollection); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint airtable CreateDatabase --token %token% --ws "wspdf8yl1yZz3PmWZ" --title "TestDatabase" --tablesdata %tablesdata% oint airtable CreateDatabase --token %token% --ws "wspdf8yl1yZz3PmWZ" --title "TestDatabase" --tablesdata %tablesdata%
``` ```
```json title="Result" ```json title="Result"
{ {
"id": "applEsyJmBRm12AuN", "id": "applEsyJmBRm12AuN",
"tables": [ "tables": [
{ {
"id": "tblqZzW78Rvsdt9gt", "id": "tblqZzW78Rvsdt9gt",
"name": "TestTable", "name": "TestTable",
"primaryFieldId": "fldj9Z3fEpLzv40d0", "primaryFieldId": "fldj9Z3fEpLzv40d0",
"fields": [ "fields": [
{ {
"type": "number", "type": "number",
"options": { "options": {
"precision": 0 "precision": 0
}, },
"id": "fldj9Z3fEpLzv40d0", "id": "fldj9Z3fEpLzv40d0",
"name": "Number" "name": "Number"
}, },
{ {
"type": "richText", "type": "richText",
"id": "fldX1kR7lienmcdEj", "id": "fldX1kR7lienmcdEj",
"name": "String" "name": "String"
} }
], ],
"views": [ "views": [
{ {
"id": "viwbKE3PS9jl6bqJl", "id": "viwbKE3PS9jl6bqJl",
"name": "Grid view", "name": "Grid view",
"type": "grid" "type": "grid"
} }
] ]
} }
] ]
} }
``` ```

146
docs/en/md/Airtable/Database-work/Get-database-tables.md
View File

@@ -1,73 +1,73 @@
--- ---
sidebar_position: 2 sidebar_position: 2
--- ---
# Get base tables # Get base tables
Gets the schema of base tables Gets the schema of base tables
*Function GetDatabaseTables(Val Token, Val Base) Export* *Function GetDatabaseTables(Val Token, Val Base) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Base | --base | String | Base identifier | | Base | --base | String | Base identifier |
Returns: Key-Value Pair - serialized JSON response from Airtable Returns: Key-Value Pair - serialized JSON response from Airtable
```bsl title="Code example" ```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ"; Base = "apptm8Xqo7TwMaipQ";
Response = OPI_Airtable.GetDatabaseTables(Token, Base); //Map Response = OPI_Airtable.GetDatabaseTables(Token, Base); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint airtable GetDatabaseTables --token %token% --base "apptm8Xqo7TwMaipQ" oint airtable GetDatabaseTables --token %token% --base "apptm8Xqo7TwMaipQ"
``` ```
```json title="Result" ```json title="Result"
{ {
"tables": [ "tables": [
{ {
"id": "tblqZzW78Rvsdt9gt", "id": "tblqZzW78Rvsdt9gt",
"name": "TestTable", "name": "TestTable",
"primaryFieldId": "fldj9Z3fEpLzv40d0", "primaryFieldId": "fldj9Z3fEpLzv40d0",
"fields": [ "fields": [
{ {
"type": "number", "type": "number",
"options": { "options": {
"precision": 0 "precision": 0
}, },
"id": "fldj9Z3fEpLzv40d0", "id": "fldj9Z3fEpLzv40d0",
"name": "Number" "name": "Number"
}, },
{ {
"type": "richText", "type": "richText",
"id": "fldX1kR7lienmcdEj", "id": "fldX1kR7lienmcdEj",
"name": "String" "name": "String"
} }
], ],
"views": [ "views": [
{ {
"id": "viwbKE3PS9jl6bqJl", "id": "viwbKE3PS9jl6bqJl",
"name": "Grid view", "name": "Grid view",
"type": "grid" "type": "grid"
} }
] ]
} }
] ]
} }
``` ```

180
docs/en/md/Airtable/Database-work/Get-list-of-bases.md
View File

@@ -1,90 +1,90 @@
--- ---
sidebar_position: 1 sidebar_position: 1
--- ---
# Get list of bases # Get list of bases
Gets the list of available bases Gets the list of available bases
*Function GetListOfBases(Val Token, Val Indent = "") Export* *Function GetListOfBases(Val Token, Val Indent = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Indent | --offset | String | Next page identifier of the base list from the previous request | | Indent | --offset | String | Next page identifier of the base list from the previous request |
Returns: Key-Value Pair - serialized JSON response from Airtable Returns: Key-Value Pair - serialized JSON response from Airtable
```bsl title="Code example" ```bsl title="Code example"
Response = OPI_Airtable.GetListOfBases(Token); //Map Response = OPI_Airtable.GetListOfBases(Token); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint airtable GetListOfBases --token %token% --offset %offset% oint airtable GetListOfBases --token %token% --offset %offset%
``` ```
```json title="Result" ```json title="Result"
{ {
"bases": [ "bases": [
{ {
"id": "appGarzKZ0lu3gzoa", "id": "appGarzKZ0lu3gzoa",
"name": "Test", "name": "Test",
"permissionLevel": "create" "permissionLevel": "create"
}, },
{ {
"id": "app9WRfJirwn3yXuG", "id": "app9WRfJirwn3yXuG",
"name": "Product catalog", "name": "Product catalog",
"permissionLevel": "create" "permissionLevel": "create"
}, },
{ {
"id": "app6gigUYTzlDEq4X", "id": "app6gigUYTzlDEq4X",
"name": "TestDatabase", "name": "TestDatabase",
"permissionLevel": "create" "permissionLevel": "create"
}, },
{ {
"id": "app5hJGyK8asYYe1Q", "id": "app5hJGyK8asYYe1Q",
"name": "TestDatabase", "name": "TestDatabase",
"permissionLevel": "create" "permissionLevel": "create"
}, },
{ {
"id": "appRQ6VxxOZb40Uwi", "id": "appRQ6VxxOZb40Uwi",
"name": "TestDatabase", "name": "TestDatabase",
"permissionLevel": "create" "permissionLevel": "create"
}, },
{ {
"id": "appM6FaGofV2XSfFA", "id": "appM6FaGofV2XSfFA",
"name": "TestDatabase", "name": "TestDatabase",
"permissionLevel": "create" "permissionLevel": "create"
}, },
{ {
"id": "apptm8Xqo7TwMaipQ", "id": "apptm8Xqo7TwMaipQ",
"name": "TestDatabase", "name": "TestDatabase",
"permissionLevel": "create" "permissionLevel": "create"
}, },
{ {
"id": "appsyQyGrF8aVN2Wm", "id": "appsyQyGrF8aVN2Wm",
"name": "TestDatabase", "name": "TestDatabase",
"permissionLevel": "create" "permissionLevel": "create"
}, },
{ {
"id": "applEsyJmBRm12AuN", "id": "applEsyJmBRm12AuN",
"name": "TestDatabase", "name": "TestDatabase",
"permissionLevel": "create" "permissionLevel": "create"
} }
] ]
} }
``` ```

8
docs/en/md/Airtable/Database-work/_category_.json
View File

@@ -1,4 +1,4 @@
{ {
"label": "Database work", "label": "Database work",
"position": "2" "position": "2"
} }

110
docs/en/md/Airtable/Field-work/Create-field.md
View File

@@ -1,55 +1,55 @@
--- ---
sidebar_position: 1 sidebar_position: 1
--- ---
# Create field # Create field
Creates a new field in the table Creates a new field in the table
*Function CreateField(Val Token, Val Base, Val Table, Val FieldStructure) Export* *Function CreateField(Val Token, Val Base, Val Table, Val FieldStructure) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Base | --base | String | Base identifier | | Base | --base | String | Base identifier |
| Table | --table | String | Table identifier | | Table | --table | String | Table identifier |
| FieldStructure | --fielddata | Structure of Key-Value | Description of the new field | | FieldStructure | --fielddata | Structure of Key-Value | Description of the new field |
Returns: Key-Value Pair - serialized JSON response from Airtable Returns: Key-Value Pair - serialized JSON response from Airtable
```bsl title="Code example" ```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ"; Base = "apptm8Xqo7TwMaipQ";
Table = "tbl9G4jVoTJpxYwSY"; Table = "tbl9G4jVoTJpxYwSY";
Name = String(New UUID); Name = String(New UUID);
Field = OPI_Airtable.GetNumberField(Name); Field = OPI_Airtable.GetNumberField(Name);
Response = OPI_Airtable.CreateField(Token, Base, Table, FieldStructure); //Map Response = OPI_Airtable.CreateField(Token, Base, Table, FieldStructure); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint airtable CreateField --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --fielddata %fielddata% oint airtable CreateField --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --fielddata %fielddata%
``` ```
```json title="Result" ```json title="Result"
{ {
"type": "number", "type": "number",
"options": { "options": {
"precision": 0 "precision": 0
}, },
"id": "fld3IbFtHZtBHQwsk", "id": "fld3IbFtHZtBHQwsk",
"name": "9c0d2a82-7bf9-40b7-8052-ae3ebadc72d5" "name": "9c0d2a82-7bf9-40b7-8052-ae3ebadc72d5"
} }
``` ```

90
docs/en/md/Airtable/Field-work/Get-attachment-field.md
View File

@@ -1,45 +1,45 @@
--- ---
sidebar_position: 5 sidebar_position: 5
--- ---
# Get field (file) # Get field (file)
Gets the description of a file field Gets the description of a file field
*Function GetAttachmentField(Val Name) ExportReturn PrimitiveFieldDescription(Name, "multipleAttachments");EndFunction* *Function GetAttachmentField(Val Name) ExportReturn PrimitiveFieldDescription(Name, "multipleAttachments");EndFunction*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Name | --title | String | Field name | | Name | --title | String | Field name |
Returns: Structure - Field description Returns: Structure - Field description
```bsl title="Code example" ```bsl title="Code example"
Name = "Attachment"; Name = "Attachment";
Response = OPI_Airtable.GetAttachmentField(Name); //Map Response = OPI_Airtable.GetAttachmentField(Name); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint airtable GetAttachmentField --title "Attachment" oint airtable GetAttachmentField --title "Attachment"
``` ```
```json title="Result" ```json title="Result"
{ {
"name": "Attachment", "name": "Attachment",
"type": "multipleAttachments" "type": "multipleAttachments"
} }
``` ```

98
docs/en/md/Airtable/Field-work/Get-checkbox-field.md
View File

@@ -1,49 +1,49 @@
--- ---
sidebar_position: 6 sidebar_position: 6
--- ---
# Get field (checkbox) # Get field (checkbox)
Gets the description of a boolean field Gets the description of a boolean field
*Function GetCheckboxField(Val Name) Export* *Function GetCheckboxField(Val Name) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Name | --title | String | Field name | | Name | --title | String | Field name |
Returns: Structure - Field description Returns: Structure - Field description
```bsl title="Code example" ```bsl title="Code example"
Name = "Checkbox"; Name = "Checkbox";
Response = OPI_Airtable.GetCheckboxField(Name); //Map Response = OPI_Airtable.GetCheckboxField(Name); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint airtable GetCheckboxField --title "Checkbox" oint airtable GetCheckboxField --title "Checkbox"
``` ```
```json title="Result" ```json title="Result"
{ {
"name": "Checkbox", "name": "Checkbox",
"type": "checkbox", "type": "checkbox",
"options": { "options": {
"icon": "check", "icon": "check",
"color": "yellowBright" "color": "yellowBright"
} }
} }
``` ```

102
docs/en/md/Airtable/Field-work/Get-date-field.md
View File

@@ -1,51 +1,51 @@
--- ---
sidebar_position: 7 sidebar_position: 7
--- ---
# Get field (date) # Get field (date)
Gets the description of a date field Gets the description of a date field
*Function GetDateField(Val Name) Export* *Function GetDateField(Val Name) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Name | --title | String | Field name | | Name | --title | String | Field name |
Returns: Structure - Field description Returns: Structure - Field description
```bsl title="Code example" ```bsl title="Code example"
Name = "Date"; Name = "Date";
Response = OPI_Airtable.GetDateField(Name); //Map Response = OPI_Airtable.GetDateField(Name); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint airtable GetDateField --title "Date" oint airtable GetDateField --title "Date"
``` ```
```json title="Result" ```json title="Result"
{ {
"name": "Date", "name": "Date",
"type": "date", "type": "date",
"options": { "options": {
"dateFormat": { "dateFormat": {
"format": "YYYY-MM-DD", "format": "YYYY-MM-DD",
"name": "iso" "name": "iso"
} }
} }
} }
``` ```

90
docs/en/md/Airtable/Field-work/Get-email-field.md
View File

@@ -1,45 +1,45 @@
--- ---
sidebar_position: 8 sidebar_position: 8
--- ---
# Get field (email) # Get field (email)
Gets the description of an email field Gets the description of an email field
*Function GetEmailField(Val Name) ExportReturn PrimitiveFieldDescription(Name, "email");EndFunction* *Function GetEmailField(Val Name) ExportReturn PrimitiveFieldDescription(Name, "email");EndFunction*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Name | --title | String | Field name | | Name | --title | String | Field name |
Returns: Structure - Field description Returns: Structure - Field description
```bsl title="Code example" ```bsl title="Code example"
Name = "Email"; Name = "Email";
Response = OPI_Airtable.GetEmailField(Name); //Map Response = OPI_Airtable.GetEmailField(Name); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint airtable GetEmailField --title "Email" oint airtable GetEmailField --title "Email"
``` ```
```json title="Result" ```json title="Result"
{ {
"name": "Email", "name": "Email",
"type": "email" "type": "email"
} }
``` ```

90
docs/en/md/Airtable/Field-work/Get-link-field.md
View File

@@ -1,45 +1,45 @@
--- ---
sidebar_position: 10 sidebar_position: 10
--- ---
# Get field (url) # Get field (url)
Gets the description of a URL field Gets the description of a URL field
*Function GetLinkField(Val Name) ExportReturn PrimitiveFieldDescription(Name, "url");EndFunction* *Function GetLinkField(Val Name) ExportReturn PrimitiveFieldDescription(Name, "url");EndFunction*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Name | --title | String | Field name | | Name | --title | String | Field name |
Returns: Structure - Field description Returns: Structure - Field description
```bsl title="Code example" ```bsl title="Code example"
Name = "Link"; Name = "Link";
Response = OPI_Airtable.GetLinkField(Name); //Map Response = OPI_Airtable.GetLinkField(Name); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint airtable GetLinkField --title "Link" oint airtable GetLinkField --title "Link"
``` ```
```json title="Result" ```json title="Result"
{ {
"name": "Link", "name": "Link",
"type": "url" "type": "url"
} }
``` ```

100
docs/en/md/Airtable/Field-work/Get-number-field.md
View File

@@ -1,50 +1,50 @@
--- ---
sidebar_position: 4 sidebar_position: 4
--- ---
# Get field (numeric) # Get field (numeric)
Gets the description of a numeric field Gets the description of a numeric field
*Function GetNumberField(Val Name, Val Precision = 0) Export* *Function GetNumberField(Val Name, Val Precision = 0) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Name | --title | String | New field name | | Name | --title | String | New field name |
| Precision | --precision | Number, String | Number of decimal places | | Precision | --precision | Number, String | Number of decimal places |
Returns: Structure - Field description Returns: Structure - Field description
```bsl title="Code example" ```bsl title="Code example"
Name = "Number"; Name = "Number";
Precision = "0"; Precision = "0";
Response = OPI_Airtable.GetNumberField(Name, Precision); //Map Response = OPI_Airtable.GetNumberField(Name, Precision); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint airtable GetNumberField --title "Number" --precision "0" oint airtable GetNumberField --title "Number" --precision "0"
``` ```
```json title="Result" ```json title="Result"
{ {
"name": "Number", "name": "Number",
"type": "number", "type": "number",
"options": { "options": {
"precision": 0 "precision": 0
} }
} }
``` ```

90
docs/en/md/Airtable/Field-work/Get-phone-field.md
View File

@@ -1,45 +1,45 @@
--- ---
sidebar_position: 9 sidebar_position: 9
--- ---
# Get field (phone) # Get field (phone)
Gets the description of a phone number field Gets the description of a phone number field
*Function GetPhoneField(Val Name) ExportReturn PrimitiveFieldDescription(Name, "phoneNumber");EndFunction* *Function GetPhoneField(Val Name) ExportReturn PrimitiveFieldDescription(Name, "phoneNumber");EndFunction*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Name | --title | String | Field name | | Name | --title | String | Field name |
Returns: Structure - Field description Returns: Structure - Field description
```bsl title="Code example" ```bsl title="Code example"
Name = "Phone"; Name = "Phone";
Response = OPI_Airtable.GetPhoneField(Name); //Map Response = OPI_Airtable.GetPhoneField(Name); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint airtable GetPhoneField --title "Phone" oint airtable GetPhoneField --title "Phone"
``` ```
```json title="Result" ```json title="Result"
{ {
"name": "Phone", "name": "Phone",
"type": "phoneNumber" "type": "phoneNumber"
} }
``` ```

90
docs/en/md/Airtable/Field-work/Get-string-field.md
View File

@@ -1,45 +1,45 @@
--- ---
sidebar_position: 3 sidebar_position: 3
--- ---
# Get field (string) # Get field (string)
Gets the description of a string field Gets the description of a string field
*Function GetStringField(Val Name) ExportReturn PrimitiveFieldDescription(Name, "richText");EndFunction* *Function GetStringField(Val Name) ExportReturn PrimitiveFieldDescription(Name, "richText");EndFunction*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Name | --title | String | New field name | | Name | --title | String | New field name |
Returns: Structure - Field description Returns: Structure - Field description
```bsl title="Code example" ```bsl title="Code example"
Name = "String"; Name = "String";
Response = OPI_Airtable.GetStringField(Name); //Map Response = OPI_Airtable.GetStringField(Name); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint airtable GetStringField --title "String" oint airtable GetStringField --title "String"
``` ```
```json title="Result" ```json title="Result"
{ {
"name": "String", "name": "String",
"type": "richText" "type": "richText"
} }
``` ```

118
docs/en/md/Airtable/Field-work/Modify-field.md
View File

@@ -1,59 +1,59 @@
--- ---
sidebar_position: 2 sidebar_position: 2
--- ---
# Modify field # Modify field
Changes the name and/or description of an existing table field Changes the name and/or description of an existing table field
*Function ModifyField(Val Token, Val Base, Val Table, Val Field, Val Name = "", Val Description = "") Export* *Function ModifyField(Val Token, Val Base, Val Table, Val Field, Val Name = "", Val Description = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Base | --base | String | Base identifier Base | | Base | --base | String | Base identifier Base |
| Table | --table | String | Table identifier | | Table | --table | String | Table identifier |
| Field | --field | String | Field identifier | | Field | --field | String | Field identifier |
| Name | --title | String | New name | | Name | --title | String | New name |
| Description | --description | String | New description | | Description | --description | String | New description |
Returns: Key-Value Pair - serialized JSON response from Airtable Returns: Key-Value Pair - serialized JSON response from Airtable
```bsl title="Code example" ```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ"; Base = "apptm8Xqo7TwMaipQ";
Table = "tbl9G4jVoTJpxYwSY"; Table = "tbl9G4jVoTJpxYwSY";
Field = "fld3IbFtHZtBHQwsk"; Field = "fld3IbFtHZtBHQwsk";
Name = String(New UUID) + "(change.)"; Name = String(New UUID) + "(change.)";
Description = "New description"; Description = "New description";
Response = OPI_Airtable.ModifyField(Token, Base, Table, Field, Name, Description); //Map Response = OPI_Airtable.ModifyField(Token, Base, Table, Field, Name, Description); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint airtable ModifyField --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --field "fld3IbFtHZtBHQwsk" --title %title% --description "New description" oint airtable ModifyField --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --field "fld3IbFtHZtBHQwsk" --title %title% --description "New description"
``` ```
```json title="Result" ```json title="Result"
{ {
"type": "number", "type": "number",
"options": { "options": {
"precision": 0 "precision": 0
}, },
"id": "fld3IbFtHZtBHQwsk", "id": "fld3IbFtHZtBHQwsk",
"name": "9c0d2a82-7bf9-40b7-8052-ae3ebadc72d5(change.)", "name": "9c0d2a82-7bf9-40b7-8052-ae3ebadc72d5(change.)",
"description": "New description" "description": "New description"
} }
``` ```

8
docs/en/md/Airtable/Field-work/_category_.json
View File

@@ -1,4 +1,4 @@
{ {
"label": "Field work", "label": "Field work",
"position": "4" "position": "4"
} }

148
docs/en/md/Airtable/Record-management/Create-posts.md
View File

@@ -1,74 +1,74 @@
--- ---
sidebar_position: 3 sidebar_position: 3
--- ---
# Create records # Create records
Creates one or an array of records by description or an array of field value descriptions Creates one or an array of records by description or an array of field value descriptions
*Function CreatePosts(Val Token, Val Base, Val Table, Val Data) Export* *Function CreatePosts(Val Token, Val Base, Val Table, Val Data) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Base | --base | String | Database identifier | | Base | --base | String | Database identifier |
| Table | --table | String | Table identifier | | Table | --table | String | Table identifier |
| Data | --data | Structure, Array of Structure | Set or array of sets of Key : Value pairs > Field : Indicator | | Data | --data | Structure, Array of Structure | Set or array of sets of Key : Value pairs > Field : Indicator |
Returns: Key-Value Pair - serialized JSON response from Airtable Returns: Key-Value Pair - serialized JSON response from Airtable
```bsl title="Code example" ```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ"; Base = "apptm8Xqo7TwMaipQ";
Table = "tbl9G4jVoTJpxYwSY"; Table = "tbl9G4jVoTJpxYwSY";
Numeric = 10; Numeric = 10;
StringType = "Hello"; StringType = "Hello";
RowDescription1 = New Structure("Number,String", Numeric, StringType); RowDescription1 = New Structure("Number,String", Numeric, StringType);
RowDescription2 = New Structure("Number,String", Numeric, StringType); RowDescription2 = New Structure("Number,String", Numeric, StringType);
Data = New Array; Data = New Array;
Data.Add(RowDescription1); Data.Add(RowDescription1);
Data.Add(RowDescription2); Data.Add(RowDescription2);
Response = OPI_Airtable.CreatePosts(Token, Base, Table, Data); //Map Response = OPI_Airtable.CreatePosts(Token, Base, Table, Data); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint airtable CreatePosts --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --data %data% oint airtable CreatePosts --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --data %data%
``` ```
```json title="Result" ```json title="Result"
{ {
"records": [ "records": [
{ {
"id": "recjHNKNZBWLZkZ7A", "id": "recjHNKNZBWLZkZ7A",
"createdTime": "2024-05-10T19:39:51Z", "createdTime": "2024-05-10T19:39:51Z",
"fields": { "fields": {
"Number": 10, "Number": 10,
"String": "Hello\n" "String": "Hello\n"
} }
}, },
{ {
"id": "recGyJ0MlN1H3GMuN", "id": "recGyJ0MlN1H3GMuN",
"createdTime": "2024-05-10T19:39:51Z", "createdTime": "2024-05-10T19:39:51Z",
"fields": { "fields": {
"Number": 10, "Number": 10,
"String": "Hello\n" "String": "Hello\n"
} }
} }
] ]
} }
``` ```

122
docs/en/md/Airtable/Record-management/Delete-posts.md
View File

@@ -1,61 +1,61 @@
--- ---
sidebar_position: 4 sidebar_position: 4
--- ---
# Delete records # Delete records
Deletes one or an array of records by identifiers Deletes one or an array of records by identifiers
*Function DeletePosts(Val Token, Val Base, Val Table, Val Records) Export* *Function DeletePosts(Val Token, Val Base, Val Table, Val Records) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Base | --base | String | Database identifier | | Base | --base | String | Database identifier |
| Table | --table | String | Table identifier | | Table | --table | String | Table identifier |
| Records | --records | String, Array of String | Identifier or array of record identifiers | | Records | --records | String, Array of String | Identifier or array of record identifiers |
Returns: Key-Value Pair - serialized JSON response from Airtable Returns: Key-Value Pair - serialized JSON response from Airtable
```bsl title="Code example" ```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ"; Base = "apptm8Xqo7TwMaipQ";
Table = "tbl9G4jVoTJpxYwSY"; Table = "tbl9G4jVoTJpxYwSY";
Records = New Array; Records = New Array;
Records.Add("recjHNKNZBWLZkZ7A"); Records.Add("recjHNKNZBWLZkZ7A");
Records.Add("recGyJ0MlN1H3GMuN"); Records.Add("recGyJ0MlN1H3GMuN");
Response = OPI_Airtable.DeletePosts(Token, Base, Table, Record); //Map Response = OPI_Airtable.DeletePosts(Token, Base, Table, Record); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint airtable DeletePosts --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --records %records% oint airtable DeletePosts --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --records %records%
``` ```
```json title="Result" ```json title="Result"
{ {
"records": [ "records": [
{ {
"deleted": true, "deleted": true,
"id": "recjHNKNZBWLZkZ7A" "id": "recjHNKNZBWLZkZ7A"
}, },
{ {
"deleted": true, "deleted": true,
"id": "recGyJ0MlN1H3GMuN" "id": "recGyJ0MlN1H3GMuN"
} }
] ]
} }
``` ```

146
docs/en/md/Airtable/Record-management/Get-list-of-records.md
View File

@@ -1,73 +1,73 @@
--- ---
sidebar_position: 1 sidebar_position: 1
--- ---
# Get list of records # Get list of records
Gets the list of records of the selected table Gets the list of records of the selected table
*Function GetListOfRecords(Val Token, Val Base, Val Table, Val Indent = "") Export* *Function GetListOfRecords(Val Token, Val Base, Val Table, Val Indent = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Base | --base | String | Database identifier | | Base | --base | String | Database identifier |
| Table | --table | String | Table identifier | | Table | --table | String | Table identifier |
| Indent | --offset | String | Next page identifier of data from the previous request | | Indent | --offset | String | Next page identifier of data from the previous request |
Returns: Key-Value Pair - serialized JSON response from Airtable Returns: Key-Value Pair - serialized JSON response from Airtable
```bsl title="Code example" ```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ"; Base = "apptm8Xqo7TwMaipQ";
Table = "tbl9G4jVoTJpxYwSY"; Table = "tbl9G4jVoTJpxYwSY";
Response = OPI_Airtable.GetListOfRecords(Token, Base, Table, Indent); //Map Response = OPI_Airtable.GetListOfRecords(Token, Base, Table, Indent); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint airtable GetListOfRecords --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --offset %offset% oint airtable GetListOfRecords --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --offset %offset%
``` ```
```json title="Result" ```json title="Result"
{ {
"records": [ "records": [
{ {
"id": "recGyJ0MlN1H3GMuN", "id": "recGyJ0MlN1H3GMuN",
"createdTime": "2024-05-10T19:39:51Z", "createdTime": "2024-05-10T19:39:51Z",
"fields": { "fields": {
"Number": 10, "Number": 10,
"String": "Hello\n" "String": "Hello\n"
} }
}, },
{ {
"id": "recV6DxeLQMBNJrUk", "id": "recV6DxeLQMBNJrUk",
"createdTime": "2024-05-10T19:39:51Z", "createdTime": "2024-05-10T19:39:51Z",
"fields": { "fields": {
"Number": 10, "Number": 10,
"String": "Hello\n" "String": "Hello\n"
} }
}, },
{ {
"id": "recjHNKNZBWLZkZ7A", "id": "recjHNKNZBWLZkZ7A",
"createdTime": "2024-05-10T19:39:51Z", "createdTime": "2024-05-10T19:39:51Z",
"fields": { "fields": {
"Number": 10, "Number": 10,
"String": "Hello\n" "String": "Hello\n"
} }
} }
] ]
} }
``` ```

108
docs/en/md/Airtable/Record-management/Get-record.md
View File

@@ -1,54 +1,54 @@
--- ---
sidebar_position: 2 sidebar_position: 2
--- ---
# Get record # Get record
Gets row data of the table by identifier Gets row data of the table by identifier
*Function GetRecord(Val Token, Val Base, Val Table, Val Record) Export* *Function GetRecord(Val Token, Val Base, Val Table, Val Record) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Base | --base | String | Database identifier | | Base | --base | String | Database identifier |
| Table | --table | String | Table identifier | | Table | --table | String | Table identifier |
| Record | --record | String | Record identifier in the table | | Record | --record | String | Record identifier in the table |
Returns: Key-Value Pair - serialized JSON response from Airtable Returns: Key-Value Pair - serialized JSON response from Airtable
```bsl title="Code example" ```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ"; Base = "apptm8Xqo7TwMaipQ";
Table = "tbl9G4jVoTJpxYwSY"; Table = "tbl9G4jVoTJpxYwSY";
Record = "recV6DxeLQMBNJrUk"; Record = "recV6DxeLQMBNJrUk";
Response = OPI_Airtable.GetRecord(Token, Base, Table, Record); //Map Response = OPI_Airtable.GetRecord(Token, Base, Table, Record); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint airtable GetRecord --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk" oint airtable GetRecord --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --record "recV6DxeLQMBNJrUk"
``` ```
```json title="Result" ```json title="Result"
{ {
"id": "recV6DxeLQMBNJrUk", "id": "recV6DxeLQMBNJrUk",
"createdTime": "2024-05-10T19:39:51Z", "createdTime": "2024-05-10T19:39:51Z",
"fields": { "fields": {
"Number": 10, "Number": 10,
"String": "Hello\n" "String": "Hello\n"
} }
} }
``` ```

8
docs/en/md/Airtable/Record-management/_category_.json
View File

@@ -1,4 +1,4 @@
{ {
"label": "Record management", "label": "Record management",
"position": "5" "position": "5"
} }

256
docs/en/md/Airtable/Table-management/Create-table.md
View File

@@ -1,128 +1,128 @@
--- ---
sidebar_position: 1 sidebar_position: 1
--- ---
# Create table # Create table
Creates a new table in the base Creates a new table in the base
*Function CreateTable(Val Token, Val Base, Val Name, Val FieldArray, Val Description = "") Export* *Function CreateTable(Val Token, Val Base, Val Name, Val FieldArray, Val Description = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Base | --base | String | Base identifier | | Base | --base | String | Base identifier |
| Name | --title | String | New table name | | Name | --title | String | New table name |
| FieldArray | --fieldsdata | Array of Structure | Array of field descriptions | | FieldArray | --fieldsdata | Array of Structure | Array of field descriptions |
| Description | --description | String | Table description | | Description | --description | String | Table description |
Returns: Key-Value Pair - serialized JSON response from Airtable Returns: Key-Value Pair - serialized JSON response from Airtable
```bsl title="Code example" ```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ"; Base = "apptm8Xqo7TwMaipQ";
TableName = "TestTable2"; TableName = "TestTable2";
Description = "NewTable"; Description = "NewTable";
FieldArray = New Array; FieldArray = New Array;
FieldArray.Add(OPI_Airtable.GetNumberField("Number")); FieldArray.Add(OPI_Airtable.GetNumberField("Number"));
FieldArray.Add(OPI_Airtable.GetStringField("String")); FieldArray.Add(OPI_Airtable.GetStringField("String"));
FieldArray.Add(OPI_Airtable.GetAttachmentField("Attachment")); FieldArray.Add(OPI_Airtable.GetAttachmentField("Attachment"));
FieldArray.Add(OPI_Airtable.GetCheckboxField("Checkbox")); FieldArray.Add(OPI_Airtable.GetCheckboxField("Checkbox"));
FieldArray.Add(OPI_Airtable.GetDateField("Date")); FieldArray.Add(OPI_Airtable.GetDateField("Date"));
FieldArray.Add(OPI_Airtable.GetPhoneField("Phone")); FieldArray.Add(OPI_Airtable.GetPhoneField("Phone"));
FieldArray.Add(OPI_Airtable.GetEmailField("Email")); FieldArray.Add(OPI_Airtable.GetEmailField("Email"));
FieldArray.Add(OPI_Airtable.GetLinkField("Link")); FieldArray.Add(OPI_Airtable.GetLinkField("Link"));
Response = OPI_Airtable.CreateTable(Token, Base, Name, FieldArray, Description); //Map Response = OPI_Airtable.CreateTable(Token, Base, Name, FieldArray, Description); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint airtable CreateTable --token %token% --base "apptm8Xqo7TwMaipQ" --title %title% --fieldsdata %fieldsdata% --description "NewTable" oint airtable CreateTable --token %token% --base "apptm8Xqo7TwMaipQ" --title %title% --fieldsdata %fieldsdata% --description "NewTable"
``` ```
```json title="Result" ```json title="Result"
{ {
"id": "tblT64aWyrMUAbUmF", "id": "tblT64aWyrMUAbUmF",
"name": "TestTable2", "name": "TestTable2",
"description": "NewTable", "description": "NewTable",
"primaryFieldId": "fldoHs3kv6RLc8pjo", "primaryFieldId": "fldoHs3kv6RLc8pjo",
"fields": [ "fields": [
{ {
"type": "number", "type": "number",
"options": { "options": {
"precision": 0 "precision": 0
}, },
"id": "fldoHs3kv6RLc8pjo", "id": "fldoHs3kv6RLc8pjo",
"name": "Number" "name": "Number"
}, },
{ {
"type": "richText", "type": "richText",
"id": "fldzY5xRHDY7ClKxa", "id": "fldzY5xRHDY7ClKxa",
"name": "String" "name": "String"
}, },
{ {
"type": "multipleAttachments", "type": "multipleAttachments",
"options": { "options": {
"isReversed": false "isReversed": false
}, },
"id": "fldYHxxXPALKl3yHp", "id": "fldYHxxXPALKl3yHp",
"name": "Attachment" "name": "Attachment"
}, },
{ {
"type": "checkbox", "type": "checkbox",
"options": { "options": {
"icon": "check", "icon": "check",
"color": "yellowBright" "color": "yellowBright"
}, },
"id": "fldRUoggUObfqckXh", "id": "fldRUoggUObfqckXh",
"name": "Checkbox" "name": "Checkbox"
}, },
{ {
"type": "date", "type": "date",
"options": { "options": {
"dateFormat": { "dateFormat": {
"name": "iso", "name": "iso",
"format": "YYYY-MM-DD" "format": "YYYY-MM-DD"
} }
}, },
"id": "fldvtwjapJM7s99nN", "id": "fldvtwjapJM7s99nN",
"name": "Date" "name": "Date"
}, },
{ {
"type": "phoneNumber", "type": "phoneNumber",
"id": "flda4VY8dVd2mbqz9", "id": "flda4VY8dVd2mbqz9",
"name": "Phone" "name": "Phone"
}, },
{ {
"type": "email", "type": "email",
"id": "fld8ZLKndqBIkT72s", "id": "fld8ZLKndqBIkT72s",
"name": "Email" "name": "Email"
}, },
{ {
"type": "url", "type": "url",
"id": "fldqjsCp1c2KaAS53", "id": "fldqjsCp1c2KaAS53",
"name": "Link" "name": "Link"
} }
], ],
"views": [ "views": [
{ {
"id": "viwX3vEGO5vB2Km4k", "id": "viwX3vEGO5vB2Km4k",
"name": "Grid view", "name": "Grid view",
"type": "grid" "type": "grid"
} }
] ]
} }
``` ```

238
docs/en/md/Airtable/Table-management/Modify-table.md
View File

@@ -1,119 +1,119 @@
--- ---
sidebar_position: 2 sidebar_position: 2
--- ---
# Modify table # Modify table
Changes the name and/or description of the base Changes the name and/or description of the base
*Function ModifyTable(Val Token, Val Base, Val Table, Val Name = "", Val Description = "") Export* *Function ModifyTable(Val Token, Val Base, Val Table, Val Name = "", Val Description = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Base | --base | String | Base identifier | | Base | --base | String | Base identifier |
| Table | --table | String | Table identifier | | Table | --table | String | Table identifier |
| Name | --title | String | New name | | Name | --title | String | New name |
| Description | --description | String | New description | | Description | --description | String | New description |
Returns: Key-Value Pair - serialized JSON response from Airtable Returns: Key-Value Pair - serialized JSON response from Airtable
```bsl title="Code example" ```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ"; Base = "apptm8Xqo7TwMaipQ";
Table = "tbl9G4jVoTJpxYwSY"; Table = "tbl9G4jVoTJpxYwSY";
Name = "Test table 2 (change.)"; Name = "Test table 2 (change.)";
Description = "New table (change.)"; Description = "New table (change.)";
Response = OPI_Airtable.ModifyTable(Token, Base, Table, Name, Description); //Map Response = OPI_Airtable.ModifyTable(Token, Base, Table, Name, Description); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint airtable ModifyTable --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --title "Test table 2 (change.)" --description "New table (change.)" oint airtable ModifyTable --token %token% --base "apptm8Xqo7TwMaipQ" --table "tbl9G4jVoTJpxYwSY" --title "Test table 2 (change.)" --description "New table (change.)"
``` ```
```json title="Result" ```json title="Result"
{ {
"id": "tblT64aWyrMUAbUmF", "id": "tblT64aWyrMUAbUmF",
"name": "Test table 2 (change.)", "name": "Test table 2 (change.)",
"description": "New table (change.)", "description": "New table (change.)",
"primaryFieldId": "fldoHs3kv6RLc8pjo", "primaryFieldId": "fldoHs3kv6RLc8pjo",
"fields": [ "fields": [
{ {
"id": "fldoHs3kv6RLc8pjo", "id": "fldoHs3kv6RLc8pjo",
"name": "Number", "name": "Number",
"type": "number", "type": "number",
"options": { "options": {
"precision": 0 "precision": 0
} }
}, },
{ {
"id": "fldzY5xRHDY7ClKxa", "id": "fldzY5xRHDY7ClKxa",
"name": "String", "name": "String",
"type": "richText" "type": "richText"
}, },
{ {
"id": "fldYHxxXPALKl3yHp", "id": "fldYHxxXPALKl3yHp",
"name": "Attachment", "name": "Attachment",
"type": "multipleAttachments", "type": "multipleAttachments",
"options": { "options": {
"isReversed": false "isReversed": false
} }
}, },
{ {
"id": "fldRUoggUObfqckXh", "id": "fldRUoggUObfqckXh",
"name": "Checkbox", "name": "Checkbox",
"type": "checkbox", "type": "checkbox",
"options": { "options": {
"icon": "check", "icon": "check",
"color": "yellowBright" "color": "yellowBright"
} }
}, },
{ {
"id": "fldvtwjapJM7s99nN", "id": "fldvtwjapJM7s99nN",
"name": "Date", "name": "Date",
"type": "date", "type": "date",
"options": { "options": {
"dateFormat": { "dateFormat": {
"name": "iso", "name": "iso",
"format": "YYYY-MM-DD" "format": "YYYY-MM-DD"
} }
} }
}, },
{ {
"id": "flda4VY8dVd2mbqz9", "id": "flda4VY8dVd2mbqz9",
"name": "Phone", "name": "Phone",
"type": "phoneNumber" "type": "phoneNumber"
}, },
{ {
"id": "fld8ZLKndqBIkT72s", "id": "fld8ZLKndqBIkT72s",
"name": "Email", "name": "Email",
"type": "email" "type": "email"
}, },
{ {
"id": "fldqjsCp1c2KaAS53", "id": "fldqjsCp1c2KaAS53",
"name": "Link", "name": "Link",
"type": "url" "type": "url"
} }
], ],
"views": [ "views": [
{ {
"id": "viwX3vEGO5vB2Km4k", "id": "viwX3vEGO5vB2Km4k",
"name": "Grid view", "name": "Grid view",
"type": "grid" "type": "grid"
} }
] ]
} }
``` ```

8
docs/en/md/Airtable/Table-management/_category_.json
View File

@@ -1,4 +1,4 @@
{ {
"label": "Table management", "label": "Table management",
"position": "3" "position": "3"
} }

16
docs/en/md/Airtable/_category_.json
View File

@@ -1,8 +1,8 @@
{ {
"label": "Airtable", "label": "Airtable",
"position": 11, "position": 11,
"link": { "link": {
"type": "doc", "type": "doc",
"id": "Airtable" "id": "Airtable"
} }
} }

128
docs/en/md/Dropbox/Account-and-authorization/Get-account-information.md
View File

@@ -1,64 +1,64 @@
--- ---
sidebar_position: 4 sidebar_position: 4
--- ---
# Get account information # Get account information
Gets account information Gets account information
*Function GetAccountInformation(Val Token, Val Account = "") Export* *Function GetAccountInformation(Val Token, Val Account = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Account | --account | String | Account ID. Current token account if not filled | | Account | --account | String | Account ID. Current token account if not filled |
Returns: Key-Value Pair - serialized JSON response from Dropbox Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example" ```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Result = OPI_Dropbox.GetAccountInformation(Token); Result = OPI_Dropbox.GetAccountInformation(Token);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint dropbox GetAccountInformation --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --account %account% oint dropbox GetAccountInformation --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --account %account%
``` ```
```json title="Result" ```json title="Result"
{ {
"account_id": "dbid:AAA4WKMCfgoW5LwuNQFeLOyp-X4omQiNDhE", "account_id": "dbid:AAA4WKMCfgoW5LwuNQFeLOyp-X4omQiNDhE",
"name": { "name": {
"given_name": "Anton", "given_name": "Anton",
"surname": "Titovets", "surname": "Titovets",
"familiar_name": "Anton", "familiar_name": "Anton",
"display_name": "Anton Titovets", "display_name": "Anton Titovets",
"abbreviated_name": "АТ" "abbreviated_name": "АТ"
}, },
"email": "bayselonarrend@gmail.com", "email": "bayselonarrend@gmail.com",
"email_verified": true, "email_verified": true,
"disabled": false, "disabled": false,
"country": "BY", "country": "BY",
"locale": "en", "locale": "en",
"referral_link": "https://www.dropbox.com/referrals/AADQceVD6l02CM1dzgLM7s_o8gdaPXKc7oM?src=app9-2724483", "referral_link": "https://www.dropbox.com/referrals/AADQceVD6l02CM1dzgLM7s_o8gdaPXKc7oM?src=app9-2724483",
"is_paired": false, "is_paired": false,
"account_type": { "account_type": {
".tag": "basic" ".tag": "basic"
}, },
"root_info": { "root_info": {
".tag": "user", ".tag": "user",
"root_namespace_id": "3179550035", "root_namespace_id": "3179550035",
"home_namespace_id": "3179550035" "home_namespace_id": "3179550035"
} }
} }
``` ```

76
docs/en/md/Dropbox/Account-and-authorization/Get-authorization-link.md
View File

@@ -1,38 +1,38 @@
--- ---
sidebar_position: 1 sidebar_position: 1
--- ---
# Get authorization link # Get authorization link
Generates an authorization link for browser transition Generates an authorization link for browser transition
*Function GetAuthorizationLink(Val AppKey) Export* *Function GetAuthorizationLink(Val AppKey) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| AppKey | --appkey | String | Application key | | AppKey | --appkey | String | Application key |
Returns: String - URL for browser transition Returns: String - URL for browser transition
```bsl title="Code example" ```bsl title="Code example"
AppKey = "oynqxds..."; AppKey = "oynqxds...";
Result = OPI_Dropbox.GetAuthorizationLink(AppKey); Result = OPI_Dropbox.GetAuthorizationLink(AppKey);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint dropbox GetAuthorizationLink --appkey "oynqxds..." oint dropbox GetAuthorizationLink --appkey "oynqxds..."
``` ```
```json title="Result" ```json title="Result"
"https://www.dropbox.com/oauth2/authorize?client_id=oynqxdsqft8oyky&response_type=code&token_access_type=offline" "https://www.dropbox.com/oauth2/authorize?client_id=oynqxdsqft8oyky&response_type=code&token_access_type=offline"
``` ```

90
docs/en/md/Dropbox/Account-and-authorization/Get-space-usage-data.md
View File

@@ -1,45 +1,45 @@
--- ---
sidebar_position: 5 sidebar_position: 5
--- ---
# Get space usage data # Get space usage data
Gets information on the amount of used disk space Gets information on the amount of used disk space
*Function GetSpaceUsageData(Val Token) Export* *Function GetSpaceUsageData(Val Token) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
Returns: Key-Value Pair - serialized JSON response from Dropbox Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example" ```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Result = OPI_Dropbox.GetSpaceUsageData(Token); Result = OPI_Dropbox.GetSpaceUsageData(Token);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint dropbox GetSpaceUsageData --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." oint dropbox GetSpaceUsageData --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."
``` ```
```json title="Result" ```json title="Result"
{ {
"used": 1477493597, "used": 1477493597,
"allocation": { "allocation": {
".tag": "individual", ".tag": "individual",
"allocated": 2147483648 "allocated": 2147483648
} }
} }
``` ```

92
docs/en/md/Dropbox/Account-and-authorization/Get-token.md
View File

@@ -1,46 +1,46 @@
--- ---
sidebar_position: 2 sidebar_position: 2
--- ---
# Get token # Get token
Gets token based on the code from the GetAuthorizationLink page Gets token based on the code from the GetAuthorizationLink page
*Function GetToken(Val AppKey, Val AppSecret, Val Code) Export* *Function GetToken(Val AppKey, Val AppSecret, Val Code) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| AppKey | --appkey | String | Application key | | AppKey | --appkey | String | Application key |
| AppSecret | --appsecret | String | Application secret | | AppSecret | --appsecret | String | Application secret |
| Code | --code | String | Code from the authorization page | | Code | --code | String | Code from the authorization page |
Returns: Key-Value Pair - serialized JSON response from Dropbox Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example" ```bsl title="Code example"
AppKey = "oynqxds..."; AppKey = "oynqxds...";
AppSecret = "tk2oewn..."; AppSecret = "tk2oewn...";
Code = "bTCiUTzxe6kAAAAAAAAAGN1NMZIxyqETKr4o7OS2dU8"; Code = "bTCiUTzxe6kAAAAAAAAAGN1NMZIxyqETKr4o7OS2dU8";
Result = OPI_Dropbox.GetToken(AppKey, AppSecret, Code); Result = OPI_Dropbox.GetToken(AppKey, AppSecret, Code);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint dropbox GetToken --appkey "oynqxds..." --appsecret "tk2oewn..." --code "bTCiUTzxe6kAAAAAAAAAGN1NMZIxyqETKr4o7OS2dU8" oint dropbox GetToken --appkey "oynqxds..." --appsecret "tk2oewn..." --code "bTCiUTzxe6kAAAAAAAAAGN1NMZIxyqETKr4o7OS2dU8"
``` ```
```json title="Result" ```json title="Result"
{ {
"error": "invalid_grant", "error": "invalid_grant",
"error_description": "code doesn't exist or has expired" "error_description": "code doesn't exist or has expired"
} }
``` ```

94
docs/en/md/Dropbox/Account-and-authorization/Refresh-token.md
View File

@@ -1,47 +1,47 @@
--- ---
sidebar_position: 3 sidebar_position: 3
--- ---
# Refresh token # Refresh token
Gets a new token based on the refresh token Gets a new token based on the refresh token
*Function RefreshToken(Val AppKey, Val AppSecret, Val RefreshToken) Export* *Function RefreshToken(Val AppKey, Val AppSecret, Val RefreshToken) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| AppKey | --appkey | String | Application key | | AppKey | --appkey | String | Application key |
| AppSecret | --appsecret | String | Application secret | | AppSecret | --appsecret | String | Application secret |
| RefreshToken | --refresh | String | Refresh token | | RefreshToken | --refresh | String | Refresh token |
Returns: Key-Value Pair - serialized JSON response from Dropbox Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example" ```bsl title="Code example"
AppKey = "oynqxds..."; AppKey = "oynqxds...";
AppSecret = "tk2oewn..."; AppSecret = "tk2oewn...";
RefreshToken = "oZFWg3DmZ_IAAAAAAAAAAWilOA0M1SjV..."; RefreshToken = "oZFWg3DmZ_IAAAAAAAAAAWilOA0M1SjV...";
Result = OPI_Dropbox.RefreshToken(AppKey, AppSecret, RefreshToken); Result = OPI_Dropbox.RefreshToken(AppKey, AppSecret, RefreshToken);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint dropbox RefreshToken --appkey "oynqxds..." --appsecret "tk2oewn..." --refresh "oZFWg3DmZ_IAAAAAAAAAAWilOA0M1SjV..." oint dropbox RefreshToken --appkey "oynqxds..." --appsecret "tk2oewn..." --refresh "oZFWg3DmZ_IAAAAAAAAAAWilOA0M1SjV..."
``` ```
```json title="Result" ```json title="Result"
{ {
"access_token": "sl.B2M8yVLTS_ojO3UsFs2tRlXxkFh50RLOkroi3SLCwcjA2xX58JY__GXKh9vPGnGcfDkkTJJYB1Wn9tFvj6cRs3w04TnfaBQnJiOfUb58UHexTCAdck9xNFIBAQjuAQKUtkoht66bvsu4oh6Wl6gQpvU", "access_token": "sl.B2M8yVLTS_ojO3UsFs2tRlXxkFh50RLOkroi3SLCwcjA2xX58JY__GXKh9vPGnGcfDkkTJJYB1Wn9tFvj6cRs3w04TnfaBQnJiOfUb58UHexTCAdck9xNFIBAQjuAQKUtkoht66bvsu4oh6Wl6gQpvU",
"token_type": "bearer", "token_type": "bearer",
"expires_in": 14400 "expires_in": 14400
} }
``` ```

8
docs/en/md/Dropbox/Account-and-authorization/_category_.json
View File

@@ -1,4 +1,4 @@
{ {
"label": "Account and authorization", "label": "Account and authorization",
"position": "2" "position": "2"
} }

114
docs/en/md/Dropbox/File-and-directory-management/Copy-object.md
View File

@@ -1,57 +1,57 @@
--- ---
sidebar_position: 8 sidebar_position: 8
--- ---
# Copy object # Copy object
Copies a file or directory to the selected path Copies a file or directory to the selected path
*Function CopyObject(Val Token, Val From, Val Target) Export* *Function CopyObject(Val Token, Val From, Val Target) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| From | --form | String | Path to the original object | | From | --form | String | Path to the original object |
| Target | --to | String | Target path for the new object | | Target | --to | String | Target path for the new object |
Returns: Key-Value Pair - serialized JSON response from Dropbox Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example" ```bsl title="Code example"
Original = "/New/pic.png"; Original = "/New/pic.png";
Copy = "/New/pic_copy.png"; Copy = "/New/pic_copy.png";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Result = OPI_Dropbox.CopyObject(Token, Original, Copy); Result = OPI_Dropbox.CopyObject(Token, Original, Copy);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint dropbox CopyObject --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --form %form% --to %to% oint dropbox CopyObject --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --form %form% --to %to%
``` ```
```json title="Result" ```json title="Result"
{ {
"metadata": { "metadata": {
".tag": "file", ".tag": "file",
"name": "pic_copy.png", "name": "pic_copy.png",
"path_lower": "/new/pic_copy.png", "path_lower": "/new/pic_copy.png",
"path_display": "/New/pic_copy.png", "path_display": "/New/pic_copy.png",
"id": "id:kJU6-a-pT48AAAAAAAABYg", "id": "id:kJU6-a-pT48AAAAAAAABYg",
"client_modified": "2024-05-30T12:32:09Z", "client_modified": "2024-05-30T12:32:09Z",
"server_modified": "2024-05-30T12:32:54Z", "server_modified": "2024-05-30T12:32:54Z",
"rev": "619ab10ed491ebd841553", "rev": "619ab10ed491ebd841553",
"size": 2114023, "size": 2114023,
"is_downloadable": true, "is_downloadable": true,
"content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492"
} }
} }
``` ```

96
docs/en/md/Dropbox/File-and-directory-management/Create-folder.md
View File

@@ -1,48 +1,48 @@
--- ---
sidebar_position: 10 sidebar_position: 10
--- ---
# Create folder # Create folder
Creates an empty directory at the selected path Creates an empty directory at the selected path
*Function CreateFolder(Val Token, Val Path) Export* *Function CreateFolder(Val Token, Val Path) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Path | --path | String | Target path for creating the directory | | Path | --path | String | Target path for creating the directory |
Returns: Key-Value Pair - serialized JSON response from Dropbox Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example" ```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Path = "/New catalog"; Path = "/New catalog";
Result = OPI_Dropbox.CreateFolder(Token, Path); Result = OPI_Dropbox.CreateFolder(Token, Path);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint dropbox CreateFolder --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% oint dropbox CreateFolder --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path%
``` ```
```json title="Result" ```json title="Result"
{ {
"metadata": { "metadata": {
"name": "New catalog", "name": "New catalog",
"path_lower": "/new catalog", "path_lower": "/new catalog",
"path_display": "/New catalog", "path_display": "/New catalog",
"id": "id:kJU6-a-pT48AAAAAAAABZA" "id": "id:kJU6-a-pT48AAAAAAAABZA"
} }
} }
``` ```

112
docs/en/md/Dropbox/File-and-directory-management/Delete-object.md
View File

@@ -1,56 +1,56 @@
--- ---
sidebar_position: 7 sidebar_position: 7
--- ---
# Delete object # Delete object
Deletes an object from the cloud drive Deletes an object from the cloud drive
*Function DeleteObject(Val Token, Val Path, Val Irrecoverable = False) Export* *Function DeleteObject(Val Token, Val Path, Val Irrecoverable = False) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Path | --path | String | Path to the object to delete | | Path | --path | String | Path to the object to delete |
| Irrecoverable | --permanently | String | Delete object without the possibility of recovery | | Irrecoverable | --permanently | String | Delete object without the possibility of recovery |
Returns: Key-Value Pair - serialized JSON response from Dropbox Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example" ```bsl title="Code example"
Path = "/New/pic.png"; Path = "/New/pic.png";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Result = OPI_Dropbox.DeleteObject(Token, Path); Result = OPI_Dropbox.DeleteObject(Token, Path);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint dropbox DeleteObject --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --permanently %permanently% oint dropbox DeleteObject --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --permanently %permanently%
``` ```
```json title="Result" ```json title="Result"
{ {
"metadata": { "metadata": {
".tag": "file", ".tag": "file",
"name": "pic.png", "name": "pic.png",
"path_lower": "/new/pic.png", "path_lower": "/new/pic.png",
"path_display": "/New/pic.png", "path_display": "/New/pic.png",
"id": "id:kJU6-a-pT48AAAAAAAABYA", "id": "id:kJU6-a-pT48AAAAAAAABYA",
"client_modified": "2024-05-30T12:32:09Z", "client_modified": "2024-05-30T12:32:09Z",
"server_modified": "2024-05-30T12:32:48Z", "server_modified": "2024-05-30T12:32:48Z",
"rev": "619ab108e3d3dbd841553", "rev": "619ab108e3d3dbd841553",
"size": 2114023, "size": 2114023,
"is_downloadable": true, "is_downloadable": true,
"content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492"
} }
} }
``` ```

82
docs/en/md/Dropbox/File-and-directory-management/Download-file.md
View File

@@ -1,41 +1,41 @@
--- ---
sidebar_position: 11 sidebar_position: 11
--- ---
# Download file # Download file
Downloads a file by the specified path or ID Downloads a file by the specified path or ID
*Function DownloadFile(Val Token, Val Path) Export* *Function DownloadFile(Val Token, Val Path) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Path | --path | String | Path or ID of the file | | Path | --path | String | Path or ID of the file |
Returns: BinaryData - binary data of the file Returns: BinaryData - binary data of the file
```bsl title="Code example" ```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Path = "/New/pic.png"; Path = "/New/pic.png";
Result = OPI_Dropbox.DownloadFile(Token, Path); Result = OPI_Dropbox.DownloadFile(Token, Path);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint dropbox DownloadFile --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% oint dropbox DownloadFile --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path%
``` ```
```json title="Result" ```json title="Result"
NOT JSON: FF D8 FF E1 54 C1 45 78 69 66 00 00 49 49 2A 00 08 00 00 00 0B 00 0E 01 02 00 20 00 00 00 92 00 00 00 0F 01 02 00 05 00 00 00 B2 00 00 00 10 01 02 00 07 00 00 00 B8 00 00 00 12 01 03 00 01 00… NOT JSON: FF D8 FF E1 54 C1 45 78 69 66 00 00 49 49 2A 00 08 00 00 00 0B 00 0E 01 02 00 20 00 00 00 92 00 00 00 0F 01 02 00 05 00 00 00 B2 00 00 00 10 01 02 00 07 00 00 00 B8 00 00 00 12 01 03 00 01 00…
``` ```

82
docs/en/md/Dropbox/File-and-directory-management/Download-folder.md
View File

@@ -1,41 +1,41 @@
--- ---
sidebar_position: 12 sidebar_position: 12
--- ---
# Download folder # Download folder
Downloads a zip archive with the contents of the specified directory Downloads a zip archive with the contents of the specified directory
*Function DownloadFolder(Val Token, Val Path) Export* *Function DownloadFolder(Val Token, Val Path) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Path | --path | String | Path or ID of the directory | | Path | --path | String | Path or ID of the directory |
Returns: BinaryData - binary data of the zip archive with the contents of the directory Returns: BinaryData - binary data of the zip archive with the contents of the directory
```bsl title="Code example" ```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Path = "/New"; Path = "/New";
Result = OPI_Dropbox.DownloadFolder(Token, Path); Result = OPI_Dropbox.DownloadFolder(Token, Path);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint dropbox DownloadFolder --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% oint dropbox DownloadFolder --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path%
``` ```
```json title="Result" ```json title="Result"
NOT JSON: 50 4B 03 04 14 00 00 08 00 00 36 3D BE 58 00 00 00 00 00 00 00 00 00 00 00 00 04 00 09 00 4E 65 77 2F 55 54 05 00 01 B9 2D 58 66 50 4B 03 04 14 00 08 08 00 00 4F 87 AF 58 00 00 00 00 00 00 00… NOT JSON: 50 4B 03 04 14 00 00 08 00 00 36 3D BE 58 00 00 00 00 00 00 00 00 00 00 00 00 04 00 09 00 4E 65 77 2F 55 54 05 00 01 B9 2D 58 66 50 4B 03 04 14 00 08 08 00 00 4F 87 AF 58 00 00 00 00 00 00 00…
``` ```

86
docs/en/md/Dropbox/File-and-directory-management/Get-list-of-folder-files.md
View File

@@ -1,43 +1,43 @@
--- ---
sidebar_position: 2 sidebar_position: 2
--- ---
# Get list of folder files # Get list of folder files
Gets the list of the first files in the directory or continues getting the next ones when the cursor is specified Gets the list of the first files in the directory or continues getting the next ones when the cursor is specified
*Function GetListOfFolderFiles(Val Token, Val Path = "", Val Detailed = False, Val Cursor = "") Export* *Function GetListOfFolderFiles(Val Token, Val Path = "", Val Detailed = False, Val Cursor = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Path | --path | String | Path to the directory. Optional if the cursor is specified | | Path | --path | String | Path to the directory. Optional if the cursor is specified |
| Detailed | --detail | Boolean | Adds additional information fields for media files | | Detailed | --detail | Boolean | Adds additional information fields for media files |
| Cursor | --cursor | String | Cursor from the previous request to get the next set of files | | Cursor | --cursor | String | Cursor from the previous request to get the next set of files |
Returns: HTTPResponse - Get list of folder files Returns: HTTPResponse - Get list of folder files
```bsl title="Code example" ```bsl title="Code example"
Path = "/New"; Path = "/New";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Result = OPI_Dropbox.GetListOfFolderFiles(Token, Path, True); Result = OPI_Dropbox.GetListOfFolderFiles(Token, Path, True);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint dropbox GetListOfFolderFiles --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --detail %detail% --cursor %cursor% oint dropbox GetListOfFolderFiles --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --detail %detail% --cursor %cursor%
``` ```
```json title="Result" ```json title="Result"
``` ```

108
docs/en/md/Dropbox/File-and-directory-management/Get-object-information.md
View File

@@ -1,54 +1,54 @@
--- ---
sidebar_position: 1 sidebar_position: 1
--- ---
# Get object information # Get object information
Gets information about a file or directory Gets information about a file or directory
*Function GetObjectInformation(Val Token, Val Path, Val Detailed = False) Export* *Function GetObjectInformation(Val Token, Val Path, Val Detailed = False) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Path | --path | String | Path to the object | | Path | --path | String | Path to the object |
| Detailed | --detail | Boolean | Adds additional information fields for media files | | Detailed | --detail | Boolean | Adds additional information fields for media files |
Returns: Key-Value Pair - serialized JSON response from Dropbox Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example" ```bsl title="Code example"
Path = "/New/pic.png"; Path = "/New/pic.png";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Result = OPI_Dropbox.GetObjectInformation(Token, Path, True); Result = OPI_Dropbox.GetObjectInformation(Token, Path, True);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint dropbox GetObjectInformation --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --detail %detail% oint dropbox GetObjectInformation --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --detail %detail%
``` ```
```json title="Result" ```json title="Result"
{ {
".tag": "file", ".tag": "file",
"name": "pic.png", "name": "pic.png",
"path_lower": "/new/pic.png", "path_lower": "/new/pic.png",
"path_display": "/New/pic.png", "path_display": "/New/pic.png",
"id": "id:kJU6-a-pT48AAAAAAAABYA", "id": "id:kJU6-a-pT48AAAAAAAABYA",
"client_modified": "2024-05-30T12:32:09Z", "client_modified": "2024-05-30T12:32:09Z",
"server_modified": "2024-05-30T12:32:09Z", "server_modified": "2024-05-30T12:32:09Z",
"rev": "619ab0e44a57cbd841553", "rev": "619ab0e44a57cbd841553",
"size": 2114023, "size": 2114023,
"is_downloadable": true, "is_downloadable": true,
"content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492"
} }
``` ```

116
docs/en/md/Dropbox/File-and-directory-management/Get-object-version-list.md
View File

@@ -1,58 +1,58 @@
--- ---
sidebar_position: 13 sidebar_position: 13
--- ---
# Get list of object versions # Get list of object versions
Gets the list of versions (revisions) of the object Gets the list of versions (revisions) of the object
*Function GetObjectVersionList(Val Token, Val Path, Val Count = 10) Export* *Function GetObjectVersionList(Val Token, Val Path, Val Count = 10) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Path | --path | String | Path to the object | | Path | --path | String | Path to the object |
| Count | --amount | String, Number | Number of the latest versions of the object to display | | Count | --amount | String, Number | Number of the latest versions of the object to display |
Returns: Key-Value Pair - serialized JSON response from Dropbox Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example" ```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Path = "/New/pic.png"; Path = "/New/pic.png";
Result = OPI_Dropbox.GetObjectVersionList(Token, Path, 1); Result = OPI_Dropbox.GetObjectVersionList(Token, Path, 1);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint dropbox GetObjectVersionList --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --amount %amount% oint dropbox GetObjectVersionList --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --amount %amount%
``` ```
```json title="Result" ```json title="Result"
{ {
"is_deleted": false, "is_deleted": false,
"entries": [ "entries": [
{ {
"name": "pic.png", "name": "pic.png",
"path_lower": "/new/pic.png", "path_lower": "/new/pic.png",
"path_display": "/New/pic.png", "path_display": "/New/pic.png",
"id": "id:kJU6-a-pT48AAAAAAAABYA", "id": "id:kJU6-a-pT48AAAAAAAABYA",
"client_modified": "2024-05-30T12:32:09Z", "client_modified": "2024-05-30T12:32:09Z",
"server_modified": "2024-05-30T12:32:09Z", "server_modified": "2024-05-30T12:32:09Z",
"rev": "619ab0e44a57cbd841553", "rev": "619ab0e44a57cbd841553",
"size": 2114023, "size": 2114023,
"is_downloadable": true, "is_downloadable": true,
"content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492"
} }
] ]
} }
``` ```

82
docs/en/md/Dropbox/File-and-directory-management/Get-preview.md
View File

@@ -1,41 +1,41 @@
--- ---
sidebar_position: 3 sidebar_position: 3
--- ---
# Get preview # Get preview
Gets PDF or HTML preview of the object (for documents only) Gets PDF or HTML preview of the object (for documents only)
*Function GetPreview(Val Token, Val Path) Export* *Function GetPreview(Val Token, Val Path) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Path | --path | String | Path to the object | | Path | --path | String | Path to the object |
Returns: BinaryData - document preview Returns: BinaryData - document preview
```bsl title="Code example" ```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Path = "/New/mydoc.docx"; Path = "/New/mydoc.docx";
Result = OPI_Dropbox.GetPreview(Token, Path); Result = OPI_Dropbox.GetPreview(Token, Path);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint dropbox GetPreview --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% oint dropbox GetPreview --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path%
``` ```
```json title="Result" ```json title="Result"
NOT JSON: 25 50 44 46 2D 31 2E 35 0D 0A 25 B5 B5 B5 B5 0D 0A 31 20 30 20 6F 62 6A 0D 0A 3C 3C 2F 54 79 70 65 2F 43 61 74 61 6C 6F 67 2F 50 61 67 65 73 20 32 20 30 20 52 2F 4C 61 6E 67 28 65 6E 2D 55 53… NOT JSON: 25 50 44 46 2D 31 2E 35 0D 0A 25 B5 B5 B5 B5 0D 0A 31 20 30 20 6F 62 6A 0D 0A 3C 3C 2F 54 79 70 65 2F 43 61 74 61 6C 6F 67 2F 50 61 67 65 73 20 32 20 30 20 52 2F 4C 61 6E 67 28 65 6E 2D 55 53…
``` ```

124
docs/en/md/Dropbox/File-and-directory-management/Get-upload-status-by-url.md
View File

@@ -1,62 +1,62 @@
--- ---
sidebar_position: 6 sidebar_position: 6
--- ---
# Get upload status by URL # Get upload status by URL
Gets the upload status of the file by URL Gets the upload status of the file by URL
*Function GetUploadStatusByURL(Val Token, Val JobID) Export* *Function GetUploadStatusByURL(Val Token, Val JobID) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| JobID | --job | String | ID of the asynchronous job from the UploadFileByURL response | | JobID | --job | String | ID of the asynchronous job from the UploadFileByURL response |
Returns: Key-Value Pair - serialized JSON response from Dropbox Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example" ```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
WorkID = "G8YbueOu2nsAAAAAAAAAAQ"; WorkID = "G8YbueOu2nsAAAAAAAAAAQ";
Status = "in_progress"; Status = "in_progress";
WHile Status = "in_progress" Do WHile Status = "in_progress" Do
Result = OPI_Dropbox.GetUploadStatusByURL(Token, WorkID); Result = OPI_Dropbox.GetUploadStatusByURL(Token, WorkID);
Status = Result[".tag"]; Status = Result[".tag"];
OPI_Tools.Pause(5); OPI_Tools.Pause(5);
EndDo; EndDo;
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint dropbox GetUploadStatusByURL --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --job %job% oint dropbox GetUploadStatusByURL --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --job %job%
``` ```
```json title="Result" ```json title="Result"
{ {
".tag": "complete", ".tag": "complete",
"name": "url_doc.docx", "name": "url_doc.docx",
"path_lower": "/new/url_doc.docx", "path_lower": "/new/url_doc.docx",
"path_display": "/New/url_doc.docx", "path_display": "/New/url_doc.docx",
"id": "id:kJU6-a-pT48AAAAAAAABYw", "id": "id:kJU6-a-pT48AAAAAAAABYw",
"client_modified": "2024-05-30T12:33:07Z", "client_modified": "2024-05-30T12:33:07Z",
"server_modified": "2024-05-30T12:33:08Z", "server_modified": "2024-05-30T12:33:08Z",
"rev": "619ab11c37fb9bd841553", "rev": "619ab11c37fb9bd841553",
"size": 24069, "size": 24069,
"is_downloadable": true, "is_downloadable": true,
"content_hash": "8d63c5989ceec1a90f3fde2ffaa76efcd2c050191e6b55a1761e4e352590bd8c" "content_hash": "8d63c5989ceec1a90f3fde2ffaa76efcd2c050191e6b55a1761e4e352590bd8c"
} }
``` ```

86
docs/en/md/Dropbox/File-and-directory-management/Move-object.md
View File

@@ -1,43 +1,43 @@
--- ---
sidebar_position: 9 sidebar_position: 9
--- ---
# Move object # Move object
Moves an object to the selected path Moves an object to the selected path
*Function MoveObject(Val Token, Val From, Val Target) Export* *Function MoveObject(Val Token, Val From, Val Target) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| From | --form | String | Path to the original object | | From | --form | String | Path to the original object |
| Target | --to | String | Target path for the new object | | Target | --to | String | Target path for the new object |
Returns: Key-Value Pair - serialized JSON response from Dropbox Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example" ```bsl title="Code example"
OriginalPath = "/New/pic.png"; OriginalPath = "/New/pic.png";
TargetPath = "/pic.png"; TargetPath = "/pic.png";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Result = OPI_Dropbox.MoveObject(Token, OriginalPath, TargetPath); Result = OPI_Dropbox.MoveObject(Token, OriginalPath, TargetPath);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint dropbox MoveObject --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --form %form% --to %to% oint dropbox MoveObject --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --form %form% --to %to%
``` ```
```json title="Result" ```json title="Result"
``` ```

108
docs/en/md/Dropbox/File-and-directory-management/Restore-object-to-version.md
View File

@@ -1,54 +1,54 @@
--- ---
sidebar_position: 14 sidebar_position: 14
--- ---
# Restore object to version # Restore object to version
Restores object state to required version (revision) Restores object state to required version (revision)
*Function RestoreObjectToVersion(Val Token, Val Path, Val Version) Export* *Function RestoreObjectToVersion(Val Token, Val Path, Val Version) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Path | --path | String | Path to the object | | Path | --path | String | Path to the object |
| Version | --rev | String | ID of the version (revision) for restoration | | Version | --rev | String | ID of the version (revision) for restoration |
Returns: Key-Value Pair - serialized JSON response from Dropbox Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example" ```bsl title="Code example"
Version = "61a0b76320a6fbd841553"; Version = "61a0b76320a6fbd841553";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Path = "/New/pic.png"; Path = "/New/pic.png";
Result = OPI_Dropbox.RestoreObjectToVersion(Token, Path, Version); Result = OPI_Dropbox.RestoreObjectToVersion(Token, Path, Version);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint dropbox RestoreObjectToVersion --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --rev "61a0b76320a6fbd841553" oint dropbox RestoreObjectToVersion --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --rev "61a0b76320a6fbd841553"
``` ```
```json title="Result" ```json title="Result"
{ {
"name": "pic.png", "name": "pic.png",
"path_lower": "/new/pic.png", "path_lower": "/new/pic.png",
"path_display": "/New/pic.png", "path_display": "/New/pic.png",
"id": "id:kJU6-a-pT48AAAAAAAABYA", "id": "id:kJU6-a-pT48AAAAAAAABYA",
"client_modified": "2024-05-30T12:32:09Z", "client_modified": "2024-05-30T12:32:09Z",
"server_modified": "2024-05-30T12:32:09Z", "server_modified": "2024-05-30T12:32:09Z",
"rev": "619ab0e44a57cbd841553", "rev": "619ab0e44a57cbd841553",
"size": 2114023, "size": 2114023,
"is_downloadable": true, "is_downloadable": true,
"content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492"
} }
``` ```

92
docs/en/md/Dropbox/File-and-directory-management/Upload-file-by-url.md
View File

@@ -1,46 +1,46 @@
--- ---
sidebar_position: 5 sidebar_position: 5
--- ---
# Upload file by URL # Upload file by URL
Uploads a file to the cloud drive by fetching it from the specified URL Uploads a file to the cloud drive by fetching it from the specified URL
*Function UploadFileByURL(Val Token, Val FileURL, Val Path) Export* *Function UploadFileByURL(Val Token, Val FileURL, Val Path) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| FileURL | --url | String | URL source of the file | | FileURL | --url | String | URL source of the file |
| Path | --path | String | Save path on Dropbox | | Path | --path | String | Save path on Dropbox |
Returns: Key-Value Pair - serialized JSON response from Dropbox Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example" ```bsl title="Code example"
Path = "/New/url_doc.docx"; Path = "/New/url_doc.docx";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
URL = "https://openintegrations.dev/test_data/document.docx"; URL = "https://openintegrations.dev/test_data/document.docx";
Result = OPI_Dropbox.UploadFileByURL(Token, URL, Path); Result = OPI_Dropbox.UploadFileByURL(Token, URL, Path);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint dropbox UploadFileByURL --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --url %url% --path %path% oint dropbox UploadFileByURL --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --url %url% --path %path%
``` ```
```json title="Result" ```json title="Result"
{ {
".tag": "async_job_id", ".tag": "async_job_id",
"async_job_id": "41d0vPCn2mYAAAAAAAAAAQ" "async_job_id": "41d0vPCn2mYAAAAAAAAAAQ"
} }
``` ```

116
docs/en/md/Dropbox/File-and-directory-management/Upload-file.md
View File

@@ -1,58 +1,58 @@
--- ---
sidebar_position: 4 sidebar_position: 4
--- ---
# Upload file # Upload file
Uploads a file to the cloud drive Uploads a file to the cloud drive
*Function UploadFile(Val Token, Val File, Val Path, Val Overwrite = False) Export* *Function UploadFile(Val Token, Val File, Val Path, Val Overwrite = False) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| File | --file | String, BinaryData | Data file for upload | | File | --file | String, BinaryData | Data file for upload |
| Path | --path | String | Save path on Dropbox | | Path | --path | String | Save path on Dropbox |
| Overwrite | --overwrite | Boolean | Overwrite file in case of path conflicts | | Overwrite | --overwrite | Boolean | Overwrite file in case of path conflicts |
Returns: Key-Value Pair - serialized JSON response from Dropbox Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example" ```bsl title="Code example"
Path = "/New/pic.png"; Path = "/New/pic.png";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Image = "https://openintegrations.dev/test_data/picture.jpg"; Image = "https://openintegrations.dev/test_data/picture.jpg";
ImagePath = GetTempFileName("png"); ImagePath = GetTempFileName("png");
CopyFile(Image, ImagePath); CopyFile(Image, ImagePath);
Result = OPI_Dropbox.UploadFile(Token, ImagePath, Path, True); Result = OPI_Dropbox.UploadFile(Token, ImagePath, Path, True);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint dropbox UploadFile --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --file %file% --path %path% --overwrite %overwrite% oint dropbox UploadFile --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --file %file% --path %path% --overwrite %overwrite%
``` ```
```json title="Result" ```json title="Result"
{ {
"name": "pic.png", "name": "pic.png",
"path_lower": "/new/pic.png", "path_lower": "/new/pic.png",
"path_display": "/New/pic.png", "path_display": "/New/pic.png",
"id": "id:kJU6-a-pT48AAAAAAAABYA", "id": "id:kJU6-a-pT48AAAAAAAABYA",
"client_modified": "2024-05-30T12:32:09Z", "client_modified": "2024-05-30T12:32:09Z",
"server_modified": "2024-05-30T12:32:09Z", "server_modified": "2024-05-30T12:32:09Z",
"rev": "619ab0e44a57cbd841553", "rev": "619ab0e44a57cbd841553",
"size": 2114023, "size": 2114023,
"is_downloadable": true, "is_downloadable": true,
"content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492" "content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492"
} }
``` ```

8
docs/en/md/Dropbox/File-and-directory-management/_category_.json
View File

@@ -1,4 +1,4 @@
{ {
"label": "File and directory management", "label": "File and directory management",
"position": "3" "position": "3"
} }

88
docs/en/md/Dropbox/Shared-access-settings/Add-users-to-file.md
View File

@@ -1,44 +1,44 @@
--- ---
sidebar_position: 3 sidebar_position: 3
--- ---
# Add user to file # Add user to file
Defines access to the file for an external user Defines access to the file for an external user
*Function AddUsersToFile(Val Token, Val FileID, Val EmailAddresses, Val ViewOnly = True) Export* *Function AddUsersToFile(Val Token, Val FileID, Val EmailAddresses, Val ViewOnly = True) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| FileID | --fileid | String | ID of the file to be accessed | | FileID | --fileid | String | ID of the file to be accessed |
| EmailAddresses | --emails | String, Array of String | List of email addresses of users being added | | EmailAddresses | --emails | String, Array of String | List of email addresses of users being added |
| ViewOnly | --readonly | Boolean | Prohibits file editing for the external user | | ViewOnly | --readonly | Boolean | Prohibits file editing for the external user |
Returns: Key-Value Pair - serialized JSON response from Dropbox Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example" ```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Email = "h5bk6ft62s@privaterelay.appleid.com"; Email = "h5bk6ft62s@privaterelay.appleid.com";
File = "kJU6-a-pT48AAAAAAAAABw"; File = "kJU6-a-pT48AAAAAAAAABw";
Result = OPI_Dropbox.AddUsersToFile(Token, File, Email, False); Result = OPI_Dropbox.AddUsersToFile(Token, File, Email, False);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint dropbox AddUsersToFile --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --fileid %fileid% --emails %emails% --readonly %readonly% oint dropbox AddUsersToFile --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --fileid %fileid% --emails %emails% --readonly %readonly%
``` ```
```json title="Result" ```json title="Result"
``` ```

88
docs/en/md/Dropbox/Shared-access-settings/Add-users-to-folder.md
View File

@@ -1,44 +1,44 @@
--- ---
sidebar_position: 4 sidebar_position: 4
--- ---
# Add users to folder # Add users to folder
Grants external users access to the directory Grants external users access to the directory
*Function AddUsersToFolder(Val Token, Val FolderID, Val EmailAddresses, Val ViewOnly = True) Export* *Function AddUsersToFolder(Val Token, Val FolderID, Val EmailAddresses, Val ViewOnly = True) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| FolderID | --folder | String | ID of the public catalog (shared folder ID) | | FolderID | --folder | String | ID of the public catalog (shared folder ID) |
| EmailAddresses | --emails | String, Array of String | List of email addresses of users being added | | EmailAddresses | --emails | String, Array of String | List of email addresses of users being added |
| ViewOnly | --readonly | Boolean | Prohibits file editing for the external user | | ViewOnly | --readonly | Boolean | Prohibits file editing for the external user |
Returns: Undefined - empty response Returns: Undefined - empty response
```bsl title="Code example" ```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Email = "h5bk6ft62s@privaterelay.appleid.com"; Email = "h5bk6ft62s@privaterelay.appleid.com";
Folder = "5022319569"; // shared_folder_id Folder = "5022319569"; // shared_folder_id
Result = OPI_Dropbox.AddUsersToFolder(Token, Folder, Email, False); Result = OPI_Dropbox.AddUsersToFolder(Token, Folder, Email, False);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint dropbox AddUsersToFolder --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --folder %folder% --emails %emails% --readonly %readonly% oint dropbox AddUsersToFolder --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --folder %folder% --emails %emails% --readonly %readonly%
``` ```
```json title="Result" ```json title="Result"
``` ```

82
docs/en/md/Dropbox/Shared-access-settings/Cancel-file-publication.md
View File

@@ -1,41 +1,41 @@
--- ---
sidebar_position: 6 sidebar_position: 6
--- ---
# Unpublish file # Unpublish file
Prohibits access to the file for external users Prohibits access to the file for external users
*Function CancelFilePublication(Val Token, Val FileID) Export* *Function CancelFilePublication(Val Token, Val FileID) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| FileID | --fileid | String | ID of the file to be accessed | | FileID | --fileid | String | ID of the file to be accessed |
Returns: Key-Value Pair - serialized JSON response from Dropbox Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example" ```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
File = "kJU6-a-pT48AAAAAAAAABw"; File = "kJU6-a-pT48AAAAAAAAABw";
Result = OPI_Dropbox.CancelFilePublication(Token, File); Result = OPI_Dropbox.CancelFilePublication(Token, File);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint dropbox CancelFilePublication --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --fileid %fileid% oint dropbox CancelFilePublication --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --fileid %fileid%
``` ```
```json title="Result" ```json title="Result"
{} {}
``` ```

102
docs/en/md/Dropbox/Shared-access-settings/Cancel-folder-publication.md
View File

@@ -1,51 +1,51 @@
--- ---
sidebar_position: 2 sidebar_position: 2
--- ---
# Unpublish folder # Unpublish folder
Cancels the public access mode for the directory Cancels the public access mode for the directory
*Function CancelFolderPublication(Val Token, Val FolderID) Export* *Function CancelFolderPublication(Val Token, Val FolderID) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| FolderID | --folder | String | ID of the public catalog (shared folder ID) | | FolderID | --folder | String | ID of the public catalog (shared folder ID) |
Returns: Key-Value Pair - serialized JSON response from Dropbox Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example" ```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Folder = "5022319569"; Folder = "5022319569";
Result = OPI_Dropbox.CancelFolderPublication(Token, Folder); Result = OPI_Dropbox.CancelFolderPublication(Token, Folder);
CurrentStatus = "in_progress"; CurrentStatus = "in_progress";
JobID = Result["async_job_id"]; JobID = Result["async_job_id"];
WHile CurrentStatus = "in_progress" Do WHile CurrentStatus = "in_progress" Do
Result = OPI_Dropbox.GetAsynchronousChangeStatus(Token, JobID); Result = OPI_Dropbox.GetAsynchronousChangeStatus(Token, JobID);
CurrentStatus = Result[".tag"]; CurrentStatus = Result[".tag"];
OPI_Tools.Pause(3); OPI_Tools.Pause(3);
EndDo; EndDo;
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint dropbox CancelFolderPublication --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --folder %folder% oint dropbox CancelFolderPublication --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --folder %folder%
``` ```
```json title="Result" ```json title="Result"
{ {
".tag": "complete" ".tag": "complete"
} }
``` ```

74
docs/en/md/Dropbox/Shared-access-settings/Get-asynchronous-change-status.md
View File

@@ -1,37 +1,37 @@
--- ---
sidebar_position: 5 sidebar_position: 5
--- ---
# Get asynchronous change status # Get asynchronous change status
Gets the status of the asynchronous access change job Gets the status of the asynchronous access change job
*Function GetAsynchronousChangeStatus(Val Token, Val JobID) Export* *Function GetAsynchronousChangeStatus(Val Token, Val JobID) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| JobID | --job | String | AsynchronousJobID | | JobID | --job | String | AsynchronousJobID |
Returns: Key-Value Pair - serialized JSON response from Dropbox Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example" ```bsl title="Code example"
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint dropbox GetAsynchronousChangeStatus --token %token% --job %job% oint dropbox GetAsynchronousChangeStatus --token %token% --job %job%
``` ```
```json title="Result" ```json title="Result"
``` ```

138
docs/en/md/Dropbox/Shared-access-settings/Publish-folder.md
View File

@@ -1,69 +1,69 @@
--- ---
sidebar_position: 1 sidebar_position: 1
--- ---
# Publish folder # Publish folder
Sets the directory to public access mode Sets the directory to public access mode
*Function PublishFolder(Val Token, Val Path) Export* *Function PublishFolder(Val Token, Val Path) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Path | --path | String | Path to the target directory | | Path | --path | String | Path to the target directory |
Returns: Key-Value Pair - serialized JSON response from Dropbox Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example" ```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Path = "/New"; Path = "/New";
Result = OPI_Dropbox.PublishFolder(Token, Path); Result = OPI_Dropbox.PublishFolder(Token, Path);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint dropbox PublishFolder --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% oint dropbox PublishFolder --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path%
``` ```
```json title="Result" ```json title="Result"
{ {
".tag": "complete", ".tag": "complete",
"access_type": { "access_type": {
".tag": "owner" ".tag": "owner"
}, },
"is_inside_team_folder": false, "is_inside_team_folder": false,
"is_team_folder": false, "is_team_folder": false,
"path_display": "/New", "path_display": "/New",
"path_lower": "/new", "path_lower": "/new",
"name": "New", "name": "New",
"policy": { "policy": {
"acl_update_policy": { "acl_update_policy": {
".tag": "editors" ".tag": "editors"
}, },
"shared_link_policy": { "shared_link_policy": {
".tag": "anyone" ".tag": "anyone"
}, },
"viewer_info_policy": { "viewer_info_policy": {
".tag": "enabled" ".tag": "enabled"
} }
}, },
"preview_url": "https://www.dropbox.com/scl/fo/0eu3zz5f05vymefoq6yyl/h?dl=0", "preview_url": "https://www.dropbox.com/scl/fo/0eu3zz5f05vymefoq6yyl/h?dl=0",
"shared_folder_id": "5009428129", "shared_folder_id": "5009428129",
"time_invited": "2024-05-30T12:35:34Z", "time_invited": "2024-05-30T12:35:34Z",
"access_inheritance": { "access_inheritance": {
".tag": "inherit" ".tag": "inherit"
}, },
"folder_id": "id:kJU6-a-pT48AAAAAAAABXw" "folder_id": "id:kJU6-a-pT48AAAAAAAABXw"
} }
``` ```

8
docs/en/md/Dropbox/Shared-access-settings/_category_.json
View File

@@ -1,4 +1,4 @@
{ {
"label": "Shared access settings", "label": "Shared access settings",
"position": "5" "position": "5"
} }

86
docs/en/md/Dropbox/Tag-work/Add-tag.md
View File

@@ -1,43 +1,43 @@
--- ---
sidebar_position: 2 sidebar_position: 2
--- ---
# Add tag # Add tag
Adds a new text tag to a file or directory Adds a new text tag to a file or directory
*Function AddTag(Val Token, Val Path, Val Tag) Export* *Function AddTag(Val Token, Val Path, Val Tag) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Path | --path | String | Path to the object for which the tag needs to be created | | Path | --path | String | Path to the object for which the tag needs to be created |
| Tag | --tag | String | Tag text | | Tag | --tag | String | Tag text |
Returns: Key-Value Pair - serialized JSON response from Dropbox Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example" ```bsl title="Code example"
Tag = "Important"; Tag = "Important";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Path = "/New/mydoc.docx"; Path = "/New/mydoc.docx";
Result = OPI_Dropbox.AddTag(Token, Path, Tag); Result = OPI_Dropbox.AddTag(Token, Path, Tag);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint dropbox AddTag --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --tag %tag% oint dropbox AddTag --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --tag %tag%
``` ```
```json title="Result" ```json title="Result"
{} {}
``` ```

86
docs/en/md/Dropbox/Tag-work/Delete-tag.md
View File

@@ -1,43 +1,43 @@
--- ---
sidebar_position: 3 sidebar_position: 3
--- ---
# Delete tag # Delete tag
Deletes the text tag of a file or directory Deletes the text tag of a file or directory
*Function DeleteTag(Val Token, Val Path, Val Tag) Export* *Function DeleteTag(Val Token, Val Path, Val Tag) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Path | --path | String | Path to the object whose tag needs to be deleted | | Path | --path | String | Path to the object whose tag needs to be deleted |
| Tag | --tag | String | Tag text | | Tag | --tag | String | Tag text |
Returns: Key-Value Pair - serialized JSON response from Dropbox Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example" ```bsl title="Code example"
Tag = "Important"; Tag = "Important";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."; Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Path = "/New/mydoc.docx"; Path = "/New/mydoc.docx";
Result = OPI_Dropbox.DeleteTag(Token, Path, Tag); Result = OPI_Dropbox.DeleteTag(Token, Path, Tag);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint dropbox DeleteTag --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --tag %tag% oint dropbox DeleteTag --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --tag %tag%
``` ```
```json title="Result" ```json title="Result"
{} {}
``` ```

106
docs/en/md/Dropbox/Tag-work/Get-tag-list.md
View File

@@ -1,53 +1,53 @@
--- ---
sidebar_position: 1 sidebar_position: 1
--- ---
# Get list of tags # Get list of tags
Gets the list of tags of the selected files Gets the list of tags of the selected files
*Function GetTagList(Val Token, Val Paths) Export* *Function GetTagList(Val Token, Val Paths) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Paths | --paths | String, Array of String | Path or set of paths to the files | | Paths | --paths | String, Array of String | Path or set of paths to the files |
Returns: Key-Value Pair - serialized JSON response from Dropbox Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example" ```bsl title="Code example"
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint dropbox GetTagList --token %token% --paths %paths% oint dropbox GetTagList --token %token% --paths %paths%
``` ```
```json title="Result" ```json title="Result"
{ {
"paths_to_tags": [ "paths_to_tags": [
{ {
"path": "/New/Dogs.mp3", "path": "/New/Dogs.mp3",
"tags": [] "tags": []
}, },
{ {
"path": "/New/mydoc.docx", "path": "/New/mydoc.docx",
"tags": [ "tags": [
{ {
".tag": "user_generated_tag", ".tag": "user_generated_tag",
"tag_text": "important" "tag_text": "important"
} }
] ]
} }
] ]
} }
``` ```

8
docs/en/md/Dropbox/Tag-work/_category_.json
View File

@@ -1,4 +1,4 @@
{ {
"label": "Tag work", "label": "Tag work",
"position": "4" "position": "4"
} }

118
docs/en/md/Google_Calendar/Calendar-list-management/Add-calendar-to-list.md
View File

@@ -1,59 +1,59 @@
--- ---
sidebar_position: 2 sidebar_position: 2
--- ---
# Add calendar to list # Add calendar to list
Adds an existing calendar to the user's list Adds an existing calendar to the user's list
*Function AddCalendarToList(Val Token, Val Calendar) Export* *Function AddCalendarToList(Val Token, Val Calendar) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Calendar | --calendar | String | Calendar ID | | Calendar | --calendar | String | Calendar ID |
Returns: Key-Value Pair - serialized JSON response from Google Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example" ```bsl title="Code example"
Response = OPI_GoogleCalendar.AddCalendarToList(Token, "55868c32be16935f0..."); //Map Response = OPI_GoogleCalendar.AddCalendarToList(Token, "55868c32be16935f0..."); //Map
Response = OPI_Tools.JSONString(Response); //String Response = OPI_Tools.JSONString(Response); //String
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint gcalendar AddCalendarToList --token %token% --calendar %calendar% oint gcalendar AddCalendarToList --token %token% --calendar %calendar%
``` ```
```json title="Result" ```json title="Result"
{ {
"conferenceProperties": { "conferenceProperties": {
"allowedConferenceSolutionTypes": [ "allowedConferenceSolutionTypes": [
"hangoutsMeet" "hangoutsMeet"
] ]
}, },
"accessRole": "owner", "accessRole": "owner",
"selected": true, "selected": true,
"foregroundColor": "#000000", "foregroundColor": "#000000",
"backgroundColor": "#7bd148", "backgroundColor": "#7bd148",
"colorId": "9", "colorId": "9",
"description": "TestDescription", "description": "TestDescription",
"summary": "TestCalendar (change.)", "summary": "TestCalendar (change.)",
"defaultReminders": [], "defaultReminders": [],
"timeZone": "UTC", "timeZone": "UTC",
"id": "f0fad8c7db43ef0adb71cbf035eb08cf80d8f8d51ba31fa86f4d5680dc2e9725@group.calendar.google.com", "id": "f0fad8c7db43ef0adb71cbf035eb08cf80d8f8d51ba31fa86f4d5680dc2e9725@group.calendar.google.com",
"etag": "\"1708423365033000\"", "etag": "\"1708423365033000\"",
"kind": "calendar#calendarListEntry" "kind": "calendar#calendarListEntry"
} }
``` ```

82
docs/en/md/Google_Calendar/Calendar-list-management/Delete-calendar-from-list.md
View File

@@ -1,41 +1,41 @@
--- ---
sidebar_position: 4 sidebar_position: 4
--- ---
# Remove calendar from list # Remove calendar from list
Removes a calendar from the user's list Removes a calendar from the user's list
*Function DeleteCalendarFromList(Val Token, Val Calendar) Export* *Function DeleteCalendarFromList(Val Token, Val Calendar) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Calendar | --calendar | String | Calendar ID | | Calendar | --calendar | String | Calendar ID |
Returns: Key-Value Pair - serialized JSON response from Google Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example" ```bsl title="Code example"
Response = OPI_GoogleCalendar.DeleteCalendarFromList(Token, "55868c32be16935f0..."); //Map Response = OPI_GoogleCalendar.DeleteCalendarFromList(Token, "55868c32be16935f0..."); //Map
Response = OPI_Tools.JSONString(Response); //String Response = OPI_Tools.JSONString(Response); //String
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint gcalendar DeleteCalendarFromList --token %token% --calendar %calendar% oint gcalendar DeleteCalendarFromList --token %token% --calendar %calendar%
``` ```
```json title="Result" ```json title="Result"
"" ""
``` ```

130
docs/en/md/Google_Calendar/Calendar-list-management/Edit-list-calendar.md
View File

@@ -1,65 +1,65 @@
--- ---
sidebar_position: 5 sidebar_position: 5
--- ---
# Edit list calendar # Edit list calendar
Edits the properties of a calendar from the user's list Edits the properties of a calendar from the user's list
*Function EditListCalendar(Val Token, Val Calendar, Val PrimaryColor, Val SecondaryColor, Val Hidden = False) Export* *Function EditListCalendar(Val Token, Val Calendar, Val PrimaryColor, Val SecondaryColor, Val Hidden = False) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Calendar | --calendar | String | Calendar ID | | Calendar | --calendar | String | Calendar ID |
| PrimaryColor | --primary | String | HEX primary color (#ffffff) | | PrimaryColor | --primary | String | HEX primary color (#ffffff) |
| SecondaryColor | --secondary | String | HEX secondary color (#ffffff) | | SecondaryColor | --secondary | String | HEX secondary color (#ffffff) |
| Hidden | --hidden | Boolean | Hidden calendar | | Hidden | --hidden | Boolean | Hidden calendar |
Returns: Key-Value Pair - serialized JSON response from Google Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example" ```bsl title="Code example"
Black = "#000000"; Black = "#000000";
Yellow = "#ffd800"; Yellow = "#ffd800";
Response = OPI_GoogleCalendar.EditListCalendar(Token, "55868c32be16935f0...", Black, Yellow, False); //Map Response = OPI_GoogleCalendar.EditListCalendar(Token, "55868c32be16935f0...", Black, Yellow, False); //Map
Response = OPI_Tools.JSONString(Response); //String Response = OPI_Tools.JSONString(Response); //String
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint gcalendar EditListCalendar --token %token% --calendar %calendar% --primary %primary% --secondary %secondary% --hidden %hidden% oint gcalendar EditListCalendar --token %token% --calendar %calendar% --primary %primary% --secondary %secondary% --hidden %hidden%
``` ```
```json title="Result" ```json title="Result"
{ {
"conferenceProperties": { "conferenceProperties": {
"allowedConferenceSolutionTypes": [ "allowedConferenceSolutionTypes": [
"hangoutsMeet" "hangoutsMeet"
] ]
}, },
"accessRole": "owner", "accessRole": "owner",
"foregroundColor": "#000000", "foregroundColor": "#000000",
"backgroundColor": "#ffd800", "backgroundColor": "#ffd800",
"colorId": "6", "colorId": "6",
"description": "TestDescription", "description": "TestDescription",
"summary": "TestCalendar (change.)", "summary": "TestCalendar (change.)",
"defaultReminders": [], "defaultReminders": [],
"timeZone": "UTC", "timeZone": "UTC",
"id": "0da65d69eba1e4b27f980447827b251ca2d94ecb1d30dba22c83559c33d0ea29@group.calendar.google.com", "id": "0da65d69eba1e4b27f980447827b251ca2d94ecb1d30dba22c83559c33d0ea29@group.calendar.google.com",
"etag": "\"1708424005038000\"", "etag": "\"1708424005038000\"",
"kind": "calendar#calendarListEntry" "kind": "calendar#calendarListEntry"
} }
``` ```

350
docs/en/md/Google_Calendar/Calendar-list-management/Get-calendar-list.md
View File

@@ -1,175 +1,175 @@
--- ---
sidebar_position: 1 sidebar_position: 1
--- ---
# Get list of calendars # Get list of calendars
Gets an array of account calendars Gets an array of account calendars
*Function GetCalendarList(Val Token) Export* *Function GetCalendarList(Val Token) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
Returns: Key-Value Pair - Array of calendar data mappings Returns: Key-Value Pair - Array of calendar data mappings
```bsl title="Code example" ```bsl title="Code example"
Response = OPI_GoogleCalendar.GetCalendarList(Token); //Map Response = OPI_GoogleCalendar.GetCalendarList(Token); //Map
Response = OPI_Tools.JSONString(Response); //String Response = OPI_Tools.JSONString(Response); //String
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint gcalendar GetCalendarList --token %token% oint gcalendar GetCalendarList --token %token%
``` ```
```json title="Result" ```json title="Result"
[ [
{ {
"conferenceProperties": { "conferenceProperties": {
"allowedConferenceSolutionTypes": [ "allowedConferenceSolutionTypes": [
"hangoutsMeet" "hangoutsMeet"
] ]
}, },
"accessRole": "reader", "accessRole": "reader",
"foregroundColor": "#000000", "foregroundColor": "#000000",
"backgroundColor": "#92e1c0", "backgroundColor": "#92e1c0",
"colorId": "13", "colorId": "13",
"description": "Hollydays.", "description": "Hollydays.",
"summary": "Hollydays", "summary": "Hollydays",
"defaultReminders": [], "defaultReminders": [],
"timeZone": "Europe/Minsk", "timeZone": "Europe/Minsk",
"id": "addressbook#contacts@group.v.calendar.google.com", "id": "addressbook#contacts@group.v.calendar.google.com",
"etag": "\"1708410978711000\"", "etag": "\"1708410978711000\"",
"kind": "calendar#calendarListEntry" "kind": "calendar#calendarListEntry"
}, },
{ {
"conferenceProperties": { "conferenceProperties": {
"allowedConferenceSolutionTypes": [ "allowedConferenceSolutionTypes": [
"hangoutsMeet" "hangoutsMeet"
] ]
}, },
"notificationSettings": { "notificationSettings": {
"notifications": [ "notifications": [
{ {
"method": "email", "method": "email",
"type": "eventCreation" "type": "eventCreation"
}, },
{ {
"method": "email", "method": "email",
"type": "eventChange" "type": "eventChange"
}, },
{ {
"method": "email", "method": "email",
"type": "eventCancellation" "type": "eventCancellation"
}, },
{ {
"method": "email", "method": "email",
"type": "eventResponse" "type": "eventResponse"
} }
] ]
}, },
"accessRole": "owner", "accessRole": "owner",
"selected": true, "selected": true,
"foregroundColor": "#000000", "foregroundColor": "#000000",
"backgroundColor": "#9fe1e7", "backgroundColor": "#9fe1e7",
"colorId": "14", "colorId": "14",
"primary": true, "primary": true,
"summary": "bayselonarrend@gmail.com", "summary": "bayselonarrend@gmail.com",
"defaultReminders": [ "defaultReminders": [
{ {
"minutes": 30, "minutes": 30,
"method": "popup" "method": "popup"
} }
], ],
"timeZone": "Europe/Minsk", "timeZone": "Europe/Minsk",
"id": "bayselonarrend@gmail.com", "id": "bayselonarrend@gmail.com",
"etag": "\"1708411692097000\"", "etag": "\"1708411692097000\"",
"kind": "calendar#calendarListEntry" "kind": "calendar#calendarListEntry"
}, },
{ {
"conferenceProperties": { "conferenceProperties": {
"allowedConferenceSolutionTypes": [ "allowedConferenceSolutionTypes": [
"hangoutsMeet" "hangoutsMeet"
] ]
}, },
"accessRole": "reader", "accessRole": "reader",
"foregroundColor": "#000000", "foregroundColor": "#000000",
"backgroundColor": "#16a765", "backgroundColor": "#16a765",
"colorId": "8", "colorId": "8",
"description": "Holidays and memorable dates in Belarus", "description": "Holidays and memorable dates in Belarus",
"summary": "Holidays in Belarus", "summary": "Holidays in Belarus",
"defaultReminders": [], "defaultReminders": [],
"timeZone": "Europe/Minsk", "timeZone": "Europe/Minsk",
"id": "ru.by#holiday@group.v.calendar.google.com", "id": "ru.by#holiday@group.v.calendar.google.com",
"etag": "\"1708417568219000\"", "etag": "\"1708417568219000\"",
"kind": "calendar#calendarListEntry" "kind": "calendar#calendarListEntry"
}, },
{ {
"conferenceProperties": { "conferenceProperties": {
"allowedConferenceSolutionTypes": [ "allowedConferenceSolutionTypes": [
"hangoutsMeet" "hangoutsMeet"
] ]
}, },
"accessRole": "owner", "accessRole": "owner",
"foregroundColor": "#000000", "foregroundColor": "#000000",
"backgroundColor": "#cca6ac", "backgroundColor": "#cca6ac",
"colorId": "21", "colorId": "21",
"description": "TestDescription", "description": "TestDescription",
"summary": "TestCalendar (change.)", "summary": "TestCalendar (change.)",
"defaultReminders": [], "defaultReminders": [],
"timeZone": "UTC", "timeZone": "UTC",
"id": "9e3fe3b35b6a09a1fa9413a0deec2fe8e040ed7fdd0fdeb1e49028848269654d@group.calendar.google.com", "id": "9e3fe3b35b6a09a1fa9413a0deec2fe8e040ed7fdd0fdeb1e49028848269654d@group.calendar.google.com",
"etag": "\"1708417602744000\"", "etag": "\"1708417602744000\"",
"kind": "calendar#calendarListEntry" "kind": "calendar#calendarListEntry"
}, },
{ {
"conferenceProperties": { "conferenceProperties": {
"allowedConferenceSolutionTypes": [ "allowedConferenceSolutionTypes": [
"hangoutsMeet" "hangoutsMeet"
] ]
}, },
"accessRole": "owner", "accessRole": "owner",
"foregroundColor": "#000000", "foregroundColor": "#000000",
"backgroundColor": "#ffd800", "backgroundColor": "#ffd800",
"colorId": "6", "colorId": "6",
"description": "TestDescription", "description": "TestDescription",
"summary": "TestCalendar (change.)", "summary": "TestCalendar (change.)",
"defaultReminders": [], "defaultReminders": [],
"timeZone": "UTC", "timeZone": "UTC",
"id": "0047d950f70f380b8ff7e2fa538b6f9f10c8a3212d0740788545406cf73431b9@group.calendar.google.com", "id": "0047d950f70f380b8ff7e2fa538b6f9f10c8a3212d0740788545406cf73431b9@group.calendar.google.com",
"etag": "\"1708417840630000\"", "etag": "\"1708417840630000\"",
"kind": "calendar#calendarListEntry" "kind": "calendar#calendarListEntry"
}, },
{ {
"conferenceProperties": { "conferenceProperties": {
"allowedConferenceSolutionTypes": [ "allowedConferenceSolutionTypes": [
"hangoutsMeet" "hangoutsMeet"
] ]
}, },
"accessRole": "owner", "accessRole": "owner",
"foregroundColor": "#000000", "foregroundColor": "#000000",
"backgroundColor": "#ffd800", "backgroundColor": "#ffd800",
"colorId": "6", "colorId": "6",
"description": "TestDescription", "description": "TestDescription",
"summary": "TestCalendar (change.)", "summary": "TestCalendar (change.)",
"defaultReminders": [], "defaultReminders": [],
"timeZone": "UTC", "timeZone": "UTC",
"id": "b5c45ad216306688c4286a262bf66d3da38aaadec3b7a5768153740140ea787c@group.calendar.google.com", "id": "b5c45ad216306688c4286a262bf66d3da38aaadec3b7a5768153740140ea787c@group.calendar.google.com",
"etag": "\"1708418157716000\"", "etag": "\"1708418157716000\"",
"kind": "calendar#calendarListEntry" "kind": "calendar#calendarListEntry"
} }
] ]
``` ```

116
docs/en/md/Google_Calendar/Calendar-list-management/Get-list-calendar.md
View File

@@ -1,58 +1,58 @@
--- ---
sidebar_position: 3 sidebar_position: 3
--- ---
# Get list calendar # Get list calendar
Gets a calendar from the user's list by ID Gets a calendar from the user's list by ID
*Function GetListCalendar(Val Token, Val Calendar) Export* *Function GetListCalendar(Val Token, Val Calendar) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Calendar | --calendar | String | Calendar ID | | Calendar | --calendar | String | Calendar ID |
Returns: Key-Value Pair - serialized JSON response from Google Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example" ```bsl title="Code example"
Response = OPI_GoogleCalendar.GetListCalendar(Token, "55868c32be16935f0..."); //Map Response = OPI_GoogleCalendar.GetListCalendar(Token, "55868c32be16935f0..."); //Map
Response = OPI_Tools.JSONString(Response); //String Response = OPI_Tools.JSONString(Response); //String
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint gcalendar GetListCalendar --token %token% --calendar %calendar% oint gcalendar GetListCalendar --token %token% --calendar %calendar%
``` ```
```json title="Result" ```json title="Result"
{ {
"conferenceProperties": { "conferenceProperties": {
"allowedConferenceSolutionTypes": [ "allowedConferenceSolutionTypes": [
"hangoutsMeet" "hangoutsMeet"
] ]
}, },
"accessRole": "owner", "accessRole": "owner",
"foregroundColor": "#000000", "foregroundColor": "#000000",
"backgroundColor": "#ffd800", "backgroundColor": "#ffd800",
"colorId": "6", "colorId": "6",
"description": "TestDescription", "description": "TestDescription",
"summary": "TestCalendar (change.)", "summary": "TestCalendar (change.)",
"defaultReminders": [], "defaultReminders": [],
"timeZone": "UTC", "timeZone": "UTC",
"id": "f0fad8c7db43ef0adb71cbf035eb08cf80d8f8d51ba31fa86f4d5680dc2e9725@group.calendar.google.com", "id": "f0fad8c7db43ef0adb71cbf035eb08cf80d8f8d51ba31fa86f4d5680dc2e9725@group.calendar.google.com",
"etag": "\"1708423563386000\"", "etag": "\"1708423563386000\"",
"kind": "calendar#calendarListEntry" "kind": "calendar#calendarListEntry"
} }
``` ```

8
docs/en/md/Google_Calendar/Calendar-list-management/_category_.json
View File

@@ -1,4 +1,4 @@
{ {
"label": "Calendar list management", "label": "Calendar list management",
"position": "3" "position": "3"
} }

78
docs/en/md/Google_Calendar/Calendar-metadata-management/Clear-main-calendar.md
View File

@@ -1,39 +1,39 @@
--- ---
sidebar_position: 4 sidebar_position: 4
--- ---
# Clear primary calendar # Clear primary calendar
Clears the event list of the primary calendar Clears the event list of the primary calendar
*Function ClearMainCalendar(Val Token) Export* *Function ClearMainCalendar(Val Token) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
Returns: Key-Value Pair - serialized JSON response from Google Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example" ```bsl title="Code example"
Response = OPI_GoogleCalendar.ClearMainCalendar(Token); Response = OPI_GoogleCalendar.ClearMainCalendar(Token);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint gcalendar ClearMainCalendar --token %token% oint gcalendar ClearMainCalendar --token %token%
``` ```
```json title="Result" ```json title="Result"
"" ""
``` ```

104
docs/en/md/Google_Calendar/Calendar-metadata-management/Create-calendar.md
View File

@@ -1,52 +1,52 @@
--- ---
sidebar_position: 1 sidebar_position: 1
--- ---
# Create calendar # Create calendar
Creates an empty calendar Creates an empty calendar
*Function CreateCalendar(Val Token, Val Name) Export* *Function CreateCalendar(Val Token, Val Name) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Name | --title | String | Name of the created calendar | | Name | --title | String | Name of the created calendar |
Returns: Key-Value Pair - serialized JSON response from Google Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example" ```bsl title="Code example"
Response = OPI_GoogleCalendar.CreateCalendar(Token, "TestCalendar"); //Map Response = OPI_GoogleCalendar.CreateCalendar(Token, "TestCalendar"); //Map
Response = OPI_Tools.JSONString(Response); //String Response = OPI_Tools.JSONString(Response); //String
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint gcalendar CreateCalendar --token %token% --title %title% oint gcalendar CreateCalendar --token %token% --title %title%
``` ```
```json title="Result" ```json title="Result"
{ {
"conferenceProperties": { "conferenceProperties": {
"allowedConferenceSolutionTypes": [ "allowedConferenceSolutionTypes": [
"hangoutsMeet" "hangoutsMeet"
] ]
}, },
"summary": "TestCalendar", "summary": "TestCalendar",
"timeZone": "UTC", "timeZone": "UTC",
"id": "75b64bec8700a640b004af3491867ac5e479884794f529699da23e7009f7d691@group.calendar.google.com", "id": "75b64bec8700a640b004af3491867ac5e479884794f529699da23e7009f7d691@group.calendar.google.com",
"etag": "\"ZlOrbHnYjwJB0APkTQupgFm7F3s\"", "etag": "\"ZlOrbHnYjwJB0APkTQupgFm7F3s\"",
"kind": "calendar#calendar" "kind": "calendar#calendar"
} }
``` ```

82
docs/en/md/Google_Calendar/Calendar-metadata-management/Delete-calendar.md
View File

@@ -1,41 +1,41 @@
--- ---
sidebar_position: 5 sidebar_position: 5
--- ---
# Delete calendar # Delete calendar
Deletes a calendar by ID Deletes a calendar by ID
*Function DeleteCalendar(Val Token, Val Calendar) Export* *Function DeleteCalendar(Val Token, Val Calendar) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Calendar | --calendar | String | Calendar ID | | Calendar | --calendar | String | Calendar ID |
Returns: Key-Value Pair - serialized JSON response from Google Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example" ```bsl title="Code example"
Response = OPI_GoogleCalendar.DeleteCalendar(Token, "55868c32be16935f0..."); Response = OPI_GoogleCalendar.DeleteCalendar(Token, "55868c32be16935f0...");
Response = OPI_Tools.JSONString(Response); Response = OPI_Tools.JSONString(Response);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint gcalendar DeleteCalendar --token %token% --calendar %calendar% oint gcalendar DeleteCalendar --token %token% --calendar %calendar%
``` ```
```json title="Result" ```json title="Result"
"" ""
``` ```

114
docs/en/md/Google_Calendar/Calendar-metadata-management/Edit-calendar-metadata.md
View File

@@ -1,57 +1,57 @@
--- ---
sidebar_position: 3 sidebar_position: 3
--- ---
# Edit calendar # Edit calendar
Edits properties of an existing calendar Edits properties of an existing calendar
*Function EditCalendarMetadata(Val Token, Val Calendar, Val Name = "", Val Description = "") Export* *Function EditCalendarMetadata(Val Token, Val Calendar, Val Name = "", Val Description = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Calendar | --calendar | String | Calendar ID | | Calendar | --calendar | String | Calendar ID |
| Name | --title | String | New name | | Name | --title | String | New name |
| Description | --description | String | New calendar description | | Description | --description | String | New calendar description |
Returns: Key-Value Pair - serialized JSON response from Google Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example" ```bsl title="Code example"
Name = "TestCalendar (change.)"; Name = "TestCalendar (change.)";
Description = "TestDescription"; Description = "TestDescription";
Response = OPI_GoogleCalendar.EditCalendarMetadata(Token, "55868c32be16935f0...", Name, Description); //Map Response = OPI_GoogleCalendar.EditCalendarMetadata(Token, "55868c32be16935f0...", Name, Description); //Map
Response = OPI_Tools.JSONString(Response); //String Response = OPI_Tools.JSONString(Response); //String
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint gcalendar EditCalendarMetadata --token %token% --calendar %calendar% --title "TestCalendar (change.)" --description "TestDescription" oint gcalendar EditCalendarMetadata --token %token% --calendar %calendar% --title "TestCalendar (change.)" --description "TestDescription"
``` ```
```json title="Result" ```json title="Result"
{ {
"conferenceProperties": { "conferenceProperties": {
"allowedConferenceSolutionTypes": [ "allowedConferenceSolutionTypes": [
"hangoutsMeet" "hangoutsMeet"
] ]
}, },
"description": "TestDescription", "description": "TestDescription",
"summary": "TestCalendar (change.)", "summary": "TestCalendar (change.)",
"timeZone": "UTC", "timeZone": "UTC",
"id": "75b64bec8700a640b004af3491867ac5e479884794f529699da23e7009f7d691@group.calendar.google.com", "id": "75b64bec8700a640b004af3491867ac5e479884794f529699da23e7009f7d691@group.calendar.google.com",
"etag": "\"x8eLqpmgoxpEDEXmEbsZxxgmJhc\"", "etag": "\"x8eLqpmgoxpEDEXmEbsZxxgmJhc\"",
"kind": "calendar#calendar" "kind": "calendar#calendar"
} }
``` ```

106
docs/en/md/Google_Calendar/Calendar-metadata-management/Get-calendar-metadata.md
View File

@@ -1,53 +1,53 @@
--- ---
sidebar_position: 2 sidebar_position: 2
--- ---
# Get calendar # Get calendar
Gets calendar information by ID Gets calendar information by ID
*Function GetCalendarMetadata(Val Token, Val Calendar) Export* *Function GetCalendarMetadata(Val Token, Val Calendar) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Calendar | --calendar | String | Calendar ID | | Calendar | --calendar | String | Calendar ID |
Returns: Key-Value Pair - serialized JSON response from Google Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example" ```bsl title="Code example"
Response = OPI_GoogleCalendar.GetCalendarMetadata(Token, "55868c32be16935f0..."); //Map Response = OPI_GoogleCalendar.GetCalendarMetadata(Token, "55868c32be16935f0..."); //Map
Response = OPI_Tools.JSONString(Response); //String Response = OPI_Tools.JSONString(Response); //String
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint gcalendar GetCalendarMetadata --token %token% --calendar %calendar% oint gcalendar GetCalendarMetadata --token %token% --calendar %calendar%
``` ```
```json title="Result" ```json title="Result"
{ {
"conferenceProperties": { "conferenceProperties": {
"allowedConferenceSolutionTypes": [ "allowedConferenceSolutionTypes": [
"hangoutsMeet" "hangoutsMeet"
] ]
}, },
"description": "TestDescription", "description": "TestDescription",
"summary": "TestCalendar (change.)", "summary": "TestCalendar (change.)",
"timeZone": "UTC", "timeZone": "UTC",
"id": "155868c32be26e4c4123a107810d40b929b516935f080e4747261fdc3416227c@group.calendar.google.com", "id": "155868c32be26e4c4123a107810d40b929b516935f080e4747261fdc3416227c@group.calendar.google.com",
"etag": "\"4A10_PI6FFY129ggELzZ8veUU-U\"", "etag": "\"4A10_PI6FFY129ggELzZ8veUU-U\"",
"kind": "calendar#calendar" "kind": "calendar#calendar"
} }
``` ```

8
docs/en/md/Google_Calendar/Calendar-metadata-management/_category_.json
View File

@@ -1,4 +1,4 @@
{ {
"label": "Calendar metadata management", "label": "Calendar metadata management",
"position": "2" "position": "2"
} }

200
docs/en/md/Google_Calendar/Event-management/Create-event.md
View File

@@ -1,100 +1,100 @@
--- ---
sidebar_position: 4 sidebar_position: 4
--- ---
# Create event # Create event
Creates a new event Creates a new event
*Function CreateEvent(Val Token, Val Calendar, Val EventDescription) ExportReturn EventManagement(Token, Calendar, EventDescription);EndFunction* *Function CreateEvent(Val Token, Val Calendar, Val EventDescription) ExportReturn EventManagement(Token, Calendar, EventDescription);EndFunction*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Calendar | --calendar | String | Calendar ID | | Calendar | --calendar | String | Calendar ID |
| EventDescription | --props | Key-Value Pair | Event description | | EventDescription | --props | Key-Value Pair | Event description |
Returns: String, Arbitrary, HTTPResponse, BinaryData, Undefined - Google server response Returns: String, Arbitrary, HTTPResponse, BinaryData, Undefined - Google server response
```bsl title="Code example" ```bsl title="Code example"
Attachments = New Map; Attachments = New Map;
Attachments.Insert("Image1", "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png"); Attachments.Insert("Image1", "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png");
Attachments.Insert("Image2", "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1"); Attachments.Insert("Image2", "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1");
EventMatch = New Map; EventMatch = New Map;
EventMatch.Insert("Description", Description); EventMatch.Insert("Description", Description);
EventMatch.Insert("Title", Name); EventMatch.Insert("Title", Name);
EventMatch.Insert("Venue", "On office"); EventMatch.Insert("Venue", "On office");
EventMatch.Insert("StartDate", CurrentSessionDate()); EventMatch.Insert("StartDate", CurrentSessionDate());
EventMatch.Insert("EndDate", EventMatch["StartDate"] + 3600); EventMatch.Insert("EndDate", EventMatch["StartDate"] + 3600);
EventMatch.Insert("ArrayOfAttachmentURLs", Attachments); EventMatch.Insert("ArrayOfAttachmentURLs", Attachments);
EventMatch.Insert("SendNotifications", True); EventMatch.Insert("SendNotifications", True);
Response = OPI_GoogleCalendar.CreateEvent(Token, Calendar, EventMatch); Response = OPI_GoogleCalendar.CreateEvent(Token, Calendar, EventMatch);
Response = OPI_Tools.JSONString(Response); Response = OPI_Tools.JSONString(Response);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint gcalendar CreateEvent --token %token% --calendar %calendar% --props %props% oint gcalendar CreateEvent --token %token% --calendar %calendar% --props %props%
``` ```
```json title="Result" ```json title="Result"
{ {
"eventType": "default", "eventType": "default",
"attachments": [ "attachments": [
{ {
"iconLink": "", "iconLink": "",
"title": "Image2", "title": "Image2",
"fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1" "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1"
}, },
{ {
"iconLink": "", "iconLink": "",
"title": "Image1", "title": "Image1",
"fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png" "fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png"
} }
], ],
"reminders": { "reminders": {
"useDefault": true "useDefault": true
}, },
"sequence": 0, "sequence": 0,
"start": { "start": {
"timeZone": "Europe/Minsk", "timeZone": "Europe/Minsk",
"dateTime": "2024-02-21T15:16:25+03:00" "dateTime": "2024-02-21T15:16:25+03:00"
}, },
"creator": { "creator": {
"self": true, "self": true,
"email": "bayselonarrend@gmail.com" "email": "bayselonarrend@gmail.com"
}, },
"end": { "end": {
"timeZone": "Europe/Minsk", "timeZone": "Europe/Minsk",
"dateTime": "2024-02-21T16:16:25+03:00" "dateTime": "2024-02-21T16:16:25+03:00"
}, },
"iCalUID": "j4nonfcc0m2mtop1vc8ivo8tb8@google.com", "iCalUID": "j4nonfcc0m2mtop1vc8ivo8tb8@google.com",
"description": "TestEventDescription", "description": "TestEventDescription",
"updated": "2024-02-21T09:16:28.474Z", "updated": "2024-02-21T09:16:28.474Z",
"created": "2024-02-21T09:16:28.000Z", "created": "2024-02-21T09:16:28.000Z",
"htmlLink": "https://www.google.com/calendar/event?eid=ajRub25mY2MwbTJtdG9wMXZjOGl2bzh0YjggYmF5c2Vsb25hcnJlbmRAbQ", "htmlLink": "https://www.google.com/calendar/event?eid=ajRub25mY2MwbTJtdG9wMXZjOGl2bzh0YjggYmF5c2Vsb25hcnJlbmRAbQ",
"location": "On office", "location": "On office",
"summary": "New event", "summary": "New event",
"organizer": { "organizer": {
"self": true, "self": true,
"email": "bayselonarrend@gmail.com" "email": "bayselonarrend@gmail.com"
}, },
"status": "confirmed", "status": "confirmed",
"id": "j4nonfcc0m2mtop1vc8ivo8tb8", "id": "j4nonfcc0m2mtop1vc8ivo8tb8",
"etag": "\"3417013976948000\"", "etag": "\"3417013976948000\"",
"kind": "calendar#event" "kind": "calendar#event"
} }
``` ```

84
docs/en/md/Google_Calendar/Event-management/Delete-event.md
View File

@@ -1,42 +1,42 @@
--- ---
sidebar_position: 7 sidebar_position: 7
--- ---
# Delete event # Delete event
Deletes an event by ID Deletes an event by ID
*Function DeleteEvent(Val Token, Val Calendar, Val Event) Export* *Function DeleteEvent(Val Token, Val Calendar, Val Event) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Calendar | --calendar | String | Calendar ID | | Calendar | --calendar | String | Calendar ID |
| Event | --event | String | Event ID | | Event | --event | String | Event ID |
Returns: Key-Value Pair - serialized JSON response from Google Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example" ```bsl title="Code example"
Response = OPI_GoogleCalendar.DeleteEvent(Token, "55868c32be16935f0...", "j4nonfcc0m2..."); //Map Response = OPI_GoogleCalendar.DeleteEvent(Token, "55868c32be16935f0...", "j4nonfcc0m2..."); //Map
Response = OPI_Tools.JSONString(Response); //String Response = OPI_Tools.JSONString(Response); //String
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint gcalendar DeleteEvent --token %token% --calendar %calendar% --event %event% oint gcalendar DeleteEvent --token %token% --calendar %calendar% --event %event%
``` ```
```json title="Result" ```json title="Result"
"" ""
``` ```

182
docs/en/md/Google_Calendar/Event-management/Edit-event.md
View File

@@ -1,91 +1,91 @@
--- ---
sidebar_position: 6 sidebar_position: 6
--- ---
# Edit event # Edit event
Edits an existing event Edits an existing event
*Function EditEvent(Val Token, Val Calendar, Val EventDescription, Val Event) ExportReturn EventManagement(Token, Calendar, EventDescription, Event);EndFunction* *Function EditEvent(Val Token, Val Calendar, Val EventDescription, Val Event) ExportReturn EventManagement(Token, Calendar, EventDescription, Event);EndFunction*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Calendar | --calendar | String | Calendar ID | | Calendar | --calendar | String | Calendar ID |
| EventDescription | --props | String | New event description | | EventDescription | --props | String | New event description |
| Event | --event | String | Event ID | | Event | --event | String | Event ID |
Returns: Key-Value Pair - serialized JSON response from Google Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example" ```bsl title="Code example"
EventMatch = New Map; EventMatch = New Map;
EventMatch.Insert("Description", "Test event description (change.)"); EventMatch.Insert("Description", "Test event description (change.)");
Response = OPI_GoogleCalendar.EditEvent(Token, "55868c32be16935f0...", EventMatch, "j4nonfcc0m2..."); Response = OPI_GoogleCalendar.EditEvent(Token, "55868c32be16935f0...", EventMatch, "j4nonfcc0m2...");
Response = OPI_Tools.JSONString(Response); Response = OPI_Tools.JSONString(Response);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint gcalendar EditEvent --token %token% --calendar %calendar% --props %props% --event %event% oint gcalendar EditEvent --token %token% --calendar %calendar% --props %props% --event %event%
``` ```
```json title="Result" ```json title="Result"
{ {
"eventType": "default", "eventType": "default",
"attachments": [ "attachments": [
{ {
"iconLink": "", "iconLink": "",
"title": "Image2", "title": "Image2",
"fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1" "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1"
}, },
{ {
"iconLink": "", "iconLink": "",
"title": "Image1", "title": "Image1",
"fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png" "fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png"
} }
], ],
"reminders": { "reminders": {
"useDefault": true "useDefault": true
}, },
"sequence": 0, "sequence": 0,
"start": { "start": {
"timeZone": "Europe/Minsk", "timeZone": "Europe/Minsk",
"dateTime": "2024-02-24T16:42:28+03:00" "dateTime": "2024-02-24T16:42:28+03:00"
}, },
"creator": { "creator": {
"self": true, "self": true,
"email": "bayselonarrend@gmail.com" "email": "bayselonarrend@gmail.com"
}, },
"end": { "end": {
"timeZone": "Europe/Minsk", "timeZone": "Europe/Minsk",
"dateTime": "2024-02-24T17:42:28+03:00" "dateTime": "2024-02-24T17:42:28+03:00"
}, },
"iCalUID": "7c2s6g3k6ib1mr2v1b7lnt9kfk@google.com", "iCalUID": "7c2s6g3k6ib1mr2v1b7lnt9kfk@google.com",
"description": "Test event description (change.)", "description": "Test event description (change.)",
"updated": "2024-02-24T10:42:42.401Z", "updated": "2024-02-24T10:42:42.401Z",
"created": "2024-02-24T10:42:32.000Z", "created": "2024-02-24T10:42:32.000Z",
"htmlLink": "https://www.google.com/calendar/event?eid=N2MyczZnM2s2aWIxbXIydjFiN2xudDlrZmsgYmF5c2Vsb25hcnJlbmRAbQ", "htmlLink": "https://www.google.com/calendar/event?eid=N2MyczZnM2s2aWIxbXIydjFiN2xudDlrZmsgYmF5c2Vsb25hcnJlbmRAbQ",
"location": "InOffice", "location": "InOffice",
"summary": "New event", "summary": "New event",
"organizer": { "organizer": {
"self": true, "self": true,
"email": "bayselonarrend@gmail.com" "email": "bayselonarrend@gmail.com"
}, },
"status": "confirmed", "status": "confirmed",
"id": "7c2s6g3k6ib1mr2v1b7lnt9kfk", "id": "7c2s6g3k6ib1mr2v1b7lnt9kfk",
"etag": "\"3417542724802000\"", "etag": "\"3417542724802000\"",
"kind": "calendar#event" "kind": "calendar#event"
} }
``` ```

84
docs/en/md/Google_Calendar/Event-management/Get-event-description.md
View File

@@ -1,42 +1,42 @@
--- ---
sidebar_position: 1 sidebar_position: 1
--- ---
# Get description events # Get description events
*Function GetEventDescription() Export* *Function GetEventDescription() Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
Returns: Key-Value Pair - Empty event template Returns: Key-Value Pair - Empty event template
```bsl title="Code example" ```bsl title="Code example"
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint gcalendar GetEventDescription oint gcalendar GetEventDescription
``` ```
```json title="Result" ```json title="Result"
EventMatch = New Map; EventMatch = New Map;
EventMatch.Insert("Description", ""); // Event description EventMatch.Insert("Description", ""); // Event description
EventMatch.Insert("Title", "New event"); // Title events EventMatch.Insert("Title", "New event"); // Title events
EventMatch.Insert("Venue", ""); // String description of the venue of the event EventMatch.Insert("Venue", ""); // String description of the venue of the event
EventMatch.Insert("StartDate", CurrentSessionDate()); // Date of start events EventMatch.Insert("StartDate", CurrentSessionDate()); // Date of start events
EventMatch.Insert("EndDate", EventMatch["StartDate"] + 3600); // Date of end events EventMatch.Insert("EndDate", EventMatch["StartDate"] + 3600); // Date of end events
EventMatch.Insert("ArrayOfAttachmentURLs", New Map); // Key - name, Value - URL to file EventMatch.Insert("ArrayOfAttachmentURLs", New Map); // Key - name, Value - URL to file
EventMatch.Insert("SendNotifications", True); // Indication of sending notifications to participants EventMatch.Insert("SendNotifications", True); // Indication of sending notifications to participants
``` ```

180
docs/en/md/Google_Calendar/Event-management/Get-event-list.md
View File

@@ -1,90 +1,90 @@
--- ---
sidebar_position: 2 sidebar_position: 2
--- ---
# Get list of events # Get list of events
Gets the list of all calendar events Gets the list of all calendar events
*Function GetEventList(Val Token, Val Calendar) Export* *Function GetEventList(Val Token, Val Calendar) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Calendar | --calendar | String | Calendar ID | | Calendar | --calendar | String | Calendar ID |
Returns: Key-Value Pair - Array of event mappings Returns: Key-Value Pair - Array of event mappings
```bsl title="Code example" ```bsl title="Code example"
Response = OPI_GoogleCalendar.GetEventList(Token, "55868c32be16935f0..."); Response = OPI_GoogleCalendar.GetEventList(Token, "55868c32be16935f0...");
Response = OPI_Tools.JSONString(Response); Response = OPI_Tools.JSONString(Response);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint gcalendar GetEventList --token %token% --calendar %calendar% oint gcalendar GetEventList --token %token% --calendar %calendar%
``` ```
```json title="Result" ```json title="Result"
[ [
{ {
"eventType": "default", "eventType": "default",
"attachments": [ "attachments": [
{ {
"iconLink": "", "iconLink": "",
"title": "", "title": "",
"fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png" "fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png"
}, },
{ {
"iconLink": "", "iconLink": "",
"title": "", "title": "",
"fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1" "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1"
} }
], ],
"reminders": { "reminders": {
"useDefault": true "useDefault": true
}, },
"sequence": 0, "sequence": 0,
"start": { "start": {
"timeZone": "Europe/Minsk", "timeZone": "Europe/Minsk",
"dateTime": "2024-02-20T05:31:12+03:00" "dateTime": "2024-02-20T05:31:12+03:00"
}, },
"creator": { "creator": {
"self": true, "self": true,
"email": "bayselonarrend@gmail.com" "email": "bayselonarrend@gmail.com"
}, },
"end": { "end": {
"timeZone": "Europe/Minsk", "timeZone": "Europe/Minsk",
"dateTime": "2024-02-20T06:31:12+03:00" "dateTime": "2024-02-20T06:31:12+03:00"
}, },
"iCalUID": "o6dt8kbedrmu15o53pgbrrv35o@google.com", "iCalUID": "o6dt8kbedrmu15o53pgbrrv35o@google.com",
"description": "TestEventDescription", "description": "TestEventDescription",
"updated": "2024-02-20T11:31:13.044Z", "updated": "2024-02-20T11:31:13.044Z",
"created": "2024-02-20T11:31:13.000Z", "created": "2024-02-20T11:31:13.000Z",
"htmlLink": "https://www.google.com/calendar/event?eid=bzZkdDhrYmVkcm11MTVvNTNwZ2JycnYzNW8gYmF5c2Vsb25hcnJlbmRAbQ", "htmlLink": "https://www.google.com/calendar/event?eid=bzZkdDhrYmVkcm11MTVvNTNwZ2JycnYzNW8gYmF5c2Vsb25hcnJlbmRAbQ",
"location": "On office", "location": "On office",
"summary": "New event", "summary": "New event",
"organizer": { "organizer": {
"self": true, "self": true,
"email": "bayselonarrend@gmail.com" "email": "bayselonarrend@gmail.com"
}, },
"status": "confirmed", "status": "confirmed",
"id": "o6dt8kbedrmu15o53pgbrrv35o", "id": "o6dt8kbedrmu15o53pgbrrv35o",
"etag": "\"3416857346088000\"", "etag": "\"3416857346088000\"",
"kind": "calendar#event" "kind": "calendar#event"
}, },
] ]
``` ```

174
docs/en/md/Google_Calendar/Event-management/Get-event.md
View File

@@ -1,87 +1,87 @@
--- ---
sidebar_position: 3 sidebar_position: 3
--- ---
# Get event # Get event
Gets an event by ID Gets an event by ID
*Function GetEvent(Val Token, Val Calendar, Val Event) Export* *Function GetEvent(Val Token, Val Calendar, Val Event) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Calendar | --calendar | String | Calendar ID | | Calendar | --calendar | String | Calendar ID |
| Event | --event | String | Event ID | | Event | --event | String | Event ID |
Returns: Key-Value Pair - serialized JSON response from Google Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example" ```bsl title="Code example"
Response = OPI_GoogleCalendar.GetEvent(Token, "55868c32be16935f0...", "j4nonfcc0m2..."); //Map Response = OPI_GoogleCalendar.GetEvent(Token, "55868c32be16935f0...", "j4nonfcc0m2..."); //Map
Response = OPI_Tools.JSONString(Response); //String Response = OPI_Tools.JSONString(Response); //String
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint gcalendar GetEvent --token %token% --calendar %calendar% --event %event% oint gcalendar GetEvent --token %token% --calendar %calendar% --event %event%
``` ```
```json title="Result" ```json title="Result"
{ {
"eventType": "default", "eventType": "default",
"attachments": [ "attachments": [
{ {
"iconLink": "", "iconLink": "",
"title": "Image2", "title": "Image2",
"fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1" "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1"
}, },
{ {
"iconLink": "", "iconLink": "",
"title": "Image1", "title": "Image1",
"fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png" "fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png"
} }
], ],
"reminders": { "reminders": {
"useDefault": true "useDefault": true
}, },
"sequence": 0, "sequence": 0,
"start": { "start": {
"timeZone": "Europe/Minsk", "timeZone": "Europe/Minsk",
"dateTime": "2024-02-21T15:16:25+03:00" "dateTime": "2024-02-21T15:16:25+03:00"
}, },
"creator": { "creator": {
"self": true, "self": true,
"email": "bayselonarrend@gmail.com" "email": "bayselonarrend@gmail.com"
}, },
"end": { "end": {
"timeZone": "Europe/Minsk", "timeZone": "Europe/Minsk",
"dateTime": "2024-02-21T16:16:25+03:00" "dateTime": "2024-02-21T16:16:25+03:00"
}, },
"iCalUID": "j4nonfcc0m2mtop1vc8ivo8tb8@google.com", "iCalUID": "j4nonfcc0m2mtop1vc8ivo8tb8@google.com",
"description": "TestEventDescription", "description": "TestEventDescription",
"updated": "2024-02-21T09:16:28.474Z", "updated": "2024-02-21T09:16:28.474Z",
"created": "2024-02-21T09:16:28.000Z", "created": "2024-02-21T09:16:28.000Z",
"htmlLink": "https://www.google.com/calendar/event?eid=ajRub25mY2MwbTJtdG9wMXZjOGl2bzh0YjggYmF5c2Vsb25hcnJlbmRAbQ", "htmlLink": "https://www.google.com/calendar/event?eid=ajRub25mY2MwbTJtdG9wMXZjOGl2bzh0YjggYmF5c2Vsb25hcnJlbmRAbQ",
"location": "On office", "location": "On office",
"summary": "New event", "summary": "New event",
"organizer": { "organizer": {
"self": true, "self": true,
"email": "bayselonarrend@gmail.com" "email": "bayselonarrend@gmail.com"
}, },
"status": "confirmed", "status": "confirmed",
"id": "j4nonfcc0m2mtop1vc8ivo8tb8", "id": "j4nonfcc0m2mtop1vc8ivo8tb8",
"etag": "\"3417013976948000\"", "etag": "\"3417013976948000\"",
"kind": "calendar#event" "kind": "calendar#event"
} }
``` ```

176
docs/en/md/Google_Calendar/Event-management/Move-event.md
View File

@@ -1,88 +1,88 @@
--- ---
sidebar_position: 5 sidebar_position: 5
--- ---
# Move event # Move event
Moves an event to another calendar Moves an event to another calendar
*Function MoveEvent(Val Token, Val SourceCalendar, Val TargetCalendar, Val Event) Export* *Function MoveEvent(Val Token, Val SourceCalendar, Val TargetCalendar, Val Event) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| SourceCalendar | --from | String | ID of the source calendar | | SourceCalendar | --from | String | ID of the source calendar |
| TargetCalendar | --to | String | ID of the target calendar | | TargetCalendar | --to | String | ID of the target calendar |
| Event | --event | String | ID of the source calendar event | | Event | --event | String | ID of the source calendar event |
Returns: Key-Value Pair - serialized JSON response from Google Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example" ```bsl title="Code example"
Response = OPI_GoogleCalendar.MoveEvent(Token, "bayselonarrend@gmail.com", "55868c32be16935f0...", "j4nonfcc0m2..."); //Map Response = OPI_GoogleCalendar.MoveEvent(Token, "bayselonarrend@gmail.com", "55868c32be16935f0...", "j4nonfcc0m2..."); //Map
Response = OPI_Tools.JSONString(Response); //String Response = OPI_Tools.JSONString(Response); //String
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint gcalendar MoveEvent --token %token% --from %from% --to %to% --event %event% oint gcalendar MoveEvent --token %token% --from %from% --to %to% --event %event%
``` ```
```json title="Result" ```json title="Result"
{ {
"eventType": "default", "eventType": "default",
"attachments": [ "attachments": [
{ {
"iconLink": "", "iconLink": "",
"title": "Image2", "title": "Image2",
"fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1" "fileUrl": "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/logo.png?v1"
}, },
{ {
"iconLink": "", "iconLink": "",
"title": "Image1", "title": "Image1",
"fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png" "fileUrl": "https://opi.neocities.org/assets/images/logo_long-e8fdcca6ff8b32e679ea49a1ccdd3eac.png"
} }
], ],
"reminders": { "reminders": {
"useDefault": true "useDefault": true
}, },
"sequence": 0, "sequence": 0,
"start": { "start": {
"timeZone": "Europe/Minsk", "timeZone": "Europe/Minsk",
"dateTime": "2024-02-24T16:20:49+03:00" "dateTime": "2024-02-24T16:20:49+03:00"
}, },
"creator": { "creator": {
"self": true, "self": true,
"email": "bayselonarrend@gmail.com" "email": "bayselonarrend@gmail.com"
}, },
"end": { "end": {
"timeZone": "Europe/Minsk", "timeZone": "Europe/Minsk",
"dateTime": "2024-02-24T17:20:49+03:00" "dateTime": "2024-02-24T17:20:49+03:00"
}, },
"iCalUID": "f9kkj2omsqtt67g12qh2jig8uk@google.com", "iCalUID": "f9kkj2omsqtt67g12qh2jig8uk@google.com",
"description": "TestEventDescription", "description": "TestEventDescription",
"updated": "2024-02-24T10:20:51.234Z", "updated": "2024-02-24T10:20:51.234Z",
"created": "2024-02-24T10:20:49.000Z", "created": "2024-02-24T10:20:49.000Z",
"htmlLink": "https://www.google.com/calendar/event?eid=Zjlra2oyb21zcXR0NjdnMTJxaDJqaWc4dWsgYmF5c2Vsb25hcnJlbmRAbQ", "htmlLink": "https://www.google.com/calendar/event?eid=Zjlra2oyb21zcXR0NjdnMTJxaDJqaWc4dWsgYmF5c2Vsb25hcnJlbmRAbQ",
"location": "InOffice", "location": "InOffice",
"summary": "New event", "summary": "New event",
"organizer": { "organizer": {
"self": true, "self": true,
"email": "bayselonarrend@gmail.com" "email": "bayselonarrend@gmail.com"
}, },
"status": "confirmed", "status": "confirmed",
"id": "f9kkj2omsqtt67g12qh2jig8uk", "id": "f9kkj2omsqtt67g12qh2jig8uk",
"etag": "\"3417540102468000\"", "etag": "\"3417540102468000\"",
"kind": "calendar#event" "kind": "calendar#event"
} }
``` ```

8
docs/en/md/Google_Calendar/Event-management/_category_.json
View File

@@ -1,4 +1,4 @@
{ {
"label": "Event management", "label": "Event management",
"position": "4" "position": "4"
} }

196
docs/en/md/Google_Calendar/Google_Calendar.md
View File

@@ -1,98 +1,98 @@
--- ---
id: GoogleCalendar id: GoogleCalendar
sidebar_class_name: GoogleCalendar sidebar_class_name: GoogleCalendar
--- ---
<img src={require('../../static/img/APIs/GoogleCalendar.png').default} width='64px' /> <img src={require('../../static/img/APIs/GoogleCalendar.png').default} width='64px' />
# Google Calendar # Google Calendar
Этот раздел поwithinящен библиотеtoе for work with API Google Kалендаря. Nа данной withтранице опиwithаны inwithе дейwithтinия, необходимые for полноценного of start work Этот раздел поwithinящен библиотеtoе for work with API Google Kалендаря. Nа данной withтранице опиwithаны inwithе дейwithтinия, необходимые for полноценного of start work
:::important :::important
If inы уже иwithпользуете OPI for work with другими withерinиwithами Google Workspase и inыполняли withтартоinую towithтройtoу, то пунtoты **Создание проеtoта** и **Nаwithтройtoа OAuth** можно пропуwithтить. Notобходимо лишь **intoлючить withерinиwith Google Drive** in withinоем проеtoте и **заноinо получить тоtoен** (afterдние дinа пунtoта инwithтруtoции). If inы уже иwithпользуете OPI for work with другими withерinиwithами Google Workspase и inыполняли withтартоinую towithтройtoу, то пунtoты **Создание проеtoта** и **Nаwithтройtoа OAuth** можно пропуwithтить. Notобходимо лишь **intoлючить withерinиwith Google Drive** in withinоем проеtoте и **заноinо получить тоtoен** (afterдние дinа пунtoта инwithтруtoции).
::: :::
## Getting started ## Getting started
<hr/> <hr/>
### Создание проеtoта ### Создание проеtoта
1. Перейдите to [main page Google Cloud](https://console.cloud.google.com) и withоздайте проеtoт 1. Перейдите to [main page Google Cloud](https://console.cloud.google.com) и withоздайте проеtoт
![BF](../../static/img/Docs/GoogleCalendar/1.png) ![BF](../../static/img/Docs/GoogleCalendar/1.png)
2. Inыберите withозданный проеtoт и in боtoоinом меню перейдите APIs and Services -> OAuth consent screen 2. Inыберите withозданный проеtoт и in боtoоinом меню перейдите APIs and Services -> OAuth consent screen
![BF](../../static/img/Docs/GoogleCalendar/2.png) ![BF](../../static/img/Docs/GoogleCalendar/2.png)
3. Inыберите пунtoт External 3. Inыберите пунtoт External
![BF](../../static/img/Docs/GoogleCalendar/3.png) ![BF](../../static/img/Docs/GoogleCalendar/3.png)
4. Заполните fields App name, User support email и Email addresses (inwithе fields withо зinездочtoами) 4. Заполните fields App name, User support email и Email addresses (inwithе fields withо зinездочtoами)
![BF](../../static/img/Docs/GoogleCalendar/4.png) ![BF](../../static/img/Docs/GoogleCalendar/4.png)
5. Nажимайте далее и Save and continue to afterдней intoладtoе 5. Nажимайте далее и Save and continue to afterдней intoладtoе
![BF](../../static/img/Docs/GoogleCalendar/5.png) ![BF](../../static/img/Docs/GoogleCalendar/5.png)
6. Nажмите Publish App 6. Nажмите Publish App
![BF](../../static/img/Docs/GoogleCalendar/6.png) ![BF](../../static/img/Docs/GoogleCalendar/6.png)
<hr/> <hr/>
### Nаwithтройtoа OAuth ### Nаwithтройtoа OAuth
1. In боtoоinом меню inыберите пунtoт Credentials -> Create Credentials -> OAuth client ID 1. In боtoоinом меню inыберите пунtoт Credentials -> Create Credentials -> OAuth client ID
![BF](../../static/img/Docs/GoogleCalendar/7.png) ![BF](../../static/img/Docs/GoogleCalendar/7.png)
2. Ininедите имя и inыберите Application type - Desktop app 2. Ininедите имя и inыберите Application type - Desktop app
![BF](../../static/img/Docs/GoogleCalendar/8.png) ![BF](../../static/img/Docs/GoogleCalendar/8.png)
3. Сохраните ClientID и Client Secret 3. Сохраните ClientID и Client Secret
![BF](../../static/img/Docs/GoogleCalendar/9.png) ![BF](../../static/img/Docs/GoogleCalendar/9.png)
<hr/> <hr/>
### Intoлючение withерinиwithа Google Calendar ### Intoлючение withерinиwithа Google Calendar
1. Перейдите to [page Kалендаря in Marketplace](https://console.cloud.google.com/marketplace/product/google/calendar-json.googleapis.com) 1. Перейдите to [page Kалендаря in Marketplace](https://console.cloud.google.com/marketplace/product/google/calendar-json.googleapis.com)
2. Nажмите Enable 2. Nажмите Enable
![BF](../../static/img/Docs/GoogleCalendar/12.png) ![BF](../../static/img/Docs/GoogleCalendar/12.png)
<hr/> <hr/>
### Toлучение Tokenа ### Toлучение Tokenа
1. Передайте ClientID in фунtoцию OPI_GoogleWorkspace.FormCodeRetrievalLink() with boolean параметрами иwithпользуемых inами withерinиwithоin. Resultом фунtoции will URL, toоторый необходимо отtoрыть in браузере. Authorfromуйтеwithь при помощи withinоего аtotoаунта Google 1. Передайте ClientID in фунtoцию OPI_GoogleWorkspace.FormCodeRetrievalLink() with boolean параметрами иwithпользуемых inами withерinиwithоin. Resultом фунtoции will URL, toоторый необходимо отtoрыть in браузере. Authorfromуйтеwithь при помощи withinоего аtotoаунта Google
![BF](../../static/img/Docs/GoogleCalendar/10.png) ![BF](../../static/img/Docs/GoogleCalendar/10.png)
2. Сtoопируйте toод from URL after аinторfromации 2. Сtoопируйте toод from URL after аinторfromации
![BF](../../static/img/Docs/GoogleCalendar/11.png) ![BF](../../static/img/Docs/GoogleCalendar/11.png)
3. Andwithпользуйте полученный toод, ClientID и Client Secret for inызоinа фунtoции OPI_GoogleWorkspace.GetTokenByCode(ClientID, ClientSecret, Code) 3. Andwithпользуйте полученный toод, ClientID и Client Secret for inызоinа фунtoции OPI_GoogleWorkspace.GetTokenByCode(ClientID, ClientSecret, Code)
```json title="Result фунtoции GetTokenByCode(), еwithли переinеwithти его in JSON" ```json title="Result фунtoции GetTokenByCode(), еwithли переinеwithти его in JSON"
{ {
"token_type": "Bearer", "token_type": "Bearer",
"refresh_token": "1//09au6OES3JN9oCgYIARAAGAkSNwF-L9Ir1B7uawfwafT1wE0FKO519Xj6JxawfawfyjMyJ_QlUZYLHZqw", "refresh_token": "1//09au6OES3JN9oCgYIARAAGAkSNwF-L9Ir1B7uawfwafT1wE0FKO519Xj6JxawfawfyjMyJ_QlUZYLHZqw",
"scope": "https://www.googleapis.com/auth/calendar", "scope": "https://www.googleapis.com/auth/calendar",
"expires_in": 3599, "expires_in": 3599,
"access_token": "ya29.a0AfB_byA344tXkIawdawdwadadhyZQV8bSZn_snNXtY2HLb7l71awdawdawdad-ASgpzyOSWIvEmPruhUa_1yCCq6jvoD0r_q-fNEsARrH8zpJ3c6LNGWvwdg8CXsSxYaCgYKAWkSawfwafawfrCK0EP5kZY_A0171" "access_token": "ya29.a0AfB_byA344tXkIawdawdwadadhyZQV8bSZn_snNXtY2HLb7l71awdawdawdad-ASgpzyOSWIvEmPruhUa_1yCCq6jvoD0r_q-fNEsARrH8zpJ3c6LNGWvwdg8CXsSxYaCgYKAWkSawfwafawfrCK0EP5kZY_A0171"
} }
``` ```
4. Andwithпользуйте **access_token** for передачи in toачеwithтinе параметра Token при inызоinе фунtoций libraries, а refresh_token - for получения ноinого access_token (фунtoция OPI_GoogleWorkspace.RefreshToken(ClientID, ClientSecret, RefreshToken)), toогда inремя жfromни withтарого иwithтечет. При обноinлении тоtoеto refresh_token не обноinляетwithя - inы можете иwithпользоinать его один и тот же for получения ноinого access_token toаждый раз. 4. Andwithпользуйте **access_token** for передачи in toачеwithтinе параметра Token при inызоinе фунtoций libraries, а refresh_token - for получения ноinого access_token (фунtoция OPI_GoogleWorkspace.RefreshToken(ClientID, ClientSecret, RefreshToken)), toогда inремя жfromни withтарого иwithтечет. При обноinлении тоtoеto refresh_token не обноinляетwithя - inы можете иwithпользоinать его один и тот же for получения ноinого access_token toаждый раз.

16
docs/en/md/Google_Calendar/_category_.json
View File

@@ -1,8 +1,8 @@
{ {
"label": "Google Calendar", "label": "Google Calendar",
"position": 7, "position": 7,
"link": { "link": {
"type": "doc", "type": "doc",
"id": "GoogleCalendar" "id": "GoogleCalendar"
} }
} }

120
docs/en/md/Google_Drive/Comment-management/Create-comment.md
View File

@@ -1,60 +1,60 @@
--- ---
sidebar_position: 1 sidebar_position: 1
--- ---
# Create comment # Create comment
Creates a comment for a file or directory Creates a comment for a file or directory
*Function CreateComment(Val Token, Val Identifier, Val Comment) Export* *Function CreateComment(Val Token, Val Identifier, Val Comment) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Identifier | --object | String | Identifier of the object that needs a comment | | Identifier | --object | String | Identifier of the object that needs a comment |
| Comment | --text | String | Comment text | | Comment | --text | String | Comment text |
Returns: Key-Value Pair - serialized JSON response from Google Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example" ```bsl title="Code example"
Identifier = "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW"; Identifier = "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW";
Comment = "NewComment"; Comment = "NewComment";
Response = OPI_GoogleDrive.CreateComment(Token, Identifier, Comment); //Map Response = OPI_GoogleDrive.CreateComment(Token, Identifier, Comment); //Map
Response = OPI_Tools.JSONString(Response); //String Response = OPI_Tools.JSONString(Response); //String
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint gdrive CreateComment --token %token% --object "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW" --text %text% oint gdrive CreateComment --token %token% --object "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW" --text %text%
``` ```
```json title="Result" ```json title="Result"
{ {
"content": "NewComment", "content": "NewComment",
"htmlContent": "NewComment", "htmlContent": "NewComment",
"author": { "author": {
"photoLink": "//lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s50-c-k-no", "photoLink": "//lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s50-c-k-no",
"me": true, "me": true,
"kind": "drive#user", "kind": "drive#user",
"displayName": "Anton Titovets" "displayName": "Anton Titovets"
}, },
"replies": [], "replies": [],
"modifiedTime": "2024-03-17T12:53:45.469Z", "modifiedTime": "2024-03-17T12:53:45.469Z",
"createdTime": "2024-03-17T12:53:45.469Z", "createdTime": "2024-03-17T12:53:45.469Z",
"kind": "drive#comment", "kind": "drive#comment",
"deleted": false, "deleted": false,
"id": "AAABI3NNNAY" "id": "AAABI3NNNAY"
} }
``` ```

86
docs/en/md/Google_Drive/Comment-management/Delete-comment.md
View File

@@ -1,43 +1,43 @@
--- ---
sidebar_position: 4 sidebar_position: 4
--- ---
# Delete comment # Delete comment
Deletes comment by ID Deletes comment by ID
*Function DeleteComment(Val Token, Val ObjectID, Val CommentID) Export* *Function DeleteComment(Val Token, Val ObjectID, Val CommentID) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| ObjectID | --object | String | Identifier of the file or directory where the comment is located | | ObjectID | --object | String | Identifier of the file or directory where the comment is located |
| CommentID | --comment | String | Comment identifier | | CommentID | --comment | String | Comment identifier |
Returns: Key-Value Pair - serialized JSON response from Google Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example" ```bsl title="Code example"
Identifier = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa"; Identifier = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa";
Response = OPI_GoogleDrive.DeleteComment(Token, Identifier, Comment); //Map Response = OPI_GoogleDrive.DeleteComment(Token, Identifier, Comment); //Map
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint gdrive DeleteComment --token %token% --object %object% --comment %comment% oint gdrive DeleteComment --token %token% --object %object% --comment %comment%
``` ```
```json title="Result" ```json title="Result"
'' ''
``` ```

126
docs/en/md/Google_Drive/Comment-management/Get-comment-list.md
View File

@@ -1,63 +1,63 @@
--- ---
sidebar_position: 3 sidebar_position: 3
--- ---
# Get list of comments # Get list of comments
Gets the list of all comments of the object Gets the list of all comments of the object
*Function GetCommentList(Val Token, Val ObjectID) Export* *Function GetCommentList(Val Token, Val ObjectID) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| ObjectID | --object | String | Object identifier | | ObjectID | --object | String | Object identifier |
Returns: Key-Value Pair - serialized JSON response from Google Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example" ```bsl title="Code example"
AndДFile = "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW"; AndДFile = "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW";
Response = OPI_GoogleDrive.GetCommentList(Token, AndДFile); //Map Response = OPI_GoogleDrive.GetCommentList(Token, AndДFile); //Map
Response = OPI_Tools.JSONString(Response); //String Response = OPI_Tools.JSONString(Response); //String
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint gdrive GetCommentList --token %token% --object %object% oint gdrive GetCommentList --token %token% --object %object%
``` ```
```json title="Result" ```json title="Result"
{ {
"comments": [ "comments": [
{ {
"content": "NewComment", "content": "NewComment",
"htmlContent": "NewComment", "htmlContent": "NewComment",
"author": { "author": {
"photoLink": "//lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s50-c-k-no", "photoLink": "//lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s50-c-k-no",
"me": true, "me": true,
"kind": "drive#user", "kind": "drive#user",
"displayName": "Anton Titovets" "displayName": "Anton Titovets"
}, },
"replies": [], "replies": [],
"modifiedTime": "2024-03-17T12:53:45.469Z", "modifiedTime": "2024-03-17T12:53:45.469Z",
"createdTime": "2024-03-17T12:53:45.469Z", "createdTime": "2024-03-17T12:53:45.469Z",
"kind": "drive#comment", "kind": "drive#comment",
"deleted": false, "deleted": false,
"id": "AAABI3NNNAY" "id": "AAABI3NNNAY"
} }
], ],
"kind": "drive#commentList" "kind": "drive#commentList"
} }
``` ```

120
docs/en/md/Google_Drive/Comment-management/Get-comment.md
View File

@@ -1,60 +1,60 @@
--- ---
sidebar_position: 2 sidebar_position: 2
--- ---
# Get comment # Get comment
Gets comment by ID Gets comment by ID
*Function GetComment(Val Token, Val ObjectID, Val CommentID) Export* *Function GetComment(Val Token, Val ObjectID, Val CommentID) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| ObjectID | --object | String | Identifier of the file or directory where the comment is located | | ObjectID | --object | String | Identifier of the file or directory where the comment is located |
| CommentID | --comment | String | Comment identifier | | CommentID | --comment | String | Comment identifier |
Returns: Key-Value Pair - serialized JSON response from Google Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example" ```bsl title="Code example"
AndДFile = "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW"; AndДFile = "1rCyOc4A8VYw7DM3HV55P9BuKWayJOSvW";
CommentID = AAABI3NNNAY; CommentID = AAABI3NNNAY;
Response = OPI_GoogleDrive.GetComment(Token, AndДFile, CommentID); //Map Response = OPI_GoogleDrive.GetComment(Token, AndДFile, CommentID); //Map
Response = OPI_Tools.JSONString(Response); //String Response = OPI_Tools.JSONString(Response); //String
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint gdrive GetComment --token %token% --object %object% --comment "AAABI3NNNAY" oint gdrive GetComment --token %token% --object %object% --comment "AAABI3NNNAY"
``` ```
```json title="Result" ```json title="Result"
{ {
"content": "NewComment", "content": "NewComment",
"htmlContent": "NewComment", "htmlContent": "NewComment",
"author": { "author": {
"photoLink": "//lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s50-c-k-no", "photoLink": "//lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s50-c-k-no",
"me": true, "me": true,
"kind": "drive#user", "kind": "drive#user",
"displayName": "Anton Titovets" "displayName": "Anton Titovets"
}, },
"replies": [], "replies": [],
"modifiedTime": "2024-03-17T12:53:45.469Z", "modifiedTime": "2024-03-17T12:53:45.469Z",
"createdTime": "2024-03-17T12:53:45.469Z", "createdTime": "2024-03-17T12:53:45.469Z",
"kind": "drive#comment", "kind": "drive#comment",
"deleted": false, "deleted": false,
"id": "AAABI3NNNAY" "id": "AAABI3NNNAY"
} }
``` ```

8
docs/en/md/Google_Drive/Comment-management/_category_.json
View File

@@ -1,4 +1,4 @@
{ {
"label": "Comment management", "label": "Comment management",
"position": "3" "position": "3"
} }

104
docs/en/md/Google_Drive/File-and-directory-management/Copy-object.md
View File

@@ -1,52 +1,52 @@
--- ---
sidebar_position: 7 sidebar_position: 7
--- ---
# Copy object # Copy object
Copies file or directory Copies file or directory
*Function CopyObject(Val Token, Val Identifier, Val NewName = "", Val NewParent = "") Export* *Function CopyObject(Val Token, Val Identifier, Val NewName = "", Val NewParent = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Identifier | --object | String | Object identifier | | Identifier | --object | String | Object identifier |
| NewName | --title | String | New object name | | NewName | --title | String | New object name |
| NewParent | --catalog | String | New parent directory | | NewParent | --catalog | String | New parent directory |
Returns: Key-Value Pair - serialized JSON response from Google Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example" ```bsl title="Code example"
NewName = "CopiedFile.jpeg"; NewName = "CopiedFile.jpeg";
NewLocation = "1603PU_Hrkvj4HeFJKYSVxZJDRoGvd3SJ"; NewLocation = "1603PU_Hrkvj4HeFJKYSVxZJDRoGvd3SJ";
Identifier = "1F8pfXPgltiOG2fPv88uStwegYj1tRoFk"; Identifier = "1F8pfXPgltiOG2fPv88uStwegYj1tRoFk";
Response = OPI_GoogleDrive.CopyObject(Token, Identifier, NewName, NewLocation) //Map Response = OPI_GoogleDrive.CopyObject(Token, Identifier, NewName, NewLocation) //Map
Response = OPI_Tools.JSONString(Response); //String Response = OPI_Tools.JSONString(Response); //String
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint gdrive CopyObject --token %token% --object "1F8pfXPgltiOG2fPv88uStwegYj1tRoFk" --title "CopiedFile.jpeg" --catalog %catalog% oint gdrive CopyObject --token %token% --object "1F8pfXPgltiOG2fPv88uStwegYj1tRoFk" --title "CopiedFile.jpeg" --catalog %catalog%
``` ```
```json title="Result" ```json title="Result"
{ {
"mimeType": "image/jpeg", "mimeType": "image/jpeg",
"name": "CopiedFile.jpeg", "name": "CopiedFile.jpeg",
"id": "1uxsMaxL1W5Y7z6-HhjE6QpyDxFPgW4Fy", "id": "1uxsMaxL1W5Y7z6-HhjE6QpyDxFPgW4Fy",
"kind": "drive#file" "kind": "drive#file"
} }
``` ```

98
docs/en/md/Google_Drive/File-and-directory-management/Create-folder.md
View File

@@ -1,49 +1,49 @@
--- ---
sidebar_position: 5 sidebar_position: 5
--- ---
# Create folder # Create folder
Creates an empty directory on the drive Creates an empty directory on the drive
*Function CreateFolder(Val Token, Val Name, Val Parent = "") Export* *Function CreateFolder(Val Token, Val Name, Val Parent = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Name | --title | String | Folder name | | Name | --title | String | Folder name |
| Parent | --catalog | String | Parent | | Parent | --catalog | String | Parent |
Returns: Key-Value Pair - serialized JSON response from Google Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example" ```bsl title="Code example"
Name = "TestFolder"; Name = "TestFolder";
Response = OPI_GoogleDrive.CreateFolder(Token, Name); //Map Response = OPI_GoogleDrive.CreateFolder(Token, Name); //Map
Response = OPI_Tools.JSONString(Response); //String Response = OPI_Tools.JSONString(Response); //String
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint gdrive CreateFolder --token %token% --title "TestFolder" --catalog %catalog% oint gdrive CreateFolder --token %token% --title "TestFolder" --catalog %catalog%
``` ```
```json title="Result" ```json title="Result"
{ {
"mimeType": "application/vnd.google-apps.folder", "mimeType": "application/vnd.google-apps.folder",
"name": "TestFolder", "name": "TestFolder",
"id": "1fIqr5pJV3QybT5sPeZhBD_0TIvtL5Ovc", "id": "1fIqr5pJV3QybT5sPeZhBD_0TIvtL5Ovc",
"kind": "drive#file" "kind": "drive#file"
} }
``` ```

84
docs/en/md/Google_Drive/File-and-directory-management/Delete-object.md
View File

@@ -1,42 +1,42 @@
--- ---
sidebar_position: 9 sidebar_position: 9
--- ---
# Delete object # Delete object
Deletes file or directory by ID Deletes file or directory by ID
*Function DeleteObject(Val Token, Val Identifier) Export* *Function DeleteObject(Val Token, Val Identifier) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Identifier | --object | String | Identifier of the object to delete | | Identifier | --object | String | Identifier of the object to delete |
Returns: Key-Value Pair - serialized JSON response from Google Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example" ```bsl title="Code example"
Identifier = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa"; Identifier = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa";
Response = OPI_GoogleDrive.DeleteObject(Token, Identifier); //Map Response = OPI_GoogleDrive.DeleteObject(Token, Identifier); //Map
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint gdrive DeleteObject --token %token% --object "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa" oint gdrive DeleteObject --token %token% --object "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa"
``` ```
```json title="Result" ```json title="Result"
'' ''
``` ```

88
docs/en/md/Google_Drive/File-and-directory-management/Download-file.md
View File

@@ -1,44 +1,44 @@
--- ---
sidebar_position: 6 sidebar_position: 6
--- ---
# Download file # Download file
Gets file by ID Gets file by ID
*Function DownloadFile(Val Token, Val Identifier, Val SavePath = "") Export* *Function DownloadFile(Val Token, Val Identifier, Val SavePath = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Identifier | --object | String | File identifier | | Identifier | --object | String | File identifier |
| SavePath | --out | String | File save path | | SavePath | --out | String | File save path |
Returns: BinaryData,String - Binary data or file path when SavePath parameter is specified Returns: BinaryData,String - Binary data or file path when SavePath parameter is specified
```bsl title="Code example" ```bsl title="Code example"
Identifier = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa"; Identifier = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa";
Response = OPI_GoogleDrive.DownloadFile(Token, Identifier); //Map Response = OPI_GoogleDrive.DownloadFile(Token, Identifier); //Map
Response = OPI_Tools.JSONString(Response); //String Response = OPI_Tools.JSONString(Response); //String
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint gdrive DownloadFile --token %token% --object "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa" --out %out% oint gdrive DownloadFile --token %token% --object "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa" --out %out%
``` ```
```json title="Result" ```json title="Result"
``` ```

296
docs/en/md/Google_Drive/File-and-directory-management/Get-directories-list.md
View File

@@ -1,148 +1,148 @@
--- ---
sidebar_position: 2 sidebar_position: 2
--- ---
# Get list of directories # Get list of directories
Gets the list of drive directories Gets the list of drive directories
*Function GetDirectoriesList(Val Token, Val NameContains = "", Val Detailed = False) Export* *Function GetDirectoriesList(Val Token, Val NameContains = "", Val Detailed = False) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| NameContains | --querry | String | Filter by name | | NameContains | --querry | String | Filter by name |
| Detailed | --depth | Boolean | Adds a list of files to the directory fields | | Detailed | --depth | Boolean | Adds a list of files to the directory fields |
Returns: Key-Value Pair - Array of directory mappings Returns: Key-Value Pair - Array of directory mappings
```bsl title="Code example" ```bsl title="Code example"
Name = "Description"; Name = "Description";
Response = OPI_GoogleDrive.GetDirectoriesList(Token, Name, False); //Map Response = OPI_GoogleDrive.GetDirectoriesList(Token, Name, False); //Map
Response = OPI_Tools.JSONString(Response); //String Response = OPI_Tools.JSONString(Response); //String
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint gdrive GetDirectoriesList --token %token% --querry %querry% --depth %depth% oint gdrive GetDirectoriesList --token %token% --querry %querry% --depth %depth%
``` ```
```json title="Result" ```json title="Result"
[ [
{ {
"linkShareMetadata": { "linkShareMetadata": {
"securityUpdateEnabled": true, "securityUpdateEnabled": true,
"securityUpdateEligible": false "securityUpdateEligible": false
}, },
"modifiedByMe": true, "modifiedByMe": true,
"quotaBytesUsed": "0", "quotaBytesUsed": "0",
"viewedByMeTime": "2024-03-13T06:02:50.470Z", "viewedByMeTime": "2024-03-13T06:02:50.470Z",
"createdTime": "2024-03-13T06:02:50.470Z", "createdTime": "2024-03-13T06:02:50.470Z",
"permissionIds": [ "permissionIds": [
"07468399490707249352" "07468399490707249352"
], ],
"modifiedByMeTime": "2024-03-13T06:02:50.470Z", "modifiedByMeTime": "2024-03-13T06:02:50.470Z",
"explicitlyTrashed": false, "explicitlyTrashed": false,
"trashed": true, "trashed": true,
"id": "1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4", "id": "1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4",
"starred": false, "starred": false,
"name": "MovesDescription", "name": "MovesDescription",
"permissions": [ "permissions": [
{ {
"pendingOwner": false, "pendingOwner": false,
"role": "owner", "role": "owner",
"emailAddress": "bayselonarrend@gmail.com", "emailAddress": "bayselonarrend@gmail.com",
"photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64",
"kind": "drive#permission", "kind": "drive#permission",
"type": "user", "type": "user",
"deleted": false, "deleted": false,
"displayName": "Anton Titovets", "displayName": "Anton Titovets",
"id": "07468399490707249352" "id": "07468399490707249352"
} }
], ],
"spaces": [ "spaces": [
"drive" "drive"
], ],
"webViewLink": "https://drive.google.com/drive/folders/1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4", "webViewLink": "https://drive.google.com/drive/folders/1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4",
"isAppAuthorized": false, "isAppAuthorized": false,
"owners": [ "owners": [
{ {
"photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64",
"emailAddress": "bayselonarrend@gmail.com", "emailAddress": "bayselonarrend@gmail.com",
"permissionId": "07468399490707249352", "permissionId": "07468399490707249352",
"me": true, "me": true,
"kind": "drive#user", "kind": "drive#user",
"displayName": "Anton Titovets" "displayName": "Anton Titovets"
} }
], ],
"version": "2", "version": "2",
"lastModifyingUser": { "lastModifyingUser": {
"photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64",
"emailAddress": "bayselonarrend@gmail.com", "emailAddress": "bayselonarrend@gmail.com",
"permissionId": "07468399490707249352", "permissionId": "07468399490707249352",
"me": true, "me": true,
"kind": "drive#user", "kind": "drive#user",
"displayName": "Anton Titovets" "displayName": "Anton Titovets"
}, },
"shared": false, "shared": false,
"hasThumbnail": false, "hasThumbnail": false,
"parents": [ "parents": [
"1PAFI1-rThB46uix012xmLQ01h-JARjaz" "1PAFI1-rThB46uix012xmLQ01h-JARjaz"
], ],
"ownedByMe": true, "ownedByMe": true,
"mimeType": "application/vnd.google-apps.folder", "mimeType": "application/vnd.google-apps.folder",
"viewersCanCopyContent": true, "viewersCanCopyContent": true,
"iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/application/vnd.google-apps.folder", "iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/application/vnd.google-apps.folder",
"viewedByMe": true, "viewedByMe": true,
"writersCanShare": true, "writersCanShare": true,
"folderColorRgb": "#8f8f8f", "folderColorRgb": "#8f8f8f",
"copyRequiresWriterPermission": false, "copyRequiresWriterPermission": false,
"capabilities": { "capabilities": {
"canRemoveContentRestriction": false, "canRemoveContentRestriction": false,
"canModifyOwnerContentRestriction": false, "canModifyOwnerContentRestriction": false,
"canModifyLabels": false, "canModifyLabels": false,
"canAcceptOwnership": false, "canAcceptOwnership": false,
"canChangeSecurityUpdateEnabled": false, "canChangeSecurityUpdateEnabled": false,
"canMoveItemWithinDrive": true, "canMoveItemWithinDrive": true,
"canRemoveMyDriveParent": true, "canRemoveMyDriveParent": true,
"canReadLabels": false, "canReadLabels": false,
"canAddMyDriveParent": false, "canAddMyDriveParent": false,
"canShare": true, "canShare": true,
"canModifyContent": true, "canModifyContent": true,
"canUntrash": true, "canUntrash": true,
"canMoveItemOutOfDrive": false, "canMoveItemOutOfDrive": false,
"canMoveItemIntoTeamDrive": false, "canMoveItemIntoTeamDrive": false,
"canModifyContentRestriction": false, "canModifyContentRestriction": false,
"canReadRevisions": false, "canReadRevisions": false,
"canTrash": true, "canTrash": true,
"canRemoveChildren": true, "canRemoveChildren": true,
"canListChildren": true, "canListChildren": true,
"canDownload": true, "canDownload": true,
"canDelete": true, "canDelete": true,
"canRename": true, "canRename": true,
"canChangeCopyRequiresWriterPermission": false, "canChangeCopyRequiresWriterPermission": false,
"canAddChildren": true, "canAddChildren": true,
"canComment": true, "canComment": true,
"canModifyEditorContentRestriction": false, "canModifyEditorContentRestriction": false,
"canMoveChildrenWithinDrive": true, "canMoveChildrenWithinDrive": true,
"canCopy": false, "canCopy": false,
"canChangeViewersCanCopyContent": false, "canChangeViewersCanCopyContent": false,
"canEdit": true "canEdit": true
}, },
"modifiedTime": "2024-03-13T06:02:50.470Z", "modifiedTime": "2024-03-13T06:02:50.470Z",
"thumbnailVersion": "0", "thumbnailVersion": "0",
"kind": "drive#file" "kind": "drive#file"
} }
] ]
``` ```

88
docs/en/md/Google_Drive/File-and-directory-management/Get-file-description.md
View File

@@ -1,44 +1,44 @@
--- ---
sidebar_position: 10 sidebar_position: 10
--- ---
# Get description file # Get description file
*Function GetFileDescription() Export* *Function GetFileDescription() Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
Returns: Key-Value Pair - File description Returns: Key-Value Pair - File description
```bsl title="Code example" ```bsl title="Code example"
Description = New Map; Description = New Map;
Description.Insert("MIME", "image/jpeg"); // MIME-type uploading file Description.Insert("MIME", "image/jpeg"); // MIME-type uploading file
Description.Insert("Name", "New file.jpg"); // File name with extension Description.Insert("Name", "New file.jpg"); // File name with extension
Description.Insert("Description", "This is a new file"); // File description Description.Insert("Description", "This is a new file"); // File description
Description.Insert("Parent", "root"); // ID directory upload or "root" for upload in root Description.Insert("Parent", "root"); // ID directory upload or "root" for upload in root
Return Description; Return Description;
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint gdrive GetFileDescription oint gdrive GetFileDescription
``` ```
```json title="Result" ```json title="Result"
``` ```

354
docs/en/md/Google_Drive/File-and-directory-management/Get-files-list.md
View File

@@ -1,177 +1,177 @@
--- ---
sidebar_position: 3 sidebar_position: 3
--- ---
# Get list of files # Get list of files
Gets the list of files Gets the list of files
*Function GetFilesList(Val Token, Val NameContains = "", Val Directory = "") Export* *Function GetFilesList(Val Token, Val NameContains = "", Val Directory = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| NameContains | --querry | String | Filter by name | | NameContains | --querry | String | Filter by name |
| Directory | --catalog | String | Filter by parent directory ID | | Directory | --catalog | String | Filter by parent directory ID |
Returns: Key-Value Pair - Array of file mappings Returns: Key-Value Pair - Array of file mappings
```bsl title="Code example" ```bsl title="Code example"
Directory = "1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4"; Directory = "1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4";
Response = OPI_GoogleDrive.GetFilesList(Token,, Directory); //Map Response = OPI_GoogleDrive.GetFilesList(Token,, Directory); //Map
Response = OPI_Tools.JSONString(Response); //String Response = OPI_Tools.JSONString(Response); //String
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint gdrive GetFilesList --token %token% --querry %querry% --catalog "1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4" oint gdrive GetFilesList --token %token% --querry %querry% --catalog "1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4"
``` ```
```json title="Result" ```json title="Result"
[ [
{ {
"sha256Checksum": "1a03612de72929ef42a272cb17123871bf9b7723c89f9659765a49f744b6162b", "sha256Checksum": "1a03612de72929ef42a272cb17123871bf9b7723c89f9659765a49f744b6162b",
"linkShareMetadata": { "linkShareMetadata": {
"securityUpdateEnabled": true, "securityUpdateEnabled": true,
"securityUpdateEligible": false "securityUpdateEligible": false
}, },
"imageMediaMetadata": { "imageMediaMetadata": {
"exposureBias": 0, "exposureBias": 0,
"focalLength": 5.2, "focalLength": 5.2,
"exposureTime": 0.00125, "exposureTime": 0.00125,
"cameraMake": "SONY", "cameraMake": "SONY",
"isoSpeed": 100, "isoSpeed": 100,
"time": "2012:08:03 08:21:50", "time": "2012:08:03 08:21:50",
"width": 3264, "width": 3264,
"cameraModel": "DSC-H7", "cameraModel": "DSC-H7",
"whiteBalance": "Auto", "whiteBalance": "Auto",
"colorSpace": "sRGB", "colorSpace": "sRGB",
"aperture": 5.6, "aperture": 5.6,
"exposureMode": "Auto", "exposureMode": "Auto",
"rotation": 0, "rotation": 0,
"height": 2448, "height": 2448,
"meteringMode": "Pattern", "meteringMode": "Pattern",
"maxApertureValue": 2.875, "maxApertureValue": 2.875,
"flashUsed": true "flashUsed": true
}, },
"modifiedByMe": true, "modifiedByMe": true,
"thumbnailVersion": "1", "thumbnailVersion": "1",
"fullFileExtension": "jpg", "fullFileExtension": "jpg",
"quotaBytesUsed": "2114025", "quotaBytesUsed": "2114025",
"viewedByMeTime": "2024-03-17T08:09:01.753Z", "viewedByMeTime": "2024-03-17T08:09:01.753Z",
"permissionIds": [ "permissionIds": [
"07468399490707249352" "07468399490707249352"
], ],
"modifiedByMeTime": "2024-03-17T08:05:59.327Z", "modifiedByMeTime": "2024-03-17T08:05:59.327Z",
"explicitlyTrashed": false, "explicitlyTrashed": false,
"trashed": false, "trashed": false,
"description": "This is a new file", "description": "This is a new file",
"createdTime": "2024-03-17T08:05:59.327Z", "createdTime": "2024-03-17T08:05:59.327Z",
"id": "1_3QPKWfAhAT0pl0QA1QSC6mRKZndwUrD", "id": "1_3QPKWfAhAT0pl0QA1QSC6mRKZndwUrD",
"starred": false, "starred": false,
"spaces": [ "spaces": [
"drive" "drive"
], ],
"name": "New file.jpg", "name": "New file.jpg",
"permissions": [ "permissions": [
{ {
"pendingOwner": false, "pendingOwner": false,
"role": "owner", "role": "owner",
"emailAddress": "bayselonarrend@gmail.com", "emailAddress": "bayselonarrend@gmail.com",
"photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64",
"kind": "drive#permission", "kind": "drive#permission",
"type": "user", "type": "user",
"deleted": false, "deleted": false,
"displayName": "Anton Titovets", "displayName": "Anton Titovets",
"id": "07468399490707249352" "id": "07468399490707249352"
} }
], ],
"webContentLink": "https://drive.google.com/uc?id=1_3QPKWfAhAT0pl0QA1QSC6mRKZndwUrD&export=download", "webContentLink": "https://drive.google.com/uc?id=1_3QPKWfAhAT0pl0QA1QSC6mRKZndwUrD&export=download",
"isAppAuthorized": true, "isAppAuthorized": true,
"webViewLink": "https://drive.google.com/file/d/1_3QPKWfAhAT0pl0QA1QSC6mRKZndwUrD/view?usp=drivesdk", "webViewLink": "https://drive.google.com/file/d/1_3QPKWfAhAT0pl0QA1QSC6mRKZndwUrD/view?usp=drivesdk",
"version": "4", "version": "4",
"owners": [ "owners": [
{ {
"photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64",
"emailAddress": "bayselonarrend@gmail.com", "emailAddress": "bayselonarrend@gmail.com",
"permissionId": "07468399490707249352", "permissionId": "07468399490707249352",
"me": true, "me": true,
"kind": "drive#user", "kind": "drive#user",
"displayName": "Anton Titovets" "displayName": "Anton Titovets"
} }
], ],
"lastModifyingUser": { "lastModifyingUser": {
"photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64",
"emailAddress": "bayselonarrend@gmail.com", "emailAddress": "bayselonarrend@gmail.com",
"permissionId": "07468399490707249352", "permissionId": "07468399490707249352",
"me": true, "me": true,
"kind": "drive#user", "kind": "drive#user",
"displayName": "Anton Titovets" "displayName": "Anton Titovets"
}, },
"hasThumbnail": true, "hasThumbnail": true,
"shared": false, "shared": false,
"ownedByMe": true, "ownedByMe": true,
"parents": [ "parents": [
"1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4" "1VWoLK5w0uPVSjK3oyIXeiMtINN4jDOz4"
], ],
"sha1Checksum": "ebdbaf8ed7fe21f6562fde438a2bb12ba49750f2", "sha1Checksum": "ebdbaf8ed7fe21f6562fde438a2bb12ba49750f2",
"viewedByMe": true, "viewedByMe": true,
"headRevisionId": "0B92vrbrhqfJrN1VxL1Nib01LOVV1V3ArN3pGRytVMUNKQWs4PQ", "headRevisionId": "0B92vrbrhqfJrN1VxL1Nib01LOVV1V3ArN3pGRytVMUNKQWs4PQ",
"writersCanShare": true, "writersCanShare": true,
"thumbnailLink": "https://lh3.googleusercontent.com/drive-storage/AJQWtBNcYDmfZOJX84IFS9WFTZXNjlIFg8qaIfYni7xr0ILGZ2rGr_-R2ixRuP9zBMHCp6bpROqLp3WtddBL1p1mwc7Zv8je0Ru2dVbDTKLryg=s220", "thumbnailLink": "https://lh3.googleusercontent.com/drive-storage/AJQWtBNcYDmfZOJX84IFS9WFTZXNjlIFg8qaIfYni7xr0ILGZ2rGr_-R2ixRuP9zBMHCp6bpROqLp3WtddBL1p1mwc7Zv8je0Ru2dVbDTKLryg=s220",
"modifiedTime": "2024-03-17T08:05:59.327Z", "modifiedTime": "2024-03-17T08:05:59.327Z",
"capabilities": { "capabilities": {
"canRemoveContentRestriction": false, "canRemoveContentRestriction": false,
"canModifyOwnerContentRestriction": true, "canModifyOwnerContentRestriction": true,
"canModifyLabels": false, "canModifyLabels": false,
"canAcceptOwnership": false, "canAcceptOwnership": false,
"canChangeSecurityUpdateEnabled": false, "canChangeSecurityUpdateEnabled": false,
"canMoveItemWithinDrive": true, "canMoveItemWithinDrive": true,
"canRemoveMyDriveParent": true, "canRemoveMyDriveParent": true,
"canReadLabels": false, "canReadLabels": false,
"canAddMyDriveParent": false, "canAddMyDriveParent": false,
"canShare": true, "canShare": true,
"canModifyContent": true, "canModifyContent": true,
"canUntrash": true, "canUntrash": true,
"canMoveItemOutOfDrive": true, "canMoveItemOutOfDrive": true,
"canMoveItemIntoTeamDrive": true, "canMoveItemIntoTeamDrive": true,
"canModifyContentRestriction": true, "canModifyContentRestriction": true,
"canReadRevisions": true, "canReadRevisions": true,
"canTrash": true, "canTrash": true,
"canRemoveChildren": false, "canRemoveChildren": false,
"canListChildren": false, "canListChildren": false,
"canDownload": true, "canDownload": true,
"canDelete": true, "canDelete": true,
"canRename": true, "canRename": true,
"canChangeCopyRequiresWriterPermission": true, "canChangeCopyRequiresWriterPermission": true,
"canAddChildren": false, "canAddChildren": false,
"canComment": true, "canComment": true,
"canModifyEditorContentRestriction": true, "canModifyEditorContentRestriction": true,
"canMoveChildrenWithinDrive": false, "canMoveChildrenWithinDrive": false,
"canCopy": true, "canCopy": true,
"canChangeViewersCanCopyContent": true, "canChangeViewersCanCopyContent": true,
"canEdit": true "canEdit": true
}, },
"md5Checksum": "85b6518b95b58536480354d9d5fc3d8b", "md5Checksum": "85b6518b95b58536480354d9d5fc3d8b",
"copyRequiresWriterPermission": false, "copyRequiresWriterPermission": false,
"fileExtension": "jpg", "fileExtension": "jpg",
"originalFilename": "New file.jpg", "originalFilename": "New file.jpg",
"iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/image/jpeg", "iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/image/jpeg",
"viewersCanCopyContent": true, "viewersCanCopyContent": true,
"mimeType": "image/jpeg", "mimeType": "image/jpeg",
"kind": "drive#file", "kind": "drive#file",
"size": "2114025" "size": "2114025"
} }
] ]
``` ```

292
docs/en/md/Google_Drive/File-and-directory-management/Get-object-information.md
View File

@@ -1,146 +1,146 @@
--- ---
sidebar_position: 1 sidebar_position: 1
--- ---
# Get object information # Get object information
Gets information about a folder or file by ID Gets information about a folder or file by ID
*Function GetObjectInformation(Val Token, Val Identifier) Export* *Function GetObjectInformation(Val Token, Val Identifier) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Identifier | --object | String | Identifier of the file or folder | | Identifier | --object | String | Identifier of the file or folder |
Returns: Key-Value Pair - serialized JSON response from Google Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example" ```bsl title="Code example"
Identifier = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa"; Identifier = "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa";
Response = OPI_GoogleDrive.GetObjectInformation(Token, Identifier); //Map Response = OPI_GoogleDrive.GetObjectInformation(Token, Identifier); //Map
Response = OPI_Tools.JSONString(Response); //String Response = OPI_Tools.JSONString(Response); //String
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint gdrive GetObjectInformation --token %token% --object "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa" oint gdrive GetObjectInformation --token %token% --object "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa"
``` ```
```json title="Result" ```json title="Result"
{ {
"linkShareMetadata": { "linkShareMetadata": {
"securityUpdateEnabled": true, "securityUpdateEnabled": true,
"securityUpdateEligible": false "securityUpdateEligible": false
}, },
"quotaBytesUsed": "0", "quotaBytesUsed": "0",
"folderColorRgb": "#8f8f8f", "folderColorRgb": "#8f8f8f",
"writersCanShare": true, "writersCanShare": true,
"lastModifyingUser": { "lastModifyingUser": {
"emailAddress": "bayselonarrend@gmail.com", "emailAddress": "bayselonarrend@gmail.com",
"permissionId": "07468399490707249352", "permissionId": "07468399490707249352",
"me": true, "me": true,
"photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64",
"displayName": "Anton Titovets", "displayName": "Anton Titovets",
"kind": "drive#user" "kind": "drive#user"
}, },
"modifiedByMe": true, "modifiedByMe": true,
"capabilities": { "capabilities": {
"canUntrash": true, "canUntrash": true,
"canTrash": true, "canTrash": true,
"canRemoveMyDriveParent": true, "canRemoveMyDriveParent": true,
"canRemoveContentRestriction": false, "canRemoveContentRestriction": false,
"canRemoveChildren": true, "canRemoveChildren": true,
"canMoveItemWithinDrive": true, "canMoveItemWithinDrive": true,
"canMoveItemOutOfDrive": true, "canMoveItemOutOfDrive": true,
"canMoveItemIntoTeamDrive": true, "canMoveItemIntoTeamDrive": true,
"canModifyLabels": false, "canModifyLabels": false,
"canModifyOwnerContentRestriction": false, "canModifyOwnerContentRestriction": false,
"canReadRevisions": false, "canReadRevisions": false,
"canModifyContentRestriction": false, "canModifyContentRestriction": false,
"canShare": true, "canShare": true,
"canModifyContent": true, "canModifyContent": true,
"canDownload": true, "canDownload": true,
"canMoveChildrenWithinDrive": true, "canMoveChildrenWithinDrive": true,
"canCopy": false, "canCopy": false,
"canModifyEditorContentRestriction": false, "canModifyEditorContentRestriction": false,
"canChangeSecurityUpdateEnabled": false, "canChangeSecurityUpdateEnabled": false,
"canRename": true, "canRename": true,
"canChangeCopyRequiresWriterPermission": false, "canChangeCopyRequiresWriterPermission": false,
"canDelete": true, "canDelete": true,
"canChangeViewersCanCopyContent": false, "canChangeViewersCanCopyContent": false,
"canEdit": true, "canEdit": true,
"canReadLabels": false, "canReadLabels": false,
"canAddMyDriveParent": false, "canAddMyDriveParent": false,
"canComment": true, "canComment": true,
"canAddChildren": true, "canAddChildren": true,
"canListChildren": true, "canListChildren": true,
"canAcceptOwnership": false "canAcceptOwnership": false
}, },
"copyRequiresWriterPermission": false, "copyRequiresWriterPermission": false,
"modifiedTime": "2023-12-28T13:22:03.333Z", "modifiedTime": "2023-12-28T13:22:03.333Z",
"createdTime": "2023-12-28T13:22:00.683Z", "createdTime": "2023-12-28T13:22:00.683Z",
"viewedByMeTime": "2023-12-28T13:22:00.683Z", "viewedByMeTime": "2023-12-28T13:22:00.683Z",
"viewedByMe": true, "viewedByMe": true,
"shared": false, "shared": false,
"hasThumbnail": false, "hasThumbnail": false,
"version": "3", "version": "3",
"owners": [ "owners": [
{ {
"emailAddress": "bayselonarrend@gmail.com", "emailAddress": "bayselonarrend@gmail.com",
"permissionId": "07468399490707249352", "permissionId": "07468399490707249352",
"me": true, "me": true,
"photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64",
"displayName": "Anton Titovets", "displayName": "Anton Titovets",
"kind": "drive#user" "kind": "drive#user"
} }
], ],
"isAppAuthorized": false, "isAppAuthorized": false,
"webViewLink": "https://drive.google.com/drive/folders/1dg_MhZrLoPSPYT0p3y-8dvGWoapbwiDm", "webViewLink": "https://drive.google.com/drive/folders/1dg_MhZrLoPSPYT0p3y-8dvGWoapbwiDm",
"spaces": [ "spaces": [
"drive" "drive"
], ],
"modifiedByMeTime": "2023-12-28T13:22:03.333Z", "modifiedByMeTime": "2023-12-28T13:22:03.333Z",
"permissionIds": [ "permissionIds": [
"07468399490707249352" "07468399490707249352"
], ],
"explicitlyTrashed": false, "explicitlyTrashed": false,
"parents": [ "parents": [
"1603PU_Hrkvj4HeFJKYSVxZJDRoGvd3SJ" "1603PU_Hrkvj4HeFJKYSVxZJDRoGvd3SJ"
], ],
"ownedByMe": true, "ownedByMe": true,
"trashed": false, "trashed": false,
"iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/application/vnd.google-apps.folder", "iconLink": "https://drive-thirdparty.googleusercontent.com/16/type/application/vnd.google-apps.folder",
"viewersCanCopyContent": true, "viewersCanCopyContent": true,
"mimeType": "application/vnd.google-apps.folder", "mimeType": "application/vnd.google-apps.folder",
"permissions": [ "permissions": [
{ {
"pendingOwner": false, "pendingOwner": false,
"photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64", "photoLink": "https://lh3.googleusercontent.com/a/ACg8ocLx8JGurt0UjXFwwTiB6ZoDPWslW1EnfCTahrwrIllM6Q=s64",
"role": "owner", "role": "owner",
"emailAddress": "bayselonarrend@gmail.com", "emailAddress": "bayselonarrend@gmail.com",
"type": "user", "type": "user",
"deleted": false, "deleted": false,
"displayName": "Anton Titovets", "displayName": "Anton Titovets",
"id": "07468399490707249352", "id": "07468399490707249352",
"kind": "drive#permission" "kind": "drive#permission"
} }
], ],
"name": "OPI", "name": "OPI",
"starred": false, "starred": false,
"id": "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa", "id": "1dg_MwwwPSPYT0p3y-8dvGWoapbwaaaaa",
"kind": "drive#file", "kind": "drive#file",
"thumbnailVersion": "0" "thumbnailVersion": "0"
} }
``` ```

104
docs/en/md/Google_Drive/File-and-directory-management/Update-file.md
View File

@@ -1,52 +1,52 @@
--- ---
sidebar_position: 8 sidebar_position: 8
--- ---
# Update file # Update file
Updates file binary data Updates file binary data
*Function UpdateFile(Val Token, Val Identifier, Val File, Val NewName = "") Export* *Function UpdateFile(Val Token, Val Identifier, Val File, Val NewName = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Identifier | --object | String | Identifier of the object to update | | Identifier | --object | String | Identifier of the object to update |
| File | --file | BinaryData,String | File source for update | | File | --file | BinaryData,String | File source for update |
| NewName | --title | String | New file name (if necessary) | | NewName | --title | String | New file name (if necessary) |
Returns: Key-Value Pair - serialized JSON response from Google Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example" ```bsl title="Code example"
NewName = "Updated file.jpeg"; NewName = "Updated file.jpeg";
ReplacementImage = "C:\OPI\image2.jpg"; ReplacementImage = "C:\OPI\image2.jpg";
Identifier = "1V0oaZh3qQZ7-wbARC8-vrErAFllsBGSJ"; Identifier = "1V0oaZh3qQZ7-wbARC8-vrErAFllsBGSJ";
Response = OPI_GoogleDrive.UpdateFile(Token, Identifier, ReplacementImage, NewName) //Map Response = OPI_GoogleDrive.UpdateFile(Token, Identifier, ReplacementImage, NewName) //Map
Response = OPI_Tools.JSONString(Response); //String Response = OPI_Tools.JSONString(Response); //String
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint gdrive UpdateFile --token %token% --object "1V0oaZh3qQZ7-wbARC8-vrErAFllsBGSJ" --file %file% --title "Updated file.jpeg" oint gdrive UpdateFile --token %token% --object "1V0oaZh3qQZ7-wbARC8-vrErAFllsBGSJ" --file %file% --title "Updated file.jpeg"
``` ```
```json title="Result" ```json title="Result"
{ {
"mimeType": "image/jpeg", "mimeType": "image/jpeg",
"name": "UpdatedFile.jpg", "name": "UpdatedFile.jpg",
"id": "1V0oaZh3qQZ7-wbARC8-vrErAFllsBGSJ", "id": "1V0oaZh3qQZ7-wbARC8-vrErAFllsBGSJ",
"kind": "drive#file" "kind": "drive#file"
} }
``` ```

110
docs/en/md/Google_Drive/File-and-directory-management/Upload-file.md
View File

@@ -1,55 +1,55 @@
--- ---
sidebar_position: 4 sidebar_position: 4
--- ---
# Upload file # Upload file
Uploads a file to the drive Uploads a file to the drive
*Function UploadFile(Val Token, Val File, Val Description) ExportReturn FileManagement(Token, File, Description);EndFunction* *Function UploadFile(Val Token, Val File, Val Description) ExportReturn FileManagement(Token, File, Description);EndFunction*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| File | --file | BinaryData,String | File to be uploaded | | File | --file | BinaryData,String | File to be uploaded |
| Description | --props | Key-Value Pair | JSON description or path to .json | | Description | --props | Key-Value Pair | JSON description or path to .json |
Returns: Key-Value Pair - serialized JSON response from Google Returns: Key-Value Pair - serialized JSON response from Google
```bsl title="Code example" ```bsl title="Code example"
Description = New Map; Description = New Map;
Description.Insert("MIME", "image/jpeg"); Description.Insert("MIME", "image/jpeg");
Description.Insert("Name", "New file.jpg"); Description.Insert("Name", "New file.jpg");
Description.Insert("Description", "This is a new file"); Description.Insert("Description", "This is a new file");
Description.Insert("Parent", "root"); Description.Insert("Parent", "root");
Image = "C:\OPI\image.jpg"; Image = "C:\OPI\image.jpg";
Response = OPI_GoogleDrive.UploadFile(Token, Image, Description); //Map Response = OPI_GoogleDrive.UploadFile(Token, Image, Description); //Map
Response = OPI_Tools.JSONString(Response); //String Response = OPI_Tools.JSONString(Response); //String
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint gdrive UploadFile --token %token% --file %file% --props %props% oint gdrive UploadFile --token %token% --file %file% --props %props%
``` ```
```json title="Result" ```json title="Result"
{ {
"mimeType": "image/jpeg", "mimeType": "image/jpeg",
"name": "New file.jpg", "name": "New file.jpg",
"id": "16hPGNTMmbnXhz_g0vjGbrLP19h56RwIg", "id": "16hPGNTMmbnXhz_g0vjGbrLP19h56RwIg",
"kind": "drive#file" "kind": "drive#file"
} }
``` ```

8
docs/en/md/Google_Drive/File-and-directory-management/_category_.json
View File

@@ -1,4 +1,4 @@
{ {
"label": "File and directory management", "label": "File and directory management",
"position": "2" "position": "2"
} }

Some files were not shown because too many files have changed in this diff Show More