1c/OpenIntegrations
1
0
Fork 0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-11-06 08:49:29 +02:00
Code Issues Releases Activity

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

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/en/md/VK/Ad-account-management/_category_.json
View File

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

118
docs/en/md/VK/Community-managment/Create-album.md
View File

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

136
docs/en/md/VK/Community-managment/Create-composite-post.md
View File

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

104
docs/en/md/VK/Community-managment/Create-poll.md
View File

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

120
docs/en/md/VK/Community-managment/Create-post.md
View File

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

280
docs/en/md/VK/Community-managment/Create-story.md
View File

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

86
docs/en/md/VK/Community-managment/Delete-album.md
View File

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

86
docs/en/md/VK/Community-managment/Delete-image.md
View File

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

86
docs/en/md/VK/Community-managment/Delete-post.md
View File

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

252
docs/en/md/VK/Community-managment/Save-image-to-album.md
View File

@@ -1,126 +1,126 @@
---
sidebar_position: 8
---
# Save image to album
Saves an image to the community album
*Function SaveImageToAlbum(Val AlbumID, Val Image, Val Description = "", Val Parameters = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| AlbumID | --album | String, Number | Album ID |
| Image | --picture | BinaryData,String | Image file |
| Description | --description | String | Image description |
| Parameters | --auth | Structure Of String | Authorization JSON or path to .json |
Returns: Map Of KeyAndValue - Serialized JSON response from VK
```bsl title="Code example"
Parameters = GetVKParameters();
ImageDescription = "AutoTestImage";
AlbumID = "304549394";
Image = "https://openintegrations.dev/test_data/picture.jpg"; // URL, Path to file or Binary Data
TFN = GetTempFileName("png");
CopyFile(Image, TFN);
Image = New BinaryData(TFN);
Result = OPI_VK.SaveImageToAlbum(AlbumID, Image, ImageDescription, Parameters);
Result = OPI_VK.SaveImageToAlbum(AlbumID, TFN, ImageDescription, Parameters);
```
```sh title="CLI command example"
oint vk SaveImageToAlbum --album %album% --picture "https://openintegrations.dev/test_data/picture.jpg" --description %description% --auth %auth%
```
```json title="Result"
{
"response": [
{
"album_id": 304498513,
"date": 1717072420,
"id": 457244015,
"owner_id": -218861756,
"sizes": [
{
"height": 56,
"type": "s",
"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"
},
{
"height": 97,
"type": "m",
"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"
},
{
"height": 453,
"type": "x",
"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"
},
{
"height": 605,
"type": "y",
"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"
},
{
"height": 960,
"type": "z",
"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"
},
{
"height": 1920,
"type": "w",
"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"
},
{
"height": 97,
"type": "o",
"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"
},
{
"height": 150,
"type": "p",
"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"
},
{
"height": 240,
"type": "q",
"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"
},
{
"height": 382,
"type": "r",
"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"
}
],
"text": "AutoTestImage",
"user_id": 100,
"web_view_token": "dcacf60c612a67607b",
"has_tags": false
}
]
}
```
---
sidebar_position: 8
---
# Save image to album
Saves an image to the community album
*Function SaveImageToAlbum(Val AlbumID, Val Image, Val Description = "", Val Parameters = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| AlbumID | --album | String, Number | Album ID |
| Image | --picture | BinaryData,String | Image file |
| Description | --description | String | Image description |
| Parameters | --auth | Structure Of String | Authorization JSON or path to .json |
Returns: Map Of KeyAndValue - Serialized JSON response from VK
```bsl title="Code example"
Parameters = GetVKParameters();
ImageDescription = "AutoTestImage";
AlbumID = "304549394";
Image = "https://openintegrations.dev/test_data/picture.jpg"; // URL, Path to file or Binary Data
TFN = GetTempFileName("png");
CopyFile(Image, TFN);
Image = New BinaryData(TFN);
Result = OPI_VK.SaveImageToAlbum(AlbumID, Image, ImageDescription, Parameters);
Result = OPI_VK.SaveImageToAlbum(AlbumID, TFN, ImageDescription, Parameters);
```
```sh title="CLI command example"
oint vk SaveImageToAlbum --album %album% --picture "https://openintegrations.dev/test_data/picture.jpg" --description %description% --auth %auth%
```
```json title="Result"
{
"response": [
{
"album_id": 304498513,
"date": 1717072420,
"id": 457244015,
"owner_id": -218861756,
"sizes": [
{
"height": 56,
"type": "s",
"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"
},
{
"height": 97,
"type": "m",
"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"
},
{
"height": 453,
"type": "x",
"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"
},
{
"height": 605,
"type": "y",
"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"
},
{
"height": 960,
"type": "z",
"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"
},
{
"height": 1920,
"type": "w",
"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"
},
{
"height": 97,
"type": "o",
"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"
},
{
"height": 150,
"type": "p",
"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"
},
{
"height": 240,
"type": "q",
"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"
},
{
"height": 382,
"type": "r",
"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"
}
],
"text": "AutoTestImage",
"user_id": 100,
"web_view_token": "dcacf60c612a67607b",
"has_tags": false
}
]
}
```

76
docs/en/md/VK/Community-managment/Upload-photo-to-server.md
View File

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

80
docs/en/md/VK/Community-managment/Upload-video-to-server.md
View File

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

6
docs/en/md/VK/Discussion-management/_category_.json
View File

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

6
docs/en/md/VK/Group-work/_category_.json
View File

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

6
docs/en/md/VK/Interactive-actions/_category_.json
View File

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

6
docs/en/md/VK/Order-management/_category_.json
View File

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

6
docs/en/md/VK/Others/_category_.json
View File

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

6
docs/en/md/VK/Product-management/_category_.json
View File

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

6
docs/en/md/VK/Product-properties-management/_category_.json
View File

@@ -1,4 +1,4 @@
{
"label": "Product properties management",
"position": "10"
{
"label": "Product properties management",
"position": "10"
}

6
docs/en/md/VK/Product-selection-management/_category_.json
View File

@@ -1,4 +1,4 @@
{
"label": "Product selection management",
"position": "9"
{
"label": "Product selection management",
"position": "9"
}

6
docs/en/md/VK/Statistics/_category_.json
View File

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

6
docs/en/md/VK/Token-retrieval/_category_.json
View File

@@ -1,4 +1,4 @@
{
"label": "Token retrieval",
"position": "2"
{
"label": "Token retrieval",
"position": "2"
}

14
docs/en/md/VK/_category_.json
View File

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