1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2024-12-25 02:42:28 +02:00

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

This commit is contained in:
Vitaly the Alpaca 2024-06-07 11:53:24 +00:00 committed by Vitaly the Alpaca (bot)
parent cff467e14d
commit c7721282ba
159 changed files with 6660 additions and 6660 deletions

View File

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

View File

@ -1,4 +1,4 @@
{ {
"label": "Working with databases", "label": "Working with databases",
"position": "2" "position": "2"
} }

View File

@ -1,4 +1,4 @@
{ {
"label": "Working with fields", "label": "Working with fields",
"position": "4" "position": "4"
} }

View File

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

View File

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

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 | Map Of KeyAndValue | Table description: Key > name, Value > array of fields | | TableCollection | --tablesdata | Map Of KeyAndValue | Table description: Key > name, Value > array of fields |
Returns: Map Of KeyAndValue - serialized JSON response from Airtable Returns: Map Of KeyAndValue - 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"
} }
] ]
} }
] ]
} }
``` ```

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: Map Of KeyAndValue - serialized JSON response from Airtable Returns: Map Of KeyAndValue - 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"
} }
] ]
} }
] ]
} }
``` ```

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: Map Of KeyAndValue - serialized JSON response from Airtable Returns: Map Of KeyAndValue - 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"
} }
] ]
} }
``` ```

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: Map Of KeyAndValue - serialized JSON response from Airtable Returns: Map Of KeyAndValue - 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"
} }
``` ```

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) Export* *Function GetAttachmentField(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 = "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"
} }
``` ```

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"
} }
} }
``` ```

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"
} }
} }
} }
``` ```

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) Export* *Function GetEmailField(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 = "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"
} }
``` ```

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) Export* *Function GetLinkField(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 = "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"
} }
``` ```

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
} }
} }
``` ```

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) Export* *Function GetPhoneField(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 = "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"
} }
``` ```

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) Export* *Function GetStringField(Val Name) Export*
| 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"
} }
``` ```

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: Map Of KeyAndValue - serialized JSON response from Airtable Returns: Map Of KeyAndValue - 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"
} }
``` ```

View File

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

View File

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

View File

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

View File

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

View File

@ -1,4 +1,4 @@
{ {
"label": "Tags managment", "label": "Tags managment",
"position": "4" "position": "4"
} }

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: Map Of KeyAndValue - serialized JSON response from Dropbox Returns: Map Of KeyAndValue - 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"
{} {}
``` ```

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: Map Of KeyAndValue - serialized JSON response from Dropbox Returns: Map Of KeyAndValue - 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"
{} {}
``` ```

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: Map Of KeyAndValue - serialized JSON response from Dropbox Returns: Map Of KeyAndValue - 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"
} }
] ]
} }
] ]
} }
``` ```

View File

@ -1,8 +1,8 @@
{ {
"label": null, "label": null,
"position": 12, "position": 12,
"link": { "link": {
"type": "doc", "type": "doc",
"id": "Dropbox" "id": "Dropbox"
} }
} }

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -1,4 +1,4 @@
{ {
"label": "Books managment", "label": "Books managment",
"position": "2" "position": "2"
} }

View File

@ -1,208 +1,208 @@
--- ---
sidebar_position: 1 sidebar_position: 1
--- ---
# CreateBook # CreateBook
Creates a new book Creates a new book
*Function CreateBook(Val Token, Val Name, Val ArrayOfSheetNames) Export* *Function CreateBook(Val Token, Val Name, Val ArrayOfSheetNames) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Name | --title | String | Name | | Name | --title | String | Name |
| ArrayOfSheetNames | --sheets | Array of String | Array of names to add new sheets to the book | | ArrayOfSheetNames | --sheets | Array of String | Array of names to add new sheets to the book |
Returns: Map Of KeyAndValue - serialized JSON response from Google Returns: Map Of KeyAndValue - serialized JSON response from Google
```bsl title="Code example" ```bsl title="Code example"
ArrayOfSheetNames = New Array; ArrayOfSheetNames = New Array;
ArrayOfSheetNames.Add("Sheet1"); ArrayOfSheetNames.Add("Sheet1");
ArrayOfSheetNames.Add("Sheet2"); ArrayOfSheetNames.Add("Sheet2");
Name = "TestTable"; Name = "TestTable";
Response = OPI_GoogleSheets.CreateBook(Token, Name, ArrayOfSheetNames); //Map Response = OPI_GoogleSheets.CreateBook(Token, Name, ArrayOfSheetNames); //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 gsheets CreateBook --token %token% --title "TestTable" --sheets %sheets% oint gsheets CreateBook --token %token% --title "TestTable" --sheets %sheets%
``` ```
```json title="Result" ```json title="Result"
{ {
"spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc",
"properties": { "properties": {
"title": "TestTable", "title": "TestTable",
"locale": "ru_RU", "locale": "ru_RU",
"autoRecalc": "ON_CHANGE", "autoRecalc": "ON_CHANGE",
"timeZone": "Etc/GMT", "timeZone": "Etc/GMT",
"defaultFormat": { "defaultFormat": {
"backgroundColor": { "backgroundColor": {
"red": 1, "red": 1,
"green": 1, "green": 1,
"blue": 1 "blue": 1
}, },
"padding": { "padding": {
"top": 2, "top": 2,
"right": 3, "right": 3,
"bottom": 2, "bottom": 2,
"left": 3 "left": 3
}, },
"verticalAlignment": "BOTTOM", "verticalAlignment": "BOTTOM",
"wrapStrategy": "OVERFLOW_CELL", "wrapStrategy": "OVERFLOW_CELL",
"textFormat": { "textFormat": {
"foregroundColor": {}, "foregroundColor": {},
"fontFamily": "arial,sans,sans-serif", "fontFamily": "arial,sans,sans-serif",
"fontSize": 10, "fontSize": 10,
"bold": false, "bold": false,
"italic": false, "italic": false,
"strikethrough": false, "strikethrough": false,
"underline": false, "underline": false,
"foregroundColorStyle": { "foregroundColorStyle": {
"rgbColor": {} "rgbColor": {}
} }
}, },
"backgroundColorStyle": { "backgroundColorStyle": {
"rgbColor": { "rgbColor": {
"red": 1, "red": 1,
"green": 1, "green": 1,
"blue": 1 "blue": 1
} }
} }
}, },
"spreadsheetTheme": { "spreadsheetTheme": {
"primaryFontFamily": "Arial", "primaryFontFamily": "Arial",
"themeColors": [ "themeColors": [
{ {
"colorType": "TEXT", "colorType": "TEXT",
"color": { "color": {
"rgbColor": {} "rgbColor": {}
} }
}, },
{ {
"colorType": "BACKGROUND", "colorType": "BACKGROUND",
"color": { "color": {
"rgbColor": { "rgbColor": {
"red": 1, "red": 1,
"green": 1, "green": 1,
"blue": 1 "blue": 1
} }
} }
}, },
{ {
"colorType": "ACCENT1", "colorType": "ACCENT1",
"color": { "color": {
"rgbColor": { "rgbColor": {
"red": 0.25882354, "red": 0.25882354,
"green": 0.52156866, "green": 0.52156866,
"blue": 0.95686275 "blue": 0.95686275
} }
} }
}, },
{ {
"colorType": "ACCENT2", "colorType": "ACCENT2",
"color": { "color": {
"rgbColor": { "rgbColor": {
"red": 0.91764706, "red": 0.91764706,
"green": 0.2627451, "green": 0.2627451,
"blue": 0.20784314 "blue": 0.20784314
} }
} }
}, },
{ {
"colorType": "ACCENT3", "colorType": "ACCENT3",
"color": { "color": {
"rgbColor": { "rgbColor": {
"red": 0.9843137, "red": 0.9843137,
"green": 0.7372549, "green": 0.7372549,
"blue": 0.015686275 "blue": 0.015686275
} }
} }
}, },
{ {
"colorType": "ACCENT4", "colorType": "ACCENT4",
"color": { "color": {
"rgbColor": { "rgbColor": {
"red": 0.20392157, "red": 0.20392157,
"green": 0.65882355, "green": 0.65882355,
"blue": 0.3254902 "blue": 0.3254902
} }
} }
}, },
{ {
"colorType": "ACCENT5", "colorType": "ACCENT5",
"color": { "color": {
"rgbColor": { "rgbColor": {
"red": 1, "red": 1,
"green": 0.42745098, "green": 0.42745098,
"blue": 0.003921569 "blue": 0.003921569
} }
} }
}, },
{ {
"colorType": "ACCENT6", "colorType": "ACCENT6",
"color": { "color": {
"rgbColor": { "rgbColor": {
"red": 0.27450982, "red": 0.27450982,
"green": 0.7411765, "green": 0.7411765,
"blue": 0.7764706 "blue": 0.7764706
} }
} }
}, },
{ {
"colorType": "LINK", "colorType": "LINK",
"color": { "color": {
"rgbColor": { "rgbColor": {
"red": 0.06666667, "red": 0.06666667,
"green": 0.33333334, "green": 0.33333334,
"blue": 0.8 "blue": 0.8
} }
} }
} }
] ]
} }
}, },
"sheets": [ "sheets": [
{ {
"properties": { "properties": {
"sheetId": 1999766427, "sheetId": 1999766427,
"title": "Sheet1", "title": "Sheet1",
"index": 0, "index": 0,
"sheetType": "GRID", "sheetType": "GRID",
"gridProperties": { "gridProperties": {
"rowCount": 1000, "rowCount": 1000,
"columnCount": 26 "columnCount": 26
} }
} }
}, },
{ {
"properties": { "properties": {
"sheetId": 225184494, "sheetId": 225184494,
"title": "Sheet2", "title": "Sheet2",
"index": 1, "index": 1,
"sheetType": "GRID", "sheetType": "GRID",
"gridProperties": { "gridProperties": {
"rowCount": 1000, "rowCount": 1000,
"columnCount": 26 "columnCount": 26
} }
} }
} }
], ],
"spreadsheetUrl": "https://docs.google.com/spreadsheets/d/1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc/edit" "spreadsheetUrl": "https://docs.google.com/spreadsheets/d/1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc/edit"
} }
``` ```

View File

@ -1,50 +1,50 @@
--- ---
sidebar_position: 3 sidebar_position: 3
--- ---
# ChangeBookName # ChangeBookName
Changes the name of the existing book Changes the name of the existing book
*Function EditBookTitle(Val Token, Val Book, Val Name) Export* *Function EditBookTitle(Val Token, Val Book, Val Name) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Book | --spreadsheet | String | BookID | | Book | --spreadsheet | String | BookID |
| Name | --title | String | New name | | Name | --title | String | New name |
Returns: Map Of KeyAndValue - serialized JSON response from Google Returns: Map Of KeyAndValue - serialized JSON response from Google
```bsl title="Code example" ```bsl title="Code example"
Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Name = "Test table (change.)"; Name = "Test table (change.)";
Response = OPI_GoogleSheets.EditBookTitle(Token, Book, Name); //Map Response = OPI_GoogleSheets.EditBookTitle(Token, Book, 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 gsheets EditBookTitle --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --title "Test table (change.)" oint gsheets EditBookTitle --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --title "Test table (change.)"
``` ```
```json title="Result" ```json title="Result"
{ {
"spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc",
"replies": [ "replies": [
{} {}
] ]
} }
``` ```

View File

@ -1,203 +1,203 @@
--- ---
sidebar_position: 2 sidebar_position: 2
--- ---
# GetBook # GetBook
Gets information about the book by ID Gets information about the book by ID
*Function GetBook(Val Token, Val Identifier) Export* *Function GetBook(Val Token, Val Identifier) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Identifier | --spreadsheet | String | BookIdentifier | | Identifier | --spreadsheet | String | BookIdentifier |
Returns: Map Of KeyAndValue - serialized JSON response from Google Returns: Map Of KeyAndValue - serialized JSON response from Google
```bsl title="Code example" ```bsl title="Code example"
Identifier = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; Identifier = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Response = OPI_GoogleSheets.GetBook(Token, Identifier); //Map Response = OPI_GoogleSheets.GetBook(Token, Identifier); //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 gsheets GetBook --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" oint gsheets GetBook --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"
``` ```
```json title="Result" ```json title="Result"
{ {
"spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc",
"properties": { "properties": {
"title": "Test table (change.)", "title": "Test table (change.)",
"locale": "ru_RU", "locale": "ru_RU",
"autoRecalc": "ON_CHANGE", "autoRecalc": "ON_CHANGE",
"timeZone": "Etc/GMT", "timeZone": "Etc/GMT",
"defaultFormat": { "defaultFormat": {
"backgroundColor": { "backgroundColor": {
"red": 1, "red": 1,
"green": 1, "green": 1,
"blue": 1 "blue": 1
}, },
"padding": { "padding": {
"top": 2, "top": 2,
"right": 3, "right": 3,
"bottom": 2, "bottom": 2,
"left": 3 "left": 3
}, },
"verticalAlignment": "BOTTOM", "verticalAlignment": "BOTTOM",
"wrapStrategy": "OVERFLOW_CELL", "wrapStrategy": "OVERFLOW_CELL",
"textFormat": { "textFormat": {
"foregroundColor": {}, "foregroundColor": {},
"fontFamily": "arial,sans,sans-serif", "fontFamily": "arial,sans,sans-serif",
"fontSize": 10, "fontSize": 10,
"bold": false, "bold": false,
"italic": false, "italic": false,
"strikethrough": false, "strikethrough": false,
"underline": false, "underline": false,
"foregroundColorStyle": { "foregroundColorStyle": {
"rgbColor": {} "rgbColor": {}
} }
}, },
"backgroundColorStyle": { "backgroundColorStyle": {
"rgbColor": { "rgbColor": {
"red": 1, "red": 1,
"green": 1, "green": 1,
"blue": 1 "blue": 1
} }
} }
}, },
"spreadsheetTheme": { "spreadsheetTheme": {
"primaryFontFamily": "Arial", "primaryFontFamily": "Arial",
"themeColors": [ "themeColors": [
{ {
"colorType": "TEXT", "colorType": "TEXT",
"color": { "color": {
"rgbColor": {} "rgbColor": {}
} }
}, },
{ {
"colorType": "BACKGROUND", "colorType": "BACKGROUND",
"color": { "color": {
"rgbColor": { "rgbColor": {
"red": 1, "red": 1,
"green": 1, "green": 1,
"blue": 1 "blue": 1
} }
} }
}, },
{ {
"colorType": "ACCENT1", "colorType": "ACCENT1",
"color": { "color": {
"rgbColor": { "rgbColor": {
"red": 0.25882354, "red": 0.25882354,
"green": 0.52156866, "green": 0.52156866,
"blue": 0.95686275 "blue": 0.95686275
} }
} }
}, },
{ {
"colorType": "ACCENT2", "colorType": "ACCENT2",
"color": { "color": {
"rgbColor": { "rgbColor": {
"red": 0.91764706, "red": 0.91764706,
"green": 0.2627451, "green": 0.2627451,
"blue": 0.20784314 "blue": 0.20784314
} }
} }
}, },
{ {
"colorType": "ACCENT3", "colorType": "ACCENT3",
"color": { "color": {
"rgbColor": { "rgbColor": {
"red": 0.9843137, "red": 0.9843137,
"green": 0.7372549, "green": 0.7372549,
"blue": 0.015686275 "blue": 0.015686275
} }
} }
}, },
{ {
"colorType": "ACCENT4", "colorType": "ACCENT4",
"color": { "color": {
"rgbColor": { "rgbColor": {
"red": 0.20392157, "red": 0.20392157,
"green": 0.65882355, "green": 0.65882355,
"blue": 0.3254902 "blue": 0.3254902
} }
} }
}, },
{ {
"colorType": "ACCENT5", "colorType": "ACCENT5",
"color": { "color": {
"rgbColor": { "rgbColor": {
"red": 1, "red": 1,
"green": 0.42745098, "green": 0.42745098,
"blue": 0.003921569 "blue": 0.003921569
} }
} }
}, },
{ {
"colorType": "ACCENT6", "colorType": "ACCENT6",
"color": { "color": {
"rgbColor": { "rgbColor": {
"red": 0.27450982, "red": 0.27450982,
"green": 0.7411765, "green": 0.7411765,
"blue": 0.7764706 "blue": 0.7764706
} }
} }
}, },
{ {
"colorType": "LINK", "colorType": "LINK",
"color": { "color": {
"rgbColor": { "rgbColor": {
"red": 0.06666667, "red": 0.06666667,
"green": 0.33333334, "green": 0.33333334,
"blue": 0.8 "blue": 0.8
} }
} }
} }
] ]
} }
}, },
"sheets": [ "sheets": [
{ {
"properties": { "properties": {
"sheetId": 1999766427, "sheetId": 1999766427,
"title": "Sheet1", "title": "Sheet1",
"index": 0, "index": 0,
"sheetType": "GRID", "sheetType": "GRID",
"gridProperties": { "gridProperties": {
"rowCount": 1000, "rowCount": 1000,
"columnCount": 26 "columnCount": 26
} }
} }
}, },
{ {
"properties": { "properties": {
"sheetId": 225184494, "sheetId": 225184494,
"title": "Sheet2", "title": "Sheet2",
"index": 1, "index": 1,
"sheetType": "GRID", "sheetType": "GRID",
"gridProperties": { "gridProperties": {
"rowCount": 1000, "rowCount": 1000,
"columnCount": 26 "columnCount": 26
} }
} }
} }
], ],
"spreadsheetUrl": "https://docs.google.com/spreadsheets/d/1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc/edit" "spreadsheetUrl": "https://docs.google.com/spreadsheets/d/1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc/edit"
} }
``` ```

View File

@ -1,58 +1,58 @@
--- ---
sidebar_position: 2 sidebar_position: 2
--- ---
# Clear cells # Clear cells
Clears the value in cells Clears the value in cells
*Function ClearCells(Val Token, Val Book, Val CellsArray, Val Sheet = "") Export* *Function ClearCells(Val Token, Val Book, Val CellsArray, Val Sheet = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Book | --spreadsheet | String | BookID | | Book | --spreadsheet | String | BookID |
| CellsArray | --cells | Array of String | Array of cells like A1 to be cleared | | CellsArray | --cells | Array of String | Array of cells like A1 to be cleared |
| Sheet | --sheetname | String | Sheet name (first sheet by default) | | Sheet | --sheetname | String | Sheet name (first sheet by default) |
Returns: Map Of KeyAndValue - serialized JSON response from Google Returns: Map Of KeyAndValue - serialized JSON response from Google
```bsl title="Code example" ```bsl title="Code example"
CellsArray = New Array; CellsArray = New Array;
CellsArray.Add("B2"); CellsArray.Add("B2");
CellsArray.Add("A3"); CellsArray.Add("A3");
CellsArray.Add("B4"); CellsArray.Add("B4");
Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Sheet = "Sheet2"; Sheet = "Sheet2";
Response = OPI_GoogleSheets.ClearCells(Token, Book, CellsArray, Sheet); //Map Response = OPI_GoogleSheets.ClearCells(Token, Book, CellsArray, Sheet); //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 gsheets ClearCells --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --cells %cells% --sheetname "Sheet2" oint gsheets ClearCells --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --cells %cells% --sheetname "Sheet2"
``` ```
```json title="Result" ```json title="Result"
{ {
"spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc",
"clearedRanges": [ "clearedRanges": [
"'Sheet2'!B2", "'Sheet2'!B2",
"'Sheet2'!A3", "'Sheet2'!A3",
"'Sheet2'!B4" "'Sheet2'!B4"
] ]
} }
``` ```

View File

@ -1,82 +1,82 @@
--- ---
sidebar_position: 3 sidebar_position: 3
--- ---
# Get cell values # Get cell values
Gets cell values of the table Gets cell values of the table
*Function GetCellValues(Val Token, Val Book, Val CellsArray = "", Val Sheet = "") Export* *Function GetCellValues(Val Token, Val Book, Val CellsArray = "", Val Sheet = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Book | --spreadsheet | String | BookID | | Book | --spreadsheet | String | BookID |
| CellsArray | --cells | Array of String | Array of A1-type cells to get (whole sheet if not filled) | | CellsArray | --cells | Array of String | Array of A1-type cells to get (whole sheet if not filled) |
| Sheet | --sheetname | String | Sheet name (first sheet by default) | | Sheet | --sheetname | String | Sheet name (first sheet by default) |
Returns: Map Of KeyAndValue - serialized JSON response from Google Returns: Map Of KeyAndValue - serialized JSON response from Google
```bsl title="Code example" ```bsl title="Code example"
CellsArray = New Array; CellsArray = New Array;
CellsArray.Add("B2"); CellsArray.Add("B2");
CellsArray.Add("A3"); CellsArray.Add("A3");
CellsArray.Add("B4"); CellsArray.Add("B4");
Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Sheet = "Sheet2"; Sheet = "Sheet2";
Response = OPI_GoogleSheets.GetCellValues(Token, Book, CellsArray, Sheet); //Map Response = OPI_GoogleSheets.GetCellValues(Token, Book, CellsArray, Sheet); //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 gsheets GetCellValues --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --cells %cells% --sheetname "Sheet2" oint gsheets GetCellValues --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --cells %cells% --sheetname "Sheet2"
``` ```
```json title="Result" ```json title="Result"
{ {
"spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc",
"valueRanges": [ "valueRanges": [
{ {
"range": "'Sheet2'!B2", "range": "'Sheet2'!B2",
"majorDimension": "ROWS", "majorDimension": "ROWS",
"values": [ "values": [
[ [
"ThisIsB2" "ThisIsB2"
] ]
] ]
}, },
{ {
"range": "'Sheet2'!A3", "range": "'Sheet2'!A3",
"majorDimension": "ROWS", "majorDimension": "ROWS",
"values": [ "values": [
[ [
"ThisIsA3" "ThisIsA3"
] ]
] ]
}, },
{ {
"range": "'Sheet2'!B4", "range": "'Sheet2'!B4",
"majorDimension": "ROWS", "majorDimension": "ROWS",
"values": [ "values": [
[ [
"ThisIsB4" "ThisIsB4"
] ]
] ]
} }
] ]
} }
``` ```

View File

@ -1,121 +1,121 @@
--- ---
sidebar_position: 1 sidebar_position: 1
--- ---
# SetCellValues # SetCellValues
Sets sheet cell values Sets sheet cell values
*Function SetCellValues(Val Token, Val Book, Val ValueMapping, Val Sheet = "", Val MajorDimension = "COLUMNS") Export* *Function SetCellValues(Val Token, Val Book, Val ValueMapping, Val Sheet = "", Val MajorDimension = "COLUMNS") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Book | --spreadsheet | String | BookID | | Book | --spreadsheet | String | BookID |
| ValueMapping | --data | Map Of KeyAndValue | Fill data where the key is the cell name like A1 | | ValueMapping | --data | Map Of KeyAndValue | Fill data where the key is the cell name like A1 |
| Sheet | --sheetname | String | Sheet name (first sheet by default) | | Sheet | --sheetname | String | Sheet name (first sheet by default) |
| MajorDimension | --dim | String | Main dimension when filling the array range | | MajorDimension | --dim | String | Main dimension when filling the array range |
Returns: Map Of KeyAndValue - serialized JSON response from Google Returns: Map Of KeyAndValue - serialized JSON response from Google
```bsl title="Code example" ```bsl title="Code example"
ValueMapping = New Map; ValueMapping = New Map;
ValueMapping.Insert("A1", "ThisIsA1"); ValueMapping.Insert("A1", "ThisIsA1");
ValueMapping.Insert("A2", "ThisIsA2"); ValueMapping.Insert("A2", "ThisIsA2");
ValueMapping.Insert("B2", "ThisIsB2"); ValueMapping.Insert("B2", "ThisIsB2");
ValueMapping.Insert("B3", "ThisIsB3"); ValueMapping.Insert("B3", "ThisIsB3");
ValueMapping.Insert("A3", "ThisIsA3"); ValueMapping.Insert("A3", "ThisIsA3");
ValueMapping.Insert("A4", "ThisIsA4"); ValueMapping.Insert("A4", "ThisIsA4");
ValueMapping.Insert("B1", "ThisIsB1"); ValueMapping.Insert("B1", "ThisIsB1");
ValueMapping.Insert("B4", "ThisIsB4"); ValueMapping.Insert("B4", "ThisIsB4");
Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Sheet = "Sheet2"; Sheet = "Sheet2";
Response = OPI_GoogleSheets.SetCellValues(Token, Book, ValueMapping, Sheet); //Map Response = OPI_GoogleSheets.SetCellValues(Token, Book, ValueMapping, Sheet); //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 gsheets SetCellValues --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --data %data% --sheetname "Sheet2" --dim %dim% oint gsheets SetCellValues --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --data %data% --sheetname "Sheet2" --dim %dim%
``` ```
```json title="Result" ```json title="Result"
{ {
"spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc",
"totalUpdatedRows": 4, "totalUpdatedRows": 4,
"totalUpdatedColumns": 2, "totalUpdatedColumns": 2,
"totalUpdatedCells": 8, "totalUpdatedCells": 8,
"totalUpdatedSheets": 1, "totalUpdatedSheets": 1,
"responses": [ "responses": [
{ {
"spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc",
"updatedRange": "'Sheet2'!A1", "updatedRange": "'Sheet2'!A1",
"updatedRows": 1, "updatedRows": 1,
"updatedColumns": 1, "updatedColumns": 1,
"updatedCells": 1 "updatedCells": 1
}, },
{ {
"spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc",
"updatedRange": "'Sheet2'!A2", "updatedRange": "'Sheet2'!A2",
"updatedRows": 1, "updatedRows": 1,
"updatedColumns": 1, "updatedColumns": 1,
"updatedCells": 1 "updatedCells": 1
}, },
{ {
"spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc",
"updatedRange": "'Sheet2'!B2", "updatedRange": "'Sheet2'!B2",
"updatedRows": 1, "updatedRows": 1,
"updatedColumns": 1, "updatedColumns": 1,
"updatedCells": 1 "updatedCells": 1
}, },
{ {
"spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc",
"updatedRange": "'Sheet2'!B3", "updatedRange": "'Sheet2'!B3",
"updatedRows": 1, "updatedRows": 1,
"updatedColumns": 1, "updatedColumns": 1,
"updatedCells": 1 "updatedCells": 1
}, },
{ {
"spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc",
"updatedRange": "'Sheet2'!A3", "updatedRange": "'Sheet2'!A3",
"updatedRows": 1, "updatedRows": 1,
"updatedColumns": 1, "updatedColumns": 1,
"updatedCells": 1 "updatedCells": 1
}, },
{ {
"spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc",
"updatedRange": "'Sheet2'!A4", "updatedRange": "'Sheet2'!A4",
"updatedRows": 1, "updatedRows": 1,
"updatedColumns": 1, "updatedColumns": 1,
"updatedCells": 1 "updatedCells": 1
}, },
{ {
"spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc",
"updatedRange": "'Sheet2'!B1", "updatedRange": "'Sheet2'!B1",
"updatedRows": 1, "updatedRows": 1,
"updatedColumns": 1, "updatedColumns": 1,
"updatedCells": 1 "updatedCells": 1
}, },
{ {
"spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc",
"updatedRange": "'Sheet2'!B4", "updatedRange": "'Sheet2'!B4",
"updatedRows": 1, "updatedRows": 1,
"updatedColumns": 1, "updatedColumns": 1,
"updatedCells": 1 "updatedCells": 1
} }
] ]
} }
``` ```

View File

@ -1,4 +1,4 @@
{ {
"label": "Data managment", "label": "Data managment",
"position": "4" "position": "4"
} }

View File

@ -1,4 +1,4 @@
{ {
"label": "Working with sheets", "label": "Working with sheets",
"position": "3" "position": "3"
} }

View File

@ -1,63 +1,63 @@
--- ---
sidebar_position: 1 sidebar_position: 1
--- ---
# AddSheet # AddSheet
Adds a new sheet to the book Adds a new sheet to the book
*Function AddSheet(Val Token, Val Book, Val Name) Export* *Function AddSheet(Val Token, Val Book, Val Name) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Book | --spreadsheet | String | BookIdentifier | | Book | --spreadsheet | String | BookIdentifier |
| Name | --title | String | NewSheetName | | Name | --title | String | NewSheetName |
Returns: Map Of KeyAndValue - serialized JSON response from Google Returns: Map Of KeyAndValue - serialized JSON response from Google
```bsl title="Code example" ```bsl title="Code example"
Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Name = "TestSheet"; Name = "TestSheet";
Response = OPI_GoogleSheets.AddSheet(Token, Book, Name); //Map Response = OPI_GoogleSheets.AddSheet(Token, Book, 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 gsheets AddSheet --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --title "TestSheet" oint gsheets AddSheet --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --title "TestSheet"
``` ```
```json title="Result" ```json title="Result"
{ {
"spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc",
"replies": [ "replies": [
{ {
"addSheet": { "addSheet": {
"properties": { "properties": {
"sheetId": 321892522, "sheetId": 321892522,
"title": "TestSheet", "title": "TestSheet",
"index": 2, "index": 2,
"sheetType": "GRID", "sheetType": "GRID",
"gridProperties": { "gridProperties": {
"rowCount": 1000, "rowCount": 1000,
"columnCount": 26 "columnCount": 26
} }
} }
} }
} }
] ]
} }
``` ```

View File

@ -1,56 +1,56 @@
--- ---
sidebar_position: 3 sidebar_position: 3
--- ---
# CopySheet # CopySheet
Copies a sheet from one book to another Copies a sheet from one book to another
*Function CopySheet(Val Token, Val From, Val Target, Val Sheet) Export* *Function CopySheet(Val Token, Val From, Val Target, Val Sheet) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| From | --from | String | SourceBookID | | From | --from | String | SourceBookID |
| Target | --to | String | DestinationBookID | | Target | --to | String | DestinationBookID |
| Sheet | --sheet | String | CopiedSheetID | | Sheet | --sheet | String | CopiedSheetID |
Returns: Map Of KeyAndValue - serialized JSON response from Google Returns: Map Of KeyAndValue - serialized JSON response from Google
```bsl title="Code example" ```bsl title="Code example"
From = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; From = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Target = "1tPDQHmduH9NASRhy0I-a6--ebNNJ5A6wXhhTRcNhD7s"; Target = "1tPDQHmduH9NASRhy0I-a6--ebNNJ5A6wXhhTRcNhD7s";
Sheet = "25093199"; Sheet = "25093199";
Response = OPI_GoogleSheets.CopySheet(Token, From, Target, Sheet); //Map Response = OPI_GoogleSheets.CopySheet(Token, From, Target, Sheet); //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 gsheets CopySheet --token %token% --from "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --to "1tPDQHmduH9NASRhy0I-a6--ebNNJ5A6wXhhTRcNhD7s" --sheet "25093199" oint gsheets CopySheet --token %token% --from "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --to "1tPDQHmduH9NASRhy0I-a6--ebNNJ5A6wXhhTRcNhD7s" --sheet "25093199"
``` ```
```json title="Result" ```json title="Result"
{ {
"sheetId": 1790807910, "sheetId": 1790807910,
"title": "Sheet2 (copy)", "title": "Sheet2 (copy)",
"index": 2, "index": 2,
"sheetType": "GRID", "sheetType": "GRID",
"gridProperties": { "gridProperties": {
"rowCount": 1000, "rowCount": 1000,
"columnCount": 26 "columnCount": 26
} }
} }
``` ```

View File

@ -1,50 +1,50 @@
--- ---
sidebar_position: 2 sidebar_position: 2
--- ---
# DeleteSheet # DeleteSheet
Deletes a sheet from the book Deletes a sheet from the book
*Function DeleteSheet(Val Token, Val Book, Val Sheet) Export* *Function DeleteSheet(Val Token, Val Book, Val Sheet) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Token | | Token | --token | String | Token |
| Book | --spreadsheet | String | BookIdentifier | | Book | --spreadsheet | String | BookIdentifier |
| Sheet | --sheet | String | IdentifierOfSheetToDelete | | Sheet | --sheet | String | IdentifierOfSheetToDelete |
Returns: Map Of KeyAndValue - serialized JSON response from Google Returns: Map Of KeyAndValue - serialized JSON response from Google
```bsl title="Code example" ```bsl title="Code example"
Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"; Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Sheet = "1790807910"; Sheet = "1790807910";
Response = OPI_GoogleSheets.DeleteSheet(Token, Book, Sheet); //Map Response = OPI_GoogleSheets.DeleteSheet(Token, Book, Sheet); //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 gsheets DeleteSheet --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --sheet "1790807910" oint gsheets DeleteSheet --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --sheet "1790807910"
``` ```
```json title="Result" ```json title="Result"
{ {
"spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc", "spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc",
"replies": [ "replies": [
{} {}
] ]
} }
``` ```

View File

@ -1,8 +1,8 @@
{ {
"label": null, "label": null,
"position": 9, "position": 9,
"link": { "link": {
"type": "doc", "type": "doc",
"id": "GoogleSheets" "id": "GoogleSheets"
} }
} }

View File

@ -1,4 +1,4 @@
{ {
"label": "Blocks managment", "label": "Blocks managment",
"position": "4" "position": "4"
} }

View File

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

View File

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

View File

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

View File

@ -1,8 +1,8 @@
{ {
"label": null, "label": null,
"position": 6, "position": 6,
"link": { "link": {
"type": "doc", "type": "doc",
"id": "Notion" "id": "Notion"
} }
} }

View File

@ -1,4 +1,4 @@
{ {
"label": "Block formation", "label": "Block formation",
"position": "8" "position": "8"
} }

View File

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

View File

@ -1,4 +1,4 @@
{ {
"label": "External files management", "label": "External files management",
"position": "7" "position": "7"
} }

View File

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

View File

@ -1,82 +1,82 @@
--- ---
sidebar_position: 3 sidebar_position: 3
--- ---
# Add external file # Add external file
Adds a new external file Adds a new external file
*Function AddExternalFile(Val Token, Val URL, Val Title) Export* *Function AddExternalFile(Val Token, Val URL, Val Title) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Bot token | | Token | --token | String | Bot token |
| URL | --url | String | URL to external file | | URL | --url | String | URL to external file |
| Title | --title | String | File title for Slack | | Title | --title | String | File title for Slack |
Returns: Map Of KeyAndValue - Serialized JSON response from Slack Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example" ```bsl title="Code example"
URL = https://opi.neocities.org/test_data/document.docx; URL = https://opi.neocities.org/test_data/document.docx;
Title = "NewFile"; Title = "NewFile";
Response = OPI_Slack.AddExternalFile(Token, URL, Title); //Map Response = OPI_Slack.AddExternalFile(Token, URL, Title); //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 slack AddExternalFile --token %token% --url "https://opi.neocities.org/test_data/document.docx" --title %title% oint slack AddExternalFile --token %token% --url "https://opi.neocities.org/test_data/document.docx" --title %title%
``` ```
```json title="Result" ```json title="Result"
{ {
"ok": true, "ok": true,
"file": { "file": {
"id": "F070P52CU94", "id": "F070P52CU94",
"created": 1714146552, "created": 1714146552,
"timestamp": 1714146552, "timestamp": 1714146552,
"name": "Novyj_fajl", "name": "Novyj_fajl",
"title": "NewFile", "title": "NewFile",
"mimetype": "application/vnd.slack-remote", "mimetype": "application/vnd.slack-remote",
"filetype": "remote", "filetype": "remote",
"pretty_type": "Remote", "pretty_type": "Remote",
"user": "U06UG1CAYH2", "user": "U06UG1CAYH2",
"user_team": "T06UD92BS3C", "user_team": "T06UD92BS3C",
"editable": false, "editable": false,
"size": 0, "size": 0,
"mode": "external", "mode": "external",
"is_external": true, "is_external": true,
"external_type": "app", "external_type": "app",
"is_public": false, "is_public": false,
"public_url_shared": false, "public_url_shared": false,
"display_as_bot": false, "display_as_bot": false,
"username": "", "username": "",
"url_private": "https://slack.com/api/files.remote.add", "url_private": "https://slack.com/api/files.remote.add",
"media_display_type": "unknown", "media_display_type": "unknown",
"permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F070P52CU94/novyj_fajl", "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F070P52CU94/novyj_fajl",
"comments_count": 0, "comments_count": 0,
"is_starred": false, "is_starred": false,
"shares": {}, "shares": {},
"channels": [], "channels": [],
"groups": [], "groups": [],
"ims": [], "ims": [],
"has_more_shares": false, "has_more_shares": false,
"external_id": "d2a110a2-08eb-4f20-989f-8943f0816420", "external_id": "d2a110a2-08eb-4f20-989f-8943f0816420",
"external_url": "https://slack.com/api/files.remote.add", "external_url": "https://slack.com/api/files.remote.add",
"has_rich_preview": false, "has_rich_preview": false,
"file_access": "visible" "file_access": "visible"
} }
} }
``` ```

View File

@ -1,45 +1,45 @@
--- ---
sidebar_position: 5 sidebar_position: 5
--- ---
# Delete external file # Delete external file
Deletes an external file from Slack Deletes an external file from Slack
*Function DeleteExternalFile(Val Token, Val FileID) Export* *Function DeleteExternalFile(Val Token, Val FileID) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Bot token | | Token | --token | String | Bot token |
| FileID | --fileid | String | File identifier | | FileID | --fileid | String | File identifier |
Returns: Map Of KeyAndValue - Serialized JSON response from Slack Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example" ```bsl title="Code example"
FileID = "F070P52CU94"; FileID = "F070P52CU94";
Response = OPI_Slack.DeleteExternalFile(Token, FileID); //Map Response = OPI_Slack.DeleteExternalFile(Token, FileID); //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 slack DeleteExternalFile --token %token% --fileid "F070P52CU94" oint slack DeleteExternalFile --token %token% --fileid "F070P52CU94"
``` ```
```json title="Result" ```json title="Result"
{ {
"ok": true "ok": true
} }
``` ```

View File

@ -1,50 +1,50 @@
--- ---
sidebar_position: 1 sidebar_position: 1
--- ---
# Get list of external files # Get list of external files
Gets a list of external files of a user or channel Gets a list of external files of a user or channel
*Function GetExternalFileList(Val Token, Val Channel = "", Val Cursor = "") Export* *Function GetExternalFileList(Val Token, Val Channel = "", Val Cursor = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Bot token | | Token | --token | String | Bot token |
| Channel | --channel | String | Channel for selection | | Channel | --channel | String | Channel for selection |
| Cursor | --cursor | String | Pointer from the previous request, if the result rows > 100 | | Cursor | --cursor | String | Pointer from the previous request, if the result rows > 100 |
Returns: Map Of KeyAndValue - Serialized JSON response from Slack Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example" ```bsl title="Code example"
Channel = "C070VPMKN8J"; Channel = "C070VPMKN8J";
Response = OPI_Slack.GetExternalFileList(Token, Channel); //Map Response = OPI_Slack.GetExternalFileList(Token, Channel); //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 slack GetExternalFileList --token %token% --channel "C070VPMKN8J" --cursor %cursor% oint slack GetExternalFileList --token %token% --channel "C070VPMKN8J" --cursor %cursor%
``` ```
```json title="Result" ```json title="Result"
{ {
"ok": true, "ok": true,
"files": [], "files": [],
"response_metadata": { "response_metadata": {
"next_cursor": "" "next_cursor": ""
} }
} }
``` ```

View File

@ -1,80 +1,80 @@
--- ---
sidebar_position: 2 sidebar_position: 2
--- ---
# Get external file # Get external file
Gets information about the external file Gets information about the external file
*Function GetExternalFile(Val Token, Val FileID) Export* *Function GetExternalFile(Val Token, Val FileID) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Bot token | | Token | --token | String | Bot token |
| FileID | --fileid | String | File identifier | | FileID | --fileid | String | File identifier |
Returns: Map Of KeyAndValue - Serialized JSON response from Slack Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example" ```bsl title="Code example"
FileID = "F070P52CU94"; FileID = "F070P52CU94";
Response = OPI_Slack.GetExternalFile(Token, FileID); //Map Response = OPI_Slack.GetExternalFile(Token, FileID); //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 slack GetExternalFile --token %token% --fileid "F070P52CU94" oint slack GetExternalFile --token %token% --fileid "F070P52CU94"
``` ```
```json title="Result" ```json title="Result"
{ {
"ok": true, "ok": true,
"file": { "file": {
"id": "F070P52CU94", "id": "F070P52CU94",
"created": 1714146552, "created": 1714146552,
"timestamp": 1714146552, "timestamp": 1714146552,
"name": "Novyj_fajl", "name": "Novyj_fajl",
"title": "NewFile", "title": "NewFile",
"mimetype": "application/vnd.slack-remote", "mimetype": "application/vnd.slack-remote",
"filetype": "remote", "filetype": "remote",
"pretty_type": "Remote", "pretty_type": "Remote",
"user": "U06UG1CAYH2", "user": "U06UG1CAYH2",
"user_team": "T06UD92BS3C", "user_team": "T06UD92BS3C",
"editable": false, "editable": false,
"size": 0, "size": 0,
"mode": "external", "mode": "external",
"is_external": true, "is_external": true,
"external_type": "app", "external_type": "app",
"is_public": false, "is_public": false,
"public_url_shared": false, "public_url_shared": false,
"display_as_bot": false, "display_as_bot": false,
"username": "", "username": "",
"url_private": "https://slack.com/api/files.remote.add", "url_private": "https://slack.com/api/files.remote.add",
"media_display_type": "unknown", "media_display_type": "unknown",
"permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F070P52CU94/novyj_fajl", "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F070P52CU94/novyj_fajl",
"comments_count": 0, "comments_count": 0,
"is_starred": false, "is_starred": false,
"shares": {}, "shares": {},
"channels": [], "channels": [],
"groups": [], "groups": [],
"ims": [], "ims": [],
"has_more_shares": false, "has_more_shares": false,
"external_id": "d2a110a2-08eb-4f20-989f-8943f0816420", "external_id": "d2a110a2-08eb-4f20-989f-8943f0816420",
"external_url": "https://slack.com/api/files.remote.add", "external_url": "https://slack.com/api/files.remote.add",
"has_rich_preview": false, "has_rich_preview": false,
"file_access": "visible" "file_access": "visible"
} }
} }
``` ```

View File

@ -1,99 +1,99 @@
--- ---
sidebar_position: 4 sidebar_position: 4
--- ---
# Send external file # Send external file
Sends an external file to a list of channels Sends an external file to a list of channels
*Function SendExternalFile(Val Token, Val FileID, Val ChannelArray) Export* *Function SendExternalFile(Val Token, Val FileID, Val ChannelArray) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Bot token | | Token | --token | String | Bot token |
| FileID | --fileid | String | File identifier | | FileID | --fileid | String | File identifier |
| ChannelArray | --channels | Array Of String | Array of channels for sending | | ChannelArray | --channels | Array Of String | Array of channels for sending |
Returns: Map Of KeyAndValue - Serialized JSON response from Slack Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example" ```bsl title="Code example"
Channel = "C070VPMKN8J"; Channel = "C070VPMKN8J";
FileID = "F070P52CU94"; FileID = "F070P52CU94";
Response = OPI_Slack.SendExternalFile(Token, FileID, Channel); //Map Response = OPI_Slack.SendExternalFile(Token, FileID, Channel); //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 slack SendExternalFile --token %token% --fileid "F070P52CU94" --channels %channels% oint slack SendExternalFile --token %token% --fileid "F070P52CU94" --channels %channels%
``` ```
```json title="Result" ```json title="Result"
{ {
"ok": true, "ok": true,
"file": { "file": {
"id": "F070P52CU94", "id": "F070P52CU94",
"created": 1714146552, "created": 1714146552,
"timestamp": 1714146552, "timestamp": 1714146552,
"name": "Novyj_fajl", "name": "Novyj_fajl",
"title": "NewFile", "title": "NewFile",
"mimetype": "application/vnd.slack-remote", "mimetype": "application/vnd.slack-remote",
"filetype": "remote", "filetype": "remote",
"pretty_type": "Remote", "pretty_type": "Remote",
"user": "U06UG1CAYH2", "user": "U06UG1CAYH2",
"user_team": "T06UD92BS3C", "user_team": "T06UD92BS3C",
"editable": false, "editable": false,
"size": 0, "size": 0,
"mode": "external", "mode": "external",
"is_external": true, "is_external": true,
"external_type": "app", "external_type": "app",
"is_public": true, "is_public": true,
"public_url_shared": false, "public_url_shared": false,
"display_as_bot": false, "display_as_bot": false,
"username": "", "username": "",
"url_private": "https://slack.com/api/files.remote.add", "url_private": "https://slack.com/api/files.remote.add",
"media_display_type": "unknown", "media_display_type": "unknown",
"permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F070P52CU94/novyj_fajl", "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F070P52CU94/novyj_fajl",
"comments_count": 0, "comments_count": 0,
"is_starred": false, "is_starred": false,
"shares": { "shares": {
"public": { "public": {
"C06UFNUTKUL": [ "C06UFNUTKUL": [
{ {
"reply_users": [], "reply_users": [],
"reply_users_count": 0, "reply_users_count": 0,
"reply_count": 0, "reply_count": 0,
"ts": "1714146553.217059", "ts": "1714146553.217059",
"channel_name": "slack-api-librarry", "channel_name": "slack-api-librarry",
"team_id": "T06UD92BS3C", "team_id": "T06UD92BS3C",
"share_user_id": "U06UG1CAYH2", "share_user_id": "U06UG1CAYH2",
"source": "UNKNOWN" "source": "UNKNOWN"
} }
] ]
} }
}, },
"channels": [ "channels": [
"C06UFNUTKUL" "C06UFNUTKUL"
], ],
"groups": [], "groups": [],
"ims": [], "ims": [],
"has_more_shares": false, "has_more_shares": false,
"external_id": "d2a110a2-08eb-4f20-989f-8943f0816420", "external_id": "d2a110a2-08eb-4f20-989f-8943f0816420",
"external_url": "https://slack.com/api/files.remote.add", "external_url": "https://slack.com/api/files.remote.add",
"has_rich_preview": false, "has_rich_preview": false,
"file_access": "visible" "file_access": "visible"
} }
} }
``` ```

View File

@ -1,45 +1,45 @@
--- ---
sidebar_position: 4 sidebar_position: 4
--- ---
# Delete file # Delete file
Deletes a file on Slack Deletes a file on Slack
*Function DeleteFile(Val Token, Val FileID) Export* *Function DeleteFile(Val Token, Val FileID) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Bot token | | Token | --token | String | Bot token |
| FileID | --fileid | String | File identifier | | FileID | --fileid | String | File identifier |
Returns: Map Of KeyAndValue - Serialized JSON response from Slack Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example" ```bsl title="Code example"
FileID = "F070VL6FQFM"; FileID = "F070VL6FQFM";
Response = OPI_Slack.DeleteFile(Token, FileID); //Map Response = OPI_Slack.DeleteFile(Token, FileID); //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 slack DeleteFile --token %token% --fileid "F070VL6FQFM" oint slack DeleteFile --token %token% --fileid "F070VL6FQFM"
``` ```
```json title="Result" ```json title="Result"
{ {
"ok": true "ok": true
} }
``` ```

View File

@ -1,84 +1,84 @@
--- ---
sidebar_position: 3 sidebar_position: 3
--- ---
# Get file data # Get file data
Gets information about the file Gets information about the file
*Function GetFileData(Val Token, Val FileID) Export* *Function GetFileData(Val Token, Val FileID) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Bot token | | Token | --token | String | Bot token |
| FileID | --fileid | String | File identifier | | FileID | --fileid | String | File identifier |
Returns: Map Of KeyAndValue - Serialized JSON response from Slack Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example" ```bsl title="Code example"
FileID = "F070VL6FQFM"; FileID = "F070VL6FQFM";
Response = OPI_Slack.GetFileData(Token, FileID); //Map Response = OPI_Slack.GetFileData(Token, FileID); //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 slack GetFileData --token %token% --fileid "F070VL6FQFM" oint slack GetFileData --token %token% --fileid "F070VL6FQFM"
``` ```
```json title="Result" ```json title="Result"
{ {
"ok": true, "ok": true,
"file": { "file": {
"id": "F070VL6FQFM", "id": "F070VL6FQFM",
"created": 1714146550, "created": 1714146550,
"timestamp": 1714146550, "timestamp": 1714146550,
"name": "megadoc.docx", "name": "megadoc.docx",
"title": "NewFile", "title": "NewFile",
"mimetype": "", "mimetype": "",
"filetype": "", "filetype": "",
"pretty_type": "", "pretty_type": "",
"user": "U06UG1CAYH2", "user": "U06UG1CAYH2",
"user_team": "T06UD92BS3C", "user_team": "T06UD92BS3C",
"editable": false, "editable": false,
"size": 24069, "size": 24069,
"mode": "hosted", "mode": "hosted",
"is_external": false, "is_external": false,
"external_type": "", "external_type": "",
"is_public": false, "is_public": false,
"public_url_shared": false, "public_url_shared": false,
"display_as_bot": false, "display_as_bot": false,
"username": "", "username": "",
"url_private": "https://files.slack.com/files-pri/T06UD92BS3C-F070VL6FQFM/megadoc.docx", "url_private": "https://files.slack.com/files-pri/T06UD92BS3C-F070VL6FQFM/megadoc.docx",
"url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F070VL6FQFM/download/megadoc.docx", "url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F070VL6FQFM/download/megadoc.docx",
"media_display_type": "unknown", "media_display_type": "unknown",
"permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F070VL6FQFM/megadoc.docx", "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F070VL6FQFM/megadoc.docx",
"permalink_public": "https://slack-files.com/T06UD92BS3C-F070VL6FQFM-9fb2618d36", "permalink_public": "https://slack-files.com/T06UD92BS3C-F070VL6FQFM-9fb2618d36",
"is_starred": false, "is_starred": false,
"shares": {}, "shares": {},
"channels": [], "channels": [],
"groups": [], "groups": [],
"ims": [], "ims": [],
"has_more_shares": false, "has_more_shares": false,
"has_rich_preview": false, "has_rich_preview": false,
"file_access": "visible", "file_access": "visible",
"comments_count": 0 "comments_count": 0
}, },
"comments": [], "comments": [],
"response_metadata": { "response_metadata": {
"next_cursor": "" "next_cursor": ""
} }
} }
``` ```

View File

@ -1,84 +1,84 @@
--- ---
sidebar_position: 1 sidebar_position: 1
--- ---
# Get list of files # Get list of files
Gets a list of files of the bot or channel Gets a list of files of the bot or channel
*Function GetFilesList(Val Token, Val Channel = "", Val PageNumber = 1) Export* *Function GetFilesList(Val Token, Val Channel = "", Val PageNumber = 1) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Bot token | | Token | --token | String | Bot token |
| Channel | --channel | String | Channel for selection | | Channel | --channel | String | Channel for selection |
| PageNumber | --page | Number, String | Page number | | PageNumber | --page | Number, String | Page number |
Returns: Map Of KeyAndValue - Serialized JSON response from Slack Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example" ```bsl title="Code example"
PageNumber = 1; PageNumber = 1;
Channel = "C123456"; Channel = "C123456";
Response = OPI_Slack.GetFilesList(Token, Channel, PageNumber); //Map Response = OPI_Slack.GetFilesList(Token, Channel, PageNumber); //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 slack GetFilesList --token %token% --channel "C123456" --page "1" oint slack GetFilesList --token %token% --channel "C123456" --page "1"
``` ```
```json title="Result" ```json title="Result"
{ {
"ok": true, "ok": true,
"files": [ "files": [
{ {
"id": "F070V4U7Y4R", "id": "F070V4U7Y4R",
"created": 1713978714, "created": 1713978714,
"timestamp": 1713978714, "timestamp": 1713978714,
"name": "megadoc.docx", "name": "megadoc.docx",
"title": "NewFile", "title": "NewFile",
"mimetype": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "mimetype": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"filetype": "docx", "filetype": "docx",
"pretty_type": "Word Document", "pretty_type": "Word Document",
"user": "U06UG1CAYH2", "user": "U06UG1CAYH2",
"user_team": "T06UD92BS3C", "user_team": "T06UD92BS3C",
"editable": false, "editable": false,
"size": 24069, "size": 24069,
"mode": "hosted", "mode": "hosted",
"is_external": false, "is_external": false,
"external_type": "", "external_type": "",
"is_public": true, "is_public": true,
"public_url_shared": false, "public_url_shared": false,
"display_as_bot": false, "display_as_bot": false,
"username": "", "username": "",
"url_private": "https://files.slack.com/files-pri/T06UD92BS3C-F070V4U7Y4R/megadoc.docx", "url_private": "https://files.slack.com/files-pri/T06UD92BS3C-F070V4U7Y4R/megadoc.docx",
"url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F070V4U7Y4R/download/megadoc.docx", "url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F070V4U7Y4R/download/megadoc.docx",
"media_display_type": "unknown", "media_display_type": "unknown",
"converted_pdf": "https://files.slack.com/files-tmb/T06UD92BS3C-F070V4U7Y4R-417b34221e/megadoc_converted.pdf", "converted_pdf": "https://files.slack.com/files-tmb/T06UD92BS3C-F070V4U7Y4R-417b34221e/megadoc_converted.pdf",
"thumb_pdf": "https://files.slack.com/files-tmb/T06UD92BS3C-F070V4U7Y4R-417b34221e/megadoc_thumb_pdf.png", "thumb_pdf": "https://files.slack.com/files-tmb/T06UD92BS3C-F070V4U7Y4R-417b34221e/megadoc_thumb_pdf.png",
"thumb_pdf_w": 909, "thumb_pdf_w": 909,
"thumb_pdf_h": 1286, "thumb_pdf_h": 1286,
"permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F070V4U7Y4R/megadoc.docx", "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F070V4U7Y4R/megadoc.docx",
"channels": [ "channels": [
"C06UFNUTKUL" "C06UFNUTKUL"
], ],
"groups": [], "groups": [],
"ims": [], "ims": [],
"comments_count": 0 "comments_count": 0
} }
] ]
} }
``` ```

View File

@ -1,37 +1,37 @@
--- ---
sidebar_position: 6 sidebar_position: 6
--- ---
# Make file private # Make file private
Removes the public URL from the file. Requires user token Removes the public URL from the file. Requires user token
*Function MakeFilePrivate(Val Token, Val FileID) Export* *Function MakeFilePrivate(Val Token, Val FileID) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | User token | | Token | --token | String | User token |
| FileID | --fileid | String | File identifier | | FileID | --fileid | String | File identifier |
Returns: Map Of KeyAndValue - Serialized JSON response from Slack Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example" ```bsl title="Code example"
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint slack MakeFilePrivate --token %token% --fileid %fileid% oint slack MakeFilePrivate --token %token% --fileid %fileid%
``` ```
```json title="Result" ```json title="Result"
``` ```

View File

@ -1,37 +1,37 @@
--- ---
sidebar_position: 5 sidebar_position: 5
--- ---
# Make file public # Make file public
Creates a public URL for the file. Requires user token Creates a public URL for the file. Requires user token
*Function MakeFilePublic(Val Token, Val FileID) Export* *Function MakeFilePublic(Val Token, Val FileID) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | User token | | Token | --token | String | User token |
| FileID | --fileid | String | File identifier | | FileID | --fileid | String | File identifier |
Returns: Map Of KeyAndValue - Serialized JSON response from Slack Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example" ```bsl title="Code example"
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint slack MakeFilePublic --token %token% --fileid %fileid% oint slack MakeFilePublic --token %token% --fileid %fileid%
``` ```
```json title="Result" ```json title="Result"
``` ```

View File

@ -1,88 +1,88 @@
--- ---
sidebar_position: 2 sidebar_position: 2
--- ---
# Upload file # Upload file
Uploads a file to Slack servers Uploads a file to Slack servers
*Function UploadFile(Val Token, Val File, Val FileName, Val Title, Val Channel = "") Export* *Function UploadFile(Val Token, Val File, Val FileName, Val Title, Val Channel = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Token | --token | String | Bot token | | Token | --token | String | Bot token |
| File | --file | String, BinaryData | File for upload | | File | --file | String, BinaryData | File for upload |
| FileName | --filename | String | File name with extension | | FileName | --filename | String | File name with extension |
| Title | --title | String | File name in Slack | | Title | --title | String | File name in Slack |
| Channel | --channel | String | Channel ID | | Channel | --channel | String | Channel ID |
Returns: Map Of KeyAndValue - Serialized JSON response from Slack Returns: Map Of KeyAndValue - Serialized JSON response from Slack
```bsl title="Code example" ```bsl title="Code example"
FileName = "megadoc.docx"; FileName = "megadoc.docx";
File = New BinaryData("D:\" + FileName); File = New BinaryData("D:\" + FileName);
Title = "NewFile"; Title = "NewFile";
Channel = "C123456"; Channel = "C123456";
Response = OPI_Slack.UploadFile(Token, File, FileName, Title, Channel); //Map Response = OPI_Slack.UploadFile(Token, File, FileName, Title, Channel); //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 slack UploadFile --token %token% --file %file% --filename "megadoc.docx" --title %title% --channel "C123456" oint slack UploadFile --token %token% --file %file% --filename "megadoc.docx" --title %title% --channel "C123456"
``` ```
```json title="Result" ```json title="Result"
{ {
"ok": true, "ok": true,
"files": [ "files": [
{ {
"id": "F070SS4UHNZ", "id": "F070SS4UHNZ",
"created": 1714146549, "created": 1714146549,
"timestamp": 1714146549, "timestamp": 1714146549,
"name": "megadoc.docx", "name": "megadoc.docx",
"title": "NewFile", "title": "NewFile",
"mimetype": "", "mimetype": "",
"filetype": "", "filetype": "",
"pretty_type": "", "pretty_type": "",
"user": "U06UG1CAYH2", "user": "U06UG1CAYH2",
"user_team": "T06UD92BS3C", "user_team": "T06UD92BS3C",
"editable": false, "editable": false,
"size": 24069, "size": 24069,
"mode": "hosted", "mode": "hosted",
"is_external": false, "is_external": false,
"external_type": "", "external_type": "",
"is_public": false, "is_public": false,
"public_url_shared": false, "public_url_shared": false,
"display_as_bot": false, "display_as_bot": false,
"username": "", "username": "",
"url_private": "https://files.slack.com/files-pri/T06UD92BS3C-F070SS4UHNZ/megadoc.docx", "url_private": "https://files.slack.com/files-pri/T06UD92BS3C-F070SS4UHNZ/megadoc.docx",
"url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F070SS4UHNZ/download/megadoc.docx", "url_private_download": "https://files.slack.com/files-pri/T06UD92BS3C-F070SS4UHNZ/download/megadoc.docx",
"media_display_type": "unknown", "media_display_type": "unknown",
"permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F070SS4UHNZ/megadoc.docx", "permalink": "https://openintegrationsgroup.slack.com/files/U06UG1CAYH2/F070SS4UHNZ/megadoc.docx",
"permalink_public": "https://slack-files.com/T06UD92BS3C-F070SS4UHNZ-e68bef4a91", "permalink_public": "https://slack-files.com/T06UD92BS3C-F070SS4UHNZ-e68bef4a91",
"comments_count": 0, "comments_count": 0,
"is_starred": false, "is_starred": false,
"shares": {}, "shares": {},
"channels": [], "channels": [],
"groups": [], "groups": [],
"ims": [], "ims": [],
"has_more_shares": false, "has_more_shares": false,
"has_rich_preview": false, "has_rich_preview": false,
"file_access": "visible" "file_access": "visible"
} }
] ]
} }
``` ```

View File

@ -1,4 +1,4 @@
{ {
"label": "File managment", "label": "File managment",
"position": "6" "position": "6"
} }

View File

@ -1,4 +1,4 @@
{ {
"label": "Management and settings", "label": "Management and settings",
"position": "2" "position": "2"
} }

View File

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

View File

@ -1,8 +1,8 @@
{ {
"label": null, "label": null,
"position": 9, "position": 9,
"link": { "link": {
"type": "doc", "type": "doc",
"id": "Slack" "id": "Slack"
} }
} }

View File

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

Binary file not shown.

Before

Width:  |  Height:  |  Size: 61 KiB

After

Width:  |  Height:  |  Size: 72 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 41 KiB

After

Width:  |  Height:  |  Size: 93 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 99 KiB

After

Width:  |  Height:  |  Size: 244 KiB

View File

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

View File

@ -1,4 +1,4 @@
{ {
"label": "Data retrieval and settings", "label": "Data retrieval and settings",
"position": "2" "position": "2"
} }

View File

@ -1,4 +1,4 @@
{ {
"label": "Data sending", "label": "Data sending",
"position": "3" "position": "3"
} }

View File

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

View File

@ -1,8 +1,8 @@
{ {
"label": null, "label": null,
"position": 2, "position": 2,
"link": { "link": {
"type": "doc", "type": "doc",
"id": "Telegram" "id": "Telegram"
} }
} }

View File

@ -1,4 +1,4 @@
{ {
"label": "Data and settings", "label": "Data and settings",
"position": "2" "position": "2"
} }

View File

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

View File

@ -1,8 +1,8 @@
{ {
"label": null, "label": null,
"position": 4, "position": 4,
"link": { "link": {
"type": "doc", "type": "doc",
"id": "Twitter" "id": "Twitter"
} }
} }

View File

@ -1,4 +1,4 @@
{ {
"label": "Ad account management", "label": "Ad account management",
"position": "7" "position": "7"
} }

View File

@ -1,59 +1,59 @@
--- ---
sidebar_position: 5 sidebar_position: 5
--- ---
# Create album # Create album
Creates an album to store images Creates an album to store images
*Function CreateAlbum(Val Name, Val Description = "", Val Parameters = "") Export* *Function CreateAlbum(Val Name, Val Description = "", Val Parameters = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Name | --title | String | Album name | | Name | --title | String | Album name |
| Description | --description | String | Album description | | Description | --description | String | Album description |
| Parameters | --auth | Structure Of String | Authorization JSON or path to .json | | Parameters | --auth | Structure Of String | Authorization JSON or path to .json |
Returns: Map Of KeyAndValue - Serialized JSON response from VK Returns: Map Of KeyAndValue - Serialized JSON response from VK
```bsl title="Code example" ```bsl title="Code example"
Parameters = GetVKParameters(); Parameters = GetVKParameters();
Name = "AlbumFromAutoTest"; Name = "AlbumFromAutoTest";
Description = "NewAlbumFromAutoTest"; Description = "NewAlbumFromAutoTest";
Result = OPI_VK.CreateAlbum(Name, Description, Parameters); Result = OPI_VK.CreateAlbum(Name, Description, Parameters);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint vk CreateAlbum --title %title% --description %description% --auth %auth% oint vk CreateAlbum --title %title% --description %description% --auth %auth%
``` ```
```json title="Result" ```json title="Result"
{ {
"response": { "response": {
"id": 304498513, "id": 304498513,
"owner_id": -218861756, "owner_id": -218861756,
"size": 0, "size": 0,
"title": "AlbumFromAutoTest", "title": "AlbumFromAutoTest",
"feed_disabled": 0, "feed_disabled": 0,
"feed_has_pinned": 0, "feed_has_pinned": 0,
"can_upload": 1, "can_upload": 1,
"comments_disabled": 0, "comments_disabled": 0,
"created": 1717072416, "created": 1717072416,
"description": "NewAlbumFromAutoTest", "description": "NewAlbumFromAutoTest",
"thumb_id": 0, "thumb_id": 0,
"updated": 1717072416, "updated": 1717072416,
"upload_by_admins_only": 1 "upload_by_admins_only": 1
} }
} }
``` ```

View File

@ -1,68 +1,68 @@
--- ---
sidebar_position: 2 sidebar_position: 2
--- ---
# Create composite post # Create composite post
Creates a post based on an array of object identifiers (images, videos, etc..) Creates a post based on an array of object identifiers (images, videos, etc..)
*Function CreateCompositePost(Val Text, Val Objects, Val Advertisement = False, Val LinkUnderPost = "", Val Parameters = "") Export* *Function CreateCompositePost(Val Text, Val Objects, Val Advertisement = False, Val LinkUnderPost = "", Val Parameters = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Text | --text | String | Post text | | Text | --text | String | Post text |
| Objects | --objects | Array of String | Array of identifiers like photo123_123 | | Objects | --objects | Array of String | Array of identifiers like photo123_123 |
| Advertisement | --ad | Boolean | Sign ""This is an ad"" | | Advertisement | --ad | Boolean | Sign ""This is an ad"" |
| LinkUnderPost | --url | String | Link (URL) under the post | | LinkUnderPost | --url | String | Link (URL) under the post |
| Parameters | --auth | Structure Of String | Authorization JSON or path to .json | | Parameters | --auth | Structure Of String | Authorization JSON or path to .json |
Returns: Map Of KeyAndValue - Serialized JSON response from VK Returns: Map Of KeyAndValue - Serialized JSON response from VK
```bsl title="Code example" ```bsl title="Code example"
Parameters = GetVKParameters(); Parameters = GetVKParameters();
Text = "Post from autotest"; Text = "Post from autotest";
URL = "https://github.com/Bayselonarrend/OpenIntegrations"; URL = "https://github.com/Bayselonarrend/OpenIntegrations";
Image = "https://openintegrations.dev/test_data/picture.jpg"; // URL, Path or Binary Data Image = "https://openintegrations.dev/test_data/picture.jpg"; // URL, Path or Binary Data
Video = "https://openintegrations.dev/test_data/video.mp4"; // URL, Path or Binary Data Video = "https://openintegrations.dev/test_data/video.mp4"; // URL, Path or Binary Data
TFN = GetTempFileName("png"); TFN = GetTempFileName("png");
CopyFile(Image, TFN); CopyFile(Image, TFN);
ImageUpload = OPI_VK.UploadPhotoToServer(TFN, Parameters)["response"][0]; ImageUpload = OPI_VK.UploadPhotoToServer(TFN, Parameters)["response"][0];
VideoUpload = OPI_VK.UploadVideoToServer(Video, "NewVideo",,, Parameters); VideoUpload = OPI_VK.UploadVideoToServer(Video, "NewVideo",,, Parameters);
ImageOwner = OPI_Tools.NumberToString(ImageUpload["owner_id"]); ImageOwner = OPI_Tools.NumberToString(ImageUpload["owner_id"]);
VideoOwner = OPI_Tools.NumberToString(VideoUpload["owner_id"]); VideoOwner = OPI_Tools.NumberToString(VideoUpload["owner_id"]);
ImageID = OPI_Tools.NumberToString(ImageUpload["id"]); ImageID = OPI_Tools.NumberToString(ImageUpload["id"]);
VideoID = OPI_Tools.NumberToString(VideoUpload["video_id"]); VideoID = OPI_Tools.NumberToString(VideoUpload["video_id"]);
AttachmentsArray = New Array; AttachmentsArray = New Array;
AttachmentsArray.Add("photo" + ImageOwner + "_" + ImageID); AttachmentsArray.Add("photo" + ImageOwner + "_" + ImageID);
AttachmentsArray.Add("video" + VideoOwner + "_" + VideoID); AttachmentsArray.Add("video" + VideoOwner + "_" + VideoID);
Result = OPI_VK.CreateCompositePost(Text, AttachmentsArray, False, URL, Parameters); Result = OPI_VK.CreateCompositePost(Text, AttachmentsArray, False, URL, Parameters);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint vk CreateCompositePost --text %text% --objects %objects% --ad %ad% --url %url% --auth %auth% oint vk CreateCompositePost --text %text% --objects %objects% --ad %ad% --url %url% --auth %auth%
``` ```
```json title="Result" ```json title="Result"
{ {
"response": { "response": {
"post_id": 2126 "post_id": 2126
} }
} }
``` ```

View File

@ -1,52 +1,52 @@
--- ---
sidebar_position: 4 sidebar_position: 4
--- ---
# Create poll # Create poll
Creates a poll with answer options Creates a poll with answer options
*Function CreatePoll(Val Question, Val AnswersArray, Val Image = "", Val Parameters = "") Export* *Function CreatePoll(Val Question, Val AnswersArray, Val Image = "", Val Parameters = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Question | --question | String | Poll question | | Question | --question | String | Poll question |
| AnswersArray | --options | Array of String | Array of answer options | | AnswersArray | --options | Array of String | Array of answer options |
| Image | --picture | String, BinaryData | Poll image | | Image | --picture | String, BinaryData | Poll image |
| Parameters | --auth | Structure Of String | Authorization JSON or path to .json | | Parameters | --auth | Structure Of String | Authorization JSON or path to .json |
Returns: Map Of KeyAndValue - Serialized JSON response from VK Returns: Map Of KeyAndValue - Serialized JSON response from VK
```bsl title="Code example" ```bsl title="Code example"
Parameters = GetVKParameters(); Parameters = GetVKParameters();
Question = "What's your favorite color?"; Question = "What's your favorite color?";
OptionArray = New Array; OptionArray = New Array;
OptionArray.Add("Red"); OptionArray.Add("Red");
OptionArray.Add("Yellow"); OptionArray.Add("Yellow");
OptionArray.Add("Green"); OptionArray.Add("Green");
Result = OPI_VK.CreatePoll(Question, OptionArray,, Parameters); Result = OPI_VK.CreatePoll(Question, OptionArray,, Parameters);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint vk CreatePoll --question "What's your favorite color?" --options "['Red','Yellow','Green']" --picture %picture% --auth %auth% oint vk CreatePoll --question "What's your favorite color?" --options "['Red','Yellow','Green']" --picture %picture% --auth %auth%
``` ```
```json title="Result" ```json title="Result"
{ {
"response": { "response": {
"post_id": 2127 "post_id": 2127
} }
} }
``` ```

View File

@ -1,60 +1,60 @@
--- ---
sidebar_position: 1 sidebar_position: 1
--- ---
# Create post # Create post
Creates a post with images Creates a post with images
*Function CreatePost(Val Text, Val ImageArray, Val Advertisement = False, Val LinkUnderPost = "", Val Parameters = "") Export* *Function CreatePost(Val Text, Val ImageArray, Val Advertisement = False, Val LinkUnderPost = "", Val Parameters = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Text | --text | String | Post text | | Text | --text | String | Post text |
| ImageArray | --pictures | Array of String, BinaryData | Array of images | | ImageArray | --pictures | Array of String, BinaryData | Array of images |
| Advertisement | --ad | Boolean | Sign ""This is an ad"" | | Advertisement | --ad | Boolean | Sign ""This is an ad"" |
| LinkUnderPost | --url | String | Link (URL) under the post | | LinkUnderPost | --url | String | Link (URL) under the post |
| Parameters | --auth | Structure Of String | Authorization JSON or path to .json | | Parameters | --auth | Structure Of String | Authorization JSON or path to .json |
Returns: Map Of KeyAndValue - Serialized JSON response from VK Returns: Map Of KeyAndValue - Serialized JSON response from VK
```bsl title="Code example" ```bsl title="Code example"
Parameters = GetVKParameters(); Parameters = GetVKParameters();
Text = "Post from autotest"; Text = "Post from autotest";
URL = "https://github.com/Bayselonarrend/OpenIntegrations"; URL = "https://github.com/Bayselonarrend/OpenIntegrations";
Image = "https://openintegrations.dev/test_data/picture.jpg"; // URL, Path or Binary Data Image = "https://openintegrations.dev/test_data/picture.jpg"; // URL, Path or Binary Data
Image2 = "https://openintegrations.dev/test_data/picture2.jpg"; // URL, Path or Binary Data Image2 = "https://openintegrations.dev/test_data/picture2.jpg"; // URL, Path or Binary Data
TFN = GetTempFileName("png"); TFN = GetTempFileName("png");
CopyFile(Image2, TFN); CopyFile(Image2, TFN);
ImageArray = New Array; ImageArray = New Array;
ImageArray.Add(Image); ImageArray.Add(Image);
ImageArray.Add(TFN); ImageArray.Add(TFN);
Result = OPI_VK.CreatePost(Text, ImageArray, True, URL, Parameters); Result = OPI_VK.CreatePost(Text, ImageArray, True, URL, Parameters);
Result = OPI_VK.CreatePost(Text, Image, False,, Parameters); Result = OPI_VK.CreatePost(Text, Image, False,, Parameters);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint vk CreatePost --text %text% --pictures %pictures% --ad %ad% --url %url% --auth %auth% oint vk CreatePost --text %text% --pictures %pictures% --ad %ad% --url %url% --auth %auth%
``` ```
```json title="Result" ```json title="Result"
{ {
"response": { "response": {
"post_id": 2123 "post_id": 2123
} }
} }
``` ```

View File

@ -1,140 +1,140 @@
--- ---
sidebar_position: 7 sidebar_position: 7
--- ---
# Create story # Create story
Creates a story from an image Creates a story from an image
*Function CreateStory(Val Image, Val URL = "", Val Parameters = "") Export* *Function CreateStory(Val Image, Val URL = "", Val Parameters = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Image | --picture | String, BinaryData | Story background | | Image | --picture | String, BinaryData | Story background |
| URL | --url | String | URL for button under the story | | URL | --url | String | URL for button under the story |
| Parameters | --auth | Structure Of String | Authorization JSON or path to .json | | Parameters | --auth | Structure Of String | Authorization JSON or path to .json |
Returns: Map Of KeyAndValue - Serialized JSON response from VK Returns: Map Of KeyAndValue - Serialized JSON response from VK
```bsl title="Code example" ```bsl title="Code example"
Parameters = GetVKParameters(); Parameters = GetVKParameters();
URL = "https://github.com/Bayselonarrend/OpenIntegrations"; URL = "https://github.com/Bayselonarrend/OpenIntegrations";
Image = "https://openintegrations.dev/test_data/picture.jpg"; // URL, Path to file or Binary Data Image = "https://openintegrations.dev/test_data/picture.jpg"; // URL, Path to file or Binary Data
TFN = GetTempFileName("png"); TFN = GetTempFileName("png");
CopyFile(Image, TFN); CopyFile(Image, TFN);
Image = New BinaryData(TFN); Image = New BinaryData(TFN);
Result = OPI_VK.CreateStory(Image, URL, Parameters); Result = OPI_VK.CreateStory(Image, URL, Parameters);
Result = OPI_VK.CreateStory(TFN,, Parameters); Result = OPI_VK.CreateStory(TFN,, Parameters);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint vk CreateStory --picture "https://openintegrations.dev/test_data/picture.jpg" --url %url% --auth %auth% oint vk CreateStory --picture "https://openintegrations.dev/test_data/picture.jpg" --url %url% --auth %auth%
``` ```
```json title="Result" ```json title="Result"
{ {
"response": { "response": {
"count": 1, "count": 1,
"items": [ "items": [
{ {
"id": 456239491, "id": 456239491,
"owner_id": -218861756, "owner_id": -218861756,
"access_key": "story", "access_key": "story",
"can_comment": 1, "can_comment": 1,
"can_reply": 1, "can_reply": 1,
"can_see": 1, "can_see": 1,
"can_like": true, "can_like": true,
"can_share": 1, "can_share": 1,
"can_hide": 1, "can_hide": 1,
"date": 1717072436, "date": 1717072436,
"expires_at": 1717158836, "expires_at": 1717158836,
"link": { "link": {
"text": "More", "text": "More",
"url": "https://github.com/Bayselonarrend/OpenIntegrations" "url": "https://github.com/Bayselonarrend/OpenIntegrations"
}, },
"photo": { "photo": {
"album_id": -81, "album_id": -81,
"date": 1717072436, "date": 1717072436,
"id": 457244016, "id": 457244016,
"owner_id": -218861756, "owner_id": -218861756,
"sizes": [ "sizes": [
{ {
"height": 56, "height": 56,
"type": "s", "type": "s",
"width": 75, "width": 75,
"url": "https://sun6-20.userapi.com/s/v1/ig2/TUrQJn6Un8LHB0aNIOPtaqEt3K_J4tZbV2notqyJ1TUyHCj9m-bbiOZKm1u07WpGGAZfH1LFXbg95EM-uS0JHKX9.jpg?size=75x56&quality=95&type=story" "url": "https://sun6-20.userapi.com/s/v1/ig2/TUrQJn6Un8LHB0aNIOPtaqEt3K_J4tZbV2notqyJ1TUyHCj9m-bbiOZKm1u07WpGGAZfH1LFXbg95EM-uS0JHKX9.jpg?size=75x56&quality=95&type=story"
}, },
{ {
"height": 97, "height": 97,
"type": "m", "type": "m",
"width": 130, "width": 130,
"url": "https://sun6-20.userapi.com/s/v1/ig2/lASmJS8sUOYvtmSKkFOsBGNIWpcqoqenWSBOdBHSXQE9PuZjUx_aVVA3Zd6DOV08nssSEYQgXJ6Vam6TiPx2Lcpm.jpg?size=130x97&quality=95&type=story" "url": "https://sun6-20.userapi.com/s/v1/ig2/lASmJS8sUOYvtmSKkFOsBGNIWpcqoqenWSBOdBHSXQE9PuZjUx_aVVA3Zd6DOV08nssSEYQgXJ6Vam6TiPx2Lcpm.jpg?size=130x97&quality=95&type=story"
}, },
{ {
"height": 192, "height": 192,
"type": "j", "type": "j",
"width": 256, "width": 256,
"url": "https://sun6-20.userapi.com/s/v1/ig2/mmYPgPQo3uRxhAH1qIKIijT-5j87fr0A5PEe1X8k3kdo5MmagHYZIdECvXyFL9KubVsKzTZTWFJSQgskL5a09dhS.jpg?size=256x192&quality=95&type=story" "url": "https://sun6-20.userapi.com/s/v1/ig2/mmYPgPQo3uRxhAH1qIKIijT-5j87fr0A5PEe1X8k3kdo5MmagHYZIdECvXyFL9KubVsKzTZTWFJSQgskL5a09dhS.jpg?size=256x192&quality=95&type=story"
}, },
{ {
"height": 453, "height": 453,
"type": "x", "type": "x",
"width": 604, "width": 604,
"url": "https://sun6-20.userapi.com/s/v1/ig2/APnAEUFfn6z-WwqFWAM0_jbv9cRo4zrIPx3RSFrsSNdh8bXpv6438yZqB_BDM3pMfSfl6Gsx751T7mJ8yEf_zCi9.jpg?size=604x453&quality=95&type=story" "url": "https://sun6-20.userapi.com/s/v1/ig2/APnAEUFfn6z-WwqFWAM0_jbv9cRo4zrIPx3RSFrsSNdh8bXpv6438yZqB_BDM3pMfSfl6Gsx751T7mJ8yEf_zCi9.jpg?size=604x453&quality=95&type=story"
}, },
{ {
"height": 605, "height": 605,
"type": "y", "type": "y",
"width": 807, "width": 807,
"url": "https://sun6-20.userapi.com/s/v1/ig2/vou57hqLWC875j9nOB1HbiEWaVcSXCHmxNlyzyKEyKv6UO97Mm67PyKNftSvW0RvaHARFvl7Hc9noOv2TAV8Tq6X.jpg?size=807x605&quality=95&type=story" "url": "https://sun6-20.userapi.com/s/v1/ig2/vou57hqLWC875j9nOB1HbiEWaVcSXCHmxNlyzyKEyKv6UO97Mm67PyKNftSvW0RvaHARFvl7Hc9noOv2TAV8Tq6X.jpg?size=807x605&quality=95&type=story"
}, },
{ {
"height": 960, "height": 960,
"type": "z", "type": "z",
"width": 1280, "width": 1280,
"url": "https://sun6-20.userapi.com/s/v1/ig2/WGh4yRLRWsT4baZUDXiIUZU90sFYcZKcme9nnAPSy8CW_uYDQRDQSy8s0SkNRDEBteCyRBPG0Ka7tPwRQzp5M6Cx.jpg?size=1280x960&quality=95&type=story" "url": "https://sun6-20.userapi.com/s/v1/ig2/WGh4yRLRWsT4baZUDXiIUZU90sFYcZKcme9nnAPSy8CW_uYDQRDQSy8s0SkNRDEBteCyRBPG0Ka7tPwRQzp5M6Cx.jpg?size=1280x960&quality=95&type=story"
}, },
{ {
"height": 1920, "height": 1920,
"type": "w", "type": "w",
"width": 2560, "width": 2560,
"url": "https://sun6-20.userapi.com/s/v1/ig2/QugTL2gH3oV88GUPKhP1GOUfKWONc8iSt_v-Qt6TOsmioQPJ9nyq4L2a1yBHu2eSJKjsql1VhMtEx6wpt3fVVnly.jpg?size=2560x1920&quality=95&type=story" "url": "https://sun6-20.userapi.com/s/v1/ig2/QugTL2gH3oV88GUPKhP1GOUfKWONc8iSt_v-Qt6TOsmioQPJ9nyq4L2a1yBHu2eSJKjsql1VhMtEx6wpt3fVVnly.jpg?size=2560x1920&quality=95&type=story"
} }
], ],
"text": "", "text": "",
"user_id": 100, "user_id": 100,
"web_view_token": "404a88e5d32e0ff306", "web_view_token": "404a88e5d32e0ff306",
"has_tags": false "has_tags": false
}, },
"replies": { "replies": {
"count": 0, "count": 0,
"new": 0 "new": 0
}, },
"is_one_time": false, "is_one_time": false,
"track_code": "story/3AAQAdLy9G9EAs4bMamDA84nNfHkBAAFoAagB6AIAA==", "track_code": "story/3AAQAdLy9G9EAs4bMamDA84nNfHkBAAFoAagB6AIAA==",
"type": "photo", "type": "photo",
"views": 0, "views": 0,
"likes_count": 0, "likes_count": 0,
"reaction_set_id": "reactions", "reaction_set_id": "reactions",
"no_sound": false, "no_sound": false,
"can_ask": 0, "can_ask": 0,
"can_ask_anonymous": 0, "can_ask_anonymous": 0,
"narratives_count": 0, "narratives_count": 0,
"can_use_in_narrative": true "can_use_in_narrative": true
} }
] ]
} }
} }
``` ```

View File

@ -1,43 +1,43 @@
--- ---
sidebar_position: 6 sidebar_position: 6
--- ---
# Delete album # Delete album
Deletes a previously created album Deletes a previously created album
*Function DeleteAlbum(Val AlbumID, Val Parameters = "") Export* *Function DeleteAlbum(Val AlbumID, Val Parameters = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| AlbumID | --album | String, Number | Album ID | | AlbumID | --album | String, Number | Album ID |
| Parameters | --auth | Structure Of String | Authorization JSON or path to .json | | Parameters | --auth | Structure Of String | Authorization JSON or path to .json |
Returns: Map Of KeyAndValue - Serialized JSON response from VK Returns: Map Of KeyAndValue - Serialized JSON response from VK
```bsl title="Code example" ```bsl title="Code example"
Parameters = GetVKParameters(); Parameters = GetVKParameters();
AlbumID = "304549394"; AlbumID = "304549394";
Result = OPI_VK.DeleteAlbum(AlbumID, Parameters); Result = OPI_VK.DeleteAlbum(AlbumID, Parameters);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint vk DeleteAlbum --album %album% --auth %auth% oint vk DeleteAlbum --album %album% --auth %auth%
``` ```
```json title="Result" ```json title="Result"
{ {
"response": 1 "response": 1
} }
``` ```

View File

@ -1,43 +1,43 @@
--- ---
sidebar_position: 9 sidebar_position: 9
--- ---
# Delete image # Delete image
Deletes an image from the album Deletes an image from the album
*Function DeleteImage(Val ImageID, Val Parameters = "") Export* *Function DeleteImage(Val ImageID, Val Parameters = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| ImageID | --pictureid | String, Number | Image ID | | ImageID | --pictureid | String, Number | Image ID |
| Parameters | --auth | Structure Of String | Authorization JSON or path to .json | | Parameters | --auth | Structure Of String | Authorization JSON or path to .json |
Returns: Map Of KeyAndValue - Serialized JSON response from VK Returns: Map Of KeyAndValue - Serialized JSON response from VK
```bsl title="Code example" ```bsl title="Code example"
Parameters = GetVKParameters(); Parameters = GetVKParameters();
ImageID = "457244340"; ImageID = "457244340";
Result = OPI_VK.DeleteImage(ImageID, Parameters); Result = OPI_VK.DeleteImage(ImageID, Parameters);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint vk DeleteImage --pictureid %pictureid% --auth %auth% oint vk DeleteImage --pictureid %pictureid% --auth %auth%
``` ```
```json title="Result" ```json title="Result"
{ {
"response": 1 "response": 1
} }
``` ```

View File

@ -1,43 +1,43 @@
--- ---
sidebar_position: 3 sidebar_position: 3
--- ---
# Delete post # Delete post
Deletes a post by ID Deletes a post by ID
*Function DeletePost(Val PostID, Val Parameters = "") Export* *Function DeletePost(Val PostID, Val Parameters = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| PostID | --post | String, Number | Post ID | | PostID | --post | String, Number | Post ID |
| Parameters | --auth | Structure Of String | Authorization JSON or path to .json | | Parameters | --auth | Structure Of String | Authorization JSON or path to .json |
Returns: Map Of KeyAndValue - Serialized JSON response from VK Returns: Map Of KeyAndValue - Serialized JSON response from VK
```bsl title="Code example" ```bsl title="Code example"
Parameters = GetVKParameters(); Parameters = GetVKParameters();
PostID = "2304"; PostID = "2304";
Result = OPI_VK.DeletePost(PostID, Parameters); Result = OPI_VK.DeletePost(PostID, Parameters);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint vk DeletePost --post %post% --auth %auth% oint vk DeletePost --post %post% --auth %auth%
``` ```
```json title="Result" ```json title="Result"
{ {
"response": 1 "response": 1
} }
``` ```

View File

@ -1,126 +1,126 @@
--- ---
sidebar_position: 8 sidebar_position: 8
--- ---
# Save image to album # Save image to album
Saves an image to the community album Saves an image to the community album
*Function SaveImageToAlbum(Val AlbumID, Val Image, Val Description = "", Val Parameters = "") Export* *Function SaveImageToAlbum(Val AlbumID, Val Image, Val Description = "", Val Parameters = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| AlbumID | --album | String, Number | Album ID | | AlbumID | --album | String, Number | Album ID |
| Image | --picture | BinaryData,String | Image file | | Image | --picture | BinaryData,String | Image file |
| Description | --description | String | Image description | | Description | --description | String | Image description |
| Parameters | --auth | Structure Of String | Authorization JSON or path to .json | | Parameters | --auth | Structure Of String | Authorization JSON or path to .json |
Returns: Map Of KeyAndValue - Serialized JSON response from VK Returns: Map Of KeyAndValue - Serialized JSON response from VK
```bsl title="Code example" ```bsl title="Code example"
Parameters = GetVKParameters(); Parameters = GetVKParameters();
ImageDescription = "AutoTestImage"; ImageDescription = "AutoTestImage";
AlbumID = "304549394"; AlbumID = "304549394";
Image = "https://openintegrations.dev/test_data/picture.jpg"; // URL, Path to file or Binary Data Image = "https://openintegrations.dev/test_data/picture.jpg"; // URL, Path to file or Binary Data
TFN = GetTempFileName("png"); TFN = GetTempFileName("png");
CopyFile(Image, TFN); CopyFile(Image, TFN);
Image = New BinaryData(TFN); Image = New BinaryData(TFN);
Result = OPI_VK.SaveImageToAlbum(AlbumID, Image, ImageDescription, Parameters); Result = OPI_VK.SaveImageToAlbum(AlbumID, Image, ImageDescription, Parameters);
Result = OPI_VK.SaveImageToAlbum(AlbumID, TFN, ImageDescription, Parameters); Result = OPI_VK.SaveImageToAlbum(AlbumID, TFN, ImageDescription, Parameters);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint vk SaveImageToAlbum --album %album% --picture "https://openintegrations.dev/test_data/picture.jpg" --description %description% --auth %auth% oint vk SaveImageToAlbum --album %album% --picture "https://openintegrations.dev/test_data/picture.jpg" --description %description% --auth %auth%
``` ```
```json title="Result" ```json title="Result"
{ {
"response": [ "response": [
{ {
"album_id": 304498513, "album_id": 304498513,
"date": 1717072420, "date": 1717072420,
"id": 457244015, "id": 457244015,
"owner_id": -218861756, "owner_id": -218861756,
"sizes": [ "sizes": [
{ {
"height": 56, "height": 56,
"type": "s", "type": "s",
"width": 75, "width": 75,
"url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=75x56&quality=96&sign=025829abd0851633ab894cc48e64dbbb&c_uniq_tag=2CLDgToJpt6arrVUiZQ9l04lyJ415VJvA6WDs7UOnoI&type=album" "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=75x56&quality=96&sign=025829abd0851633ab894cc48e64dbbb&c_uniq_tag=2CLDgToJpt6arrVUiZQ9l04lyJ415VJvA6WDs7UOnoI&type=album"
}, },
{ {
"height": 97, "height": 97,
"type": "m", "type": "m",
"width": 130, "width": 130,
"url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=130x97&quality=96&sign=695e45c5d6322047a61314118cb57ef4&c_uniq_tag=cDuBpPHNopdt-Cizd6uRFsKIdW_Oui8oo7TYcflfRgE&type=album" "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=130x97&quality=96&sign=695e45c5d6322047a61314118cb57ef4&c_uniq_tag=cDuBpPHNopdt-Cizd6uRFsKIdW_Oui8oo7TYcflfRgE&type=album"
}, },
{ {
"height": 453, "height": 453,
"type": "x", "type": "x",
"width": 604, "width": 604,
"url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=604x453&quality=96&sign=13ca3aaef94483586ace112657fe8241&c_uniq_tag=_pon027js3STBAQDQY4UbPdMBOh0AzKmalzEJnHAb-8&type=album" "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=604x453&quality=96&sign=13ca3aaef94483586ace112657fe8241&c_uniq_tag=_pon027js3STBAQDQY4UbPdMBOh0AzKmalzEJnHAb-8&type=album"
}, },
{ {
"height": 605, "height": 605,
"type": "y", "type": "y",
"width": 807, "width": 807,
"url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=807x605&quality=96&sign=ca6a02d61aa6e88bbd63631e32c49895&c_uniq_tag=NSEWtM7U9s0sKGN84elYe-6ayOzx8dJXPD5JxUFUSK8&type=album" "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=807x605&quality=96&sign=ca6a02d61aa6e88bbd63631e32c49895&c_uniq_tag=NSEWtM7U9s0sKGN84elYe-6ayOzx8dJXPD5JxUFUSK8&type=album"
}, },
{ {
"height": 960, "height": 960,
"type": "z", "type": "z",
"width": 1280, "width": 1280,
"url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=1280x960&quality=96&sign=b10c42d8778cd2ac306fdeed0d7c77e9&c_uniq_tag=OsjHk58Ztn163AK2vT9xOw8tz75w00HoqpQSzJ9DOzo&type=album" "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=1280x960&quality=96&sign=b10c42d8778cd2ac306fdeed0d7c77e9&c_uniq_tag=OsjHk58Ztn163AK2vT9xOw8tz75w00HoqpQSzJ9DOzo&type=album"
}, },
{ {
"height": 1920, "height": 1920,
"type": "w", "type": "w",
"width": 2560, "width": 2560,
"url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=2560x1920&quality=96&sign=2b5cb4cd90cd4d100b394da5cd1d2540&c_uniq_tag=JXApXjELC3QaCHRgTV2wAZ9xT_1uGPHx2DnJ15ZrfqQ&type=album" "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=2560x1920&quality=96&sign=2b5cb4cd90cd4d100b394da5cd1d2540&c_uniq_tag=JXApXjELC3QaCHRgTV2wAZ9xT_1uGPHx2DnJ15ZrfqQ&type=album"
}, },
{ {
"height": 97, "height": 97,
"type": "o", "type": "o",
"width": 130, "width": 130,
"url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=130x97&quality=96&sign=695e45c5d6322047a61314118cb57ef4&c_uniq_tag=cDuBpPHNopdt-Cizd6uRFsKIdW_Oui8oo7TYcflfRgE&type=album" "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=130x97&quality=96&sign=695e45c5d6322047a61314118cb57ef4&c_uniq_tag=cDuBpPHNopdt-Cizd6uRFsKIdW_Oui8oo7TYcflfRgE&type=album"
}, },
{ {
"height": 150, "height": 150,
"type": "p", "type": "p",
"width": 200, "width": 200,
"url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=200x150&quality=96&sign=aea8308f1793d48319babde7d4cf7a2a&c_uniq_tag=0oVRnXvNOW_41uhPO1-daYe0KK2SgLDPeMJ4gk2Js5g&type=album" "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=200x150&quality=96&sign=aea8308f1793d48319babde7d4cf7a2a&c_uniq_tag=0oVRnXvNOW_41uhPO1-daYe0KK2SgLDPeMJ4gk2Js5g&type=album"
}, },
{ {
"height": 240, "height": 240,
"type": "q", "type": "q",
"width": 320, "width": 320,
"url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=320x240&quality=96&sign=f3d612a2ac0b297964e48d1775fa0c70&c_uniq_tag=LAynb-BcGM4BS_ew4PYMa93V627AEj8nTMcnq8Wy5gY&type=album" "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=320x240&quality=96&sign=f3d612a2ac0b297964e48d1775fa0c70&c_uniq_tag=LAynb-BcGM4BS_ew4PYMa93V627AEj8nTMcnq8Wy5gY&type=album"
}, },
{ {
"height": 382, "height": 382,
"type": "r", "type": "r",
"width": 510, "width": 510,
"url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=510x382&quality=96&sign=88209c9869f3522afe0a292a5884e246&c_uniq_tag=eMrSiFeVaca-qCgJXIxD1U1wU6ZInBYxsJVHxKn8CbY&type=album" "url": "https://sun9-38.userapi.com/impg/ejNe0jcXKF-JoKZdXKCs97GJjsJh4ZGE0iH8KQ/88_4gS4JO3s.jpg?size=510x382&quality=96&sign=88209c9869f3522afe0a292a5884e246&c_uniq_tag=eMrSiFeVaca-qCgJXIxD1U1wU6ZInBYxsJVHxKn8CbY&type=album"
} }
], ],
"text": "AutoTestImage", "text": "AutoTestImage",
"user_id": 100, "user_id": 100,
"web_view_token": "dcacf60c612a67607b", "web_view_token": "dcacf60c612a67607b",
"has_tags": false "has_tags": false
} }
] ]
} }
``` ```

View File

@ -1,38 +1,38 @@
--- ---
sidebar_position: 11 sidebar_position: 11
--- ---
# Upload photo to server # Upload photo to server
Uploads photo to server for further use Uploads photo to server for further use
*Function UploadPhotoToServer(Val Image, Val Parameters = "", Val View = "Post") Export* *Function UploadPhotoToServer(Val Image, Val Parameters = "", Val View = "Post") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Image | --file | String, BinaryData | Image file | | Image | --file | String, BinaryData | Image file |
| Parameters | --auth | Structure Of String | Authorization JSON or path to .json | | Parameters | --auth | Structure Of String | Authorization JSON or path to .json |
| View | --type | String | Upload type (Post, Product, Story, Poll, Other) | | View | --type | String | Upload type (Post, Product, Story, Poll, Other) |
Returns: Map Of KeyAndValue - Serialized JSON response from VK Returns: Map Of KeyAndValue - Serialized JSON response from VK
```bsl title="Code example" ```bsl title="Code example"
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint vk UploadPhotoToServer --file %file% --auth %auth% --type %type% oint vk UploadPhotoToServer --file %file% --auth %auth% --type %type%
``` ```
```json title="Result" ```json title="Result"
``` ```

View File

@ -1,40 +1,40 @@
--- ---
sidebar_position: 10 sidebar_position: 10
--- ---
# Upload video to server # Upload video to server
Uploads video to the group for further use Uploads video to the group for further use
*Function UploadVideoToServer(Val Video, Val Name, Val Description = "", Val Album = "", Val Parameters = "") Export* *Function UploadVideoToServer(Val Video, Val Name, Val Description = "", Val Album = "", Val Parameters = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| Video | --file | String, BinaryData | Video file | | Video | --file | String, BinaryData | Video file |
| Name | --title | String | Video name | | Name | --title | String | Video name |
| Description | --description | String | Video description | | Description | --description | String | Video description |
| Album | --album | String | Album ID, if necessary | | Album | --album | String | Album ID, if necessary |
| Parameters | --auth | Structure Of String | Authorization JSON or path to .json | | Parameters | --auth | Structure Of String | Authorization JSON or path to .json |
Returns: Map Of KeyAndValue - Serialized JSON response from VK Returns: Map Of KeyAndValue - Serialized JSON response from VK
```bsl title="Code example" ```bsl title="Code example"
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
oint vk UploadVideoToServer --file %file% --title %title% --description %description% --album %album% --auth %auth% oint vk UploadVideoToServer --file %file% --title %title% --description %description% --album %album% --auth %auth%
``` ```
```json title="Result" ```json title="Result"
``` ```

View File

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

View File

@ -1,4 +1,4 @@
{ {
"label": "Community managment", "label": "Community managment",
"position": "3" "position": "3"
} }

View File

@ -1,4 +1,4 @@
{ {
"label": "Interactive actions", "label": "Interactive actions",
"position": "5" "position": "5"
} }

View File

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

View File

@ -1,4 +1,4 @@
{ {
"label": "Others", "label": "Others",
"position": "12" "position": "12"
} }

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