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

Доработки доков

This commit is contained in:
Anton
2024-07-31 21:55:27 +03:00
parent 6249ccefa0
commit 0196d209d2
285 changed files with 1251 additions and 858 deletions

View File

@@ -27,9 +27,20 @@ sidebar_position: 2
```bsl title="Code example"
Parameters = GetVKParameters();
Response = OPI_VK.CreateAd(1029683999, 166, 126, 221, 1607951446, Parameters);
Response = OPI_Tools.JSONString(Response);
CampaignNumber = "1030383630";
DailyLimit = 150;
CategoryNumber = 126;
PostID = "3114";
AccountID = "1607951446";
Result = OPI_VK.CreateAd(CampaignNumber
, DailyLimit
, CategoryNumber
, PostID
, AccountID
, Parameters);
```

View File

@@ -24,9 +24,12 @@ sidebar_position: 1
```bsl title="Code example"
Parameters = GetVKParameters();
Response = OPI_VK.CreateAdvertisingCampaign(1234567890, "New ads campaign", Parameters);
Response = OPI_Tools.JSONString(Response);
AccountID = "1607951446";
Name = "New campaign";
Result = OPI_VK.CreateAdvertisingCampaign(AccountID, Name, Parameters);
```

View File

@@ -1,46 +0,0 @@
---
sidebar_position: 3
---
# Pause advertising post
Pauses the display of the advertising post
*Function PauseAdvertising(Val AccountID, Val AdID, Val Parameters = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| AccountID | --cabinet | String, Number | Advertising account ID |
| AdID | --adv | String, Number | Ad 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"
Response = OPI_VK.PauseAdvertising(1234567890, 1029701085, Parameters);
Response = OPI_Tools.JSONString(Response);
```
```sh title="CLI command example"
oint vk PauseAdvertising --cabinet %cabinet% --adv %adv% --auth %auth%
```
```json title="Result"
{
"response": [
{
"id": 1029701085
}
]
}
```

View File

@@ -24,9 +24,12 @@ sidebar_position: 3
```bsl title="Code example"
Parameters = GetVKParameters();
Response = OPI_VK.PauseAdvertising(1234567890, 1029701085, Parameters);
Response = OPI_Tools.JSONString(Response);
AccountID = "1607951446";
AdID = "0";
Result = OPI_VK.PauseAdvertising(AccountID, AdID, Parameters);
```

View File

@@ -41,6 +41,9 @@ sidebar_position: 1
ImageArray.Add(TFN);
Result = OPI_VK.CreatePost(Text, ImageArray, True, URL, Parameters);
Result = OPI_VK.CreatePost(Text, Image, False,, Parameters);
```

View File

@@ -33,6 +33,9 @@ sidebar_position: 7
Image = New BinaryData(TFN);
Result = OPI_VK.CreateStory(Image, URL, Parameters);
Result = OPI_VK.CreateStory(TFN,, Parameters);
```

View File

@@ -24,7 +24,7 @@ sidebar_position: 6
```bsl title="Code example"
Parameters = GetVKParameters();
AlbumID = "304549394";
AlbumID = "305001965";
Result = OPI_VK.DeleteAlbum(AlbumID, Parameters);
```

View File

@@ -24,7 +24,7 @@ sidebar_position: 9
```bsl title="Code example"
Parameters = GetVKParameters();
ImageID = "457244340";
ImageID = "457246056";
Result = OPI_VK.DeleteImage(ImageID, Parameters);
```

View File

@@ -24,7 +24,7 @@ sidebar_position: 3
```bsl title="Code example"
Parameters = GetVKParameters();
PostID = "2304";
PostID = "3114";
Result = OPI_VK.DeletePost(PostID, Parameters);
```

View File

@@ -27,7 +27,7 @@ sidebar_position: 8
```bsl title="Code example"
Parameters = GetVKParameters();
ImageDescription = "AutoTestImage";
AlbumID = "304549394";
AlbumID = "305001965";
Image = "https://openintegrations.dev/test_data/picture.jpg"; // URL, Path to file or Binary Data
TFN = GetTempFileName("png");
@@ -36,6 +36,10 @@ sidebar_position: 8
Image = New BinaryData(TFN);
Result = OPI_VK.SaveImageToAlbum(AlbumID, Image, ImageDescription, Parameters);
Result = OPI_VK.SaveImageToAlbum(AlbumID, TFN, ImageDescription, Parameters);
```

View File

@@ -27,7 +27,8 @@ sidebar_position: 10
```bsl title="Code example"
Parameters = GetVKParameters();
Video = "C:/nature.mp4";
Video = "https://openintegrations.dev/test_data/video.mp4";
Name = "NewVideo";
Description = "Video description";

View File

@@ -25,7 +25,7 @@ sidebar_position: 2
```bsl title="Code example"
Parameters = GetVKParameters();
DiscussionID = "51206275";
DiscussionID = "51705921";
Result = OPI_VK.CloseDiscussion(DiscussionID, False, Parameters);
```

View File

@@ -24,7 +24,7 @@ sidebar_position: 3
```bsl title="Code example"
Parameters = GetVKParameters();
DiscussionID = "51206275";
DiscussionID = "51705921";
Result = OPI_VK.OpenDiscussion(DiscussionID, Parameters);
```

View File

@@ -25,7 +25,7 @@ sidebar_position: 4
```bsl title="Code example"
Parameters = GetVKParameters();
DiscussionID = "51206275";
DiscussionID = "51705921";
Message = "I like yellow more";
Result = OPI_VK.WriteInDiscussion(DiscussionID, Message, Parameters);

View File

@@ -24,9 +24,10 @@ sidebar_position: 1
```bsl title="Code example"
Parameters = GetVKParameters();
PostID = "3114";
Response = OPI_VK.LikePost(221,,Parameters);
Response = OPI_Tools.JSONString(Response);
Result = OPI_VK.LikePost(PostID,, Parameters);
```

View File

@@ -26,9 +26,11 @@ sidebar_position: 2
```bsl title="Code example"
Parameters = GetVKParameters();
PostID = 2571;
WallID = -218704372;
Response = OPI_VK.MakeRepost(2571, -218704372,,, Parameters);
Response = OPI_Tools.JSONString(Response);
Result = OPI_VK.MakeRepost(PostID, WallID,,, Parameters);
```

View File

@@ -25,9 +25,12 @@ sidebar_position: 4
```bsl title="Code example"
Parameters = GetVKParameters();
Text = "NewComment";
PostID = "3114";
WallID = Parameters["owner_id"];
Response = OPI_VK.WriteComment(221, -218861756, "Hello", Parameters);
Response = OPI_Tools.JSONString(Response);
Result = OPI_VK.WriteComment(PostID, WallID, Text, Parameters);
```

View File

@@ -26,11 +26,18 @@ sidebar_position: 3
```bsl title="Code example"
Parameters = GetVKParameters();
KТ = "vk1.a.IzbBGUkYUvrNfMt_sknCcC66hyYifL0U1Bb...";
Response = OPI_VK.WriteMessage("I am bot, but you - not >:)", 657811122, KТ,, Parameters);
Text = "Message from autotest";
UserID = "657846756";
Communitytoken = "vk1.a.IzbBGUkYUvrNfMt_sknCcC66hyYifL0U1Bb8CVYCNFBUVfpsJtzZ_K5LwCzURr2_uCzEaP_AK1QmInp9sGp7fu_CtEDSipFWFXJo0y8I...";
Response = OPI_Tools.JSONString(Response);
ButtonArray = New Array;
ButtonArray.Add("Button 1");
ButtonArray.Add("Button 2");
Keyboard = OPI_VK.FormKeyboard(ButtonArray);
Result = OPI_VK.WriteMessage(Text, UserID, Communitytoken, Keyboard, Parameters);
```

View File

@@ -22,16 +22,11 @@ sidebar_position: 1
```bsl title="Code example"
ButtonArray = New Array;
ButtonArray.Add("Button 1");
ButtonArray.Add("Button 2");
Keyboard = OPI_VK.FormKeyboard(ButtonArray);
KТ = "vk1.a.IzbBGUkYUvrNfMt_sknCcC66hyYifL0U1Bb8CVYC...";
Response = OPI_VK.WriteMessage("I am bot, but you - not >:)", 657846756, KТ, Keyboard, Parameters);
Response = OPI_Tools.JSONString(Response);
```

View File

@@ -24,30 +24,34 @@ sidebar_position: 4
```bsl title="Code example"
Parameters = GetVKParameters();
Image1 = "https://openintegrations.dev/test_data/picture.jpg"; // URL, Path to file or binary Data
Image2 = "https://openintegrations.dev/test_data/picture2.jpg"; // URL, Path to file or binary Data
Selection = "123";
ImageArray = New Array;
ImageArray.Add(Image);
ImageArray.Add(Image);
ImageArray.Add(Image1);
ImageArray.Add(Image2);
Product = New Map();
Product.Insert("Name", "TestProduct");
Product.Insert("Description", "Product description");
Product.Insert("Category", "20173");
Product.Insert("Price", 1);
Product.Insert("OldPrice", 15);
Product.Insert("MainPhoto", Image);
Product.Insert("URL", "https://github.com/Bayselonarrend/OpenIntegrations");
Product.Insert("AdditionalPhotos", ImageArray);
Product.Insert("MainInGroup", True);
Product.Insert("Width", 20);
Product.Insert("Height", 30);
Product.Insert("Depth", 40);
Product.Insert("Weight", 100);
Product.Insert("SKU", "12345");
Product.Insert("AvailableBalance", "10");
ProductDescription = New Map();
ProductDescription.Insert("Name", "TestProduct");
ProductDescription.Insert("Description", "Product description");
ProductDescription.Insert("Category", "20173");
ProductDescription.Insert("Price", 1);
ProductDescription.Insert("OldPrice", 15);
ProductDescription.Insert("MainPhoto", Image1);
ProductDescription.Insert("URL", "https://github.com/Bayselonarrend/OpenIntegrations");
ProductDescription.Insert("AdditionalPhotos", ImageArray);
ProductDescription.Insert("MainInGroup", True);
ProductDescription.Insert("Width", 20);
ProductDescription.Insert("Height", 30);
ProductDescription.Insert("Depth", 40);
ProductDescription.Insert("Weight", 100);
ProductDescription.Insert("SKU", "12345");
ProductDescription.Insert("AvailableBalance", "10");
Response = OPI_VK.AddProduct(Product, SelectionID, Parameters);
Response = OPI_Tools.JSONString(Response);
Result = OPI_VK.AddProduct(ProductDescription, Selection, Parameters);
```

View File

@@ -23,9 +23,11 @@ sidebar_position: 6
```bsl title="Code example"
Parameters = GetVKParameters();
Response = OPI_VK.DeleteProduct(ProductID, Parameters);
Response = OPI_Tools.JSONString(Response);
Product = "9286826";
Result = OPI_VK.DeleteProduct(Product, Parameters);
```

View File

@@ -25,12 +25,14 @@ sidebar_position: 5
```bsl title="Code example"
Parameters = GetVKParameters();
Product = New Map;
Product.Insert("Name", "EditedTestProduct");
Product = "9286826";
Response = OPI_VK.EditProduct(ProductID, Product,, Parameters);
Response = OPI_Tools.JSONString(Response);
ProductDescription = New Map;
ProductDescription.Insert("Name", "EditedTestProduct");
Result = OPI_VK.EditProduct(Product, ProductDescription,, Parameters);
```

View File

@@ -22,8 +22,9 @@ sidebar_position: 1
```bsl title="Code example"
Parameters = GetVKParameters();
Response = OPI_VK.GetProductCategoryList(Parameters); //Map
Result = OPI_VK.GetProductCategoryList(Parameters);
```

View File

@@ -23,9 +23,8 @@ sidebar_position: 2
```bsl title="Code example"
Response = OPI_VK.GetProductList(, Parameters);
Response = OPI_Tools.JSONString(Response);
Parameters = GetVKParameters();
Result = OPI_VK.GetProductList(, Parameters);
```

View File

@@ -23,13 +23,16 @@ sidebar_position: 3
```bsl title="Code example"
Parameters = GetVKParameters();
Item1 = "9286828";
Item2 = "9286829";
ProductsArray = New Array;
ProductsArray.Add("8656033");
ProductsArray.Add("8656034");
ProductsArray.Add(Item1);
ProductsArray.Add(Item2);
Response = OPI_VK.GetProductsByID(ProductsArray, Parameters);
Response = OPI_Tools.JSONString(Response);
Result = OPI_VK.GetProductsByID(ProductsArray, Parameters);
```

View File

@@ -24,13 +24,16 @@ sidebar_position: 7
```bsl title="Code example"
Parameters = GetVKParameters();
Item1 = "9286828";
Item2 = "9286829";
ProductsArray = New Array;
ProductsArray.Add(YellowItemID);
ProductsArray.Add(RedItemID);
ProductsArray.Add(Item1);
ProductsArray.Add(Item2);
Response = OPI_VK.GroupProducts(ProductsArray,, Parameters);
Response = OPI_Tools.JSONString(Response);
Result = OPI_VK.GroupProducts(ProductsArray,, Parameters);
```

View File

@@ -24,9 +24,24 @@ sidebar_position: 5
```bsl title="Code example"
Parameters = GetVKParameters();
Response = OPI_VK.AddProductPropertyVariant("Red", 260, Parameters);
Response = OPI_Tools.JSONString(Response);
Property = "607";
OptionArray = New Array;
OptionArray.Add("Yellow");
OptionArray.Add("Blue");
OptionArray.Add("Red");
For Each Value In OptionArray Do
Result = OPI_VK.AddProductPropertyVariant(Value, Property, Parameters);
FunctionParameters.Insert(ParameterName, VariantID);
EndDo;
```

View File

@@ -23,9 +23,11 @@ sidebar_position: 2
```bsl title="Code example"
Parameters = GetVKParameters();
Response = OPI_VK.CreateProductProperty("Color", Parameters);
Response = OPI_Tools.JSONString(Response);
Name = "Color";
Result = OPI_VK.CreateProductProperty(Name, Parameters);
```

View File

@@ -23,9 +23,16 @@ sidebar_position: 7
```bsl title="Code example"
Parameters = GetVKParameters();
Response = OPI_VK.DeleteProductPropertyVariant(980 Parameters);
Response = OPI_Tools.JSONString(Response);
Option = "1924";
Result = OPI_VK.DeleteProductPropertyVariant(Option, Parameters);
Check_VKTrue(Result);
OPI_Tools.Pause(5);
```

View File

@@ -23,9 +23,11 @@ sidebar_position: 4
```bsl title="Code example"
Parameters = GetVKParameters();
Response = OPI_VK.DeleteProductProperty(260, Parameters);
Response = OPI_Tools.JSONString(Response);
Property = "607";
Result = OPI_VK.DeleteProductProperty(Property, Parameters);
```

View File

@@ -25,9 +25,16 @@ sidebar_position: 6
```bsl title="Code example"
Parameters = GetVKParameters();
Response = OPI_VK.EditProductPropertyVariant("Yellow", 260, 980 Parameters);
Response = OPI_Tools.JSONString(Response);
Property = "607";
Option = "1924";
Value = "New variant name";
Result = OPI_VK.EditProductPropertyVariant(Value
, Property
, Option
, Parameters);
```

View File

@@ -24,9 +24,12 @@ sidebar_position: 3
```bsl title="Code example"
Parameters = GetVKParameters();
Response = OPI_VK.EditProductProperty("Color (change.)", Property, Parameters);
Response = OPI_Tools.JSONString(Response);
Name = "Color (change.)";
Property = "607";
Result = OPI_VK.EditProductProperty(Name, Property, Parameters);
```

View File

@@ -22,9 +22,8 @@ sidebar_position: 1
```bsl title="Code example"
Response = OPI_VK.GetPropertyList(Parameters);
Response = OPI_Tools.JSONString(Response);
Parameters = GetVKParameters();
Result = OPI_VK.GetPropertyList(Parameters);
```

View File

@@ -24,9 +24,12 @@ sidebar_position: 5
```bsl title="Code example"
Parameters = GetVKParameters();
Response = OPI_VK.AddProductToCollection(8656559, 40, Parameters);
Response = OPI_Tools.JSONString(Response);
Product = "9286826";
Selection = "123";
Result = OPI_VK.AddProductToCollection(Product, Selection, Parameters);
```

View File

@@ -1,42 +0,0 @@
---
sidebar_position: 5
---
# Add product to selection
Adds a product to the selection
*Function AddProductToCollection(Val ProductsArray, Val Selection, Val Parameters = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| ProductsArray | --items | Array of string, number | Array of products or product |
| Selection | --sel | String | Selection 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"
Response = OPI_VK.AddProductToCollection(8656559, 40, Parameters);
Response = OPI_Tools.JSONString(Response);
```
```sh title="CLI command example"
oint vk AddProductToCollection --items %items% --sel %sel% --auth %auth%
```
```json title="Result"
{
"response": 1
}
```

View File

@@ -26,14 +26,18 @@ sidebar_position: 3
```bsl title="Code example"
Parameters = GetVKParameters();
Response = OPI_VK.CreateProductCollection("TestCollection"
Name = "TestCollection";
Image = "https://openintegrations.dev/test_data/picture.jpg";
Main = True;
Hidden = False;
Result = OPI_VK.CreateProductCollection(Name
, Image
, True
, False
, Main
, Hidden
, Parameters);
Response = OPI_Tools.JSONString(Response);
```

View File

@@ -23,9 +23,11 @@ sidebar_position: 7
```bsl title="Code example"
Parameters = GetVKParameters();
Response = OPI_VK.DeleteSelection(40, Parameters);
Response = OPI_Tools.JSONString(Response);
Selection = "123";
Result = OPI_VK.DeleteSelection(Selection, Parameters);
```

View File

@@ -27,15 +27,17 @@ sidebar_position: 4
```bsl title="Code example"
Parameters = GetVKParameters();
Response = OPI_VK.EditProductCollection("EditedCollection"
, 40
, Image
, True
, False
, Parameters);
Name = "EditedCollection";
Selection = "123";
Response = OPI_Tools.JSONString(Response);
Result = OPI_VK.EditProductCollection(Name, Selection,,,, Parameters);
Check_VKTrue(Result);
OPI_Tools.Pause(5);
```

View File

@@ -22,9 +22,8 @@ sidebar_position: 1
```bsl title="Code example"
Response = OPI_VK.GetSelectionList(Parameters);
Response = OPI_Tools.JSONString(Response);
Parameters = GetVKParameters();
Result = OPI_VK.GetSelectionList(Parameters);
```

View File

@@ -24,9 +24,12 @@ sidebar_position: 6
```bsl title="Code example"
Parameters = GetVKParameters();
Response = OPI_VK.RemoveProductFromSelection(8656559, 40, Parameters);
Response = OPI_Tools.JSONString(Response);
Product = "9286826";
Selection = "123";
Result = OPI_VK.RemoveProductFromSelection(Product, Selection, Parameters);
```

View File

@@ -23,13 +23,13 @@ sidebar_position: 2
```bsl title="Code example"
Parameters = GetVKParameters();
ArrayOfPosts = New Array;
ArrayOfPosts.Add(214);
ArrayOfPosts.Add(215);
Response = OPI_VK.GetPostStatistics(ArrayOfPosts, VK_Parameters);
Response = OPI_Tools.JSONString(Response);
Result = OPI_VK.GetPostStatistics(ArrayOfPosts, Parameters);
```

View File

@@ -24,9 +24,13 @@ sidebar_position: 1
```bsl title="Code example"
Parameters = GetVKParameters();
Response = OPI_VK.GetStatistics(CurrentSessionDate() - 60 * 60 * 24, CurrentSessionDate(), Parameters);
Response = OPI_Tools.JSONString(Response);
CurrentDate = OPI_Tools.GetCurrentDate();
StartDate = BegOfDay(CurrentDate);
EndDate = EndOfDay(StartDate);
Result = OPI_VK.GetStatistics(StartDate, EndDate, Parameters);
```